Configure Scheduled Task Policies

URL of the event in a third-party system. This is the complete path of the URL, and includes the FQDN (fully qualified domain name) of the computer that hosts the third-party system, the communication port, and the root URL path (for example, http://nnmi.example.com:8004/nnm/launch?cmd=showForm&objtype
=Incident&objuuid=$OPC_CUSTOM[nnm.incident.uuid]&menus=true).

Event drilldown information enables OMi users to launch the user interface of the third-party system in the context of an event.

Application that caused the event to occur. Unlike the Related CI attribute, which is a direct relationship to a CI in the RTSM, the application attribute is a simple string-type attribute (for example, Oracle and OS).

Device such as a computer, printer, or modem. Unlike the Related CI attribute, which is a direct relationship to a CI in the RTSM, the object attribute is a simple string-type attribute (for example, C:, and /dev/spool).

String used to organize different types of events within an event category or subcategory (for example, users or applications, accounts and security).

ID of the service associated with the event. A service ID is a unique identifier for a service and can be used in OMi to identify the node and CI associated with the event.

The message stream interface (MSI) allows external applications to interact with the internal event flow of the agent. The external application can be a read-write application, for example, an event processing program that can read events, modify attributes, and generate new events for retransmission to the server. The application could also read events, or send its own events.

Divert events. Divert an event to the MSI instead of to the server when an event is requested by an external application.

Copy events. Send the event to the server, and a copy of the event to the MSI.

Create New Custom Attribute: Creates a new custom attribute with the default name CA_n. To rename the custom attribute, double-click the name to select it and type the new name.

The name of the custom attribute. The name is case-insensitive.

Custom attributes are additional attributes that contain any information that is meaningful to you. For example, you might add a company name, contact information, or a city location to an event. You can have more than one custom attribute attached to a single event.

The following custom attribute names cannot be used because they are reserved for internal use:

Description

EtiHint

HP_OPR_SAAS_CUSTOMER_ID

NoDuplicateSuppression

RelatedCiHint

SourceCiHint

SourcedFromExternalId

SourcedFromExternalUrl

SubCategory

SubCiHint

Value of the custom attribute.

Title

Brief description of the nature of the event.

Description

Detailed description of the event.

Severity

Severity assigned to the event (Critical, Major, Minor, Warning, Normal, Unknown).

Category

Name of the logical group to which the event belongs (for example, Database, Security, or Network). The event category is similar in concept to the HP Operations Manager message group.

Subcategory

Name of the logical subgroup (category) to which the event belongs (for example, Oracle (database), Accounts (security), or Routers (network)).

ETI

Contains the event type indicator (ETI) resolution hint, which OMi uses to associate the event with an ETI and for event correlation.

Use the format <ETI name>:<ETI state>:<metric value>. Specify the name of the indicator (for example, CPULoad), the indicator state (for example, High), and, optionally, the metric value (for example, 80). When OMi receives an event with an ETI resolution hint of CPULoad:High, and the ETI and state exist, the Event Type Indicator attribute is set to CPULoad:High in the event. The metric value is optional and serves informational purposes only.

Node

Name of the system where the event occurred (for example, node.example.com).

Information used to identify a subcomponent of a CI. This CI subcomponent is used to calculate an aggregated status within OMi's Service Health for selected CIs.

If an HI is populated by events from multiple components, you can specify a component name in this field in order to ensure the correct calculation of the HI state.

For example, if you have a Computer CI with two CPUs, cpu #1 and cpu #2, events from both CPUs will be sent to the same CPU Load HI. By default, the events will override each other and create an incorrect HI state. To prevent this, you can populate Sub Component with values "cpu #1" and "cpu #2" which will cause the HI state to be calculated as an aggregated state between the two events.

Source CI

Contains the source related CI. For example, type the name and instance of the OMi server that provides events (for example, OMi@@mgmt.example.com).

If you enter a source related CI, OMi tries to find the corresponding CI in the RTSM.

Source Event ID

Reserved for future use.

Send with closed status (For the Open Message Interface, SNMP Interceptor, and Scheduled Task policies)

