Performing actions on a PATROL Agent by using CLI

You can use Command Line Interface (CLI) commands to run the managepaactions utility. With this utility, you can send the following commands to multiple PATROL Agents at once:

  • sendSyncMsg
  • executePSL

These commands can be accessed from the <installationDirectory>\TrueSightPServer\truesightpserver\bin folder.

The sendSyncMsg command

Use the sendSyncMsg command to restart multiple or all PATROL Agents at once. The following parameters are available for the sendSyncMsg command:

managepaactions sendSyncMsg user=<userName> [agentFile=<agentFileName>] [syncMsg=all] [waitInterval=<waitInterval>] [port=<port>] [protocol=<protocol>]

The parameters in sendSyncMsg are described in the following table:

ParameterDescription
user=<username>The name of the user who runs the utility.
agentFile=<agentFileName>

Optional.

Use this parameter to send the sync command to a few PATROL Agents. You can specify these PATROL Agents in the agentFileName file. Use this parameter instead of the syncMsg=all parameter.

Open the Command Prompt and run the following commands to get the list of the PATROL Agents that you have saved in the agentFileName file:

  1. CD /D "%TRUESIGHTPSERVER_HOME%\truesightpserver\modules\pgsql\bin\"
  2. psql -U <dbUserName> -d <dbname>
    where <dbUSerName> is the database user that you provided during the TrueSight Presentation Server installation.
    For example:
    psql -U admin -d truesight
  3. \copy to select serverid, moinstanceid,hostname from patrolagent_details to the agentFileName file.
  4. \q

Note

<agentFileName> is the parameter to provide the file that contains the details of PATROL Agents with the location of the file. For example: "C:\tableOut.txt"

syncMsg=all

Optionial.

Use this parameter to send the sync command to all PATROL Agents. Use this parameter instead of the agentFile parameter.

waitInterval=<waitIntervalInMin>

Optional.

Use this parameter to specify the time delay to send the sync command. The default value of this parameter is 2 minutes. If you do not specify a value for this parameter, the sync command is sent after an interval of 2 minutes. If you specify 0 in this parameter, the sync command is sent immediately.

port=<port>

protocol=<protocol>

Optional.

The default values are:

  • port: 443
  • protocol: https

The executePSL command

Use the executePSL command to send the PSL command to multiple or all PATROL Agents at once. The following parameters are available for the executePSL command:

managepaactions executePSL user=<userName> pslFile=<PSLFilename> [agentFile=<agentFileName>] [pslCmd=all] [waitInterval=<waitInterval>] [port=<port>] [protocol=<protocol>]

The parameters in executePSL are described in the following table:

ParameterDescription
user=<username>The name of the user who runs the utility.

pslFile=<PSLFileName>

Use this parameter to send the PSL command to all PATROL Agents that you specify in the PSLFilename file.


agentFile=<agentFileName>

Optional.

Use this parameter to send the PSL command to a few PATROL Agents. You can specify these PATROL Agents in the agentFileName file.

Open the Command Prompt and run the following commands to get the list of the PATROL Agents that you have saved in the agentFileName file:

  1. CD /D "%TRUESIGHTPSERVER_HOME%\truesightpserver\modules\pgsql\bin\"
  2. psql -U <dbUserName> -d <dbname>
    where <dbUSerName> is the database user that you provided during the TrueSight Presentation Server installation.
    For example:
    psql -U admin -d truesight
  3. \copy to select serverid, moinstanceid,hostname from patrolagent_details to the agentFileName file.
  4. \q

Note

<agentFileName> is the parameter to provide the file that contains the details of PATROL Agents with the location of the file. For example: "C:\tableOut.txt"

pslCmd=all

Use this parameter to send the PSL command to all PATROL Agents. Use this parameter instead of the agentFile and pslfile parameters.

waitInterval=<waitIntervalInMin>

Optional.

Use this parameter to specify the time delay to send the PSL command. The default value of this parameter is 2 minutes. If you do not specify a value for this parameter, the PSL command is sent after an interval of 2 minutes. If you specify 0 in this parameter, the PSL command is sent immediately.

port=<port>

protocol=<protocol>

Optional.

The default values are:

  • port: 443
  • protocol: https


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

Comments