Cisco Prime Performance Manager 1.4 統合開発者ガイド

偏向のない言語

この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。

翻訳について

このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。

マニュアルのコンテンツ
このマニュアル内で検索
ご利用いただける言語
Download Options

Book Title

Cisco Prime Performance Manager 1.4 統合開発者ガイド

Chapter Title

Prime Performance Manager イベント API

検索結果

Updated:
2017年5月29日

章のタイトル： Prime Performance Manager イベント API

Prime Performance Manager イベント API

Prime Performance Manager では、Simple Object Access Protocol（SOAP）OSS 要求を受け取って SOAP 応答およびトラップに応えるリモート プロシージャ コール（RPC）イベント API を提供します。また Prime Performance Manager はトラップを介して OSS に非送信請求メッセージを送信します。トラップを介してノースバウンド OSS に新しいイベントを非同期的に送信するように Prime Performance Manager を設定できます。

さらに、トラップを使用して外部のアプリケーションから Prime Performance Manager に相互起動できます。

次のトピックでは、Prime Performance Manager イベント API について説明します。

• 「イベントおよびアラームの概要」

• 「Prime Performance Manager のイベント API の操作」

• 「イベント API WSDL および XSD の定義」

• 「イベントの API エラー」

• 「Prime Performance Manager の相互起動」

イベントおよびアラームの概要

イベントは特定の時刻での単一事象です。各イベントにはイベント ID があります。アラームは、一定期間にわたって発生する一連のイベントです。アラームにはアラームを定義するイベントの期間中存在する単一のアラーム ID があります。たとえば、シャーシの温度が特定のしきい値を超えると、Prime Performance Manager はマイナー アラームを報告します。温度が再び上昇すると、Prime Performance Manager はアラームをメジャー アラームに引き上げます。さらに温度が上昇すると、Prime Performance Manager はアラームを重大なアラームに引き上げます。ただし、この一連のイベントのアラーム ID は同じままです。

Prime Performance Manager は、例で説明したような一連の状態遷移での条件の解除を考慮しません。たとえば、ITP リンクでは、1 時間の内に状態を標準から重大、標準、警告と変更する場合があります。イベントは、標準から重大、重大から標準、および標準から警告の各トランジションに対して作成されます。この 3 つのイベントが ITP リンク状態アラームの一連のイベントを構成します。

システムまたはユーザがアラームを削除（アーカイブ）します。クリアにされるアラームは重大度が標準のアラームです。システムのアーカイブは 1 日後にアラームをクリアにします（これはデフォルト設定です）。システムのアーカイブは 7 日後にアラームをアンクリアにします。システムまたはユーザがアラームをアーカイブした後、条件が再発生すると、Prime Performance Manager は新しいアラーム ID で新しいアラームを起動します。

OSS ホストの設定

ノースバウンド OSS にイベントを送信する Prime Performance Manager の設定は Prime Performance Manager GUI を使用して実行されます。情報につては、『 Cisco Prime Performance Manager 1.4 User Guide 』の「Adding Upstream OSS Hosts」の手順を参照してください。

Prime Performance Manager のイベント API の操作

次のトピックでは、Prime Performance Manager のイベント API の操作について説明します。すべての操作は、コメント付きの疑似コードとして一覧表示されます。操作構文は Web サービス記述言語（WSDL）として定義されます。構文は、「イベント API WSDL および XSD の定義」 に示すとおりです。イベント API 操作では SOAP（Simple Object Access Protocol）を使用します。エラー コードは「イベントの API エラー」で説明します。

イベント API の操作：

• 「Prime Performance Manager から取得するすべてのアラーム」

• 「Prime Performance Manager から取得するすべてのオープン アラーム」

• 「Prime Performance Manager から取得するすべてのイベント」

• 「トラップとしてフィルタリングされたイベントのPrime Performance Manager からの取得」

• 「イベントのクリア」

• 「イベントの確認応答」

• 「イベントの未確認応答」

• 「イベントの削除」

• 「イベントのの重大度の変更」

• 「イベントの注記の取得」

• 「イベントの注記の設定」

• 「イベントへの注記の追加」

