Session Management commands

Global configuration commands

Management configuration commands

Display commands

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]

Parameter

  • source_file_path:source_file_name replaces current configuration with the configuration from the specified source file.
  • boot-extensions replaces current configuration with the boot extensions configuration.
  • clean-config replaces current configuration with clean and default configurations.
  • installed-extensionsreplaces current configuration with the installed extensions configuration.
  • running-configobsolete.
  • starup-configreplaces current configuration with the startup configuration.
  • ignore-errors ignores errors while loading the new configuration.
  • md5 md5sumperforms 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 making a series of configuration changes in a temporary location and commit them to running-config at once by issuing the commit command.

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

If a session name is not specified, a system named session is created. The switch permits up to five uncommitted sessions.

Example
  • This command creates a session with a name created automatically.
    switch(config)#configure session
switch(config-s-sess-1)#

domain (XMPP Management)

The domain command configures the switchs XMPP domain name. Only messages using a domain matching the locally configured one are accepted by the XMPP client. The switch's domain name is used if none is specified.

Management over XMPP is disabled by default. To enable it, you must provide the location of the server along with the 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 they can be configured 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

Parameters
  • string domain name (text string)
Examples:
  • This command configures test.aristanetworks.com as the switchs 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 test1@test.aristanetworks.com 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 the interval that the connection waits after a users most recent command before shutting down the connection. Automatic connection timeout is disabled by setting the idle-timeout to zero, which is the default setting.

The no idle-timeout and default idle-timeout commands disables 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).
Example
  • 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 the interval that the connection waits after a users most recent command before shutting down the connection. Automatic connection timeout is disabled by setting the idle-timeout to zero, which is the default setting.

The no idle-timeout and default idle-timeout commands disables 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 86400> Automatic timeout period (minutes).
Example
  • 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 the interval that the connection waits after a users most recent command before shutting down the connection. Automatic connection timeout is disabled by setting the idle-timeout to zero, which is the default setting.

The no idle-timeout and default idle-timeout commands disables 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).
Example
  • 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 http-commands

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

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

Mgmt-api-http-cmds configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting mgmt-api-http-cmds 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 Mgmt-API configuration Mode

Example
  • This command places the switch in mgmt-api-http-cmds 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 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.

Mgmt-console configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting 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

Example
  • 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.

Mgmt-ssh configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting 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)
  • key-exchange (Management-SSH)
  • login timeout (Management-SSH)
  • mac hmac (Management-SSH)
  • server-port (Management-SSH)
  • shutdown (Management-SSH)
  • vrf (Management-SSH)
Example
  • 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.

Mgmt-telnet configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting 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)
Example
  • 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.

Mgmt-xmpp configuration mode is not a group change mode; running-config is changed immediately upon entering commands. Exiting 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)
Example
  • 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 to be used for the HTTP server. Options include:

    • <no parameter> Specifies default port number 80.
    • port <1 to 65535> Specifies HTTP server port number. 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.
Examples
  • 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 to be used for the HTTPS server. Options include:
    • <no parameter> Specifies default port number 443.
    • port <1 to 65535> Specifies HTTP server port number. 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 specifies the port number that should be 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 commands

Examples
  • 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)#

server (XMPP Management)

The server command adds a XMPP server to running-config. Multiple XMPP servers can be set up for redundancy. For redundant configurations, the XMPP server location should be a DNS name and not a raw IP address. The DNS server is responsible for returning the list of available XMPP servers, which the client can go through until an accessible server is found.

User authentication is provided by the XMPP server. Command authorization can be provided by eos local configuration or TACACS+. 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. The initial privilege level is meaningless by default. 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

Parameters

  • PRIV_LEVEL Privilege levels of the commands. Value ranges from 0 and 15.
Examples
  • These commands authorizes 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. Serial numbers and a description is also provided for each component.

Command Mode

EXEC

Command Syntax

show inventory

Examples
  • This command displays the hardware installed in a DCS-7150S-52 switch.
    switch>show inventory
System information
ModelDescription
------------------------ ----------------------------------------------------
DCS-7150S-52-CL52-port SFP+ 10GigE 1RU + Clock

HW VersionSerial NumberMfg Date
----------- -------------- ----------
02.00 JPE131207022013-03-27

