A Customizing Microsoft HP Operations Manager

This appendix describes the HP OMU mappings and various other configuration defaults in the following sections:

A.1 XML Format of HP OMU Messages

represents the format that the HP OMU Web service expects for creating new messages in HP OMU. The format for update requests is the same, except that the root node would be update instead of create.

Example A-1 Sample Create Format for HP OMU Web Service

<iwaveaf:create xmlns:iwaveaf="http://iwavesoftware.com/services/
   adapter-framework">
      <event>
 
        <summary></summary>
 
        <urgency></urgency>
 
        <resolvedBy></resolvedBy>
 
        <identifier></identifier>
 
        <group>
          <name></name>
        </group>
 
        <object>
          <displayName></displayName>
        </object>
 
        <source>
          <computerName></computerName>
        </source>
 
        <extended-fields>
          <!-- OMU Application -->
          <string-field name="application">
            <xsl:value-of select="a:TargetType"/>
          </string-field>
          <!-- Do not add CMA data -->
          <string-field name="ovo_ts_field">NONE</string-field>
          <!-- Own the event after it is created -->
          <string-field name="own">true</string-field>
        </extended-fields>

A.1.1 Mappings Between XML Format and Message Field Names

Table A-1 identifies the mappings between the HP Operations Manager message field names and the XML format that the HP Operations Manager Web services uses. To set the HP Operations Manager message attributes, the XML document presented to the HP Operations Manager Web service must have the corresponding fields set. This must be handled in the appropriate translation file identified in Table 5-1.

Table A-1 Message Attributes and XML Path Mappings

HP Operations Manager Message Attributes XML Path

Message No.

/create/event/type

Message Text

/create/event/summary

Message Type

/create/event/type

Severity

/create/event/urgency

No. of Duplicates

/create/event/repeatCount

Owned By

/create/event/owner

Time Created

/create/event/createDate

Time Acknowledged

/create/event/resolvedDate

Acknowledged By

/create/event/resolvedBy

Message Group

/create/event/group/name

Object

/create/event/object/displayName

Source

/create/event/source/name

Application

/create/event/source/name

Node

See "Extended Fields" below.

CMA Fields

See "Extended Fields" below.

A.1.2 Extended Fields

An extended field is defined as a <string-field/> element that is a child of the extended-fields node. The name of the extended field is specified in the name attribute, and the value of this field is specified as the element value.

Some reserved extended field names are handled differently. The reserved field names are listed below along with a description of how they are handled.

  • application — Reserved for the HP Operations Manager application attribute. The specified value for this field is used to set the application field when creating or updating an HP Operations Manager message.

  • disown — Changes the behavior of the HP Operations Manager Agent. By default, the HP Operations Manager account used to create the message is left as the owner. By setting this field to true, the message is disowned after it is created.

  • ovo_ts_field — Prevents transaction loopback, and should always be set to NONE.

Any other extended field name you specify adds a Custom Message Attribute (CMA) field to the message. You specify the name of the CMA field for the Name attribute, and you specify the value in the element.

Note:

Adding CMA fields causes overhead. Attempting to add a large number of CMA fields can affect performance somewhat.

A.2 Changing Default Port Numbers

In most cases, you can use the default port numbers that the HP OMU Web service uses. However, if there are any conflicts with existing applications, you need to change the port numbers.

The following sections provide procedures on how to change these default port numbers.

A.2.1 Changing the Agent Listener Port (9007)

9007 is the default port number used for communication between the Oracle OMU Agent and the OMU Web service. To change this port number, perform the following steps at the HP Operations Manager server system.

Replace <OMUA_INSTALL> with the directory where the Oracle OMU Agent is installed.

  1. Open a command prompt window and change the working directory to:

    <OMUA_INSTALL>/ovo-agent/scripts

  2. Enter the following command to stop the Oracle OMU Agent. You will be prompted for the credentials to stop the Agent.

    ./stop.sh

    Note:

    You must specify the user name and password for the account that is authorized to stop the Oracle OMU Agent. See Section 2.4, "Installing and Running the Oracle Agent for HP Operations Manager" for information about the account that is authorized to stop the Oracle OMU Agent.

  3. Make a back-up copy of the following file:

    <OMUA_INSTALL>/ovo-agent/conf/ovooper.txt

  4. Open the file above in a text editor.

  5. Search for the line containing the ListenPort= string.

  6. Change 9007 to the new port number.

  7. Save the file and exit.

  8. Enter the following command to start the HP Operations Manager Agent:

    ./start.sh

    The Oracle OMU Agent picks up the configuration changes and uses the new port number.

