Commands
Note
Before you proceed, make sure that you have installed the the Obcerv Commands app. See Install the Commands app.
The Commands app enables additional command functions in the Entity Viewer app. From the Entity Viewer > Commands page, you can conveniently view the status of queued and running commands as well as access the command history and rerun commands from the list.
Endpoints from an API which is not publicly exposed and only internally accessible to Obcerv also allow you to:
- Clear completed, failed, and cancelled commands
- Clear a single command execution history
- Subscribe to the output of a single command
Trigger commands from an entity Copied
Through the Commands app, commands set up in the Geneos Gateway Setup Editor can be accessed right in the Entity Viewer app.
To learn how to configure commands in Geneos to work with the commands function in Obcerv, see Configure Geneos commands and data for Obcerv.
- While viewing an entity, click . You can also run commands by hovering on a metric and clicking .
- From the Commands pop-up, select the command that you want to run.
Note
You can use the search box to find a specific command. - If there are required arguments, select the options or input them in the provided text fields.
- Click Run command.
- After running the command, check if the command has successfully completed or failed in the Commands panel.
- To review the command history, click View preview and switch between the Output, Execution log, Error log, or Summary tabs.
Review command audit history Copied
On the Commands page, click View Command Audit History to review detailed information about each command’s execution, including dimensions, targets, status, timestamp, and more.