Open Automation Guide Configuration and Command Line Reference Sep 2014
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. Information in this publication is subject to change without notice. Copyright © 2014 Dell Inc. All rights reserved. This product is protected by U.S.
1 About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 Objectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Supported Platforms and Required Dell Networking OS Versions . . . . . . . . . . . . . . . . . .7 Conventions . . . . . . . . . . .
www.dell.com | support.dell.com Preconfiguration Script - BMP Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35 Post Configuration Script - BMP Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36 BMP Operations on Servers Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38 DHCP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 DHCP Server Settings . . . . . . .
Running a UNIX API Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78 Running Scripts with User Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79 6 Smart Scripting CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Commands . . . . . . . . . . . . .
www.dell.com | support.dell.com VLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 Static Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 BGP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Operational . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
www.dell.com | support.dell.
www.dell.com | support.dell.com • • • • • • S4820T switches require Dell Networking OS version 9.2(0.0) or later. Z9000 switches require Dell Networking OS version 9.0.0.0 or later. (SmartScripts and SmartUtil support only) S5000 switches require Dell Networking OS version 9.6(0.0) or later. S6000 switches require Dell Networking OS version 9.0.2.0 or later. MXL Switches require Dell Networking OS version 9.2(0.0) or later. Z9500 switches require Dell Networking OS version 9.5(0.1) or later.
Table 1-1. Information Symbols Symbol Type Description Platform-specific Feature Informs you of the platform supporting the Open Automation features. For example, the S4810 and S4820T platforms support all Open Automation features. The Z9000, Z9500, S5000 and S6000 platform supports the SmartScripts and SmartUtil features. The MXL platform supports Representational State Transfer Interface (REST API) and the SmartScripts features.
www.dell.com | support.dell.com • 10 • | About this Guide MXL Switch • Dell Networking OS Command Line Reference Guide for the MXL 10/40GbE Switch IO Module • Dell Networking OS Configuration Guide for the MXL 10/40GbE Switch IO Module • MXL 10/40GbE Switch IO Module Getting Started Guide Dell Networking OS Release Notes for the platform and version you are using.
2 Open Automation Framework Open Automation Framework is supported on the S4810, S4820T, S5000, S6000, Z9000, Z9500 and MXL platforms. Dell Networking’s Open Automation Framework is designed to provide an open, industry standards-based automation technology that simplifies the management of dynamic virtual data centers and reduces risk and overhead.
www.dell.com | support.dell.com • • Representational State Transfer Application Programming Interface Web Server with HTTP Support You can use these components together or independently to extend and add functionality to the Dell Networking OS without requiring updates to a Dell Networking OS release. Figure 2-1. Open Automation Framework Note: The Open Automation Framework is referred to as Open Automation in the rest of this document.
For more information on Bare Metal Provisioning, refer to the Dell Networking OS Configuration Guide for the S4810, S4820T, S5000, S6000, Z9000 and Z9500 switches or to the Configuration Guide for the MXL 10/40GbE Switch IO Module for MXL switches.
www.dell.com | support.dell.com VSN software supports the following hypervisors: • • VMware vSphere 4.0/4.1/5.0 Citrix XenServer 5.6/6.0 REST API REST-API provides application programming interfaces (APIs) that allow Dell Networking OS switches to be managed by in-house or third-party system management tools.
3 Bare Metal Provisioning Bare metal provisioning (BMP) is included as part of the Dell Networking Operating System (OS) image. BMP is supported on the S4810, S4820T, S5000, S6000, Z9000, Z9500 and MXL switch platforms. Introduction BMP improves operational efficiency to the 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.
www.dell.com | support.dell.com Prerequisites Before you use BMP to auto-configure a supported Dell Networking switch, configure the following: • • • • External DHCP server (required) — a network device offering configuration parameters. File server (required) — a network device for storing and servicing files. Domain name server (DNS) (optional) — a server that associates domain names in the network with IP addresses.
BMP Process Overview When the system boots up in default BMP mode, the following items are requested: 1. Current (new) Dell Networking OS build image. 2. Configuration file or preconfiguration script (EXPECT, TCL, or Z-shell [ZSH] script). Note: If SmartScripts package is already installed, then the preconfiguration scripts can be in PERL or Python. 3. A list of checksums for all these components. Note: The configuration file maintains normal BMP functionality when a preconfiguration script is not sent.
www.dell.com | support.dell.com Configuring BMP BMP supports two types of reload modes: BMP mode and Normal mode. Reload Modes This section describes the following Reload modes: • • • • BMP Mode Normal Mode DHCP Server Settings Dell Networking OS Image Retrieval BMP mode is the default boot mode configured for a new system arriving from the Dell factory. This mode obtains the Dell Networking OS image and configuration file from a network source (DHCP and file servers).
The following message displays, when BMP is about to start: Message 1 This device is configured to enter Bare Metal Provisioning (BMP). BMP will now attempt to download an image, configuration file or boot script using DHCP. You can interact with the switch only via the console. If you open the console and enter any key(s), the inputs will be discarded and following message will be displayed and it waits for user input. Message 2 This device is in Bare Metal Provisioning (BMP) mode.
www.dell.com | support.dell.com Normal Context To auto-configure a switch, before you use BMP mode, first configure a DHCP, DNS, and file server in the network. Note: Syslog of severity level greater than two will not be displayed by default. The syslog will be enabled before applying the configuration or execution of preconfig script which would help in identifying any user configuration errors.
BMP Commands and Examples You can configure BMP on supported switches using a series of commands. To enable BMP mode on switches, and to apply configuration or run scripts using BMP commands, refer the Bare Metal Provisioning CLI section. System Boot and Set-Up Behavior in BMP Mode The following steps describe the system boot up process: 1. 2. The system begins the boot up process in BMP mode (the default mode). The system sends DHCP discover on all the interface up ports.
www.dell.com | support.dell.com b When an Dell Networking OS build image is found, the system compares that build image to the version currently loaded on the chassis. • If there is a mismatch between the build images, the system upgrades to the downloaded version and reloads.
9. Integrity of the files being downloaded by BMP will be verified using SHA256/MD5 hash. For each files, the relevant filename.sha256 or filename.md5 should be present in the same location, where the file is present. a When FIPS mode is disabled, • If both filename.sha256 and filename.md5 are not present, then the image will be downloaded without any type of validation. • If both filename.sha256 and filename.md5 are present, SHA256 validation is given the highest priority compared to MD5 validation.
www.dell.com | support.dell.com Reload Without a DHCP Server Offer A switch configured to reload in BMP mode. If the DHCP server cannot be reached, the system keeps on sending DISCOVER messages. 00:03:56: %STKUNIT0-M:CP sent on Ma 0/0. 00:03:56: %STKUNIT0-M:CP sent on Te 0/21. 00:03:55: %STKUNIT0-M:CP sent on Te 0/8. 00:03:41: %STKUNIT0-M:CP sent on Ma 0/0. 00:03:40: %STKUNIT0-M:CP sent on Te 0/21. 00:03:40: %STKUNIT0-M:CP sent on Te 0/8. 00:03:25: %STKUNIT0-M:CP sent on Ma 0/0.
3. If the configuration download is successful, the following logs display: 00:01:22: %STKUNIT0-M:CP %BMP-2-BMP_DOWNLOAD_START: The config file download has started. 00:01:23: %STKUNIT0-M:CP %BMP-5-BMP_DWNLD_FILE_IS_CONFIG_FILE: The downloaded file is a configuration file. 00:01:23: %STKUNIT0-M:CP %BMP-5-BMP_DWNLD_CONFIG_SCRIPT_SUCCESS: The config/script file download is successful. 00:01:24: %STKUNIT0-M:CP %BMP-5-DOWNLOAD_INFO: /tftpboot/ signal.py config file successfully downloaded.
www.dell.com | support.dell.com a If the build image versions match, the system does not try to load any image and comes up with the Dell prompt.
• When the preconfiguration script completes, the start up configuration file is automatically applied. If a preconfiguration script file download is successful, the following SYSLOGs display. 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.
www.dell.com | support.dell.com download process and it will never be stored by BMP in either runing-config or startup-config. This mainly controls the usage of non-FIPS approved algorithms by BMP initiated file download process. If this option is not configured, by default BMP assumes FIP-mode as disabled. • If the value is set to TRUE, FIPS-mode will be enabled by BMP and it uses the relevant FIPS-approved algorithms for the image/config-file download process.
You can provide a preconfiguration script in DHCP option 209 to either configure the switch or download a configuration file. The script can download a configuration file or apply CLI commands. In the downloaded configuration, post configuration script CLIs are executed if present. You can set the system to retry downloading a configuration up to six times or to automatically save the downloaded configuration or script on the switch.
www.dell.com | support.dell.com Store scripts in a flash://autoexec file. Autoexec scripts are independent of BMP. The autoexec script only executes when: • • • BMP is disabled. The script is stored in a flash://autoexec file. Use the reload-type normal-reload command before you reload the system. If the autoexec script fails, the system generates a message indicating the failure and does not load the configuration file. Before continuing the upgrade, correct the error in the script.
Running Scripts Using the Post Configuration Script (BMP Mode Only) To reload Dell Networking OS on a switch, ensure the following: • • • • • • BMP is enabled. You can write the post configuration script in EXPECT, TCLSH, or ZSH. If you already installed the SmartScripts package, you can also write the post configuration script in PERL or Python. No restraints are required for the post configuration script, for example, the signature #/DELL-NETWORKING that is required for the preconfiguration script.
www.dell.com | support.dell.com If the system is rebooted with reload-type set as normal-reload and an autoexec script is present in the Flash directory, the following logs display: Starting Dell Networking application 00:00:13: %STKUNIT1-M:CP %RAM-6-ELECTION_ROLE: Stack unit 1 is transitioning to Management unit. 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.
.. .. .. Starting Dell Networking application 00:00:13: %STKUNIT1-M:CP %RAM-6-ELECTION_ROLE: Stack unit 1 is transitioning to Managementunit. 00:00:15: %STKUNIT1-M:CP %CHMGR-5-STACKUNITDETECTED: Stack unit 1 present. The following line indicates the start of the autoexecution script. 00:00:16: %STKUNIT0-M:CP %BMP-5-AUTOEXEC_START: The AutoExec Script is Started.
www.dell.com | support.dell.com The following line indicates the autoexecution script has completed successfully: 34 00:04:05: %STKUNIT0-M:CP %BMP-5-AUTOEXEC_SUCCESS: The AutoExec Script execution returned Success.
Preconfiguration Script - BMP Mode #! /usr/bin/expect #/DELL-NETWORKING # Execute F10do and Print proc print_f10do {cmd_str} { set str [exec f10do "$cmd_str"] set tmp_str [string map {\n \r\n} $str ] puts $tmp_str } set ftp_ip "20.0.0.1" set ftp_username "lab" set ftp_passwd "lab" set config_file "s4810-10-startup-config" set post_conf "s4810-10-post-config.exp" puts "Executing Pre-Config Script !!!!\r\n" exec rm -rf "$config_file" exec rm -rf "$post_conf" puts "Downloading Startup Config and Post-Config Sc
www.dell.com | support.dell.com Post Configuration Script - BMP Mode 36 The following example shows the post configuration script for the S4810 or S4820T platform: #! /usr/bin/expect #/DELL-NETWORKING # Post Config Script for S4810-10 # Execute F10do and Print proc print_f10do {cmd_str} { set str [exec f10do "$cmd_str"] set tmp_str [string map {\n \r\n} $str ] puts $tmp_str } # Interfaces Configurations set interface_list_slot [list "0/1" "0/5" "0/9"] set interface_list [list "Te 0/1" "Te 0/5" "Te 0/9"]
puts $fp "========================================\n" puts $fp " Checking Conectivity thru LLDP\n" puts $fp "========================================\n" # Check LLDP Configurations foreach intf_slot $interface_list { set min 0 set result 0 while {$result == 0 && $min < 5} { set result_str [exec f10do "show lldp neighbors | grep \"$intf_slot\""] set tmp_str [string map {\n \r\n} $result_str] puts $tmp_str if {[regexp "$intf_slot" $result_str]} { set result 1 if {[regexp "$remote_intf($intf_slot)" $result_str
www.dell.com | support.dell.com expect "ftp>" send "ls\n" expect "ftp>" send "bye\n" expect eof print_f10do "configure terminal" print_f10do "interface TenGigabitEthernet 0/22" print_f10do "no ip address" print_f10do "shutdown" print_f10do "end" puts "Post-Config Script Execution Successfull !!!!!\r\n" exit 0 BMP Operations on Servers Overview The following sections describe how to prepare the different servers for BMP functionality: • • • DHCP Server File Server Settings Domain Name Server Settings DHC
• • • 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. The system supports the TFTP, HTTP, HTTPS, SFTP, SCP, and FTP protocols, as well as files stored in Flash. Domain Name Server (Optional) — the DNS server contacted to resolve the host name. IP Address — dynamic IP address for the system. Use this IP address only for file transfers. The following lists the DHCP option codes.
www.dell.com | support.dell.com MAC-Based Configuration To configure the DHCP server to assign a fixed IP address, Dell Networking OS image, and configuration file based on the system’s MAC address, use the BMP mode. Using BMP, the same IP address is assigned to the system even on repetitive reloads and the same configuration file is retrieved when using the DNS server or the network-config file to determine the hostname. The assigned IP address is only used to retrieve the files from the file server.
For example, on a DHCP3 server, you can configure the assignment of a fixed MAC-based IP address and configuration file by entering the following lines of configuration parameters in the dhcpd.conf file on the server: host S4810 { hardware ethernet 00:01:e8:81:e2:39; fixed-address 20.0.0.48; option configfile "customer.
www.dell.com | support.dell.com 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.
4 Bare Metal Provisioning CLI Overview Bare Metal Provisioning CLI is supported on the S4810, S4820T, S5000, S6000, Z9000, Z9500 and MXL switch platforms. In a data center network, Bare Metal Provisioning (BMP) automates the configuration 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.
www.dell.com | support.dell.com Commands • • • • • • • • bmp logging reload conditional nvram-cfg-change reload-type script post-config show boot bmp show reload-type stop bmp verify bmp logging Configure the syslog messages in a console while BMP is running. z , S5000, MXL Switch Syntax bmp logging {enable | disable} Defaults None. Command Modes EXEC Parameters Command History Usage Information enable Enables the syslog messages in the console while BMP is running.
reload conditional nvram-cfg-change To perform a reload on the chassis to upgrade any configuration changes that have changed the NVRAM content, after saving the BMP configuration, use this command. z , S5000, MXL Switch Syntax reload conditional nvram-cfg-change Defaults None. Command Modes EXEC Command History Usage Information This guide is platform-specific. For command information about other platforms, refer to the relevant Dell Networking OS Command Line Reference Guide. Version 9.6(0.
www.dell.com | support.dell.com reload-type Configure a switch to reload in Normal mode or as a DHCP client with all ports configured for Layer 3 traffic. z , S5000, MXL Switch reload-type {normal-reload | bmp [ {enable | disable}] [config-scr-download {enable | disable}] [dhcp-timeout minutes] [retry-count number] [vendor-class-identifier description]} Syntax To stop the BMP process, use the stop bmp command. Parameters normal-reload Enable the normal reload type and disable BMP reload type.
Command History Usage Information Version 9.6(0.0) Introduced on the S5000. Version 9.5(0.1) Introduced on the Z9500. Version 9.3(0.0) Updated the parameters for S6000. Version 9.2(0.0) Introduced on the MXL Switch. Updated the parameters for S4810, S4820T, and Z9000. Version 9.1.0.0 Updated the command mode from EXEC Privilege to GLOBAL CONFIGURATION. Updated the parameter from jumpstart to bmp. Added support for the config-scr-download and user-defined-string commands.
www.dell.com | support.dell.com show reload-type — displays the current reload mode (BMP or Normal mode). Related Commands stop bmp — stops the BMP process and prevents a loop if the DHCP server is not found. script post-config To run the post-configuration script after the pre-configuration script is executed during the BMP reload, ensure that this command is present in the startup-configuration.
Command History Example Version 9.6(0.0) Introduced on the S5000. Version 9.5(0.1) Introduced on the Z9500. Version 9.3(0.0) Introduced on the S6000. Version 9.2(0.0) Introduced on the Z9000, S4810, S4820T, and MXL Switch. Dell# show boot bmp Config Download via DHCP: enabled BMP State : Waiting for boot options ... BMP State : Received DHCP offer from DHCP server 25.1.1.1 ***** SELECTED OFFER DETAILS ****** Server type= DHCP Acquired IP= 25.1.1.25 Subnet-mask = 255.255.0.0 Image file = tftp://25.
www.dell.com | support.dell.com Command History Version 9.6(0.0) Introduced on the S5000. Version 9.5(0.1) Introduced on the Z9500. Version 9.3(0.0) Updated the parameters for S6000. Version 9.2(0.0) Introduced on the MXL Switch. Updated the parameters for S4810, S4820T, and Z9000. Version 9.1.0.0 Updated the parameters for S4810 and Z9000. Version 9.0.2.0 Introduced on the S6000. Version 9.0.0.0 Introduced in Z9000. Version 8.3.19.0 Introduced on the S4820T. Version 8.3.11.
Command History Usage Information This guide is platform-specific. For command information about other platforms, refer to the relevant Dell Networking OS Command Line Reference Guide. Version 9.6(0.0) Introduced on the S5000. Version 9.5(0.1) Introduced on the Z9500. Version 9.3(0.0) Introduced on the S6000. Replaces the stop jumpstart command. Version 9.2(0.0) Introduced on the MXL Switch and S4820T. Replaces the stop jumpstart command. Version 9.1(0.0) Introduced on the Z9000 and S4810.
www.dell.com | support.dell.com verify To validate the software image on the flash drive after the image has been transferred to the system, but before the image has been installed. z S5000, Z9000, Z9500 Switch verify {md5 | sha256} [flash://] img-file [hash-value] Syntax Parameters Defaults Command Modes Command History Usage Information md5 MD5 message-digest algorithm. sha256 SHA256 Secure hash algorithm. [flash://] flash (Optional) Specifies the flash drive.
5 Smart Scripting Smart Scripting is supported on the S4810, S4820T, S5000, S6000, Z9000, Z9500 and MXL switch platforms. Smart Scripting allows you to add functionality to Dell Networking switches without requiring updates to the Dell Networking OS release. Smart Scripting is available as a separate installable package that supports SQLite DB, and NET SNMP applications and TCL, Expect, Perl, Python, and Unix scripting languages.
www.dell.com | support.dell.com Smart Scripting includes a convenient set of API function libraries that you can refer to when you create Expect, PERL, Python, Tcl, UNIX and ZSH shell scripts. A representation of CLI functions to retrieve data from the Dell Networking OS and change configuration parameters on Dell Networking switches is provided in the API libraries.
• • Monitor network requests; for example, “find a specified MAC address” or “generate a health-check heartbeat”. Create a simple menu of options that a non-network administrator can use to create requests to be sent to the network. Smart Scripting consolidates management data inside a switch and sends it to management consoles, databases, or applications – reducing polling and network traffic.
www.dell.com | support.dell.com 1. On a PC or other network device, go to the Dell Networking web portal at https://www.force10networks.com/CSPortal20/Main/SupportMain.aspx. Click Login, enter your user ID and password, and click the Login button. 2. On the Customer Support page, click the Software Center tab. 3. In the left hand column, click Automation Software. 4. At the bottom of the Terms and Conditions page, click I agree. 5.
Displaying Installed Packages To view the Open Automation packages currently installed on a switch, including version numbers and content, use the show packages command. Command Syntax Command Mode Task show packages EXEC Privilege View package information. Uninstalling Smart Scripting Caution: Before you uninstall the Smart Scripting package, stop all scripts that are currently running using the no script script-name command. You must also manually stop the http server daemon.
www.dell.com | support.dell.com Table 5-1. Limits on System Attributes System Attribute Value Description stacksize 2,048 Maximum size (in bytes) of the stack segment for a process; this value defines how far a program's stack segment may be extended. Stack extension is performed automatically by the system. coredumpsize unlimited Largest size (in bytes) of a core file that may be created memory use 233,244 Maximum size (in bytes) to which a process's resident set size may grow.
Table 5-2. Supported UNIX Utilities (continued) fg Change the background process to foreground. file Determine file type. find Walk a file hierarchy. ftp Internet file transfer program. getopts Called each time you want to process an argument. grep Print lines matching a pattern. hostname Set or print name of current host system. ifconfig Configure network interface parameters. iostat Report I/O statistics. ln Make links. ls List directory contents.
www.dell.com | support.dell.com Smart Utils When you install the Smart Scripting package, sample PERL and Python scripts are installed in the /usr/pkg/scripts/sample_scripts directory. You can also create your own customized scripts and store them anywhere on the switch, such as in a /f10/ flash_ scripts directory. In addition, you can use the PERL, Python, and UNIX APIs to create scripts that invoke function calls directly in the Dell Networking OS CLI that are collectively called smart utils.
Logging in to a NetBSD UNIX Shell To log into the NetBSD UNIX shell on a switch to directly use any of the UNIX commands described in Supported UNIX Utilities or to run a script, use the start shell command. You are prompted to enter a user name and password before you can access the shell. Login is performed using SSHv2. Command Syntax Command Mode Task start shell EXEC Privilege Access the shell to run UNIX commands or a script (refer to Running a Script from the UNIX Shell).
www.dell.com | support.dell.com Setting a Search Path for Scripts Create a path to the location where scripts are stored to be used by Dell Networking OS when searching for scripts. This negates the need to specify a specific path when executing a script. Command Syntax Command Mode Task script path path-name CONFIGURATION Set a search path for a script in Dell Networking OS. The script path can contain a network file system mounted directory (defined in the mount nfs command).
Command Syntax Command Mode Task This example shows how you can schedule the script named “hello.txt” to start the execution immediately and stop after 20 minutes: Dell#script execute hello.tcl start now stop after 00:20 args "hi" username test • • Scheduled scripts can be un-configured/stopped/killed/resumed only by the configured user (test) or higher privileged user.
www.dell.com | support.dell.com Command Syntax Command Mode Task CONFIGURATION Schedule scripts to run at a certain time, to be repeated, or to stop at a specified time or by a string of arguments. The script runs in the background. Schedule a script to run periodically.
Command Syntax Command Mode Task script execute script-name watch [start {now | at date-time | after time}] [stop {after time} repeat {weekdays day | days day | minutes minutes}]} [args arguments] [username username] CONFIGURATION Monitor the supervised scripts definitely (with stop and repeat keyword) or indefinitely (with just start keyword). This example shows how you can monitor the script named “sample.tcl” which starts from now onwards: Dell(conf)#script execute sample.
www.dell.com | support.dell.com NET SNMP Client To manage the device using SNMP through scripts, Dell Networking OS supports NetSNMP client. You can run scripts that use SNMP to manage the data center/ devices from within the Dell Networking OS itself. Dell Networking OS provides Perl and Python interfaces for NetSNMP client and to execute the SNMP operations, you can also use tclsh exec command.
The scripting framework is enabled with system resource usage protection. So, when the system is running at a high cpu, memory or disk I/O, it automatically suspends all the user-configured running scripts and also prevents scheduling new scripts further till the system resource usage comes down to nominal levels. The following example is used to suspend the scripts when the cpu crosses 70, memory usage is above 60, or the disk I/O is greater than 70.
www.dell.com | support.dell.com Viewing Script Information To view information on currently stored, scheduled, and running SmartScripts, use the following show commands. Command Syntax Command Mode Task show script file [detail] EXEC Privilege Display the list of stored files in the script path. Enter detail to show the detail output of the file. show script process [detail] EXEC Privilege Display list of scripts that are scheduled or running.
Figure 5-1. Execution of a PERL, Python, and Shell Script from a UNIX Shell: Example Dell# start shell <---------------------------------- Log on to a UNIX shell 4.4 BSD UNIX () (ttyp0) login: admin Password: Copyright (c) 1996, 1997, 1998, 1999, 2000, 2001, 2002 The NetBSD Foundation, Inc. All rights reserved. Copyright (c) 1980, 1983, 1986, 1988, 1990, 1991, 1993, 1994 The Regents of the University of California. All rights reserved.
www.dell.com | support.dell.com Figure 5-2. PERL Script with API function call: Example #!/usr/pkg/bin/perl -w require '/usr/pkg/scripts/smartutils/F10SmartUtils.pl'; <------ Load the PERL API usage() if ($#ARGV < 1); ($start,$end)=@ARGV; $startVlan = $start; $endVlan = $end; for (my $i=$startVlan;$i<=$endVlan;$i++) { my $createvlanId = F10CreateVlanId($i); <-------------------- Invoke a PERL API function } sub usage { print "usage: createVlans.pl \n"; exit; } Supported Dell Networking OS A
Table 5-3. Supported Dell Networking OS API Functions in PERL Scripts (continued) F10Ping (ipAddress) Pings (via ICMP) an IP address from the switch. F10ShowArpTbl None Returns the table of learned ARP entries. F10ShowBGPNeighbors None Returns list of BGP neighbors. F10ShowBGPRoute None Returns the table of BGP-learned routes. F10ShowBGPSummary None Returns summary information on BGP sessions. F10ShowBootVar None Returns system boot variables.
www.dell.com | support.dell.com Table 5-3. Supported Dell Networking OS API Functions in PERL Scripts (continued) F10ShowVrrpBrief None Returns a brief VRRP session summary. F10Traceroute (ipAddress, timeout) Performs a traceroute operation to an IP address from the switch. F10WriteMem None Write the running configuration to the startup configuration file.
Creating a Python API Script To create a Python script to be run on a Dell Networking switch, use the information in this section. For information about how to run a Python script from the Dell Networking OS CLI, refer to Scheduling Time / Event-based Scripts. F10SmartUtils.py is the Python API library containing the supported functions (described in Supported Dell Networking OS API Functions in Python Scripts), which you can use in a Python script to invoke Dell Networking OS operations on a switch.
www.dell.com | support.dell.com Supported Dell Networking OS API Functions in Python Scripts describes the supported functions and required arguments that you can use in Python scripts running on a Dell Networking switch to connect through a telnet session and gather information or configure parameters through the CLI. 74 Table 5-4.
Table 5-4. Supported Dell Networking OS API Functions in Python Scripts (continued) F10ShowIPRoute None Returns routing table information. F10ShowISISNeighbors None Returns list of ISIS neighbors. F10ShowISISRoute None Returns the table of ISIS-learned routes. F10ShowLagIntStatus (lagId) Returns the detailed status of a specified port-channel interface. F10ShowLagIntVlanMember (lagId) s Returns information on VLAN membership for a specified port-channel interface.
www.dell.com | support.dell.com The smartutils.cfg file is the configuration file used by the Programmatic Interface package. It contains the user name and passwords required to log on to a switch via telnet and access the CLI to execute the function calls in a Python API script. The smartutils.cfg file downloads with the Programmatic Interface package and is stored at /usr/pkg/scripts/smartutils. Note: Use the user name and passwords contained in the smartutils.
Figure 5-4. Script Written in the UNIX Shell Scripting Language: Example #!/bin/sh i=$1 while [ $i -le $2 ] do echo $i /usr/pkg/bin/python /usr/pkg/scripts/smartutils/F10SmartScriptUtils.py createvlanid $i (( i++ )) done Table 5-5. Supported API Functions in UNIX Shell Scripts Function Arguments Description addlaginttovlan lagId, vlanId, tagFlag Adds a port channel (LAG) to a VLAN. tagFlag values: 1 (tagged) or 0 (untagged).
www.dell.com | support.dell.com Table 5-5. Supported API Functions in UNIX Shell Scripts (continued) showipintbriefphy None Returns brief interface status (up/down/ admin up/down) of all physical interfaces. showipintbriefvlan None Returns brief interface status (up/down/ admin up/down) of all VLAN interfaces. showiproute None Returns switch routing table. showisisneighbors None Returns detailed ISIS neighbor information. showisisroute None Returns ISIS-learned routes.
The smartutils.cfg configuration file is used by the Programmatic Interface package. It contains the user name and passwords required to log on to a switch via telnet and access the CLI to execute the function calls in a UNIX API script. The smartutils.cfg file downloads with the Programmatic Interface package and is stored at /usr/pkg/ scripts/smartutils. Note: Use the user name and passwords contained in the smartutils.
www.dell.com | support.dell.com To run a PERL, Python, or UNIX script from the Dell Networking OS CLI, use the script command. Enter the script name and directory path to start the script. The script can invoke any of the supported UNIX utilities listed in Supported UNIX Utilities. Enter the command multiple times to run more than one script at the same time. 80 | Command Syntax Command Mode Task script [username name] script-path [script-parameter script-parameter ...
6 Smart Scripting CLI Overview Smart Scripting is supported on the S4810, S4820T, S5000, S6000, Z9000, Z9500 and MXL switch platforms.
www.dell.com | support.dell.com mount nfs Share the network file system to be used by the local Dell Networking OS file system. S5000, Z9000, Z9500, MXL Switch Syntax mount nfs nfs-server-ip: remote_dir mount_name [username username password password] To unmount the network file system, use the no mount command. Parameters Defaults Command Modes Command History Related commands Usage Information remote_dir mount_name Enter the directory path where the network file system will be mounted.
package install , S5000, Z9000, Z9500, MXL Switch Syntax Parameters Defaults Command Modes Command History Usage Information Install the Smart Scripting package. This command downloads the package from the specified location and installs it in the internal flash memory on a switch.
www.dell.com | support.dell.com Syntax Parameters Defaults Command Modes Command History Usage Information package uninstall package-name package-name Enter the name of an Open Automation automation package, exactly as it appears in the show packages list. None EXEC Privilege Version 9.6(0.0) Introduced on the S5000. Version 9.5(0.1) Introduced on the Z9500. Version 9.2(0.0) Introduced on the MXL switch. Version 9.0.2.0. Introduced on the S6000. Version 9.0.0.0 Introduced on the Z9000.
Parameters Defaults Command Modes Command History Usage Information username name (Optional) Enter the user name whose read-write privileges is applied when the script runs. A username used to run scripts cannot contain special characters. script-name Enter the name of the script to run, including the directory path and filename; for example: Perl script: /usr/pkg/scripts/sample_scripts/cmd-server.pl Python script: /usr/pkg/scripts/sample_scripts/DisplayAlarms.
www.dell.com | support.dell.com script (stop/resume/clear/kill/unschedule) Stop, resume, clear, kill, or unschedule a Expect, Perl, Python, Tcl, UNIX and ZSH shell script from the Dell Networking OS CLI. , S5000, Z9000, Z9500, MXL Switch Syntax Parameters Defaults Command Modes Command History Usage Information script {stop | resume | clear | kill | unschedule} {script-name script-name | job-id job-id | all} stop Enter the keyword stop to stop a script from being run.
script execute script-name start {now | time-date | time} [stop {at time-date | after time}] [args arguments] [username username] [bg] Syntax To cancel, use the script unschedule command. Parameters Defaults Command Modes Command History Usage Information script-name Enter the name of the script to be scheduled for execution. start now Enter the keywords start now to begin executing the script.
script execute script-name watch start {now | time-date | time} [args arguments] [username username] [bg] www.dell.com | support.dell.com Syntax Parameters script-name Enter the name of the script to be scheduled for execution. watch Enter the keyword watch to monitor the script. start now Enter the keywords start now to begin executing the script. start time-date Enter the keywords start time-date with the time and date in HH:MM-MM/DD/YY format to begin executing the script at a specific time.
start time-date Enter the keyword start with the time and date in HH:MM-MM/DD/ YY format to begin executing the script at a specific time. The date can be the present or a future date. start time Enter the keyword start with the time in HH:MM format to begin executing the script after a set time. repeat weekdays weekday Enter the keywords repeat weekdays to schedule the script to repeat executing on specific days of the week.
www.dell.com | support.dell.com • • • More than three times within 10 minutes, the script is in Blocked state, which you can reset using the script clear command. TACACS/RADIUS user(s) are not supported. Only the person who configured the scheduled scripts (or a higher privileged user) can change them. script execute triggered-by Schedule the script to execute on the occurrence of the configured event.
— When the script is running, all the event occurrences are notified by the SIGUSR1 signal and a new instance of the script is not spawned. — The script uses the getcurrevt utility to retrieve the event name. — The script uses the getnextevt utility to retrieve the last but one event name. — The script, which contains the script name, args, and username, can be associated with more than one trigger event. — When multiple users configure a singleton script, the scripts runs separately in each user context.
www.dell.com | support.dell.com • ftp: Copy from the remote file system (tftp://hostip//filepath) The downloaded files are stored into a dedicated folder (/usr/pkg/ss-scripts). Note: In case of stack, the scripts from the ss-scripts will be synchronized across the stack for every one hour. When the stack forms first, the script synchronization from the master to members will happen only after 10 minutes. script list execute Configure a list of scripts to run when the switch is rebooted.
File contents used in the list name are in the following format: #! list_name seq 1 script seq 2 script seq 3 script seq 4 script seq 5 script [args] [args] [args] [args] [args] script path Configure the path for the script on the switch. , S5000, Z9000, Z9500, MXL Switch Syntax script path path-name To remove the path for the script, use the no script path command.
www.dell.com | support.dell.com script remove Remove a script from a switch. , S5000, Z9000, Z9500, MXL Switch Syntax Parameters Defaults Command Modes Command History Usage Information script remove {file-name | all} file-name Enter the file name of the script to be removed from the switch. all Enter the keywords all to remove all files from the dedicated folder on the switch. None EXEC Version 9.6(0.0) Introduced on the S5000. Version 9.5(0.1) Introduced on the Z9500. Version 9.3(0.
Defaults Command Modes Command History Usage Information log-event severity severity level Enter the keywords log-event severity followed by the severity level to define a trigger even based on the syslog message severity level. Valid message security levels are from 1 to 6.
www.dell.com | support.dell.com Example 85% memory consumption Dell(conf)# script trigger-event memory_event mem-usage 85 show packages , S5000, Z9000, Z9500, MXL Switch Syntax Parameters Defaults Command Modes Display the installed Open Automation packages, including version number and contents. show packages [system] system (Optional) Enter the keyword brief to display system information about the package, version, and status of the package in all stack-units.
Example (show packages) Example (show packages system) Dell# show packages * Package Name: SMARTSCRIPTS Version: 2.0.0 Python 2.6.5 Perl 5.8.8 Data::Dumper 2.126 Class::MethodMaker 2.16 ExtUtils::MakeMaker 6.56 XML::NamespaceSupport 1.11 XML::SAX 0.96 XML::LibXML 1.70 Compress::Raw::Bzip2 2.027 Compress::Raw::Zlib 2.027 IO::Compress 2.027 URI 1.54 HTML::Tagset 3.20 HTML::Parser 3.65 LWP 5.836 Net::Telnet 3.03 OSSP::uuid 1.0602 UUID 0.02 version 0.82 Class::Inspector 1.24 Task::Weaken 1.
www.dell.com | support.dell.com show script Display the stored, scheduled, and running scripts. , S5000, Z9000, Z9500, MXL Switch show script {file | process | watch} | [detail] Syntax Parameters Defaults Command Modes Command History file Enter the keyword file to list the stored files in the script path. Enter the optional keyword detail to show detailed output of the scripts including job-id, script type, and script status.
Command History Usage Information Version 9.6(0.0) Introduced on the S5000. Version 9.5(0.1) Introduced on the Z9500. Version 9.2(0.0) Introduced on the MXL Switch. Version 9.0.2.0 Introduced on the S6000. Version 9.0.0.0 Introduced on the Z9000. Version 8.3.19.0 Introduced on the S4820T. Version 8.3.8.0 Introduced on the S4810.
www.dell.com | support.dell.com Version 9.3(0.0) Introduced on the S6000. Version 9.2(0.0) Introduced on the S4810, S4820T, Z9000 and MXL Switch. Usage Information When any maximum percentage limit is reached, all running scripts are suspended; additional scripts are not be scheduled. Scripts begin running when any of the resource limits reaches 10% less than the configured value. Details are entered into the syslog.
7 Virtual Server Networking Virtual Server Networking is supported on platforms: S4810, S4820T, S5000 and MXL switch. As a part of the Open Automation package, Virtual Switch Networking (VSN) provides real-time communication between the Dell Network fabric and virtual servers to automate network management and configuration tasks throughout the data center.
www.dell.com | support.dell.com Overview Virtual Server Networking is an Open Automation tool that enables Dell Networking switch/routers in a data center network to retrieve configuration information from hypervisors. VMware vSphere and Citrix Xen hypervisors are supported. Both VMware and Citrix Xen provide SDKs and APIs for accessing their configuration objects. VSN requires Layer 3 connectivity to access a hypervisor.
VSN subscribes to hypervisor for any change to be notified to switch. Depending on the hypervisor mode configured, Dell Networking OS may automatically update its configuration, provide provisioning for configuration changes, or require system administrator intervention.
www.dell.com | support.dell.com Data VLANS Hypervisor-aware VLANs used for data traffic are automatically configured according to the configuration parameters retrieved from the hypervisor by VSN as part of the VLAN trunk on the switch port. Use the show vlan command to display the VSN hypervisor-learned VLANs on the switch. As shown in Figure 7-2, VSN VLANs that have been automatically configured are displayed with a G tag in the left-most column and are associated with ports marked with an H tag.
You must manually configure the interfaces used to connect to hypervisors. Refer to the Dell Networking OS Configuration Guide, Interfaces chapter for information on how to configure a VLAN or physical interface. Prerequisites: - Smart Scripting is a prerequisite for using Virtual Server Networking. You must first install the Smart Scripting package before you can run the VSN application (see Installing Smart Scripting) To install the VSN package: 1.
www.dell.com | support.dell.com Enabling VSN in a Hypervisor Session Restrictions: - VSN is not supported in stacked configurations; it is only supported on standalone units. - VSN supports connections only with VMware and Xen hypervisors - You can define up to eight hypervisor sessions on a switch. - To connect with a VMware hypervisor running on an ESXi 5.0 server, you must configure the server's firewall to allow connections only through the management IP address.
Step 4 Task Command Syntax Command Mode Establish the connection between the switch and a hypervisor access url username username password password HYPERVISOR Where url is one of the following values: 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 be used for authentication on the server.
www.dell.com | support.dell.com Discovery The discovery process starts after you enter the no disable command on the interface and ends in 10 minutes after connectivity is established between the switch and the hypervisor. If no connectivity is established, the switch attempts to connect for three minutes and then stops. Refer to Connectivity for more details on this process.
Message 3 Xen-Citrix:Connection error for hypervisor testing:LOGIN FAILURE If connectivity to a hypervisor is lost after information is retrieved and used to reconfigure a switch, the following log message is displayed. The VSN agent tries to connect to the hypervisor in the background. The information that was retrieved from the hypervisor is not deleted. Message 4 Xen-Citrix:Lost connection to hypervisor xen217. Retrying...
www.dell.com | support.dell.com To run a VSN script (Perl or Python) in all connected hypervisor sessions to retrieve virtual server configurations and update Dell Networking OS settings on the switch, enter the script command in configuration mode. Command Syntax Command Mode Task script script-name CONFIGURATION Run a VSN script in active sessions on VMware and Xen hypervisors.
Uninstalling VSN Caution: Before you uninstall the VSN package, you must first stop all VSN scripts that are currently running using the no script script-name command. Uninstalling the VSN package removes it from the internal flash memory on a switch. Command Syntax Command Mode Task package uninstall name Enter the name of the VSN package, exactly as it appears in show packages output. EXEC Privilege Uninstall the VSN package from the system.
www.dell.com | support.dell.com To display the components of current hypervisor sessions, including the link, virtual switch, and hypervisor to which the switch is connected, use the show virtualswitch command. Command Syntax Command Mode Task show virtualswitch [interface] [virtualswitch-name] EXEC Privilege Display general information on current hypervisor sessions.
Figure 7-7.
| Virtual Server Networking www.dell.com | support.dell.
8 Virtual Server Networking CLI Overview Virtual Server Networking CLI is supported on the following platforms: S4810, S4820T, S5000 and MXL switch. Note: VSN is not supported in stacked configurations; it is only supported on standalone switches.
www.dell.com | support.dell.com access Configure the connection to access a hypervisor. S5000 MXL [no] access url username name password password Syntax Parameters Defaults Command Modes Command History Usage Information url Enter the URL location of the desired hypervisor.
Usage Information Entering the disable command in hypervisor configuration mode disables VSN in the current hypervisor session. It does not remove connectivity with the hypervisor or remove the session information from the system configuration. Enter no disable to re-enable a configured hypervisor session. hypervisor Specify the name of a hypervisor session with which VSN will connect.
www.dell.com | support.dell.com Parameters check VSN retrieves configuration information about virtual servers from a hypervisor and notifies the system administrator if the configuration has changed (for example, a VLAN has been added or removed). Changes in Dell Networking OS configuration parameters must be entered manually on the switch. config VSN retrieves configuration information from the Hypervisor and implements any necessary configuration changes automatically.
Defaults None Command Modes Command History EXEC Privilege Version 9.6(0.0) Introduced on the S5000. Version 9.2(0.0) Introduced on the MXL switch. Version 8.3.19.0 Introduced on the S4820T. Version 8.3.8.0 Introduced on the S4810. Usage Information Because the installation of the VSN package takes time, the installation is performed in the background. When the download is complete, a message is displayed on the console.
www.dell.com | support.dell.com script S5000 MXL Syntax Run an installed VSN script (Perl or Python) on active hypervisor links to retrieve virtual server configurations and update Dell Networking OS settings on the switch. [no] script script-name Enter the no script script-name to stop a running script.
Usage Information Related Commands Example Use this information when defining types of hypervisor connections with the hypervisor command. hypervisor Define a hypervisor instance. Dell#show hypervisor supported vmware xen-citrix show packages Display all Open Automation packages installed on a switch. S5000 MXL Syntax Defaults Command Modes Command History show packages None EXEC Privilege Version 9.6(0.0) Introduced on the S5000. Version 9.2(0.0) Introduced on the MXL switch. Version 8.3.19.
www.dell.com | support.dell.com Example Dell#show packages **************************************** * Package Name:SMARTSCRIPTS Version: 2.0.0 Python Perl 2.6.5 5.8.8 Data::Dumper 2.126 Class::MethodMaker 2.16 ExtUtils::MakeMaker 6.56 XML::NamespaceSupport 1.11 XML::SAX 0.96 XML::LibXML 1.70 Compress::Raw::Bzip2 2.027 Compress::Raw::Zlib 2.027 IO::Compress 2.027 URI 1.54 HTML::Tagset 3.20 HTML::Parser 3.65 LWP 5.836 Net::Telnet 3.03 OSSP::uuid 1.0602 UUID 0.02 version 0.82 Class::Inspector 1.
show virtualswitch S5000 MXL Syntax Defaults Parameters Command Modes Command History Usage Information Display the components of current hypervisor sessions, including the virtual switch and name of the hypervisor session to which a switch interface is connected, show virtualswitch [interface] [virtualswitch-name] None interface Display information on the hypervisor session established on a specified interface.
www.dell.com | support.dell.com The following command output displays information on the hypervisor session established on virtual switch vSwitch3 on a VMware server connected to the interface 0/32. Dell#show virtualswitch Gigabitethernet 0/32 vSwitch3 Interface :Gi 0/32 Hypervisor Type :vmware Hypervisor Name :vmware207 Hypervisor Version :4.1.
Command History Usage Information Related Commands Example Version 9.6(0.0) Introduced on the S5000. Version 9.2(0.0) Introduced on the MXL switch. Version 8.3.19.0 Introduced on the S4820T. Version 8.3.8.0 Introduced on the S4810. The show vmmap command displays information on the virtual machines accessed on a switch interface, including the virtual machine name, VMAC address, and corresponding VLAN ID hypervisor Define a hypervisor instance.
www.dell.com | support.dell.com vsn enable Enable VSN on an interface. S5000 MXL Syntax Defaults Command Modes Command History Usage Information [no] vsn enable VSN is disabled by default on switch interfaces. INTERFACE Version 9.6(0.0) Introduced on the S5000. Version 9.2(0.0) Introduced on the MXL switch. Version 8.3.19.0 Introduced on the S4820T. Version 8.3.8.0 Introduced on the S4810. Enter the vsn enable command only on hypervisor-facing interfaces.
9 REST API Representational state transfer (REST) application programming interface (API) is an integrated part of the Dell Networking Operating System (OS). The supported platforms in 9.5(0.1) release are S4810, S4820T, S5000, S6000, Z9000 and Z9500 platforms. HTTP and HTTPS Use REST API to configure and monitor a Dell Networking switch over hyper text transfer protocol (HTTP) and hyper text transfer protocol secure (HTTPS).
www.dell.com | support.dell.com Important Points to Remember • • • • Internet Protocol (IP) reachability is required from REST client to Dell Networking switch. For enabling and disabling the REST API, refer to REST API CLI. You cannot delete physical interfaces using REST API. Port 8008 is a non-secure port used for HTTP; port 8888 is a secure port used for HTTPS. REST Authentication The REST API authenticates and authorizes the user upon the request based on the Dell Networking OS AAA configuration.
POST and GET Request Examples The following output displays a POST request to create BGP 65009: linux:~/REST$ cat HTTP_SEND_post_bgp 65009 64 32 linux:~/REST$ curl -v -u admin:admin -X POST -T HTTP_SEND_post_bgp http:// 10.43.48.2:8008/api/running/ftos/router * About to connect() to 10.43.48.2 port 8008 (#0) * Trying 10.43.48.2...
www.dell.com | support.dell.com The following output displays a GET request after running the POST request using CURL: linux:~/REST$ curl -v -u admin:admin http://10.43.48.2:8008/api/running/ftos/ router/bgp * About to connect() to 10.43.48.2 port 8008 (#0) * Trying 10.43.48.2... connected * Server auth using Basic with user 'admin' > GET /api/running/ftos/router/bgp HTTP/1.1 > Authorization: Basic YWRtaW46YWRtaW4= > User-Agent: curl/7.22.0 (i686-pc-linux-gnu) libcurl/7.22.0 OpenSSL/1.0.1 zlib/1.2.3.
204 No Content The request was successfully completed, but no response body is returned. 400 Bad Request The request could not be processed because it contains missing or invalid information (such as validation error on an input field, a missing required value, and so on). 401 Unauthorized The request requires user authentication. The response includes a “WWW-Authenticate” header field for basic authentication. 403 Forbidden Access to the resource was denied by the server due to authorization rules.
www.dell.com | support.dell.com • • • 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. Note: If the node is augmented into the tree from another module, the name is printed as :.
| | | +--rw secondary [address] | +--rw address? ftos:ipv4-address-with-prefix +--rw address ftos:ipv4-address-with-prefix +--rw rate-interval? uint32 +--rw port-channel-protocol? | +--rw lacp? | +--rw port-channel? uint32 | +--rw mode? enumeration | +--rw port-priority? uint32 +--rw ipv6? | +--rw address [ipv6-address] | +--rw ipv6-address ftos:ipv6-address | +--rw eui64? boolean +--rw portmode? | +--rw hybrid? boolean +--rw switchport? | +--rw backup | +--rw interface |
www.dell.com | support.dell.
| +--rw primary | | | +--rw secondary [address] | +--rw address? ftos:ipv4-address-with-prefix +--rw address ftos:ipv4-address-with-prefix +--rw rate-interval? uint32 +--rw port-channel-protocol? | +--rw lacp? | +--rw port-channel? uint32 | +--rw mode? enumeration | +--rw port-priority? uint32 +--rw ipv6? | +--rw address [ipv6-address] | +--rw ipv6-address ftos:ipv6-address | +--rw eui64? boolean +--rw portmode? | +--rw hybrid? boolean +--rw switchport? | +--rw backup |
www.dell.com | support.dell.
| +--rw tengigabitethernet [name] | | | +--rw fortyGigE [name] | +--rw name +--rw name ftos:slot-port-range ftos:slot-port-range +--rw ip | +--rw address? | +--rw primary | | | +--rw secondary [address] | +--rw address? ftos:ipv4-address-with-prefix +--rw address ftos:ipv4-address-with-prefix +--rw min-links? uint32 +--rw lacp? enumeration +--rw rate-interval? uint32 +--rw description? string +--rw mtu? uint32 +--rw shutdown? boolean rw vlan [vlan-id] VLAN The following
www.dell.com | support.dell.
BGP The following definition is for configuring and displaying the properties of BGP.
www.dell.com | support.dell.com Operational 140 TenGigabitEthernet The following definition is for displaying the statistics of a TenGigabitEthernet.
| | +--ro ifHCInOver127BytesPkts? yang:counter64 | | +--ro ifHCInOver255BytesPkts? yang:counter64 | | +--ro ifHCInOver511BytesPkts? yang:counter64 | | +--ro ifHCInOver1023BytesPkts? yang:counter64 | | +--ro ifHCInSymbolErrors? yang:counter64 | | +--ro ifHCInRunts? yang:counter64 | | +--ro ifHCInGiants? yang:counter64 | | +--ro ifHCInThrottles? yang:counter64 | | +--ro ifHCInCRC? yang:counter64 | | +--ro ifHCInOverRun? yang:counter64 | | +--ro ifHCInDiscarded? yang:
www.dell.com | support.dell.com FortyGigabitEthernet 142 The following definition is for displaying the statistics of a FortyGigabitEthernet.
| | +--ro ifHCInSymbolErrors? yang:counter64 | | +--ro ifHCInRunts? yang:counter64 | | +--ro ifHCInGiants? yang:counter64 | | +--ro ifHCInThrottles? yang:counter64 | | +--ro ifHCInCRC? yang:counter64 | | +--ro ifHCInOverRun? yang:counter64 | | +--ro ifHCInDiscarded? yang:counter64 | | +--ro ifHCOutOctets? yang:counter64 | | +--ro ifHCOutUcastPkts? yang:counter64 | | +--ro ifHCOutMulticastPkts? yang:counter64 | | +--ro ifHCOutBroadcastPkts? yang:counter64 | | +--
www.dell.com | support.dell.
| | +--ro ifHCInCRC? yang:counter64 | | +--ro ifHCInOverRun? yang:counter64 | | +--ro ifHCInDiscarded? yang:counter64 | | +--ro ifHCOutOctets? yang:counter64 | | +--ro ifHCOutUcastPkts? yang:counter64 | | +--ro ifHCOutMulticastPkts? yang:counter64 | | +--ro ifHCOutBroadcastPkts? yang:counter64 | | +--ro ifHCOutUnicastPkts? yang:counter64 | | +--ro ifHCOut64BytesPkts? yang:counter64 | | +--ro ifHCOutOver64BytesPkts? yang:counter64 | | +--ro ifHCOutOver127BytesPkts?
www.dell.com | support.dell.
| | +--ro ifBroadCastAddress? inet:ip-address | | +--ro ifAddressInput? enumeration | | +--ro ifIpMtu? int32 | | +--ro protocols | | +--ro udpHelper [helper] | | | | | +--ro udpBroadcast? inet:ip-address | | +--ro directedBroadcast? boolean | | +--ro proxyArp? boolean | | +--ro splitHorizon? boolean | | +--ro poisonReverse? boolean | | +--ro icmpRedirects? boolean | | +--ro icmpUnreachables? boolean +--ro helper inet:ip-address IP Route The following defini
www.dell.com | support.dell.com | +--ro routeSizeInactive? uint32 BGP The following definition is for displaying the operational data of BGP.
| seqNum] +--ro prefixList [networkPrefix networkPrefixLen nextHopAddress | +--ro networkPrefix inet:ip-address | +--ro networkPrefixLen inet-address:InetAddressPrefixLength | +--ro nextHopAddress inet:ip-address | +--ro seqNum uint32 | +--ro metric? uint32 | +--ro localPref? uint32 | +--ro weight? uint32 | +--ro nextHopCostIndex? uint32 | +--ro asPathString? string | +--ro pathSource? enumeration | +--ro originCode? enumeration | +--ro isNlreLocAggtd? snmpv2-tc:TruthVal
www.dell.com | support.dell.com MAC Address Table 150 The following definition(s) is for displaying the entries of mac-address-table.
System Alarm The following definition is for displaying alarm entries.
www.dell.com | support.dell.com | | +--ro piece-part-id? string | | +--ro ppid-revision? string | | +--ro service-tag? string | | +--ro express-service-code? string | +--ro protocols? string System Version The following definition is for displaying the version-info.
| +--ro vlanStatus? vlanStatus | +--ro vlanDescription? string | +--ro vlanPortList [vlanPortListNum] | +--ro vlanPortListNum int32 | +--ro vlanPortListPortMode? vlanPortMode | +--ro vlanPortListIntfType? vlanIntfType | +--ro vlanPortListData? string System The following definition is for displaying the system entries.
www.dell.com | support.dell.com +--ro fan-speed? uint32 BGP MIB The following definition is for displaying the entries in BGP MIB table.
Module: f10BgpM2SupportedCapabilitiesTable URI: /api/operational/f10BgpM2SupportedCapabilitiesTable Methods Supported: GET +--ro f10BgpM2SupportedCapabilitiesTable | +--ro f10BgpM2SupportedCapabilitiesEntry [f10BgpM2SupportedCapabilityCode] | +--ro f10BgpM2SupportedCapabilityCode uint32 | +--ro f10BgpM2SupportedCapability? snmpv2-tc:TruthValue Module: f10BgpM2PeerTable URI: /api/operational/f10BgpM2PeerTable Methods Supported: GET +--ro f10BgpM2PeerTable | +--ro f10BgpM2PeerEntry [f10BgpM2PeerInstan
www.dell.com | support.dell.
| +--ro f10BgpM2PeerIndex uint32 | +--ro f10BgpM2PeerCapReceivedCode uint32 | +--ro f10BgpM2PeerCapReceivedIndex uint32 | +--ro f10BgpM2PeerCapReceivedValue? binary Module: f10BgpM2PrefixCountersTable URI: /api/operational/f10BgpM2PrefixCountersTable Methods Supported: GET +--ro f10BgpM2PrefixCountersTable | +--ro f10BgpM2PrefixCountersEntry [f10BgpM2PeerIndex f10BgpM2PrefixCountersAfi f10BgpM2PrefixCountersSafi] | +--ro f10BgpM2PeerIndex uint32 | +--ro f10BgpM2PrefixCountersAfi f10-bgp4:F1
www.dell.com | support.dell.
| +--ro f10BgpM2AdjRibsOutEntry [f10BgpM2PeerIndex f10BgpM2NlriAfi f10BgpM2NlriSafi f10BgpM2NlriPrefix f10BgpM2NlriPrefixLen f10BgpM2AdjRibsOutIndex] | +--ro f10BgpM2PeerIndex uint32 | +--ro f10BgpM2NlriAfi f10-bgp4:F10BgpM2Afi | +--ro f10BgpM2NlriSafi f10-bgp4:F10BgpM2Safi | +--ro f10BgpM2NlriPrefix inet:ip-address | +--ro f10BgpM2NlriPrefixLen inet-address:InetAddressPrefixLength | +--ro f10BgpM2AdjRibsOutIndex uint32 | +--ro f10BgpM2AdjRibsOutRoute? snmpv2-tc:RowPointer Module: f10Bg
www.dell.com | support.dell.
| +--ro f10BgpM2PathAttrIndex uint32 | +--ro f10BgpM2LinkLocalNextHopPresent? snmpv2-tc:TruthValue | +--ro f10BgpM2LinkLocalNextHop? inet-address:InetAddress Module: f10BgpM2PathAttrOriginatorIdTable URI: /api/operational/f10BgpM2PathAttrOriginatorIdTable Methods Supported: GET +--ro f10BgpM2PathAttrOriginatorIdTable | +--ro f10BgpM2PathAttrOriginatorIdEntry [f10BgpM2PathAttrIndex] | +--ro f10BgpM2PathAttrIndex uint32 | +--ro f10BgpM2PathAttrOriginatorId? inet:ip-address Module: f10BgpM2Pat
www.dell.com | support.dell.
+--ro f10BgpM2PeerInstance? uint32 +--ro f10BgpM2PeerLocalAddr? inet:ip-address +--ro f10BgpM2PeerRemoteAddr? inet:ip-address +--ro f10BgpM2PeerState? enumeration Module: f10BgpM2BackwardTransition URI: /api/operational/f10BgpM2BackwardTransition Methods Supported: GET --n f10BgpM2BackwardTransition +--ro object-1 | +--ro f10BgpM2PeerInstance? uint32 | +--ro f10BgpM2PeerLocalAddr? inet:ip-address | +--ro f10BgpM2PeerRemoteAddr? inet:ip-address +--ro object-2 | +--ro f10BgpM2PeerInstance?
www.dell.com | support.dell.com Forwarding Plane Statistics 164 The following definition is for displaying the forwarding plane statistics.
| +--ro txPktCOS1? int32 | +--ro txPktCOS2? int32 | +--ro txPktCOS3? int32 | +--ro txPktCOS4? int32 | +--ro txPktCOS5? int32 | +--ro txPktCOS6? int32 | +--ro txPktCOS7? int32 | +--ro txPktUnit0? int32 | +--ro txPktUnit1? int32 | +--ro txPktUnit2? int32 | +--ro txPktUnit3? int32 Module: fp-stats URI: /api/operational/fp-cpu-party-bus-stats Methods Supported: GET +--ro fp-cpu-party-bus-stats | +--ro fp-cpu-party-bus-stats-entry [stackUnitId] | +--ro stackUnitId int32 | +
www.dell.com | support.dell.
Module: fp-stats URI: /api/operational/fp-cos-stats Methods Supported: GET +--ro fp-cos-stats +--ro fp-cos-stats-entry [stackUnitId stackPortId stackPortCOSId] +--ro stackUnitId int32 +--ro stackPortId int32 +--ro stackPortCOSId int32 +--ro currentUsagePerCOS? int32 +--ro defaultPktBufferAlloc? int32 +--ro maxLimitPerCOS? int32 IETF Interfaces The following definition is for configuring and displaying the properties of an interfaces using the IETF.
www.dell.com | support.dell.
| +--ro ifHighSpeed? yang:gauge32 | +--ro ifPromiscuousMode? smiv2:TruthValue | +--ro ifConnectorPresent? smiv2:TruthValue | +--ro ifAlias? smiv2:DisplayString | +--ro ifCounterDiscontinuityTime? yang:timestamp | x--ro ifTestId? smiv2:TestAndIncr | x--ro ifTestStatus? enumeration | x--ro ifTestType? smiv2:AutonomousType | x--ro ifTestResult? enumeration | x--ro ifTestCode? yang:object-identifier | x--ro ifTestOwner? if-mib:OwnerString Module: IF-MIB URI: /api/operational/ifM
www.dell.com | support.dell.
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. The command is sent as an XML payload and the corresponding output or error message of the command is returned in an unstructured format in the XML response. There are three sets of XML commands: • • • config-commands — to send the configuration commands to the system. Commands with sub-modes are allowed within a single XML tag by using the separator \r\n.
www.dell.com | support.dell.com curl -u demo:demo -X POST -T Input.xml http://:8008/api/running/ftos/ _operations/cli
Control Processor: Freescale QorIQ P2020 with 2 Gbytes (2147483648 bytes) of memory, cores(s) 1. 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# Following is the sample output of exec-command: Input.xml: ping 1.1.1.1 curl -u demo:demo -X POST -T Input.xml http://:8008/api/running/ftos/ _operations/cli
