End of Support

Session Management Commands

Global Configuration Commands

configure replace
configure session
management api eos-sdk-rpc
management api external-services
management api gnmi
management api gnsi
management api gribi
management api http-commands
management api models
management api netconf
management api restconf
management console
management ssh
management telnet
management xmpp
reset system storage secure

Management Configuration Commands

domain (XMPP Management)
idle-timeout (Console Management)
idle-timeout (SSH Management)
idle-timeout (Telnet Management)
protocol http (API Management)
protocol https (API Management)
protocol https certificate (API Management)
server (XMPP Management)
session privilege (XMPP Management)
shutdown (API Management)
shutdown (Telnet Management)
shutdown (XMPP Management)
switch-group (XMPP Management)
username (XMPP Management)
vrf (API Management)
vrf (XMPP Management)
xmpp send
xmpp session

configure replace

The configure replace command replaces the current configuration with the new configuration from the specified source.

Command Mode

Privileged EXEC

Command Syntax

configure replace {source_file_path:source_file_name | boot-extensions | clean-config | installed-extensions | running-config | startup-config}[ignore-errors] [md5 md5sum] [skip-checkpoint]

Parameters

source_file_path:source_file_name replaces the current configuration with the configuration from the specified source file.
boot-extensions replace the current configuration with the boot extensions configuration.
clean-config replaces the current configuration with clean and default configurations.
installed-extensions replace the current configuration with the installed extensions configuration.
running-config obsolete.
starup-config replaces the current configuration with the startup configuration.
ignore-errors ignore errors while loading the new configuration.
md5 md5sum performs a checksum to validate data integrity with the specified MD5 hashing algorithm.
skip-checkpoint skips creating the checkpoint file of running-config.

Example

This command replaces the current configuration state with the startup configuration.

switch(config)# configure replace start-config
! Preserving static routes. Use 'no ip routing delete-static-routes' to clear
them.
switch#

configure session

The configure session command allows a series of configuration changes made temporarily and commits to running-config later by issuing the commit command. An uncommitted configuration session will be discarded if the switch reboots and will time out after 24 hours.

Note: Committing a configuration session replaces running-config with the session configuration, which consists of the running configuration at the initial session and the commands entered as part of the session. When the session commits, it overwrites any changes to running-config since the initiation.

The no configure session session_name and default configure session session_name commands delete the specified configuration session.

Command Mode

Privileged EXEC

Command Syntax

configure session [session_name]

no configure session session_name

default configure session session_name

Parameter

session_name session name.

Guidelines

It creates a session with a name generated by the systems when a session name is not specified.
The switch permits up to five uncommitted sessions.
When the switch reboots, it discards the uncommitted sessions.
Uncommitted sessions time out after 24 hours.

Example

This command creates a session (automatically named sess-1) and adds commands. Issuing the commit command executes all commands and overwrite any configuration performed since the creation of the session.

switch(config)#configure session
switch(config-s-sess-1)#no username kevin
switch(config-s-sess-1)#aaa authentication dot1x default group radius
switch(config-s-sess-1)#dot1x system-auth-control
switch(config-s-sess-1)#copy running-config startup-config
switch(config-s-sess-1)#reload all now
switch(config-s-sess-1)#

domain (XMPP Management)

The domain command configures the switch's XMPP domain name. The XMPP client accepts messages only when using a locally configured domain. It uses the switch's domain name if none is specified.

Management over XMPP is disabled by default. To enable it, you must provide the server's location, domain, username, and password for the switch.

Arista recommends configuring the XMPP domain before the username, because it will provide shortcuts for the switch-group and username so you can configure without the domain attached to it (e.g., USERNAME instead of USERNAME@DOMAIN).

The no domain and default domain commands delete the domain name by removing the domain command from running-config.

Command Mode

Mgmt-xmpp Configuration

Command Syntax

domain string

no domain

default domain

Parameter

string domain name (text string).

Examples

This command configures test.aristanetworks.com as the switch’s domain name.

switch(config)#management xmpp
test1(config-mgmt-xmpp)#server arista-xmpp
test1(config-mgmt-xmpp)#domain test.aristanetworks.com
test1(config-mgmt-xmpp)#username This email address is being protected from spambots. You need JavaScript enabled to view it. password 0 arista
test1(config-mgmt-xmpp)#no shutdown

This command removes the domain name from the XMPP configuration.
```
switch(config-mgmt-xmpp)#no domain
switch(config-mgmt-xmpp)#
```

idle-timeout (Console Management)

The idle-timeout (Console Management) command configures the idle-timeout period for console connection sessions. The idle timeout is when the connection waits after a user's most recent command before shutting down the connection. Setting the idle timeout to zero disables the connection timeout automatically, which is the default setting.

The no idle-timeout and default idle-timeout commands disable the automatic connection timeout by removing the idle-timeout statement from running-config.

Command Mode

Mgmt-console

Command Syntax

idle-timeout idle_period

no idle-timeout

default idle-timeout

Parameters

idle_period session idle-timeout length. Options include:

0 Automatic connection timeout is disabled.
1 to 86400 Automatic timeout period (minutes).

Examples

These commands configure a console idle-timeout period of three hours, then return the switch to global configuration mode.

switch(config)# management console
switch(config-mgmt-console)# idle-timeout 180
switch(config-mgmt-console)# exit
switch(config)#

These commands disable automatic connection timeout.

switch(config)# management console
switch(config-mgmt-console)# idle-timeout 0
switch(config-mgmt-console)#

idle-timeout (SSH Management)

The idle-timeout (SSH Management) command configures the idle-timeout period for SSH connection sessions. The idle timeout is when the connection waits after a user's most recent command before shutting down the connection. Setting the idle timeout to zero disables the connection timeout automatically, which is the default setting.

The no idle-timeout and default idle-timeout commands disable the automatic connection timeout by removing the idle-timeout statement from running-config.

Command Mode

Mgmt-ssh Configuration

Command Syntax

idle-timeout idle_period

no idle-timeout

default idle-timeout

Parameters

idle_period session idle-timeout length. Options include:

0 Automatic connection timeout is disabled.
1 to 86400Automatic timeout period (minutes).

Examples

These commands configure an SSH idle-timeout period of three hours, then return the switch to global configuration mode.
```
switch(config)#management ssh
switch(config-mgmt-ssh)#idle-timeout 180
switch(config-mgmt-ssh)#exit
switch(config)#
```

These commands disable automatic connection timeout.

switch(config)#management ssh
switch(config-mgmt-ssh)#idle-timeout 0
switch(config-mgmt-ssh)#

idle-timeout (Telnet Management)

The idle-timeout (Telnet Management) command configures the idle-timeout period for Telnet connection sessions. The idle timeout is when the connection waits after a user's most recent command before shutting down the connection. Setting the idle timeout to zero disables the connection timeout automatically, which is the default setting.

The no idle-timeout and default idle-timeout commands disable the automatic connection timeout by removing the idle-timeout statement from running-config.

Command Mode

Mgmt-telnet

Command Syntax

idle-timeout idle_period

no idle-timeout

default idle-timeout

Parameters

idle_period session idle-timeout length. Options include:

0 Automatic connection timeout is disabled.
1 to 86400 Automatic timeout period (minutes).

Examples

These commands configure a Telnet idle-timeout period of three hours, then return the switch to global configuration mode.

switch(config)#management telnet
switch(config-mgmt-telnet)#idle-timeout 180
switch(config-mgmt-telnet)#exit
switch(config)#

These commands disable automatic connection timeout.

switch(config)#management telnet
switch(config-mgmt-telnet)#idle-timeout 0
switch(config-mgmt-telnet)#

management api eos-sdk-rpc

The management api eos-sdk-rpc command places the switch in EOS SDK RPC API management configuration mode.

The no management api eos-sdk-rpc and default management api eos-sdk-rpc commands delete the mgmt-api-eos-sdk-rpc configuration mode statements from running-config.

EOS SDK RPC API management configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting the EOS SDK RPC API management configuration mode does not affect the running-config. The exit command returns the switch to global configuration mode.

Command Mode

Global Configuration

Command Syntax

management api eos-sdk-rpc

no management api eos-sdk-rpc

default management api eos-sdk-rpc

Commands Available in EOS SDK RPC API Configuration Mode

transport (EOS SDK RPC API Management)

Examples

This command places the switch in EOS SDK RPC API management configuration mode.
```
switch(config)#management api eos-sdk-rpc
switch(config-mgmt-api-eos-sdk-rpc)#
```
This command returns the switch to global management mode.
```
switch(config-mgmt-api-eos-sdk-rpc)#exit
switch(config)#
```

management api external-services

The management api external-services command places the switch in External Services API configuration mode.

The no management api external-services and default management api external-services commands delete the mgmt-api-external-services configuration mode statements from running-config.

External Services API configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting the External Services API configuration mode does not affect the running-config. The exit command returns the switch to global configuration mode.

Command Mode

Global Configuration

Command Syntax

management api external-services

no management api external-services

default management api external-services

Commands Available in Mgmt-API Configuration Mode

shutdown (External Services API Management)
vrf (External Services API Management)

Examples

This command places the switch in External Services API Management configuration mode.

switch(config)# management api external-services
switch(config-mgmt-api-external-services)#

This command returns the switch to global management mode.

switch(config-mgmt-api-external-services)# exit
switch(config)#

management api gnmi

The management api gnmi command places the switch in GNMI API Management configuration mode.

The no management api gnmi and default management api gnmi commands delete the mgmt-api-gnmi configuration mode statements from running-config.

GNMI API Management configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting the GNMI API Management configuration mode does not affect running-config. The exit command returns the switch to global configuration mode.

Command Mode

Global Configuration

Command Syntax

management api gnmi

no management api gnmi

default management api gnmi

Commands Available in Mgmt-API Configuration Mode

operation (GNMI API Management)
provider (GNMI API Management)
transport (GNMI API Management)

Examples

This command places the switch in GNMI API Management configuration mode.
```
switch(config)# management api gnmi
switch(config-mgmt-api-gnmi)#
```
This command returns the switch to global management mode.
```
switch(config-mgmt-api-gnmi)# exit
switch(config)#
```

management api gnsi

The management api gnsi command places the switch in GNSI API management configuration mode.

The no management api gnsi and default management api gnsi commands delete the mgmt-api-gnsi configuration mode statements from running-config.

GNSI API Management configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting the GNSI API Management configuration mode does not affect running-config. The exit command returns the switch to global configuration mode.

Command Mode

Global Configuration

Command Syntax

management api gnsi

no management api gnsi

default management api gnsi

Commands Available in GNSI API Management Configuration Mode

service (GNSI API Management)
transport (GNSI API Management)

Examples

This command places the switch in GNSI API Management configuration mode.
```
switch(config)#management api gnsi
switch(config-mgmt-api-gnsi)#
```
This command returns the switch to global management mode.
```
switch(config-mgmt-api-gnsi)#exit
switch(config)#
```

management api gribi

The management api gribi command places the switch in gRIBI API Management configuration mode.

The no management api gribi and default management api gribi commands delete the mgmt-api-gribi configuration mode statements from running-config.

gRIBI API Management configuration mode is not a group change mode; running-config changes immediately upon entering commands. Exiting the gRIBI API Management configuration mode does not affect running-config. The exit command returns the switch to global configuration mode.

Command Mode

Global Configuration

Command Syntax

management api gribi

no management api gribi

default management api gribi

Commands Available in gRIBI API Management Configuration Mode

transport (gRIBI API Management)

Examples

This command places the switch in gRIBI API Management configuration mode.
```
switch(config)# management api gribi
switch(config-mgmt-api-gribi)#
```
This command returns the switch to global management mode.
```
switch(config-mgmt-api-gribi)# exit
switch(config)#
```

management api http-commands

The management api http-commands command places the switch in HTTP Commands API Management configuration mode.

The no management api http-commands and default management api http-commands commands delete the mgmt-api-http-command configuration mode statements from running-config.

HTTP Commands API Management configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting HTTP Commands API Management configuration mode does not affect running-config. The exit command returns the switch to global configuration mode.

Command Mode

Global Configuration

Command Syntax

management api http-commands

no management api http-commands

default management api http-commands

Commands Available in HTTP Commands API Management Configuration Mode

protocol http (API Management)
protocol https (API Management)
protocol https certificate (API Management)
protocol shutdown (API Management)
protocol vrf (API Management)

Examples

This command places the switch in HTTP Commands API Management configuration mode.
```
switch(config)# management api http-commands
switch(config-mgmt-api-http-cmds)#
```
This command returns the switch to global management mode.
```
switch(config-mgmt-api-http-cmds)# exit
switch(config)#
```

management api models

The management api models command places the switch in Models API Management configuration mode.

The no management api models and default management api models commands delete the mgmt-api-models configuration mode statements from running-config.

Models API Management configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting Models API Management configuration mode does not affect running-config. The exit command returns the switch to global configuration mode.

Command Mode

Global Configuration

Command Syntax

management api models

no management api models

default management api models

Commands Available in Models API Management Configuration Mode

models (Models API Management)
modules (Models API Management)
provider (Models API Management)

Examples

This command places the switch in Models API Management configuration mode.
```
switch(config)# management api models
switch(config-mgmt-api-models)#
```
This command returns the switch to global management mode.
```
switch(config-mgmt-api-models)# exit
switch(config)#
```

management api netconf

The management api netconf command places the switch in Netconf API Management configuration mode.

The no management api netconf and default management api netconf commands delete the mgmt-api-netconf configuration mode statements from running-config.

Netconf API Management configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting Netconf API Management configuration mode does not affect running-config. The exit command returns the switch to global configuration mode.

Command Mode

Global Configuration

Command Syntax

management api netconf

no management api netconf

default management api netconf

Commands Available in Netconf API Management Configuration Mode

transport (Netconf API Management)

Examples

This command places the switch in Netconf API Management configuration mode.
```
switch(config)# management api netconf
switch(config-mgmt-api-netconf)#
```
This command returns the switch to global management mode.
```
switch(config-mgmt-api-netconf)# exit
switch(config)#
```

management api restconf

The management api restconf command places the switch in Restconf API Management configuration mode.

The no management api restconf and default management api restconf commands delete the mgmt-api-restconf configuration mode statements from running-config.

Restconf API Management configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting Restconf API Management configuration mode does not affect running-config. The exit command returns the switch to global configuration mode.

Command Mode

Global Configuration

Command Syntax

management api restconf

no management api restconf

default management api restconf

Commands Available in Restconf API Management Configuration Mode

transport (Restconf API Management)

Examples

This command places the switch in Restconf API Management configuration mode.
```
switch(config)# management api restconf
switch(config-mgmt-api-restconf)#
```
This command returns the switch to global management mode.
```
switch(config-mgmt-api-restconf)# exit
switch(config)#
```

management console

The management console command places the switch in mgmt-console configuration mode to adjust the idle-timeout period for console connection sessions. The idle-timeout period determines the inactivity interval that terminates a connection session.

The no management console and default management console commands delete mgmt-console configuration mode statements from running-config.

The mgmt-console configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting the mgmt-console configuration mode does not affect running-config. The exit command returns the switch to global configuration mode.

Command Mode

Global Configuration

Command Syntax

management console

no management console

default management console

Commands Available in mgmt-console Configuration Mode

idle-timeout (Console Management)

Examples

This command places the switch in mgmt-console configuration mode:
```
switch(config)# management console
switch(config-mgmt-console)#
```
This command returns the switch to global management mode:
```
switch(config-mgmt-console)# exit
switch(config)#
```

management ssh

The management ssh command places the switch in mgmt-ssh configuration mode to adjust SSH session connection parameters.

The no management ssh and default management ssh commands delete the mgmt-ssh configuration mode statements from running-config.

The mgmt-ssh configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting the mgmt-ssh configuration mode does not affect running-config. The exit command returns the switch to global configuration mode.

Command Mode

Global Configuration

Command Syntax

management ssh

no management ssh

default management ssh

Commands Available in Mgmt-ssh Configuration Mode

authentication mode (Management-SSH)
cipher (Management-SSH)
fips restrictions (Management-SSH)
hostkey (Management-SSH)
idle-timeout (Management-SSH)
ip access group (Management-SSH)
ipv6 access group (Management-SSH)
login timeout (Management-SSH)
key-exchange (Management-SSH)
mac hmac (Management-SSH)
server-port (Management-SSH)
shutdown (Management-SSH)
vrf (Management-SSH)

Examples

This command places the switch in mgmt-ssh configuration mode:
```
switch(config)# management ssh
switch(config-mgmt-ssh)#
```
This command returns the switch to global management mode:
```
switch(config-mgmt-ssh)# exit
switch(config)#
```

management telnet

The management telnet command places the switch in mgmt-telnet configuration mode to adjust telnet session connection parameters.

The no management telnet and default management telnet commands delete the mgmt-telnet configuration mode statements from running-config.

The mgmt-telnet configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting the mgmt-telnet configuration mode does not affect running-config. The exit command returns the switch to global configuration mode.

Command Mode

Global Configuration

Command Syntax

management telnet

no management telnet

default management telnet

Commands Available in mgmt-telnet Configuration Mode

idle-timeout (Management-Telnet)
ip access group (Management-Telnet)
ipv6 access group (Management-Telnet)
shutdown (Management-Telnet)
vrf (Management-Telnet)

Examples

This command places the switch in mgmt-telnet configuration mode:
```
switch(config)# management telnet
switch(config-mgmt-telnet)#
```
This command returns the switch to global management mode:
```
switch(config-mgmt-telnet)# exit
switch(config)#
```

management xmpp

The management xmpp command places the switch in mgmt-xmpp configuration mode. Management over XMPP is disabled by default. To enable XMPP, you must provide the location of the XMPP server along with the username and password for the switch.

The no management xmpp and default management xmpp commands delete the mgmt-xmpp configuration mode statements from running-config.

The mgmt-xmpp configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting the mgmt-xmpp configuration mode does not affect running-config. The exit command returns the switch to global configuration mode.

Command Mode

Global Configuration

Command Syntax

management xmpp

no management xmpp

default management xmpp

Commands Available in Mgmt-xmpp Configuration Mode

domain (Management-xmpp)
server (Management-xmpp)
session (Management-xmpp)
shutdown (Management-xmpp)
switch-group (Management-xmpp)
username (Management-xmpp)
vrf (Management-xmpp)

Examples

This command places the switch in mgmt-xmpp configuration mode:
```
switch(config)# management xmpp
switch(config-mgmt-xmpp)#
```

This command returns the switch to global management mode:

switch(config-mgmt-xmpp)# exit
switch(config-mgmt-xmpp)#

protocol http (API Management)

The protocol http command enables the hypertext transfer protocol (HTTP) server.

The no protocol http and default protocol http commands disable the HTTP server by removing the protocol http statement from running-config.

Command Mode

Mgmt-API Configuration

Command Syntax

protocol http [TCP_PORT]

no protocol http

default protocol http

Parameters

TCP_PORT Port number used for the HTTP server. Options include:
- no parameter Specifies default port number 80.
- port 1 to 65535 Specifies HTTP server port number. The value ranges from 1 to 65535.
localhost The name of the server bound on the localhost.
port The number of the TCP port to serve on.

Related Commands

management api http-commands places the switch in mgmt-api configuration mode.

Example

These commands enables the management API for the HTTP server.

switch(config)#management api http-commands
switch(config-mgmt-api-http-cmds)#

protocol https (API Management)

The protocol https command enables the HTTP secure server. The HTTP secure server is active by default.

The default protocol https command restores the default setting by removing the no protocol https statement from running-config. The no protocol https command disables the HTTP secure server.

Command Mode

Mgmt-API Configuration

Command Syntax

protocol https [TCP_PORT]

no protocol https

default protocol https

Parameters

TCP_PORT Port number used for the HTTPS server. Options include:
- no parameter Specifies default port number 443.
- port 1 to 65535 Specifies HTTP server port number. The value ranges from 1 to 65535.
certificate The HTTPS key and certificate to use.
cipher Exclusive list of cryptographic ciphers.
key-exchange Exclusive list of key-exchange algorithms.
mac Exclusive list of MAC algorithms.
port The number of the TCP port to serve on.
ssl Configure SSL options.

Related Commands

management api http-commands places the switch in mgmt-api configuration mode.

Examples

These commands enables service to the HTTP server. The no shutdown command allows access to the service.

switch(config)# management api http-commands 
switch(config-mgmt-api-http-cmds)# protocol https
switch(config-mgmt-api-http-cmds)# no shutdown

These commands specify the port number used for the HTTPS server. The no shutdown command allows access to the service.

switch(config)# management api http-commands 
switch(config-mgmt-api-http-cmds)# protocol https port 52
switch(config-mgmt-api-http-cmds)# no shutdown

protocol https certificate (API Management)

The protocol https certificate command configures the HTTP secure server to request an X.509 certificate from the client. The client then authenticates the certificate with a public key.

The no protocol https certificate and default protocol https certificate commands restore default behavior by removing the protocol https certificate statement from running-config.

Command Mode

Mgmt-API Configuration

Command Syntax

protocol https certificate

no protocol https certificate

default protocol https certificate

