Configuring a blackout by using pconfig

Include the PATROL_CONFIG string at the start of the BMC PATROL Agent Configuration File (.cfg ).

Note

The .cfg file may contain multiple configuration variables. Ensure that the last variable does not have a trailing comma.

The following tasks explain how to use the pconfig command-line utility to configure the BMC PATROL Agent configuration branch, /AgentSetup/Blackout, on UNIX and Windows.

To modify the configuration variable on UNIX

  1. Go to the PATROL Agent installation directory and run the following script:
    • For Korn and Bourne shell: ../patrolrc.sh
    • For C shell: source.patrolrc

  2. Create the config_file.cfg file and edit the configuration variables as required.

    To modify the value of the /AgentSetup/Blackout configuration variable, use the following format: 

    PATROL_CONFIG "/AgentSetup/Blackout/<object>" = {REPLACE = "[TYPE; START_INFO; DURATION; INFO_MSG]"}
  3. Save the config_file.cfg file.

  4. Apply the changes made in the configuration variable to BMC PATROL Agent, as follows: 

    pconfig -p <port> -host <hostName> <config_file.cfg>

  5. Obtain the latest configuration information, as follows: 

    pconfig +get -p <port> -host <hostName> | grep Blackout
  6. Verify that the change is made to the configuration variable.

To modify the configuration variable on Windows

  1. Create the config_file.cfg file and edit the configuration variables as required.

    To modify the value of the /AgentSetup/Blackout configuration variable, use the following format: 

    PATROL_CONFIG "/AgentSetup/Blackout/<object>" = {REPLACE = "[TYPE; START_INFO; DURATION; INFO_MSG]"}
  2. Save the config_file.cfg file.

  3. Apply the changes made in the configuration variable to BMC PATROL Agent, as follows: 

    pconfig -p <port> -host <hostName> <config_file.cfg>

  4. Obtain the latest configuration information, as follows: 

    pconfig +get -p <port> -host <hostName> -save <config_file.cfg>
  5. Verify that the change is made to the configuration variable.

 Examples

The following examples illustrate the blackout configuration and settings:

Example
  • "/AgentSetup/Blackout/CPU/CPU/CPUCpuUtil" = {REPLACE = "[ TYPE_COLLECTION; START DOW 1,3 AT 18:03; 15; \"Day of week Blackout \"]"}

    This blackout is applied for the CPUCpuUtil parameter, on Monday and Wednesday of every week, at 18:03 hours, for a duration of 15 minutes.

  • "/AgentSetup/Blackout/CPU/CPU" = {REPLACE = "[ TYPE_COLLECTION; START DOM 15-21 AT 11:48; 5; \"Day of Month Blackout \"]"}

    This blackout is applied for the CPU application class instance, for the span between the 15 th to the 21 st of every month, at 11:48 hours, for a duration of 5 minutes.

  • "/AgentSetup/Blackout/CPU" = {REPLACE = "[ TYPE_EVENT; START DAILY AT 17:00; 2; \"Daily Blackout will happen \"]"}

    This blackout is applied for the CPU application class, daily, at 17:00 hours, for a duration of 2 minutes.

  • "/AgentSetup/Blackout/CPU/CPU/CPUCpuUtil" = {REPLACE = "[ TYPE_ALL; START ONCE AT 16:15; 0; \"Start Once Blackout \"]"}

    This blackout starts at 16:15 hours and is applied once for an infinite duration of time.

 

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