開発者用ツールキット GUI

開発者用ツールキットについて

Cisco DNA Center プラットフォームは、次のソフトウェア開発者ツールを提供します。これらにより、Cisco DNA Center でアクセスしてプログラムするとともに、Cisco DNA Center と他のアプリケーションを統合することができます。

[APIs]：機能ごとにカテゴリ内で整理された API（[Operational Tasks] API や [Site Management] API など）を利用できます。
[Integration Flows]：カテゴリタイプごとに整理された統合フローを利用できます。現時点では、IT サービスの管理（ITSM）のみを利用できます。
[Data and Reports]：サンプリングとスケジュールが可能なデータとレポートの両方が提供されます。
[Multivendor Support]：マルチベンダーサポートの説明と、追加情報を得るための Cisco DevNet へのリンクが提供されます。

API での作業

このプロシージャを実行して、使用可能な API の確認、API を使用するためのコード例の生成、Cisco DNA Center プラットフォーム上でのインタラクティブな API の試用を行います。これらのタスクは、Cisco DNA Center GUI の [APIs] ウィンドウを使用して実行します。

図 1. Cisco DNA Center プラットフォーム [APIs] ウィンドウ

Cisco DNA Center GUI には、要求方式と URL、クエリパラメータ、リクエストヘッダーのパラメータ、応答、およびスキーマ、要求をプレビューまたはテストする方法を含め、各 API コールに関するドキュメントが表示されます。

始める前に

Cisco DNA Center リリース GA 1.3.3.0 へのインストールまたはアップグレードが完了していることを確認します。最新の Cisco DNA Center リリースのインストールについての詳細は、『Cisco Digital Network Architecture Center Installation Guide』を参照してください。
前のセクションで説明されているとおり、サポートされているプログラミング言語と認証条件を満たしていることを確認してください。詳細については、API の前提条件を参照してください。

手順

ステップ 1

Cisco DNA Centerホームページで、[Platform] ヘッダーの下の [View the API Catalog] をクリックするか、またはページ上部で [Platform] > [Developer Toolkit] > [APIs] をクリックします。

ステップ 2

GUI によって表示される API を確認します。

いつでも、リリースバージョンのサポートされている API のリストを表示できます。

必要に応じて、角度アイコン（[>]）をクリックして、API サブドメインを表示します。

ステップ 3

ドメインとサブドメインから API を選択します。

（注）

API は、プラットフォーム機能モデルとして Cisco DNA Center プラットフォームに基づいて編成されます。たとえば、API は、[Authentication]、[Know Your Network]、[Site Management]、[Connectivity]、[Operational Tools]、[Policy]、および [Event Management] としてグループ化されています。

API を選択した後、各列に次の情報が表示されます。

[Method]：サポートされるメソッドには、GET、POST、PUT、および DELETE が含まれます。
[Name]：slide-in paneおよび説明、機能、タグ、パラメータ、応答、モデルスキーマなどの追加情報にアクセスするためのリンク。
[Description]：メソッドの簡単な説明。
アイコン（...）：コードプレビュースニペットまたは [Try It] オプションを作成するためのリンクにアクセスします。

（注）

特定の API 構成が進行中で、後から再度確認することを示す青色の色分けされたメッセージが表示されることがあります。API が登録されている場合は画面が自動更新されます。その後、API アクティビティを続行できます。きわめて可能性は低いが、API を設定できないことを示す赤で色分けされたメッセージが表示された場合は、Cisco DNA Center 管理者に連絡して、問題を解決するための支援をシスコに依頼してください。

ステップ 4

API メソッドの名前（リンク）をクリックします。

API メソッドに関する次の情報が表示されます。

[DESCRIPTION]：メソッドと URLを伴う API の説明。
[PARAMETERS]：説明、データ型（ブール値または文字列）、デフォルト値、有効な値を含む API のパラメータ。
[RESPONSES]：考えられる HTTP 応答。
[MODEL SCHEMAS]：データモデル（[Model] タブ）または実際の応答の JSON 形式（[Model Schema] タブ）として応答を提供します。サンプルコードは、[Code Preview] ボタンから入手可能です。
[POLICIES]：API レート制限機能。ポリシーは特定の API に適用されます。これらのポリシーは、クライアント IP アドレスごとの時間間隔あたりの API コール数を設定します。

ステップ 5

（オプション）[Code Preview] をクリックして、コードプレビューを生成します。

（注）

