About the Netvisor OS CLI

This chapter provides information for understanding and using the Pluribus Networks Netvisor OS command line interface (CLI) on a Netvisor OS OS switch.

Important Terms

The following list of important terms and concepts as well as definitions is important for understanding Netvisor OS features and determine the best configuration to meet your needs.

Term

Meaning

API

Application Programming Interface to the Netvisor OS OS switch. It has a similar scope as the CLI.

CLI

Command Line Interface to the Netvisor OS OS switch. Depending on the command, it can be executed for an individual switch, a cluster, or a fabric.

Cluster

A pair of Netvisor OS OS switches configured as a high availability group. You can configure a number of clusters in the fabric, but a switch can be a member of one cluster.

Fabric

A set of Netvisor OS switches configured as a single entity. Any switch can only be a member of one fabric.

Flow

NetFlow identifies packet flows for both ingress and egress IP packets and provides statistics based on these packet flows. NetFlow does not require any change to either the packets themselves or to any networking device.

In-band Management Address

The IP address of the switch on a production or management network for administration and inter-switch communication.

LACP

Link Aggregation Control Protocol allows a non-Netvisor OS device to have multiple connections to the same switch, for example, IEEE 802.3ad trunks.

vFlow

A logical, manageable connection within or throughout the fabric.

VLAG

Virtual Link Aggregation Group is the Netvisor OS method for multiple connecting hosts to multiple switches, switches to each other, and switches to other switches.

Entering Commands and Getting Help

Commands, options, and arguments are entered at the CLI prompt. A command name must be typed, but included command-completion and help features contribute to the command entry process.

To display a list of command that you can use within a command mode, enter a question mark (?), or use the tab key, or type help at the command prompt. You can also display keywords and arguments for each command with this context-sensitive help feature. You can also use complete commands and display keywords and arguments for each command using the tab key to assist with context-sensitive command help and completion.

Table 1 lists the command that you can enter to get help specific to a command, keyword, or argument.

Table 1: Getting Help

abbreviated- command-entry?

Displays a list of commands that begin with a specific character string. Do not leave a space between the string and question mark.

abbreviated- command-entry <tab>

Completes a partial command name.

?

Lists all commands.

command ?

Lists all keywords for the command. Leave a space between the command and the question mark.

command keyword ?

Lists all arguments for the keyword. Leave a space between the command and the question mark.

Where a text string is used, such as name-string, the following characters are allowed as part of the text string: a-z, A-Z, 0-9, _ (underscore), . (period), , (comma), : (colon), and - (dash).


 

Informational Note:  If you enter a command that is invalid, then using the ? and tab key have no effect and do not return any changes to the CLI.


 

Informational Note:  The CLI has an editing ability similar to UNIX and Linux functionality using emacs keys. For example, ˄p steps backward through previous commands, ˄n moves to the next command in the history, ˄a moves to the first character in the command and ˄e moves to the end of the line, ˄u erases the current line, and ˄w erases the previous word.

Informational Note:  Also you can use the up and down arrows on your keyboard to retrieve the last command entered at the CLI.

Finding Command Options

The syntax can consist of optional or required keywords. To display keywords for a command, enter a question mark (?) at the command prompt or after entering part of a command followed by a space. Netvisor CLI displays a list of available keywords along with a brief description of the keywords. For example, if you want to see all of the keywords for the command user, enter user ?.

Table 1, displays examples of using the question mark (?) to assist you with entering commands.

Table 2: Finding Command Options

CLI network-admin@switch > ?

All commands:

acl-ip-create

acl-ip-delete

...

Displays a list of commands that begin with a specific character string. Do not leave a space between the string and question mark.

Switch> user auth

User: <user>

Password: <password>

Completes a partial command name.

?

Lists all commands.

command ?

Lists all keywords for the command. Leave a space between the command and the question mark.

command option ?

Lists all arguments for the option. Leave a space between the command and the question mark.


 

Informational Note:  Other useful options, especially for displaying statistics, include sort, interval, duration, and show diff interval.