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	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Operations Manager i10.62

Administer > Monitoring > Policy Templates > Configure Service Auto-Discovery Policies

Configure Service Auto-Discovery Policies

Service auto-discovery policies enable you to run scripts (or programs) that discover configuration items in your managed environment. The output of a discovery script is used to automatically populate the OMi Run-time Service Model (RTSM). HPE Operations Smart Plug-ins (SPIs) supply many service auto-discovery policies. You can also create your own custom service auto-discovery policies.

To access

You can create or edit a Perl Script policy using the Perl Script policy editor, which you can open in the following ways.

You can create or edit a Service Auto-Discovery policy using the Discovery policy editor, which you can open in the following ways.

To open the editor from the Edit Aspect dialog box:
1. Open the Management Templates & Aspects manager:
  
  Administration > Monitoring > Management Templates & Aspects
  
  Alternatively, click Management Templates & Aspects.
2. In the Configuration Folders pane, expand the configuration folders.
3. In the Management Templates & Aspects pane, click an aspect, and then click the Edit Item button.
  
  The Edit Aspect dialog box opens.
4. Click the Policy Templates tab, and then do one of the following:
  - To add a new policy template:
    1. Click the Add Policy Templates From List button. The Add Policy Templates From List dialog box opens.
    2. Click the New Item button, and then click the Add New Policy Template or the Add New Policy Template (Raw Mode) button. The Select Type for New Policy Template dialog box opens.
    3. Select the appropriate type <DataType> from Perl Script, and then click OK.
    4. Select the type Service Auto-Discovery, and then click OK.
  - To edit an existing policy template, click the policy template in the list, click the button, and then click the Edit Policy Template or the Edit Policy Template (Raw Mode) button.
  The Operations Connector High Availability policy editor opens.
  
  The Perl Script policy editor opens.
  
  The Discovery policy editor opens.
To open the editor from the Policy Templates manager:
1. Open the Policy Templates manager:
  
  Administration > Monitoring > Policy Templates
  
  Alternatively, click Policy Templates.
2. In the Policy Template Groups pane, expand Policy Management > Templates grouped by type.
3. Depending on the type of data collected by the particular policy, expand Configuration, Events, Generic, Metrics, or Topology. Each policy type can be used only for a subset of the available data types.
4. Click the <DataType> from Perl Script item in the appropriate folder, and then do one of the following:
  - To add a new policy template, in the Policy Templates pane, click the button, and then click the Add New Policy Template or the Add New Policy Template (Raw Mode) button.
    
    The New <DataType> from Perl Script policy editor opens.
  - To edit an existing policy template, click the policy template in the Policy Templates pane, click the button, and then click the Edit Policy Template or the Edit Policy Template (Raw Mode) button.
    
    The Edit <DataType> from Perl Script policy editor opens.
5. Click the Service Auto-Discovery item, and then do one of the following:
  - To add a new policy template, in the Policy Templates pane, click the button, and then click the Add New Policy Template or the Add New Policy Template (Raw Mode) button.
    
    The New Node Info policy editor opens.
  - To edit an existing policy template, click the policy template in the Policy Templates pane, click the button, and then click the Edit Policy Template or the Edit Policy Template (Raw Mode) button.
    
    The Edit Node Info policy editor opens.

Learn More

Configuration Item XML Schema Definition (XSD)