独自のプログラムを作成している場合は、コードプレビューのサンプルを切り取って、独自のプログラムに貼り付けることができます。

ステップ 6

（オプション）[Code Preview] ウィンドウで、ドロップダウンからコードを生成するための言語を選択します。

次の言語がサポートされています。

シェル
ノード：HTTP
ノード：Unirest
ノード：Request
Python
Ruby
javascript
JQuery
PHP
Go
Ansible

使用するコードプレビューサンプルを確認またはコピーした後、[Close] をクリックします。

ステップ 7

（オプション）[Try It] をクリックして、メソッドを試します。

ステップ 8

（オプション）[Try It] ウィンドウで、要求された値（URL アドレスや値など）を入力し、[Run] をクリックします。

応答またはエラーコードを確認した後、[Close] をクリックします。

Cisco DNA Centerが 202（承認）HTTP ステータスコードを返した場合、結果の本文には、元のリクエストが生成した非同期タスクに関する詳細情報のクエリに使用できるタスク ID と URL が含まれます。たとえば、非常に長いタスクが完了したかどうかを判断するためにこの情報を使用できます。詳細については、「Getting Information about Asynchronous Operations」を参照してください。

（注）

応答は Cisco DNA Center 自体からのライブ応答で、結果はネットワークの実際の状態を反映しています。対照的に、コードプレビューは静的で、入力する必要がある値のプレースホルダが含まれています。

統合フローの使用

統合フローは、Cisco DNA Center プラットフォームと、ネットワーク問題を追跡、トラブルシューティング、および解決するために使用される ITSM システムなどのサードパーティ製システムとの相互作用を定義します。

Cisco DNA Center プラットフォームは、スケジュールベースの統合フローをサポートします。このタイプの統合フローはスケジュールに従って実行され、タスクを実行し、REST エンドポイントまたはその他のベンダーの特定の宛先への情報をプッシュします。スケジュールベースの統合フローは、これらを実行するスケジュールを指定する GUI で [Integration Flows] ウィンドウを使用して編集できます。

（注）

[Developer Toolkit] で使用可能な統合フローは、[Manage] > [Bundles] 内のさまざまなバンドルによって使用されます。バンドルは、ユーザ独自のアプリケーションを Cisco DNA Center と統合したり、Cisco DNA Center 自体のパフォーマンスを向上させたりするために使用されます。バンドル内で使用されている統合フローを表示するには、[Manage] 内でバンドルをクリックし、[Contents] タブをクリックします。バンドルの統合フローが、[Contents] タブの下にリストされます。

図 2. Cisco DNA Center プラットフォーム [Integration Flows] ウィンドウ

始める前に

Cisco DNA Center リリース GA 1.3.3.0 へのインストールまたはアップグレードが完了していることを確認します。最新の Cisco DNA Center リリースのインストールについての詳細は、『Cisco Digital Network Architecture Center Installation Guide』を参照してください。

[Integration Flows] ウィンドウで確認または管理する統合フローを有効にし、スケジュールしていることを確認します。

（注）

[Integration Flows] ウィンドウで統合フローを表示および管理できるようにするには、それらを有効にする必要があります。Cisco DNA Center プラットフォームで個々のバンドルから統合フローを有効にする必要があります。たとえば、[Platform] タブ > [Developer Toolkit] > [Manage] > [Bundles] > [Basic ITSM (ServiceNow) CMDB synchronization] > [Contents] タブの順にクリックします。[Enable] オプションボタンをクリックします。

手順

ステップ 1

Cisco DNA Center のホームページで、[Platform] > [Developer Toolkit] > [Integration Flows] の順にクリックします。

ステップ 2

GUI によって表示される統合フローを確認します。

（注）

使用可能な統合フローは、グループ別に編成されます。このリリースの場合、使用可能な唯一のグループが ITSM 統合です。

ステップ 3

ITSM 統合グループから統合フローを選択します。

次の情報が表示されます。

[Name]：統合フローと追加情報が入手可能なslide-in paneにアクセスするリンクの名前。
[Description]：統合フローの簡単な説明。
[Trigger]：スケジュールベース。
アイコン（[…]）：[Schedule Flow] オプションにアクセスします。

ステップ 4

スケジュールベースの統合フローの場合は、アイコン（[…]）をマウスオーバーして [Schedule Flow] をクリックします。

ステップ 5

次の表示されたデータを確認してください。