Prime Performance Manager から取得するすべてのアラーム

int getAllAlarmsAsTraps (TrapTarget target)
 

この方式は、トラップとして Prime Performance Manager からすべてのアラームを取得します。

Parameters

TrapTarget target：Prime Performance Manager アラーム トラップを送信するターゲットを指定します。次のパラメータを指定できます。

Hostname：トラップ送信先に送信するホスト名または IP アドレス。

Port Number：トラップ送信先に送信するポート番号。

Community String：トラップに対応するコミュニティ ストリング。

SNMP Version：トラップの Simple Network Management Protocol（SNMP; 簡易ネットワーク管理プロトコル）のバージョン：1 または 2c。

MIB：トラップを送信する管理情報ベース（MIB）形式：CISCO PRIME、CISCO SYSLOG、または CISCO-EPM-2。

戻り値

この方式の結果として送信されたアラームの数。

例

<message name="getFilteredEventsRequest">
<part name="filter" type="tns:EventFilter"></part>
</message>
<message name="getFilteredEventsResponse">
<part name="events" type="tns:EventList"></part>
</message>
 

Prime Performance Manager から取得するすべてのオープン アラーム

int getAllOpenAlarmsAsTraps (TrapTarget target)
 

この方式は、トラップとして Prime Performance Manager からすべてのオープン アラームを取得します。

Parameters

TrapTarget target：Prime Performance Manager アラーム トラップを送信するターゲットを指定します。次のパラメータを指定できます。

Hostname：トラップ送信先に送信するホスト名または IP アドレス。

Port Number：トラップ送信先に送信するポート番号。

Community String：トラップに対応するコミュニティ ストリング。

SNMP Version：トラップの Simple Network Management Protocol（SNMP; 簡易ネットワーク管理プロトコル）のバージョン：1 または 2c。

MIB：トラップを送信する管理情報ベース（MIB）形式：CISCO PRIME、CISCO SYSLOG、または CISCO-EPM-2。

戻り値

この方式の結果として送信されたオープン アラームの数。

Prime Performance Manager から取得するすべてのイベント

int getAllEventsAsTraps (TrapTarget target)
 

この方式は、トラップとして Prime Performance Manager からすべてのイベントを取得します。

Parameters

TrapTarget target：Prime Performance Manager イベント トラップを送信するターゲットを指定します。次のパラメータを指定できます。

Hostname：トラップ送信先に送信するホスト名または IP アドレス。

Port Number：トラップ送信先に送信するポート番号。

Community String：トラップに対応するコミュニティ ストリング。

SNMP Version：トラップの Simple Network Management Protocol（SNMP; 簡易ネットワーク管理プロトコル）のバージョン：1 または 2c。

MIB：トラップを送信する管理情報ベース（MIB）形式：CISCO PRIME、CISCO SYSLOG、または CISCO-EPM-2。

戻り値

この方式の結果として送信されたイベントの数。

Prime Performance Manager からのフィルタリング済みイベントの取得

EventList getFilteredEvents (EventFilter filter)

この方式では Prime Performance Manager からフィルタリング済みイベントのリストを取得します。

Parameters

• EventFilter：Prime Performance Manager イベントを取得するルールを指定します。フィルタはスタンドアロンであるか、または組み合わされている場合があります。複数のフィルタを指定する場合、AND ロジックを使用して適用します。次のパラメータを指定できます。

– Event ID：フィルタするイベント ID のリストを指定します。

– Start Date：イベントをフィルタするための開始日を指定します。

– End Date：イベントをフィルタするための終了日を指定します。

– Severity：イベントをフィルタするための重大度のリストを指定します。有効な重大度は Prime Performance Manager の Event Editor でカスタマイズできます。

– Category：イベントをフィルタするためのカテゴリのリストを指定します。有効なイベント カテゴリは Prime Performance Manager の Event Editor でカスタマイズできます。

– Acknowledged：イベントが確認応答されているかどうかに基づくフィルタ。

– Cleared：イベントがクリアされているかどうかに基づくフィルタ。

– Message Text：イベントに指定されたメッセージ テキストがあるかどうかに基づくフィルタ。

