Dell Networking Open Automation Guide October 2015 Regulatory Model: Open Automation
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your computer. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. Copyright © 2015 Dell Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws.
Contents 1 About this Guide..................................................................................................10 Audience.............................................................................................................................................. 10 Supported Platforms and Required Dell Networking OS Versions................................................... 10 Conventions........................................................................................................
Using Preconfiguration Scripts..................................................................................................... 28 Using the Post-Configuration Script.................................................................................................. 29 Using Auto-Execution Script (Normal Mode Only)........................................................................... 29 Timers in Pre–configuration and Post–configuration Scripts.........................................................
6 Puppet.................................................................................................................. 68 Overview............................................................................................................................................. 68 Installing Puppet................................................................................................................................. 68 Prerequisites......................................................................
Managing Executed Scripts.......................................................................................................... 88 Viewing Script Information........................................................................................................... 90 Running a Script from the UNIX Shell................................................................................................ 90 Running Scripts with User Privileges....................................................................
Uninstalling VSN................................................................................................................................ 125 Viewing VSN Information..................................................................................................................125 10 Virtual Server Networking CLI..................................................................... 127 access.............................................................................................................
Static Route................................................................................................................................. 166 Weighted ECMP...........................................................................................................................166 Operational........................................................................................................................................ 167 BGP.......................................................................
13 Web Server with HTTP Support................................................................... 205 Starting the Web Server....................................................................................................................
1 About this Guide This document describes the components and uses of the Open Automation Framework designed to run on the Dell Networking operating system (OS).
Dell Networking Platform Minimum Operating Software S6000–ON 9.7(0.0) or later MXL 9.2(0.0) or later Z9500 9.5(0.1) or later (BMP, SmartScripts, and REST API only) C9010 9.9(0.0) or later Conventions To describe command syntax, this document uses the following conventions. Convention Description keyword Keywords are shown in a terminal font and are entered in the CLI as listed. parameter Parameters are shown in italics and require you enter a number or word in the CLI.
Dell Networking Platform S3048–ON S5000 S6000 S6000–ON MXL Switch Z9500 C9010 Dell Networking platform and OS 12 Related Documents • Installing the S4048–ON System • Dell Networking OS Command Line Reference guide for the S3048–ON System • Dell Networking OS Configuration Guide for the S3048–ON System • Installing the S3048–ON System • Dell Networking OS Command Line Reference guide for the S5000 System • Dell Networking OS Configuration Guide for the S5000 System • Installing the S50
Open Automation Framework 2 The Dell Networking S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000-ON, Z9500, and MXL platforms support the Open Automation framework. The Open Automation framework provides an open, industry standards-based automation technology that simplifies managing dynamic virtual data centers and reduces risk and overhead.
Figure 1. Open Automation Framework NOTE: The Open Automation framework is referred to as Open Automation in the rest of this document. Bare Metal Provisioning Bare metal provisioning (BMP) provides the following features.
The scripting environment (Expect, Perl, Python, Ruby, Tcl, UNIX and ZSH shell scripts) makes it easy for IT administrators to quickly develop scripts. Virtual Server Networking Virtual server networking (VSN) provides the following: • Automatic re-provisioning of virtual local area networks (VLANs) when you migrate virtual machines (VMs). • Support for multiple hypervisors, such as VMware and Citrix XenServer.
3 Bare Metal Provisioning Bare metal provisioning (BMP) is included as part of the Dell Networking OS image and is supported on the S4810, S4820T, S3048–ON, , S4048–ON, S5000, S6000, S6000-ON, Z9500, C9010, IOA, and MXL platforms. Introduction BMP improves operational efficiency to your system by automatically loading pre-defined configurations and Dell Networking OS images using standard protocols such as dynamic host configuration protocol (DHCP) and common file transfer mechanisms.
• Relay agent (optional) — an intermediary network device that passes messages between the DHCP clients and the DHCP server when the server is not on the same subnet. It can also provide IP addresses for multiple subnets. For more information, refer to Domain Name Server Settings and File Server Settings. Industrial Standard Upgrades with BMP Dell Networking OS follows the Industrial Standards with BMP. Following are the steps to perform the upgrade process: 1. Chassis Loads in BMP mode. 2.
NOTE: The configuration file maintains normal BMP functionality when a preconfiguration script is not sent. BMP Operations BMP is supported on the user ports and management ports of a switch.
address is not present in the start-up configuration file, no IP address is assigned to the management interface. • BMP mode (default) — the switch automatically configures all ports (management and user ports) as Layer 3 physical ports and acts as a DHCP client on the ports for a user-configured time (DHCP timeout). Set BMP mode using the (conf-reload-type)# boot-type bmp-reload command.
Normal Context To auto-configure a switch, before you use BMP mode, first configure a DHCP, DNS, and file server in the network. NOTE: By default, a syslog severity level greater than two does not display. Enable syslog before applying the preconfiguration script which helps identify any configuration errors. To help configure a new factory loaded switch, the switch boots up in the default BMP mode. You can reconfigure the switch to reload either in BMP mode or Normal mode.
mask, DHCP server IP, TFTP server address, DNS server IP, bootfile name, and configuration filename from the DHCP server. 5. If a DHCP offer has neither an image path nor a configuration file path, it is an invalid BMP DHCP offer and is ignored. The first DHCP offers the following to choose from: • IP address • Dell Networking OS image • Configuration file or preconfiguration script • IP address and Dell Networking OS image OR IP address and configuration file or preconfiguration script 6.
Dell Networking OS image MD5 Checksum Validation Successful. • c. 8. Erasing Sseries Primary Image, please wait If the versions match, the system downloads the configuration file or preconfiguration script. 00:03:07: %STKUNIT0-M:CP %BMP-2-BMP_DOWNLOAD_START: The config file download has started. 00:03:19: %STKUNIT0-M:CP %BMP-5-BMP_DWNLD_FILE_IS_SCRIPT_FILE: The downloaded file is a script file. 00:03:19: %STKUNIT0-M:CP %BMP-5-BMP_DWNLD_CONFIG_SCRIPT_SUCCESS: The config/script file download is successful.
00:03:22: %STKUNIT0-M:CP %BMP-2-BMP_SHA256_VALIDATE_FAILURE: The Config/Script SHA256 Checksum Validation Failed. BMP Mode: Boot and Set-UP Behavior When you configure a switch to reload in BMP mode, one of the following scenarios may occur.
NIL. 00:02:27: %STKUNIT0-M:CP %BMP-5-BMP_BOOT_OFFER: DHCP config file scp://anvltest:force10@13.4.4.1//tftpboot/basic-l3. 00:02:27: %STKUNIT0-M:CP %BMP-5-BMP_BOOT_OFFER: stacking info NIL 2. If you enabled the config-scr-download command, the system downloads the customer.conf configuration file from the file-server address. 3. If the configuration download is successful, the following logs display: file download has started.
00:02:55: %STKUNIT0-M:CP %BMP-5-BMP_RELEASE_HEADER_INFO: Downloaded Image Minor Version : 0 00:02:56: %STKUNIT0-M:CP %BMP-5-BMP_RELEASE_HEADER_INFO: Downloaded Image Main Version : 0 00:02:56: %STKUNIT0-M:CP %BMP-5-BMP_RELEASE_HEADER_INFO: Downloaded Image Patch Version : 1216 00:02:56: %STKUNIT0-M:CP %BMP-5-BMP_RELEASE_HEADER_INFO: Flash A Image Major Version : 1 00:02:56: %STKUNIT0-M:CP %BMP-5-BMP_RELEASE_HEADER_INFO: Flash A Image Minor Version : 0 00:02:56: %STKUNIT0-M:CP %BMP-5-BMP_RELEASE_HEADER_INFO:
After the preconfiguration script executes successfully, the startup configuration file loads. 00:04:30: %STKUNIT0-M:CP %BMP-5-BMP_PRE_CONFIG_SCRIPT_END: Pre-Config script completed with return status 0. 00:03:03: %STKUNIT0-M:CP %IFMGR-5-ASTATE_DN: Changed interface Admin state to down: Ma 0/0. 00:03:03: %STKUNIT0-M:CP %IFMGR-5-OSTATE_DN: Changed interface state to down: Ma 0/0. 00:03:03: %STKUNIT0-M:CP %SYS-5-CONFIG_LOAD: Loading configuration file.
• The remote ID is configurable between the switch MAC address, the hostname, or a custom string. To set the remote ID, enable the relay up-front in reload-type sub mode. If the relay is enabled, by default, the remote ID is set to MAC address. Software Upgrade Using BMP BMP simplifies switch configuration by allowing you to boot images and run configurations that are specified in a DHCP server and also by automatically downloading files from a file server.
NOTE: To display a properly formatted output string, Dell Networking recommends adding the following clido wrapper function at the beginning of TCLSH and EXPECT scripts: # Execute clido and return the output string proc Execclido {cmd_str} { set str [exec clido "$cmd_str"] set tmp_str [string map {\n \r\n} $str ] return $tmp_str } ... set out_str [Execclido "show version"] puts $out_str ...
5. The system receives an IP address via the DHCP server which it uses to get a Dell Networking OS image to boot, a configuration file (if supplied), and a preconfiguration script. 6. The system runs the preconfiguration script. • 7. 8. The default timer on the script is 10 minutes. The maximum amount of time the script can run is one hour. The preconfiguration script can access Dell Networking OS CLI commands through the clido utility.
00:00:15: %STKUNIT1-M:CP %CHMGR-5-STACKUNITDETECTED: Stack unit 1 present 00:01:02: %STKUNIT0-M:CP %BMP-5-AUTOEXEC_START: The AutoExec Script is Started. • After the script execution is successful, Dell Networking OS log displays: 00:04:05: %STKUNIT0-M:CP %BMP-5-AUTOEXEC_SUCCESS: The AutoExec Script execution returned Success.
00:32:16: %STKUNIT1-M:CP %CHMGR-5-RELOAD: User request to reload the chassis syncing disks... done unmounting file systems... unmounting /f10/flash (/dev/ld0h)... unmounting /usr/pkg (/dev/ld0g)... unmounting /usr (mfs:35)... unmounting /f10 (mfs:21)... unmounting /kern (kernfs)... unmounting / (/dev/md0a)... done rebooting .. .. .. Starting Dell Networking application 00:00:13: %STKUNIT1-M:CP %RAM-6-ELECTION_ROLE: Stack unit 1 is transitioning to Managementunit.
FIT-INDUS-1-0-0/SW/SRC System image file is "dt-maa-s4810-72" System Type: S4810Control Processor: Freescale QorIQ P2020 with 2147483648 bytes of memory. 128M bytes of boot flash memory. 1 52-port GE/TE/FG (SE)48 Ten GigabitEthernet/IEEE 802.3 interface(s) 4 Forty GigabitEthernet/IEEE 802.3 interface(s) Dell#Wed Jan 2 22:47:34 GMT 2013 this is Autoexec script The following line indicates the auto-execution script has completed successfully.
puts "Config File: $config_file downloaded successfully\r\n" } else { puts "ERROR: Config File: $config_file - Not Found\r\n" } if {[file exists $post_conf]} { puts "Post Config Script: $post_conf downloaded successfully\r\n" } else { puts "ERROR: Post Config Script: $post_conf - Not Found\r\n"} # Copy Config to Startup Config print_f10do "show version" after 5000 print_f10do "copy flash://$config_file startup-config" print_f10do "yes" after 5000 puts "Pre-Config Script Execution Successful !!!!!\r\n" exit
# Write the Result to Status File puts $fp "ERROR: LLDP is not configured\r\n" } # Configure Interfaces foreach intf_slot $interface_list_slot { set intf "TenGigabitEthernet $intf_slot" puts "Configuring $intf ...\n" puts $fp "Configuring $intf ...\n" print_f10do "configure terminal" print_f10do "interface $intf" print_f10do "no ip address" print_f10do "no shutdown" print_f10do "end" after 200 } # Wait for 2 mins for the Neighbor to come-up puts "Wait for 1 min for the Neighbor to come-up\r\n" after [expr {
# Configure FTP - Interface print_f10do "configure terminal" print_f10do "interface TenGigabitEthernet 0/22" print_f10do "ip address 20.0.0.34/16" print_f10do "no shutdown" print_f10do "end" puts "Uploading Status File($status_file) to $ftp_ip ...\n" spawn ftp "$ftp_ip" expect "Name .*: " send "lab\n" expect "Password:" send "lab\n" expect "ftp>" send "cd scripts\n" expect "ftp>" send "ls\n" expect "ftp>" send "put $status_file\n" expect "ftp>" send "ls\n" expect "ftp>" send "bye\n" expect eof print_f10do "
– Configuration File Name — the configurations applied to the system. The configuration filename is expected to use option 209. To configure the device by itself for a download configuration file, you can also create a preconfiguration script in option 209. – File Server Address — the server where the image and configurations files are placed. The address is assumed to be a TFTP address unless it is given as a URL.
Following is a configuration example of a DHCP server included on the most popular Linux distribution. The dhcpd.conf file shows that the MAC-based IP and configuration file assignment are fixed. option configfile code 209=text; option bootfile-name code 67=text; host HOST1{ #####MAC to IP mapping hardware ethernet 00:01:e8:8c:4d:0e; fixed-address 30.0.0.
Class-Based Configuration By matching a part of the string from the vendor class identifier option 60 string, the image, configuration file, or script file is sent in the DHCP offer. For example: host dt-maa-z9000-11 { hardware ethernet 00:01:e8:a9:81:a3; fixed-address 10.16.151.175; option tftp-server-address 10.16.151.209; match if substring (option vendor-class-identifier,0,17) = "TY=DELLNTW-Z9000 "; { filename "tftp://10.16.151.209/FTOS-ZB-9.3.0.0.bin"; option configfile "ftp://anvltest:force10@10.16.
File Server Settings Set up a file server and ensure connectivity. To allow file transfers to the switch, configure the file server that holds the boot and configuration files. The system recognizes HTTP, HTTPS, SFTP, TFTP, FTP, USB, and Flash URLs. For example: • tftp://server ip or name/filename • ftp://user:passwd@serverip or name//mypath/Dell-A.B.C.D.
MIB OID Value and Functionality 1.3.6.1.4.1.6027.3.2 String (Set the vendor-class identifier values up to a maximum of 60 characters) 3.1.6 1.3.6.1.4.1.6027.3.2 1 or 2 (Enable or Disable relay option) 3.1.7 1.3.6.1.4.1.6027.3.2 String (Set the mac/hostname/custom-string as remote-id option in DHCP offer 3.1.
Bare Metal Provisioning CLI 4 Bare metal provisioning commands are supported on the S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, Z9500, C9010, IOA, and MXL platforms. In a data center network, BMP automates configuring and updating the switches, ensuring standard configurations across the installed devices. To set up a single switch or a stack of switches with minimal effort, use the auto-configuration function.
Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command. Related Commands Version Description 9.9(0.0) Introduced on the C9010. 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.0P2) Introduced on the S3048–ON. 9.7(0.0) Introduced on the S4810, S4820T, S5000, S6000, S6000– ON, Z9000, Z9500, IOA, and MXL.
Version Description 9.7(0.0) Introduced on the S6000–ON. 9.6(0.0) Introduced on the S6000. 9.5(0.1) Introduced on the Z9500. 9.5(0.0) Introduced on the S4810, S4820T, S6000, Z9000, and MXL. Usage Information This command is applicable only when BMP is running and enables or disables the syslog messages (with a Severity level >2, critical). When BMP is not running, the following error message displays: % Error: bmp process is not running.
Related Commands Version Description 9.7(0.0) Introduced on the S4810, S4820T, S5000, S6000, S6000– ON, Z9000, Z9500, IOA, and MXL. • reload-type — allows you to configure the reload-type options in reload-type sub command mode. • show reload-type — displays the current Reload mode (BMP mode or Normal mode). config-scr-download Allows you to specify whether the configuration or script file needs to be downloaded.
Usage Information For an initial setup, the config-scr-download parameter of the reload-type command is enabled. After the configuration file successfully downloads, the config-scr-download parameter is automatically disabled. You can enable it again using the reload-type command. Related Commands • reload-type — allows you to configure the reload-type options in reload-type sub command mode. • show reload-type — displays the current Reload mode (BMP mode or Normal mode).
Related Commands • reload-type — allows you to configure the reload-type options in reload-type sub command mode. • show reload-type — displays the current Reload mode (BMP mode or Normal mode). relay Allows you to configure the addition of option 82 in DHCP client packets.
• show reload-type — displays the current Reload mode (BMP mode or Normal mode). reload conditional nvram-cfg-change After saving the BMP configuration, to perform a reload on the chassis due to configuration changes that changes the NVRAM content, use this command. S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, Z9500, C9010, and MXL Switch Syntax reload conditional nvram-cfg-change Defaults none Command Modes EXEC Command History This guide is platform-specific.
reload-type Allows you to configure the reload-type options in reload-type sub command mode. S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, Z9500, C9010, IOA, and MXL Syntax reload-type Defaults BMP Command Modes CONFIGURATION Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command.
• stop bmp — stops the BMP process and prevents a loop if the DHCP server is not found. retry-count Allows you to configure the number of retries for downloading the Dell Networking OS image and configuration file.
script post-config To run the post-configuration script after the preconfiguration script is executed during the BMP reload, ensure that this command is present in the startup-configuration. S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, Z9500, C9010, and MXL Syntax Parameters script post-config {script-name} scriptname Enter the name of the script to run after the BMP start-up configuration is applied.
Command Modes EXEC Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command. Version Description 9.9(0.0) Introduced on the C9010. 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.0P2) Introduced on the S3048–ON. 9.7(0.0) Introduced on the S6000–ON. 9.6(0.0) Introduced on the S5000. 9.5(0.
show config Displays the reload type options that are configured on the system. S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, Z9500, C9010, IOA, and MXL Switch Syntax show config Defaults none Command Modes RELOAD-TYPE CONFIGURATION Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command.
• retry-count — allows you to configure the number of retries for downloading the Dell Networking OS image and configuration file. • vendor-class-identifier — allows you to configure the optional vendor class identifier for DHCP option 60. show reload-type Displays the reload type currently configured on the system.
To display the current reload mode for BMP, use the show bootvar or show system brief commands. The show bootvar command includes the path of the Dell Networking OS image file retrieved from a DHCP server when BMP is running, but not after you exit BMP.
Version Description 9.2(0.0) Introduced on the Z9000, S4810, S4820T, and MXL switch. Replaces the stop jumpstart command. 9.1(0.0) Introduced on the Z9000 and S4810. Replaces the stop jumpstart command. Usage Information If the switch enters a loop while reloading in BMP mode, use the stop bmp command on a switch running BMP. A loop occurs when the switch is continuously trying to contact a DHCP server and a DHCP server is not found.
with Type, Hardware, Serial Number, Service Tag and OS Version. Defaults none Command Modes RELOAD-TYPE CONFIGURATION Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command. Related Commands Version Description 9.9(0.0) Introduced on the C9010. 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.
Command Modes EXEC Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command. Version Description 9.9(0.0) Introduced on the C9010. 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.0P2) Introduced on the S3048–ON. 9.7(0.0) Introduced on the IOA and S6000–ON. 9.6(0.0) Introduced on the S5000. 9.5(0.
Open Management Infrastructure 5 Dell Networking OS supports the Open Management Infrastructure (OMI) framework. OMI is supported on the S4810, S4820T, S3048–ON, S4048–ON, S6000, and Z9500 platforms. Overview OMI is an open source package which manages infrastructure components such as servers, storage, and networking. OMI supports the distributed management task force (DMTF) common information model (CIM) / web-based enterprise management (WBEM) standards.
• OMI-I-9.8.0.0.tar.gz for S6000 and Z9500. • OMI-I-9.8.0.0.tar.gz for S3048–ON and S4048–ON. • OMI-I-9.8.0.0.tar.gz for Z9100–ON. Prerequisites Before using OMI on the Dell Networking OS switch, configure the following: 1. Create a user, with the user privilege 15, where this user can configure the box from the management station through OMI. 2. Install the smartscript package. For detailed information, please refer to the Installing SmartScripting section of the Smart Scripting chapter. 3.
• client — show omi-client log • dsc — show dsc log • top — show the status from top • bottom — show the status from bottom • number of lines — specify the number of lines • client–test — test the OMI server using OMI client • install–cert — install the given SSL certificates to the OMI server • start — start the OMI server • stop — stop the OMI server NOTE: The script path is/usr/pkg/omi108/bin.
} 7. } } • PortId identifies the interface. This example configures tengigabitethernet 0/1. • EnabledState identifies the status of the port. In this example, “Enabled” brings up the port. In Powershell, create the Ethernet MOF using configuration block. MSFT_NetworkDevice_EthernetPortViewConfig -OutputPath c:\EthernetPortViewMof This configuration creates the MOF in the C:\EthernetPortViewMof directory. 8. Connect to OMI. $cred=Get-Credential -UserName:"admin" -Message:"Admin User?" 9.
AclType = 1; IsPolicyMapMatchCondition = True; SourceInfo = "C:\\ConfigFiles\ \MSFT_NetworkDevice_AclView_config.ps1::6::9::MSFT_NetworkDevice_AclView"; AclList = { $MSFT_NetworkDevice_AclEntry1ref }; ModuleName = "DSCModules"; ModuleVersion = "1.0"; }; instance of OMI_ConfigurationDocument { Version="1.0.
NetworkPrefix = 32; }; instance of MSFT_NetworkDevice_IpAddress as $MSFT_NetworkDevice_IpAddress3ref { IpAddressFamily = 1; IpAddress = "10.10.10.15"; NetworkPrefix = 32; }; instance of MSFT_NetworkDevice_BgpConfigurationView as $MSFT_NetworkDevice_BgpConfigurationView1ref { EnabledState =True; Id = "1-1-vrf-1"; ExtAsNumber = 1; Ensure = 0; ResourceID = "[MSFT_NetworkDevice_BgpConfigurationView]MyBgpConfiguration"; RouterId = $MSFT_NetworkDevice_IpAddress1ref; SourceInfo = "C:\\ConfigFiles\ \MSFT_NetworkDev
instance of MSFT_Credential as $MSFT_Credential1ref { Password = "force10"; UserName = "Any\\Any"; }; instance of MSFT_NetworkDevice_BgpPeerView as $MSFT_NetworkDevice_BgpPeerView1ref { Id = "1-vrf-1-1.2.3.4"; ResourceID = "[MSFT_NetworkDevice_BgpPeerView]MyBgpPeer"; SourceInfo = "C:\\ConfigFiles\ \MSFT_NetworkDevice_BgpPeerViewConfig.
Id Name PeerCredential AddressFamily VrfContext IsEnabled ActivateIPv6 AllowAsIn MultiHopTimeToLive RouteMapIn RouteMapOut Ensure KeyEncryptionMethod RemoteRouterId UpdateSourceInterface UpdateSourceInterfaceType ExtAsNumber PSComputerName : : : : : : : : : : : : : : : : : : 1-vrf1-1.2.3.
VrfContext IsEnabled ActivateIPv6 AllowAsIn MultiHopTimeToLive RouteMapIn RouteMapOut Ensure KeyEncryptionMethod RemoteRouterId UpdateSourceInterface UpdateSourceInterfaceType ExtAsNumber PSComputerName : : : : : : : : : : : : : : vrf-1 False True Id Name PeerCredential AddressFamily VrfContext IsEnabled ActivateIPv6 AllowAsIn MultiHopTimeToLive RouteMapIn RouteMapOut Ensure KeyEncryptionMethod RemoteRouterId UpdateSourceInterface UpdateSourceInterfaceType ExtAsNumber PSComputerName : : : : : : : : : :
! address-family ipv4 vrf vrf1 network 10.10.10.15/32 network 10.10.10.20/32 maximum-paths ebgp 3 redistribute static route-map rmap3 redistribute connected route-map rmap1 neighbor 1.2.3.4 remote-as 3 neighbor 1.2.3.4 description descr1 neighbor 1.2.3.4 allowas-in 3 neighbor 1.2.3.4 shutdown neighbor 2.3.4.5 remote-as 3 neighbor 2.3.4.5 shutdown neighbor 1::1 remote-as 3 neighbor 1::1 shutdown exit-address-family ! address-family ipv4 vrf vrf2 neighbor 1.2.3.4 remote-as 3 neighbor 1.2.3.
Puppet 6 Dell Networking OS supports the Puppet automation framework. Puppet Agent is supported on the S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, and Z9500 platforms. Overview Puppet is a configuration management utility, that defines the state of system, then automatically enforces the correct state. Puppet Agent is a daemon that runs on all the client servers.
2. Install the smartscript package. EXEC Privilege mode Dell#package install tftp://10.16.127.35/SMARTSCRIPTS-I-9.6.9.5.tar.gz 3. Install the puppet package. EXEC Privilege mode package install tftp://10.16.127.35/PUPPET-I-9.9.0.0.tar.gz NOTE: You must keep the clock of the chassis in sync with the Puppet master. The synchronization is done by the Network Transfer Protocol (NTP) server. Configuring the Puppet Agent To configure the Puppet Agent, use the following steps. 1. Enable the REST API.
Puppet Agent Configuration Scripts This section describes about the various Puppet Agent configuration scripts: puppet-config To configure or make changes to the agent’s parameters, use the puppet-config script. puppet-config [-d] option=value Following are the mandatory puppet configuration options: agentrestipaddr : IP address to be used for rest apis. The default IP address is 127.0.0.1. agentrestpasswd : Password of the user given in agentrestuser. agentrestport : Port number to be used for rest apis.
puppet-apply To apply any puppet manifest file, use the puppet-apply script.
} } LAG Configuration Apply the LAG configurations using both the Puppet Standalone and Puppet Agent. You can read and write the LAG configurations by using the netdev_lagtype. node dell_s4810_node1 { netdev_device { hostname: } netdev_lag { "name": ensure => (present | absent), active => (true | false), links => ('interface-name' | ['interface-name1', 'interfacename2' ...
Using the Puppet Facter Dell Networking OS supports the standalone tool called the Puppet Facter. This tool is based on Ruby and provides complete system information about the agent node to the puppet master. To apply the configurations using puppet, you must install the Puppet Facter tools on all the nodes. Following are the facts pair in the manifest files.
7 Smart Scripting Smart Scripting is supported on the S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, Z9500, C9010, and MXL switch platforms. Smart Scripting is not supported on the M IOA, FN IOA, and FN IOM platforms. Smart Scripting allows you to add functionality to Dell Networking switches without updating the Dell Networking OS release.
Smart Scripting supports running a script either from the Dell Networking OS CLI or directly from a UNIX shell. You can run scripts periodically, based on events, at boot up or after the switch is initialized. In addition, you can run scripts in the foreground or background and display the progress of a script. If required, you can cancel, stop, or resume scripts. Smart Scripting allows you to automate common management and maintenance tasks, such as: • Building visibility and/or discovery programs.
To download the SmartScript package to a dedicated location, use one of the following methods: TFTP, FTP, Flash, or NFSMount. The Smart Scripting package includes the following files and functionality: • Dell Smartscript Utilities supports Perl, Python, and Ruby APIs. • SQLlite database and Perl, Python, Ruby, TCL interface to SQLite. • NetSNMP client and Perl, Python, Ruby interface to the client. • Perl interpreter and associated files. • Python interpreter and associated files.
package install {flash://filename | ftp://userid:password@host-ipaddress/ dir-path | tftp:// host-ipaddress/dir-path | nfsmount://filepath} • flash://filename installs the Smart Scripting file stored in flash memory on the switch. • ftp://userid:password@host-ipaddress/filepath logs in and installs Smart Scripting from a file stored on an FTP server. • tftp://host-ipaddress/filepath installs Smart Scripting from a file stored on a TFTP server.
Table 1. DELL_TRGEVT_TYPE Event and Environment Variable Event DELL_TRGEVT_TYPE (Environment Variable) cpu-usage CPU log-event LOG EVENT mem-usage MEMORY time-event TIME EVENT 3. DELL_TRGEVT_LOGMSG — displays the log message that triggered the script. It prints a maximum of 256 characters. 4. DELL_TRGEVT_CPU — gets the CPU percentage that triggered the script. 5. DELL_TRGEVT_MEM — displays the memory usage that triggered the script.
clido To configure any command on the device directly without handling it via the telenet or ssh sessions, use the clido system command. Syntax: clido “CLI command” Example clido clido clido clido clido "configure terminal" "interface vlan 10" "no shutdown" "end" "show vlan" NOTE: clido maintains context upon execution in the system. To handle such cases, switch between different submodes wherever required for the needed configurations.
do show vlan show running | grep loopback dellsyslog A Dell proprietary utility which helps you in generating custom SYSLOGS with the configured severity. Syntax: dellsyslog [-s ] {syslog message} The severity level maps as follows: • 0 — emergency • 1 — alert • 2 — critical • 3 — error • 4 — warning • 5 — notify • 6 — infor • 7 — debug The default severity level is 6.
• DellCliConfig — If you need to configure the list of Dell Networking OS commands, you can make use of this API.
• Stores all the periodically collected data and/or statistics from the Dell Networking OS. • Stores the Dell Networking OS configuration files. • Stores other script logs, updated, deleted, and transferred using this database. Dell Networking OS provides Perl, Python, Ruby, and TCLSH interfaces for SQLite. As a result, you can create custom scripts to handle all the database information and operations.
System Attributes Value Description stack segment can be extended. The system automatically performs stack extension. coredumpsize unlimited Largest size (in bytes) of a core file that can be created. memory use 233,244 Maximum size (in bytes) to which a process’s resident set size may grow. This value imposes a limit on the amount of physical memory a process is given; if memory is tight, the system prefers to take memory from processes that are exceeding their declared resident set size.
UNIX Utility Function env Set and print environment. expr Evaluate expression. fc List the history of commands on the computer. fg Change the background process to the foreground process. file Determine the file type. find Walk a file hierarchy. ftp Internet file transfer program. getopts Called each time you process an argument. grep Print lines matching a pattern. hostname Set or print the name of the current host system. ifconfig Configure network interface parameters.
UNIX Utility Function vmstat Report virtual memory statistics. wait Await process completion. wc Word, line, and byte count. who Display the users who are currently logged in. Creating a User Name and Password for Smart Scripting Before you run a script from the Dell Networking OS CLI, you may want to configure an additional user name and password to use only to run scripts on a switch.
EXEC script get url 3. Remove a script from a switch. EXEC script remove {file_name file-name | all} Setting a Search Path for Scripts Create a path to the location where you stored the scripts. The Dell Networking OS uses this path when searching for the scripts. This way you do not have to specify a specific path when executing a script. • Set a search path for a script in the Dell Networking OS.
– Scheduled scripts can be unconfigured/stopped/killed/resumed only by the configured user (test) or higher privileged user. – In general, the Privilege level 15 (highest privilege user in Dell Networking OS CLI) user can configure/reconfigure the explicit username in script execute CLI. The following example shows how you can schedule the script named sample.zsh to start after one hour and 12 minutes from now and runs the script in the background: • Dell#script execute sample.
Following example shows how you can define the event to trigger a script even if any one of the pattern is matched: • Dell(conf)#script trigger-event Server_Reporter_Event log-event tag tag-orex "Major alarm" "Minor alarm" Schedule a script to run based on defined events. Schedule a script to provide mapping between the scripts and trigger-events.
002 CONF WATCH 003 EXEC Dell# Watch Blocked user2 Scheduled user2 args.pl args.pl hi The script status are determined as follows: • Scheduled — The script is scheduled to run. • Running — The script is currently running. • Stopped — The script is suspended. • Completed — The script run is successful and exits normally. • Watch Blocked — The script is monitored but terminates within ten minutes.
Viewing Script Information To view information on currently stored, scheduled, and running SmartScripts, use the following commands. • Display a list of stored files in the script path. To show the detail output of the file, enter detail. EXEC Privilege mode • show script file [detail] Display a list of scripts that are scheduled or running. To display the detailed status of the scripts, enter detail.
$ python createVlans.py 12 14 $ ./createVlans.sh 12 14 Running Scripts with User Privileges Use these scripts to administer any Expect, PERL, Python, Ruby, Tcl, UNIX and ZSH shell scripts stored on the switch from the Dell Networking OS CLI. To apply the associated read-write privileges while running a script from the Dell Networking OS CLI, specify an optional username (refer to XXXCreating a User Name and Password for Smart Scripting).
Smart Scripting CLI 8 Smart Scripting is supported on the S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, Z9500, C9010, and MXL platforms. Smart Scripting is not supported on the M IOA, FN IOA, and FN IOM platforms. disable Allows you to enable or disable the current event handler configuration. S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, Z9500, C9010, and MXL Syntax disable To reset the event handler, use the [no] disable command.
Parameters script-name Enter the name of the script to schedule for execution. arguments arg [..args] Enter the keyword arguments then the arguments to script. The maximum length is 64 characters. The arguments can be any number of words within quotes and separated by a space. Defaults none Command Modes SCRIPT EVENT HANDLER CONFIGURATION Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide.
Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command. Usage Information Related Commands Version Description 9.9(0.0) Introduced on the C9010. 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.0P2) Introduced on the S3048–ON. 9.7(0.0) Introduced on the S6000–ON. 9.6(0.0) Introduced on the S5000. 9.5(0.
• From an NFS mount server: nfsmount://filepath Defaults none Command Modes EXEC Privilege Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command. Version Description 9.9(0.0) Introduced on the C9010. 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.0P2) Introduced on the S3048–ON. 9.7(0.
Defaults none Command Modes EXEC Privilege Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command. Version Description 9.9(0.0) Introduced on the C9010. 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.0P2) Introduced on the S3048–ON. 9.7(0.0) Introduced on the S6000–ON. 9.6(0.0) Introduced on the S5000. 9.
Parameters username name (Optional) Enter the user name with read-write privileges. A username cannot contain special characters. script-name Enter the name of the script to run, including the directory path and filename; for example: scriptparameter • Perl script: /usr/pkg/scripts/sample_scripts/ cmd-server.pl • Python script: /usr/pkg/scripts/sample_scripts/ DisplayAlarms.py • Ruby script: /usr/pkg/ss-scripts/ interface_monitor.rb • UNIX shell script: /usr/pkg/home/admin/test.
Usage Information To run more than one script at the same time, use the script (run) command multiple times; for example: Dell(conf)#script username root /usr/pkg/scripts/ sample_scripts/ DisplayAlarms.py Dell(conf)#script username root /usr/pkg/bin/python /usr/pkg/ scripts/ VSNAgent/Xen/hpAgtMain.py When you run a script from the Dell Networking OS CLI with the script (run) command, you can specify an optional user name to apply the read-write privileges assigned to the user name when the script runs.
job-id Enter the keywords job-id then the job identifier of the specific job stop, resume, clear, kill, or unschedule. all Enter the keyword all to stop, resume, clear, kill or unschedule all scripts. Defaults none Command Modes EXEC Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command.
Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command. Version Description 9.9(0.0) Introduced on the C9010. 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.0P2) Introduced on the S3048–ON. 9.7(0.0) Introduced on the S4810, S4820T, S5000, S6000, S6000– ON, Z9000, Z9500, and MXL.
bg Enter the keyword bg to schedule scripts to run in the background. arguments arg [..args] Enter the keyword arguments then the arguments to script. The maximum length is 64 characters. The arguments can be any number of words within quotes and separated by a space. username username Enter the keyword username to use when the script runs. The maximum length is 16 characters. The default username is the user configuring the CLI. bg Enter the keyword bg to schedule scripts to run in the background.
This example illustrates that the script execution starts at 22:22 10/30/14 (MM/DD/YY) and stops after 1 hour and the script runs in the background. script execute (CONFIGURATION mode) Schedule the scripts to run across reloads. S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, Z9500, C9010, and MXL Syntax script execute script-name [start {at date-time | after time}] [stop {at date-time | after time}] [watch] [arguments arg[..
username username (Optional) Enter the username to use when the script runs. The maximum length is 16 characters. The default username is the user configuring the CLI. Defaults The script runs in the background. Command Modes CONFIGURATION Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command.
script get Copy a script to a switch. S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, Z9500, C9010, and MXL Syntax Parameters script get url url Enter the keyword url then the URL location of the script to download to a switch. Defaults none Command Modes EXEC Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide.
NOTE: For stack systems, the script from ss-scripts synchronizes across the stack for every one hour. When the stack forms first, the script synchronization from the master to members happens only after 10 minutes. script path Configure the path for the script on the switch. S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, Z9500, C9010, and MXL Syntax script path path-name To remove the path for the script, use the no script path command.
Related Commands mount nfs — sets up the folders in the NFS-mounted directory. script remove Remove a script from a switch. S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, Z9500, C9010, and MXL Syntax Parameters script remove {file-name | all} file-name Enter the filename of the script to remove from the switch. all Enter the keywords all to remove all files from the dedicated folder on the switch. Defaults none Command Modes EXEC Command History This guide is platform-specific.
script trigger-event Configure the event that causes the script to run.
time-event stop at datetime Enter the keyword stop at then the time and date either in HH:MM — MM/DD/YY format to stop the trigger event at the specified time and date or in HH:MM format to begin the trigger event at the specified time on the same day (if the mentioned time is elapsed, the event runs on the next day HH:MM mentioned). The date must be a future date.
Version Description 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.0P2) Introduced on the S3048–ON. 9.7(0.0) Introduced on the S4810, S4820T, S5000, S6000, S6000– ON, Z9000, Z9500, and MXL. 9.6(0.0) Introduced on the S5000. 9.5(0.1) Introduced on the Z9500. 9.3(0.0) Introduced on the S6000. 9.2(0.0) Introduced on the S4810, S4820T, Z9000, and MXL Switch. Usage Information The maximum number of events you can configure is 20.
Following example shows the cpu-usage limit. Dell(conf)# script trigger-event event1 cpu-usage 30 Following example shows how the event triggers on every month first Sunday. script trigger-event Event2 time-event weekday sun month jan,feb,mar,apr,may,jun,jul,aug,sep,oct,nov,dec mothday 1-7 Following example shows how the event triggers at the end of every quarter.
Version Description 9.2(0.0) Introduced on the MXL Switch. 9.0.2.0 Introduced on the S6000. 9.0.0.0 Introduced on the Z9000. 8.3.19.0 Introduced on the S4820T. 8.3.8.0 Introduced on the S4810. Usage Information In a stack setup, the Dell Networking OS automatically synchronizes the software version installed on the master stack unit with the other switches in the stack. To view the installed software versions on the stack units, use the show packages system command.
-----------------------------------Unit Package Name Version Status ------------------------------------0 SMARTSCRIPTS 2.9.9.2 Installed nano 2.2.6nb1 Installing 1 SMARTSCRIPTS 2.9.9.2 Installing nano 2.2.6nb1 Installing 2 not present 3 not present 4 not present 5 not present 6 not present 7 not present 8 not present 9 not present 10 not present 11 not present show script Display the stored, scheduled, and running scripts.
Version Description 9.9(0.0) Introduced on the C9010. 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.0P2) Introduced on the S3048–ON. 9.7(0.0) Introduced on the S6000–ON. 9.6(0.0) Introduced on the S6000. 9.5(0.1) Introduced on the Z9500. 9.3(0.0) Introduced on the S6000. 9.2(0.0) Introduced on the S4810, S4820T, Z9000, and MXL switch. start shell Start a NetBSD UNIX shell.
Usage Information To invoke the Dell Networking OS operations, start an NetBSD shell on a switch before you can enter UNIX commands or run a script directly from the shell (see Running a Script from the UNIX Shell). After you start a shell, you are prompted to enter a username and password. Related Commands show packages — displays all the Open Automation packages installed on the switch. triggered-by Allows you to associate the events to a script in Event Handler Configuration mode.
To return to the default value, use the no switch script limit command. Parameters cpu percentage Enter the keyword cpu and the maximum percentage limit for the script execution. The range is from 20 to 90 percent. mem percentage Enter the keyword mem and the maximum percentage limit for the script execution. The range is from 20 to 90 percent. disk percentage Enter the keyword disk and the maximum percentage limit for the script execution. The range is from 20 to 90 percent.
Parameters username username Enter the keyword username then the name of the user to access the script. The maximum length is 16 characters. The default username is the user configuring the CLI. privilege privilege Enter the keyword privilege then the privilege level to run the scripts. The range is from 1 to 15. Defaults none Command Modes SCRIPT EVENT HANDLER CONFIGURATION Command History This guide is platform-specific.
To remove the username and password, use the no username command. Parameters name Enter a username to access the UNIX shell. The length of the username can be up to 16 characters to satisfy the BSD UNIX login requirements. A username running the scripts cannot contain any special characters. password password Enter a password to access the UNIX shell. Defaults none Command Modes CONFIGURATION Command History This guide is platform-specific.
9 Virtual Server Networking Virtual server networking (VSN) is supported on the S4810, S4820T, S5000, and MXL switch platforms. As a part of the Open Automation package, VSN provides real-time communication between the Dell Network fabric and the virtual servers to automate network management and configuration tasks throughout the data center.
Figure 2. Virtual Server Networking Example For any change, VSN subscribes use hypervisor to notify the switch. Depending on the hypervisor mode you configure, the Dell Networking OS may automatically update its configuration, provide provisioning for configuration changes, or require system administrator intervention. Hypervisor Modes There are two modes for retrieving configuration information from a hypervisor on a virtual server: check and config.
VLAN Configurations The following sections describe management, data, and hypervisor-unaware VLANs. Install VSN You install VSN as a separate Open Automation package, apart from the Dell Networking OS image and the downloaded Smart Scripting package. When you install the VSN package, VSN is loaded into the Dell Networking OS. NOTE: VSN is only supported on standalone switches; it is not supported in stacked configurations.
7. • ftp://userid:password@host-ipaddress/filepath logs in and installs VSN from a file stored on an FTP server. • tftp://host-ipaddress/filepath installs VSN from a file stored on a TFTP server. • nfsmount://filepath copies from a file stored on an NFS mount file system. Enter the following command to configure the Perl script (VSNAgent.pl) used for VSN operations on VMware hypervisors: script /usr/pkg/scripts/VSNAgent/VMWare/VSNAgent.pl.
Where url is one of the following values: 5. • For a VMware hypervisor: https://[ip-address]/sdk/vimService username [name] password [password] • For an Xen hypervisor: http://ip-address username [name] password [password] • username name: Username to use for authentication on the server. • password password: Password to use for authentication shown in clear text. Set the mode for retrieving virtual server configurations and updating Dell Networking OS settings on the switch.
• Enter the shutdown and no shutdown commands on a VSN-enabled port. The discovery process resumes on the individual port only, not on all enabled ports. • Enter the disable and no disable commands in Hypervisor Configuration mode, for a specified type of hypervisor connection. The discovery process resumes on all enabled ports. • An update arrives from a hypervisor. The discovery process resumes on all VSN-enabled ports.
• For Citrix Xen hypervisors, the Python script is stored is at /usr/pkg/scripts/VSNAgent/Xen/ hpAgtMain.py CAUTION: The Dell Open Automation Virtual Server Networking™ software package (the “Product”) may contain the VMware SDK for Perl, which is licensed by VMware, Inc. VMware will not provide technical support for the VMware SDK included in the Product. Users interested in writing scripts for VMware products must obtain the VMware SDK directly from VMware.
Uninstalling VSN Uninstalling the VSN package removes it from the internal flash memory on a switch. CAUTION: Before you uninstall the VSN package, first stop all VSN scripts that are currently running using the no script script-name command. • Uninstall the VSN package from the system. EXEC Privilege mode package uninstall name Enter the name of the VSN package exactly as it appears in show packages output.
Example of the show hypervisor supported command. Dell#show hypervisor supported vmware xen-citrix Example of the show virtualswitch all hypervisor sessions command. Dell#show Interface Gi 0/32 Po 7 virtualswitch VSwitch Hypervisor vSwitch3 VMWare_vmware207 vSwitch1 VMWare_vmware206 Example of the show virtualswitch specified hypervisor sessions command. Dell#show virtualswitch GigabitEthernet 0/32 vSwitch3 Interface :Gi 0/32 Hypervisor Type :vmware Hypervisor Name :vmware207 Hypervisor Version :4.1.
Virtual Server Networking CLI 10 The virtual server networking CLI is supported on the S4810, S4820T, S5000, and MXL switch platforms. NOTE: VSN is only supported on standalone switches; it is not supported in stacked configurations. access Configure the connection to access a hypervisor. S4810, S4820T, S5000, and MXL Switch Syntax Parameters [no] access url username name password password url Enter the URL location of the desired hypervisor.
Version Description 8.3.8.0 Introduced on the S4810. Usage Information VSN tries to establish a connection with a hypervisor only after you configure the user credentials (username and password) with the access command. disable Stop a hypervisor session. S4810, S4820T, S5000, and MXL Switch Syntax [no] disable Defaults Disable Command Modes HYPERVISOR Command History This guide is platform-specific.
Parameters name Enter up to 40 characters to specify the name of a hypervisor session to which you want to connect on network servers. Defaults none Command Modes HYPERVISOR Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command. Version Description 9.6(0.0) Introduced on the S5000. 9.2(0.
Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command. Version Description 9.6(0.0) Introduced on the S5000. 9.2(0.0) Introduced on the MXL. 8.3.19.0 Introduced on the S4820T. 8.3.8.0 Introduced on the S4810.
Defaults none Command Modes EXEC Privilege Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command. Version Description 9.6(0.0) Introduced on the S5000 switch. 9.2(0.0) Introduced on the MXL switch. 8.3.19.0 Introduced on the S4820T. 8.3.8.0 Introduced on the S4810.
Version Description 8.3.8.0 Introduced on the S4810. Usage Information Uninstalling the VSN package removes it from the internal flash memory on the switch. To follow the progress when removing a package from the system, enter the show packages command. NOTE: Before you uninstall the VSN package, first stop all scripts that are currently running using the no script script-name command. Related Commands show packages — displays all the packages installed in the system.
For Xen Citrix hypervisors, the hpAgtMain.py Python script is stored in the /usr/ pkg/ scripts/VSNAgent/Xen directory. show hypervisor supported Displays the types of Hypervisors VSN currently supports. S4810, S4820T, S5000, and MXL Switch Syntax show hypervisor supported Defaults none Command Modes EXEC Privilege Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide.
Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command. Example Version Description 9.6(0.0) Introduced on the S5000. 9.2(0.0) Introduced on the MXL switch. 8.3.19.0 Introduced on the S4820T. 8.3.8.0 Introduced on the S4810.
Python 2.6.5 XenAPI Perl 5.8.8 VIPerlToolkit 4.1 VSNAgent Scripts **************************************** show virtualswitch Displays the components of current Hypervisor sessions, including the virtual switch and name of the Hypervisor session to which a switch interface is connected. S4810, S4820T, S5000, and MXL Switch Syntax Parameters show virtualswitch [interface] [virtualswitch-name] interface virtualswitchname Display information on the Hypervisor session established on a specified interface.
Usage Information To display the interface, virtual-switch name, and Hypervisor-session name for all current Hypervisor connections on the switch, use the show virtualswitch command. To display detailed information about a Hypervisor session, re-enter the command with the interface and virtual-switch name for the session from the show virtualswitch output as shown in the following example.
Parameters interface Display information on the Hypervisor session established on a specified interface. Enter one of the following interface types: • For a 100/1000 Ethernet interface or 1-Gigabit Ethernet interface, enter GigabitEthernet slot/port. • For a 10-Gigabit Ethernet interface, enter TenGigabitEthernet slot/port. • For a port-channel interface, enter port-channel number. Valid port-channel numbers are from 1 to 128.
type Set the hypervisor type to which you want to connect. S4810, S4820T, S5000, and MXL Switch Syntax Parameters [no] type {vmware | xen-citrix} vmware Set the hypervisor type as VMware. xen-citrix Set the hypervisor type as Xen-Citrix. Defaults none Command Modes HYPERVISOR Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide.
Version Description 9.6(0.0) Introduced on the S5000. 9.2(0.0) Introduced on the MXL switch. 8.3.19.0 Introduced on the S4820T. 8.3.8.0 Introduced on the S4810. Usage Information Enter the vsn enable command only on Hypervisor-facing interfaces. DO NOT enter this command on an interface used for inter-switch links. Enter the no vsn enable command to remove the VSN configuration from the system. To re-enable a Hypervisor session, reconfigure VSN.
REST API 11 Representational state transfer (REST) application programming interface (API) is an integrated part of the Dell Networking operating system (OS) and is supported on the S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, and Z9500 platforms. HTTP and HTTPS Use REST API to configure and monitor a Dell Networking switch over the hyper text transfer protocol (HTTP) and hyper text transfer protocol secure (HTTPS).
levels 2 through 15 have read-write access in REST API. The allowed methods are GET, PATCH, PUT, POST, and DELETE. For information about the privilege level command, see the Dell Networking OS Command Line Reference Guide, Security chapter. Request Query Parameters Following are the various request query parameters supported on REST. • deep — Retrieves a resource with all the subresources inline. • shallow — Retrieves a resource with no subresources inline.
* Server auth using Basic with user 'admin' > PUT /api/running/dell/interfaces/interface/tengig-1-37 HTTP/1.1 > Authorization: Basic YWRtaW46YWRtaW4= > User-Agent: curl/7.15.5 (i686-redhat-linux-gnu) libcurl/7.15.5 OpenSSL/0.9.8b zlib/1.2.3 libidn/0.6.5 > Host: 10.16.151.159:8008 > Accept: */* > Content-Length: 171 > Expect: 100-continue > < HTTP/1.1 100 Continue < Server: ConfD/5.2 < Allow: GET, POST, OPTIONS, HEAD < Content-Length: 0 < HTTP/1.1 204 No Content < Server: ConfD/5.
11.1.1.2 200 false false The following configuration depicts the BGP configurations for router through the POST request: curl -v -u admin:admin http://10.16.151.159:8008/api/running/dell/router -X POST -T BGP_HTTP_REST_POST_PDU.xml * About to connect() to 10.16.151.159 port 8008 * Trying 10.16.151.159... connected * Connected to 10.16.151.159 (10.16.151.
1 1 false 11.1.1.2 * Connection #0 to host 10.16.151.159 left intact * Closing connection #0 The following configuration depicts adding another BGP peer to the configuration via REST– PATCH request: cat BGP_HTTP_REST_PATCH_PDU.xml 100 11.1.1.
Following is the current configurations applied on the system: Dell#show config ! router bgp 100 neighbor 11.1.1.2 neighbor 11.1.1.2 neighbor 11.1.1.3 neighbor 11.1.1.3 Dell# remote-as 200 no shutdown remote-as 200 no shutdown The following configuration retrieves the BGPrunning-config via REST API: curl -u admin:admin http://10.16.151.159:8008/api/running/dell/router/bgp\?deep PAGE 146100 1860238788none active
* Connection #0 to host 10.16.151.159 left intact * Closing connection #0 HTTP Status Error Codes The REST API server returns the following HTTP status error codes.
• Logical interface • BGP • Infrastructure • Miscellaneous Each node is printed as: . • is one of the following: – + for current – x for deprecated – o for obsolete • is one of the following: – rw for configuration data – ro for non-configuration data – -x for rpcs – -n for notifications • is the name of the node. – () refers that the node is a choice node – :() refers that the node is a case node – -x for rpcs.
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 148 +--rw bgp [as-name] +--rw as-name dell:as-number +--rw bgp | +--rw asnotation? enumeration | +--rw always-compare-med? boolean | +--rw bestpath? | | +--rw as-path? enumeration | | +--rw med? | | | +--rw confed? boolean | | | +--rw missing-as-best? boolean | | +--rw router-id-ignore? boolean | +--rw client-to-client? | | +--rw reflection? boolean | +--rw cluster-id? union | +-
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | REST API | | +--rw ttl? uint8 | +--rw fall-over? boolean | +--rw send-community? | | +--rw community-type? enumeration | +--rw shutdown? boolean | +--rw update-source-loopback? uint16 | +--rw weight? uint16 | +--rw timers? | | +--rw keepalive? dell:seconds | | +--rw hold-time? dell:seconds | +--rw add-path? | | +--rw addpath? enumeration | | +--rw path-count? uint8 | +--rw local-
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 150 | | +--rw as-number? dell:as-number | | +--rw no-prepend? boolean | +--rw password? | | +--rw encryption-type? enumeration | | +--rw password-value? string | +--rw activate? boolean | +--rw advertisement-interval? dell:seconds | +--rw allowas-in? uint8 | +--rw default-originate? | | +--rw route-map? dell:route-map-name | +--rw distribute-list [direction] | | +--rw direction d
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | REST API +--rw bgp? | +--rw asnotation? enumeration | +--rw always-compare-med? boolean | +--rw bestpath? | | +--rw as-path? enumeration | | +--rw med? | | | +--rw confed? boolean | | | +--rw missing-as-best? boolean | | +--rw router-id-ignore? boolean | +--rw client-to-client? | | +--rw reflection? boolean | +--rw cluster-id? union | +--rw confederation? | | +--rw identifier? de
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 152 | +--rw static? | | +--rw route-map? dell:route-map-name | +--rw imported-bgp? | | +--rw route-map? dell:route-map-name | +--rw ospf [process-id] | | +--rw process-id uint16 | | +--rw match? | | | +--rw external1? boolean | | | +--rw external2? boolean | | | +--rw internal? boolean | | +--rw route-map? dell:route-map-name | +--rw isis [tag] | +--rw tag string | +--rw level? e
| | +--rw remove-private-as? boolean | | +--rw route-map [direction] | | | +--rw direction dell:bgp-opt-dir | | | +--rw name? dell:route-map-name | | +--rw route-reflector-client? boolean | | +--rw sender-side-loop-detection? boolean | | +--rw soft-reconfiguration? enumeration | | +--rw dmzlink-bw? boolean | +--rw neighbor [ip-address] | +--rw ip-address union | +--rw peer-group-name? dell:peer-group-name | +--rw remote-as? dell:as-number | +--rw description? string | +--rw ebgp-multihop? | | +--rw ttl? uin
Global Configuration The following definition displays the global configuration entries: Module: SYSTEM URI: /api/running/dell/system Methods Supported: GET, POST, PUT, PATCH, and DELETE Global Configuration Model +--rw dell +--rw system | +--rw hostname? string | +--rw banner? | | +--rw login? string | +--rw credentials? | | +--rw username? string | | +--rw password? string | | +--rw privilege? uint32 | +--rw default-vlan? | | +--rw vlan-id? vlan-id-num | +--rw ip | +--rw dhcp? | | +--rw server? bool
IP Prefix-List The following definition configures and displays the properties of ip prefix-list.
| | | +--rw destination-mask dell:ipv4-mask-or-prefix | | +--:(host) | | +--rw destination-host? dell:ipv4-host | +--rw dscp? uint32 | +--rw ecn? uint32 | +--rw fragments? boolean +--rw acl-filters-qos +--rw filter-type? dell:acl-rule-types +--rw protocol dell:ipv4-protocols-qos IPv6 ACL The following definition configures and displays the properties of IPv6 ACL.
Methods Supported: GET, POST, PUT, PATCH, and DELETE NOTE: The POST and DELETE operations are not supported on Physical Interfaces. Use the following formats for various interface types: 1. Physical Interface:-- • The can be TenGigabitEthernet or FortyGigabitEthernet. • Example: tengig-0–0, fortygig-0–48 • Management: mgmt-- Example: mgmt-5–0 2. Logical Interface: - • The can be vlan, port-channel, loopback, or management.
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 158 | | +--:(non-sticky) | | +--rw dynamic? boolean | | +--rw station-move? boolean | +--rw learn-limit-violation? | | +--rw (action)? | | +--:(log) | | | +--rw log boolean | | +--:(shutdown) | | +--rw shutdown boolean | +--rw station-move-violation? | +--rw (action)? | +--:(log) | | +--rw log boolean | +--:(shutdown-both) | | +--rw shutdown-both boolean | +--:(shutdown-offending)
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | REST API | | | | +--:(hostname) | | | | | +--rw hostname? boolean | | | | +--:(mac) | | | | | +--rw mac? boolean | | | | +--:(user-string) | | | | +--rw user-string? string | | | +--rw vendor-class-identifier? | | | +--rw distinct-string? string | | +--rw secondary [address] | | +--rw address dell:ipv4-address-with-prefix | +--rw access-group? | | +--rw in? | | | +--rw acl-name a
| | | | | | | | | | | | | | | | | | | | | +--rw reachable-time? | +--rw retrans-timer? | +--rw suppress-ra? +--rw access-group? +--rw in? | +--rw WORD | +--rw implicit-permit? | +--rw (ipv6-action)? | +--:(vlan) | | +--rw vlan* | +--:(optimized) | +--rw optimized? +--rw out? +--rw WORD +--rw implicit-permit? +--rw (ipv6-action)? +--:(vlan) | +--rw vlan* +--:(optimized) +--rw optimized? uint32 uint32 boolean access-list-name boolean vlan-range boolean access-list-name boolean vlan-range boolean IPv6 Globa
+--rw prefix-min-len? +--rw prefix-max-len? uint32 uint32 IP Tunneling The following definition configures and displays the properties of IP tunneling.
| +--rw unnumbered? dell:interface-name +--rw ipv6? | +--rw address [ipv6-address] | | +--rw ipv6-address dell:ipv6-address | +--rw nd? | | +--rw dad? | | | +--rw attempts? uint32 | | +--rw hop-limit? uint32 | | +--rw managed-config-flag? boolean | | +--rw ra-interval? | | | +--rw max-ra-interval uint32 | | | +--rw min-ra-interval uint32 | | +--rw mtu? uint32 | | +--rw dhcp-non-address? boolean | | +--rw prefix [prefix-name] | | | +--rw prefix-name dell:ipv6-nd-prefix-name | | | +--rw advertise? boolean | |
| +--rw (destination-address) | | +--:(destination) | | | +--rw destination? | | | +--rw destination-mask | | +--:(host) | | +--rw destination-host? | +--rw encapsulation-type? | +--rw encapsulation-operator? | +--rw encapsulation-protocol? +--rw acl-filters-qos +--rw filter-type? +--rw protocol dell:mac-address-any dell:mac-address dell:mac-address dell:mac-acl-encap-types dell:mac-acl-encap-operators uint32 dell:acl-rule-types dell:mac-protocols-qos Management Route The following definition configures a
types types 164 | +--rw track-num? uint32 | +--rw protocol ip-protocols-type | +--rw source ipv4-address-any | +--rw source-mask dell:ipv4-mask-or-prefix | +--rw destination ipv4-address-any | +--rw destination-mask dell:ipv4-mask-or-prefix | +--rw tcp-options* enumeration | +--rw tcp-udp-port-oper-list [port-type] | +--rw port-type tcp-udp-port-type | +--rw oper-type tcp-udp-port-oper-type | +--rw port uint32 | +--rw start-port uint32 | +--rw end-port uint32 +--rw ipv6 +--ro stats +--ro access-list +--r
+--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro urg? count-type? egress-count-value? ingress-count-value? log? monitor? order? dscp? ecn? fragments? boolean acl-rule-count-types uint32 uint32 boolean boolean uint32 uint32 uint32 boolean Port Mirroring The following definition is for configuring and displaying the properties of port mirroring: Module: Port Mirroring URI: /api/running/dell/monitor-session Methods Supported: GET, POST, PUT, PATCH, and DELETE Port Mirroring Configuration Mo
Route Map Configuration Model +--rw route-map* [map-name seq] +--rw map-name string +--rw map-attr string +--rw seq union | +--:(action) | | +--rw permit? string | | +--rw deny? string +--rw set +--rw ext-community! +--rw bandwidth? uint32 Static Route The following definition configures and displays the properties of a Static Route configuration: Module: IP STATIC ROUTE URI: /api/running/dell/ip/route Methods Supported: GET, POST, PUT, PATCH, and DELETE Static Route Configuration Model +--rw ip +--r
Operational This section describes the properties of all the IPv4 operational data.
| +--ro status-code? enumeration | +--ro best-route? snmpv2-tc:TruthValue | +--ro link-bandwidth? string +--ro received-routes +--ro prefix-list* [network-prefix network-prefix-len nexthop-address seq-num] +--ro network-prefix inet:ip-address +--ro network-prefix-len inetaddress:InetAddressPrefixLength +--ro next-hop-address inet:ip-address +--ro seq-num uint32 +--ro metric? uint32 +--ro local-pref? uint32 +--ro weight? uint32 +--ro next-hop-cost-index? uint32 +--ro as-path-string? string +--ro path-source?
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | REST API +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +
with-prefix with-prefix with-prefix 170 | | | | | | | | | | | | | | | | | | | | | | +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro accept-prefix? advertised-prefix? prefix-denied? addr-withdrawn-from-peer? addr-withdrawn-by-peer? martian-addr-ignored? restart-time-adver-peer? restart-time-rece-peer? stale-path-time-config-peer? graceful-restart-role-recv-only? graceful-restart-role-adver-only? restart-time-adv? restart
prefix REST API | | +--ro routes-withdrawn? uint32 | | +--ro router-id? dell:ipv6-address-with-prefix | +--ro neighbor [neighbor-address] | +--ro neighbor-address dell:ipv6-address-with-prefix | +--ro remote-as? string | +--ro msg-rcvd? uint32 | +--ro msg-sent? uint32 | +--ro table-version? uint32 | +--ro in-queue? string | +--ro out-queue? string | +--ro up-time? string | +--ro state-prefix? string +--ro unicast | +--ro local-rib | | +--ro routes-added? uint32 | | +--ro routes-replaced? uint32 | | +--ro
prefix prefix prefix 172 | | | | | | | | | | | | +--ro input | +--ro local-as? boolean | +--ro no-advertise? boolean | +--ro no-export? boolean | +--ro community-number? string +--ro output +--ro community +--ro local-rib | +--ro routes-added? uint32 | +--ro routes-replaced? uint32 | +--ro routes-withdrawn? uint32 | +--ro router-id? dell:ipv6-address-with- | +--ro prefix-list [network-prefix next-hop-addr] | +--ro network-prefix dell:ipv6-address-with-prefix | +--ro next-hop-addr dell:ipv6-address-wit
prefix prefix prefix REST API | +--ro path-source? bgp-path-source | +--ro metric? string | +--ro local-pref? string | +--ro weight? uint32 | +--ro as-path-string? string | +--ro origin-code? bgp-origin-code +---x cluster-list | +--ro input | | +--ro cluster-list-id? bgp-list-name | +--ro output | +--ro cluster-list [cluster-list-id] | +--ro cluster-list-id bgp-list-name | +--ro local-rib | | +--ro routes-added? uint32 | | +--ro routes-replaced? uint32 | | +--ro routes-withdrawn? uint32 | | +--ro router
+--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro status-code? best-route? flaps? duration? reuse? as-path? path-source? origin-code? bgpv6-status-code boolean uint8 hour-minute-second hour-minute-second string bgp-path-source bgp-origin-code Interface Use the following definition to get the static IPv4 operational data: Module: STATS URI: /api/operational/dell/stats Methods Supported: GET Interface Model for IPv4 +--ro stats +--ro interfaces* [name] +--ro name dell:interface-name +--ro description?
| +--ro address dell:ipv6-address-with-prefix +--ro secondary-ip-address* [address] | +--ro address dell:ipv4-address-with-prefix +--ro line-speed? enumeration +--ro ip-mtu? uint32 +--ro arp-type? enumeration +--ro arp-timeout? uint32 +--ro last-clear-intf-cnters? uint32 +--ro last-intf-status-changed? uint32 +--ro in-octets? yang:counter64 +--ro in-unicast-pkts? yang:counter64 +--ro in-multicast-pkts? yang:counter64 +--ro in-broadcast-pkts? yang:counter64 +--ro in-64bytes-pkts? yang:counter64 +--ro in-over
IP Route Use the following definition to get the Route statistics: Module: IP ROUTE URI: /api/operational/dell/stats/ip/route Methods Supported: GET Route Model +--ro route +--ro gateway-of-last-resort? string +--ro route-entry* [destination] | +--ro destination inet:ip-prefix | +--ro next-hop* [address] | | +--ro address inet:ip-address | | +--ro interface? dell:interface-name | | +--ro weight? uint32 | | +--ro route-type? enumeration | +--ro route-owner? enumeration | +--ro metric? uint32 | +--ro ag
| +--ro address! | +--ro primary | | +--ro address? dell:ipv4-address-with-prefix | +--ro secondary* [address] | +--ro address dell:ipv4-address-with-prefix +--ro if-virtual-address? dell:ipv4-address-with-prefix +--ro if-broadcast-address? inet:ip-address +--ro if-address-input? enumeration +--ro if-ip-mtu? int32 +--ro protocols +--ro udp-helper* [helper] | +--ro helper inet:ip-address +--ro udp-broadcast? inet:ip-address +--ro directed-broadcast? boolean +--ro proxy-arp? boolean +--ro split-horizon? boole
Methods Supported: GET IPv6 ACL Operational Model +--ro dell +--ro stats +--ro access-list +--ro ipv6 [name] +--ro name dell:access-list-name +--ro ipv6-acl-filter [seq-num] +--ro seq-num uint32 +--ro filter-type? acl-rule-types +--ro protocol? ip-protocols +--ro ipv6-protocol-number? uint32 +--ro source | +--ro ipv6-filter? acl-incoming-address-filtertypes | +--ro ipv6-address? dell:ipv6-address | +--ro ipv6-mask? dell:ipv6-address | +--ro operator? ip-acl-operators | +--ro port? uint32 | +--ro port-rang
Management Route Model +--ro management-route +--ro route-entry* [destination] | +--ro destination dell:ipv4-address-with-prefix | +--ro gateway? string | +--ro state? enumeration | +--ro route-source? enumeration +--ro summary +--ro connected-active? uint32 +--ro connected-inactive? uint32 +--ro dynamic-active? uint32 +--ro dynamic-inactive? uint32 +--ro static-active? uint32 +--ro static-inactive? uint32 +--ro mgmt-route-size? uint32 MAC Address Table Use the following definition to get the entries of ma
Policy Based Routing (PBR) Use the following model to get the PBR operational data: Module: STATS URI: /api/operational/dell/stats/ip/redirect-list Methods Supported: GET PBR Operational Model +--rw dell +--ro stats +--ro ip | +--ro redirect-list [name] | +--ro name string | +--ro filter [seq-no] | | +--ro seq-no uint32 | | +--ro output-action? pbr-rule-types | | +--ro next-hop-ip? dell:ipv4-no-prefix | | +--ro redirect-interface? dell:tunnel-intf-name | | +--ro track-num? uint32 | | +--ro track-statu
| | +--ro nexthop-mac? string | | +--ro egress-port? string | +--ro rule-entry-count? uint32 +--ro interface [name] +--ro name dell:interface-name +--ro rule-entry [cam-index] +--ro cam-index uint32 +--ro port? uint32 +--ro vlan-id? dell:vlan-id-num-with-default +--ro protocol? dell:ip-protocols-type +--ro tcp-flag* tcp-bits +--ro source-port? uint32 +--ro destination-port? uint32 +--ro source-ip? string +--ro destination-ip? string +--ro nexthop-mac? string +--ro egress-port? string Port Mirroring Use the
| +--ro name access-list-name | +--ro type? access-list-types | +--ro mac-acl-filter* [seq-no] | +--ro seq-no uint32 | +--ro filter-type? acl-rule-types | +--ro src-mac-filter? acl-incoming-address-filter-types | +--ro src-mac-address? yang:phys-address | +--ro src-mac-mask? yang:phys-address | +--ro dest-mac-filter? acl-incoming-address-filter-types | +--ro dest-mac-address? yang:phys-address | +--ro dest-mac-mask? yang:phys-address | +--ro encapsulation-type? mac-acl-encap-types | +--ro encapsulation-oper
URI: /api/operational/dell/stats/system Methods Supported: GET System Model +--ro mac-address? yang:phys-address +--ro reload-type? reload-type +--ro next-boot? reload-type +--ro units* [unit-id] | +--ro unit-id uint32 | +--ro unit-role? string | +--ro unit-status? string | +--ro unit-next-boot-status? string | +--ro required-type? string | +--ro current-type? string | +--ro master-priority? int32 | +--ro hardware-revision? string | +--ro os-version? string | +--ro num-ports? uint32 | +--ro up-time? str
+--ro thermal-sensor-reading* [unit-id] +--ro unit-id uint32 +--ro sensor-class* [sensor-type] +--ro sensor-type sensor-types +--ro sensor* [sensor-id] +--ro sensor-id uint32 +--ro temperature? int32 System Alarm Use the following definition to display the Alarm entries: Module: STATS URI: /api/operational/dell/stats/alarms Methods Supported: GET System Alarm Model +--ro alarms +--ro major-alarms [index] | +--ro index uint32 | +--ro alarm-description? string | +--ro duration? yang:timestamp +--ro min
| +--ro revision? | +--ro piece-part-id? | +--ro ppid-revision? | +--ro service-tag? | +--ro express-service-code? +--ro protocols? string string string string string string System Version The following definition displays version-info: Module: STATS URI: /api/operational/dell/stats/version-info Methods Supported: GET System Version Model +--ro version-info +--ro os-ver? string +--ro sw-ver? string +--ro build-time? string +--ro build-path? string +--ro up-time? string +--ro image-name? string +--ro
+--ro vlan-port-list-intf-type? +--ro vlan-port-list-data? vlan-intf-type string Operational Data for IPv6 This section describes the method of fetching the IPv6 operational data. Interface Use the following definition to get the statistics of IPv6 Interface operational data.
+--ro label_value? boolean +--ro mld-host +--ro elapsed-time? dell:hour-minute-second +--ro valid-mld-pkts-received? yang:counter32 +--ro valid-mld-pkts-sent? yang:counter32 +--ro reports-received? yang:counter32 +--ro reports-sent? yang:counter32 +--ro leaves-sent? yang:counter32 +--ro mldv2-queries-received? yang:counter32 | +--ro mldv1-queries-received? yang:counter32 | +--ro errors-malformed-pkts? yang:counter32 +--ro neighbors* [ipv6-address] | +--ro ipv6-address dell:ipv6-address-with-prefix | +--ro i
+--ro route-size-inactive? +--ro total-active-routes? +--ro total-inactive-routes? uint32 uint32 uint32 Prefix-list Use the following definition to get the IPv6 Prefix– list data: Module: PREFIX-LIST URI: /api/operational/dell/stats/ipv6/prefix-list Methods Supported: GET Prefix-List Model for IPv6 +--ro prefix-list +--ro last-deletion-insertion? dell:prefix-list-name +--ro prefix-list-name* [name] +--ro name dell:prefix-list-name +--ro count? uint32 +--ro range-entries? uint32 +--ro sequence-min? u
+--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro connected-active? connected-inactive? dynamic-active? dynamic-in-active? static-active? static-inactive? route-size-active? route-size-in-active? uint32 uint32 uint32 uint32 uint32 uint32 uint32 uint32 Management Information Base (MIB) Management Information Base (MIB) is a database of objects that can be monitored by a network management system.
| +--ro dellNetBgpM2SupportedCapabilityCode uint32 | +--ro dellNetBgpM2SupportedCapability? snmpv2-tc:TruthValue +--ro dellNetBgpM2PeerTable* [dellNetBgpM2PeerInstance dellNetBgpM2PeerLocalAddr dellNetBgpM2PeerRemoteAddr] | +--ro dellNetBgpM2PeerInstance uint32 | +--ro dellNetBgpM2PeerIdentifier? inet:ip-address | +--ro dellNetBgpM2PeerState? enumeration | +--ro dellNetBgpM2PeerStatus? enumeration | +--ro dellNetBgpM2PeerConfiguredVersion? uint32 | +--ro dellNetBgpM2PeerNegotiatedVersion? uint32 | +--ro del
| +--ro dellNetBgpM2PeerCapReceivedCode uint32 | +--ro dellNetBgpM2PeerCapReceivedIndex uint32 | +--ro dellNetBgpM2PeerCapReceivedValue? binary +--ro dellNetBgpM2PrefixCountersTable* [dellNetBgpM2PeerIndex dellNetBgpM2PrefixCountersAfi dellNetBgpM2PrefixCountersSafi] | +--ro dellNetBgpM2PeerIndex uint32 | +--ro dellNetBgpM2PrefixCountersAfi mib:dellNetBgpM2Afi | +--ro dellNetBgpM2PrefixCountersSafi mib:dellNetBgpM2Safi | +--ro dellNetBgpM2PrefixInPrefixes? yang:gauge32 | +--ro dellNetBgpM2PrefixInPrefixesAc
| +--ro dellNetBgpM2AdjRibsOutIndex uint32 | +--ro dellNetBgpM2AdjRibsOutRoute? snmpv2-tc:RowPointer +--ro dellNetBgpM2PathAttrTable* [dellNetBgpM2PathAttrIndex] | +--ro dellNetBgpM2PathAttrIndex uint32 | +--ro dellNetBgpM2PathAttrOrigin? enumeration | +--ro dellNetBgpM2PathAttrNextHop? inet:ip-address | +--ro dellNetBgpM2PathAttrMedPresent? snmpv2-tc:TruthValue | +--ro dellNetBgpM2PathAttrMed? uint32 | +--ro dellNetBgpM2PathAttrLocalPrefPresent? snmpv2-tc:TruthValue | +--ro dellNetBgpM2PathAttrLocalPref? u
NextHopAddress] +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro NetworkPrefix NetworkPrefixLen NextHopAddress StatusCode? BestRoute? PathSource? OriginCode? RouteFlapCount? RouteFlapDuration? ReuseDuration? AsPathString? inet:ip-address inet-address:InetAddressPrefixLength inet:ip-address enumeration snmpv2-tc:TruthValue enumeration enumeration uint32 yang:timeticks yang:timeticks snmp-framework:SnmpAdminString Forwarding Information Base (FIB) The following definition displays the prop
Forwarding Plane Statistics Model +--ro mib +--ro fp-stats +--ro fp-stats-table* [stackUnitId] | +--ro stackUnitId int32 | +--ro rxHandle? int32 | +--ro numMsgHdr? int32 | +--ro numMsgBuf? int32 | +--ro numCluster? int32 | +--ro received? int32 | +--ro dropped? int32 | +--ro rxToNetwork? int32 | +--ro rxError? int32 | +--ro rxDatapathError? int32 | +--ro rxPktCOS0? int32 | +--ro rxPktCOS1? int32 | +--ro rxPktCOS2? int32 | +--ro rxPktCOS3? int32 | +--ro rxPktCOS4? int32 | +--ro rxPktCOS5? int32 | +--ro rxPkt
| +--ro inPktDroppedByFP? yang:counter64 | +--ro inL2L3Drops? yang:counter64 | +--ro inPortBitMapZeroDrops? yang:counter64 | +--ro inRxVLANDrops? yang:counter64 | +--ro inFCSDrops? yang:counter64 | +--ro inMTUExceeds? yang:counter64 | +--ro mmuHoldDrops? yang:counter64 | +--ro mmuTxPurgeCellErr? yang:counter64 | +--ro mmuAgedDrops? yang:counter64 | +--ro egressFCSDrops? yang:counter64 | +--ro egIPv4L3UCAgedDrops? yang:counter64 | +--ro egTTLThresholdDrops? yang:counter64 | +--ro egInvalidVLANCounterDrops? y
+--ro ifLastChange? yang:timeticks +--ro ifInOctets? yang:counter32 +--ro ifInUcastPkts? yang:counter32 x--ro ifInNUcastPkts? yang:counter32 +--ro ifInDiscards? yang:counter32 +--ro ifInErrors? yang:counter32 +--ro ifInUnknownProtos? yang:counter32 +--ro ifOutOctets? yang:counter32 +--ro ifOutUcastPkts? yang:counter32 x--ro ifOutNUcastPkts? yang:counter32 +--ro ifOutDiscards? yang:counter32 +--ro ifOutErrors? yang:counter32 x--ro ifOutQLen? yang:gauge32 x--ro ifSpecific? yang:object-identifier +--ro ifName?
IETF Interface Model +--rw interfaces +--rw interface [name] +--rw name +--rw description? +--ro type? +--ro location? +--rw enabled? +--ro if-index? +--rw mtu? +--rw link-up-down-trap-enable? +--rw rate-interval? string string ianaift:iana-if-type string boolean int32 uint32 enumeration uint32 REST API Framework to Execute the CLIs REST CLI is an alternative approach for Telnet and SSH to send the Dell Networking OS commands to the system.
interface vlan 100\r\n ip address 1.2.3.4/24 curl -u demo:demo -X POST -T Input.xml http://:8008/api/running/dell/ _operations/cli
_operations/cli
12 REST API CLI The REST API CLI commands are supported on the S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, and Z9500 platforms. rest-server Enable the REST API service over a non-secure or secure HTTP. S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, and Z9500 Syntax rest-server {http | secure-http} To disable the REST API over a non-secure or secure HTTP request, use the no rest-server {http | secure-http} command. Parameters http Enable the REST API on HTTP (Port: 8008).
Usage Information NOTE: The rest enable command is deprecated; however, the support is maintained for backward compatibility in version 9.4(0.0P1) and is removed in the 9.5(0.1) release. crypto cert generate Generate a self-signed certificate and key files, if exists, and replace them with the newly generated files.
validity days (OPTIONAL) Enter the keyword validity then the number of days the certificate is valid. The validity range is from 1 to 10000 days. The default value is 3650 days (10 years). Command Modes EXEC Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide. The following is a list of the Dell Networking OS version history for this command. Version Description 9.8(0.
Version Description 9.7(0.0) Introduced on the S6000–ON. 9.6(0.0) Introduced on the S Series and Z Series switches. Usage Information If either certificate or key files are not present or not valid, the prompt displays a message File not found/invalid. show crypto cert Display the certificate information.
Dell# Not After : Apr 30 19:05:16 2014 GMT show ip rest-server Display the status of the configured rest-server (HTTP or Secure HTTP). S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, and Z9500 Syntax show ip rest-server Defaults none Command Modes EXEC Privilege Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell Networking OS Command Line Reference Guide.
Web Server with HTTP Support 13 You download web server with HTTP support with the SmartScripts package. It is supported on the S4810, S4820T, S5000, and MXL switch platforms. For more information, see the Download the Smart Scripting Package. Starting the Web Server In the Open Automation package, the web server runs on a switch and handles HTTP and HTTPS requests. You can start the web server in a non-secure (HTTP) or secure (HTTPS) mode.
