Dell FORCE10 Open Automation User Manual

Smart Scripting | 33
Running a UNIX API Script
When you run a UNIX shell script that invokes the API functions in Table 3-5, logon
credentials are read from the smartutils.cfg file, and a telnet session is opened on the
switch in which function calls are executed in the FTOS CLI. The script closes the
telnet session after running all the CLI commands.
The smartutils.cfg file is the configuration file used by the Programmatic
Management package. It contains the user name and passwords required to log on to
a switch via telnet and access the CLI to execute the function calls in a UNIX API
script. The smartutils.cfg file is downloaded with the Programmatic Management
package and is stored at /usr/pkg/scripts/smartutils.
To configure the username and passwords in the smartutils.cfg file that are used to
run UNIX 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 UNIX API script:
• From the FTOS CLI, use the
script command as described in Running a Script
from the FTOS CLI.
• From a UNIX shell, follow the procedure described in Running a Script from the
UNIX Shell.
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.
writemem None Write the running configuration to the startup configuration file.
Table 3-5. Supported API Functions in UNIX Shell Scripts (continued)
Note: The user name and passwords contained in the smartutils.cfg file are used to
log in and run only the scripts created using the PERL, Python, and UNIX APIs
described in this chapter
. A username used to run scripts cannot contain special
characters.

Dell FORCE10 Open Automation Specifications

General

Series	FORCE10
Model	Open Automation
Jumbo Frame Support	Yes
Product Type	Switch
Ports	Varies by model
Switching Capacity	Varies by model
Forwarding Rate	Varies by model
MAC Address Table Size	Varies by model
Power Supply	Varies by configuration
Operating Temperature	0°C to 40°C
Storage Temperature	-40°C to 70°C
Dimensions	Varies by model
Weight	Varies by model

Summary

Open Automation Framework

Bare Metal Provisioning

Automates the initial configuration and deployment of network devices.

Smart Scripting

Enables automation of network tasks using industry-standard scripting languages.

Virtual Server Networking

Automates network management for virtualized environments.

Programmatic Management

Allows remote management of switches using APIs and protocols.

Web GUI and HTTP Server

Provides a web-based interface for monitoring and managing the network.

Smart Scripting

Overview

Use Cases

Provides examples of how Smart Scripting can be used for automation.

Downloading the Smart Scripting Package

Installing Smart Scripting

Step-by-step guide for installing the Smart Scripting package.

Uninstalling Smart Scripting

Creating PERL, Python and UNIX Scripts

Guidance on developing scripts using different programming languages.

Creating a User Name and Password for Smart Scripting

Running a Script from the FTOS CLI

Instructions for executing scripts directly from the FTOS command-line interface.

Logging in to a NetBSD UNIX Shell

Running a Script from the UNIX Shell

How to execute scripts from within a NetBSD UNIX shell.

Using the PERL API

Utilizing the Perl API for interacting with switch functions.

Running a PERL API Script

Guidance on executing scripts that leverage the Perl API.

Using the Python API

Utilizing the Python API for interacting with switch functions.

Running a Python API Script

Guidance on executing scripts that leverage the Python API.

Using UNIX Shell Scripting

Leveraging UNIX shell scripts for network automation.

Creating a UNIX API Script

Developing shell scripts to interact with switch APIs.

Running a UNIX API Script

Executing shell scripts that utilize switch APIs.

Smart Scripting CLI

package install

Command to install Open Automation packages, such as Smart Scripting.

start shell

username

Virtual Server Networking

Hypervisor Modes

Explains the 'check' and 'config' modes for retrieving hypervisor data.

VLAN configuration

Installing VSN

Step-by-step guide for installing the Virtual Server Networking package.

Enabling VSN in a Hypervisor Session

How to configure and enable VSN sessions with hypervisors.

Discovery

Running VSN Scripts

Instructions for executing Perl or Python scripts for VSN functionality.

Stopping a Hypervisor Session

Uninstalling VSN

Viewing VSN information

Virtual Server Networking CLI

Commands

access

Command to configure the connection details for accessing a hypervisor.

disable

hypervisor

mode

package install

package uninstall

script

Command to run installed VSN scripts (Perl or Python).

show virtualswitch

show vmmap

type

vsn enable

Command to enable Virtual Server Networking on an interface.

Programmatic Management

Overview

Introduces remote switch management via APIs and protocols.

Using the REST API

Details how to use the Representational State Transfer API for management.

Plug-In Modules

Web GUI and HTTP Server

HTTP Server

Web Graphical User Interface

Getting Started

Menu Options

Protocols Menu

Protocols > VRRP

Protocols > VRRP Brief

Protocols > BGP Summary

Protocols > BGP Neighbors

Protocols > OSPF Neighbors

Protocols > ISIS Neighbors

Diagnostics Menu

Diagnostics > Arp Table

Diagnostics > Mac Address Table

Diagnostics > Routing Table

Diagnostics > System Log

Provides access to the system log messages and events.

Diagnostics > VLANS

Diagnostics > Int Bandwidth

Utilities Menu

Utilities > Ping

Utilities > Traceroute

Settings Menu

Settings > SmartUtils Credentials

Configures user credentials for SmartUtils to communicate with FTOS.