• Forward：イベントの転送オプションがオンになっているかどうかに基づくフィルタ。イベントの転送オプションは Prime Performance Manager の Event Editor を使用して設定します。

• AlarmMode：アラームかイベントかに基づくフィルタ。

戻り値

この方式の結果として送信されたイベントのリスト。

戻り値

<message name="getFilteredEventsRequest">
<part name="filter" type="tns:EventFilter"></part>
</message>
<message name="getFilteredEventsResponse">
<part name="events" type="tns:EventList"></part>
</message>
 

トラップとしてフィルタリングされたイベントのPrime Performance Manager からの取得

int getFilteredEventsAsTraps (TrapTarget target, EventFilter filter)
 

この方式は、トラップとして Prime Performance Manager からフィルタリングされたイベントを取得します。

Parameters

TrapTarget target：Prime Performance Manager イベント トラップを送信するターゲットを指定します。次のパラメータを指定できます。

Hostname：トラップ送信先に送信するホスト名または IP アドレス。

Port Number：トラップ送信先に送信するポート番号。

Community String：トラップに対応するコミュニティ ストリング。

SNMP Version：トラップの SNMP のバージョン：1 または 2c。

MIB：トラップを送信する MIB 形式：CISCO PRIME、 CISCO-SYSLOG、または CISCO-EPM-2。

EventFilter filter：Prime Performance Manager イベントを取得するフィルタ ルールを指定します。これらのフィルタは、スタンドアロンとして指定することも、一緒に組み合わせることもできます。複数のフィルタを指定する場合、「AND」ロジックを使用して適用します。次のパラメータを指定できます。

Event ID：フィルタするイベント ID のリストを指定します。

Start Date：イベントをフィルタするための開始日を指定します。

End Date：イベントをフィルタするための終了日を指定します。

Severity：イベントをフィルタするための重大度のリストを指定します。有効な重大度は Prime Performance Manager の Event Editor でカスタマイズできます。

Category：イベントをフィルタするためのカテゴリのリストを指定します。有効なイベント カテゴリは Prime Performance Manager の Event Editor でカスタマイズできます。

Acknowledged：イベントが確認応答されているかどうかに基づくフィルタ。

Cleared：イベントがクリアされているかどうかに基づくフィルタ。

Message Text：イベントに指定されたメッセージ テキストがあるかどうかに基づくフィルタ。

Forward：イベントの転送オプションがオンになっているかどうかに基づくフィルタ。イベントの転送オプションは Prime Performance Manager の Event Editor を使用して設定します。

AlarmMode：アラームかイベントかに基づくフィルタ。

戻り値

この方式の結果として送信されたイベントの数。

トラップの再送信

void resendTraps(String host, String port)
 

この方式は、トラップを再送信します。

Parameters

• host：トラップの宛先のホスト。

• port：トラップの宛先のポート。

戻り値

void

例

<message name="resendTrapsRequest">
<part name="host" type="xsd:string"/>
<part name="port" type="xsd:string"/>
</message>
<message name="resendTrapsResponse">
</message>

イベントのクリア

void clearEvents (EventIDList eventList, String userid, String note)
 

この方式は、指定されたイベントをクリアにします。

Parameters

EventIDList eventList：クリアするイベントのリスト。

String userid：イベントをクリアしたユーザ ID。

String note：このイベントをクリアした理由を説明した注記。

戻り値

なし

イベントの確認応答

void acknowledgeEvents (EventIDList eventList, String userid, String note)
 

この方式は、指定されたイベントを確認応答します。

Parameters

EventIDList eventList：確認応答するイベントのリスト。

String userid：イベントをクリアしたユーザ ID。

String note：このイベントを確認応答した理由を説明した注記。

戻り値

なし

イベントの未確認応答

void unacknowledgeEvents (EventIDList eventList, String userid, String note)
 

この方式は、指定されたイベントを確認応答しません。

Parameters

EventIDList eventList：確認応答しないイベントのリスト。

String userid：イベントをクリアしたユーザ ID。

String note：このイベントを確認応答しない理由を説明した注記。

戻り値

void

例

