Cisco Prime Performance Manager 1.4 統合開発者ガイド
XML リファレンス
XML リファレンス
発行日;2013/11/09 | 英語版ドキュメント(2013/07/31 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 1MB) | フィードバック

目次

XML リファレンス

XML 要素

AggregatedDBSummary

Bytes

Column

Criteria

CSV

Filter

DecimalPrecision

graphsPerRow

graphsToMerge

GraphView

IpAddr

IdLabel

LeafGraph

Link

PollDefinition

PollerList

Poll

ProcessDBSummary

ProcessPollResult

TableView

Util

WebReport

XML タグ

XML リファレンス

この章では、Prime Performance Manager レポートで使用される XML 要素およびタグに関する情報を示します。次の内容について説明します。

「XML 要素」

「XML タグ」

XML 要素

次のトピックで、Prime Performance Manager レポートで使用される XML 要素を説明します。

「AggregatedDBSummary」

「Bytes」

「Column」

「Criteria」

「CSV」

「DecimalPrecision」

「graphsPerRow」

「graphsToMerge」

「GraphView」

「IpAddr」

「IdLabel」

「LeafGraph」

「Link」

「PollDefinition」

「PollerList」

「Poll」

「ProcessDBSummary」

「ProcessPollResult」

「TableView」

「Util」

「WebReport」

AggregatedDBSummary

AggregatedDBSummary タグは ProcessDBSummary で使用可能な値を集約するために使用されます。これらは、主にグループ レポートに使用されます。

Bytes

Bytes タグは Table ビューおよび Graph ビューで値を B/KB/MB/GB 形式で表示するために使用できます。これらはサイズに関連するパラメータに主に使用されます。

Column

Column 要素は CSV、Graph ビュー、および Table ビュー セクションに含まれており、CSV レポートに表示される列のヘッダーおよび表の列を指定します。

Criteria

Criteria 要素は SystemCapability.xml ファイルおよび UserCapability.xml ファイルで定義したレポートで使用される MIB 機能を指定します。

Criteria 要素は、Poll 要素の範囲内、および WebReport 要素の範囲内で使用できます。

CSV

CSV 要素には、CSV レポートのフォーマットおよび内容を指定する要素および属性が含まれます。ユーザが CSV レポート形式を選択すると、この指定に従って CSV レポートがファイルに保存されます。

CSV 要素には次の要素が含まれます。

Column

Bits

Bytes

Util

IpAddr

Time

Filter

特定のキー値をフィルタリングしてその特定のレポートだけを表示するために、WebReports 内で Filter タグを使用できます。

DecimalPrecision

Graph ビューおよび Table ビューに 10 進数精度を設定します。たとえば、decimalPrecision =3 は小数点以下桁数を 3 として設定し、たとえば 1500.231 や 12.369 となります。Prime Performance Manager のレポートに表示される 10 進数精度のレベルは大きめの値で、decimalPrecision 要素またはユーザ設定内のユーザによって指定されます。

Graph ビューおよび Table ビュー セクションの例:

<GraphView>

<GraphSummary title="vpnErrorPercentage" />
<Graph title="vpnAvgSendErrorPercentage">
<Util name="sendErrorPercentage" decimalPrecision = "3">txErrorPercent</Util>
</Graph>
<Graph title="vpnAvgRecvErrorPercentage">
<Util name="recvErrorPercentage" decimalPrecision = "3">rxErrorPercent</Util>
</Graph>
<LeafGraph title="vpnAvgSendRecvErrorPercentage">
<Util name="vpnAvgSendErrorPercentage" decimalPrecision = "3">txErrorPercent</Util>
<Util name="vpnAvgRecvErrorPercentage" decimalPrecision = "3">rxErrorPercent</Util>
</LeafGraph>
</GraphView>
 
<TableView baseTable="L3VPN">
<IdLabel/>
<Label colSpan="1" name=""/>
<Label colSpan="3" name="send"/>
<Label colSpan="3" name="receive"/>
<HeaderRow/>
<Link name="node" context="Node">fqdnid</Link>
<Link name="vrfName" context="vrfName">vrfName</Link>
<Link name="interface" context="l3vpnIfDescr">l3vpnIfDescr</Link>
<Time/>
<Column name="type">ifType.mibEnum()</Column>
<Column name="goodPackets" decimalPrecision = "3">txTotPkts</Column>
<Column name="errors" decimalPrecision = "3">txErrors</Column>
<Util default="true" name="errorPercentage" decimalPrecision = "3">txErrorPercent</Util>
<Column name="goodPackets" decimalPrecision = "3">rxTotPkts</Column>
<Column name="errors" decimalPrecision = "3">rxErrors</Column>
<Util name="errorPercentage" decimalPrecision = "3">rxErrorPercent</Util>
</TableView>

