前のトピック: サーバの指定項目

次のトピック: IncidentFilter の XML 指定項目

タイム ゾーン指定項目

getQuery または runQuery のコールに、タイム ゾーンの指定項目を追加することができます。 getTimeZones を使用して、使用可能なタイム ゾーンの一覧を取得できます。

タイム ゾーン指定項目の例

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=getQueryViewer&objectId=Subscription/panels/System_Event_Count_By_Event_Action&timezone=TIMEZONENAME

ここで「&timezone=」は、使用するタイム ゾーンの名前を指定します。 getTimeZones コールによって返された一覧の表示名に従って、「TIMEZONENAME」を実際のタイム ゾーン名に置き換えます。

注: 無効なタイム ゾーンに対するレスポンスは、以下のように、タイム ゾーンを指定したコールによって異なります。

詳細情報:

getTimeZones

runQuery

詳細情報:

IncidentFilter の XML 指定項目

XML フィルタリングの指定項目

XML 形式のレポートに適用する CA User Activity Reporting Module フィルタをあらかじめ設定しておき、filterXML 条件記述を使用してそれらのフィルタを getQueryViewer、getReportViewer、または runQuery の URL に追加できます。 AND および OR の条件および丸かっこを使用して、複数のフィルタをネストすることができます。 実質的に、XML 形式で CA User Activity Reporting Module の詳細フィルタを作成することになります。

重要: FilterXml の条件記述は複雑です。また API によって検証されることもありません。 無効なフィルタリング条件を使用するとクエリ エラーが発生します。 そのため、フィルタリング条件を記述する際には細心の注意を払うことが推奨されます。

使用可能なフィルタ要素は以下のとおりです。使用する必要度の高い順に表示しています。

lparens

左かっこの数を定義します。 有効な値は 0 以上です。

logic

フィルタを結合する論理条件(AND または OR)を指定します。 最初のフィルタの条件では、常に論理値を空にしておきます。

col

クエリ対象とするイベント列を定義します。 getDataModel を使用して、使用可能な列の一覧を取得することができます。

oper

フィルタに使用する演算子を定義します。 有効な値は以下のとおりです(大文字と小文字が区別されます)。

val

フィルタで検索する値を定義します。

rparens

右かっこの数を定義します。 有効な値は 0 以上です。 右かっこの総数は、常に左かっこの数と一致します。

グラフィカルなクエリまたはレポートを表示した際、ビューア インターフェースの[ローカル フィルタ]ダイアログ ボックスの[詳細フィルタ]セクションで、設定した FilterXML 条件を表示または調整することができます。

XML フィルタリングの指定項目の例

この例は、フィルタ ステートメントを含む getQueryViewer コールを示しています。 わかりやすくするため、フィルタリング条件を展開して表示しています。

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=getQueryViewer&objectId=Subscription/panels/System_Event_Count_By_Event_Action&server=ELMSERVER&filterXml=
  <Filter logic="" lparens="1" col="source_username" oper="LIKE" val="su" rparens="0"/>
  <Filter logic="AND" lparens="0" col="event_logname" oper="LIKE" val="CALM" rparens="1"/>
</Scope>

「&filterxml」は、この後にフィルタ ステートメントが続くことを示しています。

フィルタ ステートメントは、source_username 列で「su」を、event_logname 列で「CALM」を検索するクエリを設定しています。 AND ステートメント(Filter logic="AND")によって 2 つの条件が結合されているため、いずれの列にもそれぞれの値があるイベントのみが返されます。

アクセス フィルタ XML の指定項目

証明書名やパスワード認証のメカニズムを使用して認証する場合、クエリまたはレポートに対して XML 形式の CA User Activity Reporting Module フィルタを事前に設定できます。 ログイン コールで渡されたアクセス フィルタ XML は、そのセッション内で実行されたすべてのクエリおよびレポートに適用されます。 ユーザがアクセス フィルタ XML を使用してログインした後にクエリまたはレポートでフィルタ XML を渡すと、CA User Activity Reporting Module は両方のフィルタを適用して結果を取得します。

アクセス フィルタ XML の要素はフィルタ XML の要素に似ています。

フィルタ XML を含まないアクセス フィルタ XML 指定項目の例

この例は、アクセス フィルタ XML ステートメントを含む getQueryViewer コールを示しています。 わかりやすくするため、フィルタリング条件を展開して表示しています。

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=getQueryViewer&objectId=Subscription/panels/System_Event_Count_by_Event_Source&certname=test&password=test&accessFilterXml=<AccessScope><Filter logic="" lparens="0" col="event_logname"oper="LIKE" val="CALM" rparens="0"/></AccessScope>

「&accessFilterXml=」は、この後にアクセス フィルタ ステートメントが続くことを示しています。

フィルタ XML を含むアクセス フィルタ XML の指定項目

この例は、フィルタおよびアクセス フィルタの XML ステートメントを含む objectId コールを示しています。

https://ELMSERVER:5250/spin/calmapi/runQuery.csp?objectId=Subscription/panels/System_Event_Count_by_Event_Source&filterXml=<Scope><Filter logic="" lparens="1"  col="event_logname" oper="INSET" val="'CALM','Unix'" rparens="1"/></Scope>&certname=test&password=test&accessFilterXml=<AccessScope><Filter logic="" lparens="1" col="event_logname" oper="LIKE" val="CALM" rparens="1"/></AccessScope>

「&filterXml=」は、この後にフィルタ ステートメントが続くことを示しています。

「&accessFilterXml=」は、この後にアクセス フィルタ ステートメントが続くことを示しています。