この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。
このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。
この章の内容は、次のとおりです。
記述表題の下で、例はそれぞれ次のセクションから構成されます。
例を使用するときの目的。
例を機能させるために必要な条件。
REST API を渡すための REST URL。
例で使用されるオブジェクトとメソッド、表示される入力変数。
入力コードのサンプル。
例を実行するときは、変更内容を含める必要がある場合があることに注意してください。
関連する例
このマニュアルは、Cisco IMC Supervisor で使用するサーバ側のスクリプト ソリューションである REST API を使用する際に役立つ例のコレクションです。手順書と同様に、少なくとも 3 つの方法でこのマニュアルを使用できます。
記載されているとおりに例に従うことで(もちろん使用する変数に置き換えて)、従う手順のすべてを把握していなくてもタスクを完了することができます。
テンプレートとして例を使用し、ワーク内の同様のタスクに適合させることができます。
例を検討することで、REST API で「どのようなことが行われるか」について把握でき、スクリプトを作成する必要があるその他のタスクでの異なるメソッドの使用について概要を把握できます。
例は、一般的な使用例を説明するために選択されています。その目的はこれらの 3 つのすべての方法で円滑に使用できるようにすることです。
(注) | API は、HTTP POST と GET のどちらかを使用します。次の例では、すべての READ API は GET で、それ以外は POST です。 |