---
title: "Commands dockable"
description: ""
url: "https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/commands-dockable/index.html"
---
## Overview

Active Console has a single command viewer that displays a list of the recent and currently executing commands. Commands are identified by an arrow ![](https://docscdn.itrsgroup.com/geneos/images/Icons/commandinstances16x16.png "icon") icon, followed by its function name.

To open the Commands Dockable, go to **Active Console > View > Commands**.

![](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-commands-dockable.png)

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. 


<div class="table-container">
<table class="legacy-table" style="width: 100%;margin-left: 0;margin-right: auto;mc-table-style: url('../../../Resources/TableStyles/ref_2_col_table.css');" class="TableStyle-ref_2_col_table" cellspacing="0">
                    <col class="TableStyle-ref_2_col_table-Column-Column1">
                    </col>
                    <col class="TableStyle-ref_2_col_table-Column-Column1">
                    </col>
                    <thead>
                        <tr class="TableStyle-ref_2_col_table-Head-Header1">
                            <th class="TableStyle-ref_2_col_table-HeadE-Column1-Header1">Column </th>
                            <th class="TableStyle-ref_2_col_table-HeadD-Column1-Header1">Description</th>
                        </tr>
                    </thead>
                    <tbody>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Name</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Recent command list.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Target</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">List of the targets (data item). </td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">State</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">
                                <p>Current status of each command. The state of a command has one of the following values:</p>
                                <ul>
                                    <li><code>Running</code> &#8212; command is currently running on the selected target.</li>
                                    <li><code>Target down</code> &#8212; target of the command is down or inaccessible.</li>
                                    <li><code>Cancelled</code> &#8212; command is  cancelled by the user.</li>
                                    <li><code>Partially complete</code> &#8212; command is running on the target and is receiving output, but it has yet to be completed.</li>
                                    <li><code>Complete</code> &#8212; command is completed.</li>
                                    <li><code>Error</code> &#8212; command encountered an error and is not complete.</li>
                                </ul>
                            </td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Output</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Displays the Gateway where the command is executed.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Result description</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Details of the result. </td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Source</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Source location where the command is executed in Gateway.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyB-Column1-Body1"> </td>
                            <td class="TableStyle-ref_2_col_table-BodyA-Column1-Body1"> </td>
                        </tr>
                    </tbody>
                </table>
                
</div>

## Run a command

There are multiple areas in Active Console 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 [List of commands](https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/commands-dockable/index.html#list-of-commands).

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 ![](https://docscdn.itrsgroup.com/geneos/images/Icons/commandinstances16x16.png "icon") **Snooze** command, it will snooze all four items.

In this example, the data item from `row_1`(`_Total`) and `Column_3` (`%privilegedTime`) ![](https://docscdn.itrsgroup.com/geneos/images/Icons/commandinstances16x16.png "icon") **Show Variables** command is executed:

![](https://docscdn.itrsgroup.com/geneos/images/active-console/ac-commands-show-variable.png)

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 Commands 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, 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](/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/).

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:

<div class="table-container">
<table class="legacy-table" style="width: 100%; mc-table-style: url('../../../Resources/TableStyles/ref_2_col_table.css'); margin-left: 0; margin-right: auto;" class="TableStyle-ref_2_col_table" cellspacing="0">
                    <col class="TableStyle-ref_2_col_table-Column-Column1"/>
                    <col class="TableStyle-ref_2_col_table-Column-Column1"/>
                    <thead>
                        <tr class="TableStyle-ref_2_col_table-Head-Header1">
                            <th class="TableStyle-ref_2_col_table-HeadE-Column1-Header1">Commands </th>
                            <th class="TableStyle-ref_2_col_table-HeadD-Column1-Header1">Description</th>
                        </tr>
                    </thead>
                    <tbody>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Snooze</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Allows control over the Gateway snooze functionality. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#snooze-commands">Snooze commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">User Assignment</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Allows control over the user assignment functionality. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/processing/monitoring-and-alerts/geneos_commands_tr/index.html#user-assignment-commands">User Assignment commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Show Rules</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Displays information about any rules which apply to the selected data item. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#rule-commands">Rule commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Show Variables</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Displays information about the configured variables available on a target. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#rule-commands">Rule commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Show Alerts</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Displays configuration information about all the alerts that are applicable for the selected data item. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#alert-commands">Alert commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Show Rule Contention</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Displays a list of rule targets for which there is more than one rule that can cause a rule contention. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#rule-commands">Rule commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Show Annotations</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Shows annotations defined for a data item. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#annotation-commands">Annotation Commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Show Rule Contention</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Shows rule targets with more than one rule which may be the cause of rule contention. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#rule-commands">Rule commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Message Broadcaster</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Sends a ticker event message to all users on the running Gateway. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#message-commands">Message commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Reload setup</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Reloads selected setup file. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#reload-commands">Reload commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Create Diagnostics</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Creates a compressed tar file containing a set of diagnostic outputs. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#diagnostic-commands">Diagnostic commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Database Logging</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">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 <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#database-logging-commands">Database Logging commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Load Monitoring</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">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 <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#load-monitoring-commands">Load Monitoring commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">View Setup</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Displays the setup for the selected sampler. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#legacy-sampler-commands">Sampler commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">View Netprobe Log</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Views the Netprobe log file, if configured. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#legacy-netprobe-commands">Netprobe commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">SampleNow</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Forces a sampler to execute a sample immediately. See <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#sampler-commands">Sampler commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Sampler Schema</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">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 <a href="https://docs.itrsgroup.com/docs/geneos/7.11.0/visualization/active-console/view-customization/../../../processing/monitoring-and-alerts/geneos_commands_tr/index.html#gateway-hub-command">Gateway Hub commands in Gateway Commands</a>.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyB-Column1-Body1"> </td>
                            <td class="TableStyle-ref_2_col_table-BodyA-Column1-Body1"> </td>
                        </tr>
                    </tbody>
                </table>
            
</div>


