Agent actions

When you execute an agent action, it is issued from your local console, but executed on the computer where the PATROL Agent is installed. Agent actions are also called menu commands in PATROL and vary from KM to KM.

 

The Agent Actions option is available only when the following conditions are met:

  • You have appropriate permissions required to execute agent actions. 
  • The application class to which the monitor belongs has the menu commands defined in the KMs for PATROL Agent.
  • A restricted user must have full access to the respective CI.

Related topics

Configuring-after-installation

Considerations-for-writing-a-script

To respond to an event by using an agent action 

  1. In the Show Monitors page, in the Tools Menu column of a monitor, click the blue wrench icon.
  2. Click Agent Actions, and select an agent action. 
    If any input is required for the agent action, a dialog box is displayed. You must provide the values that are required for the action to be executed. 
    A confirmation message is displayed after the agent action is executed.

Permissions required to execute agent actions

You must have the Allow execution of Agent Action permission assigned to have the Agent Actions option in the Tools menu. If you do not have the permission assigned, the Agent Actions option is not displayed in the Tools menu.

By default, the following roles have the Allow execution of Agent Action permission:

  • Super Admin
  • Event Administrator
  • Data Collection Administrator
  • Service Administrator

For other roles, these permissions must be assigned by the administrators to access the agent actions.

PATROL for Scripting agent actions

The following table lists the agent actions available for the PATROL for Scripting.

Monitor type

Agent action

Description

Script

Reports > Statistics

Reports the number of categories, devices, scripts, and custom monitors.

Report.png

Reports > Custom monitors

Reports the number of new monitor types (known as knowledge modules) that were created based on the scripts output.

Report_custom_monitors.png

Cleanup > Custom monitor type

Enables you to choose to delete the old monitor types (known as knowledge modules) that were created based on the scripts output and are no longer in use.

  • Daily - Monitor types that are not in use since last one day will be deleted.
  • Weekly - Monitor types that are not in use since last one week will be deleted.
  • Monthly - Monitor types that are not in use since last one month will be deleted. 

Note: The cleanup is executed two times in a day.

Validation > Script output

Enables you to validate your script output. The KM verifies the script and builds expected result for the entered script. This field can be a maximum of 128 characters.

An example of a valid script output:

Agent action_valid script.png

Agent action_valid script_output.png

You can also use the ValidateScript tool to validate your script output from the command line. For more information about how to use the tool, see Using-the-ValidateScript-tool-to-validate-the-script-output.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*