Dell FORCE10 Open Automation User Manual

Smart Scripting | 25
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.
F10DeleteVlanId (vlanId) Deletes a VLAN on the switch.
F10ExecShowCmd (command) Executes a specified show command.
F10MakeLagIntNoShutdown (lagId) Enables the specified port channel.
F10MakeLagIntShutdown (lagId) Disables the specified port channel.
F10MakeLagIntSwitch (lagId) Configures the specified port channel (LAG) as a Layer 2
switchport.
F10MakePhyIntNoShutdown (stackUnitNum, portId) Enables the specified port.
F10MakePhyIntShutdown (stackUnitNum, portId) Disables the specified port.
F10MakePhyIntSwitch (stackUnitNum, portId) Configures the specified port as a Layer 2 switchport.
F10MakeVlanIntNoShutdow
n
(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.
F10ShowBGPSummary None Returns summary information on BGP sessions.
F10ShowBootVar None Returns system boot variables.
F10ShowEnvironment None Returns environment-monitoring variable values.
F10ShowIntBrief None Returns brief interface status (up/down/admin up/admin down) of
all interfaces.
F10ShowIntBriefLag None Returns brief interface status (up/down/ admin up/down) of all
port-channel interfaces.
F10ShowIntBriefMan None Returns brief interface status (up/down/ admin up/down) of all
management interfaces.
F10ShowIntBriefPhy None Returns brief interface status (up/down/ admin up/down) of all
physical interfaces.
F10ShowIntBriefVlan None Returns brief interface status (up/down/ admin up/down) of all
VLAN interfaces.
F10ShowIPRoute None Returns routing table information.
F10ShowISISNeighbors None Returns list of ISIS neighbors.
F10ShowISISRoute None Returns the table of ISIS-learned routes.
F10ShowLagIntStatus (lagId) Returns the detailed status of a specified port-channel interface.

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.