Related Command

management api http-commands places the switch in mgmt-api configuration mode.

Example

These commands configure the HTTP secure server to request an X.509 certificate from the client for authentication.

switch(config)#management api http-commands 
switch(config-mgmt-api-http-cmds)#protocol https certificate
switch(config-mgmt-api-http-cmds)#

reset system storage secure

Use the reset system storage secure command to trigger the secure erase mechanism. A secure erase is a command that deliberately, permanently, and irreversibly removes/destroys the data stored on a storage device, rendering that data unrecoverable.

Command Mode

EXEC

Command Syntax

reset system storage secure

Examples

To trigger the secure erase mechanism, use the reset system storage secure command.

switch# reset system storage secure
WARNING! This will destroy all
data and will NOT be recoverable.
Device will reboot into Aboot, and
execution may take up to one hour.
Would you like to proceed? [y/N]

If a particular platform does not support the reset system storage secure command , the following message will appear:
```
switch#reset system storage secure
% Unavailable command (not supported on this hardware platform)
```

server (XMPP Management)

The server command adds an XMPP server to running-config. You can set up multiple XMPP servers for redundancy. The XMPP server location should be a DNS name and not a raw IP address for redundant configurations. The DNS server returns the list of available XMPP servers, which the client can use to find an accessible server.

The XMPP server provides the user authentication. EOS local configuration or TACACS+ provides the command authentication. The XMPP server should use the same authentication source as the switches. RADIUS is not supported as an XMPP authorization mechanism.

Theno server and default server commands remove the specified XMPP server from running-config.

Command Mode

Mgmt-xmpp Configuration

Command Syntax

server SERVER_NAME [SERVER_PORT]

no server

default server

Parameters

SERVER_NAME XMPP server location. Options include:
- IP address in dotted decimal notation.
- a host name for the XMPP server.
SERVER_PORT Server port. Options include:
- port 1 to 65535 where number ranges from 1 to 65535. If no port is specified, the default port 5222 is used.

Examples

This command configures the server hostname arista-xmpp to server port 1.

switch(config)# management xmpp
switch(config-mgmt-xmpp)# server arista-xmpp port 1

This command removes the XMPP server.
```
switch(config-mgmt-xmpp)# no server
```

session privilege (XMPP Management)

The session privilege command will place the user in EXEC mode. By default, the initial privilege level is meaningless. However, with the configuration of roles, users can add meaning to the different privilege levels. By default, XMPP does not limit access to any command.

Level 1-15: Commands accessible from EXEC Mode.

If AAA is not configured and the switch is configured to connect to the XMPP client, any message received is executed with privilege level 1 by default.

The no session privilege and default session privilege commands revert the list contents to none for the specified privilege levels.

Command Mode

Mgmt-xmpp Configuration

Command Syntax

session privilege PRIV_LEVEL

no session privilege

default session privilege

Parameter

PRIV_LEVEL Privilege levels of the commands.The value ranges from 0 and 15.

Examples

These commands authorize configuration commands (privilege level config 5) for XMPP.

switch(config)#(config)# management xmpp
switch(config-mgmt-xmpp)# session privilege 5
switch(config-mgmt-xmpp)#

This command removes the privilege levels set for the XMPP session.

switch(config)# management xmpp
switch(config-mgmt-xmpp)# no session privilege

show inventory

The show inventory command displays the hardware components installed in the switch. Each component has a serial number and a description.

Command Mode

EXEC

Command Syntax

show inventory

Example

This command displays the hardware installed in a DCS-7150S-52 switch.

switch> show inventory
System information
  Model                    Description
  ------------------------ ----------------------------------
  DCS-7150S-52-CL          52-port SFP+ 10GigE 1RU + Clock

  HW Version  Serial Number  Mfg Date
  ----------- -------------- ----------
  02.00       JPE13120702    2013-03-27

System has 2 power supply slots
  Slot Model            Serial Number
  ---- ---------------- ----------------
  1    PWR-460AC-F      K192KU00241CZ
  2    PWR-460AC-F      K192L200751CZ

System has 4 fan modules
  Module  Number of Fans  Model            Serial Number
  ------- --------------- ---------------- ----------------
  1       1               FAN-7000-F       N/A
  2       1               FAN-7000-F       N/A
  3       1               FAN-7000-F       N/A
  4       1               FAN-7000-F       N/A

System has 53 ports
  Type             Count
  ---------------- ----
  Management       1
  Switched         52

System has 52 transceiver slots
  Port Manufacturer     Model            Serial Number    Rev
  ---- ---------------- ---------------- ---------------- ----
  1    Arista Networks  SFP-10G-SR       XCW1225FD753     0002
  2    Arista Networks  SFP-10G-SR       XCW1225FD753     0002

  51   Arista Networks  SFP-10G-SR       XCW1225FD753     0002
  52   Arista Networks  SFP-10G-SR       XCW1225FD753     0002

switch>

show xmpp neighbors

The show xmpp neighbors command displays all neighbors and their connection status. The XMPP server keeps track of all relationships between its users.

Command Mode

EXEC

Command Syntax

show xmpp neighbors

Example

This command displays all the XMPP neighbors and their connection status.

switch# show xmpp neighbors
Neighbor                          State           Last Seen Login Time
------------------------------    --------------- ---------------------
This email address is being protected from spambots. You need JavaScript enabled to view it.     present         0:01:40 ago
This email address is being protected from spambots. You need JavaScript enabled to view it.     present         20:29:39 ago

Neighbor                          Status Message
------------------------------    -------------------------------------
This email address is being protected from spambots. You need JavaScript enabled to view it.
This email address is being protected from spambots. You need JavaScript enabled to view it.   Arista Networks DCS-7048T-4S
switch#

show xmpp status

The show xmpp status command displays the current XMPP connection status to the server.

The XMPP server keeps track of all relationships between its users. For two users to communicate directly, the other party must establish and confirm this relationship.

Switches automatically confirm requests from outside parties as long as they are users from the same domain name, for example, when you chat with your switch from your XMPP chat client.

Command Mode

EXEC

Command Syntax

show xmpp status

Example

This command displays the server's current XMPP connection status.

switch#show xmpp status
XMPP Server:  port 5222
Client username: This email address is being protected from spambots. You need JavaScript enabled to view it.
Default domain: test.aristanetworks.com
Connection status: connected
switch#

show xmpp switch-group

The show xmpp switch-group command displays the configured and active switch groups for the switch.

Command Mode

EXEC

Command Syntax

show xmpp switch-group

Example

This command displays the configured and active switch groups.

switch# show xmpp switch-group
This email address is being protected from spambots. You need JavaScript enabled to view it.
switch#

shutdown (API Management)

The shutdown command disables management over API on the switch in mgmt-api configuration mode. API is disabled by default.

The no shutdown command enables the management API access in mgmt-api configuration mode.

The default shutdown command disables the management API access in mgmt-api configuration mode.

Command Mode

Mgmt-API Configuration

Command Syntax

shutdown

no shutdown

default shutdown

Related Command

management api http-commands places the switch in mgmt-api configuration mode.

Examples

These commands disable API access to the HTTP server.

switch(config)# management api http-commands 
switch(config-mgmt-api-http-cmds)# shutdown
switch(config-mgmt-api-http-cmds)#

These commands enable API access to the HTTP server.

switch(config)# management api http-commands 
switch(config-mgmt-api-http-cmds)# no shutdown
switch(config-mgmt-api-http-cmds)#

shutdown (Telnet Management)

The shutdown command disables or enables Telnet on the switch in management-telnet mode. Telnet is disabled by default. The management telnet command places the switch in management-telnet mode.

To enable Telnet, enter no shutdown at the management-telnet prompt.
To disable Telnet, enter shutdown at the management-telnet prompt.

Command Mode

Management-Telnet Configuration

Command Syntax

shutdown

no shutdown

Examples

These commands enable Telnet and return the switch to global configuration mode.

switch(config)# management telnet
switch(config-mgmt-telnet)# no shutdown
switch(config-mgmt-telnet)# exit
switch(config)#

This command disables Telnet.
```
switch(config-mgmt-telnet)# shutdown
```

shutdown (XMPP Management)

The shutdown command disables or enables management over XMPP on the switch in management-telnet mode.XMPP is disabled by default.

The no shutdown and default shutdown commands re-enable XMPP by removing the shutdown command from running-config.

Command Mode

Mgmt-xmpp Configuration

Command Syntax

shutdown

no shutdown

default shutdown

Examples

These commands enable management over XMPP and return the switch to global configuration mode.
```
switch(config-mgmt-xmpp)# no shutdown
switch(config-mgmt-xmpp)# exit
switch(config)#
```

This command disables management over XMPP.

switch(config-mgmt-xmpp)# shutdown
switch(config-mgmt-xmpp)#

switch-group (XMPP Management)

The switch-group command allows you to configure each switch to join specified chat rooms on startup. The switch is configured to belong to the specified chat room to participate in a chat group.

The no switch-group and default switch-group commands delete the specified switch-group configuration (or all switch-group configurations if no name is specified) by removing the corresponding switch-group statement from running-config.

Command Mode

Mgmt-xmpp Configuration

Command Syntax

switch-group name SECURITY

no switch-group

default switch-group

Parameters

name Group name text that the user enters at the login prompt to access the CLI. To enter multiple names in a single command, separate them with spaces.
Valid usernames begin with A-Z, a-z, or 0-9 and may also contain any of these characters:
@ # $ % ^ & * - _ = + ; < > ,. ~ |
SECURITY password assignment.
- password pwd_txt name is protected by a specified password. pwd_txt is a clear-text string.
- password 0 pwd_txt name is protected by a specified password. pwd_txt is a clear-text string.
- password 7 pwd_txt name is protected by a specified password. pwd_txt is encrypted string.

Guidelines

A switch group is an arbitrary grouping of switches within the network belonging to one chat group.
In order to belong to one or more switch groups, the switch has to be manually assigned to it.
Switch groups are defined dynamically based on the configuration of all of the switches in the network.
As per the multi-user chat XMPP standard (XEP-0045), switch groups have the full name of This email address is being protected from spambots. You need JavaScript enabled to view it..
All CLI commands allow either the full group name or the short name, which are appended the @conference.DOMAIN.
You must configure each group with a separate command if the switch belongs to multiple chat rooms.

Examples

These commands configure the switch-group to be part of the chat room.

switch(config)# management xmpp
switch(config-mgmt-xmpp)# switch-group 
This email address is being protected from spambots. You need JavaScript enabled to view it. password 0 arista

Use the show xmpp switch-group to verify the active switch-group for the switch.

switch# show xmpp switch-group
This email address is being protected from spambots. You need JavaScript enabled to view it.

username (XMPP Management)

The username command configures the switch's username and password on the XMPP server.

The no username and default username commands delete the specified username by removing the corresponding username statement from running-config.

Command Mode

Mgmt-xmpp Configuration

Command Syntax

username name SECURITY

no username

default username

Parameters

name username text that defines the XMPP username and password.
Valid usernames begin with A-Z, a-z, or 0-9 and may also contain any of these characters:
@ # $ % ^ & * ( ) - _ = + { } [ ] ; < > ,. ~ |
SECURITY password assignment.
- password pwd_txt name specifies and unencrypted shared key. pwd_txt is a clear-text string.
- password 0 pwd_txt name specifies and unencrypted key. pwd_txt is a clear-text string.
- password 7 pwd_txt name specifies a hidden key. pwd_txt is an encrypted string.

Guidelines

Encrypted strings entered through this parameter are generated elsewhere. The password 7 option (SECURITY) is typically used to enter a list of username-passwords from a script.

Examples

These commands create the username and assign it a password. The password is entered in clear text because the parameter is set to 0.

switch(config)# management xmpp
switch(config-mgmt-xmpp)# server arista-xmpp
switch(config-mgmt-xmpp)# domain test.aristanetworks.com
switch(config-mgmt-xmpp)# username This email address is being protected from spambots. You need JavaScript enabled to view it. password 0 arista
switch(config-mgmt-xmpp)# no shutdown

This command removes all usernames from the XMPP server.

switch(config-mgmt-xmpp)# no username 
switch(config-mgmt-xmpp)#

vrf (API Management)

The vrf command places the switch in the server's VRF configuration mode. If the named VRF does not already exist, this command creates it.

Command Mode

Mgmt-API Configuration

Command Syntax

vrf VRF_INSTANCE

Parameters

VRF_INSTANCE specifies the VRF instance.

default Instance created in the default VRF.
vrf_nameInstance created in the specified user-defined VRF.

Related Command

management api http-commands places the switch in mgmt-api configuration mode.

Example

This command creates a VRF named management-vrf and places the switch in VRF configuration mode for the new VRF.

switch(config)# management api http-commands 
switch(config-mgmt-api-http-cmds)# vrf management-vrf
switch(config-mgmt-api-http-cmds-vrf-management-vrf)#

vrf (XMPP Management)

The vrf command places the switch in VRF configuration mode for the XMPP server. If the named VRF does not already exist, this command creates it.

The VRF configuration for the client is for the entire XMPP service rather than per server. All servers resolving on a particular hostname must be reachable in the same VRF.

Command Mode

Mgmt-xmpp Configuration

Command Syntax

vrf [VRF_INSTANCE]

Parameters

VRF_INSTANCE specifies the VRF instance.

default Instance created in the default VRF.
vrf_name Instance created in the specified user-defined VRF.

Example

This command creates a VRF named management-vrf and places the switch in VRF configuration mode for the server.

switch(config)# management xmpp 
switch(config-mgmt-xmpp)# vrf management-vrf
switch(config-mgmt-xmpp)

xmpp send

The xmpp send command can connect to the XMPP server and send messages to switches or switch groups within the network.

Before switches can send messages, they must be friend with each other. An easy way to have them auto-friend each other is to have them join the same chat room. The show xmpp neighbor command verifies the friendship between switches.

Command Mode

Privileged EXEC

Command Syntax

xmpp send to neighbor XMIT_TYPE content

Parameters

neighbor Options include switches or switch groups within the network that are connected as friends in a chat room.
XMIT_TYPE Transmission type. Valid options include:
- command Sends an XMPP command.
- message Sends an XMPP message.
content The command you want the friends within the chat room to display or execute.

Configuration Restrictions

Only enable-mode commands are allowed within the multi-switch CLI.
Changing into a different CLI mode and running several commands is not supported (e.g., into configuration mode).
An external XMPP client (for example, Adium) sends multiple lines within a single message. By sending multiple lines, it is possible to change to another CLI mode. After the message is processed, the switch automatically returns to the enable mode.
Commands that prompt for a response (like reload) are not supported.
Long commands, such as image file copies, may cause the switch XMPP client to stop responding and disconnect momentarily. The switch should reconnect, and the long command should be complete.
Many command outputs are displayed in a specific table format. Select a mono-spaced font, such as Courier, for the incoming messages to achieve the same visual feel as through a terminal.

Example

This command sends the switch in the chat room the request to execute the show version command.

switch# xmpp send test2 command show version
message from user: This email address is being protected from spambots. You need JavaScript enabled to view it.
--------------------------------------------------
Hardware version:     04.40
Serial number:        JFL08432083
System MAC address:   001c.7301.7d69
Software image version:  4.12.3
Architecture:            i386
Internal build version:  4.12.3
Internal build ID:       f5ab5f57-9c26-4fe4-acaa-fb60fa55d01d
Uptime:                  2 hours and 38 minutes
Total memory:            1197548 kB
Free memory:             182452 kB

xmpp session

The xmpp session command is similar to running SSH from the switch. The user must input their username (default isUSER@DEFAULTDOMAIN) and password in order to connect to the XMPP server. This command allows you to interact in the enable mode with a switch or switch group over XMPP using the standard CLI, with access to help and tab completion. All commands are then executed remotely and only the non-empty results are displayed on the screen.

Command Mode

Privileged EXEC

Command Syntax

xmpp session switchgroup

Parameters

switchgroup The option includes the switch group within the network that is connected as friends in a chat room.

Configuration Restrictions

Only enable-mode commands are allowed within the multi-switch CLI.
Changing into a different CLI mode and running several commands is not supported (e.g., into configuration mode).
An external XMPP client (for example, Adium) can send multiple lines within a single message. By sending multiple lines, it is possible to change into another CLI mode. After the message is processed, the switch automatically returns to the enable mode.
Commands that prompt for a response (like reload) are not supported.
Long commands, such as image file copies, may cause the switch XMPP client to stop responding and disconnect momentarily. The switch should reconnect, and the long command should be complete.
Many command outputs are displayed in a specific table format. Select a mono-spaced font, such as Courier, for the incoming messages to achieve the same visual feel as through a terminal.

Example

This command displays the status of Ethernet 3 from test1, which is a member of the switch group chat room.

switch# xmpp session This email address is being protected from spambots. You need JavaScript enabled to view it.
xmpp-all# show int Eth3 status

response from: This email address is being protected from spambots. You need JavaScript enabled to view it.
--------------------------------------------------
Port  Name  Status     Vlan     Duplex  Speed   Type
Et3   bs3   connected  in Po3   a-full  a-1000  10GBASE-SR
switch#

Administering the Switch

This chapter describes administrative tasks that are typically performed only after initially configuring the switch or after recovery procedures.

This chapter includes these sections:

Managing the Switch Name

These sections describe how to configure the switch's domain and host name.

Assigning a Name to the Switch describes assigning an FQDN to the switch.
Specifying DNS Addresses describes adding name servers to the configuration.

Assigning a Name to the Switch

A Fully Qualified Domain Name (FQDN) labels the switch and defines its organization ID in the Domain Name System hierarchy. The switch's FQDN consists of a host name and domain name.

The host name is uniquely associated with one device within an IP-domain. The default host name is localhost. You can configure the prompt to display the host name as described in prompt.

To assign a host name to the switch, use the hostname command. To return the switch’s host name to the default value of localhost, use the no hostname command.
To specify the domain location of the switch, use the dns domain command.

Examples

This command assigns the string main-host as the switch's host name.
```
switch(config)# hostname main-host
main-host(config)#
```
This command configures aristanetworks.com as the switch's domain name.
```
switch(config)# dns domain aristanetworks.com
switch(config)#
```
This procedure configures sales1.samplecorp.org as the switch's FQDN.
```
switch(config)# dns domain samplecorp.org
switch(config)#
```

This running-config extract contains the switch's host name and IP-domain name.

switch# show running-config
! Command: show running-config
! device: switch (DCS-7150S-64-CL, EOS-4.13.2F)
!

vlan 3-4
!
username john secret 5 $1$a7Hjept9$TIKRX6ytkg8o.ENja.na50
!
hostname sales1
ip name-server vrf default 172.17.0.22
dns domain samplecorp.org
!

end
switch#

Specifying DNS Addresses

The Domain Name Server (DNS) maps FQDN labels to IP addresses and provides addresses for network devices. Each network requires at least one server to resolve addresses. The configuration file can list a maximum of three server addresses.

To add name servers to the configuration, use the ip name-server command. Each command can add multiple servers. All server addresses support multiple VRFs, and a priority may be specified for each server named. If all name servers have the default priority (0), the default DNSmasq behavior is followed for the configuration. It queries all name servers simultaneously and forwards the requests to the first name server for 50 queries or 20 seconds, whichever expires sooner for answering. If any priorities are non-zero, queries are issued in order with a five second timeout between unresponsive name servers.

Note: DNSmasq does not fulfill in-flight requests to unresponsive name servers.

Example

This code displays the configuration file.

switch(config)# show ip name-server 
IP Address VRF     Priority
---------- ------- --------
10.0.0.1   default        0
10.0.0.2   default        1
10.0.0.1   vrf1           2
10.0.0.2   vrf1           3
fc00::1    default        4

The switch assigns source IP addresses to outgoing DNS requests. To force the switch to use a single, user-defined source interface for all requests, use the ip domain lookup command.

Examples

This command forces the switch to use VLAN 5 as the source interface for DNS requests originating from the default VRF.
```
switch(config)# ip domain lookup source-interface Vlan5
switch(config)#
```
This command forces the switch to use VLAN 10 as the source interface for DNS requests originating from VRF purple.
```
switch(config)# ip domain lookup vrf purple source-interface Vlan10
switch(config)#
```

This command configures up to four name servers on VRF purple.

switch(config)# ip name-server vrf purple 10.1.1.24 priority 4
switch(config)#

This command removes the name servers.

switch(config)# no ip name-server vrf purple 10.1.1.24
switch(config)#

This command removes all configured name in all VRFs.

switch(config)# no ip name-server 
switch(config)#

Note:

NXDOMAIN is considered a valid reply for the query.

System Clock and Time Protocols

The switch uses the system clock to display the time and time-stamping messages. Set the system clock to Coordinated Universal Time (UTC); the switch calculates local time based on the time zone setting. Time-stamps and time displays are in local time. The system clock can be set manually or via Network Time Protocol (NTP); any NTP servers properly configured on the switch override time manually entered.

The following sections deal with the configuration of the system clock and the use of NTP and PTP.

Configuring the Time Zone
Setting the System Clock Manually
Displaying the Time
Network Time Protocol (NTP)

Configuring the Time Zone

