Session Management commands

Global configuration commands

Management configuration commands

Display commands

commit timer

The commit timer command can automatically roll back changes performed during a configuration session if you haven't confirmed them within a preset time interval. This feature can prevent a user from committing configuration changes that could cause a network disruption. The no commit timer command deletes the session.

Command Mode

Configure Session configuration Mode

Command Syntax

commit timer hh:mm:ss

Parameters

hh:mm:ss - Specify the time interval for the commit session.

Example

Use the following command to create a commit timer for 01.00.00 hour:
switch(config-s-MySession)# commit timer 01:00:00
switch#

configure replace

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

Command Mode

Privileged EXEC

Command Syntax

configure replace source_file_path:source_file_name [ignore-errors] [md5 md5sum] [skip-checkpoint] [vrf instance_name]

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.
  • certificate: - Replace the current configuration with the certificate configuration.
  • checkpoint: - Replace the current configuration with the checkpoint configuration.
  • clean-config: - Replace the current configuration with a clean, default configuration.
  • extension: - Replace the current extensions configuration with an extensions configuration.
  • file: - Replace the current configuration with a configuration from a file location.
  • flash: - Replace the current configuration with a configuration from a flash location.
  • ftp: - Replace the current configuration with a configuration from a FTP location.
  • http: - Replace the current configuration with a configuration from an HTTP location.
  • https: - Replace the current configuration with a configuration from an HTTPS location.
  • installed-extensions: - Replace the current configuration with the installed extensions status.
  • running-config: - Replaces the current configuration with the running configuration.
  • scp: - Replace the current configuration with a configuration from an SCP location.
  • sftp: - Replace the current configuration with a configuration from an SFTP location.
  • snapshot: - Replace the current configuration with a configuration from a snapshot.
  • ssh-auth-principals-cmd: - Retrieve a configuration from an SSH location and replace the current configuration.
  • ssh-ca-key: - Retrieve a configuration from an SSH location and replace the current configuration.
  • ssh-key: - Retrieve a configuration from an SSH location and replace the current configuration.
  • ssh-revoke-list: - Retrieve a configuration from an SSH location and replace the current configuration.
  • startup-config: - Replace the current configuration with the startup configuration.
  • system: - Retrieve a configuration from a system location and replace the current configuration.
  • terminal: - Retrieve a configuration from a terminal location and replace the current configuration.
  • tftpt: - Retrieve a configuration from a TFTP location and replace the current configuration.
  • ignore-errors - Replace the configuration and 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 fileof 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 temporary configuration changes and commits to running-config later by issuing the commit command. eos discards an uncommitted configuration session if the switch reboots and times 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] [abort | commit | [description description]]

no configure session session_name

default configure session

Parameter

  • session_name -Create a name for the configuration session.
  • abort - Ends the configuration sessions and deletes it.
  • commit - Commits the changes executed during the session.
  • description description - Create a description for the configuration session.

Guidelines

  • Creates a session with a name generated by the switch if you do not specify a session name.
  • 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 named MySession) and adds commands. Issuing the commit command executes all commands and overwrites any configuration performed since the creation of the session.
switch(config)#configure session
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)#commit
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 provides shortcuts for the switch-group and username so you can configure it without the domain attached to it, for example, 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

ManagementXMPP configuration

Command Syntax

domain string

no domain

default domain

Parameter

string - Configures the domain name as a 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 refers to the length of time that a connection waits after a user's most recent command before shutting down the connection. By default, setting the idle timeout to zero disables the connection timeout automatically.

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

ManagementConsole configuration

Command Syntax

idle-timeout idle_period

no idle-timeout

default idle-timeout

Parameters

idle_period session idle-timeout length. Options include:
  • 0 - Disables the automatic connection timeout.
  • 1 to 86400 - Configures the automatic timeout period in 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 refers to the length of time that a 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.

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

Management SSH configuration

Command Syntax

idle-timeout idle_period

no idle-timeout

default idle-timeout

Parameters

idle_period session idle-timeout length. Options includethe following:
  • 0 - Disables the automatic connection timeout.
  • 1 to 86400 - Configures the automatic timeout period in 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 refers to the length of time that a 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.

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

ManagementTelnet

Command Syntax

idle-timeout idle_period

no idle-timeout

default idle-timeout

Parameters

idle_period session idle-timeout length. Options include:
  • 0 - Disables the automatic connection timeout.
  • 1 to 86400 - Configures the automatic timeout period in 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 HTTP commands API Management configuration Mode statements from running-config.

HTTP commands API Management configuration Mode is not a group change mode. The running-config changes 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

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 configuration 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 Console Management 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 the Console Management configuration Mode statements from running-config.

The mgmt-console configuration mode is not a group change mode. The running-config changes 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 Console Management configuration Mode

idle-timeout (Console Management)

Examples
  • This command places the switch into Console Management 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 SSH Management configuration Mode to adjust SSH session connection parameters.

The no management ssh and default management ssh commands delete the SSH Management configuration Mode statements from running-config.

The mgmt-ssh configuration mode is not a group change mode. The running-config changes immediately upon entering commands. Exiting the SSH 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 ssh

no management ssh

default management ssh