Your discovery script must output XML that conforms to the following schema:

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
   <xs:element name="Service">
      <xs:complexType>
         <xs:choice maxOccurs="unbounded">
            <xs:element ref="NewInstance" />
            <xs:element ref="DeleteInstance" />
            <xs:element ref="NewRelationship" />
            <xs:element ref="DeleteRelationship" />
         </xs:choice>
      </xs:complexType>
      <xs:key name="InstanceKey">
         <xs:selector xpath="NewInstance|DeleteInstance">
         </xs:selector>
         <xs:field xpath="Key"></xs:field>
      </xs:key>
      <xs:keyref refer="InstanceKey" name="InstanceKeyRef">
         <xs:selector xpath="NewInstance|DeleteInstance">
         </xs:selector>
         <xs:field xpath="@ref"></xs:field>
      </xs:keyref>
      <xs:keyref refer="InstanceKey" name="InstanceRef">
         <xs:selector xpath="NewRelationship/*/Instance|DeleteRelationship/*/Instance">
         </xs:selector>
         <xs:field xpath="@ref"></xs:field>
      </xs:keyref>
   </xs:element>
   <xs:element name="NewInstance" type="InstanceType" />
   <xs:element name="DeleteInstance" type="InstanceType" />
   <xs:complexType name="InstanceType">
      <xs:sequence>
         <xs:element ref="Std" />
         <xs:element ref="Virtual" minOccurs="0" />
         <xs:element ref="Key" />
         <xs:element ref="Attributes" />
      </xs:sequence>
      <xs:attribute name="ref" type="xs:string" use="required" />
   </xs:complexType>
   <xs:element name="NewRelationship" type="RelationType" />
   <xs:element name="DeleteRelationship" type="RelationType" />
   <xs:complexType name="RelationType">
      <xs:sequence>
         <xs:element ref="Parent" />
         <xs:element ref="GenericRelations" minOccurs="0" />
      </xs:sequence>
   </xs:complexType>
   <xs:element name="Std">
      <xs:simpleType>
         <xs:restriction base="xs:string">
            <xs:enumeration value="DiscoveredElement" />
         </xs:restriction>
      </xs:simpleType>
   </xs:element>
   <xs:element name="Virtual">
      <xs:complexType />
   </xs:element>
   <xs:element name="Key" type="xs:string" />
   <xs:element name="Attributes">
      <xs:complexType>
         <xs:sequence>
            <xs:element ref="Attribute" maxOccurs="unbounded" />
         </xs:sequence>
      </xs:complexType>
   </xs:element>
   <xs:element name="Attribute">
      <xs:complexType>
         <xs:attribute name="value" type="xs:string" use="required" />
         <xs:attribute name="name" type="xs:string" use="required" />
      </xs:complexType>
   </xs:element>
   <xs:element name="Parent">
      <xs:complexType>
         <xs:sequence>
            <xs:element ref="Instance" />
         </xs:sequence>
      </xs:complexType>
   </xs:element>
   <xs:element name="GenericRelations" type="RelationsList" />
   <xs:complexType name="RelationsList">
      <xs:sequence>
         <xs:element name="Relations" maxOccurs="unbounded">
            <xs:complexType>
               <xs:sequence>
                  <xs:element ref="Instance" maxOccurs="unbounded" />
               </xs:sequence>
		<xs:attribute name="type" type="xs:string" use="required" />
            </xs:complexType>
         </xs:element>
      </xs:sequence>
   </xs:complexType>
   <xs:element name="Instance">
      <xs:complexType>
         <xs:attribute name="ref" type="xs:string" use="required" />
      </xs:complexType>
   </xs:element>
</xs:schema>

Configuration Item XML Element Description

The following table describes the elements that the XML document can contain.

Element	Description
NewInstance	Represents a discovered CI. You must add a `ref` attribute, which must match the unique CI ID that you specify in the Key element. You can then use this reference in Instance elements in the current XML document if you want to create or delete relationships.
DeleteInstance	Represents a CI that you want to delete immediately. The agent automatically deletes previously discovered CIs from the agent repository if your discovery script runs five times (by default) without including the CI as a NewInstance in the XML document. Note You can control how often the discovery script must run before a missing CI is automatically deleted by changing the agent parameter `INSTANCE_DELETION_THRESHOLD` in the `agtrep` namespace. However, if you specify this element, the agent deletes the CI immediately and publishes the change to the RTSM (Run-time Service Model).
NewRelationship	Defines a new relationship between CIs. This element must contain exactly one Parent element and can contain one or more GenericRelations elements.
DeleteRelationship	Defines relationships that you want to delete. This element must contain exactly one Parent element and can contain one or more GenericRelations elements.
Std	Must contain the string `DiscoveredElement`.
Virtual	Include this element if the CI is virtual. A virtual CI is abstract and does not exist on any node CI. Omit this element if the CI is hosted on a node CI.
Key	Contains the full CI ID for this CI, which must be unique. You must include this element in all NewInstance and DeleteInstance elements. You must not specify a NewInstance and DeleteInstance with the same key in the same XML document.
Attributes	Contains Attribute elements.
Attribute	Each Attribute element has the attributes `name` and `value`. You can also specify a datatype. Attributes with the following names have a special meaning: `hpom_citype` specifies the CI type as stored in the RTSM (for example, `nt`). Attribute names with the prefix `ucmdb_` map directly to CI attributes (for example, `ucmdb_primary_dns_name` maps to the CI attribute `Primary DNS Name`).
Parent	Contains an Instance element, which defines the CI that is the parent of this relationship. The parent instance that you specify must exist in the RTSM and in the agent repository on the node. Therefore, you may need to include a NewInstance element to add the parent to the agent repository, even if the parent already exists in the RTSM.
Instance	Has a `ref` attribute that refers to a NewInstance element in the current XML document.
GenericRelations	Contains one or more Relations elements.
Relations	Has a `type` attribute that refers to the type of relation as stored in the RTSM (for example, `usage`). Contains one or more Instance elements, which refer to the CIs that are related to the specified Parent element. For complex topologies which require a sync package, add the prefix `omrel_`. For example, if the type is `membership` when no sync package is used, it becomes `omrel_membership` with sync packages.