<message name="unAcknowledgeEventsRequest">
<part name="eventList" type="tns:EventIDList"/>
<part name="userid" type="xsd:string"/>
<part name="note" type="xsd:string"/>
</message>
<message name="unAcknowledgeEventsResponse">
</message>
 

イベントの削除

void deleteEvents (EventIDList eventList)
 

この方式は、指定されたイベントを削除します。

Parameters

EventIDList eventList：削除するイベントのリスト。

戻り値

なし

イベントのの重大度の変更

void changeSeverities (EventIDList eventList, String severity, String userid, String note)
 

この方式は、指定されたイベントの重大度を変更します。

Parameters

EventIDList eventList：イベントの重大度を変更するリスト

String severity：変更対象の重大度。有効な重大度は Prime Performance Manager の Event Editor でカスタマイズできます。

String userid：イベントの重大度を変更したユーザ ID。

String note：このイベントの重大度を変更した理由を説明した注記。

戻り値

なし

イベントの注記の取得

String getNote (long eventID)
 

この方式は、イベントに添付された注記を取得します。

Parameters

Long eventID：注記を取得するイベント ID。

戻り値

なし

イベントの注記の設定

String setNote (long eventID, String userid, String note)
 

この方式は、イベントに添付する注記を設定します。

Parameters

long eventID：注記を設定するイベント ID。

String userid：注記を設定するユーザ ID。

String note：設定する注記のテキスト。

戻り値

なし

イベントへの注記の追加

String appendNote (long eventID, String userid, String note)
 

この方式は、イベントに注記を追加します。

Parameters

long eventID：注記を付けるイベント ID。

String userid：イベントの注記にテキストを付けるユーザ ID。

String note：イベントの注記に付けるテキスト。

戻り値

なし

イベント API WSDL および XSD の定義

次のトピックでは、Prime Performance Manager イベント API WSDL および XSD の定義を示します。

• 「EventAPI.wsdl」

• 「Event.xsd」

EventAPI.wsdl

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!-- Copyright (c) 2006-2013 Cisco Systems, Inc. All rights reserved. -->
 
<definitions targetNamespace="http://cisco.com/ppm" name="EventAPIService"
xmlns:tns="http://cisco.com/ppm"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns="http://schemas.xmlsoap.org/wsdl/">
 
<types>
<xsd:schema>
<xsd:import namespace="http://cisco.com/ppm" schemaLocation="MWTM.xsd" />
<xsd:import namespace="http://cisco.com/ppm" schemaLocation="Event.xsd" />
<xsd:import namespace="http://cisco.com/ppm" schemaLocation="Common.xsd" />
</xsd:schema>
</types>
 