graphsPerRow

graphsPerRow 属性は Graph ビューのタグの中でその行に表示されるグラフの数に対して定義されます。これらは、主にダッシュボード レポートで使用されます。

graphsToMerge

graphsToMerge 属性は Graph ビューのタグの中で結合して表示されるグラフの数に対して定義されます。これは、主にダッシュボード レポートで使用されます。

GraphView

レポートのグラフ ビューで使用されるグラフおよびサブ グラフを指定します。次の要素が含まれます。

Column

Graph

GraphSummary

LeafGraph

IpAddr

IP アドレスを指定します。Column 要素で使用されます。

IdLabel

Column 要素で使用されます。

LeafGraph

LeafGraph の属性を指定します。LeafGraph は、複数の値を 1 つのグラフで表示します。GraphView 要素で使用されます。

Link

リンクを指定します。TableView セクションで使用されます。

PollDefinition

PollDefinition セクションは、レポート用にポーリングする MIB 変数を指定します。また、ポーリングのフィルタリングに使用されるレポート マクロを呼び出すこともできます。

PollerList

PollerList 要素は、report.xml ファイルの主要要素です。これにより、他のすべての要素がカプセル化されます。

Poll

Poll 要素は次の主要レポート要素を指定します。

Criteria

PollDefinition

ProcessPollResult

ProcessDBSummary

ProcessDBSummary

ProcessDBSummary には、レポート データをメモリに保持するために使用される仮想テーブルを構築するコードが含まれます。定義されたレポート期間が終了するたびに、テーブル データがゲートウェイ上の物理データベースに書き込まれます。

ProcessPollResult

ProcessPollResult セクションには、MIB データの処理方法を指定するコードが含まれます。

TableView

TableView 要素は、テーブル レポート ビューで使用される内容とテキストを指定します。TableView 要素には次の要素が含まれます。

Column

Label

Link

Util

Byte

Util

平均などの値を計算するユーティリティを指定します。GraphView 要素または TableView 要素で使用します。

WebReport

WebReport 要素は、Table ビューと同じようにの Graph ビューで使用される要素と文字列を指定します。WebReport のセクションには、GraphView および TableView が含まれます。

XML タグ

表 8-1 に Prime Performance Manager レポートで使用する XML タグを示します。ほとんどのタグは、レポート内のデフォルトの動作を指定します。ユーザが [Override Report Definitions] オプションを有効にしないかぎり、これらの値によって [Prime Performance Manager User Preferences] ウィンドウで設定した環境設定が上書きされます。ユーザ設定の情報については、『 Cisco Prime Performance Manager 1.4 User Guide 』の「Setting User Preferences」を参照してください。

 

表 8-1 XML タグ

タグ
説明

colNameGraphPrefix

TableView のセクションに含まれています。colNameGraphPrefix=true の場合、列の値がスロット 1 CPU 2 などのグラフ タイトルに追加されます。false に設定されている場合(デフォルト)、グラフ タイトルは 1 | 2 です。このタグは、IPSLA、CPU、メモリ、およびその他のレポートなどに有用な記述子に必要なインデックス整数に役立ちます。例:

<TableView baseTable="IPSLA_JITTER">
<IdLabel/>
<Label colSpan="1" name="responseTime" />
<Label colSpan="1" name="jitter" />
<Label colSpan="1" name="packetLoss" />
<Label colSpan="1" name="reachability" />
 
<HeaderRow/>
<Link name="node" context="Node">fqdnid</Link>
<Link name="target" context="TargetAddress" colNameGraphPrefix="true">TargetAddress</Link>
<Link name="owner" context="IPSLAOwner" colNameGraphPrefix="true">IPSLAOwner</Link>
<Link name="tag" context="IPSLATag" colNameGraphPrefix="true">IPSLATag</Link>
<Link name="type"
context="IPSLARTTType" hideSummary="true">IPSLARTTType</Link>
<Link name="index"
context="IPSLAIndex" colNameGraphPrefix="true">IPSLAIndex</Link>
<Time/>
 
