Cisco Prime Performance Manager 1.0 統合開発者ガイド
レポート マクロ リファレンス
レポート マクロ リファレンス
発行日;2012/06/18 | 英語版ドキュメント(2011/06/23 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 1,021KB) | フィードバック

目次

レポート マクロ リファレンス

マクロ

BOOLEANVALUE

BREAK

CONTINUE

DELTA

DELTA NEXT

DEVICETYPE

DOUBLEVALUE

ENDSWITH

FILTER

GETALL

GETAVAILABILITYINFO

GETCACHE

GETHOSTADDRESS

GETHOSTNAME

HASCAPABILITY

HASVAR

IF

IFDESCR

IFSPEED

IFSPEEDRECEIVE

INDEXOF

INTERVALDURATION

INTVALUE

IOSVERSION

IPADDRESS

ISNULL

ISTABLEEMPTY

JOIN

LASTVALUE

LEFTJOIN

LENGTH

LONGVALUE

MATCHES

NEXTVALUE

NOT

PERSISTVALUE

POLL

POLLNEXT

POLLPERSIST

PRINT

PUTCACHE

RATE

RETURN

SETCPUINFO

SETTIMEVARINFO

SHORTVALUE

STARTSWITH

SUBSTRING

SYSTIME

TABLEINDICES

TOPN

TOSTRING

レポート マクロ リファレンス

Cisco Prime Performance Manager レポート インターフェイスでは、レポート内で使用可能な多数の定義済みレポート マクロが用意されています。

マクロの呼び出し方法には、次の 2 種類があります。

1. object.macro ( arg1 , arg2 , arg3 , etc.)

2. macro ( object , arg1 , arg2 , arg3 , etc.)

この章内の各リファレンス トピックでは、2 番目の方法の構文が示されています。

引数が角カッコ([])で囲まれている場合、その引数は省略可能であることを意味します。

引数が特定の型であることが示されている場合(オブジェクトは文字列型)、その引数は次のもので置き換えることもできます。

同じ型を返すマクロ/アルゴリズム

または

数値型/文字列型の場合は数値/文字列値

マクロ

「BOOLEANVALUE」

「BREAK」

「CONTINUE」

「DELTA」

「DELTA NEXT」

「DEVICETYPE」

「DOUBLEVALUE」

「ENDSWITH」

「FILTER」

「GETALL」

「GETAVAILABILITYINFO」

「GETCACHE」

「GETHOSTADDRESS」

「GETHOSTNAME」

「HASCAPABILITY」

「HASVAR」

「IF」

「IFDESCR」

「IFSPEED」

「IFSPEEDRECEIVE」

「INDEXOF」

「INTERVALDURATION」

「INTVALUE」

「IOSVERSION」

「IPADDRESS」

「ISNULL」

「ISTABLEEMPTY」

「JOIN」

「LASTVALUE」

「LEFTJOIN」

「LENGTH」

「LONGVALUE」

「MATCHES」

「NEXTVALUE」

「NOT」

「PERSISTVALUE」

「POLL」

「POLLNEXT」

「POLLPERSIST」

「PUTCACHE」

「RATE」

「RETURN」

「SETCPUINFO」

「SETTIMEVARINFO」

「SHORTVALUE」

「STARTSWITH」

「SUBSTRING」

「SYSTIME」

「TABLEINDICES」

「TOPN」

「TOSTRING」

BOOLEANVALUE

構文

BOOLEANVALUE ( object )

マクロの説明

オブジェクトをブール形式に変換します。失敗すると、ヌルを返します。

BREAK

構文

BREAK ()

マクロの説明

ProcessPollResult セクション内でのみ使用されます。

その行およびそれ以降のすべての行に対する処理を中止します。

CONTINUE

構文

CONTINUE ()

マクロの説明

ProcessPollResult セクション内でのみ使用されます。

その行の処理をスキップし、次の行に進みます。

DELTA

構文

DELTA ( object )

マクロの説明

ProcessPollResult セクション内でのみ使用されます。

object パラメータは次のとおりです。

現在と前のポール値の差分(currentPolling - previousPolling)を返す数値型です。

最初のポールである(前の値がない)場合や数値がオーバーフローした場合など、発生する可能性のある状態を考慮します。

DELTA NEXT

構文

DELTANEXT ( object , arg1 )

マクロの説明

object は数値型です。arg1 は文字列型であり、PollDefinition セクション内で前に作成された変数のインデックスの名前です(オブジェクトと同じテーブル内に存在していなければならない)。

前のポーリングの代わりにデータベース内の次の行との間で DELTA マクロを呼び出すことができます。