<message name="APIStatus">
<part name="APIStatus" element="tns:APIStatus"/>
</message>
<message name="resendTrapsRequest">
<part name="host" type="xsd:string"/>
<part name="port" type="xsd:string"/>
</message>
<message name="resendTrapsResponse">
</message>
<message name="getFilteredEventsRequest">
<part name="filter" type="tns:EventFilter"></part>
</message>
<message name="getFilteredEventsResponse">
<part name="events" type="tns:EventList"></part>
</message>
<message name="getAllOpenAlarmsAsTrapsRequest">
<part name="target" type="tns:TrapTarget"/>
</message>
<message name="getAllOpenAlarmsAsTrapsResponse">
<part name="eventCount" type="xsd:int"/>
</message>
<message name="getAllEventsAsTrapsRequest">
<part name="target" type="tns:TrapTarget"/>
</message>
<message name="getAllEventsAsTrapsResponse">
<part name="eventCount" type="xsd:int"/>
</message>
<message name="getFilteredEventsAsTrapsRequest">
<part name="target" type="tns:TrapTarget"/>
<part name="filter" type="tns:EventFilter"/>
</message>
<message name="getFilteredEventsAsTrapsResponse">
<part name="eventCount" type="xsd:int"/>
</message>
<message name="clearEventsRequest">
<part name="eventList" type="tns:EventIDList"/>
<part name="userid" type="xsd:string"/>
<part name="note" type="xsd:string"/>
</message>
<message name="clearEventsResponse">
</message>
<message name="acknowledgeEventsRequest">
<part name="eventList" type="tns:EventIDList"/>
<part name="userid" type="xsd:string"/>
<part name="note" type="xsd:string"/>
</message>
<message name="acknowledgeEventsResponse">
</message>
<message name="unAcknowledgeEventsRequest">
<part name="eventList" type="tns:EventIDList"/>
<part name="userid" type="xsd:string"/>
<part name="note" type="xsd:string"/>
</message>
<message name="unAcknowledgeEventsResponse">
</message>
<message name="deleteEventsRequest">
<part name="eventList" type="tns:EventIDList"/>
</message>
<message name="deleteEventsResponse">
</message>
<message name="changeSeveritiesRequest">
<part name="eventList" type="tns:EventIDList"/>
<part name="severity" type="xsd:string"/>
<part name="userid" type="xsd:string"/>
<part name="note" type="xsd:string"/>
</message>
<message name="changeSeveritiesResponse">
</message>
<message name="getNoteRequest">
<part name="eventID" type="xsd:long"/>
</message>
<message name="getNoteResponse">
<part name="note" type="xsd:string"/>
</message>
<message name="setNoteRequest">
<part name="eventID" type="xsd:long"/>
<part name="userid" type="xsd:string"/>
<part name="note" type="xsd:string"/>
</message>
<message name="setNoteResponse">
</message>
<message name="appendNoteRequest">
<part name="eventID" type="xsd:long"/>
<part name="userid" type="xsd:string"/>
<part name="note" type="xsd:string"/>
</message>
<message name="appendNoteResponse">
</message>
 
<portType name="EventAPI">
<operation name="resendTraps">
<input message="tns:resendTrapsRequest"/>
<output message="tns:resendTrapsResponse"/>
<fault name="APIStatus" message="tns:APIStatus"/>
</operation>
<operation name="getFilteredEvents">
<input message="tns:getFilteredEventsRequest" />
<output message="tns:getFilteredEventsResponse" />
<fault name="APIStatus" message="tns:APIStatus" />
</operation>
<operation name="getAllOpenAlarmsAsTraps">
<input message="tns:getAllOpenAlarmsAsTrapsRequest"/>
<output message="tns:getAllOpenAlarmsAsTrapsResponse"/>
<fault name="APIStatus" message="tns:APIStatus"/>
</operation>
<operation name="getAllEventsAsTraps">
<input message="tns:getAllEventsAsTrapsRequest"/>
<output message="tns:getAllEventsAsTrapsResponse"/>
<fault name="APIStatus" message="tns:APIStatus"/>
</operation>
<operation name="getFilteredEventsAsTraps">
<input message="tns:getFilteredEventsAsTrapsRequest"/>
<output message="tns:getFilteredEventsAsTrapsResponse"/>
<fault name="APIStatus" message="tns:APIStatus"/>
</operation>
<operation name="clearEvents">
<input message="tns:clearEventsRequest"/>
<output message="tns:clearEventsResponse"/>
<fault name="APIStatus" message="tns:APIStatus"/>
</operation>
<operation name="acknowledgeEvents">
<input message="tns:acknowledgeEventsRequest"/>
<output message="tns:acknowledgeEventsResponse"/>
<fault name="APIStatus" message="tns:APIStatus"/>
</operation>
<operation name="unAcknowledgeEvents">
<input message="tns:unAcknowledgeEventsRequest"/>
<output message="tns:unAcknowledgeEventsResponse"/>
<fault name="APIStatus" message="tns:APIStatus"/>
</operation>
<operation name="deleteEvents">
<input message="tns:deleteEventsRequest"/>
<output message="tns:deleteEventsResponse"/>
<fault name="APIStatus" message="tns:APIStatus"/>
</operation>
<operation name="changeSeverities">
<input message="tns:changeSeveritiesRequest"/>
<output message="tns:changeSeveritiesResponse"/>
<fault name="APIStatus" message="tns:APIStatus"/>
</operation>
<operation name="getNote">
<input message="tns:getNoteRequest"/>
<output message="tns:getNoteResponse"/>
<fault name="APIStatus" message="tns:APIStatus"/>
</operation>
<operation name="setNote">
<input message="tns:setNoteRequest"/>
<output message="tns:setNoteResponse"/>
<fault name="APIStatus" message="tns:APIStatus"/>
</operation>
<operation name="appendNote">
<input message="tns:appendNoteRequest"/>
<output message="tns:appendNoteResponse"/>
<fault name="APIStatus" message="tns:APIStatus"/>
</operation>
</portType>
 
