このページの目次
API with Wired Assurance
Wired Assuranceに関して関心がある主なURIエンドポイントは、主に3つあります。
-
ネットワークテンプレート
-
サイト設定
-
スイッチ設定
ネットワークテンプレート
ドキュメントは、RFテンプレートのすぐ下にあります。 https://api.mist.com/api/v1/docs/Org#rf-template
-
ネットワーク テンプレートの作成
-
役職: https://api.mist.com/api/v1/orgs/:org_id/networktemplates
-
ペイロード: JSON 形式のペイロード
-
必須: 名前
-
-
ネットワークテンプレートのリストを取得
-
取得: /api/v1/orgs/:org_id/networktemplates
-
ペイロード:なし
-
フィルター: id、名前
-
-
ネットワーク テンプレートの取得
-
取得: / api/v1/orgs/:org_id/networktemplates/:networktemplate_id
-
ペイロード:なし
-
-
ネットワーク テンプレートの更新
- PUT: / api/v1/orgs/:org_id/networktemplates/:networktemplate_id
- ペイロード:JSON形式のペイロード(変更/追加のみが必要)
-
ネットワーク テンプレートの削除
- 削除: / api/v1/orgs/:org_id/networktemplates/:networktemplate_id
- ペイロード:なし
サイト設定
ドキュメントはここにあります: https://api.mist.com/api/v1/docs/Site#site-setting
-
サイト設定の取得
*スイッチング関連の設定と非スイッチング関連の設定の両方を含む*
- 取得: / api/v1/sites/:site_id/setting
- ペイロード:なし
- サイト設定の更新:
- PUT: / api/v1/sites/:site_id/setting
- ペイロード:JSON形式のペイロード(変更/追加のみが必要)
- このサイトをテンプレートにリンクするには、適用するネットワーク テンプレートの ID の値を含む "networktemplate_id" キーを追加します。
- 注: サイト設定に POST または削除はありません。サイト設定を作成する唯一の方法は新しいサイトを作成することであり、それらを削除する現在の唯一の方法はサイトを削除することです。
スイッチ設定
スイッチ設定
ドキュメントはここにあります: https://api.mist.com/api/v1/docs/Site#device
- スイッチ設定を取得します。
- 取得: / api/v1/sites/:site_id/devices/:d evice_id
- ペイロード:なし
- スイッチ設定の更新:
- PUT: / api/v1/sites/:site_id/devices/:d evice_id
- ペイロード:JSON形式のペイロード(変更/追加のみが必要)
- スイッチ設定のリセット:
- 投稿: / api/v1/sites/:site_id/devices/:d evice_id
- ペイロード: なしまたは JSON
- これにより、スイッチ設定で定義された設定が事実上削除され、何もないか、ペイロードに渡されたものに置き換えられます。あなたが台無しになって、再構成する前に設定をリセットする必要がある場合に最適です。
- 注:これは現在、APIドキュメントにはありません。現在、再追加に取り組んでいます。あなたはdjango APIブラウザでそれを見つけることができます。
-
get switch config コマンド:
これにより、Mistがスイッチにプッシュする設定セットコマンドが返されます。これには基本的な接続性(ブラウンフィールド設定スニペット、またはグリーンフィールド設定)は含まれず、Mistのテンプレート/サイト/スイッチ設定を介してプッシュされる設定のみが含まれることに注意してください。
- 取得: / api/v1/sites/:site_id/devices/:d evice_id/config_cmd
- ペイロード:なし
- ブラウンフィールド導入だけでなく、MistでのEXの学習とテストにも非常に便利です。
APIのユースケース
信頼できる情報源
ネットワーク運用が進化し続けるにつれて、信頼できる情報源(SoT)はより重要な要素になりつつあります。これらのSoTにより、外部ソフトウェアアプリケーションでネットワークをどのように構成すべきかを記述し、そのSoTをMistと直接通信して構成することができます。
信頼できる情報源は、YAMLまたはJSONデータファイルのセットのような単純なものから、NetboxやNSOTなどの専用アプリケーションのような高度なものまでさまざまです。SoTのデータに基づいてAPIを介してサイトとスイッチを構成すると、制御のレベルが提供され、サイトとデバイス間で構成の一貫性を維持できます。
サービス指向の構成
変更管理は、ネットワーク運用の大きな部分を占めます。手動での変更はミスが起きやすく、時間がかかります。ServiceNowなどのITSMプラットフォームに変更管理を統合することで、変更を適切に変更管理プロセスに通すことで、一般的な変更管理要求を簡素化し、変更を行う際の人為的エラーを減らすことができます。Wired Assurance用APIにより、ITSMプラットフォームと有線ネットワーク構成間のこれらの統合が可能になります。
継続的な取り組み
APIにより、EXスイッチングをプログラムで設定する機会がすぐに得られますが、追加機能の追加作業はすでに進んでいます。たとえば、Cisco IOS設定の移行を自動化したり、既存のソフトウェアライブラリとオープンソースツールを使用して、既存のジュニパーEX設定のMistプラットフォームへの自動移行などです。