このマクロは、 arg1 の行の値が変化するまで差分を計算し続けます。

DEVICETYPE

構文

DEVICETYPE ( object )

マクロの説明

SystemCapabilities.xml ファイル内でのみ使用され、ユーザが再び呼び出してはなりません。

ノードのデバイス タイプを返します(通常、 object は sysObjectOID)。

DOUBLEVALUE

構文

DOUBLEVALUE ( object )

マクロの説明

オブジェクト(数値または文字列)を double 型に変換し、それを返します。失敗すると、ヌルを返します。

ENDSWITH

構文

ENDSWITH ( object , arg1 )

マクロの説明

object は文字列型で、 arg1 も文字列型です。

文字列オブジェクトの末尾が文字列 arg1 の場合、真を返します。

Java の endsWith 文字列関数と同様です。

FILTER

構文

FILTER (object, arg1 )

マクロの説明

object はテーブルです。 arg1 は条件です(ブール値の結果を返す)。

条件に合格しないアイテム(偽を返すアイテム)を削除した、オブジェクトのサブセットを返します。

GETALL

構文

GETALL ( object , arg1 )

マクロの説明

object はテーブルです。arg1 は文字列(キー)です。

arg1 のカラム値をすべて返します。

GETAVAILABILITYINFO

構文

GETAVAILABILITYINFO ()

マクロの説明

PollDefinition セクション内でのみ使用されます。

ノードから可用性情報(システムが起動しているかどうか)を取得します(MWTMCURRTIME、sysUpTime、sysName、および可用性)。

Poll セクション内のレポートでは、追加の引数として alwaysExecute="true" が必要です。

GETCACHE

構文

GETCACHE ( object )

マクロの説明

object はキャッシュ内のキーです。

指定されたキーに対する値を返します。

このキャッシュは、他のポール定義内で後から情報を参照できるようにするキーと値のペアのリストです。

GETHOSTADDRESS

構文

GETHOSTADDRESS ( object )

マクロの説明

ProcessPollResult セクション内でのみ使用されます。

object は IP アドレスです。

ホスト アドレスを文字列形式で返します。

GETHOSTNAME

構文

GETHOSTNAME ( object )

マクロの説明

ProcessPollResult セクション内でのみ使用されます。

object は IP アドレスです。

ホスト名を文字列形式で返します。

HASCAPABILITY

構文

HASCAPABILITY ( arg1 )

マクロの説明

デバイスが特定の MIB( arg1 で文字列として指定)に対応しているかどうかをチェックします。

HASVAR

構文

HASVAR ( arg1 )

マクロの説明

SystemCapability.xml ファイル内でのみ使用されます。

指定された変数( arg1 )がデバイスに存在する場合は真を返します。

IF

構文

IF ( object , arg1 , [ arg2 ])

マクロの説明

object はブール型です。

2 つの引数が使用されると、object が真ならば arg1 を返すか実行し、 object が偽ならばヌルを返します。

3 つの引数が使用されると、object が真ならば arg1 を返すか実行し、object が偽ならば arg2 を返すか実行します。

IFDESCR

構文

IFDESCR ([ object ])

マクロの説明

ProcessPollResult セクション内でのみ使用されます。

インターフェイスの説明を返します。先に検索することで、再ポーリングを防ぎます。

オプションの引数は、この操作のインデックス キーです(デフォルトは ifIndex)。

IFSPEED

構文

IFSPEED ([ object ])

マクロの説明

ProcessPollResult セクション内でのみ使用されます。

インターフェイスの設定速度を返します。

オプションの引数は、この操作のインデックス キーです(デフォルトは ifIndex )。

IFSPEEDRECEIVE

構文

IFSPEEDRECEIVE ([ object ])

マクロの説明

インターフェイスの受信速度を返します。

オプションの引数は、この操作のインデックス キーです(デフォルトは ifIndex )。

INDEXOF

構文

INDEXOF ( object , arg1 , [ arg2 ])

マクロの説明

object は文字列型、 arg1 は文字列、 arg2 は整数です。

2 つの引数( object arg1 )が使用されると、 object 内で見つかった最初の arg1 の開始インデックスを返します。

3 つの引数が使用されると、object 内でインデックス番号 arg2 より後に見つかった最初の arg1 の開始インデックスを返します。

Java の indexOf 文字列関数と同様です。

INTERVALDURATION

構文

INTERVALDURATION ()

マクロの説明

WebReport セクションと CSV セクションでのみ使用されます。

指定されたレポートの時間間隔を返します(秒単位)。

レポートでは通常、15 分、1 時間、1 日などになります。

INTVALUE

構文

INTVALUE ( object )

