A Customizing Microsoft SCOM

This appendix describes the SCOM mappings and various other configuration defaults and contains the following sections:

A.1 XML Format of Microsoft SCOM Alerts

Example A-1 represents the format that the Microsoft SCOM web service expects for creating new alerts in Microsoft SCOM. Example A-2 represents the format that the Microsoft SCOM web service expects for updating alerts in Microsoft SCOM.

Note:

Alert History information is now passed differently for SCOM 2012 than it was for SCOM 2007:

  • For 2012, the history information is passed in the logs/log/description field.

  • For SCOM 2007 the history information is passed in the following field:

    <string-field name="AlertHistory"></string-field>

Example A-1 Sample Create Format for Microsoft SCOM Web Service

<iwaveaf:create xmlns:iwaveaf="http://iwavesoftware.com/services/adapter-framework">
  <event>
    <summary></summary>
    <description></description>
    <severity></severity>
    <priority></priority>
    <logs>                <--------For SCOM 2012
      <log>
        <description></description>
      </log>
    </logs>
    <extended-fields>
      <string-field name="CustomField1"></string-field>
      ...
      <string-field name="CustomField10"></string-field>
    </extended-fields>
  </event>
</iwaveaf:create>

Example A-2 Sample Update Format for Microsoft SCOM Web Service

<iwaveaf:update xmlns:iwaveaf="http://iwavesoftware.com/services/adapter-framework">
  <event>
    <identifier></identifier>
    <status></status>
    <logs>                <--------For SCOM 2012
      <log>
        <description></description>
      </log>
    </logs>
    <extended-fields>
      <string-field name="AlertHistory"></string-field>        <--------For SCOM 2007
      <string-field name="CustomField1"></string-field>
      …
      <string-field name="CustomField10"></string-field>
    </extended-fields>
  </event>
</iwaveaf:update>

A.1.1 Mappings Between XML Format and Alert Field Names

Table A-1 identifies the mappings between the Microsoft SCOM alert field names and the XML format that the Microsoft SCOM web services uses when creating an alert in SCOM. Table A-2 identifies the mappings between the Microsoft SCOM alert field names and the XML format that the Microsoft SCOM web services uses when updating an alert in SCOM.

The XML document presented to the Microsoft SCOM web service must have the corresponding fields set. Fields denoted with an asterisk ( * ) are optional. This must be handled in the appropriate translation file identified in Table A-1.

Table A-1 Create Alert Attributes and XML Path Mappings

Microsoft SCOM Field Names XML Path Attribute Name Attribute Value

Name

/create/event/summary

    

Description

/create/event/description

    

Severity

/create/event/severity

    

Priority

/create/event/priority

    

Alert History

/create/event/logs/log/description

    

* Owner

/create/event/owner

    

* Custom Field 1

/create/event/extended-fields/string-field

name

CustomField1

* Custom Field 2

/create/event/extended-fields/string-field

name

CustomField2

* Custom Field 3

/create/event/extended-fields/string-field

name

CustomField3

* Custom Field 4

/create/event/extended-fields/string-field

name

CustomField4

* Custom Field 5

/create/event/extended-fields/string-field

name

CustomField5

* Custom Field 6

/create/event/extended-fields/string-field

name

CustomField6

* Custom Field 7

/create/event/extended-fields/string-field

name

CustomField7

* Custom Field 8

/create/event/extended-fields/string-field

name

CustomField8

* Custom Field 9

/create/event/extended-fields/string-field

name

CustomField9

* Custom Field 10

/create/event/extended-fields/string-field

name

CustomField10

* Alert Parameter 2

/create/event/extended-fields/string-field

name

AlertParameter2

* Alert Parameter 3

/create/event/extended-fields/string-field

name

AlertParameter3

* Alert Parameter 4

/create/event/extended-fields/string-field

name

AlertParameter4

* Alert Parameter 5

/create/event/extended-fields/string-field

name

AlertParameter5

* Alert Parameter 6

