Cisco SCA BB Service Configuration API プログラマ ガイド Rel. 3.1
SCA BB Service Configuration API の概要
SCA BB Service Configuration API の概要
発行日;2012/02/01 | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 372KB) | フィードバック

目次

SCA BB Service Configuration API の概要

サービス コンフィギュレーション

Service Configuration API について

Service Configuration Management API について

Service Configuration Management API

Service Configuration Management API のクラス

Service Configuration Editing API について

Service Configuration Editing API

Service Configuration Editing API のデータ タイプ

Service Configuration API を使用したプログラム ワークフロー

SCA BB Service Configuration API の概要

この章では、Cisco SCA BB Service Configuration API(以下、Service Configuration API)を利用する場合に役立つさまざまな用語と概念について説明します。

「サービス コンフィギュレーション」

「Service Configuration API について」

サービス コンフィギュレーション

Cisco Service Control ソリューションの基本的なエンティティの 1 つはサービス コンフィギュレーションです。サービス コンフィギュレーションは、Service Control Engine(SCE)プラットフォーム上で稼働する Cisco Service Control Application のネットワーク トラフィックの分類方法、アカウンティングとレポートの方法、および制御方法を定義するコンフィギュレーション パラメータの集合体です。

サービス コンフィギュレーションを編集し SCE プラットフォームに適用すると、トラフィックの分類方法を変更し別のポリシーを実行できます。

サービス コンフィギュレーションおよびトラフィック処理の詳細については、『 Cisco Service Control Application for Broadband User Guide 』を参照してください。

Service Configuration API について

一般的に、Cisco SCA BB Console でのサービス コンフィギュレーションの編集と管理は手動で行います。Cisco SCA BB Console はコンフィギュレーションの各特性を編集し、SCE フラットフォームに適用する GUI ツールです。

Service Configuration API は、プログラムでサービス コンフィギュレーションを編集し、SCE プラットフォームにこのコンフィギュレーションを適用することによって、外部アプリケーションが SCE プラットフォームによって実行されるポリシーを変更できるようにします。

Service Configuration API は 2 つの部分で構成され、それぞれ異なる種類のタスクを扱います。

Service Configuration Management API -- SEC プラットフォームへのコンフィギュレーションの適用、ファイルへのコンフィギュレーションの保存など、サービス コンフィギュレーション全体で実行されるタスクを処理します。

Service Configuration Editing API -- 分類基準の変更、ポリシー ルールの追加など、1 つのサービス コンフィギュレーションへの変更を処理します。

Service Configuration Management API

Service Configuration Management API は次のタスクを実行するために使用できます。

新しいサービス コンフィギュレーションの作成 -- デフォルトの設定値を持つ新しいサービス コンフィギュレーションを作成します。このコンフィギュレーションは変更でき、SCE プラットフォームに適用したり、ファイルに保存したりできます。

ファイルへのサービス コンフィギュレーションの保存 -- PQB ファイルにサービス コンフィギュレーションを保存します。API が作成する PQB ファイルは SCA BB Console で編集できます。逆もまた同様です。

ファイルからのサービス コンフィギュレーションの読み込み -- SCE プラットフォームにサービス コンフィギュレーションを適用したり、サービス コンフィギュレーションを編集するために、PQB ファイルをロードします。

SCE フラットフォームへのサービス コンフィギュレーションの適用 -- SCE フラットフォームでサービス コンフィギュレーションを有効にします(この API の主動作)。API プロブラムから SCE プラットフォームへの接続を作成し、適用を実行します。接続後、この接続を使って SCE プラットフォームにサービス コンフィギュレーションを適用します。

SCE プラットフォームからのサービス コンフィギュレーションの取得 -- SCE プラットフォームから現在適用されているサービス コンフィギュレーションを取得します。API プロブラムから SCE プラットフォームへの接続を作成し、取得を実行します。接続後、この接続を使って SCE プラットフォームからコンフィギュレーションを送信します。

CSV ファイルへのサービス コンフィギュレーションの部分エクスポート -- CSV ファイルにゾーン、フレーバ、プロトコルなどサービス コンフィギュレーションの一部をエクスポートします。CSV ファイルは手動でまたは外部システムを使用して操作できます。また、サービス コンフィギュレーションにインポートして戻すこともできます。

CSV ファイルからサービス コンフィギュレーションを部分インポート -- CSVファイルからオープン サービス コンフィギュレーションへサービス コンフィギュレーションの一部をインポートします。プログラムはCSVファイルを自動的に作成し、サービス コンフィギュレーションへインポートしてから、SCEプラットフォームにアップデートされたコンフィギュレーションを適応します。

CSV ファイルに対してインポートまたはエクスポート可能なサービス コンフィギュレーションについては、『 Cisco Service Control Application for Broadband User Guide 』の「Using the Service Configuration Editor」の章を参照してください。CSV 形式については、『 Cisco Service Control Application for Broadband Reference Guide 』の「CSV File Formats」の章を参照してください。

Service Configuration Management API のクラス

Service Configuration Management API の主なクラスは次のとおりです。

SCABB -- SCE プラットフォームとの接続方法、処理の適用と取得に使用される方法を提供

ConnectionApi -- SCE プラットフォームとの接続

ImportExportApi -- PQB ファイルに対するサービス コンフィギュレーションの保存方法、読み取り方法を提供。また、CSV ファイルに対するサービス コンフィギュレーションの部分インポート方法、部分エクスポート方法を提供

ServiceConfigApi -- 新しいサービス コンフィギュレーションの作成方法、および SCE プラットフォームに対するサービス コンフィギュレーションの適用方法、取得方法を提供

ServiceConfig -- このクラスのオブジェクトは、SCE プラットフォームに適用される場合、サービス コントロール アプリケーションのネットワーク トラフィックに対する分類方法、アカウンティングとレポートの方法、および制御方法を決定するコンフィギュレーション パラメータのコンテナです。

Service Configuration Editing API

Service Configuration Editing API は次のタスクを実行するために使用できます。

サービス コンフィギュレーションの検査 -- コンフィギュレーションに含まれるサービスとサブスクライバ パッケージを判別するために、API は SCE プラットフォームから取得したコンフィギュレーションを検査できます。2 つのコンフィギュレーションを比較するために使用できます。

トラフィックを分類するためのコンフィギュレーション基準 -- サービス コンフィギュレーションは、HTTP トランザクションの URL などさまざまな基準に従って、トラフィックを分類する方法を決定できます。たとえば、特定の Web サイトへのアクセスを拒否する URL のリストを自動更新するために API を使用できます。

トラフィック制御の各種特性の設定 -- サービス コンフィギュレーションは、サービス単位のルールとサブスクライバ パッケージ単位のルール、詳細な BW コントロール階層、およびクォータ管理モデルを使用して、ネットワーク トラフィックの制御方法を決定します。API は設定変更のために使用できます。そのため、SCE プラットフォームによって実行されるポリシーは、一部の外部トリガーに対する応答または指定された時間間隔での応答として、自動的に変更されます。


) サブスクライバに対するポリシーのプロビジョニングはこの API を使用して実行できません。そのため「SM API プログラマーズ ガイド」で説明されている Subscriber API を使用します(『Cisco SCMS SM Java API Programmer Guide』または『Cisco SCMS SM C/C++ API Programmer Guide』を参照)。



) カウンタのモニタリングはこの API を使用して実行できません。このため、SCE プラットフォームへの SNMP を使用してカウンタをモニタします(『Cisco Service Control Application for Broadband Reference Guide』の「SCA BB Proprietary MIB Reference」の章を参照)。または、Cisco Service Control Management Suite Collection Manager データベースに対する SQL を使用してカウンタをモニタします(『Cisco Service Control Management Suite Collection Manager User Guide』を参照)。


Service Configuration Editing API のデータ タイプ

トラフィック分類設定の主なデータ タイプは、サービス、プロトコル、シグニチャ、ゾーン、およびフレーバです。

トラフィックのアカウンティングとレポートの主なデータ タイプは、カウンタ定義とさまざまな RDR パラメータです。

トラフィック制御の主なデータ タイプは、パッケージ、ルール、サブスクラバ BW コントローラ、およびグローバル BW コントローラです。

サービス コンフィギュレーションを構成するオブジェクト(サービス コンフィギュレーション エンティティ)の説明はこのマニュアルでは取り扱いません。『 Cisco Service Control Application for Broadband User Guide 』の「Traffic Processing Overview」の章を参照してください。Service Configuration Editing API を使用する SCA BB Console を利用すると、コンフィギュレーション オブジェクトに詳しくなり、API を使用して実行可能なことが分かるようになります。

Service Configuration API を使用したプログラム ワークフロー

Service Configuration API を使用するアプリケーションの一般的なワークフロー:

詳細手順


ステップ 1 アプリケーションは SCE プラットフォームからサービス コンフィギュレーションを取得します。

ステップ 2 アプリケーションはサービス コンフィギュレーションを変更します。

たとえば、アプリケーションは CSV ファイルからゾーン設定をインポートします(ゾーンは分類基準として機能するネットワーク側の IP アドレスのリストです)。サービス コンフィギュレーションでゾーンが定義されると、そのゾーンに送信されるすべてのネットワーク トラフィックを制御するルールを作成できます。

ステップ 3 分類と実行が更新されたコンフィギュレーションに基づいて行われるように、アプリケーションは SCE プラットフォームに変更されたサービス コンフィギュレーションを適用します。

もう 1 つの一般的なワークフローは(SCA BB Console にて手動で作成される)事前に定義されたサービス コンフィギュレーションのセットを使用します。このワークフローでは、一部の外部トリガーに対する応答または指定された時間での応答として、SCE プラットフォームに各サービス コンフィギュレーションを適用するために、アプリケーションは API を使用します。

Service Configuration API を使用したワークフローの実装は、「SCA BB Service Configuration API を使用したプログラミング」で説明されています。