Preface
Preface
This preface describes the audience, organization, and conventions of the Book Title. It also provides information on how to obtain related documentation.
This chapter includes the following topics:
- Audience
- Document Conventions
- Related Documentation
- Obtaining Documentation and Submitting a Service Request
Audience
This publication is for experienced network administrators who configure and maintain Cisco NX-OS on Cisco Nexus 5000 Series Platform switches.
Document Conventions
Command descriptions use the following conventions:
Convention | Description |
---|---|
bold |
Bold text indicates the commands and keywords that you enter literally as shown. |
Italic |
Italic text indicates arguments for which the user supplies the values. |
[x] |
Square brackets enclose an optional element (keyword or argument). |
[x | y] |
Square brackets enclosing keywords or arguments separated by a vertical bar indicate an optional choice. |
{x | y} |
Braces enclosing keywords or arguments separated by a vertical bar indicate a required choice. |
[x {y | z}] |
Nested set of square brackets or braces indicate optional or required choices within optional or required elements. Braces and a vertical bar within square brackets indicate a required choice within an optional element. |
variable |
Indicates a variable for which you supply values, in context where italics cannot be used. |
string | A nonquoted set of characters. Do not use quotation marks around the string or the string will include the quotation marks. |
Examples use the following conventions:
Convention | Description |
---|---|
screen font |
Terminal sessions and information the switch 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 is available at the following URL:
Documentation for Cisco Nexus 5000 Series Switches and Cisco Nexus 2000 Series Fabric Extenders is available at the following URL:
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, using the Cisco Bug Search Tool (BST), submitting a service request, and gathering additional information, see What's New in Cisco Product Documentation.
To receive new and revised Cisco technical content directly to your desktop, you can subscribe to the What's New in Cisco Product Documentation RSS feed. RSS feeds are a free service.