<binding name="EventAPIPortBinding" type="tns:EventAPI">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="rpc" />
<operation name="resendTraps">
<soap:operationsoapAction="" />
<input>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</input>
<output>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</output>
<fault name="APIStatus">
<soap:fault use="literal" name="APIStatus" />
</fault>
</operation>
<operation name="getFilteredEvents">
<soap:operationsoapAction="" />
<input>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</input>
<output>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</output>
<fault name="APIStatus">
<soap:fault use="literal" name="APIStatus" />
</fault>
</operation>
<operation name="getAllOpenAlarmsAsTraps">
<soap:operationsoapAction="" />
<input>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</input>
<output>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</output>
<fault name="APIStatus">
<soap:fault name="APIStatus" use="literal" />
</fault>
</operation>
<operation name="getAllEventsAsTraps">
<soap:operationsoapAction="" />
<input>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</input>
<output>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</output>
<fault name="APIStatus">
<soap:fault name="APIStatus" use="literal" />
</fault>
</operation>
<operation name="getFilteredEventsAsTraps">
<soap:operationsoapAction="" />
<input>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</input>
<output>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</output>
<fault name="APIStatus">
<soap:fault name="APIStatus" use="literal" />
</fault>
</operation>
<operation name="clearEvents">
<soap:operationsoapAction="" />
<input>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</input>
<output>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</output>
<fault name="APIStatus">
<soap:fault name="APIStatus" use="literal" />
</fault>
</operation>
<operation name="acknowledgeEvents">
<soap:operationsoapAction="" />
<input>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</input>
<output>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</output>
<fault name="APIStatus">
<soap:fault name="APIStatus" use="literal" />
</fault>
</operation>
<operation name="unAcknowledgeEvents">
<soap:operationsoapAction="" />
<input>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</input>
<output>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</output>
<fault name="APIStatus">
<soap:fault name="APIStatus" use="literal" />
</fault>
</operation>
<operation name="deleteEvents">
<soap:operationsoapAction="" />
<input>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</input>
<output>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</output>
<fault name="APIStatus">
<soap:fault name="APIStatus" use="literal" />
</fault>
</operation>
<operation name="changeSeverities">
<soap:operationsoapAction="" />
<input>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</input>
<output>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</output>
<fault name="APIStatus">
<soap:fault name="APIStatus" use="literal" />
</fault>
</operation>
<operation name="getNote">
<soap:operationsoapAction="" />
<input>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</input>
<output>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</output>
<fault name="APIStatus">
<soap:fault name="APIStatus" use="literal" />
</fault>
</operation>
<operation name="setNote">
<soap:operationsoapAction="" />
<input>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</input>
<output>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</output>
<fault name="APIStatus">
<soap:fault name="APIStatus" use="literal" />
</fault>
</operation>
<operation name="appendNote">
<soap:operationsoapAction="" />
<input>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</input>
<output>
<soap:body use="literal" namespace="http://cisco.com/ppm" />
</output>
<fault name="APIStatus">
<soap:fault name="APIStatus" use="literal" />
</fault>
</operation>
</binding>
 
<service name="EventAPIService">
<port name="EventAPIPort" binding="tns:EventAPIPortBinding">
<soap:address location="REPLACE_WITH_ACTUAL_URL"/>
</port>
</service>
 
</definitions>
 

Event.xsd

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!-- Copyright (c) 2006-2013 Cisco Systems, Inc. All rights reserved. -->
 
<xs:schema version="1.0"
targetNamespace="http://cisco.com/ppm"
xmlns:tns="http://cisco.com/ppm"
xmlns:xs="http://www.w3.org/2001/XMLSchema">
 