<Column default="true" name="millisecs">ResponseTimeAvg</Column>
<Column name="millisecs">(JitterPosSDAvg + JitterNegSDAvg + JitterPosDSAvg + JitterNegDSAvg) / 4</Column>
<Util name="percentage">PacketLossOverallUtilAvg</Util>
<Util name="percentage" tcaRising="false">TargetReachabilityUtilAvg</Util>
</TableView>

CsvPoll

値が SNMP 経由でないファイルから読み取る必要があることを指定します。例:

ApnBearersStatsTable = CsvPoll("apn",
"integer:auth-req-sent,
integer:auth-acc-rcvd,
integer:auth-timeout,
integer:acc-req-sent,
integer:acc-rsp-rcvd,
integer:acc-req-timeout,
integer:act-defbear,
integer:act-dedbear,
integer:setup-defbear,
integer:setup-dedbear,
integer:rel-defbear,
integer:rel-dedbear,
integer:rel-fail-defbear,
integer:rel-fail-dedbear,
integer:rej-defbear,
integer:rej-dedbear,
integer:mod-uebear,
integer:mod-nwbear,
integer:ue-init-modfail,
integer:nw-init-modfail",
"string:vpnname,
integer:vpnid,
string:apn");

descending

どのメトリック方向が良いか悪いかを指定することで tcaRising と同じ方法で機能します。これはテーブル内のソートおよびテーブルの色付けに使用されます。descending="false" の場合、値は降順ではなく昇順でソートされます。descending= "true" がテーブルのデフォルトです。

downColors

下降率などのメトリックが適用されます。計算は降順/可用性のユーザ設定に似ています。ここでは、表示される色が値そのままではなく値から 1 を引いた値かどうかが選択された値によって決定されます。たとえば、1 % 以上の時間インターフェイスがダウンしている場合にこれが識別される必要があります。しかし、降順メトリックは稼働時間ではなくダウン タイムを測定するため、使用できません。

このフラグは、true に設定されている場合は、色が式 <value 1> を使用して表示される必要があることを示します。

hideAvg

hideAvg=true の場合、グラフのサマリー テーブル内の平均値および凡例は、ユーザ設定に関係なく、表示されません。hideAvg=false の場合、ユーザ設定が後ろに続きます。hideAvg は Graph の行になります。showTotal に例を示します。

hideLegend

サマリーテーブル内の列のインデックス列を表示中に、チャートおよびグラフ サブ タイトル内の長い複雑なインデックスを削除するためにレポート XML インデックス列に追加できます。IPSLA および ClassMap レポートのいくつかは、ほとんど変化しないか人工的な値がほとんどないインデックス整数のため、MIB インデックスすべてを表示する必要のない例です。hideLegend=true で始まるレポートのコンポーネントはグラフの凡例に表示されません。このタグは、レポート、ダッシュボード、ビュー、および StarGraphs に適用されます。例については、hideSummary 参照してください。

hideMax

hideMax=true の場合、グラフのサマリー テーブル内の最大値および凡例は、ユーザ設定に関係なく、表示されません。hideMax=false の場合、ユーザ設定が後ろに続きます。hideMax は Graph の行になります。showTotal に例を示します。

hideMin

hideMin=true の場合、グラフのサマリー テーブル内の最少値および凡例は、ユーザ設定に関係なく、表示されません。hideMin=false の場合、ユーザ設定が後ろに続きます。hideMin は Graph の行になります。showTotal に例を示します。

hideSummary

hideLegend と同じ機能を実行しますが、サマリー テーブルが含まれます。hideSummary=true の場合、サマリー テーブル内の平均値およびグラフの凡例は、ユーザ設定に関係なく、表示されません。hideSummary=false の場合、ユーザ設定が後ろに続きます。

hideLegend および hideSummary は Link の行に表示されます。例:

<Link name="index" context="IPSLAIndex" hideLegend="true" colNameGraphPrefix="true">IPSLAIndex</Link>
<Link name="type" context="IPSLARTTType" hideSummary="true">IPSLARTTType</Link>

LastFlapTime_UNIXFormat

UNIX または POSIX 時間内のレポート時間を表示します。GUI レポートの例:

<ProcessPollResult>
lastFlapTime_UNIXFormat = ccsCmFlapLastFlapTime.dateAndTime("UNIX_FORMAT");
</ProcessPollResult>
 
<ProcessDBSummary baseTableName="CMTS_CM_State_HOT">
<Var name="LastFlapTime_UNIXFormat" type="Long">lastFlapTime_UNIXFormat</Var>
</ProcessDBSummary>
 
<TableView baseTable="CMTS_CM_State_HOT">
<Time name="LastFlapTime_UNIXFormat" key="true">LastFlapTime_UNIXFormat</Time>
</TableView>
 

CSV レポートの例:

<CSV name="CMTS_CM_State_HOT" location="gateway" listen="CMTS_CM_State_HOT">
<Time name="LastFlapTime_UNIXFormat" key="true">LastFlapTime_UNIXFormat</Time>
</CSV>

nocolor

Prime Performance Manager では、ユーザ設定で定義された使用率しきい値に対応して使用率の値を赤、オレンジ、および緑で表示することができます。このタグでその設定を上書きし、指定した使用率の値を常に黒いフォントで表示したりサマリー テーブルの背景色を非表示にすることができます。nocolor=true の場合、ユーザの赤、緑、およびオレンジの使用率の色設定は無視され、データは黒のフォントで表示されます。このタグが適用される可能性がある使用率の値の例は、次のとおりです。

エラー率

廃棄率

バッファ ミスの割合

ReferenceLine

Graph セクションに追加され、ユーザ定義の SLA またはその他のカスタム参照行をチャートに追加できます。例:

<Graph>

<ReferenceLine name="test" value="102" color="#FF0000" opacity="0.2"/>

</Graph>

Color のデフォルトは #000000 に設定され、opacity のデフォルトは 0.5 に設定されています。名前と値は必須です。

(注) IE 8 は opacity パラメータをサポートしません。

showCurrent

showCurrent=true の場合、グラフのサマリー テーブル内の現在の値および凡例は、ユーザ設定に関係なく、表示されます。showCurrent=false の場合、ユーザ設定が後ろに続きます。showCurrent は Graph の行になります。showTotal に例を示します。

showMax

showMax=true の場合、グラフのサマリー テーブル内の最大値および凡例は、ユーザ設定に関係なく、表示されます。showMax=false の場合、ユーザ設定が後ろに続きます。showMax は Graph の行になります。showTotal に例を示します。

showTotal

showTotal=true の場合、グラフのサマリー テーブル内の合計値および凡例は、ユーザ設定に関係なく、常に表示されます。showTotal=false の場合、ユーザ設定が後ろに続きます。

hideMin、hideMax、showMax、hideAvg、showCurrent、showMax、showTotal はすべて Graph の行になります。次に、例を示します。

<Graph title="gtCPUUtil1MinAvg" hideMin="false" showCurrent="true" showMax="true" hideAvg="false">
<Graph title="gtCPUUserUtil" hideMax="true">
<Graph title="gtCPUUtil1MinAvg" hideMin="false" showCurrent="true" showMax="true" hideAvg="false">

tcaRising

thresholdable フィールドでは、負の KPI 値が上昇か下降かを指定します。たとえば、使用率が上昇し可用性が下降する場合は負の値です。tcaRising=true(デフォルト)の場合、フィールド KPI は上昇しています。tcaRising=false の場合、KPI は下降しています。どの LeafGraph フィールドにも tcaRising 属性を使用できません。thresholdable フィールドの詳細については、「しきい値設定可能フィールドを使用したレポートの作成」を参照してください。

thresholdable

ユーザがデータ値のしきい値を作成できるかどうかを指定します。thresholdable=true の場合、ユーザはデータ値に対するしきい値を作成できます。thresholdable=false の場合、ユーザはしきい値を作成できません。

tcaRising および thresholdable の両方とも GraphView または TableView セクションのいずれかの内側の Value フィールドに記述されます。次に、例を示します。

<Util name="percentage" descending="false" tcaRising="false">TargetReachabilityUtilAvg</Util>
<Column name="voltage" thresholdable="false">ciscoEnvMonVoltageStatusValue</Column>

XmlPoll

SSH/Telnet を介してポーリングをプッシュすることを XML ポーラーに指示します。例:

bgpSummaryTable = XmlPoll("bgpStats",
"bgpStats.bgpSummaryIos",
"",
"integer:tableVersion,
integer:rpkiValid,
integer:rpkiNotFound,
integer:rpkiInvalid",
"",
false,
"bgpIpv4SummaryTable");