Open Automation Guide Configuration and Command Line Reference February 2013
Notes, Cautions, and Warnings NOTE: A NOTE indicates important information that helps you make better use of your computer. CAUTION: A CAUTION WARNING: A WARNING indicates a potential for property damage, personal injury, or death. Information in this publication is subject to change without notice. © 2013 Dell Force10. All rights reserved. Reproduction of these materials in any manner whatsoever without the written permission of Dell Inc. is strictly forbidden.
1 About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 Objectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Supported Platforms and Required FTOS Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Conventions . . . . . . .
www.dell.com | support.dell.com 5 Virtual Server Networking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Hypervisor Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 VSN Persistency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1 About this Guide Objectives This document describes the components and uses of the Open Automation Framework designed to run on the Force10 Operating System (FTOS), including: • • • • Smart Scripting Virtual Server Networking (VSN) Programmatic Management Web graphic user interface (GUI) and HTTP Server Information another feature, Bare Metal Provisioning (BMP) that interacts with the Open Automation Framework can be found in the FTOS Configuration Guide.
www.dell.com | support.dell.com • • S4810 switches require FTOS version 8.3.10.1 or later. Z9000 switches require FTOS version 9.0.0.0 or later. (SmartScripts and SmartUtil support only). Conventions This document uses the following conventions to describe command syntax: Convention Description keyword Keywords are shown in bold and should be entered in the CLI as listed. parameter Parameters are shown in italics and require a number or word to be entered in the CLI.
Related Documents For more information about the Dell Force10 Networks switches discussed in this document, refer to the following documents: • • • • • S55 • FTOS Command Line Reference Guide for the S55 System • FTOS Configuration Guide for the S55 System • Installing the S55 System S60 • FTOS Command Line Reference Guide for the S60 System • FTOS Configuration Guide for the S60 System • Installing the S60 System S4810 • FTOS Command Line Reference Guide for the S4810 System • FTOS Configuration Guide
| About this Guide www.dell.com | support.dell.
2 Open Automation Framework Open Automation Framework is supported on platforms: z Dell Force10’s Open Automation Framework is designed to provide an open, industry standards-based automation technology that simplifies the management of dynamic virtual data centers and reduces risk and overhead.
www.dell.com | support.dell.com • • Programmatic Management Web GUI and HTTP server You can use these components together or independently to extend and add functionality to the FTOS operating system without requiring updates to an FTOS release. Figure 2-1. Bare Metal Provisioning Open Automation Framework Smart Scripting Virtual Server Networking Programmatic Management Web GUI and HTTP Server Note: The Open Automation Framework is referred to as Open Automation in the rest of this document.
Smart Scripting Smart Scripting provides: • • Support for industry-standard languages, such as Perl and Python, avoiding the need to learn a new proprietary scripting language Customization of device monitoring and management to suit your network needs, including custom maintenance tasks, discovery programs, and event logging for faster problem resolution Smart scripting increases network availability and manageability by allowing network administrators to deploy custom monitoring and management scripts o
www.dell.com | support.dell.com Programmatic Management Programmatic Management provides application programming interfaces (APIs) so that FTOS switches can be managed by in-house or third-party system management tools. • • • Common third-party management tool sets are supported as plug-ins to the Open Automation Framework, including Dell AIM, EMC Smarts Ionix, IBM Systems Director, HP Network Automation (NA), CA Spectrum Infrastructure Manager, and Oracle Enterprise Manager (OEM).
3 Smart Scripting Smart Scripting is supported on platforms: z Smart Scripting allows you to add functionality to the FTOS operating system without requiring updates to the FTOS release. Smart Scripting is available as a separate installable package that supports TCL, ZCL, Expect, PERL, Python, and UNIX scripting and various FTOS functions.
www.dell.com | support.dell.com Smart Scripting also offers solutions in a UNIX environment that are useful to cloud administrators who are familiar with working directly in a UNIX shell. Script support in a UNIX environment allows you to invoke standard UNIX utilities, such as netstat, tcpdump, ls, chmod, chown, and so on. Smart Scripting includes a convenient set of API function libraries to which script developers can refer when they create PERL, Python, and UNIX scripts.
• • • Reporting switch memory usage, configured VLANs, and other operating and configuration parameters. Creating custom APIs for external applications to access the switch. Automating custom provisioning of network devices to support server virtualization. For example, you can automate any of the following tasks: • • • • • • • Monitor the configuration of switch ports to verify that no change occurs and generate an alarm if a configuration change is detected as part of a cloud-computing deployment.
www.dell.com | support.dell.com Installing Smart Scripting You install the Smart Scripting file in the same way as you install an FTOS release: directly from local flash memory on a switch or from an external drive on a network server. Because the installation takes time, it is performed in the background. When the download is complete, a message is displayed on the console. The package installation updates the running-configuration file. CAUTION You can modify (e.g.
To remove an installed Open Automation package, such as Smart Scripting, enter the package uninstall command. To follow the progress of a package installation (or removal), enter the show packages command. Displaying Installed Packages To view the Open Automation packages currently installed on a switch, including version numbers and content, enter the show packages command. Command Syntax Command Mode Task show packages EXEC Privilege View package information.
www.dell.com | support.dell.com Table 3-1. Limits on System Attributes System Attribute Value Description datasize 131,072 KB Maximum size of the data segment for a process; this value defines how far a program may extend its break with the sbrk(2) system call. stacksize 2,048 KB Maximum size of the stack segment for a process; this value defines how far a program's stack segment may be extended. Stack extension is performed automatically by the system.
Table 3-2. Supported UNIX Utilities (continued) fc List the history of commands on the computer. fg Change the background process to foreground. file Determine file type. find Walk a file hierarchy. ftp Internet file transfer program. getopts Called each time you want to process an argument. grep Print lines matching a pattern. hostname Set or print name of current host system. ifconfig Configure network interface parameters. iostat Report I/O statistics. ln Make links.
www.dell.com | support.dell.com Creating PERL, Python and UNIX Scripts When you install the Smart Scripting package, sample PERL and Python scripts are installed in the /usr/pkg/scripts/sample_scripts directory. You can also create your own customized scripts and store them anywhere on the switch, such as in a /f10/ flash_ scripts directory. In addition, you can use the PERL, Python, and UNIX APIs to create scripts that invoke function calls directly in the FTOS CLI.
Running a Script from the FTOS CLI You can run any PERL, Python, and UNIX script that is stored on the switch from the FTOS CLI. When you run a script from the FTOS CLI, you can specify an optional user name to apply the associated read-write privileges when the script is run (see Creating a User Name and Password for Smart Scripting). If you do not specify a user name, the script is run with the privileges of the current user.
www.dell.com | support.dell.com Logging in to a NetBSD UNIX Shell To log in to the NetBSD UNIX shell on a switch to directly enter any of the UNIX commands described in Table 3-2 or to run a script, enter the start shell command. You are prompted to enter a user name and password before you can access the shell. Login is performed using SSHv2. Command Syntax Command Mode Task start shell EXEC Privilege Access the shell to run UNIX commands or a script (see Running a Script from the UNIX Shell).
Figure 3-2. Execution of a PERL, Python, and Shell Script from a UNIX Shell: Example FTOS# start shell <---------------------------------- Log on to a UNIX shell 4.4 BSD UNIX () (ttyp0) login: admin Password: Copyright (c) 1996, 1997, 1998, 1999, 2000, 2001, 2002 The NetBSD Foundation, Inc. All rights reserved. Copyright (c) 1980, 1983, 1986, 1988, 1990, 1991, 1993, 1994 The Regents of the University of California. All rights reserved.
www.dell.com | support.dell.com Figure 3-3. PERL Script with API function call: Example #!/usr/pkg/bin/perl -w require '/usr/pkg/scripts/smartutils/F10SmartUtils.pl'; <------ Load the PERL API usage() if ($#ARGV < 1); ($start,$end)=@ARGV; $startVlan = $start; $endVlan = $end; for (my $i=$startVlan;$i<=$endVlan;$i++) { my $createvlanId = F10CreateVlanId($i); <-------------------- Invoke a PERL API function } sub usage { print "usage: createVlans.
Table 3-3. Supported FTOS API Functions in PERL Scripts PERL API Function Arguments Description F10AddLagIntToVlan (lagId, vlanId, tagFlag) Adds a LAG interface to a VLAN as either tagged or untagged. tagFlag values: 1 (tagged) or 0 (untagged). F10AddPhyIntToVlan (stackUnitNum, portId, vlanId, tagFlag) Adds a physical interface to a VLAN as either tagged or untagged. tagFlag values: 1 (tagged) or 0 (untagged). F10CreateVlanId (vlanId) Creates a VLAN on the switch.
www.dell.com | support.dell.com Table 3-3. Supported FTOS API Functions in PERL Scripts (continued) F10ShowLagIntVlanMember (lagId) s Returns information on VLAN membership for a specified port-channel interface. F10ShowLog None Returns the switch log buffer. F10ShowMacAddrTbl None Returns the table of learned MAC addresses. F10ShowMem (lagId) Returns switch memory usage. F10ShowOSPFNeighbors None Returns list of OSPF neighbors.
To configure the username and passwords in the smartutils.cfg file that are used to run PERL API scripts, do one of the following: • • From the Web user interface, select Settings > SmartUtils Credentials (see Menu Options). From a UNIX shell, use the UNIX text editor to open the smartutils.cfg file, enter a user name and password, and save the file. To run a PERL API script: • • From the FTOS CLI, use the script command as described in Running a Script from the FTOS CLI.
www.dell.com | support.dell.com Figure 3-4. Python Script with API function call: Example #!/usr/pkg/bin/python import sys sys.path.append('/usr/pkg/scripts/smartutils') <--------------- Load the Python API import F10SmartUtils def create_vlans(startId,endId): for vlanId in range(startId,endId+1): result = F10SmartUtils.
Table 3-4. Supported FTOS API Functions in Python Scripts (continued) F10MakeVlanIntNoShutdown (vlanId) Enables the specified VLAN interface. F10MakeVlanIntShutdown (vlanId) Disables the specified VLAN interface. F10Ping (ipAddress) Pings (via ICMP) an IP address from the switch. F10ShowArpTbl None Returns the table of learned ARP entries. F10ShowBGPNeighbors None Returns list of BGP neighbors. F10ShowBGPRoute None Returns the table of BGP-learned routes.
www.dell.com | support.dell.com Table 3-4. Supported FTOS API Functions in Python Scripts (continued) F10ShowVlanIntStatus (vlanId) Returns the detailed status of a specified VLAN interface. F10ShowVrrp None Returns the full VRRP status output. F10ShowVrrpBrief None Returns a brief VRRP session summary. F10Traceroute (ipAddress, timeout) Performs a traceroute operation to an IP address from the switch. F10WriteMem None Write the running configuration to the startup configuration file.
Using UNIX Shell Scripting Use the information in this section to create a UNIX script using the UNIX API and run the script on a Dell Force10 switch. For information on how to create and run a PERL or Python script using the PERL or Python API, see Supported UNIX Utilities and Using the Python API. Creating a UNIX API Script Use the information in this section to create a UNIX shell script to be run on a Dell Force10 switch. The F10SmartScriptUtils.
www.dell.com | support.dell.com Table 3-5. 32 | Supported API Functions in UNIX Shell Scripts (continued) makephyintnoshutdown stackUnitNum, portId Enables the specified port. makephyintshutdown stackUnitNum, portId Disables the specified port. makephyintswitch stackunitNum, portId Configures the specified port as a Layer 2 switchport. makevlanintnoshutdown vlanId Enables the specified VLAN interface. makevlanintshutdown vlanId Disables the specified VLAN interface.
Table 3-5. Supported API Functions in UNIX Shell Scripts (continued) showvlan None Returns information on all VLANs, including membership. showvlanid vlanId Returns detailed interface information for a specified VLAN. showvlanintstatus vlanId Returns VLAN interface status. showvrrp None Returns the full VRRP status output. showvrrpbrief None Returns a brief VRRP session summary. traceroute ipAddress, timeout Performs a traceroute operation to an IP address from the switch.
| Smart Scripting www.dell.com | support.dell.
4 Smart Scripting CLI Overview Smart Scripting CLI is supported on platforms: z Commands • • • • • • package install package uninstall script show packages start shell username package install z Syntax Parameters Defaults Command Modes Command History Install the Smart Scripting package. This command downloads the package from the specified location, and installs it in the internal flash memory on a switch.
www.dell.com | support.dell.com Usage Information Version 8.3.5.1 Introduced on the S55. Version 8.3.3.4 Introduced on the S60. Because the installing of an Open Automation package may take time, the installation is performed in the background when the download finishes. A message is displayed on the console when the installation is complete. To follow the progress of a package installation, enter the show packages command.
script Run a Perl, Python, or UNIX shell script from the FTOS CLI. z Syntax Parameters Defaults Command Modes Command History Usage Information script [username name] script-name [script-parameter script-parameter ...] username name (Optional) Enter the user name whose read-write privileges will be applied when the script is run. A username used to run scripts cannot contain special characters.
www.dell.com | support.dell.com Enter the no script script-name command to stop a running script. To display the scripts that are currently running, including the scripts you have stopped, enter the show running-config | grep command. show packages z Syntax Defaults Command Modes Display the installed Open Automation packages, including version number and contents. show packages None EXEC EXEC Privilege Command History 38 | Smart Scripting CLI Version 9.0.0.0 Introduced on the Z9000. Version 8.3.
Example FTOS# show packages * Package Name: SMARTSCRIPTS Version: 2.0.0 Python 2.6.5 Perl 5.8.8 Data::Dumper 2.126 Class::MethodMaker 2.16 ExtUtils::MakeMaker 6.56 XML::NamespaceSupport 1.11 XML::SAX 0.96 XML::LibXML 1.70 Compress::Raw::Bzip2 2.027 Compress::Raw::Zlib 2.027 IO::Compress 2.027 URI 1.54 HTML::Tagset 3.20 HTML::Parser 3.65 LWP 5.836 Net::Telnet 3.03 OSSP::uuid 1.0602 UUID 0.02 version 0.82 Class::Inspector 1.24 Task::Weaken 1.03 Algorithm::Diff 1.1902 Text::Diff 1.37 SOAP::Lite 0.
www.dell.com | support.dell.com Example FTOS# show packages * Package Name:SMARTSCRIPTS-Z Version: 2.0.0 Python 2.6.5 Perl 5.8.8 Data::Dumper 2.126 Class::MethodMaker 2.16 ExtUtils::MakeMaker 6.56 XML::NamespaceSupport 1.11 XML::SAX 0.96 XML::LibXML 1.70 Compress::Raw::Bzip2 2.027 Compress::Raw::Zlib 2.027 IO::Compress 2.027 URI 1.54 HTML::Tagset 3.20 HTML::Parser 3.65 LWP 5.836 Net::Telnet 3.03 OSSP::uuid 1.0602 UUID 0.02 version 0.82 Class::Inspector 1.24 Task::Weaken 1.03 Algorithm::Diff 1.
start shell Start a NetBSD UNIX shell. z Syntax Defaults Command Modes Command History Usage Information start shell None EXEC Privilege Version 9.0.0.0 Introduced on the Z9000. Version 8.3.8.0 Introduced on the S4810. Version 8.3.5.1 Introduced on the S55. Version 8.3.3.4 Introduced on the S60. You must start an NetBSD shell on a switch before you can enter UNIX commands (Table 3-2) or run a script directly from the shell to invoke FTOS operations (see Running a Script from the UNIX Shell).
www.dell.com | support.dell.com username z Syntax username name password password Enter no username to remove the user name and password. Defaults Parameters Command Modes Command History Usage Information 42 Configure an additional user name and password to be used only to run scripts on a switch. The user name and password are used to log in to a UNIX shell and apply the read-write privileges assigned to the user name when a script is run.
5 Virtual Server Networking Virtual Server Networking is supported on platforms: As a part of the Open Automation package, Virtual Switch Networking (VSN) provides real-time communication between the Dell Force10 network fabric and virtual servers to automate network management and configuration tasks throughout the data center.
www.dell.com | support.dell.com Both VMware and Citrix Xen provide SDKs and APIs for accessing their configuration objects. VSN requires Layer 3 connectivity to access a hypervisor. Figure 5-1 shows an example of the network architecture in which a Dell FTOS switch is connected to multiple servers, each of which may run a different type of hypervisor.
Hypervisor Modes There are two modes for retrieving configuration information from a hypervisor on a virtual server: • • Check: VSN retrieves configuration information from a hypervisor and notifies the system administrator when there is a change in the network configuration; for example, when a VLAN is added or removed. A system administrator must make manual updates to the FTOS configuration.
www.dell.com | support.dell.com Enter the show vlan command to display the VSN hypervisor-learned VLANs on the switch. As shown in Figure 5-2, VSN VLANs that have been automatically configured are displayed with a G tag in the left-most column and are associated with ports marked with an H tag. If a VSN VLAN has been manually configured on the switch, the VLAN has no tag; the associated ports are displayed with an H tag. Figure 5-2.
Prerequisites: - Smart Scripting is a prerequisite for using Virtual Server Networking. You must first install the Smart Scripting package before you can run the VSN application (see Installing Smart Scripting) To install the VSN package: 1. On a PC or other network device, go to the Dell Force10 web portal at https://www.force10networks.com/CSPortal20/Main/SupportMain.aspx. Click Login, enter your user ID and password, and click the Login button. 2.
www.dell.com | support.dell.com Enabling VSN in a Hypervisor Session Restrictions: - VSN is not supported in stacked configurations; it is only supported on standalone units. - VSN supports connections only with VMware and Xen hypervisors - You can define up to eight hypervisor sessions on a switch. - To connect with a VMware hypervisor running on an ESXi 5.0 server, you must configure the server's firewall to allow connections only through the management IP address.
Step 4 Task Command Syntax Command Mode Establish the connection between the switch and a hypervisor access url username username password password HYPERVISOR Where url is one of the following values: For a VMware hypervisor: https://[ip-address]/sdk/vimService username [name] password [password] For an Xen hypervisor: http://ip-address username [name] password [password] username name: Username to be used for authentication on the server.
www.dell.com | support.dell.com Discovery The discovery process starts after you enter the no disable command on the interface and ends 10 minutes after connectivity is established between the switch and hypervisor. If no connectivity is established, the switch attempts to connect for three minutes and then stops. Refer to Connectivity for more details on this process.
If connectivity to a hypervisor is lost after information is retrieved and used to reconfigure a switch, the following log message is displayed. The VSN agent tries to connect to the hypervisor in the background. The information that was retrieved from the hypervisor is not deleted. Message 4 Xen-Citrix:Lost connection to hypervisor xen217. Retrying...
www.dell.com | support.dell.com To run a VSN script (Perl or Python) in all connected hypervisor sessions to retrieve virtual server configurations and update FTOS settings on the switch, enter the script command in configuration mode. Command Syntax Command Mode Task script script-name CONFIGURATION Run a VSN script in active sessions on VMware and Xen hypervisors.
Uninstalling VSN Caution: Before you uninstall the VSN package, you must first stop all VSN scripts that are currently running using the no script script-name command. Uninstalling the VSN package removes it from the internal flash memory on a switch. Command Syntax Command Mode Task package uninstall name Enter the name of the VSN package, exactly as it appears in show packages output. EXEC Privilege Uninstall the VSN package from the system.
www.dell.com | support.dell.com To display the components of current hypervisor sessions, including the link, virtual switch, and hypervisor to which the switch is connected, enter the show virtualswitch command. Command Syntax Command Mode Task show virtualswitch [interface] [virtualswitch-name] EXEC Privilege Display general information on current hypervisor sessions.
Figure 5-7.
| Virtual Server Networking www.dell.com | support.dell.
6 Virtual Server Networking CLI Overview Virtual Server Networking CLI is supported on platforms: Note: VSN is not supported in stacked configurations; it is only supported on standalone switches.
www.dell.com | support.dell.com access Configure the connection to access a hypervisor. Syntax Parameters Defaults Command Modes Command History Usage Information [no] access url username name password password url Enter the URL location of the desired hypervisor.
hypervisor Specify the name of a hypervisor session with which VSN will connect. Syntax Parameters [no] hypervisor name name Defaults None Command Modes Command History Enter up to 40 characters to specify the name of a hypervisor session to which you want to connect on network servers. CONFIGURATION Version 8.3.8.0 Introduced on the S4810. Version 8.3.5.1 Introduced on the S55. Version 8.3.3.4 Introduced on the S60.
www.dell.com | support.dell.com Usage Information You can use the mode command to change the way in which virtual-server information is retrieved in an existing hypervisor session.
package uninstall Remove an installed Open Automation package, such as Virtual Server Networking, from the system. package uninstall name Syntax Parameters Defaults Command Modes Command History Usage Information name Enter the name of the Open Automation package, exactly as it appears in the show packages list. None EXEC Privilege Version 8.3.8.0 Introduced on the S4810. Version 8.3.5.1 Introduced on the S55. Version 8.3.3.4 Introduced on the S60.
www.dell.com | support.dell.com script Run an installed VSN script (Perl or Python) on active hypervisor links to retrieve virtual server configurations and update FTOS settings on the switch. Syntax [no] script script-name Enter the no script script-name to stop a running script. Parameters Defaults Command Modes Command History Usage Information script-name Enter the directory path and filename of where the VSN script is stored; for example, /usr/pkg/scripts/VSNAgent/VMWare/ VSNAgent.pl.
show hypervisor supported Display the types of hypervisors currently supported by VSN. Syntax show hypervisor supported Defaults None Command Modes Command History EXEC Privilege Version 8.3.8.0 Introduced on the S4810. Version 8.3.5.1 Introduced on the S55. Version 8.3.3.4 Introduced on the S60. Usage Information Related Commands Example Use this information when defining types of hypervisor connections with the hypervisor command. hypervisor Define a hypervisor instance.
www.dell.com | support.dell.com Example FTOS#show packages **************************************** * Package Name:SMARTSCRIPTS Version: 2.0.0 Python Perl 2.6.5 5.8.8 Data::Dumper 2.126 Class::MethodMaker 2.16 ExtUtils::MakeMaker 6.56 XML::NamespaceSupport 1.11 XML::SAX 0.96 XML::LibXML 1.70 Compress::Raw::Bzip2 2.027 Compress::Raw::Zlib 2.027 IO::Compress 2.027 URI 1.54 HTML::Tagset 3.20 HTML::Parser 3.65 LWP 5.836 Net::Telnet 3.03 OSSP::uuid 1.0602 UUID 0.02 version 0.82 Class::Inspector 1.
show virtualswitch Display the components of current hypervisor sessions, including the virtual switch and name of the hypervisor session to which a switch interface is connected, Syntax Defaults Parameters Command Modes Command History Usage Information show virtualswitch [interface] [virtualswitch-name] None interface Display information on the hypervisor session established on a specified interface.
www.dell.com | support.dell.com The following command output displays information on the hypervisor session established on virtual switch vSwitch3 on a VMware server connected to the interface 0/32. FTOS#show virtualswitch Gigabitethernet 0/32 vSwitch3 Interface :Gi 0/32 Hypervisor Type :vmware Hypervisor Name :vmware207 Hypervisor Version :4.1.
show vmmap Display the virtual machines accessed on a switch interface. Syntax Defaults Parameters Command Modes Command History Usage Information Related Commands Example show vmmap interface None interface Display information on the virtual machines accessed on a specified interface.
www.dell.com | support.dell.com type Set the hypervisor type to which you want to connect. Syntax Defaults Parameters Command Modes Usage Information Command History [no] type {vmware | xen-citrix} None vmware Set the hypervisor type as VMware. xen-citrix Set the hypervisor type as Xen-Citrix. HYPERVISOR You must configure a hypervisor type in order to enable VSN connections with virtual servers. Use the show hypervisor supported command to display the currently supported hypervisor types.
7 Programmatic Management Programmatic Management is supported on platforms: and is downloaded with the SmartScripts package (see Downloading the Smart Scripting Package). Note: This feature is not currently supported on the Z9000 platform. Overview In the Open Automation framework, Programmatic Management allows you to remotely manage Dell Force10 switches by invoking “out-of-the-box” scripts using the Representational State Transfer (REST) application programming interface (API).
www.dell.com | support.dell.com Using the REST API The script-based REST API allows you to remotely access a switch that supports Open Automation from a network management device through programmatic HTTP requests to directly perform FTOS functions. The REST API operates by invoking the CGI scripts within the HTTP server on the switch. The HTTP server passes an HTTP request to the backend CGI scripts. For more information on the HTTP server, see HTTP Server.
The following example shows how to embed an HTTP get request in Python script. Figure 7-2. Python Sample with HTTP Get Request that Invokes the REST API #!/usr/bin/python import httplib conn = httplib.HTTPConnection("10.42.51.5") # Send HTTP GET request conn.request("GET","/cgi-bin/F10Ping?IpAddress=10.42.0.13") # Get response data response = conn.getresponse() # Display response texts on success or display status if(response.status == 200): # Handle response data data = response.
www.dell.com | support.dell.com 72 Table 7-1. | Supported Get Requests Invoked through the REST API HTTP Get Request FTOS CLI Operation F10Ping?IpAddress={ip-address} Pings a remote host from the switch using HTTP and returns the output. F10ShowArpTbl Returns a formatted table of known MAC address-to-IP address bindings. F10ShowBGPNeighbors Returns information on currently running BGP instances and discovered (configured or connected) BGP neighbors.
Plug-In Modules Programmatic Management are third-party management tools and applications that run on host devices in a data center network. Plug-in modules running on remote hosts work together to provide a framework that may invoke SNMP get and set requests, XML queries, and Telnet CLI commands on Dell Force10 switches.
| Programmatic Management www.dell.com | support.dell.
8 Web GUI and HTTP Server Web GUI and HTTP Server are supported on platforms and are downloaded with the SmartScripts package (see Downloading the Smart Scripting Package). This chapter describes the Web-based components in the Open Automation package: • • HTTP Server Web Graphical User Interface HTTP Server In the Open Automation package, the HTTP web server runs on a switch and handles HTTP requests from the Web-based graphical user interface (GUI).
www.dell.com | support.dell.com Web Graphical User Interface In the Open Automation package, the Web graphical user interface (GUI) provides a user-friendly way to retrieve configuration information from a switch by choosing a menu option. Getting Started To open the Web interface and get started on switch operations, follow these steps: Step Task Prerequisites: Only the following web browsers are supported: • • 1. 76 | Internet Explorer 7.0 or later Firefox 3.
2 To retrieve or change configuration parameters on the switch, click a menu name and then click a menu option. You may be prompted to enter more information. Refer to Table 8-1 for a list of the tasks you can perform by choosing each menu option. Refer to the Web Graphical User Interface for examples of the output of each menu option. Menu Options Table 8-1 describes the switch operation performed by each menu option. Table 8-1.
www.dell.com | support.dell.com Table 8-1. 78 Web User Interface: Supported Operations (continued) Interfaces > Management Displays the status and IP address of management interfaces. Protocols > VRRP Displays the currently configured VRRP instances on a switch, including status and session information. Protocols > VRRP Brief Displays summary information on BGP sessions and status. Protocols > BGP Summary Displays summary information on BGP sessions.
Appendix A Web Graphical User Interface This appendix contains examples of the output displayed for each menu option in the Web interface used in the Open Automation Framework for the menus: • • • • • • System Interfaces Protocols Diagnostics Utilities Settings System Menu System > Software Version System > Time/Date System > Memory Usage Web Graphical User Interface | 79
www.dell.com | support.dell.
System > Boot Variables System > Running Config Web Graphical User Interface | 81
www.dell.com | support.dell.
Interfaces Menu Interfaces > All Web Graphical User Interface | 83
www.dell.com | support.dell.
Interfaces > Management Web Graphical User Interface | 85
www.dell.com | support.dell.
Protocols > VRRP Brief Protocols > BGP Summary Web Graphical User Interface | 87
www.dell.com | support.dell.
Protocols > ISIS Neighbors Web Graphical User Interface | 89
www.dell.com | support.dell.
Diagnostics > System Log Web Graphical User Interface | 91
www.dell.com | support.dell.
Diagnostics > Int Bandwidth Web Graphical User Interface | 93
www.dell.com | support.dell.
Settings Menu Settings > SmartUtils Credentials Web Graphical User Interface | 95
www.dell.com | support.dell.
Index A APIs Perl 25 Python 28 REST 72 UNIX 31 B Bare Metal Provisioning description 10 switch autoconfiguration 10 D displaying installed OA packages Document conventions 6 17 E ESX hypervisor 44 H HTTP server description 12, 75 starting in secure mode 75 starting without SSL 75 hypervisors check and config modes 45 connecting to 51 discovering VMACs and VLANs displaying a session 53 displaying virtual machines 54 displaying VSN VLANs 46 enabling a session 48 removing a session 52 running a script 5
www.dell.com | support.dell.