[DESCRIPTION]：統合フローの説明と目的。
[TAGS]：タグは、どの Cisco DNA Center コンポーネントが、バンドルによって使用されるか、または影響を受けるかを示します。
[HOW TO USE THIS FLOW]：スケジュール設定オプション。

GUI を使用して、統合フローをスケジュールすることができます。

ステップ 6

次の GUI オプションを使用して、統合フローのスケジュールを設定します。

[Run Now]：[Run Now] を選択し、[Schedule] ボタンをクリックして統合フローを実行します。
[Run Later]：[Run Later] を選択し、日付、時刻、およびタイムゾーンを入力します。[Schedule] ボタンをクリックして、指定した日付、時刻、およびタイムゾーンで統合フローを実行します。
[Recurring]：[Recurring] を選択し、次のオプションを設定します。
- [Repeats]：統合フローを繰り返す頻度として毎日または毎週を選択します。
- [Run at Interval]：統合フローを実行する時間間隔を設定します。
- [Set Schedule Start]：開始日を設定します。
- [Set Schedule End]：終了日を設定します。
設定された時間に統合を実行するには、[Schedule] ボタンをクリックします。

データとレポートの操作

Cisco DNA Center プラットフォームのデータおよびレポート機能のデータを使用すると、ネットワークとその動作に関する洞察を得ることができます。このデータがいくつかの形式でレポートされることと、柔軟なスケジューリングおよび設定オプションが提供されることにより、データとレポートの両方を運用上のニーズに合わせて容易にカスタマイズできます。

図 3. Cisco DNA Center プラットフォームデータおよびレポートウィンドウ

データおよびレポート機能は、次の使用例をサポートしています。

キャパシティプランニング：ネットワーク内のデバイスがどのように利用されているのかを理解できます。
パターンの変更：ネットワークでの使用パターンの傾向の変化を追跡します。使用パターンの傾向には、クライアント、デバイス、バンド、またはアプリケーションが含まれる場合があります。
運用レポート：アップグレード完了やプロビジョニング障害などのネットワーク運用に関するレポートを確認できます。
ネットワークの正常性：レポートによってネットワークの全体的な正常性を判断できます。

（注）

データおよびレポート機能の新しい使用例は、将来のリリースで追加される予定です。これらの情報については、今後の Cisco DNA Center プラットフォームのリリースノートで確認してください。

レポートのサンプルとスケジュール

ネットワークに関する専門的なデータレポートを設定するには、この手順を実行します。Cisco DNA Center GUI の [Data and Reports] ウィンドウを使用では、データレポートを設定できます。

図 4. SWIM データ：[Apply Filters and Schedule] ウィンドウ

始める前に

Cisco DNA Center リリース GA 1.3.3.0 へのインストールまたはアップグレードが完了していることを確認します。最新の Cisco DNA Center リリースのインストールについての詳細は、『Cisco Digital Network Architecture Center Installation Guide』を参照してください。
Cisco DNA Center でディスカバリジョブを正常に実行し、デバイスとネットワークデータに関するレポートを設定およびスケジュールします。[Device Inventory] でディスカバリジョブが成功しているかどうか確認できます。[Home] ページで、[Provision] > [Device Inventory] > [Inventory] の順に選択して、検出結果を表示します。

手順

ステップ 1

[Home] Cisco DNA Center ページで、次のいずれかのタスクを実行します。

ページの上部で、[Platform] タブ > [Developer Toolkit] > [Data and Reports] を選択します。
[Platform] ヘッダー（[Network Configuration] フィールド）で、[Schedule and Download Data and Reports] をクリックします。
ページ下部の [Tools] で、[Data and Reports] をクリックします。

[Data and Reports] のデフォルトウィンドウである [Catalog] ビューがが表示されます。表示されない場合は、[Data and Reports] ヘッダーの下の [Catalog] をクリックします。

ステップ 2

[Catalog] ウィンドウを確認します。

[Catalog] ウィンドウに、カタログ品目と呼ばれるサポート対象のレポートカテゴリが表示されます。各カタログ品目はタイルで表示され、サンプルレポートとレポートの設定（スケジュール）の両方へのリンクが含まれています。

ステップ 3

[Catalog] ウィンドウで、レポートを作成するカタログ品目を指定します。

ステップ 4

サンプルレポートを表示するには、カタログ品目のタイルで [Sample] をクリックします。

そのサンプルレポートの [Preview] ウィンドウが表示されます。ウィンドウのサイドバーを使用して下にスクロールし、サンプルレポート全体を確認します。次のデータが表示されます。

