Dell FORCE10 Open Automation User Manual

Smart Scripting | 31
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.py file is the main API library file that contains the
functions that you can include in a UNIX shell script. The F10SmartScriptUtils.py
file is downloaded with the Programmatic Management package and is stored at /usr/
pkg/scripts/smartutils. Table 3-5 describes the FTOS operations that you can invoke
from a UNIX shell script, including the supported functions and required arguments.
Figure 3-5 shows an example of how to write a script in the UNIX shell scripting
language. You can store a UNIX shell script anywhere on the switch.
Figure 3-5. Script Written in the UNIX Shell Scripting Language: Example
#!/bin/sh
i=$1
while [ $i -le $2 ]
do
echo $i
/usr/pkg/bin/python /usr/pkg/scripts/smartutils/F10SmartScriptUtils.py createvlanid $i
(( i++ ))
done
Table 3-5. Supported API Functions in UNIX Shell Scripts
Function Arguments Description
addlaginttovlan lagId, vlanId, tagFlag Adds a port channel (LAG) to a VLAN.
tagFlag values: 1 (tagged) or 0 (untagged).
addphyinttovlan stackunitNum, portId
vlanId, tagFlag
Adds an interface to a VLAN.
tagFlag values: 1 (tagged) or 0 (untagged).
createvlanid vlanId Creates a VLAN with a specified VLAN ID.
deletevlanid vlanId Deletes a VLAN with a specified VLAN ID
makelagintnoshutdown lagId Enables the specified port channel.
makelagintshutdown lagId Disables the specified port channel.
makelagintswitch lagId Configures the specified port channel (LAG) as a Layer 2
switchport.

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.