How to Run a Command and View Its Result

Applies to any command available on a device (for example, Update Version or Ping Check).

Run a command

1. Open the device.
2. Click the command you want to run. Command buttons appear either in the left-hand Commands panel or on the device's dashboard / overview page, depending on the device.
3. You'll see "Command successfully sent."

If a command is greyed out

Some commands only run on devices that support them, or only while the device is in a certain state. When a device's reported data shows that it can't run a command, the command is greyed out wherever it appears — the Commands panel, the command, toggle, switch, selector and slider widgets on the dashboard, and the mobile view — and can't be sent.

In the Commands panel and on command (button) widgets, hover over the greyed-out command to see why. Other dashboard widgets are simply greyed out, with no reason shown. The reason is set by the Partner that provides the device model; if none was set, you'll see "This command is not available for this device". If the device hasn't reported this information yet, you'll see "This device hasn't reported whether this command is available" — the command becomes available once the device reports it.

If Send is disabled: "This command can't be sent yet"

Some commands ask you to pick from a list, for example an input source, that the device itself supplies. If the device hasn't supplied that list, there's nothing to choose and the command can't be sent. The dialog then shows This command can't be sent yet and names the setting that has no options:

• "...which this device hasn't reported": the device hasn't sent that information yet. Usually the device is still reporting for the first time after being added, its credentials are missing or incorrect, or that information isn't available with the device's current setup. Once the device reports it, the options appear.
• "...reported, but with nothing in it": the device answered, but has nothing to offer right now (for example, no active inputs). This can be normal.
• "...reported, but not as a list this screen can read": the command's definition doesn't match what the device reports. Contact the device's manufacturer or Xyte support.

When several devices are selected, the options come from the first selected device.

Send a command to several devices

1. On the Devices screen, tick the devices you want (they must share a model).
2. Click Commands in the menu above the list and pick the command.

Devices of the same model can differ in which commands they can run. The Skip unsupported devices switch at the bottom of the Commands list decides what happens when some of the selected devices can't run the command:

• On (default) — the command is sent only to the devices that can run it, and a message lists the devices that were skipped.
• Off — if any selected device can't run the command, nothing is sent.

If none of the selected devices can run the command, you'll see "Command not available" and nothing is sent.

View the result

Open the Commands tab to see the command and its status:

• Active & Pending — the command while it's queued or running (status In Progress).
• All Commands — the command once it's finished, with its final status (Done or Failed) and result in the Message column.

If a command isn't under Active & Pending, it's already finished — check All Commands.

If a command ends as Failed, an incident is opened for it. You can run the command again from that incident, and the incident closes by itself once the command succeeds. See Incidents.