Select the switch's time zone to convert the system time (UTC) to local time. To specify the time zone, use the clock timezone command.

Examples

These commands configure the switch for the United States Central Time Zone.

switch(config)# clock timezone US/Central
switch(config)#show clock
Mon Jan 14 18:42:49 2013
timezone is US/Central
switch(config)#

To view the predefined time zone labels, enter clock timezone with a question mark.

switch(config)# clock timezone ? 
 Africa/Abidjan                    Africa/Accra

  WET                               WET timezone
  Zulu                              Zulu timezone

switch(config)#clock timezone

This command displays all time zone labels that start with America.

switch(config)# clock timezone AMERICA?
America/Adak                    America/Anchorage

America/Yellowknife

switch(config)#clock timezone AMERICA

Setting the System Clock Manually

The clock set command manually configures the system clock time and date in local time. Manually enter any NTP servers properly configured on the switch override time.

Example

This command manually sets the switch time.

switch# clock set 08:15:24 14 Jan 2013
Mon Jan 14 08:15:25 2013
timezone is US/Central

Displaying the Time

Enter the show clock command to display the local time and configured time zone.

Example

This command displays the switch time.

switch(config)# show clock
Mon Jan 14 16:32:46 2013
timezone is America/Los_Angeles

Network Time Protocol (NTP)

Network Time Protocol (NTP) is enabled on the switch by default, and time settings from any properly configured NTP server will override manual setting of the system clock.

NTP servers synchronize time settings of systems running an NTP client. The switch supports NTP versions 1 through 4. The default is version 4. After configuring the switch to synchronize with an NTP server, it may take up to ten minutes for the switch to set its clock.Select the configured running-config lists of the NTP servers that the switch uses.

The following NTP sections deal with NTP on the switch:

Configuring the NTP Server
Configuring the NTP Source
Configuring the Switch as an NTP Server
Configuring NTP Authentication
Viewing NTP Settings and Status

Configuring the NTP Server

The ntp server command adds a server to the list or modifies the parameters of a previously listed address. When the system contains multiple NTP servers, the prefer keyword can be used to specify a preferred NTP server, which will be used as the NTP server if not discarded by NTP.

Note that all NTP servers must be in the same VRF and added in the default VRF if no VRF is specified.

The system clock is set via NTP if NTP is enabled, at least one NTP server is properly configured on the switch, and NTP overrides the manual setting of the system clock. Enable NTP by default. To disable NTP, select the no ntp command.

Example

These commands add three NTP servers, designating the second server as preferred.

switch(config)# ntp server local-NTP
switch(config)#ntp server 172.16.0.23 Prefer
switch(config)#ntp server 172.16.0.25

Configuring the NTP Source

A local interface can be specified as the source in outgoing NTP packets using the ntp local-interface command to control the address to which NTP responses to the switch are sent. The IP address of that interface is then used as the source address in all outgoing NTP packets unless the switch is acting as an NTP server and a server-specific source is configured using the source option of the ntp server command.

Example

This command configures the IP address of VLAN interface 25 as the source specified in all outgoing NTP packets.

switch(config)# ntp local-interface vlan 25
switch(config)#

Configuring the Switch as an NTP Server

To configure the switch to accept NTP requests on all interfaces, use the ntp serve all command to enable NTP server mode globally on the switch. To configure an individual interface to accept or deny NTP requests, use the ntp serve command. Interface level settings override the global settings, and changing the settings at either the global or interface level also causes the switch to re-synchronize with its upstream NTP server. Disable the NTP server mode by default.

Examples

This command configures the switch to act as an NTP server, accepting NTP requests.
```
switch(config)# ntp serve all
switch(config)#
```
These commands configure interface ethernet 5 to accept NTP requests regardless of global settings.
```
switch(config)# interface ethernet 5
switch(config-if-Et5)#ntp serve
switch(config-if-Et5)#
```

Configuring NTP Authentication

The switch can be configured to accept NTP packets only from an authenticated server or client. Disable the NTP authentication by default.

To configure the switch to authenticate NTP packets, create one or more authentication keys using the ntp authentication-key command, specify which keys are trusted by using the ntp trusted-key command, use the ntp authenticate command to enable NTP authentication, and specify to use the trusted-key for a specific server. The NTP server must be configured to select the same authentication key and key ID number.

Note: Enable when NTP authentication on a switch; all NTP servers upstream of the switch and all NTP clients of the switch should have matching keys configured, and clients must have NTP authentication enabled.

Example

These commands configure the switch to authenticate NTP packets using key 328 with the plaintext password timeSync.

switch(config)# ntp authentication-key 328 md5 timeSync
switch(config)#ntp trusted key 328
switch(config)#ntp authenticate
switch(config)#

Viewing NTP Settings and Status

To display the status of Network Time Protocol (NTP) on the switch, use the show ntp status command. To display the status of connections to NTP servers, use the show ntp associations command.

Note: In the output for show ntp associations, the reference ID (which identifies the time source of the NTP server) is either the IPv4 address of the time source or, if that source has an IPv6 address, the first four octets of the MD5 hash of that IPv6 address. In EOS releases prior to 4.23.2, the show ntp status command identified the system peer by its reference ID as described above. Still, in later releases, it shows the IP address (whether IPv4 or IPv6).

Examples

This command displays the status of the switch’s NTP connection.

switch# show ntp status
synchronised to NTP server (192.168.78.62) at stratum 3
   time correct to within 66 ms
   polling server every 1024 s
switch #

This command displays data about the NTP servers in the configuration.

switch# show ntp associations
remote           refid          st t when  poll reach   delay   offset  jitter 
==============================================================================
+l.ntp.arista.co 125.157.10.11   2 u  539  1024  377  121.748   -0.345   0.893
-3.ntp.arista.co 127.31.152.34   2 u  868  1024  377  101.671    2.434   1.529
+2.ntp.arista.co 176.131.12.185  2 u  676  1024  377  116.505     0.03   0.768
*4.ntp.arista.co 120.181.192.192 2 u  696  1024  377   48.431   -0.416    0.15
switch#

Managing Display Attributes

Display commands control the content of the banner and the command line prompt.

Banners

The switch can display two banners:

Login banner: The login banner precedes the login prompt. One common use for a login banner is to warn against unauthorized network access attempts.
motd banner: The message of the day (motd) banner is displayed after a user logs into the switch.

This output displays both banners in bold:

This is a login banner
switch login: john
Password:
Last login: Mon Jan 14 09:24:36 2013 from adobe-wrks.aristanetworks.com
This is an motd banner
switch>

These commands create the login and motd banner shown earlier in this section.

switch(config)# banner login
Enter TEXT message. Type 'EOF' on its line to end.
This is a login banner
EOF
switch(config)# banner motd
Enter TEXT message. Type 'EOF' on its own line to end.
This is an motd banner
EOF
switch(config)#

To create a banner:

Enter global configuration mode.
```
switch# config
switch(config)# 
```
Enter banner edit mode by typing the desired command:
- To create a login banner, type banner login.
- To create a motd banner, type banner motd
  The switch responds with instructions on entering the banner text.
```
switch(config)# banner login 
Enter TEXT message. Type 'EOF' on its own line to end. 
```
Enter the banner text.
This is the first line of banner text.

This is the second line of banner text.
Press Enter to place the cursor on a blank line after completing the banner text.
Exit banner edit mode by typing EOF.
```
EOF 
switch(config)# 
```

Configuring prompt

The prompt provides an entry point for EOS commands. The prompt command configures the contents of the prompt. The no prompt command returns the prompt to the default of %H%P.

Characters allowed in the prompt include A-Z, a-z, 0-9, and these punctuation marks:

! @ # $ % Âˆ & * ( ) - = + f g [ ] ; : < > , . ? / Â˜ n

The prompt supports these control sequences:

%s “ space character
%t “ tab character
%% “ percent character
%H “ host name
%D “ time and date
%D{f_char} “ time and date, format specified by the BSD strftime (f_char) time conversion function.
%h “ host name up to the first."
%P “ extended command mode
%p “ command mode
%r “ redundancy status on modular systems (has no effect on a fixed system)
%R “ extended redundancy status on modular systems â€“ includes status and slot number (has no effect on a fixed system)

Examples

This command creates a prompt that displays system 1 and the command mode.
```
switch(config)# prompt system%s1%P
system 1(config)#
```
This command creates a prompt that displays the command mode.
```
switch(config)# prompt %p
(config)#
```

These equivalent commands create the default prompt.

% prompt %H%P
host-name.dut103(config)#

%no prompt
host-name.dut103(config)#

Logging of Event Notifications

Arista switches log event notifications using the Syslog protocol. By default, event notifications are logged internally to /var/log/messages but can also be displayed on the console or logged to an external server. Severity levels and log message destinations can be configured via the CLI, and individual processes and protocols can also be configured to adjust or limit the messages they log. The show logging command may view details of the current logging configuration.

For a full list of Syslog messages, visit the Arista website.

Managing TCAM Capacity Warnings

Strata chipsets (present in the 7010, 7050X, 7060X, 7250X, 7260X, and 7300X series) provide event logging for the hardware capacity of TCAM tables on a per-slice basis, triggering a capacity warning by default whenever any TCAM slice exceeds 90% capacity. As a result, default TCAM logging can generate high levels of syslog messages on these platforms. Suppose this presents a problem, and the hardware capacity alert table command can adjust the capacity levels at which warnings occur above the 90% default. In that case, this adjustment can be made per TCAM resource and per slice. The command can also disable TCAM hardware capacity messages at the level “Warning” and below for a given slice. To disable messages, set the threshold to 0 or select the no version of the command.

Examples

This command reduces hardware capacity Syslog warnings by increasing the capacity threshold to 99% for EFP table monitoring in slice 2.
```
switch(config)# hardware capacity alert table EFP feature Slice-2 threshold 99
```
This command reduces messages by disabling hardware capacity Syslog warnings entirely for the IFP table in slice 5.
```
switch(config)# hardware capacity alert table IFP feature Slice-5 threshold 0
```
This command reduces messages by disabling hardware capacity Syslog warnings entirely for the VFP table in all slices.
```
switch(config)# no hardware capacity alert table VFP
```

Note:

Hardware capacity messages are user-configurable only at or below the “Warning” level. When depleting TCAM management software, it always sends “Error” messages to Syslog and affected features when all TCAM resources are used.

Event Monitor

The event monitor writes system event records to local files for access by SQLite database commands.

Note: Beginning with release EOS-4.20.5F, event-monitor is not enabled by default. Use the event-monitor command to explicitly enable event-monitor.

Description

The event monitor receives notifications for important events or changes to the enabled event monitor tables. These changes are logged to a fixed-size circular buffer. The size of this buffer is configurable, but it does not grow dynamically. Buffer contents can be stored to permanent files to increase the event monitor effective capacity. The permanent file size and the number of permanent files is configurable. The buffer is stored at a fixed location on the switch.

Specific event monitor queries are available through CLI commands. For queries not available through specific commands, manual queries are supported through other CLI commands. When the user issues a query command, the relevant events from the circular buffer and permanent files are written to and accessed from a temporary SQLite database file. The database keeps a separate table for each logging type (such as MAC, ARP, route, and others). When the monitor receives notification of a new event, the database file is deleted, then recreated.

Configuring the Event Monitor

Enabling the Event Monitor

The event-monitor command enables the event monitor and specifies the types of events that are logged. The event monitor is an event logging service that records system events to a local database. The event monitor records these events:

all changes to all events.
ARP changes to the ARP table (IPv4 address to MAC address mappings).
Neighbor changes to the neighbor table (IPv6 address to MAC address mappings).
backup backed up log files.
buffer changes to the local buffer settings.
IGMP snooping changes to the IGMP snooping table.
LACP changes to the LACP table events.
MAC changes to the MAC address table (MAC address to port mappings).
mroute changes to the IP multicast routing table.
neighbor changes to the neighbor routing table.
route changes to the IPv4 routing table.
route6 changes to the IPv6 routing table.
stpunstable events that cause STP instability.

Beginning with Release EOS-4.20.5F, event-monitor is not enabled by default. Use the event-monitor command to explicitly enable event-monitor. The no event-monitor all disables the event monitor. The no event-monitor command, followed by a log type parameter, disables event recording for the specified type.

Example

This command disables the event monitor for all types of events.
```
switch(config)# no event-monitor all
```
This command enables the event monitor for routing table changes.
```
switch(config)# event-monitor route
```

The event-monitor clear command removes the contents of the event monitor buffer. If event monitor backup is enabled, this command removes the contents from all event monitor backup files.

Example

This command clears the contents of the event monitor buffer.

switch# event-monitor clear
switch(config)#

Configuring the Buffer

The event-monitor buffer max-size command specifies the size of the event monitor buffer. The event monitor buffer is a fixed-size circular data structure that receives event records from the event monitor. When event monitor backup is enabled, the buffer is copied to a backup file before each rollover. Buffer size ranges from 6 Kb to 50 Kb. The default size is 32 Kb.

Example

This command configures a buffer size of 48 Kb.

switch(config)# event-monitor buffer max-size 48
switch(config)#

Configuring Permanent Files

The event-monitor backup path command enables storage of the event monitor buffer to permanent switch files and specifies the path/name of these files. The command references file location either from the flash drive root directory where the CLI operates (/mnt/flash) or from the switch root directory (/).

The event monitor buffer is circular after the buffer is filled, new data replaces older data at the beginning of the buffer. The buffer is copied into a new backup file after each buffer writing cycle before the switch starts re-writing the buffer.

Example

These commands configure the switch to store the event monitor buffer in sw-event.log, then display the new file in the flash directory.

switch(config)# event-monitor backup path eventmon_backup_dir/event.log
switch(config)#
bash-4.3# ls /mnt/flash/eventmon_backup_dir/

arpevent.log.1  lacpevent.log.1  neighborevent.log.1  routeevent.log.1
igmpsnoopingevent.log.1  macevent.log.1   route6event.log.1    
stpunstableevent.log.1

The event-monitor backup max-size command specifies the quantity of event monitor backup files the switch maintains. The switch appends an extension number to the file name when it creates a new file. After every 500 events, the switch deletes the oldest backup file if the file limit is exceeded.

Example

These commands configure the switch to back up the event buffer to a series of files named sw-event.log. The switch can store a maximum of four files.

switch(config)# event-monitor backup path sw-event.log
switch(config)# event-monitor backup max-size 4
switch(config)#

The first five files that the switch creates to store event monitor buffer contents are:

sw-event.log.0

sw-event.log.1

sw-event.log.2

sw-event.log.3

sw-event.log.4

The switch deletes sw-event.log.0 the first time it verifies the number of existing backup files after the creation of sw-event.log.4.

Querying the Event Monitor

These CLI commands perform SQL-style queries on the event monitor database:

The show event-monitor arp command displays ARP table events.
The show event-monitor mac command displays MAC address table events.
The show event-monitor route command displays routing table events.

Example

This command displays all events triggered by MAC address table events.

switch# show event-monitor mac
% Writing 0 Arp, 0 Route, 1 Mac events to the database
2012-01-19 13:57:55|1|0808.0808.0808|Ethernet1|configuredStaticMac|added|0

For other database queries, the show event-monitor sqlite command performs an SQL-style query on the database, using the statement specified in the command.

Example

This command displays all entries from the route table.

switch# show event-monitor sqlite select * from route;
2019-09-30 14:01:21.659428|16.16.16.255/32|default|receiveBcast|0|0|updated|20
2019-09-30 14:01:21.659464|192.168.201.12/30|default|connected|1|0|updated|21
2019-09-30 14:01:21.659497|192.168.1.255/32|default|receiveBcast|0|0|updated|22
2019-09-30 14:01:21.659503|192.168.201.8/32|default|receiveBcast|0|0|updated|23
2019-09-30 14:01:21.659512|16.16.16.0/32|default|receiveBcast|0|0|updated|24
2019-09-30 
14:01:21.659517|192.168.201.12/32|default|receiveBcast|0|0|updated|25
2019-09-30 
14:01:21.659524|192.168.201.15/32|default|receiveBcast|0|0|updated|26
2019-09-30 14:01:21.659541|192.168.201.8/30|default|connected|1|0|updated|27
2019-09-30 14:01:21.659564|16.16.16.0/24|default|connected|1|0|updated|28
2019-09-30 14:01:21.659578|192.168.201.9/32|default|receive|0|0|updated|29

Accessing Event Monitor Database Records

The event-monitor sync command combines the event monitor buffer and all backup logs and synchronizes them into a single SQLite file. The data can be accessed through SQLite or by using the show event-monitor commands described above.

Example

This command synchronizes the buffer and backup logs into a single SQLite file.
```
switch(config)# event-monitor sync
switch(config)#
```

Command-Line Interface (CLI)

The command-line interface (CLI) is one tool for controlling the switch and displaying information about its status and configuration. This chapter describes the use of the CLI.

This chapter includes these sections:

Accessing the EOS CLI
Processing Commands
Kernel-based Virtual Machine Commands and Configuration
Switch Platforms
Command Modes
Managing Switch Configuration Settings
Other Command-Line Interfaces
Directory Structure
Command-Line Interface Commands

Accessing the EOS CLI

You can open an EOS CLI session through these connections:

Ethernet management ports
console port
Telnet connections
Secure Shell (SSH)

The following figure displays the EOS CLI in a Secure Shell connection.

Processing Commands

Command Execution

Command keywords are not case-sensitive. The CLI also accepts truncated keywords that uniquely correspond to one command.

The command abbreviation con does not execute a command in Privileged EXEC mode because the names of two commands begin with these letters: configure and connect.
```
switch# con
% Ambiguous command
```
The command abbreviation conf executes configure in Privileged EXEC mode because no other command name begins with conf.
```
switch# conf
switch(config)#
```

Creating an Alias

The alias command creates an alias for a CLI command. Entering the alias in the CLI executes the corresponding command.

Example

This command makes srie an alias for the command show running-config interface ethernet 1-5.

switch(config)# alias srie show running-config interface ethernet 1-5
switch(config)# srie
interface Ethernet1
   switchport access vlan 33
   storm-control broadcast level 1
   spanning-tree portfast
   spanning-tree bpduguard enable
interface Ethernet2
   switchport access vlan 33
   spanning-tree portfast
interface Ethernet3
   switchport access vlan 33
   spanning-tree portfast
   spanning-tree bpduguard enable
interface Ethernet4
interface Ethernet5
   shutdown

Cursor Movement Keystrokes

EOS supports these cursor movement keystrokes:

Ctrl-B or the Left Arrow key: moves cursor to the left.
Ctrl-F or the Right Arrow key: moves cursor to the right.
Ctrl-A: moves cursor to beginning of line.
Ctrl-E: moves cursor to end of line.
Esc-B: moves cursor left one word.
Esc-F: moves cursor right one word.

History Substitution Keystrokes

The history buffer retains the last 20 commands entered. History substitution keystrokes that access previously entered commands include:

Ctrl-P or the Up Arrow key: Recalls the most recent buffered commands. Repeat to recall older commands.
Ctrl-N or the Down Arrow key: Recalls more recent commands after using the Ctrl-P or the Up Arrow. Repeat to recall newer commands.

The show history command in Privileged EXEC mode displays the history buffer contents.

switch# show history
  en
  config
  exit
  show history

Command Lists and Syntax Assistance

EOS CLI uses widely followed conventions for providing command lists and syntax assistance. These conventions are available in all command modes.

To display all commands available at this level, type a question mark (?):

switchName> ?
  clear       Reset functions
  connect     Open a terminal connection
  default     Set a command to its defaults
  disable     Turn off privileged commands
  enable      Turn on privileged commands
  exit        Exit from the EXEC
  logout      Exit from the EXEC
  no          Negate a command or set its defaults
  ping        Send echo messages
  show        Show running system information
  ssh         Open ssh connection
  tcpdump     Monitor packets with tcpdump
  telnet      Open a telnet connection
  terminal    Configure the terminal
  traceroute  Trace route to destination
  watch       Execute a command repeatedly
  who         Display information about terminal lines
  zerotouch   ZeroTouch configuration

To display a list of commands beginning with a specific character sequence, type the sequence followed by a question mark.
```
switch# di?
diff  dir  disable
```

To display a command’s keywords or arguments, type a question mark as an argument.

switch> ping ?
WORD  Ping destination address or hostname
ip    IPv4 echo
ipv6  IPv6 echo
mpls  Send echo messages for LSP
vrf   Ping in a VRF

The switch accepts an address-mask or CIDR notation (address-prefix) in commands that require an IP address and mask. For example, these commands are processed identically:
```
switch(config)# ip route 0.0.0.0 255.255.255.255 10.1.1.254
switch(config)# ip route 0.0.0.0/32 10.1.1.254
```
The switch accepts an address-wildcard or CIDR notation in commands requiring an IP address and wildcard. Wildcards use zeros to mask portions of the IP address and are found in some protocol configuration statements, including OSPF. The switch processes these commands identically:
```
switch(config-router-ospf)# network 10.255.255.1 0.0.0.255 area 15
switch(config-router-ospf)# network 10.255.255.1/24 area 15
```

Regular Expressions

