Dell EMC Networking Open Automation Guide 9.14.0.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. Copyright © 2018 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents 1 About this Guide.............................................................................................................................................9 Audience..............................................................................................................................................................................9 Open Automation Features and Supported Platforms .................................................................................................
Script Examples............................................................................................................................................................... 29 BMP Operations on Servers Overview......................................................................................................................... 33 Configuring the DHCP Server Settings..................................................................................................................
Puppet Agent Configuration Scripts..............................................................................................................................67 puppet-config............................................................................................................................................................. 67 puppet-show...............................................................................................................................................................
package clear-all...............................................................................................................................................................92 package install.................................................................................................................................................................. 93 package uninstall.......................................................................................................................................
hypervisor........................................................................................................................................................................130 mode................................................................................................................................................................................ 130 package install..................................................................................................................................
Management Route..................................................................................................................................................176 MAC Address Table.................................................................................................................................................. 177 Policy Based Routing (PBR)....................................................................................................................................178 Port Mirroring..
1 About this Guide This document describes the components and uses of the Open Automation Framework designed to run on the Dell EMC Networking operating system (OS).
Platform Bare Metal Provisioning (BMP) Open Management Interface (OMI) Puppet Smart Scripts Virtual Server Networking (VSN) Representatio nal State Transfer Application Programming Interface (REST API) Web Server S4048T–ON Y Y Y Y N Y Y S5000 Y Y Y Y Y Y Y S5048F–ON Y Y Y Y N Y Y S6000 Y Y Y Y N Y Y S6000–ON Y Y Y Y N Y Y S6100–ON Y Y Y Y N Y Y S6010–ON Y Y Y Y N Y Y Z9500 Y Y Y Y N Y Y MXL Y N Y Y Y N Y IOA Y N Y Y N N N
Platform S4048–ON S4048T–ON S3048–ON S5000 S6000 S6000–ON S6010–ON IOA FN-IOM MXL Switch Z9500 Related Documents • Dell EMC Networking OS Configuration Guide for the S4820T System • Dell EMC Networking Installation Guide for the S4820T System • Dell EMC Networking OS Command Line Reference Guide for the S4048–ON System • Dell EMC Networking OS Configuration Guide for the S4048–ON System • Dell EMC Networking Installation Guide for the S4048–ON System • Dell EMC Networking OS Command L
Platform C9010 Related Documents • Dell EMC Networking OS Configuration Guide for the Z9500 System • Dell EMC Networking Installation Guide for the Z9500 System • Dell EMC Networking OS Command Line Reference Guide for the C9010 System • Dell EMC Networking OS Configuration Guide for the C9010 System • Dell EMC Networking Installation Guide for the C9010 System S3100 Series • (S3124P, S3148, S3148P, S3124F, and • S3124) • Z9100–ON • Dell EMC Networking OS Command Line Reference Guide for the S
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 EMC Networking S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S4048T–ON, S5000, S5048F-ON, S6000, S6000-ON, S6010–ON, S6100–ON, Z9500, Z9100–ON, MXL, M IOA, and FN IOM platforms support the Open Automation framework.
NOTE: The Open Automation framework is seen as Open Automation in the rest of this document. Topics: • Bare Metal Provisioning • Smart Scripting • Virtual Server Networking • REST API • Web Server Bare Metal Provisioning Bare metal provisioning (BMP) provides the following features.
Virtual Server Networking Virtual server networking (VSN) provides the following: • Automatic re-provisioning of virtual local area networks (VLANs) when you migrate virtual machines (VMs). • Support for multiple hypervisors, such as VMware and Citrix XenServer. 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.
3 Bare Metal Provisioning Bare metal provisioning (BMP) is included as part of the Dell EMC Networking OS image and is supported on the S4810, S4820T, S3048– ON, S3100 Series, S4048–ON, S5000, S6000, S6000-ON, S6010–ON, S6100–ON, Z9100–ON, Z9500, C9010, IOA, FN–IOM, and MXL platforms.
Industry Standard Upgrades with BMP Dell EMC Networking OS follows the Industry Standard Upgrades with BMP. Following are the steps to perform the upgrade process: 1 The chassis loads in BMP mode. 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.
• Switch access through all ports (management and user ports) with or without the DHCP-based dynamic IP address configuration of a switch. • Booting up in Layer 3 mode with interfaces already in No Shutdown mode and basic protocols enabled to protect the system and network. • Access to the configuration file or a pre–configuration script using the DHCP offer. • Download and execute scripts before configurations are applied, allowing pre–configuration checks on the switch.
BMP Mode In BMP mode, there are two types of contexts: factory-default context and normal context. Factory-Default Context BMP is enabled with the default parameters (no dhcp-timeout and config-scr -download). In this context, you cannot enter CLI commands. By default, the BMP syslog messages are disabled. When BMP is about to start, the following message displays: This device is configured to enter Bare Metal Provisioning (BMP).
NOTE: To apply the startup configuration, cancel the default BMP setup using the stop bmp command from the console. To disable BMP for the next reload, use the boot-type normal-reload command in reload-type configuration mode. Normal Mode When reloaded in Normal mode, the switch boots up with the management port in No Shutdown mode. If the management IP address is present in the start-up configuration file, it is assigned to the management interface.
NIL sname NIL dns IP NIL router IP NIL. 00:02:27: %STKUNIT0-M:CP %BMP-5-BMP_BOOT_OFFER: DHCP image file tftp://13.4.4.1/ftos-img-s4810. 00:02:27: %STKUNIT0-M:CP %BMP-5-BMP_BOOT_OFFER: DHCP config file scp://anvltest:force10@13.4.4.1//tftpboot/basic-l3. 00:02:27: %STKUNIT0-M:CP %BMP-5-BMP_BOOT_OFFER: stacking info NIL. 7 The system sends a message to the server to retrieve the named configuration file or pre–configuration script and/or boot file from the base directory of the server.
b • If both filename.sha256 and filename.md5 are present, SHA256 validation has a higher priority compared with MD5 validation. • If filename.sha256 or filename.md5 alone is present, the corresponding type of validation is completed. When you enable FIPs mode: • MD5 validation is not used. BMP checks only for the filename.sha256 and not filename.md5. • If filename.sha256 is present, it uses SHA256 validation or the image downloads without SHA256 validation.
Reload with a DHCP Server Offer Without a Dell EMC Networking OS Offer You configure the switches to reload in BMP mode. If the switches reach a DHCP server but do not locate a downloadable Dell EMC Networking OS image file on the server, they attempt to download the configuration file. 1 The system boots up with the BMP application. 00:02:26: %STKUNIT0-M:CP %BMP-5-BMP_DHCP_OFFER: DHCP OFFER received on Te 0/21 IS SELECTED. 00:02:26: %STKUNIT0-M:CP %BMP-5-BMP_REQUEST: DHCP REQUEST sent on Te 0/21.
Te 0/21. 00:02:26: %STKUNIT0-M:CP %BMP-5-BMP_BOOT_OFFER: DHCP acquired IP 13.4.4.44 mask 255.255.255.0 server IP 13.4.4.1. 00:02:26: %STKUNIT0-M:CP %BMP-5-BMP_BOOT_OFFER: DHCP tftp IP NIL sname NIL dns IP NIL router IP NIL. 00:02:27: %STKUNIT0-M:CP %BMP-5-BMP_BOOT_OFFER: DHCP image file tftp://13.4.4.1/ftos-img-s4810. 00:02:27: %STKUNIT0-M:CP %BMP-5-BMP_BOOT_OFFER: DHCP config file NIL. 00:02:27: %STKUNIT0-M:CP %BMP-5-BMP_BOOT_OFFER: stacking info NIL.
If a pre–configuration script file downloads successfully, 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. 00:03:21: %STKUNIT0-M:CP %BMP-5-BMP_PRE_CONFIG_SCRIPT_BEGIN: The Pre-Config Script has started to Execute.
• The circuit ID identifies the port originating the protocol data unit (PDU) and has the interface details. • The remote ID is configurable between the switch MAC address, the hostname, or a custom string. To set the remote ID, enable the relay up-front in reload-type sub mode. If you enable the relay, by default, the remote ID is set to MAC address.
NOTE: To display a properly formatted output string, Dell EMC Networking recommends adding the following clido wrapper function at the beginning of TCLSH and EXPECT scripts: # Execute clido and return the output string proc Execclido {cmd_str} { set str [exec clido "$cmd_str"] set tmp_str [string map {\n \r\n} $str ] return $tmp_str } ... set out_str [Execclido "show version"] puts $out_str ...
7 8 The pre–configuration script can access Dell EMC Networking OS CLI commands through the clido utility. The clido utility has no pagination, is always set to terminal length 0, and has Dell EMC Networking OS CLI privilege 15 enabled. It works in the following modes: • Continuous mode (clido command) — use to retain the Dell EMC Networking OS context. • Reset mode (clido -r command) — use to reset the CLI command to its original context.
• If the script returns a non-zero value (indicating a failure), the configuration file does not load in the system. Debug it manually and reload the system with the corrected script. If the autoexec script fails, the system syslog displays: 00:00:34: %STKUNIT1-M:CP %BMP-5-AUTOEXE_FAILURE: The AutoExec Script execution returned Failure.
The following line indicates the start of the auto-execution script. Script is Started. 00:00:19: %STKUNIT1-M:CP %CHMGR-5-CHECKIN: Checkin from Stack unit 1 (type S4810, 64 ports) 00:00:20: %00:00:20: %STKUNIT1-M:CP %CHMGR-0-PS_UP: Power supply 0 in unit 1 is up 00:00:20: %STKUNIT1-M:CP %CHMGR-5-STACKUNITUP: Stack unit 1 is up 00:00:21: %STKUNIT1-M:CP %CHMGR-5-SYSTEM_READY: System ready 00:00:21: %STKUNIT1-M:CP %RAM-5-STACK_STATE: Stack unit 1 is in Active State.
Pre-configuration 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 S
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)} "TenGigabitEthernet 0/1" set {remote_intf(Te 0/5)} "TenGigabitEthernet 0/5" set {remote_intf(Te 0/9)} "TenGigabitEthernet 0/9" set hostname "S4810-10" set max_min 10 set status_file "s4810-10-current-status.dat" set ftp_ip "20.0.0.1" puts [exec rstimer 30] puts "\r\nReset Timer Complete\r\n" # Open Staus File set fp [open $status_file w]
$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: Interface $intf_slot is Not Connected to Interface$remote_intf($intf_slot) \r\n" puts "LLDP Output for $intf_slot :\r\n $result_str \r\n" puts $fp "LLDP Output for $intf_slot :\r\n $result_str \r\n" } continue } # Wait for 1 minute puts "Interface is Not Connected\r\n" puts "Wait for 1 min for the Neighbor to come-up\r\n" after [expr {60 * 1000}]incr min } if
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. For more information, see the Dell EMC Networking OS Configuration Guide, the Dynamic Host Configuration Protocol chapter. • Configure the DHCP server with the following set of parameters for each client switch.
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.
MIB OID Value and Functionality 1.3.6.1.4.1.6027.3.23.1.
4 Bare Metal Provisioning CLI Bare metal provisioning commands are supported on the S4810, S4820T, S3048–ON, S3100 series, S4048–ON, S4048T–ON, S5000, S6000, S6000–ON, S6010–ON, S6100–ON, Z9100–ON, Z9500, C9010, IOA, FN-IOM, 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, S4048T–ON, S5000, S6000, S6000–ON, S6010–ON, S6100– ON, Z9100–ON, Z9500, C9010, IOA, FN-IOM, 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.
bmp logging Configures the syslog messages in a console while BMP is running. S4810, S4820T, S3048–ON, S3100 series, S4048–ON, S4048T–ON, S5000, S6000, S6000–ON, S6010–ON, S6100– ON, Z9100–ON, Z9500, C9010, , IOA, FN-IOM, and MXL Syntax Parameters bmp logging {enable | disable} enable Enables the syslog messages in the console while BMP is running. disable Disables the syslog messages in the console while BMP is running.
boot-type Allows you to configure the reload type. S4810, S4820T, S3048–ON, S3100 series, S4048–ON, S4048T–ON, S5000, S6000, S6000–ON, S6010–ON, S6100– ON, Z9100–ON, Z9500, C9010, IOA, FN-IOM, and MXL Syntax boot-type { bmp-reload | normal-reload } To reset the boot-type mode, use the no boot-type { bmp-reload | normal-reload } command. Parameters bmp-reload Reloads the system in BMP mode.
config-scr-download Allows you to specify whether the configuration or script file needs to be downloaded. S4810, S4820T, S3048–ON, S3100 series, S4048–ON, S4048T–ON, S5000, S6000, S6000–ON, S6010–ON, S6100– ON, Z9100–ON, Z9500, C9010, IOA, FN-IOM, and MXL Syntax config-scr-download { enable | disable } To reset the download option, use the no config-scr-download { enable | disable } command.
• show reload-type — displays the current Reload mode (BMP mode or Normal mode). dhcp-timeout Allows you to configure the DHCP timeout limit. S4810, S4820T, S3048–ON, S3100 series, S4048–ON, S4048T–ON, S5000, S6000, S6000–ON, S6010–ON, S6100– ON, Z9100–ON, Z9500, C9010, IOA, FN-IOM, and MXL Syntax dhcp-timeout minutes To reset the DHCP time out limit, use the no dhcp-timeout minutes command. Parameters dhcp-timeout minutes Configure the DHCP timeout (in minutes) after which the BMP exits.
relay Allows you to configure the addition of option 82 in DHCP client packets. S4810, S4820T, S3048–ON, S3100 series, S4048–ON, S4048T–ON, S5000, S6000, S6000–ON, S6010–ON, S6100– ON, Z9100–ON, Z9500, C9010, IOA, FN-IOM, and MXL Syntax relay { enable | disable | remote-id { hostname | MAC | Word }} To reset the options 82 information, use the no relay { enable | disable | remote-id { hostname | MAC | Word }} command. Parameters enable Enable the option 82 in BMP. The default value is the MAC address.
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 9.1(0.0) Introduced on the Z9000 and S4810. 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.
Related Commands Version Description 9.3(0.0) Introduced on the S6000. 9.2(0.0) Introduced on the MXL Switch. Updated the parameters for S4810, S4820T, and Z9000. 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-scrdownload and user-defined-string commands. Supported platforms are S4810, S4820T, and Z9000. 9.0.2.0 Introduced on the S6000. 9.0.0.0 Introduced in Z9000. 8.3.19.
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. • reload-type — allows you to configure the reload-type options in reload-type sub command mode.
Version Description 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.3(0.0) Introduced on the S6000. 9.2(0.0) Introduced on the MXL switch and S4820T. 9.1(0.0) Introduced on the Z9000 and S4810. show boot bmp Displays the current state of the BMP process.
Example DellEMC# 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.1.1.1/boot_file.bin config file = tftp://25.1.1.1/config_file.cfg Server IP = 25.1.1.1 TFTP Server IP = NIL DNS IP = 25.1.1.1 Routers = NIL *********************************** ... BMP State : Downloading image boot_file.
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, IOA, and MXL.
Usage Information Version Description 9.10(0.1) Introduced on the S4048T–ON and S6010–ON. 9.10(0.0) Introduced on the S6100–ON. 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 S6000–ON. 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.
stop bmp To prevent an infinite loop, stop the switch from reloading in BMP mode. S4810, S4820T, S3048–ON, S3100 series, S4048–ON, S4048T–ON, S5000, S6000, S6000–ON, S6010–ON, S6100– ON, Z9100–ON, Z9500, C9010, , IOA, FN-IOM, and MXL Syntax stop bmp NOTE: This command replaces the stop jumpstart command. Defaults none Command Modes EXEC Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell EMC Networking OS Command Line Reference Guide.
The stop bmp command behaves differently in different circumstances: • While the Dell EMC Networking OS image upgrade is in progress, it aborts the BMP process after the Dell EMC Networking OS image upgrades. • When applying configurations from the file, it aborts the BMP process after all the configurations are applied in the system. • When running the pre-configuration or post-configuration script, it stops the script and aborts the BMP process immediately.
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).
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 EMC Networking OS supports the Open Management Infrastructure (OMI) framework. OMI is supported on the S4810, S4820T, S3048–ON, S4048–ON, S4048T–ON, S5000, S5048F-ON, S6000, S6000–ON, S6010–ON, S6100–ON, Z9100–ON, and Z9500 platforms. Overview THIS IS A TEST. OMI is an open source package which manages infrastructure components such as servers, storage, and networking.
Pre-requisites Before using OMI on the Dell EMC Networking OS switch, configure the following: 1 OMI works only with PowerShell version 4.0 or higher. 2 Create a user, with the user privilege 15, where this user can configure the box from the management station through OMI. 3 Install the smartscript package. For detailed information, see the Installing SmartScripting section of the Smart Scripting chapter. 4 Install the OMI package. EXEC Privilege mode package install “tftp:///OMI-I-9.14.
Utility Scripts To manage the OMI operations, use the following wrapper scripts: omi-server-config To configure the OMI server, use the omi-server-config script. script execute omi-server-config args “arguments” The argument options are: • start — start OMI server • stop — stop the OMI server • client-test — testing the OMI server using OMI client • get-mof — copy DellNetworkingDSC.
Getting Started with OMI This section describes how you start configuring the OMI. To configure the OMI, follow these steps: 1 Get the chassis ready with the packages installed. 2 Get the DellNetworking DSC module from the chassis to install in the Windows server. a Copy the MOF file (ZIP file) to flash as flash:/DellNetworkingDSC.zip EXEC mode script execute omi-server-config args “get-mof” b Copy the DellNetworkingDSC.zip to the Windows server.
PS C:\windows\system32> Start-DscConfiguration -CimSession:$box1 -Path:"C: \EthernetPortViewMof" -Verbose –Wait 11 • CimSession is the box1 created in step 9. • Path is the path of the MOF created in step 7. Verify in the chassis for interface tengigabitethernet 0/1. • show running-config tengig 0/1 • show interface tengig 0/1 Examples This section shows various OMI configurations.
Enumerating an Instance using a CIM Session Create a CIM session PS C:\Users\Administrator> $cred=Get-Credential -UserName:"omiuser" -Message:"OMI User?" PS C:\Users\Administrator> $opt = New-CimSessionOption -UseSsl:$true -SkipCACheck:$true SkipCNCheck:$true -SkipRevocationCheck:$true PS C:\Users\Administrator> $s6k=New-CimSession -Credential:$cred -ComputerName:10.10.60.1 -Port: 5986 -Authentication:basic -SessionOption:$opt Get the CIM instance of various Resource View classes PS C:\Users\Administrator>
NOTE: The key (property ID) in the BGP configuration is of the form:Id = "1-1-vrf-1";AddressFamily-ExtAsNumberVRFName.Example: For an ASN 100 on default-VRF (IPv4) it will be 1-100-default For IPv6 context, it will be 2-100-default (corresponds to Router bgp 100 Address-family ipv6 unicast) Powershell Cmdlets and OMI Compatibility Matrix This section describes the list of DesiredStateConfiguration (DSC) resource cmdlets supported in OMI. Table 2.
6 Puppet Dell EMC Networking OS supports the Puppet automation framework. Puppet Agent is supported on the S4810, S4820T, S3048–ON, S4048–ON, S4048T–ON, S5000, S5048F-ON, S6000, S6000–ON, S6010–ON, S6100–ON,Z9100–ON, , Z9500, MXL, and FN IOM 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.
NOTE: You must keep the clock of the chassis in sync with the Puppet master. The synchronization is done by the Network Transfer Protocol (NTP) server. Configuring the Puppet Agent To configure the Puppet Agent, use the following steps. 1 Enable the REST API. 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.
Puppet Agent Configuration Scripts This section describes the various Puppet Agent configuration scripts: puppet-config To configure or make changes to the agent’s parameters, use the puppet-config script. puppet-config [-d] option=value Following are the mandatory puppet configuration options: agentrestipaddr : IP address to be used for rest apis. The default IP address is 127.0.0.1. agentrestpasswd : Password of the user given in agentrestuser. agentrestport : Port number to be used for rest apis.
puppet-apply To apply any puppet manifest file, use the puppet-apply script.
} } LAG Configuration Apply the LAG configurations using both the Puppet Standalone and Puppet Agent. You can read and write the LAG configurations by using the netdev_lagtype. node dell_s4810_node1 { netdev_device { hostname: } netdev_lag { "name": ensure => (present | absent), active => (true | false), links => ('interface-name' | ['interface-name1', 'interface-name2' ...
Using the Puppet Facter Dell EMC Networking OS supports the standalone tool called the Puppet Facter. This tool is based on Ruby and provides complete system information about the agent node to the puppet master. To apply the configurations using puppet, you must install the Puppet Facter tools on all the nodes. Following are the facts pair in the manifest files.
7 Smart Scripting Smart Scripting is supported on the S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S4048T–ON, S5000, S5048F-ON, S6000, S6000–ON, S6010–ON, S6100–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 EMC Networking switches without updating the Dell EMC Networking OS release.
With Smart Scripting, you don’t need to learn proprietary scripting languages; allowing for faster development and deployment of custom scripts. 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.
• Python interpreter and associated files. • Ruby interpreter and associated files. • SQLlite database and Perl, Python, Ruby, TCL interface to SQLite. • NetSNMP client and Perl, Python, Ruby interface to the client. • Expanded set of UNIX utilities. • 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.
Displaying Installed Packages To view the Open Automation packages currently installed on a switch, including version numbers and content, use the following commands. • View package information. EXEC Privilege mode show packages show packages system Uninstalling SmartScripts Uninstalling the SmartScripts 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.
set fileId [open $filename "a+"] switch $env(DELL_TRGEVT_TYPE) { "TIME EVENT" { set data "Sending Mail : The triggered Event $env(DELL_TRGEVT_NAME) is Time Event - Reload Started" } "LOG EVENT" { set data "Sending Mail : Triggered Event is $env(DELL_TRGEVT_NAME) BPDU Guard Initiated , Port will recover once it is out of Error Disable State \n" set data [concat $data "Attching the Log Message : $env(DELL_TRGEVT_LOGMSG)"] } "CPU" { set data "Sending Mail : Triggered Event is $env(DELL_TRGEVT_NAME) CPU Limits
Sample script for clido in ZSH #/usr/bin/zsh clido –r "configure terminal" clido "interface vlan 10" clido "no shutdown" clido “name MailServer_Vlan” exit 0 #usage of –r is to forcefully go to exec mode dellsh To parse a list of commands line by line in any given text file and configure it on the device, use the dellsh system command. Syntax: dellsh Sample script for dellsh in Python #! /usr/pkg/bin/python import os os.system("dellsh '/usr/pkg/ss-scripts/dellsh.
• 3 — error • 4 — warning • 5 — notify • 6 — infor • 7 — debug The default severity level is 6. Sample script for dellsyslog in Python #! /usr/pkg/bin/python import sys import os print sys.argv[1] os.system("dellsyslog -s %s 'The Syslog is generated by python'" %(sys.argv[1])) 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 #! /usr/pkg/bin/perl #importing DellSSUtils require "/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 = "/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].$ARGV[0].
for input1 in sys.argv[1:]: print DellSmartUtils.DellCliConfig(["%s" %str("interface vlan %s" %str(input1) ) , "no shutdown"]) arg_val="" for b in sys.argv[1:] : arg_val=arg_val+" %s" %(b) print DellSmartUtils.DellExec("loopback.zsh" , arg_val) f = DellSmartUtils.DellCli("show version") fh = open("/f10/flash/Dellcli.txt", "w") fh.writelines(f) fh.close() For instructions about how to run a Perl, Python, or Ruby script from the Dell EMC Networking OS CLI, see Scheduling Time / Eventbased Scripts.
Limits on System Usage To restrict CPU and memory usage, Smart Scripting establishes limits on system processes for the following attributes (regardless of the user-privilege level or scripting method). Table 4. Limits on System Attributes System Attributes Value Description cputime unlimited Maximum amount of time a process uses. filesize unlimited Largest file size (in bytes) that can be created.
UNIX Utility Function cat Concatenate and print files. chmod Change file modes. chown Change file owner and group. cksum Display file checksums and block counts. cut Select portions of each line of a file. date Display or set date and time. dd Convert and copy a file. df Display free disk space. env Set and print environment. expr Evaluate expression. fc List the history of commands on the computer. fg Change the background process to the foreground process.
UNIX Utility Function stty Change the settings of a UNIX computer terminal. tail Display the last part of a file. test Condition evaluation utility. ulimit Get and set process limits. umask Set the file creation mode mask. vmstat Report virtual memory statistics. wait Await process completion. wc Word, line, and byte count. who Display the users who are currently logged in.
Downloading Scripts to a Switch Download a script to the switch using TFTP, FTP, or FLASH. Save the script to the dedicated script storage location, /usr/pkg/ssscripts. For S3100 series, the storage location is /f10/flash/pkg/ss-scripts. Network File System (NFS) A Network File System (NFS) allows you to mount the file systems over a network and locally interact with those file systems.
Script Scheduler from EXEC mode To trigger scripts to run periodically or based on an event, use the following commands. • Schedule a script to run in EXEC mode. Schedule a script to execute at a specific time and optionally stop after a specified time. By default, the script runs in the foreground. To run the script in the background, use the bg parameter. EXEC mode script execute script-name [start {at | date-time | after time}] [stop {at date-time | after time}] [bg] [arguments arg[..
Following example shows the event triggering the script after the cpu-usage reaches 30%: DellEMC(conf)#script trigger-event event1 cpu-usage 30 Following example shows how you can define the event to trigger a script when a SYSLOG event with the OSTATE_UP pattern occurs: DellEMC(conf)#script trigger-event Port_State_Event log-event tag tag-regex "OSTATE.
003 EXEC DellEMC# Scheduled user2 args.pl hi The script status are determined as follows: • Scheduled — The script is scheduled to run. • Running — The script is currently running. • Stopped — The script is suspended. • Completed — The script run is successful and exits normally. • Watch Blocked — The script is monitored but terminates within ten minutes. • SSMGR-Stopped — Dell EMC Networking OS stops the script by itself, if the cpu/disk-io/mem goes beyond the threshold.
• Display a list of scripts that are scheduled or running. To display the detailed status of the scripts, enter detail. EXEC Privilege mode • show script process [detail] Display a list of supervised scripts that are scheduled or running. To display the detailed status of the supervised scripts, enter detail.
script [username name] script-path [script-parameter script-parameter ...] For script-path, enter the directory path and filename. (Optional) For username name, enter the user name whose read-write privileges are applied when the script runs. A username running scripts cannot contain special characters. (Optional) For script-parameter, enter the values of up to three parameters to be applied when the script runs.
8 Smart Scripting CLI Smart Scripting is supported on the S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S4048T–ON, S5000, S5048F-ON, S6000, S6000–ON, S6010–ON, S6100–ON, Z9100–ON, Z9500, C9010, and MXL platforms. Smart Scripting is not supported on the M IOA, FN IOA, and FN IOM platforms.
To reset the event handler, use the [no] disable command. 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 EMC Networking OS Command Line Reference Guide. The following is a list of the Dell EMC Networking OS version history for this command. Version Description 9.10(0.1) Introduced on the S4048T–ON and S6010–ON. 9.10(0.0) Introduced on the S3100 Series and S6100–ON.
Version Description 9.10(0.0) Introduced on the S3100 Series and S6100–ON. 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.0) Introduced on the S4810, S4820T, S5000, S6000, S6000–ON, Z9000, Z9500, and MXL. mount nfs Share the network file system the local Dell EMC Networking OS file system uses.
Usage Information Version Description 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.3(0.0) Introduced on the S6000. 9.2(0.0) Introduced on the S4810, S4820T, Z9000, and MXL. • 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.
Version Description 9.9(0.0) Introduced on the S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S5000, S6000, S6000–ON, Z9100–ON, Z9500, C9010, and MXL. 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 Version Description 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. 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.
Usage Information Version Description 9.2(0.0) Introduced on the MXL switch. 9.0.2.0 Introduced on the S6000. 9.0.0.0 Introduced on the Z9000. 8.3.19.0 Introduced on the S4820T. 8.3.8.0 Introduced on the S4810. When you uninstall an Open Automation package, it is removed from the local flash memory. CAUTION: Before you uninstall the Smart Scripting package, first stop all scripts that are running using the no script script-name command.
Defaults none Command Modes CONFIGURATION Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell EMC Networking OS Command Line Reference Guide. The following is a list of the Dell EMC Networking OS version history for this command. Usage Information Version Description 9.10(0.1) Introduced on the S4048T–ON and S6010–ON. 9.10(0.0) Introduced on the S3100 Series and S6100–ON. 9.9(0.0) Introduced on the C9010. 9.8(1.
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 EMC Networking OS CLI. S4810, S4820T, S3048–ON, S3100 Series, S4048–ON, S4048T–ON, S5000, S6000, S6000–ON, S6010–ON, S6100– 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.3(0.0) Introduced on the S6000. 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, S4048T–ON, S5000, S6000, S6000–ON, S6010–ON, S6100– 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.
Usage Information Example Version Description 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.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.
start after date-time (Optional) Enter the keywords start after then the time in [HHHH:] MMMM format to start running the script after a set time. 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.
• Only the person who configures the scheduled scripts (or a higher privileged user) can change them. • If you do not provide the username, the system uses current session username. If the script is triggered from the console, the system uses the Dell EMC Networking OS default username (smartuser). script get Copies a script to a switch.
• SCP: Copy from the remote file system using SCP (scp://userid:password@hostip/filepath) • FTP: Copy from the remote file system using FTP (tftp://hostip//filepath) The downloaded files are stored into a dedicated folder (/usr/pkg/ss-scripts). For S3100 series, the dedicated folder path is /f10/flash/pkg/ss-scripts. NOTE: For stack systems, the script from ss-scripts synchronizes across the stack for every one hour.
Version Description 9.5(0.1) Introduced on the Z9500. 9.3(0.0) Introduced on the S6000. 9.2(0.0) Introduced on the S4810, S4820T, Z9000, and MXL Switch. Usage Information The 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.
Usage Information Version Description 9.3(0.0) Introduced on the S6000. 9.2(0.0) Introduced on the S4810, S4820T, Z9000, and MXL Switch. This command removes the files from the dedicated folder /usr/pkg/ss-scripts on the switch. script trigger-event Configures the event that causes the script to run.
time-event stop at datetime Enter the keyword stop at then the time and date either in HH:MM — MM/DD/YY format to stop the trigger event at the specified time and date or in HH:MM format to begin the trigger event at the specified time on the same day (if the mentioned time is elapsed, the event runs on the next day HH:MM mentioned). The date must be a future date.
Usage Information Version Description 9.2(0.0) Introduced on the S4810, S4820T, Z9000, and MXL Switch. The maximum number of events you can configure is 20. The maximum number of allowed tag patterns in a log event trigger is three. The tags of the log events must be an exact comparison. The three tags work in a logical OR operation format (match with any one of the tags occurs). NOTE: Before deleting a trigger event, you MUST unlink the script from the event.
DellEMC(conf)# script trigger-event event7 log-event tag tag-regex "^ [A-Za-z] +.*Value : \?[0-9]" DellEMC(conf)# script trigger-event event2 log-event tag tag-regex up.*[0-9]+ DellEMC(conf)# script trigger-event event4 log-event tag tag-regex "up\?: Vl.*[0-9]+" DellEMC(conf)# script trigger-event event5 log-event tag tag-regex "The Value.*[0-9]+" show packages Displays the installed Open Automation packages, including version number and contents.
Usage Information Version Description 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. In a stack setup, the Dell EMC Networking OS automatically synchronizes the software version installed on the master stack unit with the other switches in the stack.
rest-client 1.6.7 HTTP Server mini_httpd 1.21 Perl and Python function library for Dell EMC Networking SmartScripts smartutils 2.0.0 DellSSUtils 1.0.0 WebConnect Web UI and CGI scripts htdocs 2.0.0 NetSNMP 5.7.2 Python NetSNMP module Perl NetSNMP module SQLite3 3.7.17 Python SQLite3 module Perl SQLite3 module TCL SQLite3 module Yaml 0.1.
process Enter the keyword process to list the scripts that are scheduled or running. Enter the optional keyword detail to show detailed output of the relevant arguments that are scheduled or running. watch Enter the keyword watch to list the supervised scripts and their relevant details. detail (Optional) Enter the keyword detail to show detailed output of the file including CPU percentage, memory percentage, next scheduled time, and any script name or relevant arguments.
Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell EMC Networking OS Command Line Reference Guide. The following is a list of the Dell EMC Networking OS version history for this command. Usage Information Version Description 9.10(0.1) Introduced on the S4048T–ON and S6010–ON. 9.10(0.0) Introduced on the S3100 Series and S6100–ON. 9.9(0.0) Introduced on the C9010. 9.8(1.0P1) Introduced on the Z9100–ON. 9.8(0.
Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell EMC Networking OS Command Line Reference Guide. The following is a list of the Dell EMC Networking OS version history for this command. Version Description 9.10(0.1) Introduced on the S4048T–ON and S6010–ON. 9.10(0.0) Introduced on the S3100 Series and S6100–ON. 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.
Usage Information Version Description 9.10(0.0) Introduced on the S3100 Series and S6100–ON. 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.0) Introduced on the S6000–ON. 9.6(0.0) Introduced on the S5000. 9.5(0.1) Introduced on the Z9500. 9.3(0.0) Introduced on the S6000. 9.2(0.0) Introduced on the S4810, S4820T, Z9000, and MXL switch.
Usage Information Example Version Description 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.0) Introduced on the S4810, S4820T, S5000, S6000, S6000–ON, Z9000, Z9500, and MXL. • Only the person who configures the scheduled scripts (or a higher privileged user) can change them. • If you do not provide the username, the system uses current session username.
Usage Information 116 Version Description 9.10(0.1) Introduced on the S4048T–ON and S6010–ON. 9.10(0.0) Introduced on the S3100 Series and S6100–ON. 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.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.
9 SNMP MIBs Dell Networking OS supports SNMP MIBs on the S4810, S4820T, S3048–ON, S4048–ON, S4048T–ON, S5000, S6000, S6000–ON, S6010–ON, S6100–ON,Z9100–ON, Z9500, MXL, and FN IOM platforms. Overview A MIB is a hierarchy of information which defines managed objects in a network device. The MIB structure is based on a tree structure, which defines a grouping of objects into related sets. Each object in the MIB is associated with an object identifier (OID), which names the object.
NOTE: After installing the SNMP MIB package, you can view the MIBs which gets stored at the directory /usr/pkg/ share/snmp. Verify SNMP MIBs and TRAPs To view the SNMP MIBs and Traps that are currently installed on a switch, including version numbers and content, use the following commands: • View SNMP MIB information.
dellNetSysAlarmMinorTemperatureClear dellNetSysAlarmMajorTemperatureClear dellNetSysAlar 1.3.6.1.4.1.6027.3.26.1.5.1.12 1.3.6.1.4.1.6027.3.26.1.5.1.13 Display installed packages To view the package information that are installed on the system, use the following commands: • View the package information that installed on the system. EXEC and EXEC Privilege mode show packages show packages system Following is the sample output of the show packages command: DellEMC# show packages ...
10 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 EMC Network fabric and the virtual servers to automate network management and configuration tasks throughout the data center.
Dell EMC 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.
VLAN Configurations The following sections describe management, data, and hypervisor-unaware VLANs. Install VSN Install VSN as a separate Open Automation package, apart from the Dell EMC Networking OS image and the downloaded Smart Scripting package. When you install the VSN package, VSN loads into the Dell EMC Networking OS. NOTE: VSN is only supported on standalone switches; it is not supported in stacked configurations.
To follow the progress of a package installation (or removal), use the show packages command. Enabling VSN in a Hypervisor Session To enable VSN on an interface and connect to hypervisors on network servers, follow these steps. Important Information: • 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.
• config: Retrieves configuration information and automatically updates the configuration parameters in the Dell EMC Networking OS. The default is config. 6 Enable the defined hypervisor connection. HYPERVISOR mode no disable 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.
Connectivity If a network server is not reachable, a log message displays and the VSN agent tries periodically to establish the connection with the hypervisor. The initial log message is: 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 displays. The VSN agent tries to connect to the hypervisor in the background.
Disabling a Hypervisor Session To stop VSN in a hypervisor session, enter the disable command in HYPERVISOR mode. The disable command does not remove connectivity with the hypervisor or remove the session information from the system configuration. • Shut down VSN in a hypervisor session. HYPERVISOR mode disable Removing a Hypervisor Session To delete the configuration of a hypervisor session from the running configuration, use the no hypervisor command in CONFIGURATION mode.
To display detailed information about a hypervisor session, enter the VSN interface and/or virtual-switch name generated by the hypervisor, as the show virtualswitch output displays. • Display information on virtual machines accessed on a switch interface, including the virtual machine name, VMAC address, and corresponding VLAN ID. Display the virtual machines accessed on a switch interface.
11 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 Modes HYPERVISOR Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell EMC Networking OS Command Line Reference Guide. The following is a list of the Dell EMC 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 EMC Networking OS Command Line Reference Guide.
config VSN retrieves configuration information from the Hypervisor and implements any necessary configuration changes automatically. Defaults config Command Modes HYPERVISOR Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell EMC Networking OS Command Line Reference Guide. The following is a list of the Dell EMC Networking OS version history for this command. Usage Information Version Description 9.6(0.0) Introduced on the S5000.
Defaults none Command Modes EXEC Privilege Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell EMC Networking OS Command Line Reference Guide. The following is a list of the Dell EMC 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.
Usage Information Uninstalling the VSN package removes it from the internal flash memory on the switch. To follow the progress when removing a package from the system, enter the show packages command. NOTE: Before you uninstall the VSN package, first stop all scripts that are currently running using the no script script-name command. Related Commands show packages — displays all the packages installed in the system.
show hypervisor supported Displays the types of Hypervisors VSN currently supports. S4810, S4820T, S5000, and MXL Switch Syntax show hypervisor supported Defaults none Command Modes EXEC Privilege Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell EMC Networking OS Command Line Reference Guide. The following is a list of the Dell EMC Networking OS version history for this command. Version Description 9.6(0.
Example Version Description 9.6(0.0) Introduced on the S5000. 9.2(0.0) Introduced on the MXL switch. 8.3.19.0 Introduced on the S4820T. 8.3.8.0 Introduced on the S4810. DellEMC#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.
show virtualswitch Displays the components of current Hypervisor sessions, including the virtual switch and name of the Hypervisor session to which a switch interface is connected. S4810, S4820T, S5000, and MXL Switch Syntax show virtualswitch [interface] [virtualswitch-name] Parameters interface virtualswitchname Display information on the Hypervisor session established on a specified interface.
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. DellEMC#show virtualswitch Gigabitethernet 0/32 vSwitch3 Interface :Gi 0/32 Hypervisor Type :vmware Hypervisor Name :vmware207 Hypervisor Version :4.1.
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. Usage Information 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.
vsn enable Enables VSN on an interface. S4810, S4820T, S5000, and MXL Switch Syntax [no] vsn enable Defaults VSN is disabled by default on switch interfaces. Command Modes INTERFACE Command History This guide is platform-specific. For command information about other platforms, see the relevant Dell EMC Networking OS Command Line Reference Guide. The following is a list of the Dell EMC Networking OS version history for this command. Usage Information Version Description 9.6(0.
12 REST API Representational state transfer (REST) application programming interface (API) is an integrated part of the Dell EMC Networking operating system (OS) and is supported on the S4810, S4820T, S3048–ON, S4048–ON, S4048T–ON, S5048F-ON, S6000, S6000–ON, S6010–ON, S6100–ON, Z9100–ON, C9010, S5000, and Z9500 platforms. HTTP and HTTPS Use REST API to configure and monitor a Dell EMC Networking switch over the hyper text transfer protocol (HTTP) and hyper text transfer protocol secure (HTTPS).
Request Query Parameters Following are the various request query parameters supported on REST. • deep — Retrieves a resource with all the subresources inline. • shallow — Retrieves a resource with no subresources inline. • 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.
* 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' > PUT /api/running/dell/interfaces/interface/tengig-1-37 HTTP/1.1 > Authorization: Basic YWRtaW46YWRtaW4= > User-Agent: curl/7.15.5 (i686-redhat-linux-gnu) libcurl/7.15.5 OpenSSL/0.9.8b zlib/1.2.3 libidn/0.6.5 > Host: 10.16.151.159:8008 > Accept: */* > Content-Length: 171 > Expect: 100-continue > < HTTP/1.
200 false false The following configuration depicts the BGP configurations for router through the POST request: curl -v -u admin:admin http://10.16.151.159:8008/api/running/dell/router -X POST -T BGP_HTTP_REST_POST_PDU.xml * About to connect() to 10.16.151.159 port 8008 * Trying 10.16.151.159... connected * Connected to 10.16.151.159 (10.16.151.
11.1.1.2 * Connection #0 to host 10.16.151.159 left intact * Closing connection #0 The following configuration depicts adding another BGP peer to the configuration via REST– PATCH request: cat BGP_HTTP_REST_PATCH_PDU.xml 100 11.1.1.
The following configuration retrieves the BGPrunning-config via REST API: curl -u admin:admin http://10.16.151.159:8008/api/running/dell/router/bgp\?deep 100 60 180 1 1 false 11.1.1.
Status Error Codes Description 201 Created A resource is created and the new resource URI returns in the Location header. 204 No Content The request is successfully completed but no response body returns. 400 Bad Request The request could not be processed because it contains missing or invalid information (such as a validation error on an input field, a missing required value, and so on). 401 Unauthorized The request requires user authentication.
– :() 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 :. • is one of the following: – ? for an optional leaf or presence container – * for a leaf-list – [] for a list’s keys • is the name of the type for leafs and leaf-lists. Configurations This section describes the properties of all the configurations.
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 148 | +--rw regex-eval-optz-disable? boolean | +--rw connection-retry-timer? dell:seconds | +--rw router-id? dell:ip-address | +--rw add-path? | | +--rw addpath? enumeration | | +--rw path-count? uint8 | | +--rw enable? boolean | +--rw dampening? | +--rw half-life? uint32 | +--rw reuse? uint32 | +--rw suppress? uint32 | +--rw max-suppress-time? uint32 | +--rw route-map?
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +--rw remove-private-as? boolean | +--rw route-map [direction] | | +--rw direction dell:bgp-opt-dir | | +--rw name? dell:route-map-name | +--rw route-reflector-client? boolean | +--rw sender-side-loop-detection? boolean | +--rw soft-reconfiguration? enumeration | +--rw subnet? dell:ip-address-with-prefix | +--rw dmzlink-bw? boolean +--rw neighbor [neighbor-router] | +-
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 150 | +--rw internal-distance? uint8 | +--rw local-distance? uint8 +--rw redistribute? | +--rw connected? | | +--rw route-map? dell:route-map-name | +--rw static? | | +--rw route-map? dell:route-map-name | +--rw imported-bgp? | | +--rw route-map? dell:route-map-name | +--rw ospf [process-id] | | +--rw process-id uint16 | | +--rw match? | | | +--rw external1? boolean | |
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +--rw network-v6 [ipv6-address] | +--rw ipv6-address dell:ipv6-address | +--rw route-map? dell:route-map-name | +--rw backdoor? boolean +--rw aggregate-address [ip-address] | +--rw ip-address union | +--rw advertise-map? dell:route-map-name | +--rw as-set? boolean | +--rw attribute-map? dell:route-map-name | +--rw summary-only? boolean | +--rw suppress-map? dell:route-ma
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 152 REST API | +--rw allowas-in? uint8 | +--rw default-originate? | | +--rw route-map? dell:route-map-name | +--rw distribute-list [direction] | | +--rw direction dell:bgp-opt-dir | | +--rw name? dell:prefix-list-name | +--rw filter-list [direction] | | +--rw direction dell:bgp-opt-dir | | +--rw name? dell:aspath-access-list-name | +--rw maximum-prefix? | | +--rw maxim
| +--rw soft-reconfiguration? | +--rw dmzlink-bw? | +--rw advertisement-start? +--rw management +--rw ip +--rw ipv6 enumeration boolean dell:seconds Global Configuration The following definition displays the global configuration entries: Module: SYSTEM URI: /api/running/dell/system Methods Supported: GET, POST, PUT, PATCH, and DELETE Global Configuration Model +--rw dell +--rw system | +--rw hostname? string | +--rw banner? | | +--rw login? string | +--rw credentials? | | +--rw username? string | | +
ip aspath-list Configuration Model +--rw dell +--rw ip +--rw as-path? +--rw access-list [name] +--rw name dell:access-list-name +--rw description? string +--rw rules [seq-num] +--rw seq-num uint32 +--rw action ip-aspath-action-types +--rw pattern string IP Prefix-List The following definition configures and displays the properties of ip prefix-list.
| +--rw remark-number uint32 | +--rw description? string +--rw acl-filters [seq-no] | +--rw seq-no uint32 | +--rw filter-type dell:acl-rule-types | +--rw protocol union | +--rw (source-address) | | +--:(source) | | | +--rw source? dell:ipv4-address-any | | | +--rw source-mask dell:ipv4-mask-or-prefix | | +--:(host) | | +--rw source-host? dell:ipv4-host | +--rw (destination-address) | | +--:(destination) | | | +--rw destination? dell:ipv4-address-any | | | +--rw destination-mask dell:ipv4-mask-or-prefix | |
+--rw filter-type? +--rw protocol dell:acl-rule-types dell:ipv6-protocols-qos Interface The following definition configures and displays the properties of an Interface: Module: INTERFACE URI: /api/running/dell/interfaces/interface Methods Supported: GET, POST, PUT, PATCH, and DELETE NOTE: The POST and DELETE operations are not supported on Physical Interfaces.
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +--rw interface [name] +--rw name dell:interface-name +--rw flowcontrol? | +--rw rx? enumeration | +--rw tx? enumeration +--rw portmode? | +--rw hybrid? boolean +--rw switchport? | +--rw backup? | | +--rw interface | | +--rw name dell:backup-tag-interface | +--rw mode? | +--rw private-vlan? private-vlan-mode +--rw mac? | +--rw access-group? | | +--rw in? | | | +--rw WORD
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 158 | +--rw port-channel? port-channel | +--rw mode? enumeration | +--rw port-priority? uint32 +--rw rate-interval? uint32 | +--rw ip | +--rw vrf? | | +--rw forwarding? | | +--rw (vrf-domain)? | | +--:(management) | | | +--rw management? empty | | +--:(user-defined-vrf) | | +--rw name? vrf-name | +--rw address? | | +--rw primary? | | | +--rw address? dell:ipv4-address-wit
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +--rw ra-interval? | | +--rw max-ra-interval uint32 | | +--rw min-ra-interval uint32 | +--rw mtu? uint32 | +--rw dhcp-non-address? boolean | +--rw prefix [prefix-name] | | +--rw prefix-name dell:ipv6-nd-prefix-name | | +--rw advertise? boolean | | +--rw autoconfig? boolean | | +--rw rtr-address? boolean | | +--rw off-link? boolean | | +--rw lifetime? | | +--rw valid ipv6-nd-prefix-lifetime | | +--rw preferred ipv6-nd-prefix-lifetime |
| +--rw interface dell:interface-name | +--rw mac-address dell:mac-address +--rw icmp! | +--rw source-interface? dell:interface-name-icmp +--rw prefix-list* [name] +--rw name dell:prefix-list-name +--rw description? string +--rw seq* [seq-num] +--rw seq-num uint32 +--rw action ipv6-prefix-list-action-types +--rw ipv6-prefix union +--rw prefix-min-len? uint32 +--rw prefix-max-len? uint32 IP Tunneling The following definition configures and displays the properties of IP tunneling.
| | +--:(hostname) | | | +--rw hostname? boolean | | +--:(mac) | | | +--rw mac? boolean | | +--:(user-string) | | +--rw user-string? string | +--rw vendor-class-identifier? | +--rw distinct-string? string | +--rw unnumbered? dell:interface-name +--rw ipv6? | +--rw address [ipv6-address] | | +--rw ipv6-address dell:ipv6-address | +--rw nd? | | +--rw dad? | | | +--rw attempts? uint32 | | +--rw hop-limit? uint32 | | +--rw managed-config-flag? boolean | | +--rw ra-interval? | | | +--rw max-ra-interval uint32 |
| | +--:(source) | | | +--rw source? | | | +--rw source-mask | | +--:(host) | | +--rw source-host? | +--rw (destination-address) | | +--:(destination) | | | +--rw destination? | | | +--rw destination-mask | | +--:(host) | | +--rw destination-host? | +--rw encapsulation-type? | +--rw encapsulation-operator? | +--rw encapsulation-protocol? +--rw acl-filters-qos +--rw filter-type? +--rw protocol dell:mac-address-any dell:mac-address dell:mac-address dell:mac-address-any dell:mac-address dell:mac-address dell:
| +--rw description? string | +--rw rules-list [seq] | +--rw seq uint32 | +--rw output-action enumeration | +--rw next-hop union | +--rw track-num? uint32 | +--rw protocol ip-protocols-type | +--rw source ipv4-address-any | +--rw source-mask dell:ipv4-mask-or-prefix | +--rw destination ipv4-address-any | +--rw destination-mask dell:ipv4-mask-or-prefix | +--rw tcp-options* enumeration | +--rw tcp-udp-port-oper-list [port-type] | +--rw port-type tcp-udp-port-type | +--rw oper-type tcp-udp-port-oper-type | +--
+--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro egress-count-value? ingress-count-value? log? monitor? order? dscp? ecn? fragments? uint32 uint32 boolean boolean uint32 uint32 uint32 boolean Port Mirroring The following definition is for configuring and displaying the properties of port mirroring: Module: Port Mirroring URI: /api/running/dell/monitor-session Methods Supported: GET, POST, PUT, PATCH, and DELETE Port Mirroring Configuration Model +--rw dell +--rw system +--rw interfaces +--rw router +
+--rw map-attr string +--rw seq union | +--:(action) | | +--rw permit? string | | +--rw deny? string +--rw set +--rw ext-community! +--rw bandwidth? uint32 Static Route The following definition configures and displays the properties of a Static Route configuration: Module: IP STATIC ROUTE URI: /api/running/dell/ip/route Methods Supported: GET, POST, PUT, PATCH, and DELETE Static Route Configuration Model +--rw ip +--rw route* [ip-address-prefix interface-name next-hop] | +--rw ip-address-prefix dell:i
Operational This section describes the properties of all the IPv4 operational data.
+--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro network-prefix network-prefix-len next-hop-address seq-num metric? local-pref? weight? next-hop-cost-index? as-path-string? path-source? origin-code? is-nlre-loc-aggtd? is-stale? status-code? best-route? link-bandwidth? inet:ip-address inet-address:InetAddressPrefixLength inet:ip-address uint32 uint32 uint32 uint32 uint32 string enumeration enumeration snmpv2-tc:TruthValue snmpv2-tc:TruthValue enumeration snmpv
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 168 REST API +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro +--r
| +--ro default-org-config? string | +--ro no-active-tcp-connection? string | +--ro pdu-cap-dir? string | +--ro pdu-cap-stats? string | +--ro local-host? dell:ipv6-address-with-prefix | +--ro local-port? uint32 | +--ro foreign-host? dell:ipv6-address-with-prefix | +--ro foreign-port? uint32 +--ro summary | +--ro local-router-id? dell:ipv6-address-with-prefix | +--ro local-as? string | +--ro neighbor-count? uint32 | +--ro nlri-count? uint32 | +--ro path-count? uint32 | +--ro penalized-paths? uint32 | +--ro d
| +--ro local-pref? string | +--ro weight? uint32 | +--ro as-path-string? string | +--ro origin-code? bgp-origin-code +--ro peer-group [peer-group-name] | +--ro peer-group-name string | +--ro version? uint32 | +--ro minimum-time? uint32 | +--ro address-family? enumeration | +--ro as4-support? boolean | +--ro peer-count? uint32 | +--ro maximum-connections? uint32 | +--ro peer-group-members [neighbor-address] | +--ro neighbor-address dell:ipv6-address-with-prefix | +--ro outbound-optimized? boolean +---x filt
| | +--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? uint32 | +--ro as-path-string? string | +--ro origin-code? bgp-origi
| +--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 as-path? string | +--ro path-source? bgp-path-source | +--ro origin-code? bgp-origin-code +---x dampened-paths +--ro input +--ro output +--ro dampened-paths +--ro local-rib | +--ro routes-added? uint32 | +--ro routes-replaced? uint32 | +--ro routes-withdrawn? 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? boolean +--ro allow-remote* [remote-address remote-prefix-len] | +--ro remote-address dell:ip-address | +--ro remote-prefix-len dell:ip-address-prefix-length +--ro lag-name? lag-intf-name +--ro current-intf-address?
+--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: Module: IP ROUTE URI: /api/operational/dell/stats/ip/route Methods Supported: GET Route Model +--ro route +--ro gateway-of-last-resort? string +--ro route-entry* [destination] | +--ro destination inet:ip-pre
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.
Methods Supported: GET 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
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 interface [name] +--ro name dell:interface-name +--ro rule-entry [cam-index] +--ro cam-index uint32 +--ro port? uint32 +--ro vlan-id? dell:vlan-id-num-with-default +--ro protocol? dell:ip-protocols-type +--ro tcp-flag* tcp-bits +--ro source-port? uint32 +--ro destination-port? uint32 +--ro source-ip? string +--ro destination-ip? string +--ro nexthop-mac? string +--ro egress-port? string Port Mirroring Use the following model to get the Port Mirroring operational data: Module: STATS URI: /api/opera
| +--ro seq-no uint32 | +--ro filter-type? acl-rule-types | +--ro src-mac-filter? acl-incoming-address-filter-types | +--ro src-mac-address? yang:phys-address | +--ro src-mac-mask? yang:phys-address | +--ro dest-mac-filter? acl-incoming-address-filter-types | +--ro dest-mac-address? yang:phys-address | +--ro dest-mac-mask? yang:phys-address | +--ro encapsulation-type? mac-acl-encap-types | +--ro encapsulation-operator? mac-acl-encap-operators | +--ro encapsulation-protocol? string | +--ro count-type? acl-ru
System Model +--ro mac-address? yang:phys-address +--ro reload-type? reload-type +--ro next-boot? reload-type +--ro units* [unit-id] | +--ro unit-id uint32 | +--ro unit-role? string | +--ro unit-status? string | +--ro unit-next-boot-status? string | +--ro required-type? string | +--ro current-type? string | +--ro master-priority? int32 | +--ro hardware-revision? string | +--ro os-version? string | +--ro num-ports? uint32 | +--ro up-time? string | +--ro jumbo-capable? boolean | +--ro poe-capable? boolean | +
System Alarm Use the following definition to display the Alarm entries: Module: STATS URI: /api/operational/dell/stats/alarms Methods Supported: GET System Alarm Model +--ro alarms +--ro major-alarms [index] | +--ro index uint32 | +--ro alarm-description? string | +--ro duration? yang:timestamp +--ro 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-of
System Version The following definition displays version-info: Module: STATS URI: /api/operational/dell/stats/version-info Methods Supported: GET System Version Model +--ro version-info +--ro os-ver? string +--ro sw-ver? string +--ro build-time? string +--ro build-path? string +--ro up-time? string +--ro image-name? string +--ro 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 [ind
Operational Data for IPv6 This section describes the method of fetching the IPv6 operational data. Interface Use the following definition to get the statistics of IPv6 Interface operational data.
+--ro reports-received? yang:counter32 +--ro reports-sent? yang:counter32 +--ro leaves-sent? yang:counter32 +--ro mldv2-queries-received? yang:counter32 | +--ro mldv1-queries-received? yang:counter32 | +--ro errors-malformed-pkts? yang:counter32 +--ro neighbors* [ipv6-address] | +--ro ipv6-address dell:ipv6-address-with-prefix | +--ro intf-type? string | +--ro age-expires-in-mins? dell:hour-minute | +--ro vlan? dell:vlan-id-num +--ro state? enumeration | +--ro cpu? enumeration | +--ro hardware-address? stri
Prefix-list Use the following definition to get the IPv6 Prefix– list data: Module: PREFIX-LIST URI: /api/operational/dell/stats/ipv6/prefix-list Methods Supported: GET Prefix-List Model for IPv6 +--ro prefix-list +--ro last-deletion-insertion? dell:prefix-list-name +--ro prefix-list-name* [name] +--ro name dell:prefix-list-name +--ro count? uint32 +--ro range-entries? uint32 +--ro sequence-min? uint32 +--ro sequence-max? uint32 +--ro seq* [seq-num] +--ro seq-num uint32 +--ro action? enumeration +--ro
+--ro +--ro +--ro +--ro +--ro dynamic-in-active? static-active? static-inactive? route-size-active? route-size-in-active? uint32 uint32 uint32 uint32 uint32 Management Information Base (MIB) Management Information Base (MIB) is a database of objects that can be monitored by a network management system. Dell EMC Networking OS management information system (MIB) supports many new simple network management protocol (SNMP) objects and notifications.
| +--ro dellNetBgpM2PeerLocalAddr inet:ip-address | +--ro dellNetBgpM2PeerLocalPort? inet-address:InetPortNumber | +--ro dellNetBgpM2PeerLocalAs? inetaddress:InetAutonomousSystemNumber | +--ro dellNetBgpM2PeerRemoteAddr inet:ip-address | +--ro dellNetBgpM2PeerRemotePort? inet-address:InetPortNumber | +--ro dellNetBgpM2PeerRemoteAs? inetaddress:InetAutonomousSystemNumber | +--ro dellNetBgpM2PeerIndex? uint32 | +--ro dellNetBgpM2PeerLastErrorReceived? binary | +--ro dellNetBgpM2PeerLastErrorSent? binary | +--
| +--ro dellNetBgpM2CfgPeerConfiguredVersion? uint32 | +--ro dellNetBgpM2CfgAllowVersionNegotiation? snmpv2-tc:TruthValue | +--ro dellNetBgpM2CfgPeerLocalAddr? inet:ip-address | +--ro dellNetBgpM2CfgPeerLocalAs? inetaddress:InetAutonomousSystemNumber | +--ro dellNetBgpM2CfgPeerRemoteAddr? inet:ip-address | +--ro dellNetBgpM2CfgPeerRemoteAs? inetaddress:InetAutonomousSystemNumber | +--ro dellNetBgpM2CfgPeerEntryStorageType? snmpv2-tc:StorageType | +--ro dellNetBgpM2CfgPeerError? enumeration | +--ro dellNetBg
+--ro dellNetBgpM2PathAttrUnknownTable* [dellNetBgpM2PathAttrIndex dellNetBgpM2PathAttrUnknownIndex] | +--ro dellNetBgpM2PathAttrIndex uint32 | +--ro dellNetBgpM2PathAttrUnknownIndex uint32 | +--ro dellNetBgpM2PathAttrUnknownType? uint32 | +--ro dellNetBgpM2PathAttrUnknownValue? binary +--ro dellNetBgpM2PathAttrCommTable* [dellNetBgpM2PathAttrIndex dellNetBgpM2PathAttrCommIndex] | +--ro dellNetBgpM2PathAttrIndex uint32 | +--ro dellNetBgpM2PathAttrCommIndex uint32 | +--ro dellNetBgpM2PathAttrCommValue? mib:d
+--ro +--ro +--ro +--ro +--ro +--ro +--ro +--ro chSysCardNumber uint32 dellNetInetCidrRouteDest string dellNetInetCidrRouteNextHop string dellNetInetCidrRouteFirstHop string dellNetInetCidrRouteIfIndex? uint32 dellNetInetCidrRouteMacAddress? string dellNetInetCidrRouteEgressPort? string dellNetInetCidrRouteCamIndex? uint32 Forwarding Plane Statistics The following definition displays the Forwarding Plane statistics: Module: FP-STATS URI: /api/operational/mib/fp-stats Methods Supported: GET Forwarding
| +--ro txPktUnit3? int32 +--ro fp-cpu-party-bus-stats-table* [stackUnitId] | +--ro stackUnitId int32 | +--ro inputPackets? int32 | +--ro inputBytes? int32 | +--ro inputDropped? int32 | +--ro inputError? int32 | +--ro outputPackets? int32 | +--ro outputBytes? int32 | +--ro outputError? int32 +--ro fp-drops-table* [stackUnitId stackPortId] | +--ro stackUnitId int32 | +--ro stackPortId int32 | +--ro inDrops? yang:counter64 | +--ro inIBPCBPFullDrops? yang:counter64 | +--ro inPortSTPnotFwdDrops? yang:counter64
IF MIB Model +--ro mib +--ro if-mib +--ro ifNumber? int32 +--ro ifTable* [ifIndex] +--ro ifIndex mib:InterfaceIndex +--ro ifDescr? smiv2:DisplayString +--ro ifType? ianaiftype-mib:IANAifType +--ro ifMtu? int32 +--ro ifSpeed? yang:gauge32 +--ro ifPhysAddress? yang:phys-address +--ro ifAdminStatus? enumeration +--ro ifOperStatus? enumeration +--ro ifLastChange? yang:timeticks +--ro ifInOctets? yang:counter32 +--ro ifInUcastPkts? yang:counter32 x--ro ifInNUcastPkts? yang:counter32 +--ro ifInDiscards? yang:coun
IETF Interface Operations The following definition configures and displays the properties of an Interface using IETF: Module: IETF INTERFACE URI: /api/operational/interfaces Methods Supported: GET, PATCH, and PUT IETF Interface Model +--rw interfaces +--rw interface [name] +--rw name +--rw description? +--ro type? +--ro location? +--rw enabled? +--ro if-index? +--rw mtu? +--rw link-up-down-trap-enable? +--rw rate-interval? string string ianaift:iana-if-type string boolean int32 uint32 enumeration uint
Samples of the config-command Following is the sample output of CONFIG command: To configure an IP address: Input.xml: interface vlan 100\r\n ip address 1.2.3.4/24 curl -u demo:demo -X POST -T Input.xml http://:8008/api/running/dell/ _operations/cli
Samples of the show-command Following is the sample output of SHOW command: Input.xml: version curl -u demo:demo -X POST -T Input.xml http://:8008/api/running/dell/ _operations/cli
13 REST API CLI The REST API CLI commands are supported on the S4810, S4820T, S3048–ON, S4048–ON, S4048T–ON, S5048F-ON, S6000, S6000– ON, S6010–ON, S6100–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.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.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.
state state-name (OPTIONAL) Enter the keyword state then the name of the state to include in the certificate. The default is California. validity days (OPTIONAL) Enter the keyword validity then the number of days the certificate is valid. The validity range is from 1 to 10000 days. The default value is 3650 days (10 years). Command Modes EXEC Command History This guide is platform-specific.
The following is a list of the Dell EMC Networking OS version history for this command. Usage Information Version Description 9.10(0.1) Introduced on the S4048T–ON and S6010–ON. 9.10(0.0) Introduced on the C9010 and S6100–ON. Removed the rest-server option. 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 S Series and Z Series switches.
Example DellEMC#show crypto cert Certificate: Data: Version: 3 (0x2) Serial Number: 7 (0x7) Signature Algorithm: sha1WithRSAEncryption Issuer: C=US, CN=Dell, O=Dell, OU=Dell EMC Networking, L=SAN Jose, ST=California Validity Not Before: Feb 15 14:06:42 2016 GMT Not After : Feb 12 14:06:42 2026 GMT Subject: C=US, CN=Dell, O=Dell, OU=Dell EMC Networking, L=SAN Jose, ST=California X509v3 extensions: X509v3 Subject Key Identifier: DA:39:A3:EE:5E:6B:4B:0D:32:55:BF:EF:95:60:18:90:AF:D8:07:09 DellEMC# show ip re
Example of the rest DellEMC#show ip rest-server service enabled over REST server status REST server protocol a secure HTTP REST server port DellEMC# 202 REST API CLI : enabled : HTTPS : 8888
14 Web Server You download web server with HTTP[S] support with the SmartScripts package. It is supported on the S4810, S4820T, S3100 Series, S3048–ON, S4048–ON, S4048T–ON, S5000, S5048F-ON, S6000, S6000–ON, S6010–ON, S6100–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.
