Cisco EPN Manager SDK は、Cisco EPN Manager の機能を拡張したり、データにアクセスしたり、アプリケーションから自動化操作を呼び出したりできるテクノロジーの集合です。Cisco EPN Manager SDK には、RESTful API と Open Automation が含まれています。RESTful API で「wget および cURL ユーティリティを使用した bash」、「Python」、「Ruby」、Java などのスクリプト言語を使用できます。

Cisco EPN Manager SDK テクノロジーを使用して、次のことが可能です。

• プログラムによる Cisco EPN Manager へのアクセス：Cisco EPN Manager RESTful API を使用してワークフローを呼び出し、レポートを取得できます。

• Cisco EPN Manager のカスタマイズ：カスタムワークフロータスクを作成し、スクリプトモジュールに独自の jar ファイルおよびスクリプトライブラリを展開して、Cisco EPN Manager をカスタマイズできます。スクリプト バンドルからカスタム タスクを使用します。

Cisco EPN Managerは、あらゆる標準規格の OSS システム ノース バウンドとの統合を可能にする、使いやすく包括的な API を提供します。これらの API では、最も一般的に使用される 3 つの標準規格である MTOSI、RESTConf、および RESTful API を使用してコア機能を拡張します。

自動化向けの迅速な開発設計を実現するためには、開発者が一貫性を持って API を開発し、わかりやすく使いやすい設計ガイドラインを示せるようにすることが重要です。一貫性を保つことで、チームは一般的なコード、パターン、ドキュメント、および設計上の決定事項を活用できます。Cisco EPN Manager では、シンプルで広範な例を使用してアプリケーション内で RESTful API を簡単に利用可能にできます。次の図は、Cisco EPN Manager において *すべて* の API 全体で確認される一般的な動作を示した例です。

この章は、Cisco EPN Manager 開発キット（SDK）および関連技術の使用に関心がある、以下の技術担当者を対象としています。次のようなユーザが対象です。

• Cisco EPN Manager を使用してリソースを自動化する機能を拡張したいと考えているシステム管理者および REST API 開発者。

• Cisco EPN Manager SDK または API テクノロジーを比較し、どちらがアプリケーションに最適であるかを判断したいその他のユーザ。

Cisco EPN Managerは、MTOSI、REST、および RESTConf の 3 つのノースバウンド API インターフェイス タイプを提供します。この 3 つの API によって提供される機能はかなり類似していますが、すべての API が同じ機能を提供するわけではありません。

MTOSI API は、動作の点で最も異なる API です。光イーサネットおよびキャリア イーサネット機能の基本的なプロビジョニングが可能な SOAP over HTTPS インターフェイスを提供します。DWDM や OTN などの光サービスをプロビジョニングする必要がある場合に、RESTConf API を使用できないときは、MTOSI インターフェイスを使用します。

REST API は、コンフィギュレーション ファイル、グループ管理、およびデバイス インポート機能を処理するその他の機能に加えて、システム情報、ほとんどの統計情報、およびアシュアランス情報を提供します。

RESTConf API は、上記の REST API と同様に RESTful インターフェイスに準拠しています。コア ルーティングとスイッチングだけでなく、キャリア イーサネット、L2/L3 VPN、回線エミュレーション、OTN および DWDM テクノロジーに関するすべてのプロビジョニングを提供します。

詳細については、cisco.com で入手できる個々の Cisco EPNM 統合ガイドを参照してください。

Cisco EPN ManagerRESTful API は、HTTP 要求を作成可能なプログラムまたはスクリプトで使用できる、言語に依存しないインターフェイスです。別のプログラムまたはプロセスから Cisco EPN Manager 上の操作を呼び出す場合は、REST API を使用してください。

アプリケーションは、RESTful API を使用して以下を実行できます。

• Cisco EPN Manager ドメイン内の物理デバイスと仮想デバイス、ネットワーク、アプライアンス、グループとユーザ、ポリシー、およびその他のモニタ対象エンティティに関する Cisco EPN Manager レポートを取得する。

• Cisco EPN Manager 独自の追加操作の呼び出し。

