Working with agents

This topic provides instructions on creating, modifying, and deleting filters for PATROL Agents, running queries on a PATROL Agent, and viewing the history of applied configurations. To understand the concept of agents, see Agents.

Creating Agent filters

By default, the maximum number of PATROL Agents that can be displayed on the Agents page is 2000. If you have more Agents, create filters to view them.

On the Configuration > Agents page, click the main action menu and do the following:

  1. Click Create Agent Filter.
  2. Do one of the following:
    • Click Import Conditions from a Policy and select a policy. Define additional Agent filter properties and conditions if required.

       Details about Agent filter properties

      PropertyDescription
      Agent Host Name

      Host name of the computer on which the PATROL Agent is installed.

      Note:

      • The value for the matches property must be a strict regular expression. Some examples of regular expressions that can be used:
        • virtual_machine -- To select Agents that match the exact string "virtual_machine
        • .*?virtual_machine.* -- To select Agents that match the sub-string "virtual_machine"
        • ^((?!clm-pun).)*$  -- To select Agents that do not match the sub-string  "clm-pun"
      • The value of the in list operator can be a comma-separated list of Agent host names. You cannot provide host names exceeding the limit of 4000 characters (including the comma separator and blank space). 
        Example: Suppose you want to add the Agents named, vw-pun-662266virtual-mc-122, and win-clm-3355. In this scenario, you can provide the following Agent selection criteria:
        Agent Host Name in list vw-pun-662266, virtual-mc-122, win-clm-3355
      Agent Port

      Port number through which the PATROL Agent listens for incoming connections from the PATROL console.

      Use port numbers from 1025 to 65535.

      Agent VersionVersion of the PATROL Agent.
      Agent Operating SystemOperating system of the computer on which the PATROL Agent is installed.
      Agent IP AddressIP address of the computer on which the PATROL Agent is installed. If you select the Agent IP Address in the range condition, only IPv4 range is supported.
      Agent Tag

      Tag applied on the PATROL Agent.

      Note: The agent tag value cannot contains special characters such as, single quotation marks ('), double quotation marks ("), ampersand (&), angle brackets (< >), pipe (|), and braces ({ }).

    • Click Define Conditions and add conditions for the filter.
  3. Save the filter.
  4. Add a name for the filter and click Ok. The filter is applied to all PATROL Agents on the Agents page.

Modifying filters

On the Configuration > Agents page, click the main action menu, and do the following:

  1. Click View Saved Filters.
  2. Click a filter action menu, and click Edit.
  3. Make your changes and click Update.

Deleting filters

On the Configuration > Agents page, click the main action menu, and do the following:

  1. Click View Saved Filters.
  2. Click a filter action menu, and click Delete.

Running a query on PATROL Agents

This option is available only for PATROL Agents that are in connected state.

You can run PSL commands on PATROL Agents by using the Agent Query Tool and view the results in the tool. You can also perform the following actions by using the tool:

  • Restart the Agent. Use the  button.
  • Reload the Agent. Use  the button.
  • Stop the Agent. Use the  button.

On the Configuration > Agents page, click a device action menu, and do the following:

  1. Click Query PATROL Agent.
  2. Log in to the Agent with the host credentials. 

    Note

    If you are an administrator or a user with the manage_aqt_authentication permission, you can directly run PSL commands without having to enter the host credentials for authorization. For more information, see Roles and permissions.

  3. In the Command box, do one of the following:
    • Manually enter a PSL command.
      In the Command box, type the command and press Enter or click Execute. For example, %DUMP ALL. The results are displayed. For more information about PSL commands, see  PATROL Script Language overview and functions .
    • Click  and select a query from the out-of-the-box PSL commands list.
      In the Select Command dialog box, select a command and click Apply.

       Click here to view a list of available commands

      CommandDescription
      Active/ Running KMs detailsShows all the knowledge modules (KMs) that are currently loaded on the selected PATROL Agent
      Agent InformationShows the PATROL Agent information: host, IP address, port, version, and OS version.
      All pconfig variablesShows the PATROL configuration data currently loaded on the selected PATROL Agent
      Disabled KMsShows all the knowledge modules that are disabled on the selected PATROL Agent
      Force DiscoveryTriggers discovery of all instances configured on the selected PATROL Agent
      History RetentionShows the number of days that data collection history is saved on the collection PATROL Agent
      Last 20 Parameter Alarm/Warning EventsShows the last 20 parameters that were triggered with alarm or warning events on the selected PATROl Agent
      PATROL SID ReportShows all of the PATROL Agent's created instances and their SIDs You can use this to easily find the SID you need to create a filter for a specific instance.
      Preloaded KMs - All -Policy+LocalShows all the preloaded KMs (local and policy) configured on the selected PATROL Agent
      Preloaded KMs - Locally configuredShows all the locally-configured preloaded KMs on the selected PATROL Agent
      Preloaded KMs - Policy configuredShows all the policy-configured preloaded KMs on the selected PATROL Agent
      Refresh Parameters

      Rrefreshes all the collection parameters for the KMs configured on the selected PATROL Agent to get the latest data.

  4. Click Execute. The command and its results are displayed.

Viewing Agent configuration history

This option is available only for connected Agents. To view the Agent configuration history, on the Configuration > Agents page, click the device action menu, and click Show History for Applied Configurations.


Was this page helpful? Yes No Submitting... Thank you

Comments