適用されたフィルタ（レポートを構築するために使用されたデータフィルタ）。
データメトリックとサマリー
データのグラフィカル表示（回線、バー、円グラフを含む）。
データの分析を支援するテーブル。

（注）

[Preview] ウィンドウのサンプルレポートを使用して、レポートの表示方法を計画できます。

ステップ 5

[X] をクリックして、プレビューを閉じます。

ステップ 6

レポートを作成するためのパラメータを設定するには、カタログ品目のタイルで [Schedule] をクリックします。

[Schedule] ウィンドウが開きます。ここで、レポートのフォーマットタイプを選択、データのフィルタを適用、および実際のレポート生成スケジュールを設定できます。

ステップ 7

[Schedule] ウィンドウでは、レポートを作成するためのパラメータを設定します。

[Schedule] ウィンドウは次のフィールドに分かれています。

[Format]：デフォルトのレポート名を承認するか、新しいレポート名を作成します。また、データタイプやファイルタイプを選択します（複数のオプションがある場合）。
[Filters]：レポートのデータのフィルタを選択します。
[Schedule]：レポート生成の日時を選択します。
[Send to]：レポートのダウンロードリンクが記載された電子メールの送信先となる電子メールアドレスを入力します。

ステップ 8

[Report Name] フィールドで、デフォルトのレポート名を受け入れるか、新しいレポート名を入力します。

ステップ 9

[Type] フィールドで、データタイプをクリックします。

SWIM およびインベントリレポートの場合は、データタイプの選択肢はありません。デフォルトのデータタイプは、[All Data] です。エグゼクティブサマリーの場合、データの選択肢はありません。[Executive Summary] がデフォルトになります。

（注）

エグゼクティブサマリーレポートの日付と時刻の値は、協定世界時（UTC）標準に基づきます。

クライアントレポートの場合は、次のいずれかを選択できます。

Client Summary
Top N Summary
クライアントの詳細

ステップ 10

[File Type] フィールドでは、完成レポートのファイルタイプを選択します。

[File Type] では、作成するレポートに応じて次のオプションを選択できます。

PDF
CSV
Tableau Data Extract
JSON

ファイルタイプが [CSV]、[JSON]、[Tableau Data Extract] の場合、[Fields] オプションが表示され、CSV、JSON、Tableau Data Extract から作成するレポートの属性（追加フィールド）を選択できます。

ステップ 11

（任意）レポートの属性（フィールド）を選択します。

（注）

SWIM データとレポートの場合は、 [CSV] と [Tableau Data Extract] の両方のファイルタイプについて、個々のフィールドを選択できます。クライアントデータとレポートの場合は、[Client Detail] を選択してから、 [CSV]、[Tableau Data Extract]、[JSON] の各ファイルタイプについて、個々のフィールドを選択できます。インベントリデータとレポートの場合は、 [CSV] と [Tableau Data Extract] の両方のファイルタイプについて、個々のフィールドを選択できます。

ステップ 12

必要に応じて、レポートの [Data Filters] を選択します。

[Data Filter] は、設定するレポートのタイプによって異なります。たとえば、SWIM データフィルタは、[Location]、[Device Family]、および [Device Role] で構成されます。対照的に、エグゼクティブサマリーのデータフィルタは、特定の時間範囲です（追加の [Custom] 時間範囲オプションがあります）。

ステップ 13

[Schedule] フィールドで、レポートのスケジュールを設定します。

[Schedule] には、次のオプションがあります。

Schedule Now
Schedule for Later
Reoccurring Schedule

ステップ 14

レポートの電子メール通知を送信するには、[Send to] フィールドに電子メールアドレスを入力します。

Cisco DNA Center は、レポートに関する次の電子メール通知を送信します。

レポートは、実行待ちのキュー内にあります。
インポートプロセスは進行中です。
レポートのコンパイルが正常に完了しました。

レポートが正常にコンパイルされたことを伝える電子メール通知には、元の通知に戻るリンクと、[Data and Reports] の [My Downloads] ページへのリンクがあります。ここからリンクを使用して、レポートを表示およびダウンロードできます。

（注）

電子メールからレポートを表示してダウンロードするには、適切な Cisco DNA Center ユーザ権限が必要です。

ステップ 15

[Schedule] ボタンをクリックします。

[My Downloads] ウィンドウが開き、スケジュールされたレポートのインスタンスの詳細が表示されます。

次のタスク

[My Downloads] ウィンドウで、レポートインスタンスを確認します。

（注）

[My Downloads] ウィンドウで、レポートをダウンロード、確認、編集、複製、または削除することができます。

マイダウンロードの確認

以前生成したレポートをダウンロード、確認、編集、複製、または削除するには、この手順を実行します。

始める前に

Cisco DNA Center リリース GA 1.3.3.0 へのインストールまたはアップグレードが完了していることを確認します。最新の Cisco DNA Center リリースのインストールについての詳細は、『Cisco Digital Network Architecture Center Installation Guide』を参照してください。
Cisco DNA Center でディスカバリジョブを正常に実行し、デバイスとネットワークデータに関するレポートを設定およびスケジュールします。[Device Inventory] でディスカバリジョブが成功しているかどうか確認できます。[Home] ページで、 [Provision] > [Device Inventory] > [Inventory] の順にクリックして、検出結果を表示します。
[Catalog] の [Schedule] 機能を使って、レポートを作成します。

手順

ステップ 1

Cisco DNA Center のホームページで、次のいずれかのタスクを実行します。

ページの上部で、[Platform] タブ > [Developer Toolkit] > [Data and Reports] を選択します。
[Platform] ヘッダー（[Network Configuration] フィールド）で、[Schedule and Download Data and Reports] をクリックします。
ページ下部の [Tools] で、[Data and Reports] をクリックします。

ステップ 2

[My Downloads] タブをクリックします。

次の情報が表示されます。

[Name]：レポートの名前。

レポート名を指定しなかった場合は、レポートの日付と時刻とともにレポートタイプを含むデフォルト名がレポートに設定されます。
[Report Type]：カタログオプション（クライアント、SWIM、インベントリ）に基づくレポートのタイプ。
[File Type]：ファイル形式タイプ（PDF または CSV ファイル形式など）。
[Schedule]：レポートを生成したスケジュールの説明。
[Last Execution Status]：レポートの実行ステータスと詳細が表示されます。次のレポート実行ステータスタイプが表示される場合があります。
- [Not Initiated]：スケジュールされたが、まだ開始されていないレポート。
- [In Queue]：スケジュールされ、実行する処理キュー内にあるレポート。
- [In Progress]：現在実行中のレポート。
- [Completed]：レポートの実行が完了しました。
  
  [Completed] の横にあるアイコン（下矢印）をクリックすると、最後に生成されたレポートがダウンロードされます。
- [Expired]：期限切れになり、Cisco DNA Center で使用できなくなっているレポート。
- [Error]：レポートの実行に失敗しました。

[Reports]：合計で最大 7 個のレポート数。

表示されたレポート数にマウスのカーソルを合わせると、[View Report List] が表示されます。レポートダイアログボックスを表示するには、[View Report List] をクリックします。レポートダイアログボックスには、すべてのレポート実行とそのステータス（[Not Initiated]、[In Queue]、[In Progress]、[Completed]、[Expired]、[Error]）、およびコピーをダウンロードするための [Download] ボタンが表示されます。[Error] をクリックすると、レポートの実行に関するエラーと警告が表示されます。

重要

Cisco DNA Center プラットフォーム合計 7 個のレポートを保持します。具体的には、Cisco DNA Center プラットフォームは実行された最後の 7 個のレポートと、過去 7 日間（週）に実行された最後の 7 個のレポートを保持します。たとえば、1 日に 8 個のレポートを実行した場合、Cisco DNA Center プラットフォームは最後の 7 個のレポートのみを保持します。毎日 1 つのレポートをスケジュールすると、Cisco DNA Center プラットフォームは過去 7 日間（週）にわたる最新の 7 個のレポートのみを保持します。また、Cisco DNA Center プラットフォームからさまざまな形式でレポートをエクスポートし、それらを安全な場所にアーカイブすることもできます。

[Actions]：レポートで実行できるタスクのリスト。

[Filter] アイコンをクリックしてフィルタを使用するか、[Find] フィールドにキーワードを入力することで、GUI に表示されるダウンロードを調整することができます。

ステップ 3

次の 1 つ以上のタスクを実行するには、[Actions] をクリックします。

[Edit]：レポートに設定されたパラメータ（スケジュールを含む）が表示されるウィンドウを開きます。このウィンドウでは、設定されているレポートパラメータを確認できます。ただし、このウィンドウでは、レポート設定を変更できません。これは、読み取り専用ビューです。設定を編集する必要がある場合は、[Actions] > [Edit] をクリックします。[Edit] をクリックすると、レポート設定を表示および編集できます。

[Edit]：レポートに設定されたパラメータ（スケジュールを含む）が表示されるウィンドウを開きます。このウィンドウでは、パラメータの確認および編集もできます。レポートを編集した後、[Update Schedule] をクリックします。

重要	レポート設定を編集して更新すると、以降のレポート実行にはこの新しい設定が反映されます。このことは、繰り返しのスケジュールでレポートが生成されている場合に重要です。さらに、レポート設定を編集して更新すると、 Cisco DNA Center プラットフォームの以前のレポートはすべて削除されます。このウィンドウで、[Update Schedule] ボタンをクリックすると、削除に関する警告が GUI に表示されます。[Update Schedule] ボタンをクリックして以前のすべてのレポートを削除するために設定で編集を行う必要はありません。

[Duplicate]：レポートのパラメータを表示または設定できる [Schedule] ウィンドウが開きます。レポートを再度実行するには、[Schedule] をクリックします。

（注）

既存のレポートとその設定に基づいて新しいレポートを作成する場合は、[Duplicate] オプションを使用し、設定を変更します。これにより、既存のレポートとその設定を保持したまま、既存のレポートと同様の新しいレポートを作成できます。既存のレポートを廃棄して新しいレポートに完全に置き換える場合は、前述のように [Edit] オプションを使用します。

[Run Now]：レポートを実行するプロセスを開始します。レポートの実行が成功すると、成功メッセージが表示されます。

（注）

レポートを実行しようとしたときに以前のレポートが 7 個ある場合、最後の 7 つのレポートのみが保存されることを示す警告が GUI に表示されます。レポートの既存のスケジュール以外でレポートを生成する必要がある場合は、[Run Now] オプションを使用します。

[Delete]：レポートを削除します。レポートを削除する前に、このアクションを確認するよう求められます。

マルチベンダー SDK のサポートについて

Cisco DNA Center によりユーザはシスコ以外のデバイスを管理できます。マルチベンダーサポートは、サードパーティ製デバイスのデバイスパッケージを作成するために使用できる SDK の形式で Cisco DNA Center で利用可能になっています。デバイスパッケージにより、Cisco DNA Center はデバイスとの通信に使用されるサウスバウンドプロトコルをカプセル化することで、サードパーティ製デバイスとの通信方法を理解できます。

具体的には、Cisco DNA Center マルチベンダー SDK では現在、次の機能がサポートされています。

デバイス検出
インベントリとトポロジでのデバイス表示
デバイスのネットワークアシュアランス
デバイスでコマンドランナーを使用して show スタイルコマンドを実行する機能

（注）

Cisco DNA Center マルチベンダー SDK のサポートの詳細については、「Multivendor Support」および『Getting Started with Cisco DNA Center Multivendor SDK』を参照してください。

イベントの使用

ネットワークで発生する可能性のある特定のイベントを登録できます。サブスクリプションの後、イベントが実際に発生すると、REST API または電子メールで通知が届きます。イベントを登録するには、Cisco DNA Center プラットフォーム GUI の [Events Settings] ウィンドウを使用します。

（注）

電子メール通知は、バッチ処理やスケジュールに基づいて送信されるのではなく、ほぼリアルタイムで送信されます。使用される電子メールテンプレートは事前に設定されており、ユーザがカスタマイズすることはできません。また、通知の送信順序にイベントの優先度は影響しません。たとえば、重大度 1 のイベントが重大度 3 のイベントよりも先に送信されるわけではありません。同じ問題が複数回トリガーされないように、抑制時間間隔もサポートされています。抑制時間間隔内に同じ問題（イベント）が発生した場合、2 番目の通知は送信されません。抑制時間間隔外に同じ問題が発生した場合は、別の通知が送信されます。抑制時間間隔は事前に定義されており、ユーザが設定することはできません。

図 6. Cisco DNA Center プラットフォーム [Event] ウィンドウ

始める前に

[Events Settings] ウィンドウにアクセスして、ネットワーク内で発生した可能性があり、Cisco DNA Center によってキャプチャできるイベントのリストを確認/編集しました。[Events Settings] ウィンドウにアクセスするには、[Manage] > [Configurations] > [Event Settings] をクリックします。
電子メールサブスクリプションについては、Cisco DNA Center の [Email Configuration] ウィンドウで電子メールイベント通知を設定しています。[Email Configuration] ウィンドウにアクセスするには、[System Settings] > [Settings] > [Email Configuration] をクリックします。電子メール通知の設定の詳細については、電子メールイベント通知の設定を参照してください。

手順

ステップ 1

Cisco DNA Center ホームページで、[Platform] > [Developer Toolkit] > [Event] をクリックするか、または [System Settings] > [Settings] > [Events and Subscriptions] をクリックします。

[Events] ウィンドウが表示されます。

ステップ 2

[Events] ウィンドウで、GUI によって表示されるイベントテーブルを確認します。

（注）

[Find] フィールドにキーワードを入力することで、GUI に表示されるイベントを調整できます。

ステップ 3

テーブル内の個々のイベントのデータを確認します。

次の [Events] データが表示されます。

[Event ID]：イベントの識別番号。
[Name]：イベントの名前（リンク）。

このリンクをクリックすると、イベントの [Name] slide-in paneが開きます。[Name] スライドインパネルは、[Events Details] と [Active Subscriptions] の 2 つのタブで構成されます。
[Description]：イベントの簡単な説明。
[Type]：イベントのネットワーク、アプリケーション、システム、セキュリティ、または統合のタイプ。
[Category]：エラー、警告、情報、アラート、タスクの進捗状況、タスクの完了。

[Severity]：1 〜 5。

（注）

重大度 1 は最も重要または重大な優先度であり、このタイプのイベントに割り当てる必要があります。

[Status]：サブスクリプションステータス（ユーザがイベントを登録しているかどうかを表し、 [Active Subscriptions] ページに表示されます）。イベントを登録している場合は、この列に通知のタイプ（REST URL または電子メール）も表示されます。

ステップ 4

[Name] リンクをクリックすると、イベントサブスクリプション slide-in pane が開きます。

ステップ 5

イベントサブスクリプション slide-in paneに表示されるデータを確認します。

[Event Details] タブに表示されるデータは次のとおりです。

[Description]：イベントとそれを発生させるトリガーの簡単な説明。
[Event ID]：イベントの識別番号。
[Version]：イベントのバージョン番号。
[Namespace]：イベントの名前空間。

このリリースのデフォルト値は、すべてのイベントで ASSURANCE です。
[Domain]：イベントが属する REST API ドメイン。
[Sub Domain]：イベントが属する REST API ドメインの配下のサブグループ。
[Type]：イベントのネットワーク、アプリケーション、システム、セキュリティ、または統合のタイプ。
[Category]：エラー、警告、情報、アラート、タスクの進捗状況、タスクの完了。

[Severity]：1 〜 5。

（注）

重大度 1 は最も重要または重大な優先度であり、このタイプのイベントに割り当てる必要があります。

[Cisco DNA Event Link]：REST URL を使用したイベントブロードキャスト。
[Note]：イベントの理解に役立つ追加情報。
[Tags]：イベントの影響を受ける Cisco DNA Center のコンポーネントを示すタグ。このリリースのタグのデフォルト値は、ASSURANCE にアシュアランスの特定の問題を示すシンタックスを付けた値です。
[Model Schema]：イベントに関するモデルスキーマが提示されます。
- [Details]：イベントのモデルスキーマの詳細の例。
- [REST Schema]：イベントの REST スキーマのフォーマット。

ステップ 6

[Active Subscriptions] タブをクリックします。

[ctive Subscriptions] タブに表示されるデータは次のとおりです。

[Broadcast Methods]：電子メールまたは REST API
[Count and Instances]：電子メールまたは REST API の通知のインスタンス数。
[Actions]：有効なサブスクリプションを登録解除または編集します。

（注）

有効なサブスクリプションを編集または登録解除するには、[Count and Instances] でサブスクリプション数をクリックします。個々のサブスクリプション数をクリックした後、登録解除するには [Unsubscribe]、編集するには [Edit] をクリックします。複数のサブスクリプションを登録解除する場合は、一度に 1 つずつ登録解除する必要があります。複数のサブスクリプションを登録または登録解除する機能は GUI ではサポートされていません。

ステップ 7

[Subscribe] ボタンをクリックして、このイベントを有効なサブスクリプションに追加します。これにより、以降に通知が届くようになります。

イベントを登録する際は、電子メールまたは REST API エンドポイントのいずれで通知を受け取るかを設定します。REST API エンドポイント通知（ウェブフックなど）のサブスクリプションの場合は、次のようにフィールドを設定します。

[Name]：イベントの名前。
[Subscription Type]：[REST]

サブスクリプションタイプは、電子メールまたは REST API エンドポイントのいずれかに設定できます。[EMAIL] を選択した場合にまだ電子メールを設定していないと、GUI にアクセスして設定作業を行うよう求められます。
[Select an existing endpoint]：ドロップダウン矢印を使用して、サブスクリプションのエンドポイントと URL を選択します。
[Create a new endpoint]：エンドポイント名、エンドポイントの説明、および URL を入力します。
[Trust certificate]：REST API エンドポイント通知に信頼できる証明書が必要かどうかを選択します。
[HTTP Method]：PUT または POST のいずれかのメソッドを選択します。
[Authentication]：認証タイプを選択します。
- [Basic]：クライアントが HTTP 要求を送信することで認証を行います。クライアントは、「Basic」という単語の後にスペースで区切って「username:password」の形式の base64 でエンコードされた文字列を入力した認証ヘッダーを含む HTTP 要求を送信します。GUI で [Basic] を選択した場合、下の [Header Key] フィールドに「Authorization」という値が入力されます。
- [Token]：サーバから提供されたセキュリティトークンを使用してユーザが認証されます。[Token] を選択すると、下の [Header Key] フィールドに [X-Auth-Token] の値が入力されます。
- [No Authentication]：認証が不要になります。

[Headers]：[Header Key] と [Header Value] を入力します。[Add] をクリックして、ヘッダーの値を追加します。

（注）

[Header Key] フィールドは、上記の [Authentication] の選択に応じて自動的に入力される場合があります。

サブスクリプションを保存して有効にするには、[Subscribe] をクリックします。

サブスクリプションをキャンセルしてウィンドウを終了する場合は、[Cancel] ボタンをクリックします。

ステップ 8

[Subscribe] ボタンをクリックして、イベントのアクティブなサブスクリプションにこのイベントを追加します。

イベントを登録する際は、電子メールまたは REST API エンドポイントのいずれで通知を受け取るかを設定します。電子メールのサブスクリプションの場合は、次のようにフィールドを設定します。

[Name]：イベントの名前。
[Subscription Type]：[EMAIL]

サブスクリプションタイプは、電子メールまたは REST API エンドポイントのいずれかに設定できます。[EMAIL] を選択した場合にまだ電子メールを設定していないと、GUI にアクセスして設定作業を行うよう求められます。
[Select an existing endpoint]：ドロップダウン矢印を使用して、サブスクリプションのエンドポイントを選択します。
[Create a new endpoint]：新しいエンドポイント名とエンドポイントの説明を入力します。
[SMTP Configuration]：プライマリとセカンダリの SMTP サーバのホスト名/IP アドレス、ポート番号、ユーザ名とパスワードを入力します。セカンダリ SMTP サーバはオプションです。

[Email Recipients]： [From] と [To] の電子メールアドレス、および電子メールの [Subject] ヘッダーを入力します。

（注）

電子メールを受信する電子メールアドレスは、エンドポイントごとに最大 20 個まで設定できます。追加の電子メールアドレスを入力するには、最初の電子メールアドレスを入力した後にキーボードの Enter を押し、その後に追加のメールアドレスを入力します。Enter を押した時点で、電子メールアドレスについて必要なすべての検証が実行され、電子メールアドレスのシンタックスに誤りがある場合は通知されます。エンドポイントに対して 20 を超える電子メールアドレスを設定する必要がある場合は、電子メールエイリアスを使用できます。

サブスクリプションを保存して有効にするには、[Subscribe] をクリックします。

サブスクリプションをキャンセルしてウィンドウを終了する場合は、[Cancel] ボタンをクリックします。

ステップ 9

[Active Subscriptions] タブでサブスクリプションを確認します。

サブスクリプションに関する次の情報が表示されます。

[Subscription Name]：サブスクリプションの名前。
[Events]：サブスクリプション対象のイベント。
[Actions]：イベントに対して実行されたアクション。

（注）

[Filter] アイコンをクリックしてフィルタを使用するか、[Find] フィールドにキーワードを入力することで、GUI に表示されるサブスクリプションを調整することができます。

Cisco DNA Center プラットフォームリリース 1.3.3.0 ユーザガイド

Bias-Free Language

Book Title

Cisco DNA Center プラットフォームリリース 1.3.3.0 ユーザガイド

Chapter Title