The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter includes the following sections:
The Cisco UCS C-Series rack-mount servers include the following models:
Note |
To determine which Cisco UCS C-Series rack-mount servers are supported by this firmware release, see the associated Release Notes. The C-Series release notes are available at the following URL: http://www.cisco.com/en/US/products/ps10739/prod_release_notes_list.html |
The CIMC CLI is a command-line management interface for Cisco UCS C-Series servers. You can launch the CIMC CLI and manage the server over the network by SSH or Telnet. By default, Telnet access is disabled.
A user of the CLI will be one of three roles: admin, user (can control, cannot configure), and read-only.
Note |
To recover from a lost admin password, see the Cisco UCS C-Series server installation and service guide for your platform. |
The CLI is organized into a hierarchy of command modes, with the EXEC mode being the highest-level mode of the hierarchy. Higher-level modes branch into lower-level modes. You use the scope command to move from higher-level modes to modes in the next lower level , and the exit command to move up one level in the mode hierarchy. The top command returns to the EXEC mode.
Note |
Most command modes are associated with managed objects. The scope command does not create managed objects and can only access modes for which managed objects already exist. |
Each mode contains a set of commands that can be entered in that mode. Most of the commands available in each mode pertain to the associated managed object. Depending on your assigned role, you may have access to only a subset of the commands available in a mode; commands to which you do not have access are hidden.
The CLI prompt for each mode shows the full path down the mode hierarchy to the current mode. This helps you to determine where you are in the command mode hierarchy and can be an invaluable tool when you need to navigate through the hierarchy.
The following table lists the first four levels of command modes, the commands used to access each mode, and the CLI prompt associated with each mode.
Mode Name | Command to Access | Mode Prompt |
---|---|---|
EXEC |
top command from any mode |
# |
bios |
scope bios command from EXEC mode |
/bios # |
advanced |
scope advanced command from bios mode |
/bios/advanced # |
main |
scope main command from bios mode |
/bios/main # |
server-management |
scope server-management command from bios mode |
/bios/server-management # |
certificate |
scope certificate command from EXEC mode |
/certificate # |
chassis |
scope chassis command from EXEC mode |
/chassis # |
adapter |
scope adapter index command from chassis mode |
/chassis/adapter # |
host-eth-if |
scope host-eth-if command from adapter mode |
/chassis/adapter/host-eth-if # |
host-fc-if |
scope host-fc-if command from adapter mode |
/chassis/adapter/host-fc-if # |
port-profiles |
scope port-profiles command from adapter mode |
/chassis/adapter/port-profiles # |
vmfex |
scope vmfex index command from adapter mode |
/chassis/adapter/vmfex # |
dimm-summary |
scope dimm-summary index command from chassis mode |
/chassis/dimm-summary # |
flexflash |
scope flexflash index command from chassis mode |
/chassis/flexflash # |
operational-profiles |
scope operational-profile command from flexflash mode |
/chassis/flexflash/operational-profile # |
storageadapter |
scope storageadapter slot command from chassis mode |
/chassis/storageadapter # |
physical-drive |
scope physical-drive command from storageadapter mode |
/chassis/storageadapter/physical-drive # |
virtual-drive |
scope virtual-drive command from storageadapter mode |
/chassis/storageadapter/virtual-drive # |
cimc |
scope cimc command from EXEC mode |
/cimc # |
firmware |
scope firmware command from cimc mode |
/cimc/firmware # |
import-export |
scope import-export command from cimc mode |
/cimc/import-export # |
log |
scope log command from cimc mode |
/cimc/log # |
server |
scope server index command from log mode |
/cimc/log/server # |
network |
scope network command from cimc mode |
/cimc/network # |
ipblocking |
scope ipblocking command from network mode |
/cimc/network/ipblocking # |
tech-support |
scope tech-support command from cimc mode |
/cimc/tech-support # |
fault |
scope fault command from EXEC mode |
/fault # |
pef |
scope pef command from fault mode |
/fault/pef # |
http |
scope http command from EXEC mode |
/http # |
ipmi |
scope ipmi command from EXEC mode |
/ipmi # |
kvm |
scope kvm command from EXEC mode |
/kvm # |
ldap |
scope ldap command from EXEC mode |
/ldap # |
role-group |
scope role-group command from ldap mode |
/ldap/role-group # |
power-cap |
scope power-cap command from EXEC mode |
/power-cap # |
sel |
scope sel command from EXEC mode |
/sel # |
sensor |
scope sensor command from EXEC mode |
/sensor # |
snmp |
scope snmp command from EXEC mode |
/snmp # |
trap-destination |
scope trap-destination command from snmp mode |
/snmp/trap-destination # |
v3users |
scope v3users command from snmp mode |
/snmp/v3users # |
sol |
scope sol command from EXEC mode |
/sol # |
ssh |
scope ssh command from EXEC mode |
/ssh # |
user |
scope user user-number command from EXEC mode |
/user # |
user-session |
scope user-session session-number command from EXEC mode |
/user-session # |
vmedia |
scope vmedia command from EXEC mode |
/vmedia # |
xmlapi |
scope xmlapi command from EXEC mode |
/xmlapi # |
You can use the Tab key in any mode to complete a command. Partially typing a command name and pressing Tab causes the command to be displayed in full or to the point where another keyword must be chosen or an argument value must be entered.
The CLI stores all commands used in the current session. You can step through the previously used commands by using the Up Arrow or Down Arrow keys. The Up Arrow key steps to the previous command in the history, and the Down Arrow key steps to the next command in the history. If you get to the end of the history, pressing the Down Arrow key does nothing.
All commands in the history can be entered again by simply stepping through the history to recall the desired command and pressing Enter. The command is entered as if you had manually typed it. You can also recall a command and change it before you enter it.
When you enter a configuration command in the CLI, the command is not applied until you enter the commit command. Until committed, a configuration command is pending and can be discarded by entering a discard command. When any command is pending, an asterisk (*) appears before the command prompt. The asterisk disappears when you enter the commit command, as shown in this example:
Server# scope chassis Server /chassis # set locator-led off Server /chassis *# commit Server /chassis #
You can accumulate pending changes in multiple command modes and apply them together with a single commit command. You can view the pending commands by entering the show configuration pending command in any command mode.
Note |
Committing multiple commands together is not an atomic operation. If any command fails, the successful commands are applied despite the failure. Failed commands are reported in an error message. |
Server /chassis # set cli output default Server /chassis # show hdd detail Name HDD_01_STATUS: Status : present Name HDD_02_STATUS: Status : present Name HDD_03_STATUS: Status : present Name HDD_04_STATUS: Status : present Server /chassis #
Server /chassis # set cli output yaml Server /chassis # show hdd detail --- name: HDD_01_STATUS hdd-status: present --- name: HDD_02_STATUS hdd-status: present --- name: HDD_03_STATUS hdd-status: present --- name: HDD_04_STATUS hdd-status: present ... Server /chassis #For detailed information about YAML, see http://www.yaml.org/about.html.
In most CLI command modes, you can enter set cli output default to configure the default format, or set cli output yaml to configure the YAML format.
At any time, you can type the ? character to display the options available at the current state of the command syntax. If you have not typed anything at the prompt, typing ? lists all available commands for the mode you are in. If you have partially typed a command, typing ? lists all available keywords and arguments available at your current position in the command syntax.