RESTful API クライアントは標準の HTTP 要求および応答を使用して Cisco EPN Manager とやり取りするため、RESTful API 応答はあらゆる Web ブラウザと互換性があります。多くのプログラミング言語には、HTTP 要求の作成と送信、および HTTP 応答の処理に専用のライブラリがあります。

REST API コールの大部分は、要求または応答内のデータをそれぞれ送信および返信します。これらのデータ ペイロードは、RESTful API コールに応じて 2 つの方法のいずれかでフォーマット化されます。JavaScript Object Notation（JSON）ペイロードを使用する RESTful API コールもあれば、XML ペイロードを使用するものもあります。通常の場合、複雑と見なされるアプリケーションには両方を使用する必要があります。

JSON ベースの RESTful API コールは、JSON ペイロードを使用した単純な HTTP 要求および応答です。JSON は、判読可能なデータ交換のために設計された軽量テキスト ベースのオープン スタンダードです。JSON は、単純なデータ構造と連想配列を表します。アプリケーションは、特殊な RESTful API ライブラリを使用することなく JSON ベースの API を直接呼び出し、アプリケーションに固有の方法を使用して JSON データを解析します。

Cisco EPN Manager API へのすべての要求でユーザ認証が必要です。認証の詳細については、「Authentication and Authorization」を参照してください。

RESTful API の認証は、Cisco EPN Manager の登録済みユーザのみが API 要求を作成できることを要求することによって実行されます。Cisco EPN Manager の場合、API へのアクセスは、NBI 読み取り、NBI 書き込み、NBI クレデンシャル（廃止）などの 3 つのユーザグループによって制御されます。これらの各グループは、異なる API セットへのアクセスを制御します。必要に応じて、複数のグループにユーザを割り当てることができます。API リソースのドキュメント ページで、アクセスに必要なユーザ グループを確認できます。Cisco EPN Manager で作成および登録したユーザには、一意の RESTful API アクセス キーが割り当てられます。

RESTConf トポロジ リンク取得リソースを入手するには、RESTful トポロジ リンク リソースを使用してこれらの値を取得し、必要な関連付けを実行します。

Cisco EPN Manager RESTful API のドキュメントにアクセスするには、次の操作を行います。

• Cisco EPN Manager を起動して右上隅にある をクリックすると、ウィンドウ設定メニューが開きます。

  

• [ヘルプ（Help）] > [APIヘルプ（API Help）] > [REST API] を選択し、システム要件、開発環境のセットアップ方法、ライブラリのインストール方法、RESTful API の使用方法、すべての Cisco EPN Manager REST API 関数のリスト、REST API リソース、さまざまな使用例、クエリなどを確認します。

• アラーム：アラーム モジュールは、アラームとイベントを取得して確認するメカニズムを提供します。推奨されるアラーム管理方法は、通知 API を介してリッスンすることです。サービスは異なるタイプまたは重要度のイベントを収集し、この API 経由で処理できます。

• パフォーマンス テスト：サービス パフォーマンス テストは、サービス プロビジョニングの一環としても、スタンドアロンでも実行できます。Restconf NBI は、スタンドアロンのパフォーマンス テストの実行をサポートしています。

• Quality of Service（QoS）：QoS は、ネットワーク トラフィックの差別化サービスを配信できるようにする一連の機能です。Cisco EPN Manager を使用して、キャリア イーサネット インターフェイスで QoS を設定できます。

• OAM：EPNM RESTConf API の OAM テストは、2 つの一般的なカテゴリに分類されます（サービス OAM 設定とネットワーク リソース OAM 設定）。Y.1731、Y.1564、および BERT テストでは、service-oam-config エンドポイントが使用されます。OTDR の場合は、network-resource-oam-config エンドポイントが使用されます。EPNM RESTConf OAM コールは、テストを開始するための POST コマンドを提供します。この要求によって、テスト ID とテスト要求 ID が生成されます。通常は、このテスト ID を後続のコールで使用して結果を取得します。ほとんどのテスト タイプには個々の URL があります。

