Table Of Contents

Introducing the Cisco ANA Shell Interface

Cisco ANA Shell Overview

Shell Users

Shell Command-Line Format

Shell Command Parameters

Introducing the Cisco ANA Shell Interface

---

This section describes the Cisco ANA shell interface, which is the command-line interface (CLI) of the Cisco ANA Shell Manage system. It supports a subset of the capabilities supported by the system for multilevel management of the network including VNEs, surveillance, and provisioning.

The Cisco ANA shell interface provides:

•A Cisco IOS-based CLI.

•A flat command hierarchy with a limited number of modes and unlimited number of nesting levels.

•Embedded inline help and command completion.

•The option to export all commands supported by the system.

•The basis for a user guide.

This chapter includes the following topics:

•Cisco ANA Shell Overview

•Shell Users

•Shell Command-Line Format

•Shell Command Parameters

Cisco ANA Shell Overview

The Cisco ANA shell serves as the front-end of the system and unifies the operations of all system components for the user. The shell interface requires Cisco ANA system components to support the following services:

Component	Services Required from the Component
Gateway	All required surveillance and provisioning commands supported by the gateway.
AVM	Management operations at AVM level, such as starting a new AVM.
VNE	VNE management operations, such as starting and stopping VNEs.

Shell Users

The primary users of the Cisco ANA shell interface are expected to be system administrators and users who are responsible for network operation tasks such as surveillance and provisioning.

Shell Command-Line Format

Each Cisco ANA shell command is described in a table with the following format:

Property	Description
Name
Description
Mode
Usage
General
Example
Output Format
	Field or Column	Description

Shell Command Parameters

This section defines the different types of parameters that can be used as arguments in Cisco ANA shell commands. All command parameters are strings in one of the formats described in Table 19-1.

Table 19-1 Cisco ANA Shell Command Parameters 

Parameter	Description	Format	Example
string	List of characters. If the string is not quoted, it must not contain white spaces. If the string contains white spaces, it must be quoted. To use quotes inside a string, escape them with a backslash.	—	user1 "the string \"string\""
name	The same as string. Used for clarity, for example as device name.	—	user1
integer	A string representing an integer.	—	352
vc	Identifier of an ATM VC.	<integer>["/"<integer>] Both integers must be at the range specified by ATM.	1/102
ip (=IPAddress)	IP address.	X.X.X.X	192.168.1.2
filename	A valid filename on the operating system on which the client is running.	String	path1.snc /export/home/sheer1.3/Main/path2.snc
Date	String representing the date and time.	UNIX date format in the default C location.	Wed Jul 22 16:56:25 PDT 2009