Web Services API Guide, Cisco DCNM for LAN, Release 5.x
Preface
Downloads: This chapterpdf (PDF - 122.0KB) The complete bookPDF (PDF - 11.08MB) | Feedback

Preface

Table Of Contents

Preface

Audience

Organization

Document Conventions

Related Documentation

Cisco DCNM Documentation

Cisco Nexus 1000V Series Switch Documentation

Cisco Nexus 2000 Series Fabric Extender Documentation

Cisco Nexus 3000 Series Switch Documentation

Cisco Nexus 4000 Series Switch Documentation

Cisco Nexus 5000 Series Switch Documentation

Cisco Nexus 7000 Series Switch Documentation

Obtaining Documentation and Submitting a Service Request


Preface


This preface describes the audience, organization, and conventions of the Web Services API Guide, Cisco DCNM for LAN, Release 5.x . 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 publication is for experienced users who configure and maintain Cisco NX-OS devices.

Organization

This reference is organized as follows:

Chapter and Title
Description

Chapter 1, "Overview"

Describes the Cisco NX-OS Web Services API.

Chapter 2, "AaaApp Service"

Describes the AAA Service API.

Chapter 3, "AclApp Service"

Describes the ACL Service API.

Chapter 5, "CollectorApp Service"

Describes the Collector Service API.

Chapter 6, "CollectorExtendedApp Service"

Describes the Collector Extended Service API.

Chapter 2, "ConfigArchiveApp Service"

Describes the Configuration Archive Service API.

Chapter 10, "DaiApp Service"

Describes the DAI Service API.

Chapter 11, "DataPurgingApp Service"

Describes the Data Purging Service API.

Chapter 13, "DeviceListApp Service"

Describes the Device List Service API.

Chapter 14, "DhcpSnoopingApp Service"

Describes the DHCP Snooping Service API.

Chapter 15, "Dot1xApp Service"

Describes the 802.1X Service API.

Chapter 16, "EtherChannelApp Service"

Describes the Ethernet Channel Service API.

Chapter 17, "EventApp Service"

Describes the Event Service API.

Chapter 26, "GlbpApp Service"

Describes the GLBP Service API.

Chapter 27, "HsrpApp Service"

Describes the HSRP Service API.

Chapter 26, "InterfacesApp Service"

Describes the Interfaces Service API.

Chapter 29, "ImageInstallApp Service"

Describes the Image Install Service API.

Chapter 32, "IpSourceGuardApp Service"

Describes the IP Source Guard Service API.

Chapter 31, "InventoryApp Service"

Describes the Inventory Service API.

Chapter 33, "KeyChainApp Service"

Describes the Key Chain Service API.

Chapter 35, "LicensingApp Service"

Describes the Licensing Service API.

Chapter 36, "LogApp Service"

Describes the Log Service API.

Chapter 38, "NacLpIpApp Service"

Describes the NAC LP IP Service API.

Chapter 40, "ObjectTrackingApp Service"

Describes the Object Tracking Service API.

Chapter 42, "PollerApp Service"

Describes the Poller Service API.

Chapter 44, "PortSecurityApp Service"

Describes the Port Security Service API.

Chapter 46, "RbacApp Service"

Describes the RBAC Service API.

Chapter 47, "RepositoryApp Service"

Describes the Repository Service API.

Chapter 48, "SecurityApp Service"

Describes the Security Service API.

Chapter 49, "ServerAdminApp Service"

Describes the Server Administration Service API.

Chapter 51, "SoftwareApp Service"

Describes the Software Service API.

Chapter 52, "SpanApp Service"

Describes the SPAN Service API.

Chapter 53, "StpApp Service"

Describes the STP Service API.

Chapter 58, "TrafficStormControlApp Service"

Describes the Traffic Storm Control Service API.

Chapter 59, "TunnelApp Service"

Describes the Tunnel Service API.

Chapter 60, "UserApp Service"

Describes the User Service API.

Chapter 61, "VdcApp Service"

Describes the VDC Service API.

Chapter 62, "VlanApp Service"

Describes the VLAN Service API.

Chapter 63, "VpcApp Service"

Describes the VPC Service API.

Chapter 64, "VrfApp Service"

Describes the VRF Service API.


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.


Related Documentation

This section contains information about the documentation available for Cisco DCNM and for the platforms that Cisco DCNM manages.

This section includes the following topics:

Cisco DCNM Documentation

Cisco Nexus 1000V Series Switch Documentation

Cisco Nexus 2000 Series Fabric Extender Documentation

Cisco Nexus 3000 Series Switch Documentation

Cisco Nexus 4000 Series Switch Documentation

Cisco Nexus 5000 Series Switch Documentation

Cisco Nexus 7000 Series Switch Documentation

Cisco DCNM Documentation

The Cisco DCNM documentation is available at the following URL:

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

The documentation set for Cisco DCNM includes the following documents:

Release Notes

Cisco DCNM Release Notes, Release 4.2

Installation and Licensing

Cisco DCNM Installation and Licensing Guide, Release 5.x

Cisco DCNM Fundamentals Guide

Cisco DCNM Fundamentals Guide, Release 5.x

Cisco DCNM for LAN Configuration Guides

FabricPath Configuration Guide, Cisco DCNM for LAN, Release 5.x

Cisco DCNM Interfaces Configuration Guide, Release 4.2

Cisco DCNM Layer 2 Switching Configuration Guide, Release 4.2

Cisco DCNM Security Configuration Guide, Release 4.2

System Management Configuration Guide, Cisco DCNM for LAN, Release 5.x

Cisco DCNM Unicast Routing Configuration Guide, Release 4.2

Cisco DCNM Virtual Device Context Configuration Guide, Release 4.2

Cisco DCNM Getting Started with Virtual Device Contexts, Release 4.2

Cisco DCNM Web Services API Guide, Release 4.2

Cisco DCNM for SAN Configuration Guides

System Management Configuration Guide, Cisco DCNM for SAN, Release 5.x

Interfaces Configuration Guide, Cisco DCNM for SAN, Release 5.x

Fabric Configuration Guide, Cisco DCNM for SAN, Release 5.x

Quality of Service Configuration Guide, Cisco DCNM for SAN, Release 5.x

Security Configuration Guide, Cisco DCNM for SAN, Release 5.x

IP Services Configuration Guide, Cisco DCNM for SAN, Release 5.x

Intelligent Storage Services Configuration Guide, Cisco DCNM for SAN, Release 5.x

High Availability and Redundancy Configuration Guide, Cisco DCNM for SAN, Release 5.x

Inter-VSAN Routing Configuration Guide, Cisco DCNM for SAN, Release 5.x

SMI-S and Web Services Programming Guide, Cisco DCNM for SAN, Release 5.x

SME Configuration Guide, Cisco DCNM for SAN, Release 5.x

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

Cisco Nexus 2000 Series Fabric Extender Documentation

The Cisco Nexus 2000 Series Fabric Extender documentation is available at the following URL:

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

Cisco Nexus 3000 Series Switch Documentation

The Cisco Nexus 3000 Series switch documentation is available at the followingURL:

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

Cisco Nexus 4000 Series Switch Documentation

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

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

Cisco Nexus 5000 Series Switch Documentation

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

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

Cisco Nexus 7000 Series Switch Documentation

The Cisco Nexus 7000 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 and Cisco currently supports RSS Version 2.0.

a