Table Of Contents
Preface
Document Overview
Soft Properties Manager
Command Builder
Workflow Editor
Cisco ANA Shell Interface
BQL
Related Documentation
Conventions
Accessibility Support
Obtaining Documentation and Submitting a Service Request
Preface
This manual describes the Cisco Active Network Abstraction (Cisco ANA) 3.6.5 customization suite and provides instructions for using the components of the customization suite.
This Preface includes the following topics:
•
Document Overview
•Related Documentation
•Conventions
•Accessibility Support
•Obtaining Documentation and Submitting a Service Request
Document Overview
Table 1 presents the organization of this manual.
Table 1 Manual Organization
Part
|
Chapter
|
Overview
|
Chapter 1, "Cisco ANA Overview"
|
Customizing Network Element Information Using the Soft Properties Manager
|
•Chapter 2, "Introducing the Cisco ANA Soft Properties Manager"
•Chapter 3, "Getting Started with the Soft Properties Manager"
•Chapter 4, "Soft Property Examples"
•Chapter 5, "Parsing Operators/Rules"
•Chapter 6, "Alarm Threshold Triggers"
•Chapter 7, "Regular Expressions for Soft Properties Manager"
|
Using the Workflow Editor to Create Task Workflows
|
•Chapter 8, "Introducing the Cisco ANA Workflow Editor"
•Chapter 9, "Working with the Cisco ANA Workflow Editor"
•Chapter 10, "Getting Started with the Workflow Editor"
•Chapter 11, "Managing Workflows"
•Chapter 12, "Customizing the Workflow Editor"
|
Managing and Deploying Configuration Changes Using the Command Builder
|
•Chapter 13, "Introducing Command Builder"
•Chapter 14, "Getting Started with Command Builder"
•Chapter 15, "Creating a Cisco ANA Macro Language Command: An Example"
•Chapter 16, "Running Command Scripts"
•Chapter 17, "Cisco ANA Macro Language"
•Chapter 18, "Bean Shell Commands"
|
Using the Shell Interface
|
•Chapter 19, "Introducing the Cisco ANA Shell Interface"
•Chapter 20, "Understanding Cisco ANA Shell Behavior"
•Chapter 21, "Regular Expressions for Cisco ANA Shell"
•Chapter 22, "Cisco ANA Shell Potential Errors"
|
Working with BQL
|
•Chapter 23, "Getting Started with BQL"
•Chapter 24, "Understanding IMO"
•Chapter 25, "IMO Specification"
•Chapter 26, "BQL Generic Commands"
•Chapter 27, "Encrypted SSL Sockets"
•Chapter 28, "Detailed BQL Errors Catalog and Examples"
•Chapter 29, "Best Practices for Integration BQL Parsing"
|
The following sections describe the primary audience for each tool described in the document.
Soft Properties Manager
Soft Properties Manager is intended for use by integrators and any other users who want to manage the soft properties and Threshold Crossing Alarms (TCAs) that are executed within the Cisco ANA platform.
Users of Soft Properties Manager are required to have the following preliminary knowledge before using this tool:
Subject
|
Description
|
Networking, device properties
|
Knowledge of device property retrieval using Telnet and SSH or a SNMP MIB browser.
|
Data manipulation
|
Ability to write regular expressions and parse raw strings using basic parsing tools.
|
Cisco IMO Types
|
Understanding of the Cisco ANA information model so that they know where to locate and edit the soft property.
|
Command Builder
Command Builder is intended for use by programmers who want to write command scripts that are executed within the Cisco ANA activation framework.
Workflow Editor
The Workflow Editor is intended for use by a system administrator.
Cisco ANA Shell Interface
The Cisco ANA shell interface is intended for use by system administrators and users who are responsible for network operation tasks.
BQL
Broadband Query Language (BQL) is intended for use by system architects and programmers who wish to access Cisco ANA and integrate it with northbound Operations Support System (OSS) applications. This part assumes that the reader is familiar with XML and with application programming.
This part should be accompanied by the Cisco Active Network Abstraction 3.6.5 Technology Support and Information Model Reference Manual for Information Model Object (IMO) information.
Related Documentation
Note We sometimes update the documentation after original publication. Therefore, you should also review the documentation on Cisco.com for any updates.
describes the additional documentation that is available.
Conventions
This document uses the following conventions:
Convention
|
Indication
|
bold font
|
Commands and keywords and user-entered text appear in bold font.
|
italic font
|
Document titles, new or emphasized terms, and arguments for which you supply values are in italic font.
|
[ ]
|
Elements in square brackets are optional.
|
{x | y | z }
|
Required alternative keywords are grouped in braces and separated by vertical bars.
|
[ x | y | z ]
|
Optional alternative keywords are grouped in brackets and separated by vertical bars.
|
string
|
A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks.
|
courier font
|
Terminal sessions and information the system displays appear in courier font.
|
< >
|
Nonprinting characters such as passwords are in angle brackets.
|
[ ]
|
Default responses to system prompts are in square brackets.
|
!, #
|
An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line.
|
Note Means reader take note.
Tip Means the following information will help you solve a problem.
Caution Means
reader be careful. In this situation, you might perform an action that could result in equipment damage or loss of data.
Accessibility Support
For accessibility support in Cisco ANA, see the 508 Voluntary Product Accessibility Template (VPAT), which you can get by sending an e-mail to accessibility@cisco.com.
The following details from 508 VPATs are applicable to Cisco ANA:
Template
|
Description
|
Supports
|
1194.41(a)
|
Product support documentation provided to end users shall be made available in alternate formats upon request, at no additional charge.
|
Accessible documentation is available through Cisco Technical Assistance Center (TAC) upon request.
|
1194.41(b)
|
End users shall have access to a description of the accessibility and compatibility features of products in alternate formats or alternate methods upon request, at no additional charge.
|
Accessible documentation is available through Cisco Technical Assistance Center (TAC) upon request.
|
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional information, 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
Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0.