A regular expression is a search pattern composed of symbols, letters and numbers. Some CLI parameters are defined as regular expressions for specifying more expressive search criteria. The switch uses regular expression pattern matching in several BGP commands.

The functionality of a regular expression for an AS-Path varies based on BGP regex asn and string mode configurations in the ip as-path regex-mode command.

The following tables describe the behavior of special characters in asn and string modes respectively.

Table 1. Functionality of Special Characters in ASN Mode
Special Characters	Characters Names	Description	Examples
.	Period	Matches any AS number.	‘.’ matches ‘200’. ‘10.20’ matches ‘10 30 20’, but does not match ‘10 20’.
^	Caret	Matches the specified expression at the beginning of an input string. Also used to exclude expressions in brackets while matching.	‘^123’ matches ‘123’, ‘123 456’, ‘123 456 789’, and so on; but does not match ‘1234’. ‘[^12]’ matches ‘1’, ‘2’, ‘3’, and so on; but does not match ‘12’.
*	Asterisk	Matches an entire AS number that appears either zero or more times.	‘200_100_300’ matches '200 300', ‘200 100 300’, ‘200 100 100 300’, and so on. '^100$' matches empty AS path, '100', '100 100', '100 100 100', and so on.
+	Plus sign	Matches an entire AS number appearing either one or more times.	‘10_20+_30’ matches ‘10 20 30’, ‘10 20 20 30’ and so on; but does not match ‘10 200 30’.
$	Dollar sign	Matches the specified expression at the end of an input string.	‘1_2_3$’ matches ‘1 2 3’, but does not match ‘1 2 3 4’.
[]	Brackets	Matches either an AS number, or a range of AS numbers separated by a hyphen.	‘[10_20_30-39]’ matches ‘10’, ‘20’, ‘30’, ‘31’,...’39’.
?	Question mark	Matches either zero or one occurrence of the pattern but the previous operand or entire AS number may appear zero or one time.	‘100_200?’ matches ‘100’ and ‘100 200’. ‘100_200?$’ does not match with ‘100 20’.
\|	Pipe	Matches the specified AS number on either side of the vertical bar.	‘6400\|6500’ matches either ‘6400’ or ‘6500’.
( )	Parenthesis	Nests specified AS numbers for matching.	‘^(100(200\|300))$’ matches either ‘100 200’ or ‘100 300’. ‘^100_200\|300_400$’ matches AS path either “100 200” or “300 400”.
_	Underscore	Matches specified AS numbers that are converted into AS number delimiters.	‘_123_456_’ matches ‘123 456’. ‘_333_444_’ matches ‘111 222 {333 444}’.

Note: Precede the question mark (?) with Ctrl+V sequence to prevent it from being interpreted as a help command.

