Deploy xAPI commands via CE-Deploy

Abstract

Deploying xAPI commands is a fundamental aspect of administering a Cisco collaboration endpoint deployment. While Control Hub allows us to deploy commands to a single endpoint, scaling this process to a larger deployment through Control Hub or a terminal command prompt can be time-consuming and inefficient. By utilizing CE-Deploy, we can efficiently deploy xAPI commands to multiple endpoints using various criteria such as IP Address, Control Hub Org ID, Control Hub Tags, and more. This lab will demonstrate how to deploy a system time check across multiple devices. Although this is not a configuration change, it will showcase how the CE-Deploy message console provides real-time feedback as the deployment progresses.

CE-Deploy Running xAPI Commands

dep-2.3 Lab

dep-2.3.1 Open Ce-deploy and load the environment your created in the last lab if its not already loaded.

Loading Environments

To load an environment, use the dropdown in the Environment loading section and select your new Environment and select Load Environment.

dep-2.3.2 Select xAPI from the deployment section. In the command text box enter:

xCommand Time DateTime Get

dep-2.3.3 Under the deployment options drop down select Org Id, this will populate the lab org ID. As this command does not make any system changes it can be safely run against all the devices in the lab Control Hub Organization. By doing this we can see how CE-Deploy queues and completes xAPI commands in bulk.

dep-2.3.4 Select the video devices only filter checkbox. This will limit running the command to only the xAPI capable device in the organization and no other devices in the lab, an example being a phone.

dep-2.3.5 Select "Start Deployment"

dep-2.3.6 Ensure Run Deployment Now is selected and select Next.

dep-2.3.7 If any devices are offline you may receive a prompt letting your know that some of the devices are offline. If this is case just select "Yes".

dep-2.3.8 The message console will now let you see the deployment in progress and all output from the devices. In this case what is returned is the system time running on the endpoints.

dep-2.3.9 Switch back to CE-Deploy staying in XAPI abd select the "Command Builder" button. This launches the Command Builder window. This allows us to search for commands based on the command syntex.

dep-2.3.10 In the search area type "macros log" and select the Macros Log Get command.

Click Insert. You should now see the command populate the main XAPI Command area. You should also take note that the Recents drop down is now populated with the last command you ran. This just makes life a little easier to access commands you repeatedly run.

dep-2.3.11 Click Start Deployment. You should see the Macro logs being pulled from each endpoint in the Org. To narrow the amount of data you can use your tag under the deployment options.

The message console should now populate with the log data.

Success

This concludes this section. Now that you know how to find and run commands feel free to try a few more commands from the command builder. Make sure to stick with your pod's tag if making changes to your endpoint. Using the Org ID deployment option will make a change to every endpoint in the Control Hub Org.

Running a xStatus Command

Now that you know how to run a xCommand, can you work out how to run a xStatus command?

Find a command at RoomOS or use the Command Builder in CE-Deploy.