This topic discusses how to set and control blackouts for various BMC PATROL objects.
You can set blackouts for various PATROL objects such as parameters, application instances, or application classes by using the BMC PATROL Agent configuration interface.
You can control blackouts for PATROL objects by using options for setting types of blackouts.
You can use the /AgentSetup/Blackout configuration branch to configure blackouts for PATROL objects. The branch maintains the list of objects that you want to black out and the object-specific blackout configuration such as the type of blackout, schedule information, duration, and information message to be associated with the blackout.
You can configure a blackout by using pconfig, wpconfig (Windows), xpconfig (UNIX ® ), PATROL Configuration Manager, or a PSL pconfig script, by using the following format:
The preceding format contains the following options:
<object> represents the PATROL object that you want to black out. Specify the PATROL object as described in the following table.
PATROL object options
Blackout is applied to the specified application class, and all the instances and the parameters contained in the application class instances.
Application class instance
Blackout is applied to the specified application class instance and all its parameters.
Blackout is applied to the specified parameter.
The object is specified in the following format:
You can specify the application class (
[/APP_NAME]) in an exact form, and in a generic form by using the __ANYAPPL__ wildcard string, as illustrated below:
__ANYAPPL__ applies the blackout to all the application classes, instances, and parameters contained in that application class.
If you have set the blackout for a specific PATROL object for the same or overlapping duration of time, the product applies the combined blackout to that PATROL object. For example, if you have set the TYPE_COLLECTION blackout on an application class by using __ANYAPPL__ and have set the TYPE_EVENT blackout on a parameter contained in that application class, the resultant blackout type for that parameter is TYPE_COLLECTION | TYPE_EVENT.
You can specify the application class instance (
[/INST_NAME]) in an exact form, and in a generic form by using the __ANYINST__ wildcard string, as illustrated below:
Suppresses data collection for parameters of an application class or an application class instance
Suppresses range evaluations
Suppresses event generation
Suppresses recovery action
Suppresses Simple Network Management Protocol (SNMP) traps generated by the standard event classes
Generates only the blackout start and stop information events
Runs all blackout types
When an event is generated for a PATROL object, the event description displays the type values described in the above table for various types of blackout.
You can define multiple types by separating the types by using a | as in case of
TYPE_RECOVERY|TYPE_SNMPTRAP, and so on.
START_INFO represents the condition when you want the blackout to start for the specified object. Specify START_INFO in the following format:
The following table describes the values that you can specify for START_INFO.
Applies the blackout once
Applies the blackout daily
Applies the blackout on a day of the week
Applies the blackout on a day of the month (1 to 31)
LIST OF DAYS
Applies the blackout on the list of days that you specified as a range by using ‘
Applies the blackout at the time that you specified in the Hour:Min format (24-hour format), when you want the blackout to start
START_INFO is case-sensitive. You must specify values in upper case only.
0(zero), the blackout is set for an infinite duration.