Preface
This preface describes the audience, organization and conventions of the Cisco Nexus 5000 Series NX-OS Fundamentals Configuration Guide. It also provides information on how to obtain related documentation.
- Audience
- Document Conventions
- Related Documentation for Cisco Nexus 5000 Series NX-OS Software
- Obtaining Documentation and Submitting a Service Request
Audience
This publication is for experienced users who configure and maintain Cisco NX-OS devices.
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 for Cisco Nexus 5000 Series NX-OS Software
The entire Cisco NX-OS 5000 Series documentation set is available at the following URL:
Release Notes
The release notes are available at the following URL:
http://www.cisco.com/en/US/products/ps9670/prod_release_notes_list.html
Configuration Guides
These guides are available at the following URL:
The documents in this category include:
-
Adapter-FEX Configuration Guide
-
Cisco Fabric Manager Configuration Guide
-
Cisco Nexus 5000 Series NX-OS Software Configuration Guide
-
Configuration Limits for Cisco NX-OS
-
FabricPath Configuration Guide
-
Fibre Channel over Ethernet Configuration Guide
-
Layer 2 Switching Configuration Guide
-
Multicast Routing Configuration Guide
-
Operations Guide
-
SAN Switching Configuration Guide
-
Quality of Service Configuration Guide
-
Security Configuration Guide
-
System Management Configuration Guide
-
Unicast Routing Configuration Guide
Maintain and Operate Guides
Cisco Nexus 5000 Series NX-OS Operations Guides for various features are available at http://www.cisco.com/en/US/products/ps9670/prod_maintenance_guides_list.html.
Installation and Upgrade Guides
These guides are available at the following URL:
http://www.cisco.com/en/US/products/ps9670/prod_installation_guides_list.html
The documents in this category include:
Licensing Guide
The License and Copyright Information for Cisco NX-OS Software is available at http://www.cisco.com/en/US/docs/switches/datacenter/sw/4_0/nx-os/license_agreement/nx-ossw_lisns.html.
Command References
These guides are available at the following URL:
http://www.cisco.com/en/US/products/ps9670/prod_command_reference_list.html
The documents in this category include:
-
Command Reference Master Index
-
Fabric Extender Command Reference
-
FabricPath Command Reference
-
Fibre Channel Command Reference
-
Fundamentals Command Reference
-
Layer 2 Interfaces Command Reference
-
Multicast Routing Command Reference
-
QoS Command Reference
-
Security Command Reference
-
System Management Command Reference
-
TrustSec Command Reference
-
Unicast Routing Command Reference
-
vPC Command Reference
Technical References
The Cisco Nexus 5000 and Cisco Nexus 2000 MIBs Reference is available at http://www.cisco.com/en/US/docs/switches/datacenter/nexus5000/sw/mib/reference/NX5000_MIBRef.html.
Error and System Messages
The Nexus 5000 Series NX-OS System Message Reference is available at http://www.cisco.com/en/US/docs/switches/datacenter/nexus5000/sw/system_messages/reference/sl_nxos_book.html.
Troubleshooting Guide
The Cisco Nexus 5000 Series Troubleshooting Guide is available at http://www.cisco.com/en/US/docs/switches/datacenter/nexus5000/sw/troubleshooting/guide/N5K_Troubleshooting_Guide.html.
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, at: http://www.cisco.com/c/en/us/td/docs/general/whatsnew/whatsnew.html.
Subscribe to What's New in Cisco Product Documentation, which lists all new and revised Cisco technical documentation as an RSS feed and delivers content directly to your desktop using a reader application. The RSS feeds are a free service.