この章では、イベント・コネクタを作成し、Enterprise Managerと統合するために必要な情報を提供しています。
この章は次の項で構成されています。
Enterprise Manager Cloud Control 12cには、管理コネクタ・フレームワーク(コネクタ・フレームワークとも呼ばれる)が導入され、開発者はメタデータ(XMLおよびXSL)に基づいてイベント・コネクタを作成できます。イベント・コネクタにより、Enterprise Managerは、外部システムに生成されたイベントを送信できます。
イベント・コネクタの作成には、次のメタデータ・カテゴリが必要です。
コネクタ記述子XML
コネクタの定義をXML形式で提供します。
リクエスト・テンプレートXMLまたはXSL
事前定義されたXMLテンプレートまたはXSLを使用して、EMイベントおよび外部システム属性の変換マッピングを提供します。
レスポンス・テンプレートXSL
レスポンスを外部システムからEMデータ・モデルに変換します。
注意: 現行リリースでは、アウトバウンド操作(外部システムへのイベントの送信)のみがサポートされます。インバウンド(Enterprise Managerへの外部イベントのインポート)のサポートは、将来のリリースで検討される可能性があります。 |
イベント・コネクタの作成は2ステップのプロセスで、デプロイメント記述子を作成し、データ管理用の適切なテンプレートを準備します。コネクタ記述子には、次の情報が含まれます。
Enterprise Managerで必要な基本構成パラメータ
サービス・メソッドの仕様
サービス・メソッドは、コネクタ・フレームワークが外部システムと通信する方法を定義するWebサービス・エンドポイントとメソッド名をバインドするのに使用されます。
テンプレート登録の仕様
テンプレートは、この要素に指定した情報に基づいて登録されます。コネクタ・デプロイメント記述子には、最大50個のテンプレート登録要素で構成されるオプションのリストを指定できます。
SOAPヘッダー認証の仕様(オプション)
注意: アップグレードの場合、すべての外部アラートはEnterprise Managerイベントとして12cに移行されるため、ターゲット・ページに表示されません。顧客は、ターゲット・ページに表示できるように、これらのイベントに対して手動でインシデントを作成する必要があります。12cのフレッシュ・インストールの場合、インバウンド操作はサポートされていないため、外部イベントは生成されず、ターゲット・ページには何も表示されません。 |
コネクタ記述子XMLファイルを定義して、コネクタ・メタデータおよびコネクタの構成プロパティ(Webサービスのエンドポイントおよび認証スキーマなど)を記述します。
コンストラクタ記述子を作成する際の重要な留意点は次のとおりです。
コネクタ記述子ファイル名は、connectorDeploy.xml
にする必要があります。
XMLファイルは、スキーマconnectorDeploy.xsd
に準拠する必要があります。
リファレンス実装は、付録C「MOMイベント・コネクタのサンプル」のサンプルconnectorDeploy.xml
を参照してください。次の表では、conenctorDeploy.xsd
の各セクションとその実行内容を説明します。
表2-1 コネクション記述子メタデータの詳細
メタデータ・セクション | 説明 |
---|---|
<Name>Microsoft Operations Manager Connector</Name> <Version>12.1.0.1.0</Version> <EMCompatibleVersion>12.1.0.1.0</EMCompatibleVersion> <Description>Microsoft Operations Manager Integration with Enterprise Manager</Description> <Category>EventConnector</Category> <ConfigVariable required="true"> <VariableName>SETUP_NAME</VariableName> <DisplayName>MOM Registered Connector Name</DisplayName> </ConfigVariable> <ConfigVariable required="true"> <VariableName>RESOLUTION_STATE</VariableName> <DisplayName>Resolution State</DisplayName> </ConfigVariable> |
コネクタ・タイプの名前要素値とバージョン要素値の組合せにより、EM内のコネクタ・インスタンスは一意に定義されるため、同一のものを定義する際には適切に配慮する必要があります。 EMCompatibleVersion要素は、<release specific value>と同等です。 たとえば、12Cリリースの場合は12.1.0.1.0です。 外部システム統合の要素カテゴリは、次の値のいずれかです。 EventConnector TicketingConnector この場合、値はEventConnectorになります。 ConnectivityTestVariable要素およびExternalURL要素は、イベント・コネクタに適用できません。 |
<Service> <Method>cleanup</Method> <WebServiceEndpoint> <![CDATA[http://[server]:1271/ConnectorServiceV2.asmx]]> </WebServiceEndpoint> <SOAPAction>http://www.microsoft.com/EnterpriseManagement/Mom/Connector/V2/Cleanup</SOAPAction> </Service> |
メソッドでは、EM固有のサービス名の1つが定義されます。 Webサービス・エンドポイントでは、外部システムURLが定義されます。 SoapActionでは、外部システムで呼び出す必要がある操作が定義されます。 詳細は、「サービス定義」を参照してください。 |
<TemplateRegistration> <FileName>setup_request.xml</FileName> <InternalName>setup</InternalName> <TemplateName>Setup</TemplateName> <TemplateType>OutboundXML</TemplateType> <Description>This is the request xml file for setup method</Description> </TemplateRegistration> |
テンプレート登録では、XMLまたはXSLテンプレートの定義が定義されます。 詳細は、「テンプレート定義」を参照してください。 |
<SOAPHeaderAuthentication> <Username required="true"> <VariableName>USERNAME</VariableName> <DisplayName>Username</DisplayName> </Username> <Password> <VariableName>PASSWORD</VariableName> <DisplayName> Password</DisplayName> </Password> <AuthVariable> <VariableName>AUTHENTICATION</VariableName> <DisplayName>Authentication</DisplayName> </AuthVariable> <AuthVariable> <VariableName>LOCALE</VariableName> <DisplayName>Locale</DisplayName> </AuthVariable> <AuthVariable> <VariableName>TIMEZONE</VariableName> <DisplayName>Timezone</DisplayName> </AuthVariable> <SOAPHeader> <![CDATA[ ]]> </SOAPHeader> </SOAPHeaderAuthentication> |
(オプション)このセクションでは、外部システムWebサービスの認証スキーマを記述できます。 EMの「管理コネクタの構成」ページの認証セクションは、このセクションに基づいて生成されます。 ユーザー名、パスワードおよび追加のテキスト・フィールドは、このセクションに基づいて移入されます。
|
次の表に、現行リリースでサポートされているイベント・コネクタ・サービス操作を示します。
表2-2 コネクタ・サービス操作
名前 | 説明 |
---|---|
setup(オプション) |
外部システムにコネクタを登録します。 |
initialize (オプション) |
設定後、外部システムでコネクタを初期化します。 |
uninitialize (オプション) |
外部イベント・システムでコネクタを初期化解除します。 |
cleanup (オプション) |
外部イベント・システムでコネクタを登録解除します。 |
createEvent |
新しいイベントを外部システムに転送します。 |
updateEvent |
イベントの更新を外部システムに転送します。 |
前述のサービスに関する重要なポイントは次のとおりです。
コネクタ記述子でのサービス名は、表2-2「コネクタ・サービス操作」で定義した名前と完全に一致する必要があります(大/小文字を区別)。
setupおよびinitializeは、定義されている場合、コネクタの構成時の順序でコールされます。
uninitializeおよびcleanupは、initializeおよびsetupと正反対のアクションです。
uninitializeは、initializeが定義されている場合に定義できます。cleanupは、setupが定義されている場合に定義できます。定義した場合、コネクタの削除時にuninitializeおよびcleanupの順序でサービスがコールされます。
createEventおよびupdateEventは、Enterprise Managerからイベント・ルールによって生成された外部システムにイベントを転送する場合にコールされます。
サービス設定の例を次に示します。
<Service> <Method>setup</Method> <WebServiceEndpoint>....</WebServiceEndpoint> <SOAPAction>.......</SOAPAction> </Service>
テンプレートには、リクエストの送信時およびレスポンスの受信時に変換されるデータが含まれます。テンプレートは、Enterprise Managerの特定のサービス操作についてXMLまたはXSLファイルとして定義できます。
テンプレートを定義するためのガイドラインは次のとおりです。
内部名は、メソッド名と同一である必要があります(大/小文字を区別)。
テンプレート・タイプは次のとおりです。
InboundXSL for response xsl, OutboundXSL for request xsl, and OutboundXML for request xml
テンプレート・ファイル名は重要ではありませんが、次の名前を使用することをお薦めします。
<methodName>_request.xml, <methodName>_request.xsl, and <methodName>_response.xsl.
次に例を示します。
<TemplateRegistration> <FileName>setup_request.xml</FileName> <InternalName>setup</InternalName> <TemplateName>Setup</TemplateName> <TemplateType>OutboundXML</TemplateType> <Description>This is the request xml file for setup method</Description> </TemplateRegistration>
テンプレート登録XMLまたはXSLのコーディングは、次の情報によって決まります。
定義された一連のスキーマ定義(XSD)。
ターゲット外部システムの属性。
次の表に、Enterprise Managerイベント・コネクタのスキーマ定義を示します。
表2-3 イベント・コネクタ・テンプレートXSD
名前 | 説明 |
---|---|
EMEvent.xsd |
コネクタ・フレームワークによって使用可能になるEMイベントを定義します。 |
ConnectorCommon.xsd |
SourceObjInfoTypeなど、その他すべてのxsdで使用されるすべてのデータ型を定義します。 |
EMEventResponse.xsd |
createEvent/updateEventメソッドのレスポンスを定義します。このレスポンスは、受信したイベント・マネージャ・イベントの外部サーバーからのものです。 |
initialize_response.xsd |
initializeメソッド用のレスポンス・スキーマです。 |
setupResponse.xsd |
setupメソッド用のレスポンス・スキーマです。 |
uninitialize_response.xsd |
uninitializeメソッド用のレスポンス・スキーマです。 |
リクエスト・テンプレートを定義する際の重要なポイントは次のとおりです。
setup、initialize、uninitializeおよびcleanupサービスには、リクエストXMLテンプレート・ファイルの定義が必要です。
テンプレート・リクエストXMLは、渡される情報がコネクタ変数要素としてすでに定義されている場合に使用されます。コネクタ変数は、次の情報を使用して定義できます。
登録時のコネクタ・デプロイメント記述子
これらのサービスのいずれかのレスポンス・メッセージ
createEventおよびupdateEventサービスには、XSLファイルの定義のみ必要です。
テンプレート・リクエストXSLは、Enterprise Manager内で生成されるイベント属性を使用してリクエストを生成する場合に使用されます。これらのリクエストには、Enterprise Manager内のイベント・オブジェクトとターゲット外部システムの属性とのマッピングが必要です。
テンプレート・リクエストXSLの定義は、リクエストXMLを定義している場合、オプションです。原則として、このシナリオは必要ありません。
EMEvent.xsdスキーマを使用すると、外部システムへのイベント送信時にマッピングで使用できるようにするEnterprise Managerのフィールドを決定できます。
レスポンス・テンプレートを定義する際の重要なポイントは次のとおりです。
レスポンス・テンプレート(XSL)は、表2-3「イベント・コネクタ・テンプレートXSD」に定義されているXSDに基づいて定義できます。
テンプレート・レスポンスXSLはオプションです。
レスポンス変換(XSL)が定義されていない場合、外部システムによって返されるレスポンスXML内のデータはいずれも保持されません。外部システム・レスポンス・データに関係していない操作の場合、これは理想的な実装です。
createEventおよびupdateEventサービスに対しては、EMEventResponse.xsdスキーマを使用して外部システムからのレスポンスをEnterprise Managerが認識できるレスポンスに変換する方法を決定できます。
変換後、Enterprise Managerでは<SuccessFlag>と、値に応じて次のいずれかの要素が必要とされます。
True
Enterprise Managerでは、外部システムのイベントのIDである<externalEventID>が必要とされます。これは、将来イベントを更新する際に使用されます。
False
Enterprise Managerでは、<ErrorMessage>が必要とされます。Enterprise Managerにより、イベントにexternalEventIDまたはErrorMessageの注釈が付けられます。
MOMイベント・コネクタのリファレンス実装は、次の表2-4「サンプル・テンプレート・リスト」のサンプル・テンプレート・ファイルを参照してください。
表2-4 サンプル・テンプレート・リスト
サービス名 | リクエストXSL | リクエストXML | レスポンスXSL |
---|---|---|---|
setup |
オプション |
setup_request.xml |
setup_response.xsl |
initialize |
オプション |
initialize_request.xml |
オプション |
uninitialize |
オプション |
uninitialize_request.xml |
オプション |
cleanup |
オプション |
cleanup_request.xml |
オプション |
createEvent |
createEvent_request.xsl |
該当なし |
createEvent_response.xsl |
updateEvent |
updateEvent_request.xsl |
該当なし |
updateEvent_response.xsl |
コネクタをデプロイするために、Enterprise Managerでは自己更新機能が使用されます。この機能はコンソールからアクセスできますが、Enterprise Manager環境にコネクタをインポートするための機能です。コネクタをデプロイするには、次の手順を実行します。
コネクタjarファイルを準備します。
XMLおよびXSLテンプレート・ファイルをすべて1つの.jarファイルとしてパッケージします。
<name>_connector.jar ---> connectorDeploy.xml --->template1.xml --->template2.xsl ….. ….. --->templateN.xsl
マニフェスト・ファイルを作成します。
次の表に、自己更新マニフェスト・ファイルのキー属性を示します。
表2-5 自己更新マニフェスト・ファイルの属性
名前 | 説明 |
---|---|
EntityType |
値はcore_connectorです。 |
EntityTypeVersion |
現行リリース・バージョンです。値は12.1.0.1.0です。 |
Attribute @Name=connector_type |
コネクタ・タイプ名です。 |
Attribute @Name=connector_category |
カテゴリ・タイプは、TicketingConnectorまたはEventConnectorです。 |
ArchiveList |
この要素には、コネクタ設定の一部であるアーカイブのリストが含まれます。一般に、コネクタjarは1つ存在しますが、特殊な実装の場合は追加のjar (アダプタまたはエージェント)が存在することがあります。このような場合、コネクタ固有のjarは定義リストの最初のjarである必要があります。これは必須要件です。 |
次の例に、connector_manifest.xmlファイルのコードを示します。
<EntityInstanceList xmlns="http://www.oracle.com/EnterpriseGridControl/SelfUpdateManifest"> <EntityInstance xmlns="http://www.oracle.com/EnterpriseGridControl/SelfUpdateManifest" EntityTypeVersion="11.2.0.1.0" EntityType="core_connector" Maturity="PRODUCTION" Vendor="Oracle" PluginID="oracle.sysman.core"> <Description> <![CDATA[ BMC Remedy Service Desk Connector - 12.1.0.2.0 ]]> </Description> <AttributeList> <Version>12.1.0.2.0</Version> <Attribute Name="connector_type" Value="Sample SCOM Connector" Label="Sample SCOM Connector" /> <Attribute Name="connector_category" Value="EventConnector" Label="Event Connector" /> </AttributeList> <Readme> <![CDATA[ Oracle Management Connector for SCOM integrates Oracle Enterprise Manager Cloud Control's proactive alert detect ion and resolution features with BMC's Remedy 7.0 Service Desk capabilities to provide a seamless workflow for incident mana gement and resolution. Change Logs: 12.1.0.2.0 - Miscellaneous bug fixes - Performance enhancements ]]> </Readme> <DependsOn /> <ArchiveList> <Archive Filename="scomconnector.jar" IsMDS="false" /> <Archive Filename="SCOM_webservices_adapter.jar" IsMDS="false" /> </ArchiveList> <CustomData> <![CDATA[ ]]> </CustomData> </EntityInstance> </EntityInstanceList>
属性の詳細リストは、次の場所にある自己更新スキーマ定義を参照してください。
$ORACLE_HOME/sysman/emSDK/core/selfupdate/model/SelfUpdateManifest.xsd
emedkツールを構成します。
emedkツールは、Enterprise Managerユーザー・インタフェースから指示に従って構成できます。パスは、「設定」 > 「拡張性」 > 「開発キット」です。
自己更新アーカイブを準備します。
これにはコネクタjarファイルおよびコネクタ用のマニフェスト・ファイルが必要です。自己更新を準備するには、次のユーティリティをコールして自己更新アーカイブ・ファイルを作成します。
edkUtil prepare_update -manifest "manifest xml" -archivedir "archives directory" -out "output file or directory" [-typexml "update type xml"]
表2-6 自己更新ユーティリティのオプション
オプション | 説明 |
---|---|
-manifest |
更新が記述されている自己更新マニフェスト・ファイル。 |
-archivedir |
マニフェスト・ファイルに指定されているアーカイブ・ファイルがあるディレクトリ。 |
-out |
自己更新アーカイブのディレクトリまたはファイル名。ディレクトリが指定されている場合、ファイル名は自動生成されます。 |
-typexml |
更新タイプxmlへのオプション・パス。 |
次の例では、マニフェスト・ファイル/u01/connector/connector_manifest.xml
に基づいて自己更新アーカイブを/u01/sar
ディレクトリに作成しています。connector_manifest.xmlで参照されるアーカイブは、ディレクトリ/u01/connector/archives
から取得されます。
edkUtil prepare_update -manifest /u01/connector/connector_manifest.xml -archivedir /u01/connector/archives -out /u01/sar/sample_connector.zip
次のemcliコマンドのいずれかをコールして、Enterprise Managerにコネクタ・アーカイブをインポートします。
emcli import_update -file=\ file\ -omslocal
または
emcli import_update -file=\ file\ -host=\ hostname\ [-credential_set_name=\ setname\ ] | -credential_name=\ name\ -credential_owner=\ owner\
これらのコマンドにより、自己更新アーカイブ・ファイルがEnterprise Managerにインポートされます。正常にインポートされると、更新が次のアクションを促す「ダウンロード」ステータスで自己更新ホームに表示されます。表2-7に、コネクタ・アーカイブ・コマンドのオプションを示します。
表2-7 コネクタ・アーカイブ・コマンドのオプション
オプション | 説明 |
---|---|
-file |
更新アーカイブ・ファイルの完全なパス名 |
-omslocal |
ファイルがOMSからアクセス可能であることを示すフラグ |
-host |
ファイルが使用可能なホスト・ターゲットのターゲット名 |
-credential_set_name |
ホスト・ターゲットのリポジトリに格納されている優先資格証明のセット名。次のいずれかです。
|
-credential_name |
リポジトリに格納されている名前付き資格証明の名前。このオプションは、-credential_ownerオプションとともに指定する必要があります。 |
-credential_owner |
リポジトリに格納されている名前付き資格証明の所有者。このオプションは、-credential_nameオプションとともに指定する必要があります。 |
emcli
コマンドの使用例をいくつか次に示します。
例1
ファイルupdate1.zip
をインポートします。ファイルは、OMSホストに存在している必要があります。複数のOMSが設定されている場合、リクエストはどのOMSでも処理できるため、ファイルはリクエストを処理するOMSからアクセスできる必要があります。通常、これは、すべてのOMSからアクセス可能な共有の場所にファイルを保存しておく必要があることを意味します。
emcli import_update -file=\ /u01/common/update1.zip\ -omslocal
例2
host1.example.com
ホストに存在するファイルupdate1.zip
をインポートします。ホストは、Enterprise Managerの管理対象ホスト・ターゲットであり、このホストのエージェントは起動し実行中である必要があります。リモート・ファイルの取得には、ホストhost1.example.com
の非特権優先資格証明が使用されます。
emcli import_update -file=\ /u01/common/update1.zip\ -host=\ host1.example.com\ -credential_set_name=\ HostCredsNormal\
例3
host1.example.com
ホストに存在するファイルupdate1.zip
をインポートします。ホストは、Enterprise Managerの管理対象ホスト・ターゲットであり、このホストのエージェントは起動し実行中である必要があります。リモート・ファイルの取得には、ユーザー\ admin1\
が所有する名前付き資格証明\ host1_creds\
が使用されます。
emcli import_update -file=\ /u01/common/update1.zip\ -host=\ host1.example.com\ -credential_name=\ host1_creds\ -credential_owner=\ admin1\
「自己更新」ホームページに移動します。
コネクタは「ダウンロード」と表示されます。
コネクタの行を選択し、「適用」をクリックしてコネクタをデプロイします。