Cisco SCMS SCE Subscriber API プログラミング ガイド Release 3.1
API イベント
API イベント
発行日;2012/02/06 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 946KB) | フィードバック

目次

API イベント

API イベント

ネットワーク ID 管理イベント

ログイン イベント

ログアウト イベント

ネットワーク ID 更新イベント

ポリシー プロファイル管理イベント

プロファイル更新イベント

クォータ管理イベント

クォータ更新イベント

クォータ ステータス取得イベント

クォータ ステータス イベント

クォータ下限しきい値超過イベント

クォータ枯渇イベント

クォータ ステート復元イベント

SCE同期手順イベント

同期開始イベント

同期終了イベント

サブスクライバ取得イベント

API イベント

この章では、SCMS SCE Subscriber API がアクセスする各イベントについて説明します。

「API イベント」

API イベント

API は一連のイベント、つまり、ポリシー サーバと SCE プラットフォーム間で送受信された一連の定義済みメッセージにアクセスします。

図3-1 API イベントの概要

 

すべてのメッセージには、メッセージの目的に従ってタイプを割り当てることができます。

要求 ― 情報または実行するアクションを要求します。要求のあとに応答が発生しないことがあります。

応答 ― 直前の要求に応答します。

通知 ― イベントが発生したことを反対側に通知します。

ほとんどのイベントは プッシュ モデルおよび プル モデルで使用できます。「サブスクライバ統合モデル」を参照してください。

イベントは次のサブスクライバ プロビジョニング プロセス グループに分割できます。

ネットワーク管理イベント ― サブスクライバ ネットワーク ID マッピングの変更に関連するイベントが含まれます。

ポリシー プロファイル管理イベント ― サブスクライバ ポリシー プロファイルパラメータの変更に関連するイベントが含まれます。

クォータ管理イベント ― サブスクライバ クォータの管理に関連するイベントが含まれます。

SCE 同期管理イベント ― SCE 同期プロセスの管理に関連するイベントが含まれます。

バルク操作を実行して、複数のサブスクライバ上の同じイベントに関する複数のトリガーを 1 つのグローバル イベントにバンドルできます。

ここでは、各タイプのイベントの概要を示します。

「ネットワーク ID 管理イベント」

「ポリシー プロファイル管理イベント」

「クォータ管理イベント」

「SCE同期手順イベント」

ログイン イベント

サブスクライバがネットワークに接続すると、ログイン イベントが発生します。ログイン イベントは、プル モデルおよびプッシュ モデルで異なります。

「プッシュ モデル」

「プル モデル」

プッシュ モデル

プッシュ統合モデルでは、ポリシー サーバによって SCE にサブスクライバが導入されます。たとえば、ポリシー サーバは Authentication, Authorization, Accounting(AAA; 認証、認可、アカウンティング)などの外部エンティティからサブスクライバ ログイン通知を受信し、必要なサブスクライバ属性を抽出して、情報を SCE プラットフォームに「プッシュ」します。

図3-2 ログイン イベント--プッシュ モデル

 

サブスクライバ ログイン操作を実行すると、新しいサブスクライバ レコードが SCE に作成されたり、既存サブスクライバが更新されたりすることがあります。たとえば、ケーブル モデム ネットワークの場合、サブスクライバはケーブル モデムです。このケーブル モデムに接続された CPE は、IP アドレスのリスト(あるいは範囲)として設定されます。この場合、同じモデムに接続された 新しい CPE にログインすると、CPE の IP アドレスがサブスクライバのネットワーク ID リストに追加されます。

プル モデル

プル統合モデルでは、SCE は着信データ トラフィックから新しいサブスクライバを検出すると想定されます。新しいサブスクライバはアノニマス サブスクライバとしてシステムに入力され、いずれかのデフォルト ポリシーが割り当てられます。SCE は外部システムに要求(ログインプル要求)を送信し、サブスクライバ ログイン情報(ログインプル応答)を提供します。この IP に対応する情報がない場合は、要求が省略されます。SCE に提供されるログイン情報によって、アノニマス サブスクライバは実際のサブスクライバに置き換えられ、正しいポリシーが適用されます。

外部システムがログインを拒否して、アノニマス サブスクライバからトラフィックが着信し続けている場合は、プル要求が再試行されます。

図3-3 ログイン イベント--プル モデル

 


) ログイン要求イベントおよびログイン プル応答イベントは「ネットワーク ID 管理イベント」として分類されているにもかかわらず、SCE にサブスクライバ情報をすべて送信できるように最適化されています。単一のポリシー サーバでサブスクライバ プロビジョニングのすべてのパートを実行する場合は、これらのイベントを使用して、ポリシー プロファイルおよびクォータを更新することを推奨します。複数のポリシー サーバが配置されたトポロジの場合は、ポリシー プロファイルおよびクォータの情報を更新するために、別々のイベントを使用します(以下を参照)。トポロジについての詳細は、「サポート対象トポロジ」を参照してください。


ログアウト イベント

