Cisco APIC REST API ユーザ ガイド
偏向のない言語
この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
翻訳について
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
- Updated:
- 2017年6月18日
章のタイトル： その他の例
その他の例
この章の内容は、次のとおりです。
- API の例に関する情報
- 例：JSON API を使用したトップ レベルのシステム要素の取得
- 例：JSON API を使用したノードに関する情報の取得
- 例：JSON API を使用した実行中のファームウェアの取得
- 例：JSON API を使用したリーフ ポート セレクタ プロファイルの追加
- 例：XML API および OwnerTag を使用した監査ログ情報のアクションへの追加
API の例に関する情報
この例では、JSON および XML 構造が読みやすいように改行、スペース、インデントで展開されています。
例：JSON API を使用したトップ レベルのシステム要素の取得
次に、存在するシステム デバイスを判断するために APIC を照会する例を示します。
システム要素（APIC、スパイン、およびリーフ）に関する一般情報は、クラス top:System のオブジェクトに含まれています。
次に、API クエリー メッセージの例を示します。
GET http://192.0.20.123/api/class/topSystem.json
正常な動作時には次のような応答本文が返されます。
{
"imdata" :
[{
"topSystem" : {
"attributes" : {
"instanceId" : "0:0",
"address" : "10.0.0.32",
"childAction" : "",
"currentTime" : "2013-06-14T04:13:05.584",
"currentTimeZone" : "",
"dn" : "topology/pod-1/node-17/sys",
"fabricId" : "0",
"id" : "17",
"inbMgmtAddr" : "0.0.0.0",
"lcOwn" : "local",
"mode" : "unspecified",
"name" : "leaf0",
"nodeId" : "0",
"oobMgmtAddr" : "0.0.0.0",
"podId" : "1",
"replTs" : "never",
"role" : "leaf",
"serial" : "FOX-270308",
"status" : "",
"systemUpTime" : "00:00:02:03"
}
}
}, {
"topSystem" : {
"attributes" : {
"instanceId" : "0:0",
"address" : "10.0.0.1",
"childAction" : "",
"currentTime" : "2013-06-14T04:13:29.301",
"currentTimeZone" : "PDT",
"dn" : "topology/pod-1/node-1/sys",
"fabricId" : "0",
"id" : "1",
"inbMgmtAddr" : "0.0.0.0",
"lcOwn" : "local",
"mode" : "unspecified",
"name" : "apic0",
"nodeId" : "0",
"oobMgmtAddr" : "0.0.0.0",
"podId" : "0",
"replTs" : "never",
"role" : "apic",
"serial" : "",
"status" : "",
"systemUpTime" : "00:00:02:26"
}
}
}
]
}
この応答は、システムが 1 つの APIC（ノード 1）と 1 つのリーフ（ノード 17）で構成されることを示します。
例：JSON API を使用したノードに関する情報の取得
次に、システムのノードにアクセスするために APIC を照会する例を示します。
ファブリックの特定のノード デバイスに API 操作を指示するために、リソースのパスは /mo/topology/pod-number/node-number/sys/ とその後に続くノード コンポーネントで構成されます。たとえば、この URI はノード 1 のシャーシ スロット B のボード センサー 3 にアクセスします。
GET http://192.0.20.123/api/mo/topology/pod-1/node-1/sys/ch/bslot/board/sensor-3.json
正常な動作時には次のような応答本文が返されます。
{
"imdata" :
[{
"eqptSensor" : {
"attributes" : {
"instanceId" : "0:0",
"childAction" : "",
"dn" : "topology/pod-1/node-1/sys/ch/bslot/board/sensor-3",
"id" : "3",
"majorThresh" : "0",
"mfgTm" : "not-applicable",
"minorThresh" : "0",
"model" : "",
"monPolDn" : "",
"rev" : "0",
"ser" : "",
"status" : "",
"type" : "dimm",
"vendor" : "Cisco Systems, Inc."
}
}
}
]
}
例：JSON API を使用した実行中のファームウェアの取得
次に、実行中のファームウェア イメージを判断するために APIC を照会する例を示します。
実行中のファームウェアの詳細情報は、APIC ファームウェアのステータス コンテナ クラス firmware:IfcFwStatusCont の子クラス（サブツリー）であるクラスのオブジェクト firmware:IfcRunning に含まれています。実行中のファームウェア インスタンスが複数存在する場合があるので（APIC インスタンス 1 つにつき 1 個）、コンテナ クラスを照会し、実行中のファームウェア オブジェクトのサブツリーの応答をフィルタリングできます。
次に、API クエリー メッセージの例を示します。
GET http://192.0.20.123/api/class/firmwareIfcFwStatusCont.json?
query-target=subtree
&
target-subtree-class=firmwareIfcRunning
正常な動作時には次のような応答本文が返されます。
{
"imdata" : [{
"firmwareIfcRunning" : {
"attributes" : {
"instanceId" : "0:0",
"applId" : "3",
"childAction" : "",
"dn" : "ifcfwstatuscont/ifcrunning-3",
"lcOwn" : "local",
"replTs" : "never",
"rn" : "",
"status" : "",
"ts" : "2012-12-31T16:00:00.000",
"type" : "ifc",
"version" : "1.1"
}
}
}, {
"firmwareIfcRunning" : {
"attributes" : {
"instanceId" : "0:0",
"applId" : "1",
"childAction" : "",
"dn" : "ifcfwstatuscont/ifcrunning-1",
"lcOwn" : "local",
"replTs" : "never",
"rn" : "",
"status" : "",
"ts" : "2012-12-31T16:00:00.000",
"type" : "ifc",
"version" : "1.1"
}
}
}, {
"firmwareIfcRunning" : {
"attributes" : {
"instanceId" : "0:0",
"applId" : "2",
"childAction" : "",
"dn" : "ifcfwstatuscont/ifcrunning-2",
"lcOwn" : "local",
"replTs" : "never",
"rn" : "",
"status" : "",
"ts" : "2012-12-31T16:00:00.000",
"type" : "ifc",
"version" : "1.1"
}
}
}
]
}
この応答は、APIC ファームウェア バージョン 1.1 の 3 つの実行中のインスタンスについて記述しています。
例：JSON API を使用したリーフ ポート セレクタ プロファイルの追加
次に、リーフ ポート セレクタ プロファイルを追加する例を示します。
『Cisco APIC Management Information Model Reference』 に示すように、このクラスの階層はリーフ ポート セレクタ プロファイルを形成します。
-
fabric:LePortP：リーフ ポート プロファイルは、このクラスの管理対象オブジェクト（MO）で表され、uni/fabric/leportp-[name] の識別名（DN）形式（leportp-[name] は相対名（RN））を持ちます。リーフ ポート プロファイル オブジェクトは、子オブジェクトとしてリーフ ポート セレクタを含むことができるテンプレートです。
新しいリーフ ポート セレクタ プロファイル MO を作成する API コマンドは、子 MO を作成および設定することもできます。
この例は、「MyLPSelectorProf」という名前のリーフ ポート セレクタ プロファイルを作成します。例のプロファイルには、リーフ スイッチ 1 のリーフ ポート 1 を選択し、リーフ スイッチ 1 のリーフ ポート 3 から 5 を選択する「MySelectorName」という名前のセレクタが含まれます。新しいプロファイルを作成および設定するには、この HTTP POST メッセージを送信します。
POST http://192.0.20.123/api/mo/uni/fabric/leportp-MyLPSelectorProf.json
{
"fabricLePortP" : {
"attributes" : {
"descr" : "Selects leaf ports 1/1 and 1/3-5"
},
"children" : [{
"fabricLFPortS" : {
"attributes" : {
"name" : "MySelectorName",
"type" : "range"
},
"children" : [{
"fabricPortBlk" : {
"attributes" : {
"fromCard" : "1",
"toCard" : "1",
"fromPort" : "1",
"toPort" : "1",
"name" : "block2"
}
}
}, {
"fabricPortBlk" : {
"attributes" : {
"fromCard" : "1",
"toCard" : "1",
"fromPort" : "3",
"toPort" : "5",
"name" : "block3"
}
}
}
]
}
}
]
}
}
正常な動作時には次の応答本文が返されます。
{
"imdata" : [{
"fabricLePortP" : {
"attributes" : {
"instanceId" : "0:0",
"childAction" : "deleteNonPresent",
"descr" : "Select leaf ports 1/1 and 1/3-5",
"dn" : "uni/fabric/leportp-MyLPSelectorProf",
"lcOwn" : "local",
"name" : "MyLPSelectorProf",
"replTs" : "never",
"rn" : "",
"status" : "created"
},
"children" : [{
"fabricLFPortS" : {
"attributes" : {
"instanceId" : "0:0",
"childAction" : "deleteNonPresent",
"dn" : "",
"lcOwn" : "local",
"name" : "MySelectorName",
"replTs" : "never",
"rn" : "lefabports-MySelectorName-typ-range",
"status" : "created",
"type" : "range"
},
"children" : [{
"fabricPortBlk" : {
"attributes" : {
"instanceId" : "0:0",
"childAction" : "deleteNonPresent",
"dn" : "",
"fromCard" : "1",
"fromPort" : "3",
"lcOwn" : "local",
"name" : "block3",
"replTs" : "never",
"rn" : "portblk-block3",
"status" : "created",
"toCard" : "1",
"toPort" : "5"
}
}
}, {
"fabricPortBlk" : {
"attributes" : {
"instanceId" : "0:0",
"childAction" : "deleteNonPresent",
"dn" : "",
"fromCard" : "1",
"fromPort" : "1",
"lcOwn" : "local",
"name" : "block2",
"replTs" : "never",
"rn" : "portblk-block2",
"status" : "created",
"toCard" : "1",
"toPort" : "1"
}
}
}
]
}
}
]
}
}
]
}
新しいプロファイルを削除するには、次の例のように、"status":"deleted" の fabricLePortP 属性を持つ HTTP POST メッセージを送信します。
POST http://192.0.20.123/api/mo/uni/fabric/leportp-MyLPSelectorProf.json
{
"fabricLePortP" : {
"attributes" : {
"status" : "deleted"
}
}
}
または、この HTTP DELETE メッセージを送信できます。
DELETE http://192.0.20.123/api/mo/uni/fabric/leportp-MyLPSelectorProf.json
例：XML API および OwnerTag を使用した監査ログ情報のアクションへの追加
この例は、オブジェクトが作成または変更されたときに ownerTag または ownerKey プロパティを使用して、カスタム監査ログ情報を追加する方法を示しています。
すべての設定可能なオブジェクトには、ownerTag および ownerKey が含まれており、これらはユーザ設定可能な文字列プロパティです。設定可能なオブジェクトがユーザ アクションにより作成または変更されたとき、監査ログ レコード オブジェクト（aaa:ModLR）は、監査ログに報告される変更に関する情報を含めるように自動的に作成されます。監査ログ レコード オブジェクトには、アクションにより変更された設定されたオブジェクトのプロパティのリスト（changeSet プロパティ）が含まれます。設定可能なオブジェクトを作成または変更するコマンドで、設定可能なオブジェクトの ownerTag または ownerKey プロパティへの変更を実施する人のジョブ チケット番号または名前などの、独自の追跡情報を追加できます。この追跡情報は変更の詳細とともに監査ログ レコード内に取り込まれます。
 （注） |
ownerTag 情報は、ownerTag の内容が変更されたときにのみログに表示されます。後続の設定変更が同じ情報を含めるには、次の設定変更を行う前に、ownerTag の内容をクリアできます。この状態は ownerKey のプロパティにも適用されます。 |
次の例では、ドメイン参照がテナント設定に追加されます。コマンドの一部として、オペレータの名前は ownerKey として入力され、ジョブ番号は ownerTag として入力されます。
POST https://192.0.20.123/api/mo/uni/tn-ExampleCorp.xml
<fvTenant name=“ExampleCorp" ownerKey=“georgewa" ownerTag=“chg:00033">
<aaaDomainRef name=“ExampleDomain" ownerKey=“georgewa" ownerTag="chg:00033"/>
</fvTenant>
この例では、2 つの aaa:ModLR レコードが生成されます。1 つは fv:Tenant オブジェクト用、1 つは aaa:DomainRef オブジェクト用です。ownerKey または ownerTag プロパティが以前の設定から変更されない限り、新しい値は aaa:ModLR レコードの changeSet リストに表示され、この情報はこの設定変更がレポートされる監査ログ レコードに表示されます。
フィードバック