Dell Networking Open Automation Guide 9.10(0.
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. © 2016 Dell Inc. All rights reserved. This product is protected by U.S. and international copyright and intellectual property laws.
Contents 1 About this Guide.............................................................................................................................................9 Audience..............................................................................................................................................................................9 Open Automation Features and Supported Platforms .................................................................................................
BMP Operations on Servers Overview......................................................................................................................... 32 Configuring the DHCP Server Settings.................................................................................................................. 32 DHCP Server IP Blacklist.......................................................................................................................................... 33 MAC-Based Configuration..........
puppet-show.............................................................................................................................................................. 62 puppet-agent..............................................................................................................................................................62 puppet-apply..........................................................................................................................................................
script (run)........................................................................................................................................................................89 script (stop/resume/clear/kill/unschedule).................................................................................................................. 91 script event-handler.....................................................................................................................................................
vsn enable........................................................................................................................................................................128 11 REST API...................................................................................................................................................130 HTTP and HTTPS..........................................................................................................................................................
Interface.....................................................................................................................................................................172 Management Route..................................................................................................................................................174 Prefix-list.............................................................................................................................................................
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).
Platform Bare Metal Provisioning (BMP) Open Management Interface (OMI) Puppet Smart Scripts Virtual Server Networking (VSN) Representational State Transfer Application Programming Interface (REST API) Web Server S6000–ON Y Y Y Y N Y Y Z9500 Y Y Y Y N Y Y MXL Y N N Y Y N Y IOA Y N N N N N N S3100 Series Y N N Y N N N Z9100–ON Y Y Y Y N Y Y C9010 Y N N Y N Y N Conventions To describe command syntax, this document uses the following conventions.
Platform S5000 S6000 S6000–ON MXL Switch Z9500 C9010 S3100 Series (S3124P, S3148P, S3124F, and S3124) Z9100–ON Dell Networking platform and OS Related Documents • Dell Networking OS Command Line Reference Guide for the S5000 System • Dell Networking OS Configuration Guide for the S5000 System • Dell Networking Installation Guide for the S5000 System • Dell Networking OS Command Line Reference Guide for the S6000 System • Dell Networking OS Configuration Guide for the S6000 System • Dell
2 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. The Dell Networking S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S5000, S6000, S6000-ON, Z9500, Z9100–ON, and MXL platforms support the Open Automation framework.
Topics: • Bare Metal Provisioning • Smart Scripting • Virtual Server Networking • REST API • Web Server Bare Metal Provisioning Bare metal provisioning (BMP) provides the following features.
To ensure that network connectivity, quality of service (QoS), and security policies are maintained when you migrate VMs, virtual data centers require a dynamic network infrastructure. To automatically re-provision VMs and associated VLANs during virtual machine migration, VSN facilitates communication between the Dell Networking switches and the VM management software. As a result, VSN greatly simplifies many of the tasks associated with virtualized computing environments.
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, S3100 Series, S4048–ON, S5000, S6000, S6000-ON, Z9100–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.
2 The BMP_BOOT is a special variable in Nonvolatile Random Access Memory (NVRAM) for Industry Standard Upgrade during BMP BOOT process. 3 The BMP_BOOT variable in NVRAM validates the presence of BOOT configuration. 4 If you did not configure BMP_BOOT variable, the system initiates the DHCP process and receives the offer. However, if you did configure BMP_BOOT variable, the system applies and commits the BOOT configurations present in the NORMAL_BOOT variable.
BMP is enabled on the IOA switch. Following are the characteristics of BMP feature in IOA: • The default reload-type maintains as normal reload-type. • The management interface initiates the DHCP discover packets. • IOA switch supports the DHCP image download and upgrade processes. • The switch also supports the DHCP configuration or script file download procedure.
necessary to abort BMP. Press A to abort BMP now. Press C to continue with BMP. Press L to toggle BMP syslog and console messages. Press S to display the BMP status. [A/C/L/S]: NOTE: In the Factory-Default context, the console only accepts A/C/L/S input. • Enter S to display the BMP status (show boot bmp). If you enter another key while BMP is running, it displays the previous message and repeats the process. • Enter A to stop BMP.
BMP Commands and Examples You can configure BMP on supported switches using a series of commands. To enable BMP mode on your switches, and to apply configurations or run scripts using the BMP commands, see 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 The system begins the boot up process in BMP mode (the default mode).
00:02:56: %STKUNIT0-M:CP %BMP-5-BMP_RELEASE_HEADER_INFO: Flash A Image Minor Version : 3 00:02:56: %STKUNIT0-M:CP %BMP-5-BMP_RELEASE_HEADER_INFO: Flash A Image Main Version : 0 00:02:56: %STKUNIT0-M:CP %BMP-5-BMP_RELEASE_HEADER_INFO: Flash A Image Patch Version : 57 00:02:56: %STKUNIT0-M:CP %BMP-2-BMP_DOWNLOAD_START: The Dell Networking OS image download has started. 00:03:29: %STKUNIT0-M:CP %BMP-5-BMP_DOWNLOAD: The Dell Networking OS image download is successful.
BMP Mode: Boot and Set-UP Behavior When you configure a switch to reload in BMP mode, one of the following scenarios may occur.
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: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:02:56: %STKUNIT0-M:CP %BMP-5-BMP_RELEASE_HEADER_INFO: Flash A Image Patch Version : 1216 b If the Dell Networking OS image versions are different, the system stores the downloaded Dell Networking OS image in local flash memory and loads the Dell Networking OS image from flash. This process repeats until the Dell Networking OS image versions match. The system looks for the configuration file on the file server. If the system does not find a configuration file, the download fails.
If a post–configuration script is not present in the applied configuration file, the logs display: 00:03:03: %STKUNIT0-M:CP %SYS-5-CONFIG_LOAD: Loading configuration file. 00:03:04: %STKUNIT0-M:CP %IFMGR-5-ASTATE_UP: Changed interface Admin state to up: Ma 0/0. 00:03:04: %STKUNIT0-M:CP %BMP-5-BMP_POST_SCRIPT_NOT_PRESENT: The Post-Config Script is not present.
• verify the integrity of the Dell Networking OS image the DHCP offer downloads • dynamically decide what types of configurations to apply to your system based on various factors such as network reachability, port status, or neighbor discovery • use LLDP to monitor and generate reports for CPU and memory utilization, port traffic status, and to perform link and topology checking You can provide a pre–configuration script in DHCP option 209 to either configure the switch or download a configuration fil
To check the status of configured ports or protocols, set the host name of the system, or perform additional configuration settings, use the post-configuration script. The system supports post-configuration scripts in EXPECT, TCLSH, and ZSH. If you installed the SmartScripts package in your Dell Networking switches, the system also supports post-configuration scripts in Perl, Python, and Ruby.
• Success–0 — the start-up configuration applies. • Failure–non-zero — the start-up configuration does not apply. • If you reboot the system with the reload-type set as normal-reload and an autoexec script is present in the Flash directory, the following log displays: Starting Dell Networking application 00:00:13: %STKUNIT1-M:CP %RAM-6-ELECTION_ROLE: Stack unit 1 is transitioning to Management unit.
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. 00:00:15: %STKUNIT1-M:CP %CHMGR-5-STACKUNITDETECTED: Stack unit 1 present. The following line indicates the start of the auto-execution script. Script is Started.
The following line indicates the auto-execution script has completed successfully. 00:04:05: %STKUNIT0-M:CP %BMP-5-AUTOEXEC_SUCCESS: The AutoExec Script execution returned Success. The following line indicates that the configuration file is loaded into the switch.
Post-configuration Script – BMP Mode 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"] set {remote_intf(Te 0/1)} "TenGigabitE
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]} { puts "Interface $intf_slot is Connected to $remote_intf($intf_slot)\r\n" puts $fp "Interface $intf_slot is Connected to $remote_intf($intf_slot)\r\n" } else { puts "ERROR: Interface $intf_slot is Not Connected to Interface $remote_intf($intf_slot)\r\n" puts $fp "ERROR:
BMP Operations on Servers Overview The following sections describe how to prepare the different servers for BMP functionality. • Configuring the DHCP Server Settings • File Server Settings • Domain Name Server Settings DHCP Server To configure the DHCP server use the following information. Configuring the DHCP Server Settings Before you can use BMP mode on a switch, first configure a DHCP server. To assign an IP address to the system and other parameters, configure the DHCP server.
• If you enable the reload-type config-scr-download enable command and the configuration file in the offer cannot be downloaded, BMP requests another DHCP offer. DHCP Server IP Blacklist If the process does not complete successfully, the DHCP server IP is blacklisted and the BMP process re-initiates. A DHCP server IP is maintained in the blacklist for 10 minutes. If a DHCP offer is received from the blacklisted DHCP server, the offer is rejected until the IP is alive in the blacklist (10 minutes).
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.
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 Bare metal provisioning commands are supported on the S4810, S4820T, S3048–ON, S3100 series, S4048–ON, S5000, S6000, S6000– ON, Z9100–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.
auto-save Allows you to configure the auto save option for the downloaded configuration or script file which are not saved by default. S4810, S4820T, S3048–ON, S3100 series, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, C9010, IOA, and MXL Syntax auto-save { enable | disable } To reset the auto-save option, use the no auto-save { enable | disable } command. Parameters enable Enable the option to save the downloaded configuration or script file.
Parameters enable Enables the syslog messages in the console while BMP is running. disable Disables the syslog messages in the console while BMP is running. 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. Usage Information Version Description 9.9(0.
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(2.0) Introduced on the S3100 series. 9.8(1.0P1) Introduced on the Z9100–ON 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.
Usage Information Related Commands Version Description 9.9(0.0) Introduced on the C9010. 9.8(2.0) Introduced on the S3100 series. 9.8(1.0P1) Introduced on the Z9100–ON. 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. For an initial setup, the config-scr-download parameter of the reload-type command is enabled.
Related Commands 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, 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). relay Allows you to configure the addition of option 82 in DHCP client packets.
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). 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.
Usage Information Version Description 8.3.19.0 Introduced on the S4820T. To upgrade any NVRAM changes to the chassis caused by the following CLI commands, use the reload conditional nvram-cfg-change command on a switch running BMP. • stack-unit {unit} stack-group • stack-unit {unit} port {fanout-portid} portmode quad • asf-mode • cam-acl • buffer-profile reload-type Allows you to configure the reload-type options in reload-type sub command mode.
Version Description download and user-defined-string commands. Supported platforms are S4810, S4820T, and Z9000. Related Commands 9.0.2.0 Introduced on the S6000. 9.0.0.0 Introduced in Z9000. 8.3.19.0 Introduced on the S4820T. 8.3.1.0 Introduced on the S4810. • show reload-type — displays the current Reload mode (BMP mode or Normal mode). • stop bmp — stops the BMP process and prevents a loop if the DHCP server is not found.
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). 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.
show boot bmp Displays the current state of the BMP process. S4810, S4820T, S3048–ON, S3100 series, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, C9010, and MXL Syntax show boot bmp 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. Example 46 Version Description 9.
... BMP State : BMP process is successfully completed Related Commands reload-type — allows you to configure the reload-type options in reload-type sub command mode. show config Displays the reload type options that are configured on the system. S4810, S4820T, S3048–ON, S3100 series, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, C9010, IOA, and MXL Switch Syntax show config Defaults none Command Modes RELOAD-TYPE CONFIGURATION Command History This guide is platform-specific.
• config-scr-download — allows you to specify whether the configuration or script file needs to be downloaded. • dhcp-timeout — allows you to configure the DHCP timeout limit. • relay — allows you to configure the addition of option 82 in DHCP client packets. • 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.
Usage Information To check the currently configured Auto-Configuration mode (BMP or Normal reload) on a switch running BMP, use the show reload-type command. 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.
Usage Information 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. 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.
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(2.0) Introduced on the S3100 series. 9.8(1.0P1) Introduced on the Z9100–ON. 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.
Usage Information Version Description 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.0) Introduced on the S4810, S4820T, S6000, Z9000, and Z9500.
5 Open Management Infrastructure Dell Networking OS supports the Open Management Infrastructure (OMI) framework. OMI is supported on the S4810, S4820T, S3048– ON, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, 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.
package install “tftp:///OMI-I-9.10.0.0.tar.gz” 5 Enable the REST API. CONFIGURATION mode rest-server http OMI Requirements This section describes the requirements for using OMI: • Operating system and Environment — Any Windows OS that supports the Windows Management Framework 4.0 and PowerShell version 4.0 or higher can be used with OMI. • Server Initial Configuration — DSC configurations are shared in the form of Managed Object Format (MOF) files. • Get the DellNetworkingDSC.
• install-cert — install the given SSL certificates to OMI server • server-opt[options] — invoke omi-server with the given options directly omi-server-show To view the OMI server status, use the omi-server-show script.
Following example uses the name MSFT_NetworkDevice_EthernetPortViewConfig. Configuration MSFT_NetworkDevice_EthernetPortViewConfig { Import-DscResource -Name MSFT_NetworkDevice_EthernetPortView } 7 Node ("") { MSFT_NetworkDevice_EthernetPortView MyPort { PortId = "tengig-0-1" EnabledState = "Enabled" } } • PortId identifies the interface. This example configures tengigabitethernet 0/1. • EnabledState identifies the status of the port.
} } } MSFT_NetworkDevice_EthernetPortViewConfig -OutputPath c:\EthernetPortViewMof The MOF for the node 172.168.1.2 gets stored in the path C:\EthernetPortViewMof. NOTE: Save the PowerShell commands in a file with an extension .ps1 (PowerShell Script) and execute. Push the configuration. PS C:\> Start-DscConfiguration -CimSession $dellBox -Path C:\EthernetPortViewMof -Wait -Force Enumerating an Instance using a winrm Session PS C:\Users\Administrator> winrm e http://schemas.microsoft.
• 2 3 CIM_PhysicalComputerSystemView DesiredStateConfiguration (DSC) • MSFT_NetworkDevice_AclView • MSFT_NetworkDevice_BgpConfigurationView • MSFT_NetworkDevice_BgpPeerView • MSFT_NetworkDevice_ConfigurationView • MSFT_NetworkDevice_EthernetPortView • MSFT_NetworkDevice_MclagConfigurationView • MSFT_NetworkDevice_PolicyMapView • MSFT_NetworkDevice_PortChannelView • MSFT_NetworkDevice_SnmpConfigurationView • MSFT_NetworkDevice_StaticRouteView • MSFT_NetworkDevice_VlanView • MSFT_Net
Cmdlets Description Version Support Update-DscConfiguration Runs the existing configuration on a computer. 4.0 and 5.0 Get-DscconfigurationStatus Retrieves data about completed configuration runs. Not Supported Publish-Dscconfiguration Publishes a DSC configuration to a set of computers, but does not apply it.
6 Puppet Dell Networking OS supports the Puppet automation framework. Puppet Agent is supported on the S4810, S4820T, S3048–ON, S4048– ON, S5000, S6000, S6000–ON, Z9100–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.
Configuring the Puppet Agent To configure the Puppet Agent, use the following steps. 1 Enable the REST API. CONFIGURATION mode rest-server http 2 Configure the username, password, and privilege for puppet. CONFIGURATION mode username puppet password puppet privilege 15 NOTE: Puppet supports only the username puppet for any puppet configurations. 3 Configure script path /usr/pkg/puppet/bin. The script path configuration helps you to configure the unnamed scripts present in the configured path.
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. The default port is 8008. agentrestproto : Protocol (http or https) to be used for rest apis. The default protocol is HTTP. agentrestuser : Username to be used for the rest apis. The default username is the Puppet user.
Building the Manifest File Puppet consists of a custom declarative language to describe the system configuration, which can be either applied directly on the system or compiled into a catalog and distributed to the destination system via the client-server paradigm (using REST API). The agent uses the system–specific providers to enforce the resource specified in the manifests.
} } lacp => (active | disabled | passive), minimum_links => minimum Physical Interface Configuration Apply the physical interface configurations using both the Puppet Standalone and Puppet Agent. You can read and write the physical interface configuration by using the netdev_interface type.
Setting up the Puppet Master Puppet uses the client-server model. The client-server regularly connects to the master server to synchronize their configurations and to report the changes, if any, back to the central nodes. When you install or upgrade Puppet, you must upgrade the Puppet Master component first. To install and set up the Puppet Master, follow these steps: 1 Install the Ruby script. sudo yum install ruby 2 Add the puppet repository. sudo rpm -ivh http://yum.puppetlabs.
7 Smart Scripting Smart Scripting is supported on the S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, C9010, and MXL switch platforms. Smart Scripting is not supported on the M 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 also offers solutions in a UNIX environment useful to cloud administrators who are familiar with working in a UNIX shell. Smart Script support in a UNIX environment allows you to invoke standard UNIX utilities like netstat, tcpdump, ls, chmod, chown, and so on. 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.
• Web-Server with HTTP support (see Web Server with HTTP Support). Installing Smart Scripting After you download the Smart Scripts package, install the file from local flash memory on a switch or from an external drive on a network server. Because the installation takes time, installing Smart Scripting performs in the background. When the download completes, a message displays on the console. The package installation updates the running configuration file.
show packages system Uninstalling Smart Scripting Uninstalling the Smart Scripting package removes it from the internal flash memory. CAUTION: Before you uninstall the Smart Scripting package, stop all scripts that are running using the no script scriptname command. You must also manually stop the HTTP server daemon. NOTE: If installed, uninstall the VSN Agent package before uninstalling the Smart Scripting package. • Uninstall the Smart Scripting package stored on the switch.
crossed - Sending CPU Usage Analyser Report. The CPU Percentage at which Script got Triggered is $env(DELL_TRGEVT_CPU)" } "MEMORY" { set data "Sending Mail : Triggered Event is $env(DELL_TRGEVT_NAME) Memory Limits Crossed - Sending Memory Usage Analyser Report. The MEMORY Percentage at which Script got Triggered is $env(DELL_TRGEVT_MEM)" } } puts $fileId $data close $fileId Dell Proprietary Utilities Dell Networking OS provides the following utilities which are unique and helpful while scripting.
Sample script for dellsh in Python #! /usr/pkg/bin/python import os os.system("dellsh '/usr/pkg/ss-scripts/dellsh.txt'") Sample script for dellsh in Python for S3100 Series #! /f10/flash/pkg/usr/pkg/bin/python import os os.system("dellsh '/f10/flash/pkg/ss-scripts/dellsh.txt'") Dellsh can also be used as Dell#script execute dellsh args /usr/pkg/ss-scripts/dellsh.txt In S3100 Series, Dellsh can also be used as Dell#script execute dellsh args /f10/flash/pkg/ss-scripts/dellsh.
Sample script for dellsyslog in Python for S3100 Series #! /f10/flash/pkg/usr/pkg/bin/python import sys import os print sys.argv[1] os.system("dellsyslog -s %s 'The Syslog is generated by python'" %(sys.
Sample script for Perl using DellExec, DellCli, and DellConfig (S3100 Series) #! /f10/flash/pkg/usr/pkg/bin/perl #importing DellSSUtils require "/f10/flash/pkg/usr/pkg/scripts/DellSSUtils/DellSmartUtils.pl"; #Assigning Value to the vairable which is used as an argument to the #dell library functions $cli = "show version"; $script = "/f10/flash/pkg/usr/pkg/scripts/sample_scripts/sum.py"; $args = "1 2 3"; $ExtraArgs = "10"; @list = ("interface vlan $ARGV[0]", "no shutdown", "ip address $ARGV[0].$ARGV[0].
• 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. NET SNMP Client To manage the device using the simple network management protocol (SNMP) through scripts, the Dell Networking OS supports the NetSNMP client.
System Attributes Value Description memory from processes that are exceeding their declared resident set size. memorylocked 77,741 Maximum size (in bytes) which a process may lock into memory using the mlock(2) function. maxproc 160 Maximum number of simultaneous processes allowed for the user ID. openfiles 64 Maximum number of open files for this process. Supported UNIX Utilities Smart Scripting supports the invocation of the following UNIX utilities in the scripts you use.
UNIX Utility Function ls List directory contents. md5 Calculates and verifies 128-bit MD5 hashes. more Filter for browsing text files. netstat Show the network status nice Execute a utility with an altered scheduling priority. nohup Invoke a command immune to hangups. paste Join files horizontally. ping Send ICMP ECHO_REQUEST packets to the network hosts. ps Process status. pwd Return working directory name. sed Stream editor. sleep Suspend execution for an interval of time.
Logging in to a NetBSD UNIX Shell To log in to 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. • Access the shell to run UNIX commands or a script (see Running a Script from the UNIX Shell).
The script path can contain a network file-system-mounted directory (defined in the mount nfs command). The path is added to a script search list, allowing the system to search all locations for the script name. If the script is in multiple locations, the system uses the first instance of the script found. Scheduling and Executing Scripts Schedule scripts to execute periodically, based on an event and a specific time, such as at boot up or after you configure the switch.
script trigger-event event-name {log-event [{tag—or—ex tags | tag-and-ex tags}] [severity severity level]} | time-event {[start {at date-time | after time}] [stop {at date-time | after time | count number}] [interval time] [weekday day] [ month month] [monthday nday]} | cpuusage percentage | mem-usage percentage} Following example shows the event to trigger a script at 22:22 and then triggers every Monday midnight and stops at 02:02–11/10/14: Dell(conf)#script trigger-event Event2 time-event start at 22:22
Managing Executed Scripts Use any of the following commands to manage or control the scripts; for example, stop, kill, resume, unscheduled, and clear. Protect system resources by scheduling scripts to run when resources are within the threshold parameters you configured. System resources include the switch CPU, memory, and file system.
NOTE: For information about running a script directly from a UNIX shell without using the Dell Networking OS CLI, see Running a Script from the UNIX Shell. 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.
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 (see Creating a Username and Password for Smart Scripting). If you do not specify a user name, the script runs with the privileges of the configured user.
8 Smart Scripting CLI Smart Scripting is supported on the S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, C9010, and MXL platforms. Smart Scripting is not supported on the M IOA, FN IOA, and FN IOM platforms.
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. The following is a list of the Dell Networking OS version history for this command. Version Description 9.10(0.0) Introduced on the S3100 Series. 9.9(0.0) Introduced on the C9010. 9.8(1.0P1) Introduced on the Z9100–ON. 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.
Version Description 9.7(0.0) Introduced on the S4810, S4820T, S5000, S6000, S6000–ON, Z9000, Z9500, and MXL. mount nfs Share the network file system the local Dell Networking OS file system uses. S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, C9010, and MXL 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.
Usage Information • All the mount points are maintained in the /f10/mnt/nfs folder. • Only the relative path (mount point name) is acceptable. If the path you enter is either complete or absolute, an error occurs. • If the mount point exists under the f10/mnt, you can reuse it or it is created under /f10/mnt/nfs and used. NOTE: The NFS server exportfs setting must include the insecure keyword. root@administrator-X8DTU-6:/usr# exportfs -v /home/admin 1.1.0.
package install Installs the Smart Scripting package. This command downloads the package from the specified location and installs it in the internal flash memory on a switch.
Usage Information Because installing an Open Automation package may take time, the installation performs in the background when the download finishes. A message displays on the console when the installation is complete. To follow the progress of a package installation, use the show packages command. package uninstall Removes an installed Open Automation package, such as Smart Scripting, from the system.
CAUTION: Before you uninstall the Smart Scripting package, first stop all scripts that are running using the no script script-name command. Manually stop the http-server daemon by using the no http-server {http | secure-http} command. To follow the uninstall progress, use the show packages command. Related Commands show packages — displays all Open Automation packages installed on the switch. script (run) Runs an Expect, Perl, Python, Ruby, Tcl, UNIX, and ZSH shell script from the Dell Networking OS CLI.
Usage Information Version Description 9.8(1.0P1) Introduced on the Z9100–ON. 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.1) Introduced on the Z9500. 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.
script (stop/resume/clear/kill/unschedule) Stops, resumes, clears, kills, or unschedules an Expect, Perl, Python, Ruby, Tcl, UNIX, and ZSH shell script from the Dell Networking OS CLI. S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, C9010, and MXL Syntax Parameters 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.
Usage Information Version Description 9.2(0.0) Introduced on the S4810, S4820T, Z9000, and MXL Switch. Use the keyword unschedule only on scripts that are not currently running and that were scheduled using the script execute command in EXEC mode. script event-handler Allows you to provide mapping between the scripts and trigger events.
script execute (EXEC mode) Schedules the scripts from EXEC mode either to run in foreground or background. S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, C9010, and MXL Syntax script execute script-name [start {at | date-time | after time}] [stop {at date-time | after time}] [bg] [arguments arg[..arg]] [username username] To cancel, use the script unschedule command. Parameters script-name Enter the name of the script to schedule for execution.
Usage Information Example 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. All times selected follow the system time of the switch. The maximum number of scripts to configure is 100.
stop at datetime (Optional) Enter the keywords stop at date-time with the time and date either in HH:MM-MM/DD/YY format to stop running the script or in HH:MM format to stop the script at the specified time on the same day. The date must be a future date. stop after time (Optional) Enter the keywords stop after time then the time in [HHHH:] MMMM format to indicate the time after which the script stops running.
script get Copies a script to a switch. S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, C9010, and MXL Syntax script get url Parameters 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 Configures the path for the script on the switch.
Usage Information The path can contain a network file system (NFS) mounted directory (see the mount nfs command). The path is added to a script search list allowing the system to search all locations for the script name. If the script is in multiple locations, the system uses the first instance of the script found. Related Commands mount nfs — sets up the folders in the NFS-mounted directory. script remove Removes a script from a switch.
script trigger-event Configures the event that causes the script to run.
count number Enter the keyword count then the number of times to trigger the script event. The range is from 1 to 100. interval time Enter the keyword interval then the time in [HHHH:] MMMM format, in minutes, to schedule the script execution interval. weekday day Enter the keyword weekday then the day of a week to run the script. Select one or more days from the following values: mon, tue, wed, thu, fri, sat, and sun. Separate each day by commas.
NOTE: The time-events schedule time takes effect once after the device configures the trigger-event (event). A single trigger event can contain combinations of interval, weekday, month, and month day. Related Command script event-handler — Allows you to provide mapping between the scripts and trigger events. Examples Following example shows how the event triggers a script, even if any one of the pattern matches.
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 Version Description 9.10(0.0) Introduced on the S3100 Series. 9.9(0.0) Introduced on the C9010. 9.8(1.0P1) Introduced on the Z9100–ON. 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.0P2) Introduced on the S3048–ON. 9.7(0.
version 0.97 Class::Inspector 1.27 Task::Weaken 1.04 Algorithm::Diff 1.1902 Text::Diff 1.41 SOAP::Lite 0.714 Crypt::SSLeay 0.58 URI::urn::uuid 0.03 UUID 0.03 Crypt::SSLeay 0.58 Net::SNMP 6.0.1 Net::Telnet::Cisco 1.10 DBI 1.623 Ruby 1.9.3-p545 libxml-ruby 2.3.0 mime-types 2.3 netrc 0.7.7 rest-client 1.6.7 HTTP Server mini_httpd 1.21 Perl and Python function library for Dell Networking SmartScripts smartutils 2.0.0 DellSSUtils 1.0.0 WebConnect Web UI and CGI scripts htdocs 2.0.0 NetSNMP 5.7.
show script Displays the stored, scheduled, and running scripts. S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, C9010, and MXL Syntax show script {file | process | watch} | [detail] Parameters 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.
start shell Starts a NetBSD UNIX shell. S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, C9010, and MXL Syntax start shell 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. Usage Information Version Description 9.10(0.
triggered-by Allows you to associate the events to a script in Event Handler Configuration mode. S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, C9010, and MXL Syntax triggered—by trigger-name Parameters trigger-name Enter the name of the script event to trigger. Defaults none Command Modes SCRIPT EVENT HANDLER CONFIGURATION Command History This guide is platform-specific.
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. Only /usr/pkg is monitored. Defaults none 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.
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. The following is a list of the Dell Networking OS version history for this command. Usage Information Example Version Description 9.10(0.0) Introduced on the S3100 Series. 9.9(0.0) Introduced on the C9010. 9.8(1.0P1) Introduced on the Z9100–ON. 9.8(0.
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. Usage Information Version Description 9.10(0.0) Introduced on the S3100 Series. 9.9(0.0) Introduced on the C9010. 9.8(1.0P1) Introduced on the Z9100–ON. 9.8(0.0P5) Introduced on the S4048–ON. 9.8(0.
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.
Dell Networking OS supports up to eight hypervisor sessions. A hypervisor session can consist of a single hypervisor unit (ESX, ESXi, XenServer) or a centralized hypervisor (vCenter, Xenpool). To manage a single VMware hypervisor, use a vSphere client. A vCenter server is a centralized management server for managing multiple VMware hypervisors. Figure 2. Virtual Server Networking Example For any change, VSN subscribes use hypervisor to notify the switch.
Install VSN 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 loads into the Dell Networking OS. NOTE: VSN is only supported on standalone switches; it is not supported in stacked configurations. Install the VSN package file in the same way you install a Dell Networking OS release — directly from local flash memory on a switch or from an external drive on a network server.
• VSN is only supported on standalone units; it is not supported in stacked configurations. • 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, configure the server’s firewall to allow connections only through the management IP address.
Changing VSN Settings After you enable VSN on an interface and enable a hypervisor session that connects to hypervisors on network servers, you can change the mode setting when the session is active. You cannot, however, change the type and access settings if the session is active. To change these settings, follow these steps. 1 In Hypervisor Configuration mode, stop the session by entering the disable command.
• If connectivity with the hypervisor is re-established within three minutes after the loss of connectivity, the following log message displays and the retrieved information is retained: Xen-Citrix:Reestablished connection with hypervisor xen217. • If connectivity with the hypervisor is not re-established within three minutes after the loss of connectivity, the following log message displays.
CONFIGURATION mode no hypervisor name Enter the name of the hypervisor session that you want to remove. 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.
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.
10 Virtual Server Networking CLI The Virtual Server Networking commands are supported on the S4810, S4820T, S5000, and MXL platforms. NOTE: VSN is supported only on standalone switches and VMware virtual distributed switches (VDS); it is not supported in stacked configurations.
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 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.
hypervisor Specifies the name of a hypervisor session with which VSN connects. S4810, S4820T, S5000, and MXL Switch Syntax [no] hypervisor name 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.
Defaults config 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. Usage Information 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.
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 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.
Related Commands show packages — displays all the packages installed in the system. script To retrieve virtual server configurations and update Dell Networking OS settings on the switch, run an installed VSN script (Perl or Python) on active Hypervisor links. S4810, S4820T, S5000, and MXL Switch Syntax [no] script script-name To stop a running script, enter the no script script-name 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.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.
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.03 Algorithm::Diff 1.1902 Text::Diff 1.37 SOAP::Lite 0.712 Crypt::SSLeay 0.57 URI::urn::uuid 0.03 UUID 0.03 Crypt::SSLeay 0.57 Net::SNMP 6.0.0 Net::Telnet::Cisco 1.10 HTTP Server mini_httpd 1.
virtualswitchname Display information on a specified virtual switch by entering the name the Hypervisor generates. 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. Usage Information Version Description 9.6(0.0) Introduced on the S5000. 9.2(0.
show vmmap Displays the virtual machines accessed on a switch interface. S4810, S4820T, S5000, and MXL Switch Syntax Parameters show vmmap interface 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.
type Sets the hypervisor type to VMware or Xen-Citrix. S4810, S4820T, S5000, and MXL Switch Syntax [no] type {vmware | xen-citrix} Parameters 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.
Usage Information Version Description 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. 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.
11 REST API 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, S6000, S6000–ON, Z9100–ON, C9010, S5000, 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).
• shallow — Retrieves a resource with no subresources inline. • select — Client uses to select the nodes and subresources. • with-defaults — Client uses to control and display the default data in GET request. To request a filtered partial response, use the select query parameter in the following patterns to specify the nodes and subresources. • Use a semicolon separated list to select multiple nodes. • Use a/b to select a node b that is nested within node a.
> > > > < < < < < < < < < < < < * * 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.2 Cache-control: private, no-cache, must-revalidate, proxy-revalidate Date: Thu, 04 Dec 2014 13:13:25 GMT Allow: GET, POST, OPTIONS, HEAD Content-Length: 0 Content-Type: text/html Etag: 1417-698805-339353@0 Connection #0 to host 10.16.151.
* 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.159) port 8008 * Server auth using Basic with user 'admin' > POST /api/running/dell/router 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: 493 > Expect: 100-continue > < HTTP/1.1 100 Continue < Server: ConfD/5.
100 11.1.1.3 200 false false curl -v -u admin:admin http://10.16.151.159:8008/api/running/dell/router/bgp -X PATCH -T BGP_HTTP_REST_PATCH_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.
11.1.1.2 200 false false 11.1.1.3 200 false false
Status Error Codes Description 409 Conflict This code is used if a request tries to create a resource that already exists. 415 Unsupported Media Type The format of the request is not supported. 500 Internal Error The server encountered an unexpected condition which prevented it from fulfilling the request. 501 Not Implemented The server does not (currently) support the functionality required to fulfill the request.
Configurations This section describes the properties of all the configurations. BGP The following definition configures and displays the properties of a BGP configuration.
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 138 +--rw description? string +--rw timers | +--rw bgp | +--rw keepalive? dell:seconds | +--rw hold-time? dell:seconds +--rw maximum-paths | +--rw ebgp? uint32 | +--rw ibgp? uint32 +--rw network [ipv4-address] | +--rw ipv4-address dell:ipv4-address-with-prefix | +--rw route-map? dell:route-map-name | +--rw backdoor? boolean +--rw peer-group [peer-group-name] | +--rw
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +--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-as? | | +--rw as-
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 140 | +--rw level? enumeration | +--rw metric? uint32 | +--rw route-map? dell:route-map-name +--rw address-family [family-type vrf] +--rw family-type enumeration +--rw vrf dell:vrf-name +--rw bgp? | +--rw asnotation? enumeration | +--rw always-compare-med? boolean | +--rw bestpath? | | +--rw as-path? enumeration | | +--rw med? | | | +--rw confed? boolean | | | +--rw
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +--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? enumerat
| +--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? 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? enumera
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? boolean | | +--rw relay? | | +--rw info-option? boolean | +--rw helper-address? | +--rw hop-count? boolean | +--rw multicast-map? | +--rw ip-address ip-address | +--rw bcast-address ip-address IP
IP Prefix-List Configuration Model +--rw dell +--rw ip +--rw prefix-list [name] | +--rw name dell:prefix-list-name | +--rw description? string | +--rw rules [seq-num] | +--rw seq-num uint32 | +--rw action ip-prefix-list-action-types | +--rw ip-prefix union | +--rw prefix-min-len? uint32 | +--rw prefix-max-len? uint32 IPv4 ACL The following definition configures and displays the properties of IPv4 ACL.
IPv6 ACL The following definition configures and displays the properties of IPv6 ACL.
• • fortyGigE • GigabitEthernet • TwentyfiveGigabitEthernet • FiftyGigabitEthernet • HundredGigabitEthernet • peGigabitEthernet Example: tengig-0–0, fortygig-0–48, gige-1–10, twentyfivegig-1–3–1, fiftygig-1–5–1, hundredgig-1–2–1, pegig-1–2–2 . • Management: mgmt-- Example: mgmt-5–0 2 Logical Interface: - • The can be vlan, port-channel, loopback, or management.
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +--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) | | +--rw shutdown-offending boolean |
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 148 | | +--rw address dell:ipv4-address-with-prefix | +--rw access-group? | | +--rw in? | | | +--rw acl-name access-list-name | | | +--rw implicit-permit? boolean | | | +--rw (ip-action)? | | | +--:(vlan) | | | | +--rw vlan* vlan-range | | | +--:(optimized) | | | | +--rw optimized? boolean | | | +--:(vrf) | | | +--rw vrf? dell:vrf-name | | +--rw out? | | +--rw acl-na
| | | | +--:(vlan) | +--rw vlan* +--:(optimized) +--rw optimized? vlan-range boolean IPv6 Global Configurations The following definition displays the entries of IPv6 global configurations: Module: IPv6 URI: /api/operational/dell/ipv6 Methods Supported: GET, POST, PUT, PATCH, and DELETE IPv6 Global Configuration Model +--rw ipv6 +--rw route* [ipv6-address-with-prefix exit-interface next-hop] | +--rw ipv6-address-with-prefix dell:ipv6-address | +--rw exit-interface union | +--rw next-hop union | +--rw
+--rw interface [name] +--rw name dell:interface-name +--rw tunnel? | +--rw allow-remote* dell:ip-address | +--rw destination? dell:ip-address | +--rw dscp? | | +--rw (dscp-action)? | | +--:(dscp-mapped) | | | +--rw mapped? empty | | +--:(dscp-val) | | +--rw dscp-value? uint32 | +--rw flow-label? uint32 | +--rw hop-limit? uint32 | +--rw keepalive? | | +--rw address dell:ip-address | | +--rw attempts? | | | +--rw unlimited? empty | | | +--rw retries? uint32 | | +--rw interval? uint32 | +--rw mode? | | +--rw
| +--rw unnumbered? +--rw shutdown? dell:interface-name boolean MAC ACL The following definition configures and displays the properties of MAC ACL.
+--rw ip-address-prefix union +--rw (exit-value)? +--:(exit-interface) | +--rw exit-interface? dell:mgmt-route-intf-types +--:(next-hop) +--rw next-hop? inet:ip-address Policy Based Routing (PBR) Use the following definition to configure and display the properties of PBR: Module: PBR URI: /api/running/dell/redirect-list Methods Supported: GET, POST, PUT, PATCH, and DELETE PBR Configuration Model +--rw dell +--rw system +--rw interfaces +--rw router +--rw management +--rw ip | +--rw redirect-list [name
| +--ro log? boolean | +--ro monitor? boolean | +--ro order? uint32 +--ro ip [name] +--ro name access-list-name +--ro type? access-list-types +--ro ip-acl-filter [seq-no] +--ro seq-no uint32 +--ro filter-type? acl-rule-types +--ro protocol? ip-protocols +--ro ip-protocol-number? uint32 +--ro src-ip-filter? acl-incoming-address-filter-types +--ro source-ip-address? inet:ipv4-address +--ro source-mask? inet:ipv4-address +--ro src-operator? ip-acl-operators +--ro srcport? uint32 +--ro srcportrange? layer4-port
| +--rw rspan-intf-type? enumeration | +--rw rspan-intf-tagged? boolean | +--rw rspan-remote-vlan? dell:vlan-id-num +--rw erspan-params? | +--rw source-ip? dell:ipv4-no-prefix | +--rw destination-ip? dell:ipv4-no-prefix +--rw disable? boolean +--rw flow-based? boolean Route Maps The following definition configures and displays the properties of a Route Map: Module: ROUTE MAP URI: /api/running/dell/route-map Methods Supported: GET, POST, PUT, PATCH, and DELETE Route Map Configuration Model +--rw route-
Weighted ECMP The following definition configures and displays the properties of Weighted ECMP: Module: WEIGHTED ECMP URI: /api/running/dell/ip/ecmp Methods Supported: GET, PATCH, PUT, POST, and DELETE Weighted ECMP Model +--rw ip | +--rw ecmp! | +--rw weighted? boolean Operational This section describes the properties of all the IPv4 operational data.
| +--ro network-prefix inet:ip-address | +--ro network-prefix-len inet-address: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? enumeration | +--ro origin-code? enumeration | +--ro is-nlre-loc-aggtd? snmpv2-tc:TruthValue | +--ro is-stale? snmpv2-tc:TruthValue | +--ro status-code? enumeration | +--ro best-route?
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +--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 prefix-denied? uint32 | +--ro addr-withdrawn-from-peer? uint32 | +--ro addr-withdrawn-by-peer? uint32 | +--ro martian-addr-ignored? boolean | +--ro restart-time-adver-peer? uint32 | +--ro restart-time-rece-peer? uint32 | +--ro stale-path-time-config-peer? uint32 | +--ro graceful-restart-role-recv-only? string | +--ro graceful-restart-role-adver-only? string | +--ro restart-time-adv? uint32 | +--ro restart-time-rcv? uint32 | +--ro route-reflector-client? string | +--ro soft-reconfig-inbound? boolean
+--ro unicast | +--ro local-rib | | +--ro routes-added? uint32 | | +--ro routes-replaced? uint32 | | +--ro routes-withdrawn? uint32 | | +--ro router-id? dell:ipv6-address-with-prefix | +--ro prefix-list [network-prefix next-hop-addr] | +--ro network-prefix dell:ipv6-address-with-prefix | +--ro next-hop-addr dell:ipv6-address-with-prefix | +--ro status-code? bgp-status-code | +--ro best-route? boolean | +--ro path-source? bgp-path-source | +--ro metric? string | +--ro local-pref? string | +--ro weight? uint3
| +--ro weight? uint32 | +--ro as-path-string? string | +--ro origin-code? bgp-origin-code +---x community-list | +--ro input | | +--ro community-list-name? bgp-list-name | +--ro output | +--ro community-list [community-list-name] | +--ro community-list-name bgp-list-name | +--ro local-rib | | +--ro routes-added? uint32 | | +--ro routes-replaced? uint32 | | +--ro routes-withdrawn? uint32 | | +--ro router-id? dell:ipv6-address-with-prefix | +--ro prefix-list [network-prefix next-hop-addr] | +--ro network-pre
| | +--ro filter-list? string | +--ro output | +--ro flap-statistics | +--ro local-rib | | +--ro routes-added? uint32 | | +--ro routes-replaced? uint32 | | +--ro routes-withdrawn? uint32 | | +--ro router-id? dell:ipv6-address-with-prefix | +--ro routes [network from] | +--ro network dell:ipv6-address-with-prefix | +--ro from dell:ipv6-address | +--ro status-code? bgpv6-status-code | +--ro best-route? boolean | +--ro flaps? uint8 | +--ro duration? hour-minute-second | +--ro reuse? hour-minute-second | +--ro
+--ro decapsulate-any? boolean +--ro source? string +--ro source-ip-address? dell:ip-address-any +--ro destination-ip-address? dell:ip-address +--ro dscp-mapped? boolean +--ro dscp? uint32 +--ro flow-label? uint32 +--ro hop-limit? uint32 +--ro keep-alive? boolean +--ro ka-destination-address? dell:ip-address +--ro ka-interval? uint32 +--ro ka-attempts-type? keep-alive-attempt-types +--ro ka-attempts? uint32 +--ro ka-state? keep-alive-states +--ro ka-state-last-modified? string +--ro allow-remote-enabled? bo
+--ro in-pkts-in-pkts-per-sec? yang:counter32 +--ro in-cent-line-rate? yang:counter32 +--ro out-pkts-in-mbps? yang:counter32 +--ro out-pkts-in-pkts-per-sec? yang:counter32 +--ro out-cent-line-rate? yang:counter32 +--ro discontinuity-time? yang:timestamp +--ro owner? enumeration +--ro member-interfaces | +--ro interface* [name] | +--ro name dell:phy-intf-name | +--ro oper-status? enumeration +--ro min-links? uint32 +--ro vlan-name? vlan-name IP Route Use the following definition to get the Route statistics:
IP Interface Operational Model +--ro ip +--ro interface* [name] +--ro name string +--ro description? string +--ro type? ianaiftype-mib:IANAifType +--ro if-admin-status? enumeration +--ro if-oper-status? enumeration +--ro ip | +--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? enumera
IPv6 ACL Use the following definition to get the IPv6 ACL operational data.
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-status
+--ro rule-entry [cam-index] +--ro cam-index +--ro port? +--ro vlan-id? +--ro protocol? +--ro tcp-flag* +--ro source-port? +--ro destination-port? +--ro source-ip? +--ro destination-ip? +--ro nexthop-mac? +--ro egress-port? uint32 uint32 dell:vlan-id-num-with-default dell:ip-protocols-type tcp-bits uint32 uint32 string string string string Port Mirroring Use the following model to get the Port Mirroring operational data: Module: STATS URI: /api/operational/dell/stats/monitor-session Methods Supported:
| +--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-operator? mac-acl-encap-operators | +--ro encapsulation-protocol? string | +--ro count-type? acl-rule-count-types | +--ro egress-count-value? uint32 | +--ro ingress-count-value? uint32 | +--ro log? boolean | +--ro monitor? boolean | +--ro order? uint32 +--ro
| +--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? string | +--ro jumbo-capable? boolean | +--ro poe-capable? boolean | +--ro fips-mode? boolean | +--ro boot-flash? string | +--ro memory-size? uint32 | +--ro temperature? int32 | +--ro voltage? voltage-status | +--ro serial-num
System Alarm Model +--ro alarms +--ro major-alarms [index] | +--ro index uint32 | +--ro alarm-description? string | +--ro duration? yang:timestamp +--ro minor-alarms [index] | +--ro index uint32 | +--ro alarm-description? string | +--ro duration? yang:timestamp +--ro alarm-thresholds [unit-number] +--ro unit-number uint32 +--ro minor? uint32 +--ro minor-off? uint32 +--ro major? uint32 +--ro major-off? uint32 +--ro shutdown? uint32 System Inventory The following definition displays the Inventory details: Mo
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 chassis-type? string +--ro processor-type? string +--ro flash-info? string +--ro card-info [index] | +--ro index uint32 | +--ro card-info-detail? string +--ro card-if-info [index] +--ro index uint32 +--ro card-if-info-detail? string VLAN The following definition is for displaying VLAN operations: Module: STATS URI: /api/o
Interface Model for IPv6 +--ro interface* [interface-name] +--ro interface-name dell:interface-name +--ro description? string +--ro if-admin-status? dell:admin-status +--ro if-oper-status? dell:oper-status +--ro port-down-cause? string +--ro stateless-address-autoconfig? boolean +--ro ipv6-status? boolean +--ro link-local-ipv6-address? dell:ipv6-address +--ro global-unicast-ipv6-address* [address] | +--ro address dell:ipv6-address-with-prefix | +--ro configuration-type? enumeration | +--ro remaining-life-ti
| | | | | | | | | | +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro errs-addr-unreach? errs-port-unreach? errs-pkt-too-big? errs-time-ex-trans? errs-time-ex-frags? errs-hdr-field? errs-unrec-nxt-hdr? errs-unrec-opt? errs-redirect? errs-unknown? yang:counter32 yang:counter32 yang:counter32 yang:counter32 yang:counter32 yang:counter32 yang:counter32 yang:counter32 yang:counter32 yang:counter32 Management Route Use the following definition to get the statistics of IPv6 Management Route.
+--ro +--ro +--ro +--ro +--ro +--ro +--ro seq-num action? ipv6-prefix? ipv6-mask? ge? le? hit-count? uint32 enumeration dell:ipv6-address-with-prefix dell:ipv6-address-with-prefix uint32 uint32 uint32 Route Use the following definition to get the IPv6 Route statistics: Module: ROUTE URI: /api/operational/dell/stats/ipv6/route Methods Supported: GET Route Model for IPv6 +--ro route +--ro gateway-of-last-resort? string +--ro route-entry* [destination] | +--ro destination dell:ipv6-address-with-prefix
BGP V2 Model +--ro mib +--ro bgp4-v2 +--ro dellNetBgpM2 | +--ro dellNetBgpM2CapabilitySupportAvailable? snmpv2-tc:TruthValue | +--ro dellNetBgpM2AsSize? enumeration | +--ro dellNetBgpM2LocalAs? inetaddress:InetAutonomousSystemNumber | +--ro dellNetBgpM2LocalIdentifier? inet:ip-address | +--ro dellNetBgpM2RouteReflector? snmpv2-tc:TruthValue | +--ro dellNetBgpM2ClusterId? mib:dellNetBgpM2Identifier | +--ro dellNetBgpM2ConfederationRouter? snmpv2-tc:TruthValue | +--ro dellNetBgpM2ConfederationId? inetaddress:
| +--ro dellNetBgpM2PeerInTotalMessages? yang:counter32 | +--ro dellNetBgpM2PeerOutTotalMessages? yang:counter32 | +--ro dellNetBgpM2PeerFsmEstablishedTrans? yang:counter32 | +--ro dellNetBgpM2PeerInKeepalives? yang:counter32 | +--ro dellNetBgpM2PeerOutKeepalives? yang:counter32 | +--ro dellNetBgpM2PeerInOpen? yang:counter32 | +--ro dellNetBgpM2PeerOutOpen? yang:counter32 | +--ro dellNetBgpM2PeerInRteRefresh? yang:counter32 | +--ro dellNetBgpM2PeerOutRteRefresh? yang:counter32 | +--ro dellNetBgpM2PeerReflec
| +--ro dellNetBgpM2NlriOpaqueType? enumeration | +--ro dellNetBgpM2NlriOpaquePointer? snmpv2-tc:RowPointer | +--ro dellNetBgpM2RouteFlag? enumeration +--ro dellNetBgpM2AdjRibsOutTable* [dellNetBgpM2PeerIndex dellNetBgpM2NlriAfi dellNetBgpM2NlriSafi dellNetBgpM2NlriPrefix dellNetBgpM2NlriPrefixLen dellNetBgpM2AdjRibsOutIndex] | +--ro dellNetBgpM2PeerIndex uint32 | +--ro dellNetBgpM2NlriAfi mib:dellNetBgpM2Afi | +--ro dellNetBgpM2NlriSafi mib:dellNetBgpM2Safi | +--ro dellNetBgpM2NlriPrefix inet:ip-address |
+--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro StatusCode? BestRoute? PathSource? OriginCode? RouteFlapCount? RouteFlapDuration? ReuseDuration? AsPathString? enumeration snmpv2-tc:TruthValue enumeration enumeration uint32 yang:timeticks yang:timeticks snmp-framework:SnmpAdminString Forwarding Information Base (FIB) The following definition displays the properties of interfaces using MIBs FIB: Module: FIB URI: /api/operational/mib/fib Methods Supported: GET MIBs FIB Model +--ro mib +--ro fib +--ro d
| +--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 rxPktCOS6? int32 | +--ro rxPktCOS7? int32 | +--ro rxPktUnit0? int32 | +--ro rxPktUnit1? int32 | +--ro rxPktUnit2? int32 | +--ro rxPktUnit3? int32 | +--ro transmitted? int32 | +--ro txRequested? int32 | +--ro txDescriptor? int3
| +--ro stackUnitId int32 | +--ro portPipe int32 | +--ro totalPktBuffer? int32 | +--ro currentAvailableBuffer? int32 | +--ro packetBufferAlloc? int32 +--ro fp-port-stats-table* [stackUnitId stackPortId] | +--ro stackUnitId int32 | +--ro stackPortId int32 | +--ro currentUsagePerPort? int32 | +--ro defaultPktBufferAlloc? int32 | +--ro maxLimitPerPort? int32 +--ro fp-cos-stats-table* [stackUnitId stackPortId stackPortCOSId] +--ro stackUnitId int32 +--ro stackPortId int32 +--ro stackPortCOSId int32 +--ro curren
+--ro ifHCOutOctets? yang:counter64 +--ro ifHCOutUcastPkts? yang:counter64 +--ro ifHCOutMulticastPkts? yang:counter64 +--ro ifHCOutBroadcastPkts? yang:counter64 +--ro ifLinkUpDownTrapEnable? enumeration +--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--
• exec-command — to configure the exec commands on the system. NOTE: Interactive CLIs (for example, clear counters, reload, and so on) are not supported via the REST API framework. Also, the commands sent in XML payload are restricted to a maximum of 1000 characters length. To execute REST-CLI on the device, the HTTP username and password needs the appropriate privilege. The REST-CLI request returns HTTP/1.1 200 OK on a successful completion. All the other HTTP error codes are treated as failure.
Samples of the EXEC command Following is the sample output of EXEC command: Input.xml: ping 10.16.127.35 curl -u demo:demo http://10.16.129.43:8008/api/running/dell/_operations/cli -X POST -T ./ input.xml
12 REST API CLI The REST API CLI commands are supported on the S4810, S4820T, S3048–ON, S4048–ON, S6000, S6000–ON, Z9100–ON, C9010, S5000, and Z9500 platforms. Topics: • rest-server • crypto cert generate • crypto cert install • show crypto cert • show ip rest-server rest-server Enables the REST API service over a non-secure or secure HTTP.
Usage Information Version Description 9.6(0.0) Introduced on the S5000. 9.5(0.1) Introduced on the Z9500. 9.4(0.0P1) Introduced on the S4810, S4820T, S6000, and Z9000. 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 Generates a self-signed certificate and key files, if exists, and replaces them with the newly generated files.
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 Version Description 9.10(0.0) Introduced on the C9010. 9.8(1.0P1) Introduced on the Z9100–ON. 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.
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 Displays the installed certificate information or any certificate information that is located in the file-system.
show ip rest-server Displays the status of the configured rest-server (HTTP or Secure HTTP). S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, C9010, 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. The following is a list of the Dell Networking OS version history for this command.
13 Web Server You download web server with HTTP[S] support with the SmartScripts package. It is supported on the S4810, S4820T, S3048–ON, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, and MXL platforms. For more information, see 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.
