API を使用したデバイスまたはサイトのトラブルシューティング

トラブルシューティング API を使用して、外部ポータルからデバイスとサイトのトラブルシューティングを行うことができます。トラブルシューティングできるデバイスには、クライアント(有線および無線)、アクセスポイント(AP)、スイッチ、WANエッジなどがあります。APIを使用して、有線、無線、およびWANの問題についてサイトのトラブルシューティングを行うこともできます。

Marvis APIを使用するには、以下が必要です。

• 有効なオブザーバー API トークン。

• 組織レベルでのMarvisサブスクリプション。

• デバイスの MAC アドレス(デバイスのトラブルシューティングを行う場合)

• サイト ID またはサイト名 (サイトのトラブルシューティングを行う場合)

API クエリの詳細を次に示します。

• デバイスのトラブルシューティングを行うには:

  GET /api/v1/orgs/:org_id/troubleshoot?mac=:device_mac

  デバイスのホスト名またはユーザ名がわかっている場合は、検索API(/clients/search または /devices/search)を使用してMACアドレスを取得します。

  特定のサイトのデバイスに関するトラブルシューティング応答を取得する場合は、 オプションを含める site_id こともできます。特定の期間のトラブルシューティング対応が必要な場合は、 start および end オプションを含めます。

• サイトのトラブルシューティングを行うには:

  GET /api/v1/orgs/:org_id/troubleshoot?site_id=:siteid

  特定のネットワークの問題(有線、WAN、無線)に対するトラブルシューティングの回答を取得する場合は、 オプションを含める type こともできます。デフォルトのタイプはワイヤレスであることに注意してください。WAN または有線展開のみの場合は、必ずタイプを指定してください。特定の期間のトラブルシューティング対応が必要な場合は、 start および end オプションを含めます。

API クエリは、問題のカテゴリ、理由、説明、および推奨事項 (該当する場合) を含むテキストベースの応答を取得します。結果の例を以下に示します。

• デバイス(ワイヤレス クライアント)のトラブルシューティング

  https://api.mist.com/api/v1/orgs/9777c1a0-6ef6-11e6-8bbf-02e208b2d34f/troubleshoot?mac=50:xx:xx:xx:xx:c2

  

• デバイスのトラブルシューティング(有線クライアント)

  https://api.mist.com/api/v1/orgs/9777c1a0-6ef6-11e6-8bbf-02e208b2d34f/troubleshoot?mac=3c:xx:xx:xx:xx:46

  

• サイトのトラブルシューティング (ワイヤレス)

  https://api.mist.com/api/v1/orgs/9777c1a0-6ef6-11e6-8bbf-02e208b2d34f/troubleshoot?site_id=978c48e6-6ef6-11e6-8bbf-02e208b2d34f

  

• サイトのトラブルシューティング(有線)

  https://api.mist.com/api/v1/orgs/9777c1a0-6ef6-11e6-8bbf-02e208b2d34f/troubleshoot?site_id=978c48e6-6ef6-11e6-8bbf-02e208b2d34f&type=wired

  

• サイトのトラブルシューティング (WAN)

  https://api.mist.com/api/v1/orgs/9777c1a0-6ef6-11e6-8bbf-02e208b2d34f/troubleshoot?site_id=978c48e6-6ef6-11e6-8bbf-02e208b2d34f&type=wan

  

API ドキュメントは https://api.mist.com/api/v1/docs/Org#troubleshoot で表示できます。