はじめに
本ドキュメントでは、CML ( Cisco Modeling Labs ) 上からアクセスできる API Documention ( CML 2.x API ) の使用方法について紹介します。本ドキュメントのスクリーンショットは、バージョン 2.0.0-b13 で動作している CML で取得しています。
API Documention ( CML 2.x API ) とは
API Documention は、CML ログイン後の右上の Tool からアクセスすることができる、Swagger UI で構築された API リファレンスのことを指します。
Token の生成
API Documention を使うためには、まずアクセス Token を生成する必要があります。
一番上に存在する、Authentication をクリックし、右上の Try it out をクリックします。
※ CML 2.2 以降は、ログイン後右上 TEST タブが追加され、Copy JWT を行うと以下の Token が生成されクリップボードにコピーされます。
クリックした後、以下の body に CML にログインする際の username と passward を入力し、実行 ( Execute ) をクリックします。
実行後、適切なログイン情報が入力されている場合、Response Code 200 が返り、Response body に Token が確認できます。
この Token を右下の Download などでコピーし、ページ右上の Authorize をクリックし、Token を入力します。これで、他の API を使用することができます。
Swagger 上の API を使う
Token 入力し認証した後は、Authentication 以外の API を使用することができます。例として Labs に存在する start を使用してみます。
まず、CML に存在するラボを識別するユニーク ID であるラボ ID を取得します。
この場合、このラボの ID は、abdb27 だとわかります。
このラボ ID を用いて Start を使ってみます。
ラボ ID 入力後、実行 ( Execute ) することで、このラボがスタートします。
本ドキュメントは、以上となります。
この他にも多くの API が存在しますので、一度使ってみてはいかがでしょうか。
参考情報
Cisco Modeling Labs
Cisco Modeling Labs Release Notes
Cisco Modeling Labs (CML)を使ってネットワークを学ぼう！
Cisco Modeling Labs : CML で使用できる API と programmability について
Cisco Modeling Labs : CML に対するスクリプト作成例1
Cisco Modeling Labs : CML に対するスクリプト作成例2
検索バーにキーワード、フレーズ、または質問を入力し、お探しのものを見つけましょう
シスコ コミュニティをいち早く使いこなしていただけるよう役立つリンクをまとめました。みなさんのジャーニーがより良いものとなるようお手伝いします
