About the Netvisor OS CLI

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

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

AS

Autonomous System is a collection of connected IP addresss routing prefixes under the control of one or more network operators on behalf of a single administrative entity or domain.

API

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

BFD

Bidirectional Forwarding Detection is a UDP based protocol that provides fast detection of Layer 3 next hop failures. It is used in conjunction with a routing protocol, in this case, BGP.

BGP

Border Gateway Protocol is a standardized routing protocol used to exchange routing and reachability data among autonomous systems.

CLI

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

Cluster

A pair of 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 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  or to any networking device.

IA

Insight Analytics is a Network Performance Management (NPM)

In-band Management Address

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

In-band Interface

Internal management interface used as a fabric-control port when building a fabric over any IP network.

L2VPN

Layer 2 VPN is a bridge domain extension across multiple dispersed physical locations over a generic IP transport infrastructure.

L3VPN

Layer 3 VPN is an IP domain extension across multiple dispersed physical locations over a generic IP transport infrastructure.

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.

Out-of-band Interface

Dedicated out-of-band port on Netvisor switches, used either as a management-only interface or as a fabric-control port to form the fabric and exchange fabric information over the out-of-band management network.

Overlay

In the VXLAN context, refers to all the elements built on top of the generic IP transport infrastructure in order to offer the L2VPN and L3VPN functionalities.

Underlay

In the VXLAN context,  refers to the generic IP transport infrastructure used to ensure IP communication among all Data Centers

UNUM

Pluribus UNUM™ Unified Management, Automation and Analytics Platform software.

vFlow

A logical, manageable connection within or throughout the fabric.

VIP

Virtual IP is an IP address that does not correspond to an actual physical device. It can be the IP used by the VRRP instances and the VTEPs.

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.

vLE

Virtual Link Extension is a Netvisor technology that allows defining Layer 1 pseudo-wires that can emulate a direct connection between devices on top of an IP transport network

vNET

A Virtual NETwork is a partition of the fabric. A vNET is defined by a group of network objects that can operate independently and have dedicated resources, providing multi-tenancy and network segmentation.

VRF

VRF is a technology that allows multiple routing spaces coexist on the same switch. It complements the vRouter construct, offering a highly scalable solution.

vRouter

An network object used to provide routing between subnets, VLANs and/or vNETs. The vRouter runs in a dedicated operating system container.

VRRP

Virtual Router Redundancy Protocol is a networking protocol that provides redundancy of routing paths by creation of virtual routers, which are an abstract representation of multiple routers, for example, master and backup routers, acting as a group.

VTEP

VxLAN Tunnel Endpoint is the entity responsible for encapsulating or de-encapsulating VxLAN packets.

VTEP HA

VTEP High Availability refers to a mechanism designed to ensure redundancy of the VTEP entity.

VXLAN

Virtual Extensible LAN is a Layer 2 overlay scheme over a Layer 3 network. VXLAN uses MAC-in-UDP encapsulation to provide extension of Layer 2 segments across IP transport networks

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 OS 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.

Alternate Command Format

The CLI has an alternate command format in that the commands start with a verb instead of a noun. This format omits the hyphen in the command names. For example, connection-stats-show can also be entered as show connection-stats. The command formats have the same features and can be used interchangeably.

 

Specifying IP Address Netmasks

Some commands call for the specification of an IP address netmask. Pluribus Networks Netvisor OS supports both CIDR and subnet notations.

For example, the range of IP addresses from 192.168.0.0 to 192.168.0.255 can be specified by either entering 192.160.0.0 for the IP address input for a CLI command or either 24 or 255.255.255.0 for the netmask.

Specifying Measurement Units

Many commands include input and output of capacity and throughput. Network values are always in bits and storage values in bytes. Scale factors are allowed on input and displayed in output as well as shown in Table 3, “Scale Numbers”.

Table 3: Scale Numbers

Scale Indicator

Meaning (Networking)

Meaning (Storage)

K or k

Kilobits

Kilobytes

M or m

Megabits

Megabytes

G or g

Gigabits

Gigabytes

T or t

Terabits

Terabytes

Customizing Show Output Formats

The output generated by the show commands can be customized by using the optional arguments described in Table 4, “Show Output Formats”.

Table 4: Show Output Formats

format <column_name1>, <column_name2>, <column_nameX>

Displays only the columns matching the list of column header names.

NOTE: The list of column names is comma-separated without spaces.

format all

Displays all available column headers. This output is also called verbose mode.

By default, show commands output a terse set of the most commonly useful column headers.

parsable-delim <separator>

Displays the output of show command by separating columns by the specified <separator> character(s).

For example, parsable-delim , produces a comma-separated output (CSV).

NOTE: If the parsable-delim option is specified, the column header names (titles) are suppressed from the output.

Specifying a Switch or Fabric for Command Scope

While a switch is the building block of a fabric, the goal of the Netvisor OS design is that a fabric of switches is easy to manage as a single switch. Because of this, the Netvisor OS CLI can be used to run commands on the local switch, a cluster of switches, other switches in the fabric, or the entire fabric. You don’t have to log into each switch that you want to run commands.

By default, commands are run on the switch you are currently logged into on the network. For example, the command port-config-modify port 5 disable disables port 5 on the switch you are logged into on the network.

To specify a different switch for a single command, use the switch prefix. For example, switch pleiades23 port-config-modify port 28 enable enables port 28 on pleiades23, even if the Netvisor OS CLI is connected to a different switch in the fabric.

To specify a different switch for a series of commands, use the switch prefix with no command. For example, type switch pleiades24 <return>. The Netvisor OS CLI prompt changes to indicate that pleiades24 is the switch you are executing commands. Additional commands are run on pleiades24 rather than the switch that you’re physically connected.

For most Netvisor OS CLI show commands, the command displays results from all switches in the fabric by default. For example, when the Netvisor OS CLI command port-show is entered on the switch, it shows the ports of all switches in the fabric.

To specify that a Netvisor OS CLI show command should apply to a specific switch, use the switch prefix to the CLI command. For example, for the port-show command to only show the ports of the switch named pleiades24, type the command switch pleiades24 port-show.