<!-- A list of event IDs -->
<xs:complexType name="EventIDList">
<xs:sequence>
<xs:element name="ID" type="xs:long" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
 
<xs:element name="EventIDList" type="tns:EventIDList"/>
 
<!-- A list of Events -->
<xs:complexType name="EventList">
<xs:sequence>
<xs:element name="Events" type="tns:Event" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
 
<xs:element name="EventList" type="tns:EventList"/>
 
<!-- Event : derived from com.cisco.mwg.sgm.core.SgmEvent -->
<xs:complexType name="Event">
<xs:sequence>
<xs:element name="Id" type="xs:long" />
<xs:element name="AlarmId" type="xs:long" />
<xs:element name="Owner" type="xs:string" />
<xs:element name="Category" type="xs:string" />
<xs:element name="Severity">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="Critical" />
<xs:enumeration value="Major" />
<xs:enumeration value="Minor" />
<xs:enumeration value="Warning" />
<xs:enumeration value="Informational" />
<xs:enumeration value="Normal" />
<xs:enumeration value="Indeterminate" />
<xs:enumeration value="Normal" />
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="Message" type="xs:string" />
<xs:element name="NotesExist" type="xs:boolean" />
<xs:element name="AckBy" type="xs:string" />
<xs:element name="ClearBy" type="xs:string" />
<xs:element name="CreateTimestamp" type="xs:dateTime" />
<xs:element name="AckTimestamp" type="xs:dateTime" />
<xs:element name="ClearTimestamp" type="xs:dateTime" />
<xs:element name="ChangeTimestamp" type="xs:dateTime" />
<xs:element name="AlarmNature" type="xs:string" />
<xs:element name="AlarmType" type="xs:string" />
<xs:element name="ProbableCause" type="xs:string" />
<xs:element name="DeviceType" type="xs:string" />
<xs:element name="Condition" type="xs:string" />
<xs:element name="TcaName" type="xs:string" />
<xs:element name="TcaMetric" type="xs:string" />
<xs:element name="ElementName" type="xs:string" />
<xs:element name="OriginalSeverity" type="xs:string" />
<xs:element name="Count" type="xs:long" />
<xs:element name="isAlarm" type="xs:boolean" />
</xs:sequence>
</xs:complexType>
 
<xs:element name="Event" type="tns:Event"/>
 
<!-- Trap Target specifies target host/port and SNMP parameters to send
SNMP Trap notification to -->
<xs:complexType name="TrapTarget">
<xs:sequence>
<xs:element name="Hostname" type="xs:string"/>
<xs:element name="Port" type="xs:int"/>
<xs:element name="Community" type="xs:string"/>
<xs:element name="SNMPVersion">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="1"/>
<xs:enumeration value="2c"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="MIB">
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:enumeration value="CISCO-PRIME"/>
<xs:enumeration value="CISCO-EPM-2"/>
<xs:enumeration value="CISCO-SYSLOG"/>
</xs:restriction>
</xs:simpleType>
</xs:element>
</xs:sequence>
</xs:complexType>
 
<xs:element name="TrapTarget" type="tns:TrapTarget"/>
 
<!-- Event Filter -->
<!-- If more than one conditions are specified,
EventFilter applies "AND" on all specified conditions
-->
<xs:complexType name="EventFilter">
<xs:sequence>
<xs:element name="EventIDs" type="tns:EventIDList" minOccurs="0"/>
<xs:element name="StartAlarmId" type="xs:int" minOccurs="0"/>
<xs:element name="EndAlarmId" type="xs:int" minOccurs="0"/>
<xs:element name="StartAlarmChangeTime" type="xs:dateTime" minOccurs="0"/>
<xs:element name="EndAlarmChangeTime" type="xs:dateTime" minOccurs="0"/>
<xs:element name="StartDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="EndDate" type="xs:dateTime" minOccurs="0"/>
<xs:element name="Severity" type="xs:string"
minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="Category" type="xs:string"
minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="Acknowledged" type="xs:boolean" minOccurs="0"/>
<xs:element name="Cleared" type="xs:boolean" minOccurs="0"/>
<!-- filter "text" is based on whether event message contains
given text -->
<xs:element name="MessageText" type="xs:string" minOccurs="0"/>
<xs:element name="NetworkElement" type="xs:string" minOccurs="0"/>
<xs:element name="Forward" type="xs:boolean" minOccurs="0"/>
<xs:element name="AlarmMode" type="xs:int" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
 
