API Reference Guide for Cisco Application Networking Manager 4.3
Preface
Downloads: This chapterpdf (PDF - 112.0KB) The complete bookPDF (PDF - 900.0KB) | Feedback

Preface

Table Of Contents

Preface

Audience

Organization

Related Documentation

Conventions

Open-Source Software Included in the Cisco Application Networking Manager

Obtaining Documentation and Submitting a Service Request


Preface


This guide describes the Cisco Application Networking Manager Web Services application program interface (API) implementation and explains how to use it to manage your network. This preface provides information about using this guide. This preface includes the following sections:

Audience

Organization

Related Documentation

Conventions

Open-Source Software Included in the Cisco Application Networking Manager

Obtaining Documentation and Submitting a Service Request

Audience

This API guide is written for the knowledgeable application programmer who understands the basic architecture of the Cisco Application Networking Manager (ANM). This document provides detailed descriptions of Web Service APIs supported by ANM. Depending on the configuration required, readers should have specific knowledge in the following areas:

Networking and data communications

Network security

Router configuration

Datacenter products

Organization

This document contains the following sections:

Chapter 1 "Introduction to the Cisco ANM Web Services API" provides an overview of the programmable interface and the methods and schemas used to perform configuration operations using the API.

Chapter 2 "ANM Web Services API" lists all APIs and describes them.

Chapter 3 "Web Service Objects" lists the data types that are defined structures or objects in the ANM Web Services API.

Chapter 4 "Troubleshooting Problems" lists the custom application errors.

"Use Case Examples" lists the use case sample code examples.

Related Documentation

In addition to this installation guide, the Application Networking Manager (ANM) documentation set includes the following publications. You can access the ANM documentation on www.cisco.com at: http://www.cisco.com/en/US/products/ps6904/tsd_products_support_series_home.html.

Installation Guide for the Cisco Application Networking Manager—Includes complete installation and configuration information for the ANM software.

Installation Guide for the Cisco Application Networking Manager Virtual Appliance—Includes complete information about ANM virtual appliance functionality, installation, configuration, and administration procedures.

User Guide for the Cisco Application Networking Manager—Includes complete information about ANM functionality and detailed procedures for its use. Contains all of the information found in online help. Available either on cisco.com or from the ANM online help.

Context-sensitive online help—Includes help topics for all pages in the UI (also provides access to PDFs of the user guide). Select an option from the ANM GUI, and click Help.

Supported Devices Table for the Cisco Application Networking Manager—Includes complete supported device and firmware versions for ANM.

Supplemental License Agreement for the Cisco Application Networking Manager—Describes licensing limitations and restrictions.

Conventions

This document uses the following conventions:

Item
Convention

Commands and keywords

boldface font

Variables for which you supply values

italic font

Displayed session and system information

screen font

Information you enter

boldface screen font

Variables you enter

italic screen font

Menu items and button names

boldface font

Choosing a menu item in paragraphs

Option > Network Preferences

Choosing a menu item in tables

Option > Network Preferences



Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication.



Caution Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.

Open-Source Software Included in the Cisco Application Networking Manager

The Cisco Application Networking Manager includes the following open-source software, which is covered by the Apache 2.0 license (http://www.apache.org/): Ant, Avalon Logkit, Commons, Ehcache, Jetty, Log4J, Oro, Commons_Logging, Xmlrpc.

The Cisco Application Networking Manager includes the following open-source software, which is covered by The Legion of the Bouncy Castle (http://www.bouncycastle.org/licence.html) license: BouncyCastle.

The Cisco Application Networking Manager includes the following open-source software, which is covered by the GNU Lesser General Public License Version 2.1 (http://www.gnu.org/licenses/lgpl.html): c3p0-0.9.0.2.jar, Enterprise DT, Jasperreports 1.2, Jcommon 1.2, Jfreechart 1.0.1.

The Cisco Application Networking Manager includes the following open-source software, which is covered by the Mozilla Public License Version 1.1 (http://www.mozilla.org/MPL/1.1/): Itext 1.4.

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.