Sets the event's lifecycle status to Closed before sending it to OMi.

If events with the event key that you type here exist in the OMi event database when this event is received, these events are automatically closed. You can use pattern matching and variables to match multiple event keys. For example, consider the following pattern:

<$MSG_SEV>:<$MSG_NODE_NAME>

This pattern is evaluated by first replacing the variables with the values that they resolve to, for example:

critical:cabbage.example.com

This pattern is then compared using pattern matching rule against the event keys for all events in the OMi event database. Any key that you provide in the policy is treated as a simplified OM pattern in OMi. Therefore a plain string is treated as a substring and not as a complete match. The key in our example will match:

critical:cabbage.example.com:TEST
critical:cabbage.example.com:TEST1
critical:cabbage.example.com:TEST2A

and so on.

To ensure that that the key matches only exact values, enclose the attribute value in an OM Pattern Expression, starting with ^ (start of line) and ending with $ (end of line), for example:

^critical:cabbage.example.com:TEST$

Refresh. Loads the configured indicators from the OMi server.

Entered search string is used to search the indicators and highlight only the indicators containing the specified string.

To search for indicators with specific text strings in the name, type the string in the <Search …> field and click the button. The first matching indicator is selected in the list of rules. Click the and buttons to move to the previous and next matching indicator.

Hierarchy of configuration item types with associated health indicators (HIs), which are applicable for the event integration only, and event type indicators (ETIs). To insert an indicator with a state in a policy, drag and drop the indicator from the Indicators tab to the relevant field in the policy.

You can select one of the following options from the Type drop-down list:

• Use defaults. Select if you do not want to use instructions that accompany the event.

• Instruction Text. Select if you want to add the instruction text to accompany the event. Enter the text directly in the Instruction Text field.

  Note that you can type URLs in the text. The Event Browser automatically converts them into clickable hyperlinks. For example, you can add URLs of external websites, support sites, documentation repositories, troubleshooting information, and similar.

  To add a link, type any URL that begins with one of the following URI scheme names:

  • http://

  • https://

  • ftp://

  • ftps://

  • mailto:

  • telnet://

  • file://

  You can also just type the address of any website that begins with www..

• Instruction Text Interface. Select if you want to use the external instructions interface to generate instructions. Type the name of the external instructions interface in the Interface name field and enter Parameters that will be passed to the instruction text interface upon the instruction text retrieval (these parameters will get resolved by the agent before the message is sent to the server).

  In Parameters, you can enter a policy variable or a policy parameter configured for this policy template (note that you can also enter a parameter as a value in the Interface name field). Supported policy variables include (but are not limited to):

  • <$MSG_APPL>: Returns the name of the application associated with the event.

  • <$MSG_NODE>: Returns the IP address of the node on which the original event took place.

  • <$MSG_NODE_NAME>: Returns the hostname of the node on which the original event took place (this is the hostname that the agent resolves for the node).

  • <$MSG_ID>: Returns the unique identity number of the event.

  • <$MSG_SEV>: Returns the default value for the event severity.

  • <$MSG_TEXT>: Returns the full text of the event.

  A list of supported variables is available in the Policy Variables tab. For a complete list of HPOM variables and their descriptions, see the HPOM documentation.

Load From Local File System: Click to open the Select file to upload dialog box. Use the dialog box to upload a policy file. Policy files are data files and their filenames end in _data.

Save To Local File System: Click to download the policy to a policy data file on your system. You can then update the policy more comfortably in an editor of your choice. After completing your changes to the policy, upload the policy data file by clicking the Load From Local File System button.

The policy editor automatically asks you to download policies that exceed 1 MB in file size.

Check Syntax: Validates the syntax of the policy data. If the policy syntax is incorrect, the validation tool reports an error and points to the corresponding line and position of the unexpected token (for example the incorrect keyword).

Policy data in text form. The data uses the HPE Operations Agent policy syntax.

The policy editor highlights the policy syntax. If the policy exceeds 1,000 lines, syntax highlighting is automatically disabled. If the policy exceeds 1 MB in file size, the policy editor automatically asks you to download the policy to a file.

