This appendix describes the SCOM mappings and various other configuration defaults and contains the following sections:
Sample Create Format for Microsoft SCOM Web Service represents the format that the Microsoft SCOM web service expects for creating new alerts in Microsoft SCOM.
Sample Update Format for Microsoft SCOM Web Service 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 SCOM 2012, the history information is passed in the logs/log/description
field.
For SCOM 2007 the history information is passed in the <string-field name="AlertHistory"></string-field>
field
<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>
<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>
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 |
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.
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:
<SCOM_INSTALL>
with the directory where the SCOM web services are installed.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.