commands Available in Mgmt-ssh configuration Mode
  • authentication mode
  • cipher
  • fips restrictions
  • hostkey
  • idle-timeout
  • ip access group
  • ipv6 access group
  • login timeout
  • key-exchange
  • mac hmac
  • server-port
  • shutdown
  • vrf

Examples
  • This command places the switch in SSH Management configuration Mode:
    switch(config)# management ssh
switch(config-mgmt-ssh)#
  • This command returns the switch to Global configuration Mode:
    switch(config-mgmt-ssh)# exit
switch(config)#

management telnet

The management telnet command places the switch in Telnet Management configuration Mode to adjust Telnet session connection parameters.

The no management telnet and default management telnet commands delete the Telnet Managementconfiguration Mode statements from running-config.

The Telnet Management configuration Mode is not a group change mode. The running-config changes immediately upon entering commands. Exiting the Telnet 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 telnet

no management telnet

default management telnet

commands Available in Telnet Management configuration Mode
  • idle-timeout
  • ip access group
  • ipv6 access group
  • shutdown
  • vrf )

Examples
  • This command places the switch in Telnet Management configuration Mode:
    switch(config)# management telnet
switch(config-mgmt-telnet)#
  • This command returns the switch to Global configuration Mode:
    switch(config-mgmt-telnet)# exit
switch(config)#

management xmpp

The management xmpp command places the switch in Management XMPP configuration Mode. eos disables Management over XMPP 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 Management XMPP configuration Mode statements from running-config.

The mgmt-xmpp configuration mode does not provide a group change mode. The running-config changes 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 Management XMPP configuration Mode
  • domain
  • server
  • session
  • shutdown
  • switch-group
  • username
  • vrf

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

API Management 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 for the switch.
  • cipher - Exclusive list of cryptographic ciphers.
  • key-exchange - Exclusive list of key-exchange algorithms.
  • mac - Exclusive list of MAC algorithms.
  • port - The TCP port number to serve on.
  • ssl - Configure SSL options.

Related commands

management api http-commands places the switch in API Management 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

API Management configuration

Command Syntax

protocol https certificate

no protocol https certificate

default protocol https certificate

Related Command

management api http-commands places the switch in API Management 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. Secure erase is a command that deliberately, permanently, and irreversibly removes and 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 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. The 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

XMPP Management configuration Mode

Command Syntax

server SERVER_NAME [SERVER_PORT]

no server

default server

Parameters
  • SERVER_NAME XMPP server location. Options include the following:
    • IP address - Specify an IP address in dotted decimal notation.
    • Specify a host name for the XMPP server.

  • SERVER_PORT - Specify the server port. Options include:
    • port 1 to 65535 -Specify a port 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 places the user in EXEC mode. By default, the initial privilege level has no configured privileges. 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 no AAA configuration exists 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

XMPP Management configuration Mode

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 connection status. The XMPP server keeps track of all relationships between users.

Command Mode

EXEC

Command Syntax

show xmpp neighbors

Example

This command displays all the XMPP neighbors and 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

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 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 API Management configuration Mode. eos disables API Management by default.

The no shutdown command enables the API managementaccess 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. eos disables by default. The management telnet command places the switch in the Telnet Management configuration Mode.
  • To enable Telnet, enter no shutdown at the Telnet Management prompt.
  • To disable Telnet, enter shutdown at the Telnet Management prompt.

Command Mode

Telnet Management configuration

Command Syntax

shutdown

no shutdown

Examples
  • These commands enable Telnet and return the switch to the 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. eos disables XMPP by default.

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

Command Mode

XMPP Management configuration

Command Syntax

shutdown

no shutdown

default shutdown

Examples
  • These commands enable management over XMPP and return the switch to the 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. Configure the switch 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

XMPP Management configuration Mode

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.
  • To comply with the multi-user chat XMPP standard (XEP-0045), switch groups contain 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 appended to 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 username and password for the switch 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

XMPP Management configuration

Command Syntax

username name security

no username

default username

Parameters
  • name - Specify a username for the XMPP server.

    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 an 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. Because password parameter set to zero, the password appears in clear text.
    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

API Management 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.

Related Command

management api http-commands places the switch in API Management configuration.

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

XMPP Management 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 connected with each other. The show xmpp neighbor command verifies the friendship between switches.

Command Mode

Privileged EXEC

Command Syntax

xmpp send 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 - Specifies the 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
  • Allows only enable-mode commands within the multi-switch CLI.
  • Does not support changing into a different CLI mode and running several commands.
  • An external XMPP client can send multiple lines within a single message. By sending multiple lines, it is possible to change into another CLI mode. After processing the message, the switch automatically returns to the enable mode.
  • Does not support commands that prompt for a response, such as reload.
  • 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.
  • Displays many command outputs 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 a request to the switch in the chat room for executing 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 and password in order to connect to the XMPP server. eos uses the format USER@DEFAULTDOMAIN by default. 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 connected as friends in a chat room.

configuration Restrictions
  • Allows only enable-mode commands within the multi-switch CLI.
  • Does not support changing into a different CLI mode and running several commands.
  • An external XMPP client can send multiple lines within a single message. By sending multiple lines, it is possible to change into another CLI mode. After processing the message, the switch automatically returns to the enable mode.
  • Does not support commands that prompt for a response, such as reload.
  • 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.
  • Displays many command outputs 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, 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#