Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- Policy Templates
- Configure ArcSight Logger Policies
- Configure ConfigFile Policies
- Configure BSM Connector High Availability Policies
- Configure Database Policies
- Configure Data Forwarding Policies
- Configure Flexible Management Policies
- Configure Logfile Entry Policies
- Configure Measurement Threshold Policies
- Configure Metric Streaming Configuration Policies
- Configure Node Info Policies
- Configure Open Message Interface Policies
- Configure Perl Script Policies
- Configure REST Web Service Listener Policies
- Configure Scheduled Task Policies
- Configure Service Auto-Discovery Policies
- Configure Service/Process Monitoring Policies
- Configure Structured Log File Policies
- Configure SNMP Interceptor Policies
- Configure Windows Event Log Policies
- Configure Windows Management Interface Policies
- Configure XML File Policies
- Import SiteScope templates
- Troubleshoot the deployment of SiteScope templates
- Develop Instrumentation
- Policy Objects for Scripts
- Pattern Matching in Policy Rules
- Review the policy syntax
Configure ConfigFile Policies
HPE Operations Smart Plug-ins (SPIs) provide predefined monitoring and management functionality for infrastructure, operating systems and applications. SPIs may include scripts or programs called instrumentation, which enable specific management and monitoring tasks. In some cases, it is necessary to configure the instrumentation after it is deployed. ConfigFile policies contain rules or instructions to configure SPI instrumentation.
Note
-
This release of OMi does not encrypt ConfigFile policies. It is therefore not recommended to insert passwords in the data part of these policies.
-
This release of OMi does not support ConfigFile templates.
-
Open the Policy Templates manager:
Administration > Monitoring > Policy Templates
Alternatively, click Policy Templates.
-
In the Policy Template Groups pane, expand Policy Management > Templates grouped by type > Configuration.
-
Click the ConfigFile folder, and then do one of the following:
-
To add a new policy template, in the Policy Templates pane, click the New Item button, and then click the Add New Policy Template... or the Add New Policy Template (Raw Mode) button.
The New ConfigFile Template Editor opens.
-
To edit an existing policy template, click the policy template in the Policy Templates pane, click the Edit Item button, and then click the Edit Policy Template or the Edit Policy Template (Raw Mode) button.
The Edit ConfigFile Template Editor opens.
-
Tip You can also access the policy editor from the Edit Aspect dialog box (see —Policy Templates).
Learn more
The first part of a ConfigFile policy (also known as ConfigFile variety) defines the path and file name of the configuration file that is associated with the policy. The ConfigFile definition contains the following attributes:
-
Application
-
Specifies the name of the managed application. This is usually the name of the SPI (for example
dbspi
). -
SubGroup
-
Additional grouping mechanism that helps the SPI to manage configuration files by grouping them according to custom categories. For example,
dbspi
has one subgroup for every supported database vendor. -
Filename
-
Specifies the file name of the configuration file (for example,
dbmon.cfg
).
The data part of a ConfigFile policy contains the rules or instructions that configure the instrumentation on the node and begins with the following keyword:
Data:
The following generic keywords can be used after Data
:
-
#$Installcommand=<command>
#$Deinstallcommand=<command>
<command>
contains the command to be run, including any required parameters. If necessary, use quotation marks to handle all platforms. $Installcommand runs when the policy is deployed or enabled. $Deinstallcommand runs when the policy is removed or disabled.-
#$Commandtype=<value>
-
<value>
specifies the type of command to be used:1—Executable (default)
If you do not specify the command type, the Config File policy assumes that the command is an executable.2—VBScript or shell script
You do not need to add a .vbs or .sh extension to the command. OMi automatically appends the appropriate extension so that a single policy can be run on both Windows and UNIX nodes.3—Perl script
When you deploy or enable the following example ConfigFile policy, the file acme.cfg is created, the last three lines are added to the file, and the file install.bat runs. When you remove or disable the policy, the file acme.cfg is removed and the file deinstall.bat runs.
Example:
Application=acme
SubGroup=acme_application
Filename=acme.cfg
Data:
#$Installcommand="C:\data\install.bat"
#$Deinstallcommand=C:\data\deinstall.bat"
AcmeSystemID = ACME
AcmeUserName = acme_root
AcmePassword = acme_password
Tasks
-
In the ConfigFile Policy Editor, in the Properties page, type a Name for the policy.
Optional. Provide a description of the policy (Description), select the instrumentation that will be deployed with the policy onto the host system where the agent is running (Instrumentation), and select the operating systems with which the policy is compatible (OS Types).
For more information, see Properties Page.
-
In the Policy Data page, type the ConfigFile definition and data using the HPE Operations Agent ConfigFile policy syntax. If you are creating a new policy, copy and paste template data from an existing policy template. Alternatively, click the button to load policy data from a policy template file on your computer.
For details, see ConfigFile Definition and ConfigFile Data.
You can also use policy parameters. For more details, see Policy Parameters Tab.
-
Click Save and Close to save the policy template and exit the wizard.
UI Reference
User interface elements are described below (listed alphabetically):
Description |
|
---|---|
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 |
|
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. |
|
ConfigFile policies do not support syntax checking. You can click Check Syntax but the check fails to perform. |
|
<policy data> |
Policy data in text form. 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. For details, see ConfigFile Definition and ConfigFile Data. |
Description |
|
---|---|
Name |
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. |
Description | Description of what the policy does. You might also add other notes (for example, data sources that are used). |
Template ID | GUID (globally unique identifier) assigned to the policy template when it is first created. |
Version ID | GUID (globally unique identifier) assigned to this version of the policy template when it is saved. Each version of a policy template has a unique ID. |
Version |
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. Note If you modify a policy template that is part of an HPE Operations Manager i Management Pack, increase the minor version number only. The next version of the Management Pack normally uses the next major version number. |
Change Log |
Text that describes what is new or modified in this version of the policy. |
Last Modification |
The date and time that the policy was saved.
The date and time displays using the current time zone of the computer on which the Web browser runs. The language setting of the Web browser determines the date and time format (for example, |
Last Modified by |
The name of the user active when the policy was saved. |
Instrumentation |
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. |
OS Types |
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. |
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to ovdoc-asm@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: