サマリへのコンテンツの追加

キーと値

summary [‘NXOS Version’] = ‘8.1(0)’

メッセージ – 推論

summary.add_message (“Simple message”)

（注）	DCNM 11.4(1) では、DCNM はサマリの値として JSON オブジェクトをサポートしていません。次の例はサポートされていません。 summary[“info”] = {“key”:”value”,”key-2”:”value-2”}

サマリのテーブル

table = summary.add_table(title,_id)

• title：テーブルのタイトル

• _id : テーブルの一意の識別子

テーブルへの行の追加

table.append(value, _id)

• value：JSON オブジェクトです。ネストされた JSON はサポートされません。

• _id : テーブルの一意の識別子

例：

table.append({'column1': 'value1',’column2’:’value2’},” FOX1816G0S9”)

セクションへのコンテンツの追加

キーと値

以下に示すように、単純なキーと値のペアをセクションに追加できます。

section[‘key’] = ‘value’

JSON ドキュメント – カード

任意のキーと値のペアと同じように、単一の JSON ドキュメントを追加できます。ネストされた JSON は 11.4(1) ではサポートされていません

section[‘key’] = {‘key’:’value’,’key-2’:’value’}

JSON ドキュメントは、次のようにカード ウィジェットに表示されます。

JSON ドキュメントの配列 – テーブル

section.append API を使用すると、ユーザはテーブルを作成し、行を追加できます（次の制限が付きます）。

1. すべての JSON ドキュメントには同じキーのセットが必要です

2. ネストされた JSON はサポートされません

section.append(key, dictionary, _id)

_id：テーブルの行を一意に識別する一意の識別子。_id が重複すると、一意の id 違反エラーが発生します。

例：

section.append('Switch Details', {'name': 'N5K'},'DSDAS244455')
section.append('Switch Details', {'name': 'N6K'}, 'CSDAS244456')
section.append('Switch Details', {'name': 'N7K'}, 'ASDAS244457')

サマリへのチャートの追加

report = Report(“title”)
summary = report.add_summary()
summary.add_chart(ChartType, _id)

• ChartType: ChartTypes.COLUMN_CHART, ChartTypes.PIE_CHART, ChartTypes.LINE_CHART.

• _id：チャートの一意の ID

セクションへのグラフの追加

report = Report(“title”)
section = report.add_section(“Section title”,_id)
section.add_chart(ChartType, _id)

• ChartType: ChartTypes.COLUMN_CHART, ChartTypes.PIE_CHART, ChartTypes.LINE_CHART

• _id：チャートの一意の ID

円グラフ

pie_chart.set_title("Chart title")
pie_chart.set_subtitle(“Sub title”)

付加価値を加えてください。

pie_chart.add_value("key",value)

• キー：文字列キー

• 値：数字の値

縦棒グラフ

設定とサブタイトルのタイトル

column_chart.set_title("Chart title")
column_chart.set_subtitle(“Sub title”)

X 軸と Y 軸のタイトルを設定する

column_chart.set_xAxis_title("X-Axis title")
column_chart.set_yAxis_title("y-Axis title")

値の追加

bar_chart.add_value("key",value,category)

• キー：文字列キー

• 値：数字の値

• カテゴリ：棒グラフは、データを「カテゴリ」と呼ばれる論理グループに分割します。指定されたキーには、各カテゴリの値が必要です。

たとえば、デバイス数がキーで、ファブリック名がカテゴリです。チャートには、ファブリックごと、つまりカテゴリごとにデバイス数が含まれている必要があります。

折れ線グラフ

設定とサブタイトルのタイトル

line_chart.set_title("Chart title")
line_chart.set_subtitle(“Sub title”)

X 軸と Y 軸のタイトルを設定する

line_chart.set_xAxis_title("X-Axis title")
line_chart.set_yAxis_title("y-Axis title")

値の追加

line_chart.add_value("key",value,category) 

• キー：文字列キー

• 値：数字の値

• カテゴリ：折れ線グラフは、データをカテゴリと呼ばれる論理グループに分割します。指定されたキーには、各カテゴリの値が必要です。

たとえば、デバイス数がキーで、ファブリック名がカテゴリです。チャートには、ファブリックごと、つまりカテゴリごとにデバイス数が含まれている必要があります。

コマンドの表示

from reportlib.preport import show
cli_responses = show (serial_number ,*commands)

• serial_number：コマンドを実行するデバイスのシリアル番号。VDC の場合、シリアル番号は serial_number:vdc_name である必要があります。シリアル番号のリストを渡して、複数のデバイスで同じコマンド セットを実行できます。

• *commands：デバイスで実行するコマンド。可変引数です。複数のコマンドを指定できます。

例：

• 単一のスイッチでコマンドを実行する：

  cli_responses = show(“FOX1816G0S9”,'show version | xml', 'show inventory | xml', 'show license usage | xml')

• 複数のスイッチでコマンドを実行する：

  cli_responses = show( [“FOX1816G0S9”,”SSI15470HJ5”],'show version | xml', 'show inventory | xml', 'show license usage | xml')

コマンドの表示と応答の保存

from reportlib.preport import show_and_store
cli_responses = show_and_store(report,serial_number,*commands)

report：レポート オブジェクトが作成されました。

serial_number：コマンドを実行するデバイスのシリアル番号。VDC の場合、シリアル番号は serial_number:vdc_name である必要があります。シリアル番号のリストを渡して、複数のデバイスで同じコマンド セットを実行できます。

*commands：デバイスで実行するコマンド。可変引数です。複数のコマンドを指定できます。

例：

• 単一のスイッチでコマンドを実行する：

  cli_responses = show_and_store(report, “FOX1816G0S9”, 'show version | xml', 'show inventory | xml', 'show license usage | xml')

• 複数のスイッチでコマンドを実行する：

  cli_responses = show_and_store(report, [“FOX1816G0S9”,”SSI15470HJ5”], 'show version | xml', 'show inventory | xml', 'show license usage | xml')

注意：この API は、デバイスからの応答をレポートとともに elasticsearch に保存します。すべての応答を保存するとストレージが大幅に増加する可能性があるため、ユーザはこの API を使用する際に注意する必要があります。

戻り値

戻り値 API は応答のリストを返し、各応答は次の構造を持つディクショナリです。

{
	'status': 'success' | 'failed,
	'response':<response from device>,
	'command':<cli command>,
	'serial_number': <device serial number>
}

複数のスイッチの場合、応答はスイッチごとのエントリを含む応答のリストです。

[
{
	'status': 'success',
	'response':<response from device>,
	'command':’show version’,
	'serial_number': ‘FOX1816G0S9’
},
{
	'status': 'success',
	'response':<response from device>,
	'command':’show version’,
	'serial_number': ‘SSI15470HJ5
}
]

APP からジョブをスケジュールしているときに選択された繰り返しを取得します

get_recurrence(context)

この API は、ジョブの作成中に選択された繰り返しを返します。戻り値は、NOW、ONCE、DAILY、WEEKLY、MONTHLY、ONDEMAND、および PERIODIC です。

get_period

ジョブが定期的にスケジュールされている場合、API を使用して期間情報にアクセスできます。

period = get_period(context) 
period.get_period() will return the period 
period.get_time_unit() will return time Unit (HOURS, MINUTES)

以前に生成されたレポートの取得

「get_previous_reports()」メソッドを使用すると、過去に生成されたレポートを取得できます。これは、現在のデータと履歴データに基づいて分析を実行するために使用できます。この API は、作成された時間の降順でレポートを返します。

List of reports = get_previous_reports (context,entity,count)

この API は、レポートのリストを返します。

コンテキスト：generateReport(context) メソッドから入力として受け取ったオブジェクト

エンティティ：serial_number またはファブリック名

カウント：取得するレポートの数

最も古いレポートを取得

oldest_report = get_oldest_report(context,entity)

コンテキスト：generateReport(context) メソッドから入力として受け取ったオブジェクト

エンティティ：serial_number またはファブリック名

上記の API はどちらも、情報を取得するために次の API を使用して Report オブジェクトを返します。

1. 概要を取得する：report.get_summary()

2. セクションの取得：report.get_section(_id)

report.get_section(_id)

_id：セクションの一意の識別子

XML ツリーを取得

from reportlib.preport import getxmltree
xml_element_tree = getxmltree(xml_string,tag)

この API は、指定されたタグの下にある XML ツリーを返します。

xml_string：デバイスからの XML 応答。

タグ：XML タグ。このタグの下の完全な XML は、ElementTree として返されます。

xml_element_tree：この API は xml.etree.ElementTree オブジェクトを返します。

XML 行を取得する

CLI 応答に行がある場合、getxmlrows API を使用して行の配列を取得できます。

from reportlib.preport import getxmlrows
rows = getxmlrows(xml_tree,tag_xpath)

xml_tree：xml.etree.ElementTree オブジェクト

tag_xpath：XML レコードの xpath。詳細については、https://docs.python.org/2/library/xml.etree.elementtree.html#xpath-support を参照してください。

行：行の配列

ノード値を取得

XML ノード値は、getnodevalue API を使用して読み取ることができます。この API は、プリミティブ型のノード値を取得するために使用する必要があります。

from reportlib.preport import getnodevalue
value = getnodevalue(xml_tree,node_xpath)

ノードが存在するかどうかを確認する

from reportlib.preport import has_tag
has_tag(xml_tree,tag)

この API は、指定されたタグが XML ツリーに存在するかどうかに基づいて true または false を返します。