Important This documentation space contains information about PATROL Agents when deployed in a TrueSight Operations Management environment. If you are a BMC Helix Operations Management user, see PATROL Agent 22.3.01 for BMC Helix Operations Management.

refresh_parameters()

Refresh PATROL parameters.

Syntax

refresh_parameters(object,[GLOBAL])

Parameter

Parameter

Definition

object

name of the PATROL object that is to be updated

GLOBAL

mnemonic that instructs the refresh_parameters() function to update all instances of object if object is a global parameter

Description

The refresh_parameters() function runs the PATROL parameters identified by object:

  • If object is a computer or application instance, run all parameters that belong to object.
  • If object is a local parameter, run the parameter for object.
  • If object is a global parameter and "GLOBAL" is specified, run all instances of the global parameter object.
  • If object is a global parameter and "GLOBAL" is not specified, run only the named instance of object.

To properly refresh a consumer parameter, you must also refresh its collector parameter.

Example

The following refresh_parameters() function refreshes the PAUserErrors parameter for the instance PATROL Agent:

refresh_parameters("/PATROLAGENT/PATROLAGENT/PAUserErrors");

The following refresh_parameters() function refreshes all parameters for the instance PATROL Agent:

refresh_parameters("/PATROLAGENT/PATROLAGENT");

 

 

 

 

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