Command Reference - Xcommand - Cisco TelePresence Administrator's Manual

Reference material
Command reference — xCommand
The xCommand group of commands are used to add and delete items and issue system commands.
The following section lists all the currently available xCommand commands.
To issue a command, type the command as shown, followed by one or more of the given parameters and
values. The valid values for each parameter are indicated in the angle brackets following each parameter,
using the following notation:
Format Meaning
<0..63> Indicates an integer value is required. The numbers indicate the minimum and maximum
value.
In this example the value must be in the range 0 to 63.
<S: 7,15> An S indicates a string value, to be enclosed in quotation marks, is required. The numbers
indicate the minimum and maximum number of characters for the string.
In this example the string must be between 7 and 15 characters long.
<Off/Direct/Indirect> Lists the set of valid values for the command. Do not enclose the value in quotation marks
(r) (r) indicates that this is a required parameter. Note that the (r) is not part of the command
itself.
To obtain information about using each of the xCommand commands from within the CLI, type:
xCommand or xCommand ? to return a list of all available xCommand commands.
n
xCommand ?? to return all current xCommand commands, along with a description of each command, a
n
list of its parameters, and for each parameter its valuespaces and description.
xCommand <command> ? to return a description of the command, a list of its parameters, and for each
n
parameter its valuespaces and description.
xCommand commands
All of the available xCommand commands are listed in the table below:
AdminAccountAdd
Adds a local administrator account.
Name(r): <S: 0, 128>
The username for this account.
Password(r): <Password>
The password for this account.
AccessAPI: <On/Off>
Whether this account is allowed to access the system's status and configuration via the API. Default: On.
AccessWeb: <On/Off>
Whether this account is allowed to log in to the system using the web interface. Default: On.
Enabled: <On/Off>
Indicates if the account is enabled or disabled. Access is denied to disabled accounts. Default: On.
Example: xCommand AdminAccountAdd Name: "bob_smith" Password: "abcXYZ_123" AccessAPI: On AccessWeb: On
Enabled: On
Cisco VCS Administrator Guide (X8.1.1)
Command reference — xCommand
Page 469 of 507