Preface

This preface describes the audience, organization, and conventions of the Cisco Virtual Network Management Center XML API Reference Guide, Release 1.2. It also provides information on how to obtain related documentation.

This chapter includes the following sections:

•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 application programming interfaces (APIs). Engineers should have knowledge of XML, data systems, networking protocols, and storage protocols.

Organization

This guide is organized as follows:

Chapter and Title
Description

Chapter 1, "Introduction to the Cisco VNMC XML API"

Provides an overview of the Cisco VNMC XML API.

Chapter 2, "Using the Cisco VNMC XML API"

Provides a tutorial and details in a use case example.

Chapter 3, "Cisco VNMC XML API Method Descriptions"

Provides descriptions of API methods with syntax and working examples.


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 these conventions:

Convention
Description

boldface font

Commands and keywords are in boldface.

italic font

Parameters for which you supply values are in italics.

[ ]

Elements in square brackets are optional.

[ 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.


Screen examples use these conventions: 

screen font

Terminal sessions and information that the switch displays are in screen font. 

boldface screen font

Information that you must enter is in boldface screen 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.

[ ]

Default responses to system prompts are in square brackets.

!, #

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


Related Documentation

This section contains information about the documentation available for Cisco Virtual Network Management Center and related products.

This section includes the following topics:

•Cisco Virtual Network Management Center 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 on Cisco.com at the following URL:

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

•Release Notes for Cisco Virtual Network Management Center, Release 1.2

•Cisco Virtual Security Gateway, Release 4.2(1)VSG1(2) and Cisco Virtual Network Management Center, Release 1.2 Installation and Upgrade Guide

•Cisco Virtual Network Management Center CLI Configuration Guide, Release 1.2

•Cisco Virtual Network Management Center GUI Configuration Guide, Release 1.2

•Cisco Virtual Network Management Center XML API Reference Guide, Release 1.2

Cisco Virtual Security Gateway Documentation

The following Cisco Virtual Security Gateway for the Nexus 1000V Series Switch documents are available on Cisco.com at the following URL:

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

•Cisco Virtual Security Gateway for Nexus 1000V Series Switch Release Notes, Release 4.2(1)VSG1(2)

•Cisco Virtual Security Gateway, Release 4.2(1)VSG1(2) and Cisco Virtual Network Management Center, Release 1.2 Installation and Upgrade Guide

•Cisco Virtual Security Gateway for Nexus 1000V Series Switch License Configuration Guide, Release 4.2(1)VSG1(2)

•Cisco Virtual Security Gateway for Nexus 1000V Series Switch Configuration Guide, Release 4.2(1)VSG1(2)

•Cisco Virtual Security Gateway for Nexus 1000V Series Switch Command Reference, Release 4.2(1)VSG1(2)

•Cisco Virtual Security Gateway for Nexus 1000V Series Switch Troubleshooting Guide, Release 4.2(1)VSG1(2)

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.