Cisco VNMC XML API Reference Guide, Release 2.0
Preface
Downloads: This chapterpdf (PDF - 102.0KB) The complete bookPDF (PDF - 1.59MB) | Feedback

Preface

Table Of Contents

Preface

Audience

Organization

Document Conventions

Related Documentation

Cisco Virtual Network Management Center Documentation

Cisco Adaptive Security Appliance Documentation

Cisco Virtual Security Gateway Documentation

Cisco Nexus 1000V Series Switch Documentation

Obtaining Documentation and Submitting a Service Request


Preface


This guide describes the Cisco Virtual Network Management Center (VNMC) XML northbound application programming interface (API) and how to use it.

This preface includes:

Audience

Organization

Document Conventions

Related Documentation

Obtaining Documentation and Submitting a Service Request

Audience

This guide is intended for software engineers with a background in programming and the use of APIs. Engineers should have knowledge of XML, data systems, networking protocols, Unified Modeling Language (UML), and storage protocols.

Organization

This guide is organized as follows:

Section
Description

Chapter 1 "Introducing the Cisco VNMC XML API"

Provides an overview of the VNMC XML API.

Chapter 2 "Common API Methods and Conventions"

Describes common API methods and filters, and provides use case examples.

Chapter 3 "VNMC XML API Methods"

Describes API methods with syntax and working examples.

"UML Diagrams"

Provides example Unified Modeling Language (UML) diagrams.


Document Conventions

This document uses the following conventions:


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



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


Tip Means the following information will help you solve a problem.


Command descriptions use the following conventions.

Convention
Description

boldface font

Commands, keywords, and user-entered text appear in boldface font.

italic font

Document titles, new or emphasized terms, and arguments for which you supply values are in italic font.

[ ]

Optional elements in commands and default responses to system prompts are in square brackets.

{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 that the system displays are in courier font.

italic screen font

Arguments for which you supply values are in italic screen font.

< >

Non-printing characters, such as passwords, are in angle brackets.

!, #

An exclamation point (!) or a pound sign (#) at the beginning of a line of code indicates a comment line.


Related Documentation

The following sections contain information about the documentation available for Cisco Virtual Network Management Center and related products:

Cisco Virtual Network Management Center Documentation

Cisco Adaptive Security Appliance Documentation

Cisco Virtual Security Gateway Documentation

Cisco Nexus 1000V Series Switch Documentation

Cisco Virtual Network Management Center Documentation

The following Cisco Virtual Network Management Center documents are available at the following URL:

http://www.cisco.com/en/US/products/ps11213/tsd_products_support_series_home.html

Cisco Virtual Network Management Center Documentation Overview, Release 2.0

Cisco Virtual Network Management Center CLI Configuration Guide, Release 2.0

Cisco Virtual Network Management Center GUI Configuration Guide, Release 2.0

Cisco Virtual Network Management Center Quick Start Guide, Release 2.0

Cisco Virtual Network Management Center Release Notes, Release 2.0

Cisco Virtual Network Management Center XML API Reference Guide, Release 2.0

Open Source Used in Cisco Virtual Network Management Center 2.0

Cisco Adaptive Security Appliance Documentation

The Cisco Adaptive Security Appliance (ASA) documentation is available at the following URL:

http://www.cisco.com/en/US/products/ps12233/tsd_products_support_series_home.html

Cisco Virtual Security Gateway Documentation

The Cisco Virtual Security Gateway for Nexus 1000V Series switch documentation is available at the following URL:

http://www.cisco.com/en/US/products/ps11208/tsd_products_support_model_home.html

Cisco Nexus 1000V Series Switch Documentation

The Cisco Nexus 1000V Series switch documentation is available at the following URL:

http://www.cisco.com/en/US/products/ps9902/tsd_products_support_series_home.html

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. Cisco currently supports RSS Version 2.0.