Commands instruct a device to execute actions, such as to go into standby mode or to set a new user passphrase.

The list of applicable commands varies according to the device type and the version of software installed. You can see all the public, cloud-enabled commands that are available on the device in Control Hub.

Control Hub provides you with a user interface for running these commands, providing that there are no restrictions due to access privileges, security, or privacy.

1

From the customer view on https://admin.webex.com, go to Devices and select a device.

2

From the Actions dropdown, select Run xCommand to open the command page for the device.

On this page, you can browse or search for the commands you're interested in. Your previously run commands are shown here.
3

Select the command to execute.

A command page opens, and you can enter values for all the arguments. The required options are displayed with an asterisk.


 

  • A command may be marked unavailable if there are restrictions due to access privileges, security, or privacy. On personal mode devices, several commands are unavailable in order to protect user privacy (for example, Audio Microphones Unmute).

  • If you don't find a command that you are looking for, it may be because the device doesn't have access to that command due to its software version or product type. To find out what commands are available for a specific device type, see roomos.cisco.com. Select the installed software version, the product type, Command, and a backend of Cloud.



Argument types include:

  • Integers – Type or use the arrows to enter the value. The accepted range will be indicated.

  • Strings – Type in the string.

  • Enumerations – Select from the drop-down list.

  • Arrays of strings or integers – Type in the values separated by commas. When you press comma or Enter, the value is added into the field.

  • Arrays of enumerations – Select the desired checkboxes.

  • Multiline – Input the multiline body in the Body text field.

4

When all the required arguments are defined, the Execute button is enabled. Click to execute the command.

When the command is finished running, an indication of the execution status is displayed. This contains the JSON response from the command, where applicable.