Commands Dockable

Overview

Active Console 2 has a single command viewer that displays a list of the recent and currently executing commands. Commands are identified by an arrow icon, followed by its function name.

To open the Commands dockable, go to Active Console 2 > View > Commands.

Column Description
Name Recent command list.
Target List of the targets (data item).
State

Current status of each command. The state of a command has one of the following values:

  • Running — command is currently running on the selected target.
  • Target down — target of the command is down or inaccessible.
  • Cancelled — command is cancelled by the user.
  • Partially complete — command is running on the target and is receiving output, but it has yet to be completed.
  • Complete — command is completed.
  • Error — command encountered an error and is not complete.
Output Displays the Gateway where the command is executed.
Result description Details of the result.
Source Source location where the command is executed in Gateway.
   

Each command is displayed with its current status, the target it was run on, the first line of its output, and a description of its result.

Note: The output may be blank if the first line is an empty string.

Run a command

There are multiple areas in Active Console 2 where you can run a command. The most common is to run a command in the Metrics dockable. To view the full list of commands, see Commands Dockable.

  1. Right-click any data item or row in the Metrics dockable.
  2. Click the command you want to execute.

When you run a command, it automatically appears in the Commands dockable.

If you select multiple items, then only the commands that can be used for these items appear in the right-click menu. When a command is executed, it runs on all the items. For example, if you select four entities, and then run the Snooze command, it will snooze all four items.

In this example, the data item from row_1 and Column_3 is selected and the Show Variables command is executed:

This action triggers the following effects:

  • Displays information about the configured variables available on a target in the Output dockable.
  • The Show Variables command appears in the Commands dockable.

Remove a command

You can remove existing commands in the Commands dockable. The following functions are available from the Command dockable viewer right-click menu:

  • Remove — remove the selected command item.
  • Remove complete — remove all completed commands.
  • Auto clear — remove all completed commands that do not have output.

To remove a command:

  1. Open the Commands dockable.
  2. Right-click the command you want to remove.
  3. Click Remove.

Note: This only removes the details from the Commands dockable and does not remove the commands entirely from the Gateway configuration.

To view the output of the command in the Output dockable, you can do one of the following:

  • Double-click the command item.
  • Right-click the command, and click View output.

Note: The View output option is only available if the command item displays information in the Output dockable.

List of commands

In Active Console 2, there are dockables and views where you can open the list of commands and execute them based on the configurations you have set in Gateway Commands. The list of commands vary depending on the selected data item in the:

  • Event tickers dockable.
  • Gateways dockable.
  • Managed entities view.
  • Metrics dataview.
  • Objects in Active Dashboard with data items.
  • State Tree.

This table shows the list of commands that you can use:

Commands Description
Snooze Allows control over the Gateway snooze functionality. See Snooze commands in Gateway Commands.
User Assignment Allows control over the user assignment functionality. See User Assignment commands in Gateway Commands.
Show Rules Displays information about any rules which apply to the selected data item. See Rule commands in Gateway Commands.
Show Variables Displays information about the configured variables available on a target. See Rule commands in Gateway Commands.
Show Alerts Displays configuration information about all the alerts that are applicable for the selected data item. See Alert commands in Gateway Commands.
Show Rule Contention Displays a list of rule targets for which there is more than one rule that can cause a rule contention. See Rule commands in Gateway Commands.
Show Annotations Shows annotations defined for a data item. See Annotation Commands in Gateway Commands.
Show Rule Contention Shows rule targets with more than one rule which may be the cause of rule contention. See Rule commands in Gateway Commands.
Message Broadcaster Sends a ticker event message to all users on the running Gateway. See Message commands in Gateway Commands.
Reload setup Reloads selected setup file. See Reload commands in Gateway Commands.
Create Diagnostics Creates a compressed tar file containing a set of diagnostic outputs. See Diagnostic commands in Gateway Commands.
Database Logging Database commands allow temporary changes to be made to the scope of item value logging as well as pausing or resuming the database connection. See Database Logging commands in Gateway Commands.
Load Monitoring Allows you to start and stop the collection of statistics on demand, write statistics to file, and reset the statistics collected for the Gateway. See Load Monitoring commands in Gateway Commands.
View Setup Displays the setup for the selected sampler. See Sampler commands in Gateway Commands.
View Netprobe Log Views the Netprobe log file, if configured. See Netprobe commands in Gateway Commands.
SampleNow Forces a sampler to execute a sample immediately. See Sampler commands in Gateway Commands.
Sampler Schema Generates an XML schema definition for headlines and columns not already described in the built-in schema for each dataview in the given sampler. See Gateway Hub commands in Gateway Commands.