Preface

Preface

This document lists and describes the Python Application Programming Interface (API) for Cisco Nexus 5000 series switches.

This chapter includes the following sections:

Audience

This publication is for system administrators who are responsible for installing and managing Cisco Nexus 5000 series switches.

Document Conventions

Command descriptions use these conventions:

Conventions

Description

boldface font

Commands and keywords are in boldface.

italic font

Arguments for which you supply values are in italics.

{ }

Elements in braces are required choices.

[ ]

Elements in square brackets are optional.

x | y | z

Alternative, mutually exclusive elements are 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 the device displays are in screen font.

boldface screen font

Information you must enter is in boldface screen font.

italic screen font

Arguments for which you supply values are in italic screen 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.

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.

Related Documentation

Documentation for Cisco Nexus 5000 Series Switches and Cisco Nexus 2000 Series Fabric Extenders is available at the following URL:

http://www.cisco.com/c/en/us/support/switches/nexus-5000-series-switches/tsd-products-support-series-home.html

The documentation set includes the following types of documents:

  • Licensing Information Guide
  • Release Notes
  • Installation and Upgrade Guides
  • Configuration Guides
  • Configuration Examples and TechNotes
  • Programming Guides
  • Operations Guides
  • Error and System Message Guides
  • Field Notices
  • Security Advisories, Responses and Notices
  • Troubleshooting Guide
  • Command References
  • MIB Reference Guide

Documentation Feedback

To provide technical feedback on this document or to report an error or omission, please send your comments to nexus5k-docfeedback@cisco.com. We appreciate your feedback.

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.