Launch Commands from Control Hub in webex

A single XAPI command can be executed directly from the Control Hub for a single device that supports it.

This is where commands come in. They tell the device what to do, for example, turning off the device or putting the device into standby mode.

Depending on the type of device and the version of software that is installed on the device, the list of applicable commands may vary. The Control Hub provides a list of all the public, cloud-enabled commands available on the device, so you can easily see what you are capable of.

In order to run these commands, you can use Control Hub to provide you with an interface with which to do so, provided that you are not restricted by any access privileges, security restrictions, or privacy rights.

• Go to https://admin.webex.com and select a device from the customer view; you will find this under Devices.
• You can open the device’s command page by choosing Run Command from the Actions drop-down menu.

You will find on this page a list of commands you might be interested in browsing or searching for. Here you will find a list of commands that you have previously run.

• Make sure that the command you wish to execute is selected.

As a result, you will be presented with a command page that allows you to enter values for all the arguments that must be entered. An asterisk is displayed next to the options that are required.

As a result of access privileges, security settings, or privacy restrictions, a command may be marked as unavailable. There are several commands that are not available on devices that are in personal mode to protect the privacy of users (for example, Audio Microphones Unmute).

A device might not have access to a command you are looking for due to its software version or product type, so if you are unable to find it, the device may not be available. It is important to note that roomos.cisco.com provides information on what commands are available for each type of device type. It is important to select the version of the software installed in your machine, the product type, the command, as well as the backend.

Argument types include:

• Integers –In order to enter the value, you can either type it in or use the arrow keys. A range of acceptable values will be indicated when the form is submitted.

• Strings –The string needs to be typed in.

• Enumeration –There is a drop-down menu available for you to select from.

• Arrays of strings or integers –If you want to enter multiple values, you will need to separate them with commas. The value will be added to the field as soon as you press a comma or Enter on the keyboard.

• Arrays of enumerations –Please select the checkboxes that you would like to check.

• Multiline –In the Body text field, you will need to enter the multi-line body of the document.

• The Execute button will become active as soon as all the required arguments have been defined. The command will be executed as soon as you click the button.

An indication of the status of the execution will be displayed at the end of the command after it has finished running. If the command has returned a JSON response, the file will contain this information.