<xs:element name="EventFilter" type="tns:EventFilter"/>
 
</xs:schema>

イベントの API エラー

詳細なエラー情報は、WSDL の APIStatus として次のように定義されています（イベント API WSDL の定義については、 付録 5「イベント API WSDL および XSD の定義」 を参照してください）。

<xs:complexType name=”APIStatus”>
<xs:sequence>
<xs:element name=”StatusCode” type=”xs:int”/>
<xs:element name=”Message” type=”xs:string”/>
</xs:sequence>
</xs:complexType>
 

APIStatus にはステータス コードおよびメッセージが含まれます。 表 5-1 に可能性のあるイベント API ステータス コードを示します。

 

表 5-1 ステータス コード

ステータス コード
エラー
説明

1000

UNEXPECTED_ERROR

要求された操作を停止する予期しないエラーが生じました。

2000

INVALID_PARAMETER

要求元から提供された要求操作内に 1 つまたは複数の不正なパラメータがありました。

Prime Performance Manager の相互起動

Prime Performance Manager で相互起動するためには、次の形式で URL を生成します。

<server>:<port>/ppm/jsp/main.jsp?
 

必須パラメータ

• displayType [results,reportTab]：テーブルおよびグラフだけを表示します。また、ヘッダー バーも reportTab に含まれます。このパラメータは XWT シェルなしの Prime Performance Manager の内部フレーム全体を示します。

• FQDN [objectId]：FQDN でオブジェクトを指定します。

• resultsType <文字列>：実行するレポート。この文字列は、Prime Performance Manager GUI の [Type] フィールドに入力したリスト、たとえば Interface Utilization Hourly と一致する必要があります。FQDN または resultsType のどちらかと一緒に reportID を指定する必要があります。

オプション パラメータ：

• durationSelect <文字列>：レポートの期間を設定します。開始日と終了日の代わりに次の中の必要な日付にこのパラメータを使用できます。

– lastHour：毎時レポートの場合のみ有効

– last24Hours：毎時レポートまたは日報にのみ有効

– last7Days：すべてのレポートに有効

– last30Days：日報の場合のみ有効

– last90Days：日報の場合のみ有効

• startDate <ミリ秒>：1970 年からのミリ秒で開始日をレポートします。このパラメータが指定されている場合、endDate を指定する必要があります。

• endDate <ミリ秒>：1970 年からのミリ秒で終了日をレポートします。endDate は開始日よりも大きい必要があります。このパラメータが指定されている場合、startDate を指定する必要があります。

• outputType <文字列>：出力タイプ：CSV、TABLE、または GRAPH。

• topStatSel <文字列>：デフォルトのデータのソート方法。提供された文字列はグラフィカル ユーザ インターフェイスのドロップ ダウンで表示される文字列に一致させる必要があります。

• screenWidth <整数>：画面幅。デフォルトは 1000 ピクセルです。

• screenHeight <整数>：画面の高さ。デフォルトは 700 ピクセルです。

• clientOffSetTime <ミリ秒>：クライアントの時間帯のオフセット。指定されていない場合は、レポートの開始日と終了日にサーバの時間帯が使用されます。

• fullScreen <整数>：全画面表示するグラフ指標。これは 0 のインデックス番号です。

• hideButtons<ブール値>：グラフのズーム、グラフ形式およびエクスポートのオプションを非表示にします。

• hideTitle <ブール値>：グラフのタイトルを非表示にします。

• hideNavigator <ブール値>：リーフおよび全画面グラフでのナビゲータを非表示にします。

• hideLegend <ブール値>：グラフの凡例を非表示にします。

• hideDateString <ブール値>：グラフ内の日付を非表示にします。

このドキュメントは役に立ちましたか?

Feedbackフィードバック

シスコに問い合わせ