Tasks

How to Configure the Schedule of a Service Auto-Discovery Policy

You can configure the schedule of a service auto-discovery policy by adjusting the XML settings. Modifiable units are minutes, hours, days of the week, days of the month, and months.

In general, the following settings are available:

 <?xml version="1.0" encoding="UTF-16"?>
	<Schedule>
		<Options>
			<Task>EveryHour,Daily,Weekly,Monthly,Once</Task>
			<Timesel>Exactly,Reoccur</Timesel>		
		</Options>
		<Time>
			<Minute>00,01,02,03,04,05,06,07,08,09,10,11,12,13,14,15,16,17,18,19,20,
			21,22,23,24,25,26,27,28,29,30,31,32,33,34,35,36,37,38,39,40,
			41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59</Minute>
			<Hour>0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23</Hour>
			<DofW>0,1,2,3,4,5,6</DofW>
			<DofM>1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,
			21,22,23,24,25,26,27,28,29,30,31</DofM>
			<Month>1,2,3,4,5,6,7,8,9,10,11,12</Month>
		</Time>	
	</Schedule>

By using any of the following schedule options, the policies can be executed every hour, daily, weekly, monthly, or on a specific date.

Note You always need to specify the minutes and hours. An exception is the EveryHour option, which only requires minutes.

Option	Example
Every hour	The policy is executed every hour at minute 40. <Schedule> <Options> <Task>EveryHour</Task> </Options> <Time> <Minute>40</Minute> </Time> </Schedule>
Daily (specific time)	The policy is executed every day at 5 A.M. <Schedule> <Options> <Task>Daily</Task> <Timesel>Exactly</Timesel> </Options> <Time> <Minute>00</Minute> <Hour>5</Hour> </Time> </Schedule>
Daily (multiple times)	The policy is executed twice a day at 3:10 and 12:10 A.M. <Schedule> <Options> <Task>Daily</Task> <Timesel>Reoccur</Timesel> </Options> <Time> <Minute>10</Minute> <Hour>3,12</Hour> </Time> </Schedule>
Weekly	The policy is executed every week on Sunday at 6:15 P.M. <Schedule> <Options> <Task>Weekly</Task> <Timesel>Exactly</Timesel> </Options> <Time> <Minute>15</Minute> <Hour>18</Hour> <DofW>0</DofW> </Time> </Schedule>
Monthly	The policy is executed on the first day of each month at 8 and 11 P.M. <Schedule> <Options> <Task>Monthly</Task> <Timesel>Reoccur</Timesel> </Options> <Time> <Minute>00</Minute> <Hour>20,23</Hour> <DofM>1</DofM> </Time> </Schedule>
Specific Date	The policy is executed once on December 4, 2015, at 10 P.M. <Schedule> <Options> <Task>Once</Task> <Timesel>Exactly</Timesel> </Options> <Time> <Minute>00</Minute> <Hour>22</Hour> <DofM>4</DofM> <Month>12</Month> <Year>2015</Year> </Time> </Schedule> Note For the Specific Date option, a year needs to be specified in the YYYY-format.

UI Reference

User interface elements are described below (listed alphabetically):

Policy Data Page

UI Element	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 `_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.
	Service Auto-Discovery 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 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. For details, see Service Auto-Discovery Policy Syntax.

Policy Parameters Tab

UI Element	Description
	Create Parameter: Open the Create Parameter dialog box.
	Edit Parameter: Open the Edit Parameter dialog box.
	Delete Parameter: Delete the selected parameter from the list.
	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.
<Parameters>	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

Properties Page

UI Element	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, `09/14/2010 8:16:38 AM` for English (United States)). If the Web browser and the computer on which the server run have different language settings, the language setting of the Web browser takes precedence. However, English is the default language if the Web browser is configured to use a language that is not available on the server.
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.

Send Help Center feedback