Perform the following steps at the system where the OMU Web services are installed. Replace <OMUWS_INSTALL> with the directory where the OMU Web service is installed.

  1. Open a command prompt window and change the working directory to:

    <OMUWS_INSTALL>/adapters/conf

  2. Make a back-up copy of the framework.properties file.

  3. Open the framework.properties file in a text editor.

  4. Search for the line containing the hpovou.xmlagent property. Change the port number from 9007 to the new port number.

  5. Save the file and exit.

  6. Restart the OMU Web service as instructed in Section 2.5.1.3, "Running the Web Service on Unix" and Section 2.5.1.4, "Testing the Web Service on Unix".

A.2.2 Changing the Agent Shutdown Port (9008)

The OMU Agent has two components that you must shut down whenever the Agent is stopped. The default port numbers these components use are 9008 and 9009. To change these port numbers, perform the following steps at the HP Operations Manager server system.

  1. Open a command prompt window and change the working directory to:

    <OMUA_INSTALL>/ovo-agent/scripts

    Replace <OMUA_INSTALL> with the directory where the Oracle OMU Agent is installed.

  2. Enter the following command to stop the Oracle OMU Agent. You will be prompted for the credentials to stop the Oracle OMU Agent.

    ./stop.sh

    You must specify the user name and password for the account that is authorized to stop the Oracle OMU Agent. See Section 2.4, "Installing and Running the Oracle Agent for HP Operations Manager" for information about the account that is authorized to stop the Agent.

  3. Make a back-up copy of the ovooper.txt file, then open the file in a text editor.

  4. Search for the line containing the ShutdownPort= string.

  5. Change the default port number from 9008 to the new port number.

  6. Save the file and exit.

  7. Enter the following command to start the HP Operations Manager Agent:

    ./start.sh

    The Oracle OMU Agent picks up the configuration changes and uses the new port number.

  8. Change the working directory to the scripts directory by entering the following command:

    cd ../scripts

  9. Make a back-up copy of the stop.sh script file, then open the file in a text editor.

  10. Change the SEND_SHUTDOWN_PORT and RCV_SHUTDOWN_PORT variables from 9008 to the new port number.

  11. Save the file and exit.

A.2.3 Changing the Web Service Port (8080)

The OMU Web service uses port 8080 as the default port for communication when the Web service is configured at installation to use HTTP (no SSL). To change the port number to a different value, perform the following steps on the system where the Oracle OMU Agent is installed.

Perform the following steps at the system where the HP OMU Web services are installed. Replace <OMUWS_INSTALL> with the directory where the HP OMU Web services are installed.

  1. From the Setup menu of the Enterprise Manager console, select Extensibility, then Management Connectors.

  2. Click on the name of the OMU Connector.

    The General tab of the Configure Management Connector page appears.

  3. Change the URLs listed in the Web Service End Points section to use the new port number.

  4. Click OK to save your changes.

A.2.4 Changing the Web Service Port (8443)

Contact Oracle support for assistance in switching the default SSL port 8443 to a different port.

A.3 Changing Web Service Credentials

Occasionally, problems occur when accessing the OMU Web service, because the credentials provided are incorrect. Whenever this happens, you receive an HTTP 403 error from the Web service. You first want to check the specified credentials and verify that you entered the correct information. If the credentials you have specified appear to be correct, but you still receive the 403 error, the best option is to reset the Web service credentials.

To reset the OMU Web service credentials:

  1. Open a command prompt window and change the working directory to the OMU web service conf directory using the following command:

    <OMUWS_INSTALL>/adapters/conf

    Replace <OMUWS_INSTALL> with the directory where the HP OMU web services are installed.

  2. Enter the following command to change the user name and password for accessing the OMU Web service:

    ../bin/propertiesEditor.sh -e 
framework.username="<username>" -h 
framework.password="<password>" framework.properties

    ... where <username> is the user name to specify for the Web service, and <password> is the password.

    The propertiesEditor.sh script is specifically for the UNIX platform. The equivalent script for Windows platforms is propertiesEditor.bat.

  3. Stop and then start the OMU Web service as instructed in Section 2.5.1.3, "Running the Web Service on Unix" and Section 2.5.1.4, "Testing the Web Service on Unix".