• サービス プロファイル：サービス プロファイルには、各回線/VC タイプのプロビジョニングに使用できる事前定義済みのプロビジョニング要求（注文データ）が含まれています。NBI プロビジョニング要求では、サービス プロファイル リファレンスを使用して、プロビジョニングで使用するプロビジョニング要求データを取得できます。要求でプロビジョニング データがサービス プロファイル リファレンスとともに提供されているにもかかわらず、ユーザがデータを提供した場合、要求が送信されてプロビジョニングが実行される前に、サービス プロファイルに格納されているデータがユーザ提供データとマージされて、プロファイル データがオーバーライドされます。サービス プロファイルは、EPNM サービス プロファイル ウィザード GUI を使用して作成できます。

• 顧客向けサービス（CFS）：CFS は回線/VC の顧客向けデータを表します。CFS は検出された RFS から派生し、ネットワーク内の回線/VC のエンドポイントを表します。CFS 検出時に、検出された RFS オブジェクトに対して CFS オブジェクトが作成されます。

• リソース向けサービス（RFS）：RFS は異なるデバイス上のリソース間の関係を表します。RFS 検出時に、デバイス レベルのオブジェクトとネットワーク レベルのオブジェクトが作成されます。デバイス レベルの RFS オブジェクトは、デバイス レベル設定の回線/VC 設定部分を表します。ネットワーク レベルの RFS オブジェクトは、デバイスまたはその他のネットワーク レベルのオブジェクトを集約して、ネットワーク レベルのエンティティを表します。

Cisco EPN Manager APIのすべての要求でユーザ認証が必要です。要求で認証の詳細が指定されていない場合、要求はログイン ページにリダイレクトされます。認証の詳細は、要求の HTTP ヘッダーを介して渡される場合があります。詳細については、Cisco EPN Manager API ドキュメントの「Authentication, Authorization, and Security」のトピック（[ホーム（Home）] > [認証、認可、セキュリティ（Authentication, Authorization, and Security）]）を参照してください。

Cisco EPN Manager の場合、API へのアクセスは、NBI 読み取り、NBI 書き込み、NBI クレデンシャル（廃止）などのユーザグループによって制御されます。これらの各グループは、異なる API セットへのアクセスを制御します。必要に応じて、複数のグループにユーザを割り当てることができます。API リソースのドキュメント ページで、アクセスに必要なユーザ グループを確認できます。

（注）	実稼働環境では、JSESSIONID を使用することをお勧めします。

Cisco EPN Manager REST API を使用すると、アプリケーションはプログラムによって Cisco EPN Manager とやり取りできます。これらの要求を通じて、Cisco EPN Manager のリソースへのアクセス権が付与されます。API コールを使用して、Cisco EPN Manager ワークフロー、アラームとイベントのモニタリング、デバイスインベントリの収集、ネットワーククライアントと使用状況のモニタリング、デバイスの設定、デバイスインベントリなどを実行できます。詳細については、Cisco Evolved Programmable Network Manager API ドキュメントの「Getting Started」トピック（Home > Getting Started）を参照してください。

EPNM から簡単な段階的プロセスで統計データを取得できます。これは、複数の REST 統計エンドポイント間でかなり一貫性のある一般的な使用パターンです。一般に、概略的な最初のコールでは、使用可能なメトリックのリストが返されます。そのコールから特定のメトリックに関する詳細な統計の 2 番目のリストが返され、そこから実際のデータ系列が返されます。

統計の例「エンドポイント コールの継承：特定の回線の ESR PM データ」を次に示します。

GET /webacs/api/v1/op/statisticsService/circuits?circuitName=VSO5_TO_HUB2
	GET /webacs/api/v1/op/statisticsService/circuits/metrics?circuitType=ODUUNI&circuitId=161374613
	GET /webacs/api/v1/op/statisticsService/circuits/metrics/ESR_PM?maxResults=24&timeInterval=6&endpoint-
Name=ODU20/4/0/0/1&location=FEND&circuitType=ODUUNI&deviceId=124606492_10.201.1.174&circuitId=161374613

（注）	最後の 2 つのコールの URL は、前のコールの本文で提供されました。