Table Of Contents
Preface
Introduction
Audience
Document Conventions
Obtaining Documentation, Obtaining Support, and Security Guidelines
Preface
This guide describes the Cisco ANA shell interface which is the command line interface of the Cisco ANA Shell Manage system. It supports a subset of the capabilities supported by the system including multi-level management of the network and VNEs, surveillance, and provisioning.
This guide describes the implementation guidelines for the Cisco ANA shell interface, the behavior of basic commands, and the various commands supported by Cisco ANA:
•
"General"—Provides a top-level view of the Cisco ANA shell.
•"Functional Definition"—Describes the Cisco ANA shell modes, errors and output format. It also describes the basic commands, unit node management, and surveillance commands.
•"Regular Expressions"—Details the regular expressions used in the Cisco ANA shell.
•"Cisco ANA Shell Potential Errors"—Details the error codes and messages that may occur in the Cisco ANA shell.
Introduction
Cisco ANA shell interface provides:
•An 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's guide.
Audience
This guide is intended for use by the following:
•Project Managers—In order to verify that the content of the product is consistent with the marketing requirements.
•Implementers—In order to verify implementation against the requirements.
•Quality Control—In order to gain perspective on the product's capabilities and as a basis for test plans.
Document Conventions
The Cisco ANA shell documentation uses the following conventions:
Convention
|
Description
|
Ctrl
|
Ctrl represents the Control key. For example, the key combination Ctrl-D means hold down the Control key while you press the D key. Keys are indicated in capital letters but are not case sensitive.
|
string
|
A string is a set of characters shown in italics. You may use quotation marks for strings with spaces and other special characters
|
Command syntax descriptions use the following conventions:
Convention
|
Description
|
boldface
|
Boldface text indicates commands and keywords that you enter literally as shown.
|
italics
|
Italic text indicates arguments for which you supply values.
|
[x]
|
Square brackets enclose an optional element (keyword or argument).
|
|
|
A vertical line indicates a choice within an optional or required set of keywords or arguments.
|
[x | y]
|
Square brackets enclosing keywords or arguments separated by a vertical line indicate an optional choice.
|
{x | y}
|
Braces enclosing keywords or arguments separated by a vertical line indicate a required choice.
|
Nested sets of square brackets or braces indicate optional or required choices within optional or required elements. For example:
Convention
|
Description
|
[x {y | z}]
|
Braces and a vertical line within square brackets indicate a required choice within an optional element.
|
Examples use the following conventions:
Convention
|
Description
|
screen
|
Examples of information displayed on the screen are set in Courier New font.
|
Boldface screen
|
Examples of text that you must enter are set in Courier New bold font.
|
< >
|
Angle brackets enclose text that is not printed to the screen, such as passwords.
|
[ ]
|
Square brackets enclose default responses to system prompts.
|
"x"
|
Quotation marks indicate parameters that have spaces. You must enter quotation marks in order for Shell to identify it as a single paragraph.
|
Each Cisco ANA shell command is described in a table with the following format:
Name
|
|
Description
|
|
Mode
|
|
Usage
|
|
General
|
|
Example
|
|
Output Format
|
Type
|
|
| |
|
|
|
| |
|
|
|
Obtaining Documentation, Obtaining Support, and Security Guidelines
For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Feedback