/create/event/extended-fields/string-field

name

AlertParameter6

* Alert Parameter 7

/create/event/extended-fields/string-field

name

AlertParameter7

* Alert Parameter 8

/create/event/extended-fields/string-field

name

AlertParameter8

* Alert Parameter 9

/create/event/extended-fields/string-field

name

AlertParameter9

* Alert Parameter 10

/create/event/extended-fields/string-field

name

AlertParameter10

Table A-2 Update Alert Attributes and XML Path Mappings

Microsoft SCOM Field Names XML Path Attribute Name Attribute Value

Id

/update/event/identifier

    

Resolution State

/update/event/status

    

* Ticket ID

/update/event/externalIncidentIdentifier

    

* Owner

/update/event/owner

    

* Custom Field 1

/update/event/extended-fields/string-field

name

CustomField1

* Custom Field 2

/update/event/extended-fields/string-field

name

CustomField2

* Custom Field 3

/update/event/extended-fields/string-field

name

CustomField3

* Custom Field 4

/update/event/extended-fields/string-field

name

CustomField4

* Custom Field 5

/update/event/extended-fields/string-field

name

CustomField5

* Custom Field 6

/update/event/extended-fields/string-field

name

CustomField6

* Custom Field 7

/update/event/extended-fields/string-field

name

CustomField7

* Custom Field 8

/update/event/extended-fields/string-field

name

CustomField8

* Custom Field 9

/update/event/extended-fields/string-field

name

CustomField9

* Custom Field 10

/update/event/extended-fields/string-field

name

CustomField10

* Alert History (2012)

/update/event/logs/log/description

    

* Alert History (2007)

/update/event/extended-fields/string-field

name

AlertHistory

A.1.2 Extended Fields

Extended fields pass information for fields that are not mapped to a specific field. An extended field is defined as a <string-field/> element that is a child of the extended-fields node. The name of the field is specified in the name attribute, and the value of the field is specified as the element value.

A.2 Changing Default Port Numbers

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

8080 is the default port number for HTTP communication, and 8443 is the default port for HTTPS communication. To change the port number, perform the steps in the appropriate subsection.

A.2.1 Changing the Web Service Port (8080)

The SCOM 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 at the system where the SCOM web services are installed. Replace <SCOM_INSTALL> with the directory where the SCOM web services are installed.

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

    <SCOMWS_INSTALL>/adapters/conf

  2. Make a backup copy of the framework.properties file, then open the file with a text editor.

  3. Replace all references to the old port number with the new port number, then save the file.

  4. Restart the web service as instructed in Running the Web Service on Unix and Running the Web Service on Windows.

Perform the following steps to change the URL the SCOM connector is using:

  1. From the Enterprise Manager console, click Setup.

  2. Select Extensibility in the pane.

  3. Select Management Connectors in the left pane.

  4. Click the name of the SCOM connector.

    The General tab of the Configure Management Connector page appears.

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

  6. Click OK to save your changes.

A.2.2 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 SCOM API Connection Parameters

When installing the SCOM Agent, you must configure the connection parameters used for accessing the SCOM API. The installation includes the SCOMAgentConfig utility you can use to change the Agent configuration parameters.

Perform the following steps to change the connection parameters:

  1. Open Windows Explorer on the system where the SCOM Agent is installed.

  2. Navigate to the bin directory in the SCOM Agent installation directory.

  3. Run the SCOMAgentConfig.exe utility. This action starts the SCOM Agent Configuration Tool.

  4. Click Load. This action opens a directory navigation window.

  5. Navigate to the SCOM Agent installation directory and open the SCOMAgent.cfg file.

  6. Click the Management Groups tab and click Edit. This action displays the Edit Management Group window.

  7. Change the desired information in the following fields listed, then click Update:

    Name
Server
Domain
Username
Password

  8. Click Save to save the changes to the configuration file.

  9. Click Exit to exit the utility.

  10. Stop and restart the SCOM Agent in IIS.