マクロの説明

オブジェクトを整数に変換します。エラーが発生すると、ヌルを返します。

IOSVERSION

構文

IOSVERSION ( object )

マクロの説明

SystemCapability.xml ファイル内でのみ使用されます(一度しか使用されません)。

object が「sysDescr」の場合(通常の指定)、指定された文字列から IOS バージョンを解析します。

IPADDRESS

構文

IPADDRESS ( object , [ arg1 , arg2 ])

マクロの説明

ProcessPollResult セクション内でのみ使用されます。

object はオクテット文字列のアドレスです。 arg1 arg2 はオフセットです。

1 つの引数のみが使用されると、IP アドレスに変換されたオブジェクトを返します。

2 つの引数のみが使用されると、IP アドレスに変換されたオブジェクト(「 arg1 」のバイトから開始)を返します。

3 つの引数が使用されると、IP アドレスに変換されたオブジェクト(「arg1」のバイトから開始し、「arg2」のバイトで終了)を返します。

オフセットは、Java の substring 関数と同様です。

ISNULL

構文

ISNULL (object, [arg1 ])

マクロの説明

1 つの引数が使用されると、object がヌルならば真を返し、そうでなければ偽を返します。

2 つの引数が使用されると、object がヌルでなければ object を返し、object がヌルならば arg1 を返します。

ISTABLEEMPTY

構文

ISTABLEEMPTY ( object )

マクロの説明

SystemCapability.xml ファイルと PollDefinition セクションでのみ使用されます。

object はテーブルです。

object が空の場合、真を返します。

JOIN

構文

JOIN ( object , arg1 , arg2 )

マクロの説明

PollDefinition セクション内でのみ使用されます。

object arg1 はテーブルです。 arg2 は一致条件を指定します。

object arg1 を結合して得られたテーブルを返します。

object の行と arg1 の行は、条件( arg2 )が真になる場合に結合されます。

LASTVALUE

構文

LASTVALUE ( object )

マクロの説明

ProcessPollResult セクション内でのみ使用されます。

object は取得する変数の名前です。

最後の値(初めて使用される場合はヌル)を返します。

PERSISTVALUE マクロとともに使用されます。

LEFTJOIN

構文

LEFTJOIN ( object , arg1 , arg2 )

マクロの説明

object arg1 はテーブルです。 arg2 は一致条件です。

object arg1 を結合して得られたテーブルを返します。

object の行と arg1 の行は、条件( arg2 )が真になる場合に結合されます。ただし、object 内の各行は、 arg1 で指定されたオブジェクト内に一致する行がなくても、結果として得られるテーブルに引き続き保持されます。

LENGTH

構文

LENGTH ( object )

マクロの説明

object は文字列型です。

object 内の文字の数を返します。

Java の length 文字列関数と同様です。

LONGVALUE

構文

LONGVALUE ( object )

マクロの説明

オブジェクトを long 型に変換します。エラーが発生すると、ヌルを返します。

MATCHES

構文

MATCHES ( object , arg1 )

マクロの説明

object は文字列です。 arg1 は、Java の正規表現パターンです。

arg1 の正規表現パターンが object 内で検出されると、真を返します。

NEXTVALUE

構文

NEXTVALUE ( object )

マクロの説明

ProcessPollResult セクション内でのみ使用されます。

object は変数名です。

現在の行の次のテーブル行にある変数を返します。

NOT

構文

NOT ( object )

マクロの説明

object はブール型です。

object の反対を返します。

PERSISTVALUE

構文

PERSISTVALUE (object )

マクロの説明

object は保存する変数の名前です。

object の現在の値をポール間にわたって保存します。

LASTVALUE マクロとともに使用されます。

POLL

構文

POLL ( arg1 , arg2 )

マクロの説明

PollDefinition セクション内でのみ使用されます。

arg1 は、ポーリングする変数のリストです(二重引用符で囲まれ、カンマで区切られた変数のリスト)。 arg2 は、再ポーリングしなくても他のポールで参照できるようにするために使用されるラベルです。

スカラ値のグループまたは同じインデックスを共有するテーブル変数のみをポーリングします。

現在および他のレポートで参照されるすべての変数を、同じポール マクロ内で同じラベルを使用してポーリングする必要があります。これにより、再ポーリングが回避されます。

POLLNEXT

構文

POLLNEXT ( arg1 , arg2 , arg3 , arg4 )

マクロの説明

PollDefinition セクション内でのみ使用されます。

各引数の説明は次のとおりです。

arg1 は、各行を一意に識別するインデックスです(二重引用符で囲まれ、カンマで区切られた変数のリスト)。

