Cisco APIC REST API ユーザ ガイド
はじめに
はじめに

はじめに

この前書きは、次の項で構成されています。

このマニュアルについて

このマニュアルでは、APIC REST API を使用してコマンドおよびクエリーを作成して Application Policy Infrastructure ControllerAPIC)に送信する方法について説明します。 このマニュアルでは、一連の共通タスクに関する例が提供されますが、Cisco Application Centric InfrastructureACI)ファブリックの完全な機能セットを設定する方法については説明せず、API のクラス、メソッドまたはデータ タイプの一覧表示はありません。

対象読者

このマニュアルは、プログラミングと API の使用について背景知識を持つソフトウェア エンジニアを対象としています。 エンジニアは、XML および JSON、RESTful Web サービス API、データ システム、ネットワーキング プロトコルおよびストレージ プロトコルの知識が必要です。

表記法

コマンドの説明には、次のような表記法が使用されます。

表記法 説明
bold

太字の文字は、表示どおりにユーザが入力するコマンドおよびキーワードです。

italic

イタリック体の文字は、ユーザが値を入力する引数です。

[x]

省略可能な要素(キーワードまたは引数)は、角カッコで囲んで示しています。

[x | y]

いずれか 1 つを選択できる省略可能なキーワードや引数は、角カッコで囲み、縦棒で区切って示しています。

{x | y}

必ずいずれか 1 つを選択しなければならない必須キーワードや引数は、波カッコで囲み、縦棒で区切って示しています。

[x {y | z}]

角カッコまたは波カッコが入れ子になっている箇所は、任意または必須の要素内の任意または必須の選択肢であることを表します。 角カッコ内の波カッコと縦棒は、省略可能な要素内で選択すべき必須の要素を示しています。

variable

ユーザが値を入力する変数であることを表します。イタリック体が使用できない場合に使用されます。

string 引用符を付けない一組の文字。 string の前後には引用符を使用しません。引用符を使用すると、その引用符も含めて string とみなされます。

例では、次の表記法を使用しています。

表記法 説明
screen フォント

スイッチが表示する端末セッションおよび情報は、screen フォントで示しています。

太字の screen フォント

ユーザが入力しなければならない情報は、太字の screen フォントで示しています。

イタリック体の screen フォント

ユーザが値を指定する引数は、イタリック体の screen フォントで示しています。

< >

パスワードのように出力されない文字は、山カッコ(< >)で囲んで示しています。

[ ]

システム プロンプトに対するデフォルトの応答は、角カッコで囲んで示しています。

!、#

コードの先頭に感嘆符(!)またはポンド記号(#)がある場合には、コメント行であることを示します。

このマニュアルでは、次の表記法を使用しています。


(注)  


注釈」です。 役立つ情報やこのマニュアルに記載されていない参照資料を紹介しています。



注意    


要注意」の意味です。 機器の損傷またはデータ損失を予防するための注意事項が記述されています。



警告


安全上の重要事項

「危険」の意味です。 人身事故を予防するための注意事項が記述されています。 機器の取り扱い作業を行うときは、電気回路の危険性に注意し、一般的な事故防止対策に留意してください。 各警告の最後に記載されているステートメント番号を基に、装置に付属の安全についての警告を参照してください。

これらの注意事項を保管しておいてください。


関連資料

API のクラス、プロパティ、データ タイプの詳細な参考資料については、Web ベース アプリケーションである 『Cisco APIC Management Information Model Reference』 を参照してください。

API を使用した多くの一般的なタスクの詳細な手順については、『Cisco APIC Getting Started Guide』で確認できます。

Web ベースのマニュアル

  • 『Cisco APIC Management Information Model Reference』

  • 『Cisco APIC Online Help Reference』

  • 『Cisco ACI MIB Support List』

ダウンロード可能なマニュアル

  • 『Cisco Application Centric Infrastructure Release Notes』

  • 『Cisco Application Centric Infrastructure Fundamentals Guide』

  • 『Cisco APIC Getting Started Guide』

  • 『Cisco APIC REST API ユーザ ガイド』

  • 『Cisco APIC Command Line Interface User Guide』

  • 『Cisco APIC Faults, Events, and System Message Guide』

  • 『Cisco APIC Layer 4 to Layer 7 Device Package Development Guide』

  • 『Cisco APIC Layer 4 to Layer 7 Services Deployment Guide』

  • 『Cisco ACI Firmware Management Guide』

  • 『Cisco ACI Troubleshooting Guide』

  • 『Cisco ACI NX-OS Syslog Reference Guide』

  • 『Cisco ACI Switch Command Reference, NX-OS Release 11.0』

  • 『Cisco ACI MIB Quick Reference』

  • 『Cisco Nexus CLI to Cisco APIC Mapping Guide』

  • 『Installing the Cisco Application Virtual Switch with the Cisco APIC』

  • 『Configuring the Cisco Application Virtual Switch using the Cisco APIC』

  • 『Application Centric Infrastructure Fabric Hardware Installation Guide』

マニュアルに関するフィードバック

このマニュアルに関する技術的なフィードバック、または誤りや記載もれなどお気づきの点がございましたら、apic-docfeedback@cisco.com までご連絡ください。 ご協力をよろしくお願いいたします。

マニュアルの入手方法およびテクニカル サポート

マニュアルの入手、Cisco Bug Search Tool(BST)の使用、サービス要求の送信、追加情報の収集の詳細については、『What's New in Cisco Product Documentation』を参照してください。このドキュメントは、http:/​/​www.cisco.com/​c/​en/​us/​td/​docs/​general/​whatsnew/​whatsnew.html から入手できます。

What's New in Cisco Product Documentation』に登録します。ここには、すべての新規および改訂済みの Cisco テクニカル マニュアルが RSS フィードとして掲載されており、コンテンツはリーダー アプリケーションを使用してデスクトップに直接配信されます。 RSS フィードは無料のサービスです。