Table 2. Functionality of Special Characters in String Mode
Special Characters	Characters Names	Description	Examples
.	Period	Matches any single character.	‘1.2’ matches ‘102’.
^	Caret	Matches the specified expression at the beginning of an input string.	‘^123’ matches ‘123’, ‘1234’, ‘12345’, and so on. It also matches ‘123 456’, ‘123 456 789’, and so on.
*	Asterisk	Matches either zero or more sequences of the expression preceding the asterisk.	'^5*$' matches an empty AS path, '5', '55', '555', and so on.
+	Plus sign	Matches either one or more sequences of the expression preceding the plus sign.	‘5+’ matches to ‘5’, ‘55’, ‘555’, and so on.
$	Dollar sign	Matches the expression at the end of an input string.	‘123$’ matches ‘123’, but does not match ‘1234’.
[]	Brackets	Matches either characters or a range of characters separated by a hyphen, within left and right brackets.	‘[025-7]’ matches ‘0’, ‘2’, and digits from ‘5’ to ‘7’; but does not match digits from ‘1’, ‘3’, ‘4’, ‘8’, and ‘9’.
?	Question mark	Matches either zero or one occurrence of the pattern.	'12?3' matches '13' and '123'.
\|	Pipe	Matches either one of the expressions or expression patterns on either side of the vertical bar.	‘14(36\|75)12’ matches either ‘143612’ or ‘147512’; but does not match ‘1412’, ‘14367512’, ‘14363612’ or ‘14757512’.
( )	Parenthesis	Nests specified expressions for matching.	‘(17)*’ matches any number of the two-character string ‘17’.
_	Underscore	For AS-Path regex, '_' matches curly brackets '{}', the beginning of input string, the end of input string, or space.	‘_1300_’ matches ‘100 {1300 1400}’, ‘100 1300 200’, and so on.
{}	Braces	Matches repetitions of the previous expression with the number of repetitions provided in braces.	'10{2,3}' matches '100' and '1000'.
\	Backslash	Matches the character following the backslash and special characters.	‘\(42’ matches ‘(42’.

Precede the question mark (?) with Ctrl+V sequence to prevent it from being interpreted as a help command.

Scheduling CLI Commands

The schedule command facilitates the periodic execution of the specified CLI command. Command parameters configure the time to start script execution, the interval between consecutive execution instances, the maximum time to execute the script, and the maximum number of files log that needs to be created.

The schedule config command sets configuration parameters to the CLI scheduler.

The show schedule command lists the commands currently scheduled for periodic execution and displays the summary of the specified scheduled command.

Examples

This command schedules the execution of a script once every 12 hours and the script execution is terminated if it exceeds 40 minutes. When max-log-files is set to zero, the script output is not logged.
```
switch# schedule ms_1 interval 720 timeout 40 max-log-files 0 command bash /mnt/flash/myscript.sh
```
This command saves the running configuration contents to a log file every hour, terminates the script execution if it exceeds 30 minutes and creates up to 24 log files.
```
 switch# schedule backup-test interval 60 max-log-files 24 command show running-config 
```
This command allows the switch to concurrently execute up to 2 scheduled commands.
```
switch(config)# schedule config max-concurrent-jobs 2
switch(config)#
```

This command lists the commands that are scheduled for periodic execution.

switch(config)# schedule config max-concurrent-jobs 3
switch(config)# show schedule summary
Maximum concurrent jobs  3
Prepend host name to logfile: No
Name            At time      Last    Interval   Timeout   Max     Logfile Location               Status
                             time     (mins)    (mins)    log
                                                         files
------------- ------------- ------- ---------- -------- -------- ------------------------------- ------
tech-support      now        00:29      60        30      100     flash:schedule/tech-support/   Success
thelp           12:02:00     00:02      60        40      100     flash:schedule/thelp/          Fail
                06/05/2018
switch(config)#

Running Bash Shell Commands Automatically with Event Handlers

Event handlers execute a Linux Bash shell command in response to a specific system event. An event handler consists of a Bash command, a trigger and a delay; when the trigger event occurs, the action is scheduled to run after delay seconds.

To create an event handler, use the event-handler command. This creates a new event handler and places the CLI in event handler configuration mode for that handler. Use the action bash command to configure a Bash command to run when the handler is triggered, and the trigger command to specify the trigger. Event handlers can be triggered by various events, including:

system booting
a change in a specified interface’s operational status or IP address
a change in the startup-config file
a state change in a virtual machine monitored by VM Tracer

To change the delay period between the trigger and the action, use the delay command.

When an action is run, certain information is passed to it through environment variables. For the boot trigger, no variables are set. For the interface triggers, the following variables are set and passed to the action:

$INTF interface name.
$OPERSTATE current operational status of the specified interface.
$IP-PRIMARY current primary IP address of the specified interface.

To execute more than one Bash command in response to a trigger, create a script containing the desired commands and enter the file path to the script as the argument of the action bash command.

To display information about all event handlers or about a specific event handler, use the show event-handler command.

The no event-handler command deletes an event handler.

Examples

These commands create an event handler named eth_4 which sends anemail to a specified address when there is a change in the operational status of Ethernet interface 4:

switch(config)# event-handler eth_4
switch(config-event-eth_4)# action bash email This email address is being protected from spambots. You need JavaScript enabled to view it. -s "Et4 $OPERSTATE"
switch(config-event-eth_4)# trigger on-intf ethernet 4 operstatus
switch(config-event-eth_4)# delay 60
switch(config-event-eth_4)# exit
switch(config)#

The above handler uses the $OPERSTATE variable to include the current operational state (“linkup” or “linkdown”) in the subject of the email. Note that the action will only function if email has been configured on the switch.

These commands create an event handler named onStartup which executes a user-defined script 60 seconds after the system boots.

switch(config)# event-handler onStartup
switch(config-event-onStartup)# action bash /mnt/flash/startupScript1
switch(config-event-onStartup)# trigger onboot
switch(config-event-onStartup)# delay 60
switch(config-event-onStartup)# exit
switch(config)#

The above handler will also be executed on exiting from event-handler configuration mode.

This command displays information about all event handlers configured on the system.

switch# show event-handler
Event-handler onStartup
Trigger: onBoot delay 60 seconds
Action: /mnt/flash/startupScript1
Last Trigger Activation Time: 1 minutes 51 seconds ago
Total Trigger Activations: 1
Last Action Time: 51 seconds ago
Total Actions: 1

switch#

This command deletes the event handler named onStartup.

switch(config)# no event-handler onStartup
switch(config)#

Running Adverse Drop Counters Monitor with Event Handlers

A monitoring capability for adverse drop counters can be used as a warning that the system is encountering an abnormal condition. The adverse drop counter monitor runs periodically (with a default of 60 seconds) and performs the following actions:

Reads the values of adverse drop counters.
Compares each value to the value read in the previous run.
If counter values increase more than a certain threshold (with a default of 100), it is considered as a threshold violation.
If any counter has more than a certain number of threshold violations within a specific time window (with a default of 3 violations within 15 minutes) a syslog message is logged.

No configuration is required to enable adverse drop counters monitor with event handlers. It is enabled by default and can be disabled, and can be customized for duration of time window and threshold levels. To customize the delay, polling interval, and condition for width, violation count, and threshold of this event handler, use the event-handler DropCountersHandler command. To display details of this event handler, use the show event-handler DropCountersHandler command.

Examples

These commands customize the delay, polling interval, and condition for width, violation count, and threshold of this event handler. Each parameter may be customized separately, with all other parameters remaining unchanged.

switch(config)# event-handler DropCountersHandler
switch(config-DropCountersHandler)# action bash DropCounterLog.py -l
switch(config-DropCountersHandler)# delay 0
switch(config-DropCountersHandler)# trigger on-counters
switch(config-DropCountersHandler-counters)# poll interval 60
switch(config-DropCountersHandler-counters)# condition 
bashCmd."DropCounterMonitor.py" -w 800" > 0
switch(config-DropCountersHandler-counters)# condition 
bashCmd."DropCounterMonitor.py" -c 5" > 0
switch(config-DropCountersHandler-counters)# condition 
bashCmd."DropCounterMonitor.py" -t 200" > 0
switch(config-DropCountersHandler-counters)#

This command disables this event handler.

switch(config)# no event-handler DropCountersHandler
switch(config)#

This command displays details of this event-handler.

switch(config)# show event-handler DropCountersHandler
Event-handler DropCountersHandler (BUILT-IN)
Trigger: on-counters delay 0 seconds
  Polling Interval: 60 seconds
  Condition: bashCmd."DropCounterMonitor.py" > 0
Threshold Time Window: 0 Seconds, Event Count: 1 times
Action: DropCounterLog.py -l
Action expected to finish in less than 20 seconds
Total Polls: 39
Last Trigger Detection Time: 38 minutes 22 seconds ago
Total Trigger Detections: 1
Last Trigger Activation Time: 38 minutes 22 seconds ago
Total Trigger Activations: 1
Last Action Time: Never
Total Actions: 1

switch(config)#

Kernel-based Virtual Machine Commands and Configuration

Arista’s EOS has leveraged its unmodified Linux kernel, and embraced open source standards-based technology that has brought operating system virtualization to Ethernet switching, utilizing the kernel-based virtual machine (KVM) as follows:

The hypervisor is the Linux kernel.
The core virtualization infrastructure is provided by the kernel module.
The CPU-specific implementation is provided by the processor-specific module (Intel or AMD).
The generic machine emulator and virtualizer KVM is provided by a Modified Quick Emulator (QEMU), which transforms the Linux kernel into the hypervisor.

The standard Linux kernel is the hypervisor, resulting in changes to the standard kernel (such as memory support and scheduler). Optimizations to these Linux components (such as a new scheduler in the 2.6 kernel) benefit both the hypervisor (host operating system) and Linux guest operating systems. With the kernel acting as the hypervisor, the switch can run other operating systems, such as Windows or Linux.

All components required are pre-installed with the Arista EOS software image, requiring only the download of the image. A few additional configuration steps get the KVM fully operational.

This chapter contains the following sections:

KVM Commands
KVM Configuration

KVM Commands

The following table covers KVM commands used throughout the configuration.

Table 3. KVM Commands
Command	Description
comment	Up to 240 character comment for this mode.
default	Set a command to its defaults.
disk-image	Add Virtual Machine disk image.
enable	Enable VM.
exit	Exit from Virtual Machine configuration mode.
memory-size	Set memory size.
no	Negate a command or set its defaults.
show	Show running system information.
virtual-nic	Add virtual NIC.
vnc-port	Set VNC server port.
! !	Append to comment.

CLI Commands

The following KVN CLI commands are used throughout the configuration.

vm

In config mode, the vm CLI command creates or deletes a KVM configuration, or enters config-vm mode. A newly created KVM will have an empty config file path and is disabled.

The CLI command syntax is as follows:

[no] vm NAME

config-file

In config-vm mode, the config-file CLI command sets the path of the libvirt config file, using standard file syntax (e.g. flash:vm/NetscalerVPX.xml or sata1:vm/NetscalerVPX.xml or /mnt/sata1/vm/NetscalerVPX.xml). Changing this value does not affect the state of a currently enabled KVM. To use the new file, the user must disable and then re-enable the KVM.

The CLI command syntax is as follows:

config-file [PATH]

enabled

In config-vm mode, the enabled CLI command allows enabling a currently disabled VM, causing it to start up immediately. If a VM is enabled in the startup-config, it starts up automatically when EOS boots (or when VirtAgent starts).

The CLI command syntax is as follows:

[no] enabled

Disabling a currently enabled VM initiates a shutdown process in the following sequence:

Attempt to shut down the VM politely if the guest OS supports ACPI.
If the VM is still running after 30 seconds, terminate it.

show vm

In enable mode, the show vm CLI command prints information about the configuration and status of a KVM, or of all KVMs if NAME is omitted, as follows:

Configuration: Name, config file path, and enabled.
Status: PID, log file path, and serial console pty path.
Current resource usage: RES, CPU%.
(Detailed only) contents of the log file.

(Detailed only) contents of the config file.

The CLI command syntax is as follows:

show vm [detailed] [NAME]

attach vm

In enable mode, the attach vm CLI command connects to a KVM's serial console pty (using virsh console).

Note: Press Ctrl-] to exit to the CLI.

The CLI command syntax is as follows:

attach vm [NAME]

show tech-support

The CLI command syntax is as follows:

show tech-support [detailed] [NAME]

reload

In enable mode, the reload CLI command is executed before restarting the system, and will shut down currently enabled KVMs using the same process as the no enabled command in config-vm mode.

The CLI command syntax is as follows:

reload

KVM Configuration

Arista EOS enables kernel-based virtual machine (KVM) instances by running KVM on the control-plane CPU of the switch. KVM instances can be defined from the CLI.

To configure a KVM, you must download the virtual machine image and configure the EOS.

This section contains the following topics:

Configuring a KVM
Configuring a Guest KVM

Configuring a KVM

To configure a KVM, perform the following steps:

Download the Virtual Machine Image to /mnt/flash
Name the virtual machine: switch(config)# virtual-machine [kvm_name]
Example:
```
switch(config)# virtual-machine foo 
```
Provide a pointer to the image: switch(config-vm-foo)# disk-image [file:[path] image-format [format]
Example:
```
switch(config-vm-foo)# disk-image file:/mnt/flash/fedora.img image-format qcow2
```
Define the amount of memory allocated: switch(config-vm-foo)#memory-size [size in bytes]
Bind the virtual NIC to an SVI (or management interface): switch(config-vm-foo)#virtual-nic 1 vlan [1-4] switch(config-vm-foo)# virtual-nic 1 management [1-4]
Create the VNC server’s tcp port (display): switch(config-vm-foo)# vnc-port [vnc-port number]
Enable the virtual machine: switch(config-vm-foo)# enable
Optionally attach to the virtual machine via VNC client pointed to the switch’s IP address. However, if Kernel hair-pinning is currently not enabled, preventing communication directly with the local switch, all traffic must have a destination on another networked device (such as a router, switch, or server).

For specifics about KVM visit http://www.linux-kvm.org/.

Note: In the Real VNC Viewer for Options, Expert, and ColorLevel, if the default value is pal8, establishing a session may fail. If this occurs, set this value to full and reconnect.

Example

switch# copy http://berrange.fedorapeople.org/images/2012-02-
29/f16-x86_64-openstack-sda.qcow2
(http://berrange.fedorapeople.org/images/2012-02-29/f16-x86_64-
openstack-sda.qcow2) flash:
...
switch(config)# virtual-machine foo
switch(config-vm-foo)# disk-image file:/mnt/flash/fedora.img image-format qcow2
switch(config-vm-foo)# memory-size 512
switch(config-vm-foo)# virtual-nic 1 vlan 1
switch(config-vm-foo)# virtual-nic 2 management 1
switch(config-vm-foo)# vnc-port 5900
switch(config-vm-foo)# enable

Configuring a Guest KVM

To configure a guest KVM, perform the following steps:

Download the Virtual Machine Image to /mnt/flash
Name the virtual machine: switch(config)# virtual-machine [guest_name]
Example
```
switch(config)# virtual-machine guest123
```

Provide a pointer to the image: switch(config-vm-guest123)# disk-image [file:[path] image-format [format]

Example

switch(config-vm-guest123)# disk-image flash:f16-x86_64-openstack-sda.qcow2 image-format ? 
iso iso image format ??qcow qcow image format ??qcow2 qcow2 image format ??raw raw image format ??
vmdk vmdk image format 
switch(config-vm-guest123)# disk-image 
flash:f16-x86_64-openstack-sda.qcow2 image-format qcow2

Define the amount of memory allocated: switch(config-vm-guest123)#memory-size [size in bytes]
Bind the virtual NIC to an SVI (or management interface): switch(config-vm-guest123)# virtual-nic 1 vlan [1-4] switch(config-vm-guest123)# virtual-nic 2 management [1-4]
Create the VNC server’s tcp port (display): switch(config-vm-guest123)# vnc-port [vnc-port number]

Enable the virtual machine: switch(config-vm-guest123)# enable

Example

switch# copy http://berrange.fedorapeople.org/images/2012-02-
29/f16-x86_64-openstack-sda.qcow2
(http://berrange.fedorapeople.org/images/2012-02-29/f16-x86_64-
openstack-sda.qcow2) flash:
...
switch# config terminal
switch(config)# virtual-machine ?
    WORD Virtual Machine name
switch(config)# virtual-machine foo
switch(config-vm-foo)# disk-image flash:f16-x86_64-openstack-sda.qcow2 image-format ?
    iso           iso image format
    qcow          qcow image format
    qcow2         qcow2 image format
    raw             raw image format
    vmdk          vmdk image format
switch(config-vm-foo)# disk-image flash:f16-x86_64-openstack-sda.qcow2 image-format qcow2
switch(config-vm-foo)# memory-size 1024
switch(config-vm-foo)# virtual-nic ?
    <1-4>         Virtual NIC Id
switch(config-vm-foo)# virtual-nic 1 ?
    Management    Management interface
    Vlan          Vlan interface
switch(config-vm-foo)# virtual-nic 1 vlan 1
switch(config-vm-foo)# virtual-nic 2 management 1
switch(config-vm-foo)# enable
switch(config-vm-foo)#
switch(config-vm-foo)# ^Z
switch# write mem
switch#
switch# show virtual-machine detail
Virtual Machine: foo
    Enabled:           Yes
    State:             Running
    Disk Image:        /mnt/flash/f16-x86_64-openstack-sda.qcow2
    Disk Image Format: qcow2
    Memory Size: 1024MB
    VNC port: 5900
    Virtual Nic: vnic1
        Mac Address:   52:54:00:ee:11:c9
        Device:        Vlan1
        Model Type:    e1000
    Virtual Nic:       vnic2
        Mac Address:   52:54:00:df:2a:e1
        Device:        Management1
        Model Type:    e1000
switch#

Switch Platforms

Features and CLI commands vary by switch platform. CLI options may also vary by switch platform for commands that are available on all platforms. Command descriptions in this manual describe feature availability and command parameters on the basis of switch platform, noting exceptions that exist among models that use a common platform.

https://www.arista.com/en/products/switches lists the Arista switches and platforms upon which they operate.
https://www.arista.com/en/support/product-documentation/supported-features lists Arista switch feature availability by switch platform. For the latest features, also consult the Release Notes, available at https://www.arista.com/en/support/software-download.

These sections describe the following topics:

Viewing the Model Number
Modular System Platforms – 7500 and 7500E Series Switches
Viewing Modules on 7300 Series Modular Switches
Multi-Chip Devices

Viewing the Model Number

To view the switch’s model number through the CLI, enter the show version command.

Example

This command displays the model number, serial number, system MAC address, and manufacturing information of a DCS-7150S-64 switch.

switch> show version
Arista DCS-7150S-64-CL-F
Hardware version:    01.01
Serial number:       JPE13120819
System MAC address:  001c.7326.fd0c

Software image version: 4.13.2F
Architecture:           i386
Internal build version: 4.13.2F-1649184.4132F.2
Internal build ID:      eeb3c212-b4bd-4c19-ba34-1b0aa36e43f1

Uptime:                 16 hours and 39 minutes
Total memory:           4017088 kB
Free memory:            1348228 kB

switch>

Modular System Platforms – 7500 and 7500E Series Switches

Modular switch platforms depend on their installed modules along with the fabric and forwarding software modes. The show module command displays the fabric modules in the switch. System performance in switches containing both module types is based on first-generation fabric capabilities. Best practice is to avoid switch configurations with mixed fabric modules.

These sections describe modular switch components and software modes that program their capacities.

Fabric Modules and Fabric Mode – 7500 and 7500E Series Switches

Each modular switch fabric module is categorized as first-generation or E-Series:

First-generation fabric modules support all basic switch functions.
E-Series fabric modules support faster fabric link speeds, greater internal table capacities, and advanced encoding formatting.

Fabric mode determines the switch’s fabric performance capabilities. This mode must match the fabric modules in the switch. Fabric mode settings include:

fe600: Supports first-generation fabric modules.
fe1600: Supports E-Series fabric modules.

E-series fabric modules can operate in fe600 mode, but are limited to first-generation fabric performance. First-generation modules cannot operate in fe1600 mode. Switches containing both types of modules must be set to fe600 mode. Best practice is to avoid switch configurations with mixed fabric modules.

When a switch reloads, fabric mode is determined by the following (in order of precedence):

Switches reloading in petraA forwarding compatibility mode( Linecard Modules and Forwarding Compatibility Mode – 7500 and 7500E Series)also reload in fe600 fabric mode.
As specified by the platform sand fabric mode (7500 and 7500E Series) statement in running-config.
The first fabric module that becomes operational as the switch reloads.

In switches with a homogeneous module set, the fabric mode matches its fabric modules. Switches with a mixed set of modules are typically reloaded in fe600 mode because first generation modules are usually operational before E-Series modules. However, the fabric mode in mixed module switches that are reloading cannot be guaranteed in the absence of the first two conditions.

Example

This command configures the switch to reload in fe1600 fabric mode to support E-series fabric modules. After issuing this command, the switch should be reset only after exchanging all switch fabric modules to E-series modules.

switch(config)# platform sand fabric mode fe1600
switch(config)# exit
switch# show platform sand compatibility
                     Configuration        Status
Forwarding mode      None                 Arad
Fabric mode          Fe1600               Fe600
switch#

Determining a Switch’s Operating Platform

FM6000 Platforms

To determine the operating platform on switch, display platform command options from Global Configuration command mode.

This command displays the operating platform of a switch operating on the FM6000 platform (7150 Series switches).

switch(config)# platform ?
  fm6000  FM6000 chip

switch(config)#platform

Arad and Petra Platforms

The platform ? command displays the same options on Arad and Petra platform switches. Refer to Viewing the Model Number to determine the switch’s model number.

Fixed system switches (DCS-7048 Series) operate on the Petra platform.
Modular switches (DCS-7500 Series) operate on Arad and Petra platforms. Modular System Platforms – 7500 and 7500E Series Switches describe platform usage on these switches.

Arad and Petra platform switch typically utilize multiple chips.Multi-Chip Devices describe methods of determining the port distribution on multi-chip platforms.

Example

These commands display platform options of a switch operating on either Petra or Arad platforms.

switch(config)# platform ?
  arad    Arad switch chip
  fe1600  Fe1600 chip
  fe600   Fe600 fabric chip
  petraA  PetraA switch chip
  ptp     Precision Time Protocol
  sand    Sand platform

switch(config)#platform

Trident and Trident II Platforms

The platform ? command returns trident on switches that operate on Trident or Trident II platforms. Trident II platform switches include options that configure the forwarding and routing tables. To determine the Trident platform that a switch uses, display platform trident options.

These commands indicate that the switch is operating on the Trident II platform:

switch(config)# platform ?
  ptp      Precision Time Protocol
  trident  Trident chip

switch(config)# platform trident ?
  fabric            Fabric configuration
  forwarding-table  Forwarding table configuration
  mmu               Trident MMU configuration
  routing-table     Routing table configuration

switch(config)#platform trident

Fixed and Modular switches are available that operate on the Trident II platform. Refer to Viewing the Model Number to determine the switch’s model number. Viewing Modules on 7300 Series Modular Switches displays the modules on a Trident II platform modular switch.

Trident II platform switches typically utilize multiple chips. Multi-Chip Devices describes methods of determining port distribution on multi-chip platforms.

Linecard Modules and Forwarding Compatibility Mode – 7500 and 7500E Series

Each modular switch linecard module is categorized as first-generation or E-Series:

First-generation linecard modules support all basic switch functions.
E-Series linecard modules support provide faster data processing, greater internal table capacities, and advanced encoding formatting.

The forwarding compatibility mode determines the switch’s performance capabilities when forwarding data between linecard interfaces. Forwarding compatibility mode settings include:

PetraA: Supports first-generation linecard modules.
Arad: Supports E-Series linecard modules.

Forwarding compatibility mode determines the operational capacity of installed linecards. The following table lists the affect of the forwarding compatibility mode on linecard module types.

Table 4. Linecard Module and Forwarding Mode Performance
Linecard Module Type	Forwarding Compatibility Mode	Linecard Operating Capacity
First-generation	petraA	First-generation performance capacity.
First-generation	arad	Linecard is powered-down.
E-Series	petraA	First-generation performance capacity.
E-Series	arad	E-series performance capacity.

Note: Switches must contain E-Series fabric modules to operate at E-Series performance capacities.

The forwarding compatibility mode is configured by the platform sand forwarding mode (7500 and 7500E Series) command. This command may be required after exchanging a linecard for a different module type or in switches containing first-generation and E-series linecards.

Without a platform sand forwarding mode (7500 and 7500E Series) command, forwarding compatibility mode is determined by the first linecard that is operational after reloading the switch. In a switch that is reloaded with a homogeneous module set, forwarding compatibility mode matches its linecards. Switches with a mixed set of modules are typically reloaded in petraA mode because first generation modules are usually operational before E-Series modules. However, forwarding compatibility mode in mixed module switches that are reloading is not guaranteed without a platform sand forwarding mode command.

Example

This command changes the forwarding software mode to support E-series linecard modules. This command should be run only after exchanging all linecards to E-series modules.

switch(config)# platform sand forwarding mode arad
switch(config)#

Viewing Modules – 7500 and 7500E Series

The show module command displays the model number of all installed modules.

This command displays the modules of a 7504 switch that contains first-generation modules.

switch> show module
Module    Ports Card Type                            Model           Serial No.
--------- ----- ------------------------------------ --------------- -----------
1         2     DCS-7500 Series Supervisor Module    7500-SUP        JSH11440327
2         1     Standby supervisor                   Unknown         Unknown
3         48    48-port SFP+ 10GigE Linecard         7548S-LC        JSH10449938
4         48    48-port SFP+ 10GigE Linecard         7548S-LC        JSH11091247
5         48    48-port SFP+ 10GigE Linecard         7548S-LC        JSH11211614
6         48    48-port SFP+ 10GigE Linecard         7548S-LC        JSH11520288
Fabric1   0     DCS-7504 Fabric Module               7504-FM         JSH11451230
Fabric2   0     DCS-7504 Fabric Module               7504-FM         JSH11451210
Fabric3   0     DCS-7504 Fabric Module               7504-FM         JSH11410115
Fabric4   0     DCS-7504 Fabric Module               7504-FM         JSH11380318
Fabric5   0     DCS-7504 Fabric Module               7504-FM         JSH11340955
Fabric6   0     DCS-7504 Fabric Module               7504-FM         JSH11410128

Module    MAC addresses                          Hw      Sw      Status
--------- -------------------------------------- ------- ------- -------
1         00:1c:73:03:06:ac - 00:1c:73:03:06:ac  07.06   4.12.1  Active
2                                                        4.12.1  Standby
3         00:1c:73:03:80:44 - 00:1c:73:03:80:73  06.00           Ok
4         00:1c:73:03:e4:34 - 00:1c:73:03:e4:63  07.10           Ok
5         00:1c:73:12:0b:3f - 00:1c:73:12:0b:6e  07.30           Ok
6         00:1c:73:12:b6:3f - 00:1c:73:12:b6:6e  08.00           Ok
Fabric1                                          05.03           Ok
Fabric2                                          05.03           Ok
Fabric3                                          05.02           Ok
Fabric4                                          05.02           Ok
Fabric5                                          05.02           Ok
Fabric6                                          05.02           Ok
switch>

This command displays modules of a 7504 switch that contains E-Series modules.

switch> show module
Module    Ports Card Type                            Model           Serial No.
--------- ----- ------------------------------------ --------------- -----------
1         3     DCS-7500E-SUP Supervisor Module      7500E-SUP       JAS13060306
3         72    48 port 10GbE SFP+ & 2x100G Linecard 7500E-72S-LC    JAS12410019
4         72    48 port 10GbE SFP+ & 2x100G Linecard 7500E-72S-LC    JPE13041458
5         72    48 port 10GbE SFP+ & 2x100G Linecard 7500S-72S-LC    JAS12380089
Fabric1   0     DCS-7504-E Fabric Module             7504E-FM        JAS12370008
Fabric2   0     DCS-7504-E Fabric Module             7504E-FM        JAS12380012
Fabric3   0     DCS-7504-E Fabric Module             7504E-FM        JAS12370014
Fabric4   0     DCS-7504-E Fabric Module             7504E-FM        JAS12380008
Fabric5   0     DCS-7504-E Fabric Module             7504E-FM        JAS12380017
Fabric6   0     DCS-7504-E Fabric Module             7504E-FM        JAS12370009

Module    MAC addresses                          Hw      Sw      Status
--------- -------------------------------------- ------- ------- -------
1         00:1c:73:00:f4:cd - 00:1c:73:00:f4:ce  00.00   4.12.3  Active
3         00:1c:73:00:9c:7b - 00:1c:73:00:9c:c2  00.00           Ok
4         00:1c:73:28:a0:57 - 00:1c:73:28:a0:9e  00.00           Ok
5         00:1c:73:00:9a:cb - 00:1c:73:00:9b:12  02.07           Ok
Fabric1                                          00.00           Ok
Fabric2                                          00.00           Ok
Fabric3                                          00.00           Ok
Fabric4                                          00.00           Ok
Fabric5                                          00.00           Ok
Fabric6                                          00.00           Ok
switch>

Viewing Modules on 7300 Series Modular Switches

7300 Series Modular switches operate on Trident II platform. The show module command displays the model number of all installed modules.

switch> show module
Module    Ports Card Type                            Model           Serial No.
--------- ----- ------------------------------------ --------------- -----------
1         3     Supervisor 7300X SSD                 DCS-7300-SUP-D  JAS13340024
3         128   32 port 40GbE QSFP+ LC               7300X-32Q-LC    JPE13440416
4         64    48 port 10GbE SFP+ & 4 port QSFP+ LC 7300X-64S-LC    JAS13310113
5         64    48 port 10GbE SFP+ & 4 port QSFP+ LC 7300X-64S-LC    JAS13340033
6         64    48 port 10GbE SFP+ & 4 port QSFP+ LC 7300X-64S-LC    JAS13310103
Fabric1   0     7304X Fabric Module                  7304X-FM        JAS13320077
Fabric2   0     7304X Fabric Module                  7304X-FM        JAS13350043
Fabric3   0     7304X Fabric Module                  7304X-FM        JAS13350050
Fabric4   0     7304X Fabric Module                  7304X-FM        JAS13350056

Module    MAC addresses                          Hw      Sw      Status
--------- -------------------------------------- ------- ------- -------
1         00:1c:73:36:4b:71 - 00:1c:73:36:4b:72  01.01   4.13.3F Active
3         00:1c:73:58:d4:68 - 00:1c:73:58:d4:87  03.04           Ok
4         00:1c:73:36:05:61 - 00:1c:73:36:05:94  02.02           Ok
5         00:1c:73:36:0a:e1 - 00:1c:73:36:0b:14  02.03           Ok
6         00:1c:73:36:02:e1 - 00:1c:73:36:03:14  02.02           Ok
Fabric1                                          00.00           Ok
Fabric2                                          00.00           Ok
Fabric3                                          00.00           Ok
Fabric4                                          00.00           Ok
switch>

Multi-Chip Devices

Trident II, Petra, and Arad platform switches and linecards utilize multiple chips, with Ethernet ports evenly distributed among the chips. Creating multi-port data structures (including port channels) that include ports from multiple chips protects against the failure of an individual chip on a device.

The following sections describe methods of determining port distribution on various switch platforms

Petra Fixed Switches

7048-Series switches are Petra platform devices that distribute ports among two PetraA chips. The show platform petraA port-info routing command displays the ports that are controlled by each chip.

Example

This command displays the following Ethernet port distribution on a DCS-7048-T switch:

Petra0 chip controls Ethernet 1 through Ethernet 32.

Petra1 chip controls Ethernet 33 through Ethernt 52.

switch# show platform petraA port-info routing
Petra0 Port Routing Information:
========================================================================
                         sys     fap                       routing
 intfName              port-id port-id intfType  portType   v4 v6
========================================================================
 CpuTm                     2       0    Cpu       Tm          1  1
 
 Ethernet1                29       2    Nif       Ethernet    1  1
 Ethernet2                30       3    Nif       Ethernet    1  1

 Ethernet31               59      32    Nif       Ethernet    1  1
 Ethernet32               60      33    Nif       Ethernet    1  1

 RawPetra0/70            2118      70    Recycling Raw         1  1
Petra1 Port Routing Information:
========================================================================
                         sys     fap                       routing
 intfName              port-id port-id intfType  portType   v4 v6
========================================================================
 CpuTm                     2       0    Cpu       Tm          1  1

 Ethernet33               66       2    Nif       Ethernet    1  1

 Ethernet52               85      21    Nif       Ethernet    1  1
 L3SecondHop1Petra1       86      22    Recycling Ethernet    1  1

 RawPetra1/70            2118      70    Recycling Raw         1  1
switch#

Petra Modular Switches

Linecards on 7500-Series modular switches distribute Ethernet ports among multiple petraA chips. The show platform petraA port-info routing command displays the ports that are controlled by each chip on all PetraA linecards or on a single linecard.

Example

This command displays the following Ethernet port distribution on linecard 4 of a DCS-7504 switch:

Petra4/0 chip controls Ethernet 4/1 through Ethernet 4/8.
Petra4/1 chip controls Ethernet 4/9 through Ethernet 4/16.
Petra4/2 chip controls Ethernet 4/17 through Ethernet 4/24.
Petra4/3 chip controls Ethernet 4/25 through Ethernet 4/32.
Petra4/4 chip controls Ethernet 4/33 through Ethernet 4/40.

Petra4/5 chip controls Ethernet 4/41 through Ethernet 4/48.

switch(s1)# show platform petra module 4 port-info routing
Petra4/0 Port Routing Information:
========================================================================
                         sys     fap                       routing
 intfName              port-id port-id intfType  portType   v4 v6
========================================================================
 CpuTm                     2       0    Cpu       Tm          1  0

 Ethernet4/1             221       2    Nif       Ethernet    1  0
 Ethernet4/2             222       3    Nif       Ethernet    1  0
 Ethernet4/3             223       4    Nif       Ethernet    1  0
 Ethernet4/4             224       5    Nif       Ethernet    1  0
 Ethernet4/5             225       6    Nif       Ethernet    1  0
 Ethernet4/6             226       7    Nif       Ethernet    1  0
 Ethernet4/7             227       8    Nif       Ethernet    1  0
 Ethernet4/8             228       9    Nif       Ethernet    1  0

 RawPetra4/0/70          2118      70    Recycling Raw         1  0
Petra4/1 Port Routing Information:
========================================================================
                         sys     fap                       routing
 intfName              port-id port-id intfType  portType   v4 v6
========================================================================
 CpuTm                     2       0    Cpu       Tm          1  0

 Ethernet4/9             253       2    Nif       Ethernet    1  0

Petra4/5 Port Routing Information:
========================================================================
                         sys     fap                       routing
 intfName              port-id port-id intfType  portType   v4 v6
========================================================================

 Ethernet4/41            381       2    Nif       Ethernet    1  0
 Ethernet4/42            382       3    Nif       Ethernet    1  0
 Ethernet4/43            383       4    Nif       Ethernet    1  0
 Ethernet4/44            384       5    Nif       Ethernet    1  0
 Ethernet4/45            385       6    Nif       Ethernet    1  0
 Ethernet4/46            386       7    Nif       Ethernet    1  0
 Ethernet4/47            387       8    Nif       Ethernet    1  0
 Ethernet4/48            388       9    Nif       Ethernet    1  0

switch(s1)#

Arad Modular Switches

7500-E Series linecards distribute Ethernet ports among multiple Arad chips. The show platform arad port-info routing command displays the ports that are controlled by each chip on all Arad linecards.

Example

This command displays the following Ethernet port distribution on the 7500E-72S-LC linecard that is inserted as module 3 in a DCS-7508E switch:

Arad3/0 chip: Ethernet 3/1– Ethernet 3/20.
Arad3/1 chip: Ethernet 3/21 – Ethernet 3/34 and Ethernet 3/49/1 – Ethernet 3/49/12.

Arad3/2 chip: Ethernet 3/35 – Ethernet 3/48 and Ethernet 3/50/1 – Ethernet 3/50/12.

switch# show platform arad mapping

Arad3/0            Port                        SysPhyPort Voq  (Fap,FapPort)   
Xlge  Serdes
----------------------------------------------------------------------------------------
                   CpuTm                              2    32    (0  ,  0)     n/a   n/a

                   Ethernet3/1                       28   240    (0  ,  2)     n/a   (16)
                   Ethernet3/2                       29   248    (0  ,  3)     n/a   (17)
                   Ethernet3/3                       30   256    (0  ,  4)     n/a   (18)
                   Ethernet3/4                       31   264    (0  ,  5)     n/a   (19)
                   Ethernet3/5                       32   272    (0  ,  6)     n/a   (20)
                   Ethernet3/6                       33   280    (0  ,  7)     n/a   (21)
                   Ethernet3/7                       34   288    (0  ,  8)     n/a   (22)
                   Ethernet3/8                       35   296    (0  ,  9)     n/a   (23)
                   Ethernet3/9                       36   304    (0  , 10)     n/a   (24)
                   Ethernet3/10                      37   312    (0  , 11)     n/a   (25)
                   Ethernet3/11                      38   320    (0  , 12)     n/a   (26)
                   Ethernet3/12                      39   328    (0  , 13)     n/a   (27)
                   Ethernet3/13                      40   336    (0  , 14)     n/a   (4)
                   Ethernet3/14                      41   344    (0  , 15)     n/a   (5)
                   Ethernet3/15                      42   352    (0  , 16)     n/a   (6)
                   Ethernet3/16                      43   360    (0  , 17)     n/a   (7)
                   Ethernet3/17                      44   368    (0  , 18)     n/a   (0)
                   Ethernet3/18                      45   376    (0  , 19)     n/a   (1)
                   Ethernet3/19                      46   384    (0  , 20)     n/a   (2)
                   Ethernet3/20                      47   392    (0  , 21)     n/a   (3)
 
                   RawArad3/0/56                   2104 16848    (0  , 56)     n/a   n/a

Arad3/1            Port                        SysPhyPort Voq  (Fap,FapPort)   
Xlge  Serdes
-------------------------------------------------------------------------------

                   Ethernet3/21                      60   496    (1  ,  2)     n/a   (16)

                   Ethernet3/34                      73   600    (1  , 15)     n/a   (13)
                   Ethernet3/49/1                    74   608    (1  , 16)     n/a   (0)
 
                   Ethernet3/49/12                   85   696    (1  , 27)     n/a   (11)
 

Arad3/2            Port                        SysPhyPort Voq  (Fap,FapPort)   
Xlge  Serdes
-------------------------------------------------------------------------------

                   Ethernet3/35                      92   752    (2  ,  2)     n/a   (16)

                   Ethernet3/48                     105   856    (2  , 15)     n/a   (13)
                   Ethernet3/50/1                   106   864    (2  , 16)     n/a   (0)

                   Ethernet3/50/12                  117   952    (2  , 27)     n/a   (11)

switch#

Trident II Fixed Switches

Trident II platform devices distribute their ports among multiple Trident II chips. The show platform trident system port command displays the ports that are controlled by each chip.

Example

This command displays the following Ethernet port distribution on a DCS-7250QX-64-F switch:

Trident 0 chip controls Ethernet 1/1 through Ethernet 16/4.
Trident 1 chip controls Ethernet 17/1 through Ethernet 32/4.
Trident 2 chip controls Ethernet 33/1 through Ethernet 48/4.

Trident 3 chip controls Ethernet 49/1 through Ethernet 64/4.

switch# show platform trident system port

                                                                  Port
      Intf              Chip            ModId       Logical       Physical   MMU
--------------------- ----------------- ----------- ------------- ---------- ---
      Ethernet1/1       Linecard0/0      1           1             17         9
      Ethernet1/2       Linecard0/0      1           2             18         10

      Ethernet16/3      Linecard0/0      1           60            107        98
      Ethernet16/4      Linecard0/0      1           61            108        99

      Ethernet64/2      Linecard0/3      4           62            106        97
      Ethernet64/3      Linecard0/3      4           63            107        98
      Ethernet64/4      Linecard0/3      4           64            108        99

--------------------------------------------------------------------------------
switch#

Trident II Modular Switches

Linecards on 7300-Series modular switches distribute Ethernet ports among multiple Trident II chips. The show platform trident system port command can display the ports that are controlled by each chip on all linecards or on a single chip.

This command displays the following Ethernet port distribution on DCS-7304-F switch that contains a 7300X-32Q-LC linecard as module 3:

Trident 0 chip controls Ethernet 1/1 through Ethernet 16/4 (on module 3).

Trident 1 chip controls Ethernet 17/1 through Ethernet 32/4 (on module 3).

switch# show platform trident system port

------------------------------------------------------------------------------------
                                                                  Port
     Intf              Chip             ModId       Logical       Physical       MMU
--------------------- ----------------- ----------- ------------- -------------  ---
    Ethernet3/1/1      Linecard3/0       5           1             17            4
    Ethernet3/2/1      Linecard3/0       5           2             21            5

    Ethernet3/16/3     Linecard3/0       5           51            111           102
    Ethernet3/16/4     Linecard3/0       5           52            112           103

    Ethernet3/32/3     Linecard3/1       6           63            111           102
    Ethernet3/32/4     Linecard3/1       6           64            112           103

-------------------------------------------------------------------------------------

switch#

Command Modes

Command modes define the user interface state. Each mode is associated with commands that perform a specific set of network configuration and monitoring tasks.

Mode Types lists the available modes.
Navigating Through Command Modes lists mode entry and exit commands.
Command Mode Hierarchy describes the mode structure.
Group-Change Configuration Modes describes editing aspects of these modes.

Mode Types

The switch includes these command modes:

EXEC: EXEC mode commands display system information, perform basic tests, connect to remote devices, and change terminal settings. When logging into EOS, you enter EXEC mode.
EXEC mode prompt: switch>
Privileged EXEC: Privileged EXEC mode commands configure operating and global parameters. The list of Privileged EXEC commands is a superset of the EXEC command set. You can configure EOS to require password access to enter Privileged EXEC from EXEC mode.
Privileged EXEC mode prompt: switch#
Global Configuration: Global Configuration mode commands configure features that affect the entire system, such as system time or the switch name.
Global Configuration mode prompt: switch(config)#
Interface Configuration: Interface configuration mode commands configure or enable Ethernet, VLAN, and Port-Channel interface features.
Interface Configuration mode prompt: switch(config-if-Et24)#
Protocol specific mode: Protocol specific mode commands modify global protocol settings. Protocol specific mode examples include ACL Configuration and Router BGP Configuration.
The prompt indicates the active command mode. For example, the Router BGP command prompt is switch(config-router-bgp)#

Navigating Through Command Modes

To change the active command mode, perform one of these actions:

To enter EXEC mode, log into the switch.
To enter Privileged EXEC mode from EXEC, type enable (or en) followed, if prompted, by the enable password:
```
switch> en
Password:
switch#
```
To enter Global Configuration mode from Privileged EXEC, type configure (or config):
```
switch# config
switch(config)#
```
To enter Interface Configuration mode from Global Configuration, type interface and the name of the interface to be modified:
```
switch(config)# interface Et24
switch(config-if-Et24)#
```
To enter a protocol specific configuration mode from Global Configuration, type the required command for the desired mode.
```
switch(config)# router bgp 100
switch(config-router-bgp)#
```
To return one level from any configuration mode, type exit.
```
switch(config)# exit
switch#
```
To return to Privileged EXEC mode from any configuration mode, type end or Ctrl-Z.
```
switch(config-if-Et24)# <Ctrl-z>
switch#
```
To return to EXEC mode from Privileged EXEC mode, type disable (or dis).
```
switch# dis
switch>
```
To exit EOS and log out of the CLI, type exit from EXEC mode or Privileged EXEC mode.
```
switch# exit

login:
```

Command Mode Hierarchy

Command modes are hierarchical. The parent mode of a specified command mode is the mode that contains the command that enters the specified mode.

Example

EXEC mode contains the enable command, which enters Privileged EXEC mode. Therefore, EXEC is the parent mode of Privileged EXEC.

Commands that are executable in a specified command mode include all commands available in the specified mode plus all commands executable from its parent mode.

Example

EXEC mode includes the ping command. EXEC mode is the parent mode of Privileged EXEC mode. Therefore, Privileged EXEC mode includes ping.

Additionally, Privileged EXEC is the parent mode of Global Configuration mode. Therefore, Global Configuration mode also includes ping.

Executing a configuration mode command from a child mode may change the active command mode.

Example

Global Configuration mode contains interface ethernet and ip access-list commands, which enter Interface Configuration and Access Control List (ACL) Configuration modes, respectively. When the switch is in Interface Configuration mode, the ip access-list command is available and changes the active mode to ACL Configuration.

switch(config)# interface ethernet 1
switch(config-if-Et1)# ip access-list master-list
switch(config-acl-master-list)#

The exit command changes the active command mode to its parent mode. When executed from Privileged EXEC or EXEC modes, the exit command terminates the session.

Example

This command exits Global Configuration mode to Privileged EXEC mode.
```
switch(config)#exit
switch#
```
This command terminates the user session.
```
switch# exit
```

Group-Change Configuration Modes

Group-change modes apply all changes made during an edit session only after exiting the mode. Changes are stored when the user exits the mode, either through an exit or end command or through a command that enters a different configuration mode.

The abort command discards all changes not previously applied.

Access Control List (ACL) and Multiple Spanning Tree (MST) configuration modes are examples of group-change modes.

Managing Switch Configuration Settings

Verifying Settings for the Current Mode

To display only the lines of running-config that affect the current mode, use the active option of the show (various configuration modes) command. This command option is available in all configuration modes except global configuration.

Example

Type show active to display the content of running-config that affects the current mode. To include default settings in the display, type show active all.

switch(config-router-ospf3)# show active all
ipv6 router ospf 9
   router-id 0.0.0.0
   default-metric 10
   distance ospf intra-area 10
   area 0.0.0.200 default-cost 10
   area 0.0.0.200
   no log-adjacency-changes
   timers spf 5
switch(config-router-ospf3)#

To display any comments associated with the current mode, use the comment option of the show (various configuration modes) command.

Example

Type show comment to display any comments attached to the current mode.

switch(config-router-ospf3)# show comment
Comment for router-ospf3:
    Consult Thomas Morton before making changes to the OSPF configuration.
switch(config-router-ospf3)#

Verifying the Running Configuration Settings

The running-config command is the virtual file that stores the operating configuration. The show running-config command displays the running-config. The command is supported in Privileged EXEC mode.

Example

Type show running-config in Privileged EXEC mode. The response in the example is truncated to display only the ip route configured.

switch# show running-config 
! Command: show running-config

!
ip route 0.0.0.0/0 192.0.2.1
!

end
switch#

Adding a Comment to a Configuration Mode

To add a comment to most switch configuration modes, use the comment (various configuration modes) command. Comments cannot be modified, but can be replaced by entering the comment command again and entering new text. Comments cannot be added to global configuration mode

To append to an existing comment, enter !! followed by additional comment text. To display comments for the active mode, use the show comment command. The no comment and default comment commands remove the comment from running-config.

Examples

These commands enter a comment in Router OSPF3 Mode.

switch(config-router-ospf3)# comment
Enter TEXT message. Type 'EOF' on its own line to end.
Consult Thomas Morton before making changes to the OSPF configuration.
EOF
switch(config-router-ospf3)#

These commands append additional information to the comment entered above.

switch(config-router-ospf3)# !! x2735
switch(config-router-ospf3)# show comment
Comment for router-ospf3:
    Consult Thomas Morton before making changes to the OSPF configuration.
    x2735
switch(config-router-ospf3)#

Saving the Running Configuration Settings

startup-config is the file, stored in internal flash memory, that the switch loads when it boots. Configuration changes that are not saved to startup-config are lost the next time the switch is booted.

The write and copy running-config startup-config commands store the operating configuration to startup-config.Both commands are supported in Privileged EXEC mode.

Example

These equivalent commands save the current operating configure to the startup-config file.

switch# write  

switch# copy running-config startup-config

The show startup-config command displays the startup configuration file. The command is supported in Privileged EXEC mode.

Example

Type show startup-config to display the startup configuration file. The response in the example is truncated to display only the ip route configured in Admin Username.

switch# show startup-config
! Command: show startup-config
! Startup-config last modified at  Wed Feb 19 08:34:31 2014 by admin
!

!
ip route 0.0.0.0/0 192.0.2.1
!

end
switch#

Other Command-Line Interfaces

EOS can access other CLIs that provide switch commands, files, and services.

Aboot Command-Line Interface describes the boot-loader CLI.
Bash Shell describes the Bash shell CLI.

Aboot Command-Line Interface

Aboot is the switch boot loader. It reads a configuration file from the internal flash or a USB flash drive and attempts to boot a software image.

The switch opens an Aboot shell if the switch does not find a software image, the configuration is corrupted, or the user terminates the boot process. The Aboot shell provides a CLI for manually booting a software image, recovering the internal flash to its default factory state, running hardware diagnostics, and managing files.

Bash Shell

The switch provides a Linux Bash shell for accessing the underlying Linux operating system and extensions. The Bash shell is accessible in all command modes except EXEC. Mode Types describes EOC command modes.

To enter the Bash, type bash at the prompt.

switch# bash

Arista Networks EOS shell

[admin@Switch ~]$

To exit the Bash, type logout, exit, or Ctrl-D at the Bash prompt.
```
[admin@Switch ~]$ logout
switch#
```

Directory Structure

EOS operates from a flash drive root mounted as the /mnt/flash directory on the switch. The EOS CLI supports these file and directory commands:

delete: Delete a file or directory tree.
copy: Copy a file.
more: Display the file contents.
diff: Compares the contents of files located at specified URLs.
rename: Rename a file.
cd: Change the current working directory.
dir: Lists directory contents, including files and subdirectories.
mkdir: Create a directory.
rmdir: Remove a directory.
pwd: Display the current working directory.

Verify flash memory space before copying a file. When a file is copied to flash, it is first written to a temporary file and then renamed to the destination rather than directly overwriting the destination file. This protects the integrity of the existing file if the copy command is interrupted, but requires more free space to complete the process.

Switch directory files are accessible through the Bash shell and Aboot. When entering the Bash shell from the switch, the working directory is located in /home and has the name of the user name from which Bash was entered.

Example

These commands were entered from the user name john:

switch# bash
[john@switch ~]$ pwd
/home/john
[john@switch ~]$

In this instance, the working directory is /home/john.

When a flash drive is inserted in the USB flash port, flash drive contents are accessible through /mnt/usb1.

When entering Aboot, the working directory is the root directory of the boot.

Command-Line Interface Commands

action bash

The action bash command specifies a Bash shell command to be run when an event handler is triggered. When an event handler is triggered, execution of the associated shell command is delayed by a configurable period set by the delay command. Only a single Bash command may be configured for an event handler, but the command may have multiple arguments. If more than one Bash command must be executed in response to a trigger, create a script containing the desired commands and enter the file path to the script as the argument of the action bash command.

To specify the event that will trigger the action, use the trigger command.

If the event handler uses an on-intf trigger, the following environment variables are passed to the action and can be used as arguments to the Bash command:

$INTF interface name.
$OPERSTATE current operational status of the specified interface.
$IP-PRIMARY current primary IP address of the specified interface.

Command Mode

Event-Handler Configuration

Command Syntax

action bash command

Parameters

command Bash shell command to be executed when the event handler is triggered.

Examples

This command configures the event handler “onStartup” to run a script on the flash drive.

switch(config-handler-onStartup)# action bash /mnt/flash/myScript1
switch(config-handler-onStartup)#

This command configures the event handler “eth_4” to send email to the specified address when there is a change in the operational status of Ethernet interface 4.

switch(config-event-eth_4)# action bash email This email address is being protected from spambots. You need JavaScript enabled to view it. -s "Et4 $OPERSTATE"
switch(config-event-eth_4)#

The above action uses the $OPERSTATE variable to include the current operational state (“linkup” or “linkdown”) in the subject of the email. Note that the action will only function if email has been configured on the switch.

alias

The alias command creates an alias for a CLI command. Entering the alias in the CLI executes the corresponding command. Once created, an alias is accessible in all modes and all user sessions, but is subject to all the restrictions of the original command.

When using a command alias, no tokens may precede the alias except the no and default keywords. However, an alias can incorporate positional parameters.

In online help, aliases are preceded by an asterisk (*) in this format:

*alias_name=command_name

The no alias and default alias commands remove the specified alias.

Command Mode

Global Configuration

Command Syntax

alias alias_name command_name

no alias alias_name

default alias alias_name

Parameters

alias_name the string which is to be substituted for the original command. The string can include letters, numbers, and punctuation, but no spaces. If the alias_name string is identical to an existing command, the alias will supercede the original command.
command_name the command which is to be executed when the alias is entered in the CLI. If the original command requires additional parameters, they must be included in the command_name string in the following manner:
Positional parameters are of the form “%n” and must be whitespace-delimited. The first parameter is represented by “%1” and any additional parameters must be numbered sequentially. When executing the alias a value must be entered for each parameter or the CLI will display the error “% incomplete command”.

Examples

This command makes e an alias for the command enable.
```
switch(config)#alias e enable
```
This command makes srie an alias for the command show running-config interface ethernet 1-6.
```
switch(config)#alias srie show running-config interface ethernet 1-6
```

These commands make ss an alias for the command show interfaces ethernet <range> status with a positional parameter for the port range, then use the alias to display the status of ports 4/1-4/5.

switch(config)#alias ss show interfaces ethernet %1 status
switch(config)#ss 4/1-4/5
Port      Name            Status       Vlan       Duplex  Speed Type
Et4/1                     connected    in Po1       full  10000 10GBASE-SRL
Et4/2                     notconnect   in Po1       full  10000 10GBASE-SRL
Et4/3                     notconnect   1            full  10000 10GBASE-SRL
Et4/4                     notconnect   1            full  10000 10GBASE-SRL
Et4/5                     notconnect   1            full  10000 10GBASE-SRL

bash

The bash command starts the Linux Bash shell. The Bash shell gives you access to the underlying Linux operating system and system extensions.

To exit the Bash, type logout, exit, or Ctrl-D at the Bash prompt.

Command Mode

Privileged EXEC

Command Syntax

bash

Examples

This command starts the Bash shell.

switch#bash

Arista Networks EOS shell

[admin@switch ~]$

This command, executed within Bash, exits the Bash shell.
```
[admin@switch ~]$ logout
switch#
```

comment (various configuration modes)

The comment command adds a comment for the active configuration mode to running-config. Comments cannot be modified, but can be replaced by entering the comment command again and entering new text. To append to an existing comment, enter !! followed by additional comment text. To display comments, use the comment option of the show (various configuration modes) command.

The no comment and default comment commands remove the comment from running-config.

Comments cannot be added to the global configuration mode through the EOS.

Command Mode

All configuration modes except Global Configuration

Command Syntax

comment comment_text EOF

no comment

default comment !! comment_text

Parameters

comment_text To create a comment, enter a message when prompted. The message may span multiple lines.
EOF To end a comment, type EOF on its own line (case sensitive) and press enter.

Examples

This command adds a comment to the active configuration mode.

switch(config-sg-radius-RAD-SV1)# comment
Enter TEXT message. Type 'EOF' on its own line to end.
Consult Thomas Morton before making changes to the RADIUS configuration.
EOF
switch(config-sg-radius-RAD-SV1)#

This command appends a line to the comment for the active configuration mode.

switch(config-sg-radius-RAD-SV1)# !! x3452
switch(config-sg-radius-RAD-SV1)#

configure (configure terminal)

The configure command places the switch in the Global Configuration mode to configure features at the system level. You can move to Interface Configuration mode and protocol-specific mode from the Global Configuration mode. The command may also be entered as configure terminal.

Command Mode

Privileged EXEC

Command Syntax

configure [terminal]

Example

This command places the switch in the Global Configuration mode.

switch> enable 
switch# configure 
switch(config)#

configure checkpoint

The configure checkpoint command saves the running configuration to a checkpoint file. This checkpoint file can be used for restoring the current running configuration in future, if required.

Command Mode

Privileged EXEC

Command Syntax

configure checkpoint {restore checkpoint_name | save [checkpoint_name]}

Parameters

restore checkpoint_name restores the running configuration from the specified checkpoint file.
save checkpoint_name saves running configuration to the specified checkpoint file.

Guidelines

If the filename already exists, EOS overwrites the filename. If the command is entered without a checkpoint name, the switch automatically saves the checkpoint under the name ckp-date-number where date is the date in YYYYMMDD format and number increments by one for each automatically named checkpoint file.

Examples

This command saves running-config to the ca_test checkpoint file.
```
switch# configure checkpoint save ca_test
```

This command restores the running-config from the ca_test checkpoint file.

switch# configure checkpoint restore ca_test
! Preserving static routes. Use 'no ip routing delete-static-routes' to clear
them.

This command saves running-config to the 13Aug2018 checkpoint file. The dir command shows the contents of the checkpoint directory.

switch# configure checkpoint save
switch# dir checkpoint:
Directory of checkpoint:/

       -rw-        7426           Aug 13 12:00  ckp-20180813-17
       -rw-        7588           Aug 13 12:10  ckp-20180813-18
       -rw-        8499           Aug 13 12:13  ckp-20180813-19
       -rw-        8499           Aug 13 12:13  ckp-20180813-20

configure convert

The configure convert command converts the current configuration syntax to the specified syntax.

Command Mode

Privileged EXEC

Command Syntax

configure convert new-syntax

Parameter

new-syntax converts running-config to the current version of EOS.

Example

This command converts running-config to the current version of EOS.

switch# configure convert new-syntax

WARNING!
Converting existing configuration to new syntax will lose backward compatibility.
Make sure you won't downgrade to releases that only support the old syntaxes.

Proceed [ y/n ]

configure network

The configure network command is deprecated. Use the copy <url> running-config command to configure the switch from a local file or network location.

copy running-config

The current operating configuration of the switch is stored in a virtual file called running-config. The copy running-config command saves the contents of the running-config virtual file to a new location.

Command Mode

Privileged EXEC

Command Syntax

copy running-config DESTINATION

Parameters

DESTINATION destination for the contents of the running-config file. Values include:
- startup-config the configuration file that the switch loads when it boots.
The copy running-config, startup-config, and write commands are equivalent.
- file: a file in the switch file directory.
- flash: a file in flash memory.
- url any valid URL.

The copy running-config url and write network url commands are equivalent.

Examples

This command copies running-config to the startup-config file.
```
switch# copy running-config startup-config
switch#
```
This command copies running-config to a file called rc20110617 in the dev subdirectory of the switch directory.
```
switch# copy running-config file:dev/rc20110617
switch#
```

daemon

The daemon command accesses daemon configuration mode for adding or removing external daemons and scripts, which are then managed by ProcMgr.

The no daemon and default daemon commands delete the daemon by removing the corresponding daemon command from running-config.

Command Mode

Global Configuration

Command Syntax

daemon daemon_name

no daemon daemon_name

default daemon daemon_name

Parameters

daemon_name label that references the daemon configuration mode.

Example

These commands enters daemon configuration mode and initiates the daemon script.

switch(config)# daemon process1
switch(config-daemon-process1)# command process-script -i -m
switch(config-daemon-process1)#

delay

The delay command specifies the time in seconds the system will delay between a triggering event and the execution of an event handler action. The default delay is 20 seconds.

Command Mode

Event-Handler Configuration

Command Syntax

delay seconds

Parameters

seconds number of seconds to delay before executing the action. The default is 20.

Example

This command configures the event handler Eth5 to delay 10 seconds before executing.

switch(config-handler-Eth5)# delay 10
switch(config-handler-Eth5)#

dir

The dir command displays a list of files on a file system.

Command Mode

Privileged EXEC

Command Syntax

dir [SCOPE][FILE TYPE]

Parameters

SCOPE the files to display. Options include:
- no parameter lists normal files in current directory.
- /all list all files, including hidden files.
- /recursive list files recursively.
FILE TYPE The options include:
- no parameter lists undeleted files.
- all_filesystems list files on all filesystems including deleted files, undeleted files, and files with errors.
- extensions directory or file name.
- file directory or file name.
- flash directory or file name.
- supervisor-peer directory or file name.
- usb1 directory or file name.
- system directory or file name.

Example

This command displays the flash directory.

switch# dir flash:
Directory of flash:/

       -rwx   293409892           Oct 23 08:55  EOS-4.11.0.swi
       -rwx   221274543            Sep 6 13:37  EOS-4.7.5.swi
       -rwx   271453650            Sep 4 19:13  EOS_4.10.1-SSO.swi
       -rwx      135168           Dec 31  1979  FSCK0000.REC
       -rwx          26           Oct 23 13:51  boot-config
       -rwx        8570           Sep 10 12:22  cfg_sso_mst
       -rwx        5642           Sep 20 10:35  config.reset
       drwx        4096           Oct 23 13:59  debug
       -rwx          12           Oct 23 13:56  kernel-params
       drwx        4096           Oct 23 14:59  persist
       drwx        4096            Sep 6 14:50  schedule
       -rwx        5970           Oct 23 13:53  startup-config
switch#

disable

The disable command exchanges the session’s current command mode with the specified privilege level.

Command Mode

Privileged EXEC

Command Syntax

disable [PRIVILEGE_LEVEL]

Parameters

PRIVILEGE_LEVEL Session’s new privilege level. Value ranges from 0 to 15. Levels 2 through 15 place the switch in Privileged EXEC mode. Values of 0 or 1 leave the switch in EXEC mode.

no parameter Session is assigned default level of 1.
<0 to 15> Specifies session level.

Restrictions

New privilege level must be less than the session’s current level.

Example

This command exits Privileged EXEC mode level of 15 to enter EXEC mode level 1.

switch# disable
switch>

enable

The enable command places the switch in Privileged EXEC mode. If an enable password is set, the CLI displays a password prompt when a user enters the enable command. If the user enters an incorrect password three times, the CLI displays the EXEC mode prompt.

To set a local enable password, use the enable password command.

Command Mode

EXEC

Command Syntax

enable [PRIVILEGE_LEVEL]

Parameters

PRIVILEGE_LEVEL Session’s privilege level. Values range from 0 to 15. Values of 0 or 1 places the switch in EXEC mode. Any level above 1 leaves the switch in Privileged EXEC mode.
- no parameter Session is assigned default level of 15.
- <0 to 15> Specifies session level.

Example

This command places the switch in Privileged EXEC mode with the default privilege level of 15.

switch> enable
switch#

end

The end command exits to Privileged Exec mode from any Configuration mode. If the switch is in a group-change mode (such as ACL-Configuration mode or MST-Configuration mode), the end command also saves all pending changes made in that mode to running-config.

Command Mode

All configuration modes

Command Syntax

end

Example

This command exits to Privileged Exec mode.

switch(config-if-Et25)# end
switch#

event-handler DropCountersHandler

The event-handler DropCountersHandler command enables the adverse drop counters monitor with event handlers. The DropCountersHandler event handler is enabled by default, and can be customized for duration of time window and threshold levels.

The no event-handler DropCountersHandler command disables the adverse drop counters monitor with event handlers. The default event-handler DropCountersHandler command resets the DropCountersHandler event handler to the system default.

Command Mode

Global Configuration

Command Syntax

event-handler DropCountersHandler

no event-handler DropCountersHandler

default event-handler DropCountersHandler

Examples

These commands customize the delay, polling interval, and condition for width (-w), violation count (-c), and threshold (-t) of this event handler. Each parameter may be customized separately, with all other parameters remaining unchanged.

switch(config)# event-handler DropCountersHandler
switch(config-DropCountersHandler)# action bash DropCounterLog.py -l
switch(config-DropCountersHandler)# delay 0
switch(config-DropCountersHandler)# trigger on-counters
switch(config-DropCountersHandler-counters)# poll interval 60
switch(config-DropCountersHandler-counters)# condition 
bashCmd."DropCounterMonitor.py" -w 800" > 0
switch(config-DropCountersHandler-counters)# condition 
bashCmd."DropCounterMonitor.py" -c 5" > 0
switch(config-DropCountersHandler-counters)# condition 
bashCmd."DropCounterMonitor.py" -t 200" > 0
switch(config-DropCountersHandler-counters)#

This command disables this event handler.

switch(config)# no event-handler DropCountersHandler
switch(config)#

event-handler

An event handler executes a Linux Bash shell command in response to a specific system event. An event handler consists of a Bash command, a trigger and a delay; when the trigger event occurs, the action is scheduled to run after delay seconds.

The event-handler command places the switch in event-handler configuration mode for the specified event handler. If the named event handler does not already exist, this command creates it. Event-handler configuration mode is a group change mode that configures event handlers.

Changes made in a group change mode are saved by leaving the mode through the exit command or by entering another configuration mode.

These commands are available in event-handler configuration mode:

action bash
delay
trigger

The no event-handler and default event-handler commands delete the specified event handler by removing it from running config.

Command Mode

Global Configuration

Command Syntax

event-handler name

no event-handler name

default event-handler name

Parameters

name name of the event handler to be configured. If the named event handler does not already exist, this command will create it.

Example

This command places the switch in event-handler configuration mode for an event handler called Eth_5.

switch(config)# event-handler Eth_5
switch(config-handler-Eth_5)#

exit

The exit command places the switch in the parent of the command mode from which the exit command was entered.

When used in Global configuration, the switch enters Privileged EXEC mode.
When used in EXEC or Privileged EXEC mode, the exit command terminates the user session.
When the command is used in a group-change mode (such as ACL-Configuration mode or MST-Configuration mode), the exit command also applies all pending changes made in that mode.

Command Mode

All modes

Command Syntax

exit

Examples

This command exits Global Configuration mode to Privileged EXEC mode.
```
switch(config)# exit
switch#
```
This command terminates the user session.
```
switch# exit 
```

ip ftp client source-interface

By default, the FTP (File Transfer Protocol) source IP address is selected by the switch (the IP address of the source interface if one is assigned). The ip ftp client source-interface command allows the user to override the default FTP source address.

The ip ftp client source-interface and ip ftp source-interface commands are functionally equivalent. In each case, ip ftp client source-interface is stored in running-config.

The no ip ftp client source-interface and default ip ftp client source-interface commands restore default behavior by removing the ip ftp client source-interface statement from running-config.

Command Mode

Global Configuration

Command Syntax

ip ftp [client] source-interface INTERFACE [vrf vrf_name]

no ip ftp [client] source-interface

default ip ftp [client] source-interface

Parameters

client Parameter has no functional effect.
INTERFACE Interface providing the IP address. Options include:
- ethernet e_num Ethernet interface specified by e_num.
- loopback l_num Loopback interface specified by l_num.
- management m_num Management interface specified by m_num.
- port-channel p_num Port-channel interface specified by p_num.
- tunnel t_num Tunnel interface specified by t_num.
- vlan v_num VLAN interface specified by v_num.
- vrf vrf_name Uses the specified user-defined VRF.

Examples

These commands configure the 10.10.121.15 as the source IP address the switch uses when communicating with FTP servers.

switch(config)# interface ethernet 17
switch(config-if-Et17)# ip address 10.10.121.15/24
switch(config-if-Et17)# ip ftp client source-interface ethernet 17
switch(config)#

This command configures the switch to use interface tunnel 45 and vrf vrf01 when communicating with FTP servers.
```
switch(config)#ip ftp client source-interface tunnel 45 vrf vrf01
switch(config)#
```

ip http client local-interface

The ip http client local-interface command specifies the source IP address for hypertext transfer protocol (HTTP) connections. By default, the source IP address is selected by the switch when this command is not configured or when the specified interface is not assigned an IP address.

The no ip http client local-interface and default ip http client local-interface commands restore default behavior by removing the ip http client local-interface statement from running-config .

Command Mode

Global Configuration

Command Syntax

ip http client local-interface INTERFACE [vrf vrf_name]

no ip http client local-interface

default ip http client local-interface

Parameters

INTERFACE Interface providing the IP address. Options include:
- ethernet e_num Ethernet interface specified by e_num.
- loopback l_num Loopback interface specified by l_num.
- management m_num Management interface specified by m_num.
- port-channel p_num Port-channel interface specified by p_num.
- vlan v_num VLAN interface specified by v_num.
vrf vrf_name Uses the specified user-defined VRF.

Examples

These commands configure the 10.15.17.9 as the source IP address the switch uses when communicating with HTTP servers.

switch(config)# interface vlan 10
switch(config-if-Vl10)# ip address 10.15.17.9/24
switch(config-if-Vl10)# ip http client local-interface vlan 10
switch(config)#

This command configures the switch to use interface tunnel 45 and vrf vrf01 when communicating with HTTP servers.
```
switch(config)# ip http client local-interface tunnel 45 vrf vrf01
switch(config)#
```

ip ssh client source-interface

The ip ssh client source-interface command specifies the source IP address for secure shell (SSH) connections. By default, the source IP address is selected by the switch when this command is not configured or when the specified interface is not assigned an IP address.

The ip ssh client source-interface and ip ssh source-interface commands are functionally equivalent. In each case, ip ssh client source-interface is stored in running-config.

The no ip ssh client source-interface and default ip ssh client source-interface commands restore default behavior by removing the ip ssh client source-interface statement from running-config.

Command Mode

Global Configuration

Command Syntax

ip ssh [client] source-interface INTERFACE [vrf vrf_name]

no ip ssh [client] source-interface

default ip ssh [client] source-interface

Parameters

client Parameter has no functional effect.
INTERFACE Interface providing the IP address. Options include:
- ethernet e_num Ethernet interface specified by e_num.
- loopback l_num Loopback interface specified by l_num.
- management m_num Management interface specified by m_num.
- port-channel p_num Port-channel interface specified by p_num.
- vlan v_num VLAN interface specified by v_num.
vrf vrf_name Uses the specified user-defined VRF.

Examples

These commands configure the 10.17.17.9 as the source IP address the switch uses when communicating with SSH servers.

switch(config)# interface vlan 10
switch(config-if-Vl10)# ip address 10.17.17.9/24
switch(config-if-Vl10)# ip ssh client source-interface vlan 10
switch(config)#

This command configures the switch to use interface tunnel 45 and vrf vrf01 when communicating with SSH servers.
```
switch(config)#ip ssh client source-interface tunnel 45 vrf vrf01
switch(config)#
```

ip tftp client source-interface

The ip tftp client source-interface command specifies the source IP address for Trivial File Transfer Protocol (TFTP) connections. By default, the source IP address is selected by the switch when this command is not configured or when the specified interface is not assigned an IP address.

The ip tftp client source-interface and ip tftp source-interface commands are functionally equivalent. In each case, ip tftp client source-interface is stored in running-config.

The no ip tftp client source-interface and default ip tftp client source-interface commands restore default behavior by removing the ip tftp client source-interface statement from running-config.

Command Mode

Global Configuration

Command Syntax

ip tftp [client] source-interface INTERFACE [vrf vrf_name]

no ip tftp [client] source-interface

default ip tftp [client] source-interface

Parameters

client Parameter has no functional effect.
INTERFACE Interface providing the IP address. Options include:
- ethernet e_num Ethernet interface specified by e_num.
- loopback l_num Loopback interface specified by l_num.
- management m_num Management interface specified by m_num.
- port-channel p_num Port-channel interface specified by p_num.
- vlan v_num VLAN interface specified by v_num.
vrf vrf_name Uses the specified user-defined VRF.

Examples

These commands configure the 10.15.17.9 as the source IP address the switch uses when communicating with TFTP servers.

switch(config)# interface vlan 10
switch(config-if-Vl10)# ip address 10.15.17.9/24
switch(config-if-Vl10)# ip tftp client source-interface vlan 10
switch(config)#

This command configures the switch to use interface tunnel 45 and vrf vrf01 when communicating with TFTP servers.
```
switch(config)# ip tftp client source-interface tunnel 45 vrf vrf01
switch(config)#
```

platform arad lag mode

The platform arad lag mode command allows configuration of LAGs with more than 16 members.

Command Mode

Global Configuration

Command Syntax

platform arad lag mode [1024x16 | 256x64 | 512x32]

Examples

This command configures 1024 LAGs with 16 members each.

switch(config)# platform arad lag mode 1024x16
! Change will take effect only after switch reboot.
switch(config)#

This command configures 256 LAGs with 64 members each.

switch(config)# platform arad lag mode 256x64
! Change will take effect only after switch reboot.
switch(config)#

This command configures 512 LAGs with 32 members each.

switch(config)# platform arad lag mode 512x32
! Change will take effect only after switch reboot.
switch(config)#

platform sand fabric mode (7500 and 7500E Series)

The platform sand fabric mode command specifies the fabric mode under which the switch operates after the next system reload. The command has no operational effect until the switch reloads.

The fabric mode determines the modular switch’s fabric performance capabilities and must be compatibile with the installed fabric modules. Fabric mode settings include:

fe600: Supports first-generation fabric modules.
fe1600: Supports E-Series fabric modules.
Note: Switches that reload in petraA forwarding compatibility mode (platform sand forwarding mode (7500 and 7500E Series)) also reload in fe600 fabric mode regardless of the presence of a platform sand fabric mode statement in running-config.

The switch’s fabric mode setting must match the capabilities of its installed fabric modules. Reloading the switch in a different mode may be required after exchanging fabric modules for a different module type. The show module command displays the fabric modules in the switch.

Each fabric module is categorized as first-generation or E-Series:

First-generation fabric modules support all basic switch functions.
E-Series fabric modules support faster fabric link speeds, greater internal table capacities, and advanced encoding formatting.

E-series fabric modules can operate in fe600 mode, but are limited to first-generation fabric performance. First-generation modules cannot operate in fe600 mode. Switches containing both types of modules must be set to fe600 mode. Best practice is to avoid switch configurations with mixed fabric modules.

When a switch reloads, fabric mode is determined by the following (in order of precedence):

Switches reloading in petraA forwarding compability mode also reload in fe600 fabric mode .
As specified by the platform sand fabric mode statement in running-config.
The first fabric module that becomes operational as the switch reloads.

The no platform sand fabric mode and default platform sand fabric mode commands remove the platform sand fabric mode command from running-config.

Command Mode

Global Configuration

Command Syntax

platform sand fabric mode [MODE_SETTING]

no platform sand fabric mode

default platform sand fabric mode

Parameters

MODE_SETTING Specifies the switch’s fabric mode. Options include:
- fe16000 E-Series fabric mode.
- fe600 First-generation fabric mode.

Example

switch(config)# platform sand fabric mode fe1600
switch(config)# exit
switch# show platform sand compatibility
                     Configuration        Status
Forwarding mode      None                 Arad
Fabric mode          Fe1600               Fe600
switch#

platform sand forwarding mode (7500 and 7500E Series)

The platform sand forwarding mode command specifies the forwarding compatibility mode under which the switch operates after the next system reload. The command has no operational effect until the switch reloads.

Forwarding compatibility mode specifies switch forwarding capabilities and configures performance capacity of installed linecards. Forwarding compatibility modes settings include:

petraA: Supports first-generation fabric modules.
arad: Supports E-Series fabric modules.
Note: Switches that reload in petraA forwarding compatibility mode also reload in fe600 fabric mode regardless of the presence of a platform sand fabric mode (7500 and 7500E Series) statement in running-config.

This command may be required after exchanging a linecard for a different module type or in switches containing first-generation and E-series linecards. The show module command displays the linecard modules in the switch.

Each modular switch linecard module is categorized as first-generation or E-Series:

First-generation linecards support all basic switch functions.
E-Series linecards support provide faster data processing, greater internal table capacities, and advanced encoding formatting.

The forwarding compatibility mode determines the operational capacity of installed linecards. The following table lists the affect of the forwarding compatibility mode on all linecard module types.

Table 5. Linecard Module and Forwarding Mode Performance
Linecard Module Type	Forwarding Software Mode	Linecard Operating Capacity
First-generation	petraA	Linecard performs at first-generation performance capacity.
First-generation	arad	Linecard is powered-down.
E-Series	petraA	Linecard performs at first-generation performance capacity.
E-Series	arad	Linecard performs at E-series performance capacity.

Note: Linecards operate at E-Series performance capacities only on switches that contain E-Series fabric modules and have a fabric mode setting of fe1600 fabric mode (platform sand fabric mode (7500 and 7500E Series)).

Without a platform sand fabric mode (7500 and 7500E Series) command, forward compatibility mode is determined by the first linecard that becomes operational after reloading the switch. In a switch that is reloaded with a homogeneous module set, forwarding compatibility mode matches its linecards. Switches with a mixed set of modules are typically reloaded in petraA mode because first generation modules are usually operational before E-Series modules. However, forwarding compatibility mode in mixed module switches that are reloading is not guaranteed without a platform sand forwarding mode command.

The no platform sand forwarding mode and default platform sand forwarding mode commands restore the platform sand forwarding mode command from running-config.

Command Mode

Global Configuration

Command Syntax

platform sand forwarding mode [MODE_SETTING]

no platform sand forwarding mode

default platform sand forwarding mode

Parameters

MODE_SETTING Specifies the switch’s software forwarding mode. Options include:
- arad the switch supports E-Series linecard capabilities.
- petraA the switch supports first-generation linecard capabilities.

Example

This command changes the forwarding software mode to support E-series linecard modules. This command should be run only after exchanging all linecards to E-series modules.

switch(config)# platform sand forwarding mode arad
switch(config)#

platform sand lag hardware-only

The platform sand lag hardware-only command specifies that all LAGs will use hardware resources including single member LAGs. Hardware resource allocation and deallocation traffic disruption occurs on the first member addition or deletion, rather than the second member addition or deletion.

The no platform sand lag hardware-only and default platform sand lag hardware-only commands specify that LAGs are not required to be implemented in hardware, and therefore some LAGs may be implemented in software. Permitting both hardware and software LAGs may increase the total number of port-channels because we have no resource limit on the number of software LAGs.

Command Mode

Global Configuration

Command Syntax

platform sand lag hardware-only

no platform sand lag hardware-only

default platform sand lag hardware-only

Examples

This command configures all LAGs to use hardware resources. All existing one member LAGs will be allocated hardware resources, when available.
```
switch(config)# platform sand lag hardware-only
switch(config)#
```
This command allows certain LAGs (single member LAGs) to not consume hardware resources. All existing one member LAGs will release their hardware resources.
```
switch(config)# no platform sand lag hardware-only
switch(config)#
```

pwd

The pwd command displays the working directory.

Command Mode

Privileged EXEC

Command Syntax

pwd

Example

This command shows that the working is Flash.

switch# pwd
flash:/
switch#

schedule config

The schedule config command sets configuration parameters to the CLI scheduler.

The no schedule config max-concurrent-jobs and default schedule config max-concurrent-jobs commands reset the limit of maximum concurrent jobs to the default value of 1 by removing the corresponding schedule config max-concurrent-jobs statement from running-config.

The no schedule config prepend-hostname-logfile and default schedule config prepend-hostname-logfile commands reset the log filenames to the default state.

Command Mode

Global Configuration

Command Syntax

schedule config{max-concurrent-jobs limit | prepend-hostname-logfile}

no schedule config {max-concurrent-jobs limit | prepend-hostname-logfile}

default schedule config {max-concurrent-jobs limit | prepend-hostname-logfile}

Parameters

max-concurrent-jobs limit specifies the maximum number of concurrent commands that can run on the switch. The maximum concurrent jobs ranges from 1 to 4. The default value is 1.
prepend-hostname-logfile enables prepending hostnames to log filenames. By default, this option is enabled.

Examples

This command configures to concurrently run a maximum of three commands on the switch.

switch(config)# schedule config max-concurrent-jobs 3
switch(config)# show schedule summary
Maximum concurrent jobs  3
Prepend host name to logfile: No
Name            At time      Last    Interval   Timeout   Max     Logfile Location               
Status
                             time     (mins)    (mins)    log
                                                         files
------------- ------------- ------- ---------- -------- -------- ------------------------------- ------
tech-support      now        00:29      60        30      100     flash:schedule/tech-support/   Success
thelp           12:02:00     00:02      60        40      100     flash:schedule/thelp/          
Fail
                06/05/2018
switch(config)#

This command enables prepending the hostname to log filenames.

switch(config)# schedule config prepend-hostname-logfile
switch(config)# show schedule summary
Maximum concurrent jobs  3
Prepend host name to logfile: Yes
Name            At time      Last    Interval   Timeout   Max     Logfile Location               
Status
                             time     (mins)    (mins)    log
                                                         files
------------- ------------- ------- ---------- -------- -------- ------------------------------- ------
tech-support      now        00:29      60        30      100     flash:schedule/tech-support/   Success
thelp           12:02:00     00:02      60        40      100     flash:schedule/thelp/          
Fail
                06/05/2018
switch(config)#

schedule

The schedule command facilitates the periodic execution of a specified CLI command. Command parameters configure the start time of periodic execution, the interval between consecutive execution instances, the maximum time allotted for command execution, and the maximum number of log files that can be created.

The no schedule and default schedule commands disable execution of the specified command.

Command Mode

Global Configuration

Command Syntax

schedule schedule_name PERIOD {max-log-files count | timeout timeout_interval}{command cmd | logging verbose | loglocation flash:}

no schedule schedule_name

default schedule schedule_name

Parameters

schedule_name Label associated with the scheduled command.
PERIOD Start time for execution and interval between consecutive execution instances. The interval ranges from 2 to 1440 minutes. The default interval while scheduling the show tech-support command is 60 minutes. Options include:
- at Start time for execution. Options include:
  - hh:mm:ss interval interval The command execution starts at the specified time and repeats at the specified interval.
  - hh:mm:ss mm/dd/yyyy interval interval The command execution starts at the specified time on the specified day and repeats at the specified interval.
  - hh:mm:ss once The command execution starts at the specified time and does not repeat.
  - hh:mm:ss mm/dd/yyyy once The command execution starts at the specified time on the specified day and does not repeat.
  - hh:mm:ss yyyy-mm-dd interval interval The command execution starts at the specified time on the specified day and repeats at the specified interval.
  - hh:mm:ss yyyy-mm-dd once The command execution starts at the specified time on the specified day and does not repeat.
- interval interval The command execution starts immediately and repeats at the specified interval.
- now interval hh:mm:ssinterval intervalhh:mm:ss mm/dd/yyyyinterval intervaloncehh:mm:sshh:mm:ss mm/dd/yyyyoncehh:mm:ss yyyy-mm-ddinterval intervaloncehh:mm:ss yyyy-mm-ddinterval intervalnow interval interval The command execution starts immediately and repeats at the specified interval.
max-log-files count Maximum number of log files command generates for command output. The count of maximum log files ranges from 1 to 10000. The default count of maximum log files while scheduling the show tech-support command is 100.
timeout timeout_interval Maximum time allotted for the script execution. The timeout interval ranges from 1 to 480 minutes. The default timeout is 30 minutes.
Note: The command execution is terminated if it exceeds the specified timeout interval. The timeout allotted for the scheduled command must not be greater than the corresponding interval.
command cmd The command that needs to be executed.
logging verbose Sets the logging level to “verbose.” A syslog entry is added after the execution of the scheduled command, regardless of whether the scheduled command has succeeded or failed. In the absence of logging verbose, the syslog entry is added only if the execution of the scheduled command fails with an error.
loglocation destination The flash destination for scheduled command output files.

Guidelines

Log files created by the command are stored in the flash:/schedule/ scheduled_name / directory. Empty log files are created for commands that do not generate any output.

Examples

This command saves the running configuration contents to the log file every hour with immediate effect and creates a maximum of 24 log files.
```
switch(config)# schedule backup-test interval 60 max-log-files 24 command show running-config
```
This command starts the script execution at 12:00:00 and repeats every 720 minutes. The script execution is terminated if it exceeds 20 minutes. It generates a maximum of one log file because the specified bash command does not have an output.
```
switch(config)# schedule ms1 at 12:00:00 interval 720 timeout 20 max-log-files 1 command bash /mnt/flash/myscript.sh
```

The show schedule command lists the commands currently scheduled for periodic execution and displays the summary of the specified scheduled command.

switch# show schedule summary
Maximum concurrent jobs  1
Prepend host name to logfile: Yes

Name At time Last  Interval Timeout  Max    Logfile Location    Status
             time  (mins)   (mins)   log     
                                     files
---- ------- ----- -------- -------- ------ -------------------  -------
ms1   now    23:03   720       20      1    flash:/schedule/ms1 Success

switch#

show (various configuration modes)

The show command, when executed within a configuration mode, can display data in running-config for the active configuration mode.

Command Mode

All configuration modes except Global Configuration

Command Syntax

show [DATA_TYPE]

Parameters

DATA_TYPE Specifies display contents. Values include:
- active Displays running-config settings for the configuration mode.
- active all Displays running-config plus defaults for the configuration mode.
- active all detail Displays running-config plus defaults for the configuration mode.
- comment Displays comment entered for the configuration mode.

Related Commands

The show commands in ACL-configuration mode and MST-configuration mode include the active and comment options along with additional mode-specific options.

Example

This command shows the server-group-TACACS+ configuration commands in running-config.

switch(config-sg-tacacs+-TAC-GR)# show active
   server TAC-1
   server 10.1.4.14
switch(config-sg-tacacs+-TAC-GR)#

show event-handler DropCountersHandler

The show event-handler command displays details of the DropCountersHandler event handler.

Command Mode

Privileged EXEC

Command Syntax

show event-handler DropCountersHandler

Example

This command displays details of this event handler.

switch(config)# show event-handler DropCountersHandler
Event-handler DropCountersHandler (BUILT-IN)
Trigger: on-counters delay 0 seconds
  Polling Interval: 60 seconds
  Condition: bashCmd."DropCounterMonitor.py" > 0
Threshold Time Window: 0 Seconds, Event Count: 1 times
Action: DropCounterLog.py -l
Action expected to finish in less than 20 seconds
Total Polls: 39
Last Trigger Detection Time: 38 minutes 22 seconds ago
Total Trigger Detections: 1
Last Trigger Activation Time: 38 minutes 22 seconds ago
Total Trigger Activations: 1
Last Action Time: Never
Total Actions: 1

switch(config)#

show event-handler

The show event-handler command displays the contents and activation history of a specified event handler or all event handlers.

Command Mode

Privileged EXEC

Command Syntax

show event-handler [handler_name]

Parameters

handler_name optional name of an event handler to display. If no parameter is entered, the command displays information for all event handlers configured on the system.

Example

This command displays information about an event handler called “eth_5”.

switch# show event-handler Eth_5
Event-handler Eth_5
Trigger: on-intf Ethernet5 on ip delay 20 seconds
Threshold Time Window: 0 Seconds, Event Count: 1 times
Action: :
Device-health Action: None
Action expected to finish in less than 10 seconds
Last Trigger Detection Time: 15 days 2 hours 19 minutes ago
Total Trigger Detections: 1
Last Trigger Activation Time: 15 days 2 hours 19 minutes ago
Total Trigger Activations: 1
Last Action Time: 15 days 2 hours 19 minutes ago
Total Actions: 1
switch#

show module

The show module command displays information that identifies the supervisor, fabric, and linecard modules in a modular switch, including model number, serial number, hardware version number, software version (supervisors only), MAC address (supervisors and linecards), and operational status.

Command Mode

EXEC

Command Syntax

show module [MODULE_NAME]

Parameters

MODULE_NAME Specifies modules for which data is displayed. Options include:
- no parameter All modules (identical to all option).
- fabric fab_num Specified fabric module. Number range varies with switch model.
- linecard line_num Linecard module. Number range varies with switch model.
- supervisor super_num Supervisor module. Number range varies with switch model.
- mod_num Supervisor (1 to 2) or linecard (3 to 18) module.
- all All modules.

Related Command

show version displays model and serial numbers of modular system components.

Examples

This command displays information about all installed modules on a DCS-7504 switch.

switch# show module
Module    Ports Card Type                            Model           Serial No.
--------- ----- ------------------------------------ --------------- -----------
1         2     DCS-7500 Series Supervisor Module    7500-SUP        JSH11440327
2         1     Standby supervisor                   Unknown         Unknown
3         48    48-port SFP+ 10GigE Linecard         7548S-LC        JSH10315938
4         48    48-port SFP+ 10GigE Linecard         7548S-LC        JSH11665247
5         48    48-port SFP+ 10GigE Linecard         7548S-LC        JSH11834614
6         48    48-port SFP+ 10GigE Linecard         7548S-LC        JSH11060688
Fabric1   0     DCS-7504 Fabric Module               7504-FM         JSH11244430
Fabric2   0     DCS-7504 Fabric Module               7504-FM         JSH11892120
Fabric3   0     DCS-7504 Fabric Module               7504-FM         JSH11941115
Fabric4   0     DCS-7504 Fabric Module               7504-FM         JSH11661618
Fabric5   0     DCS-7504 Fabric Module               7504-FM         JSH11757555
Fabric6   0     DCS-7504 Fabric Module               7504-FM         JSH11847728

Module    MAC addresses                          Hw      Sw      Status
--------- -------------------------------------- ------- ------- -------
1         00:1c:23:03:06:ac - 00:1c:23:03:06:ac  07.06   4.12.1  Active
2                                                        4.12.1  Standby
3         00:1c:23:03:80:44 - 00:1c:23:03:80:73  06.00           Ok
4         00:1c:23:03:e4:34 - 00:1c:23:03:e4:63  07.10           Ok
5         00:1c:23:12:0b:3f - 00:1c:23:12:0b:6e  07.30           Ok
6         00:1c:23:12:b6:3f - 00:1c:23:12:b6:6e  08.00           Ok
Fabric1                                          05.03           Ok
Fabric2                                          05.03           Ok
Fabric3                                          05.02           Ok
Fabric4                                          05.02           Ok
Fabric5                                          05.02           Ok
Fabric6                                          05.02           Ok
switch#

This command displays information about all installed modules on a DCS-7304 switch.

switch# show module
Module    Ports Card Type                            Model           Serial No.
--------- ----- ------------------------------------ --------------- -----------
1         3     Supervisor 7300X SSD                 DCS-7300-SUP-D  JAS13340024
3         128   32 port 40GbE QSFP+ LC               7300X-32Q-LC    JPE13440416
4         64    48 port 10GbE SFP+ & 4 port QSFP+ LC 7300X-64S-LC    JAS13310113
5         64    48 port 10GbE SFP+ & 4 port QSFP+ LC 7300X-64S-LC    JAS13340033
6         64    48 port 10GbE SFP+ & 4 port QSFP+ LC 7300X-64S-LC    JAS13310103
Fabric1   0     7304X Fabric Module                  7304X-FM        JAS13320077
Fabric2   0     7304X Fabric Module                  7304X-FM        JAS13350043
Fabric3   0     7304X Fabric Module                  7304X-FM        JAS13350050
Fabric4   0     7304X Fabric Module                  7304X-FM        JAS13350056

Module    MAC addresses                          Hw      Sw      Status
--------- -------------------------------------- ------- ------- -------
1         00:1c:73:36:4b:71 - 00:1c:73:36:4b:72  01.01   4.13.3F Active
3         00:1c:73:58:d4:68 - 00:1c:73:58:d4:87  03.04           Ok
4         00:1c:73:36:05:61 - 00:1c:73:36:05:94  02.02           Ok
5         00:1c:73:36:0a:e1 - 00:1c:73:36:0b:14  02.03           Ok
6         00:1c:73:36:02:e1 - 00:1c:73:36:03:14  02.02           Ok
Fabric1                                          00.00           Ok
Fabric2                                          00.00           Ok
Fabric3                                          00.00           Ok
Fabric4                                          00.00           Ok
switch#

show platform sand compatibility

The show sand platform compatibility command displays the fabric and forwarding modes. These modes determine switch forwarding capabilities and programs performance capacity of installed linecards

Information that identifies the supervisor, fabric, and linecard modules in the modular switch, including model number, serial number, hardware version number, software version (supervisors only), MAC address (supervisors and linecards), and operational status.

Command Mode

Privileged EXEC

Command Syntax

show platform sand compatibility

Related Commands

platform sand fabric mode (7500 and 7500E Series) specifies the fabric software mode.
platform sand forwarding mode (7500 and 7500E Series) specifies the forwarding software mode.

Example

This command indicates that the switch is in Fe600 fabric mode and PetraA forwarding mode.

switch# show platform sand compatibility
                     Configuration        Status
Forwarding mode      None                 PetraA
Fabric mode          None                 Fe600
switch#

show platform sand lag hardware-only

The show platform sand lag hardware-only command displays whether or not LAGs are hardware-only.

Command Mode

Privileged EXEC

Command Syntax

show platform sand lag hardware-only

Examples

This command indicates that LAGs are hardware-only.

switch(config)# platform sand lag hardware-only
switch(config)# exit
switch# show platform sand lag hardware-only
Hardware resources are used for all LAGs: True
switch#

This command indicates that LAGs are not hardware-only.

switch(config)# no platform sand lag hardware-only
switch(config)# exit
switch# show platform sand lag hardware-only
Hardware resources are used for all LAGs: False
switch#

show schedule

The show schedule command displays logging output on the terminal during the current terminal session. This command affects only the local monitor. The no terminal monitor command disables direct monitor display of logging output for the current terminal session.

The show schedule command displays the list of active scheduled commands and the summary of specified scheduled command.

Command Mode

Global Configuration

Command Syntax

show schedule {schedule_name |summary}

Parameters

schedule_name displays the summary of the specified scheduled command.
summary displays the list of active scheduled commands.

Examples

This command displays the summary of the thelp schedule.

switch(config)# show schedule thelp
The last CLI command failed with exit status 1
CLI command "show THelp" is scheduled next at "02:02:35 06/19/2018", interval is 
60 minutes
Timeout is 40 minutes
Maximum of 100 log files will be stored
Verbose logging is off
100 log files currently stored in flash:/schedule/thelp

Start time                 Size          Filename
----------------------- ---------------- ----------------------------------
Jun 19 2018 01:02       60.0 bytes       ro301_thelp_2018-06-19.0102.log.gz
Jun 19 2018 00:02       60.0 bytes       ro301_thelp_2018-06-19.0002.log.gz
Jun 18 2018 23:02       60.0 bytes       ro301_thelp_2018-06-18.2302.log.gz
Jun 18 2018 22:02       60.0 bytes       ro301_thelp_2018-06-18.2202.log.gz
Jun 18 2018 21:02       60.0 bytes       ro301_thelp_2018-06-18.2102.log.gz

switch(config)#

This command displays the summary of scheduled commands.

switch(config)# show schedule summary
Maximum concurrent jobs  1
Prepend host name to logfile: Yes
Name            At time      Last    Interval   Timeout   Max     Logfile Location               
Status
                             time     (mins)    (mins)    log
                                                         files
------------- ------------- ------- ---------- -------- -------- ------------------------------- ------
tech-support      now        00:29      60        30      100     flash:schedule/tech-support/   Success
thelp           12:02:00     00:02      60        40      100     flash:schedule/thelp/          
Fail
                06/05/2018
switch(config)#

show version

The show version command displays information that identifies the switch, including its model number, serial number, and system MAC address. The command also provides hardware and software manufacturing information, along with the available memory and elapsed time from the most recent reload procedure.

Command Mode

EXEC

Command Syntax

show version [INFO_LEVEL]

Parameters

INFO_LEVEL Specifies information the command displays. Options include:

no parameter Model and serial numbers, manufacturing data, uptime, and memory.
detail Data listed no parameter option plus version numbers of internal components.

Related Command

show module displays model and serial numbers of modular system components.

Example

This command displays the switch’s model number, serial number, hardware and software manufacturing information, uptime, and memory capacity.

switch> show version 
Arista DCS-7150S-64-CL-F
Hardware version:    01.01
Serial number:       JPE13120819
System MAC address:  001c.7326.fd0c

Software image version: 4.13.2F
Architecture:           i386
Internal build version: 4.13.2F-1649184.4132F.2
Internal build ID:      eeb3c212-b4bd-4c19-ba34-1b0aa36e43f1

Uptime:                 1 hour and 36 minutes
Total memory:           4017088 kB
Free memory:            1473280 kB

switch>

terminal length

The terminal length command overrides automatic pagination and sets pagination length for all show commands on a terminal. If the output of a show command is longer than the configured terminal length, the output will be paused after each screenful of output, prompting the user to continue.

To disable pagination for an SSH session, set terminal length to 0. By default, all console sessions have pagination disabled.

The no terminal length and default terminal length commands restore automatic pagination by removing the terminal length command from running-config.

The pagination setting is persistent if configured from Global Configuration mode. If configured from EXEC mode, the setting applies only to the current CLI session. Pagination settings may also be overridden when you adjust the size of the SSH terminal window, but can be reconfigured by running the terminal length command again.

Command Mode

EXEC

Command Syntax

terminal length lines

no terminal length

default terminal length

Parameters

lines number of lines to be displayed at a time. Values range from 0 through 32767. A value of 0 disables pagination.

Examples

This command sets the pagination length for the current terminal session to 10 lines.
```
switch# terminal length 10
Pagination set to 10 lines.
```
This command configures the switch to paginate terminal output automatically based on screen size for the current terminal session.
```
switch# no terminal length
```

These commands disable pagination globally.

switch# configure
switch(config)# terminal length 0
Pagination disabled.

terminal monitor

The terminal monitor command enables the display of logging output on the terminal during the current terminal session. This command affects only the local monitor. The no terminal monitor command disables direct monitor display of logging output for the current terminal session.

Command Mode

Privileged EXEC

Command Syntax

terminal monitor

no terminal monitor

default terminal monitor

Example

This command enables the display of logging to the local monitor during the current terminal session.

switch# terminal monitor
switch#

trigger

The trigger command specifies what event will trigger the event handler. Handlers can be triggered either by the system booting or by a change in a specified interface’s IP address or operational status.

To specify the action to be taken when the handler is triggered, use the action bash command.

Command Mode

Event-Handler Configuration

Command Syntax

trigger EVENT

Parameters

EVENT event which will trigger the configuration mode event handler. Values include:
- onboot triggers when the system reboots, or when you exit event-handler configuration mode. This option takes no further arguments, and passes no environment variables to the action triggered.
  - on-intf INTERFACE CHANGE triggers when a change is made to the specified interface.
  - on-startup-config triggers when a change is made to the startup-config file.
  - vm-tracer vm triggers when a virtual machine monitored by VM Tracer changes state.
INTERFACE the triggering interface. Values include:
- ethernet number Ethernet interface specified by number.
- loopback number loopback interface specified by number.
- management number management interface specified by number.
- port-channel number channel group interface specified by number.
- vlan numver VLAN interface specified by number.
CHANGE the change being watched for in the triggering interface. Values include:
- ip triggers when the IPv4 address of the specified interface is changed.
- ip6 triggers when the IPv6 address of the specified interface is changed.
- operstatus triggers when the operational status of the specified interface changes.

Examples

This command configures the event handler Eth5 to be triggered when there is a change in the operational status or IP address of Ethernet interface 5.
```
switch(config-handler-Eth5)# trigger on-intf Ethernet 5 operstatus ip
switch(config-handler-Eth5)#
```
This command configures the event handler “onStartup” to be triggered when the system boots, or on exiting event-handler configuration mode.
```
switch(config-handler-onStartup)# trigger onboot
switch(config-handler-onStartup)#
```

Booting the Switch

This chapter describes the switch boot process, describes configuration options, and lists the components it requires, including the boot loader, the boot loader shell, and other configuration files.

This chapter includes the following sections:

Boot LoaderAboot

Aboot is the boot loader for Arista switches. In addition to booting the switch EOS, Aboot provides a shell for changing boot parameters, restoring default switch settings, diagnosing hardware problems, and managing switch files. Aboot Shell describes the Aboot shell.

The boot process loads an EOS image file, initiates switch processes, performs self-tests, restores interface settings, and configures other network parameters. The replacement image file can be in the switch’s flash or on a device in the flash drive port. Configuration files stored in flash memory specify boot parameters.

Aboot supports most available USB flash drive models. The flash drive must be formatted using the FAT or VFAT file system. Windows NT File System (NTFS) is not supported.

Aboot initiates a system reboot upon a reload command or by restoring power to the switch. Before loading the EOS image file, Aboot provides an option to enter the Aboot shell. The user can either enter the shell to modify boot parameters or allow the switch to boot.

You can monitor the boot process through a terminal connected to the console port. Configuration file settings configure the console port to interact with the terminal.

Page 14 of 15

End of Support

Session Management Commands

Global Configuration Commands

Management Configuration Commands

Display Commands

configure replace

configure session

domain (XMPP Management)

idle-timeout (Console Management)

idle-timeout (SSH Management)

idle-timeout (Telnet Management)

management api eos-sdk-rpc

management api external-services

management api gnmi

management api gnsi

management api gribi

management api http-commands

management api models

management api netconf

management api restconf

management console

management ssh

management telnet

management xmpp

protocol http (API Management)

protocol https (API Management)

protocol https certificate (API Management)

reset system storage secure

server (XMPP Management)

session privilege (XMPP Management)

show inventory

show xmpp neighbors

show xmpp status

show xmpp switch-group

shutdown (API Management)

shutdown (Telnet Management)

shutdown (XMPP Management)

switch-group (XMPP Management)

username (XMPP Management)

vrf (API Management)

vrf (XMPP Management)

xmpp send

xmpp session

Administering the Switch

Managing the Switch Name

Assigning a Name to the Switch

Examples

Specifying DNS Addresses

Example

Examples

System Clock and Time Protocols

Configuring the Time Zone

Examples

Setting the System Clock Manually

Example

Displaying the Time

Example

Network Time Protocol (NTP)

Configuring the NTP Server

Example

Configuring the NTP Source

Example

Configuring the Switch as an NTP Server

Examples

Configuring NTP Authentication

Viewing NTP Settings and Status

Examples

Managing Display Attributes

Banners

Configuring prompt

Examples

Logging of Event Notifications

Managing TCAM Capacity Warnings

Examples

Event Monitor

Description

Configuring the Event Monitor

Enabling the Event Monitor

Example

Example