Cisco HCMF Command Line Interface Reference Guide, Release 10.1(1)
Bias-Free Language
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.
- Updated:
- September 23, 2014
Chapter: About CLI
About CLI
Start CLI Session
Cisco HCM-F provides a Command Line Interface (CLI) for administering the Cisco HCM-F services. The CLI is a Cisco Unified Communications Operating System and it is used to activate services, manage and provide fault detection for components and services.
You can access the CLI remotely or locally:
- From a web client workstation, such as the workstation that you use for Cisco Unified Communications Operating System Administration, you can use SSH to connect securely to the Cisco Unified Communications Operating System.
- You can access the Cisco Unified Communications Operating System CLI directly by using the monitor and keyboard that you used during installation or by using a terminal server that is connected to the serial port. Use this method if a problem exists with the IP address.
Ensure you have the following information that gets defined during installation:
You will need this information to log in to the Cisco IPT Platform.
Command completion
To complete commands, use Tab:
- Enter the start of a command and press Tab to complete the command. For example, if you enter se and press Tab, set gets completed.
- Enter a full command name and press Tab to display all the commands or subcommands that are available. For example, if you enter set and press Tab, you see all the set subcommands. An * identifies the commands that have subcommands.
- If you reach a command, keep pressing Tab, and the current command line repeats; this indicates that no additional expansion is available.
Get Help on Commands
You can get two kinds of help on any command:
- Detailed help that includes a definition of the command and an example of its use
- Short query help that includes only command syntax Procedure
To get detailed help, at the CLI prompt, enter
Where command specifies the command name or the command and parameter. See the Detailed Help Example below.
 Note | If you enter the help command without specifying the name of a particular command as the optional parameter, the system provides information about the CLI system. |
To query only command syntax, at the CLI prompt, enter
Where command represents the command name or the command and parameter. See the Query Example.
Note | If you enter a ? after a menu command, such as set, it acts like the Tab key and lists the commands that are available. |
Detailed Help Example
admin:help file list activelog activelog help: This will list active logging files options are: page - pause output detail - show detailed listing reverse - reverse sort order date - sort by date size - sort by size file-spec can contain '*' as wildcards Example admin:file list activelog platform detail 02 Dec,2004 12:00:59 <dir> drf 02 Dec,2004 12:00:59 <dir> log 16 Nov,2004 21:45:43 8,557 enGui.log 27 Oct,2004 11:54:33 47,916 startup.log dir count = 2, file count = 2
Query Example
admin:file list activelog ? Syntax: file list activelog file-spec [options] file-spec mandatory file to view options optional page|detail|reverse|[date|size]
End CLI Session
At the CLI prompt, enter quit or exit. If you are logged in remotely, you get logged off, and the ssh session gets dropped. If you are logged in locally, you get logged off, and the login prompt returns.
The following sections list and describe the CLI commands that are available for the Cisco Unified Communications Operating System.
CLI Command properties
Command Privilege Level
Each CLI command has a "Command Privilege Level" setting. The CLI has privilege levels 0 (lowest) through 4 (highest). Each Level, that is, the collection of commands such as "show", and each command has a privilege associated with it. A user will only be able to execute a command if the account they are using has sufficient privilege. The original Admin account, created during install, has the highest privilege level (4). This is the only account with this privilege level. When other accounts are created in the CLI using the CLI command set account, the account is assigned a privilege level. A new account can only have a privilege level of 0 or 1. Privilege levels 2 and 3 are currently unassigned and reserved for future use.
Allowed during Upgrade
Each CLI command has an "Allow during upgrade? "setting. This setting controls whether the command can be run while an L2 upgrade is taking place. During an L2 upgrade, an administrator can log into the system and try to execute CLI commands. Since the CLI parser can figure out if an L2 is in progress, it can refuse to run any commands that are not permitted during an upgrade.
Feedback