Synchronize Parameters: Check the policy template to make sure that variables in the format %%<variable_name>%% have corresponding parameters. Each variable should have one corresponding parameter.

Also checks for unused parameters, for which no corresponding variable exists in the policy template.

If any missing or unused parameters exist, the Synchronize Parameters dialog box opens. Read the summary, and then click Change or Ignore. If you click Change, the missing parameters are automatically created, and unused parameters are automatically deleted.

List of parameters configured for this policy template.

Parameters enable you to create policy templates that other users can easily customize. Each parameter corresponds to a variable in a policy template. A parameter gives consumers of a policy template the opportunity to specify the value of a variable, without having to modify the policy template themselves.

To insert a parameter, drag the parameter from the Policy Parameters tab to any text field within a condition or an event definition in a policy template. Alternatively, type the parameter in the text box using the format %%<variable_name>%% (for example %%CriticalThreshold%%).

An icon represents the type of parameter value, which can be one of the following:

• Enumeration (of several options)

• Number

• Password

• String

Returns the IP address of the node that sends the event. Sample output: 192.168.1.123.

Returns the IP address of the node that sends the event. Sample output: 192.168.1.123.

Returns the IP address of the node that sends the event. Sample output: 192.168.1.123.

Returns the IP address of the node that sends the event. Sample output: 192.168.1.123.

Name of the policy. You can use spaces in the name. The equal sign (=) is not allowed.

The name is set when the policy is created and cannot be changed in new versions of a policy.

The current version of the policy. If you modify an existing policy, you create a new version of the policy in the database with a unique version number. By default, the minor version number increases by one automatically after you modify the policy and save it. If you want to save the policy with a specific version number, you can select the major or minor version number that you want. It is not possible to replace an existing version of a policy. However, you can delete a specific version of a policy.

Text that describes what is new or modified in this version of the policy.

Last Modification

The name of the user active when the policy was saved.

Instrumentation selected for this policy. Instrumentation consists of one or more programs (for example scripts or executable files) that some policies may require to complete a configuration or monitoring task. Instrumentation is deployed to nodes that have HPE Operations Agent installed when the policy is deployed.

Instrumentations are unavailable if they are grayed out and their names end with "(Placeholder)". Upload them by using the Content Manager.

Types of operating system with which this policy is compatible.

To enable platform neutrality, you can create several platform specific variations of the same policy, and include them all in one aspect. OMi ensures that a policy is deployed only to host nodes that have the operating systems that you specify.

If you leave all the OS type check boxes clear, the policy can be deployed to host nodes with any operating system.

Select All. Selects all units of time.

The following options are available:

• Once. When Once is selected, the command runs on one specific day at the time you indicate.

  Note If the selected date or time occurs in the past, the command is not executed, and the Schedule tab shows a warning.

• Once per interval. When Once per interval is selected, the command runs once each time the interval that you indicate passes.

  Note Make sure the minimum value that you set is 15 seconds. If you set less than 15 seconds, the policy can be saved, but you will be notified about the wrong interval value by the scheduled policy editor.

• Advanced. When Advanced is selected, you can indicate specific days and times when the command should be run. You select specific days of the week, specific days of the month, and specific months. This allows you to specify odd schedules such as, "On Monday when it falls on the 2nd of the month." You can also indicate that the command should only be run during a specific year.

  Note If you select Advanced but then do not specify a schedule, the command by default runs every minute.

Load <perl / VB Script> from Client Opens a file selection dialog box for you to select the VB or Perl script to load into the policy.

Type of task:

• Command

• VB Script

• Perl Script

Complete path and extension of the command that you want to run (for example, %OvDataDir%\bin\instrumentation\cleanup.exe). The file that you specify should exist on the system.

By default, the command runs under the same account as the agent is running, which is Local System or root by default.

Code that defines the VB script. Instead of typing the script into the field, you can upload an existing script.

Code that defines the Perl script. Instead of typing the script into the field, you can upload an existing script.