arg2 は、ポーリングする変数のリストです(二重引用符で囲まれ、カンマで区切られた変数のリスト)。

arg3 は、ポーリングするインデックス変数のリストです。

arg4 はブール値です。最後の行が直近のポーリングの最後の行と同じ場合でも最後の行を返す場合に真にします。

まだ取得していないデータを取得します(使用可能な次のデータを取得します)。

POLLPERSIST

構文

POLLPERSIST ( arg1 )

マクロの説明

SystemCapability.xml ファイル内でのみ使用されます。

arg1 は、ポーリングする変数のリストです。

値をポーリングし、現在のコンテキストに格納します(他の機能チェックですぐに使用するために使用可能)。

PRINT

構文

PRINT ([ object ])

マクロの説明

引数が指定されなければ、空白行をコンソール ログに出力します(デバッグ用)。

1 つの引数が使用されると、そのオブジェクトをコンソール ログに出力します(デバッグ用)。

PUTCACHE

構文

PUTCACHE ( object , arg1 )

マクロの説明

object は使用するキーです。 arg1 は使用する値です。

キーと値のペア( object / arg1 )をキャッシュに格納します。

このキャッシュは、他のポール定義内で後から情報を参照できるようにするキーと値のペアのリストです。

RATE

構文

RATE ( object , [ arg1 , arg2 ])

マクロの説明

1 つの引数が使用されると、オブジェクトに関する前回と今回のポーリング間での変化の速度を返します(時間遅延に sysUpTime を使用して計算を実行)。

3 つの引数が使用されると(2 つの引数を使用するオプションはない)、オブジェクトに関する前回と今回のポーリング間での変化の速度を返します。この場合、 arg2 は時間に使用される値です。 arg3 は正しいメトリックを得るための乗数または変換係数です。つまり、秒数またはミリ秒数にするために使用されます。

たとえば、変数 sysUpTime は、1/100 秒の単位で記録されるので、秒数にするには 100 の乗数が必要です。

RETURN

構文

RETURN ()

マクロの説明

PollDefinition セクション内でのみ使用されます。

現在のポーリング宣言の実行を停止します。

SETCPUINFO

構文

SETCPUINFO ([ object ])

マクロの説明

CPU に関する情報( cpuDescr cpuNum cpuSlot )を設定します。

CPU インデックスを上書きするには、object をその値に設定します。

SETTIMEVARINFO

構文

SETTIMEVARINFO ( object , arg1 , arg2 )

マクロの説明

object は使用する時間変数です。 arg1 は次回その変数を使用するかどうかのブール値です。 arg2 はインデックスであり、値が変化するまでそのインデックスで使用します。

指定された引数に従って時間変数情報をコンテキストに設定します。

SHORTVALUE

構文

SHORTVALUE ( object )

マクロの説明

オブジェクトを short 型にして返します。エラーが発生すると、ヌルを返します。

STARTSWITH

構文

STARTSWITH ( object , arg1 )

マクロの説明

object は文字列型で、 arg1 も文字列型です。

文字列オブジェクトが arg1 の文字列で始まる場合に真を返します。

Java の startsWith 文字列関数と同様です。

SUBSTRING

構文

SUBSTRING ( object , arg1 , [ arg2 ])

マクロの説明

object は文字列型です。 arg1 と arg2 は整数 です

2 つの引数が使用されると、 object arg1 インデックスから始まる文字列を返します。

3 つの引数が使用されると、object の arg1 インデックスから始まり、 object arg2 インデックスで終わる文字列を返します。

最後の引数が object のサイズより大きい場合、ヌルを返します。

Java の substring 文字列関数と同様です。

SYSTIME

構文

SYSTIME ()

マクロの説明

現在のシステム時刻を返します(ミリ秒単位)。

TABLEINDICES

構文

TABLEINDICES ( object )

マクロの説明

テーブル内の行を特定するために使用する値として object を設定します(二重引用符で囲まれ、カンマで区切られた変数のリスト)。

TOPN

構文

TOPN ( object , arg1 , arg2 )

マクロの説明

PollDefinition セクションまたは ProcessDBSummary セクションで使用されます。

object はテーブルです。 arg1 はソートのキーになるカラムです。 arg2 は取得するレコード数( n )です。

ソート キーの降順でソートされた行の上位 n arg2 )個を返します。

ProcessDBSummary セクションの Filter セクション内で使用される場合、 rows は、一般に、ProcessDBSummary の実行が完了したときに設定されるオブジェクトとして使用可能な暗黙の変数です。

TOSTRING

構文

TOSTRING ( object )

マクロの説明

object を文字列形式で返します。