System has 2 power supply slots
Slot ModelSerial Number
---- ---------------- ----------------
1PWR-460AC-FK192KU00241CZ
2PWR-460AC-FK192L200751CZ

System has 4 fan modules
ModuleNumber of FansModelSerial 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 ModelSerial NumberRev
---- ---------------- ---------------- ---------------- ----
1Arista NetworksSFP-10G-SR XCW1225FD753 0002
2Arista NetworksSFP-10G-SR XCW1225FD753 0002

51 Arista NetworksSFP-10G-SR XCW1225FD753 0002
52 Arista NetworksSFP-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
NeighborState Last Seen Login Time
--------------------------------------------- -------------------------
admin@test.aristanetworks.com present 0:01:40 ago
test1@test.aristanetworks.com present 20:29:39 ago

NeighborStatus Message
----------------------------------------------------------------------
admin@test.aristanetworks.com
test1@test.aristanetworks.com 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. In order for two users to directly communicate, this relationship must first be established and confirmed by the other party.

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

Command Mode

EXEC

Command Syntax

show xmpp status

Example
  • This command displays the current XMPP connection status to the server.
    switch#show xmpp status
XMPP Server:port 5222
Client username: test@test.aristanetworks.com
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
testroom@conference.test.aristanetworks.com
switch#

shutdown (API Management)

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

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

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

Command Mode

Mgmt-API configuration

Command Syntax

shutdown

no shutdown

default shutdown

Related commands

Example
  • These commands disables 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 enables 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, in management-telnet mode, disables or enables Telnet on the switch. Telnet is disabled by default. The management telnetcommand 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

Example
  • These commands enable Telnet, then 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, in mgmt-xmpp mode, disables or enables management over XMPP on the switch. 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

Example
  • These commands enable management over XMPP, then 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. In order for the switch to participate in a chat group, the switch has to be configured to belong to the specified chat room.

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 specified password. pwd_txt is a clear-text string.
    • password 0 pwd_txt name is protected by specified password. pwd_txt is a clear-text string.
    • password 7 pwd_txt name is protected by specified password. pwd_txt is encrypted string.

Guidelines

  • A switch group is an arbitrary grouping of switches within the network which belong 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 a full name of GROUPNAME@conference.DOMAIN
  • All CLI commands allow either the full group name or the short name, which are appended the @conference.DOMAIN
  • If the switch belongs to multiple chat rooms, you must configure each group with a separate command.
Examples
  • These commands configure the switch-group to be part of the chat room.
    switch(config)#management xmpp
switch(config-mgmt-xmpp)#switch-group 
testroom@conference.test.aristanetworks.com password 0 arista
  • Use the show xmpp switch-group to verify the active switch-group for the switch.
    switch# show xmpp switch-group
testroom@conference.test.aristanetworks.com

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 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 assigns 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 test1@test.aristanetworks.com 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 VRF configuration mode for the server. 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 is created in the default VRF.
    • vrf_name Instance is created in the specified user-defined VRF.

Related commands

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 is created in the default VRF.
    • vrf_name Instance is 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 be used to connect to the XMPP server and send messages to switches or switch groups within the network.

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

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 in that mode is not supported (e.g., into configuration mode)
  • An external XMPP client (for example Adium) can be used to 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 return 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 momentarily stop responding and disconnect. The switch should reconnect and the long command should complete.
  • Many command outputs display in a specific table format. To achieve the same visual feel as through a terminal, use a monospaced font, such as Courier, for the incoming messages.
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: test2@test.aristanetworks.com
--------------------------------------------------
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 is required to input their username (default is to USER@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 in that mode is not supported (e.g., into configuration mode)
  • An external XMPP client (for example Adium) can be used to 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 return 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 momentarily stop responding and disconnect. The switch should reconnect and the long command should complete.
  • Many command outputs display in a specific table format. To achieve the same visual feel as through a terminal, use a monospaced font, such as Courier, for the incoming messages.
Example
  • This command displays the status of ethernet 3 from test1, which is a member of the switch group chat room. 
    switch# xmpp session all@test.aristanetworks.com
xmpp-all# show int Eth3 status

response from: test1@test.aristanetworks.com

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

PortNameStatus Vlan DuplexSpeed Type
Et3 bs3 connectedin Po3 a-fulla-100010GBASE-SR
switch#