ログアウト イベントは、サブスクライバが特定のネットワーク ID を使用しないことを示します。ログアウト イベントのあとに、SCE からサブスクライバ レコードが削除されるとはかぎりません。たとえば、ケーブル モデム ネットワークで複数の CPE が同じモデムに接続されている場合は、1 つの CPE からログアウトしても、別の CPE が接続されたままであれば、サブスクライバは削除されないことがあります。すべての CPE(サブスクライバのネットワーク ID)を切断すると、サブスクライバが実際に削除されます。

図3-4 ログアウト要求イベント

 

プル モデルでは、特定の期間中にサブスクライバが非アクティブであることを SCE が識別した場合などに、ログアウト イベントが発生することがあります。SCE はサブスクライバを「ログアウト」し、ログアウト通知イベントを送信します。

図3-5 ログアウト通知イベント

 

ログアウト処理に続いてログアウト通知イベントが発生することもあります。このようになるのは、実際にサブスクライバが削除された場合です。たとえば、このサブスクライバに関係付けられている有効なネットワーク マッピング(IP)がこれ以上ない場合に、この処理が発生します。

図3-6 ログアウト要求イベント

 

ネットワーク ID 更新イベント

このイベントは、SCE プラットフォームの既存のサブスクライバのネットワーク ID を更新するために、ポリシー サーバから SCE に送信される要求です。このイベントに応答は不要です。

図3-7 ネットワーク ID 更新イベント

 

ポリシー プロファイル管理イベント

「プロファイル更新イベント」

プロファイル更新イベント

このイベントは、SCE プラットフォームの既存のサブスクライバのポリシー プロファイルを更新するために、ポリシー サーバから SCE に送信される要求です。このイベントに応答は不要です。

図3-8 プロファイル更新イベント

 


) 上記のように、ログイン要求イベントおよびログイン プル応答イベントによって、ポリシー プロファイルが更新されることもあります。


クォータ更新イベント

クォータ更新イベントは、SCE プラットフォームの既存のサブスクライバのクォータを更新するために、ポリシー サーバから SCE に送信される要求です。このイベントに応答イベントは不要です。

図3-9 クォータ更新イベント

 


) 上記のように、ログイン要求イベントおよびログイン プル応答イベントによって、クォータが更新されることもあります。


クォータ ステータス取得イベント

クォータ ステータス取得イベントは、SCE プラットフォームの既存のサブスクライバのクォータ情報を報告するために、ポリシー サーバから SCE に送信される要求です。このイベントのあとに、クォータ ステータス通知イベントが続きます。

図3-10 クォータ ステータス取得イベント

 


) ポリシー サーバから特定の要求がない場合でも、SCE からクォータ ステータス通知イベント定期的に送信されることがあります。「クォータ ステータス イベント」を参照してください。


クォータ ステータス イベント

SCE はクォータ ステータス通知イベントを使用して、残りのクォータをポリシー サーバに通知します。このイベントは、事前定義されたインターバルで定期的に呼び出されます。

図3-11 クォータ ステータス イベント

 

クォータ下限しきい値超過イベント

SCE はクォータ下限しきい値超過通知イベントを使用して、特定のサブスクライバの特定のサービスの残りのクォータが、事前定義されたしきい値を下回っていることを、ポリシー サーバに通知します。ポリシー サーバから SCE に送信されるクォータ更新要求イベントのあとに、このイベントが続くことがあります。ただし、この処理が必須なわけではありません。

図3-12 クォータ下限しきい値超過イベント

 

クォータ枯渇イベント

SCE はクォータ枯渇通知イベントを使用して、特定のサブスクライバの特定のサービスのクォータが枯渇していることをポリシー サーバに通知します。ポリシー サーバから SCE に送信されるクォータ更新要求イベントのあとに、このイベントが続くことがあります。

図3-13 クォータ枯渇イベント

 

クォータ ステート復元イベント

クォータ ステート復元イベントは、SCE プラットフォームの既存のサブスクライバのクォータを復元するために、SCE からポリシー サーバに送信される通知です。このイベントは、サブスクライバが SCE にログインした直後に呼び出されます。このイベントのあとに、ポリシー サーバからのクォータ更新イベントが続くことがあります。

図3-14 クォータ ステート復元イベント

 

同期開始イベント

同期開始要求イベントは、同期プロセスが開始しようとしていることを SCE に通知する場合に使用します。SCE はこの要求を使用して、同期プロセスの準備に必要な内部処理を実行します。このイベントには、プッシュおよびプル コンポーネントがあります。

図3-15 同期開始イベント

 

同期終了イベント

同期終了要求イベントは、同期プロセスが終了したことを SCE に通知する場合に使用します。このイベントには、プッシュおよびプル コンポーネントがあります。

図3-16 同期終了イベント

 

サブスクライバ取得イベント

ポリシー サーバは、SCE のプル モデル同期プロセス中に、SCE が現在処理しているサブスクライバをすべて取得する必要があります。サブスクライバ バルク取得要求イベントは、SCE が現在処理しているサブスクライバの次のバルクを取得するために、ポリシー サーバから SCE に送信される要求です。この要求を受信した SCE は、サブスクライバ名およびネットワーク ID を指定するサブスクライバ バルク取得応答イベントで応答します。

図3-17 サブスクライバ取得イベント

 

詳細は、「プル モデル」および「プル モデルの同期手順」を参照してください。