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

    Django REST framework interface showing Get Troubleshoot API call results. Status HTTP 200 OK. JSON response details client roaming and connectivity issues.

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

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

    Screenshot of Django REST framework interface titled Get Troubleshoot showing API call results. HTTP Status Code 200 OK, JSON response with connectivity issue details: Category Connectivity, Reason Latency, high latency on switch interface. Includes Site ID, Start and End Timestamps, and buttons for OPTIONS and GET requests.

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

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

    Django REST framework interface showing a GET Troubleshoot API call with HTTP 200 OK status. Response indicates WiFi interference causing 66 percent RF capacity issues, affecting access points and SSIDs. Recommendations suggest radio management for automatic channel and power allocation and lowering minimum power settings. User email visible in top-right corner.

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

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

    Django REST framework interface showing response of Get Troubleshoot API request with HTTP 200 OK status. JSON response highlights authentication failures on switches in a site.

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

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

    Django REST framework interface for troubleshooting device health. GET request to API endpoint shows a JSON response with status 200 OK, device health issue details, timestamps, and user email kswamy at mistsys dot com.

APIのドキュメントを表示するには、 Mist APIリファレンスを参照してください。Marvisを使用したトラブルシューティングの詳細については、「 組織のトラブルシューティング」を参照してください。