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

目次

使用する前に

SCMS SCE Subscriber API の制約事項

SCMS SCE Subsriber API

プラットフォーム

パッケージの内容

パッケージの解凍とインストール

UNIX プラットフォームへの配布ファイルのインストール

Windows プラットフォームへの配布ファイルのインストール

SCE プラットフォームの設定

前提条件

プル モードでの SCE の設定

RDR フォーマッタの設定

クォータ関連通知の送信に関する RDR フォーマッタの設定

異なるカテゴリへのクォータ RDR タグのマッピング

RDR サーバの設定

RDR サーバの設定の確認

RDR サーバのイネーブル化

RDR サーバ ポートの変更

API 切断タイムアウトの設定方法

API 切断タイムアウトの設定

切断タイムアウトのデフォルト値へのリセット

タイムアウト値の表示

使用する前に

この章では、SCE Subscriber API を使用できるプラットフォーム、API のインストール方法、コンパイル方法、および起動方法について説明します。

SCMS SCE Subscriber API には、外部アプリケーション(ポリシー サーバ)を SCE に直接接続して、サブスクライバ プロビジョニングを行う機能があります。

サブスクライバ プロビジョニング は、サブスクライバ ID を相関付けに使用して、サブスクライバの ネットワーク ID ポリシー プロファイル 、および クォータ 特性を更新するプロセスです。Service Control Application for Broadband(SCA BB)のサブスクライバの特性の詳細については、「サブスクライバの特性」を参照してください。

API を複数のポリシー サーバにインストールし、同時に使用できます。また、次の図のように、API ごとにサブスクライバ プロビジョニング プロセスの異なるパートを実行できます。

図1-1 複数のサーバにインストールされたSCE Subscriber API

 

API は Proprietary Remote Procedure Call(PRPC)プロトコルを使用して、SCE との接続上で転送を行います。PRPC はシスコが開発した独自の PRC プロトコルです。


) API インスタンスごとに特定の SCE プラットフォームとの接続が確立されます。


SCMS SCE Subscriber API の制約事項

バージョン 3.0.5 の API は古いバージョンと下位互換性がありますが、バイナリ互換性はありません。新しいバージョンを使用するには、古いバージョンの API を使用するアプリケーションを再コンパイルする必要があります。この API は下位互換性があるため、アプリケーションのソース コードを変更する必要はありません。


) SCE をバージョン 3.0.5 にアップグレードする場合は、API をバージョン 3.0.5 にアップグレードして、この API を使用するアプリケーションを再コンパイルする必要があります。


SCMS SCE Subsriber API

「プラットフォーム」

「パッケージの内容」

プラットフォーム

SCMS SCE Subscriber API は、Java バージョン 1.4 をサポートする任意のプラットフォームで実行できます。

パッケージの内容

簡潔にするため、ここではインストール ディレクトリ sce-java-api-_<version>_<build-number> <installdir> と示します。

<installdir> /javadoc フォルダには、SCE Subscriber API JAVADOC マニュアルが格納されています。

<installdir> /lib フォルダには、 sceapi.jar ファイルが格納されています。これは、API 実行可能ファイルです。さらに、API の実行に必要なその他の jar ファイルもこのフォルダに入っています。

 

表1-1 インストール ディレクトリのレイアウト

パス
名前
説明

<installdir>

README

API readme ファイル

<installdir>/javadoc

index.html

すべての API 仕様の索引

(API 仕様ファイルなど)

API 仕様に関するマニュアル

<installdir>/lib

sceapi.jar

SCE Subscriber API 実行可能ファイル

asn1rt.jar

API で使用されるユーティリティ jar

log4j.jar

API で使用されるユーティリティ jar

log4j.properties

ロギング機能で必要なプロパティ ファイル

jdmkrt.jar

API で使用されるユーティリティ jar

パッケージの解凍とインストール

SCMS SCE Subscriber API は SCMS SM-LEG 配布ファイルとの一部として配布され、 sce_api ディレクトリに格納されます。

SCMS SCE Subscriber API は UNIX tar ファイルにパッケージされています。SCMS SCE Subscriber API の解凍には、ほとんどの Windows 圧縮ユーティリティに含まれている UNIX tar ユーティリティを使用できます。

「UNIX プラットフォームへの配布ファイルのインストール」

「Windows プラットフォームへの配布ファイルのインストール」

UNIX プラットフォームへの配布ファイルのインストール


ステップ 1 SCMS SM-LEG 配布ファイルを解凍して、SCE Subscriber API 配布 tar ファイル sce-java-api-dist.tar.gz を特定します。

ステップ 2 配布ファイルを解凍します。

#>gunzip sce-java-api-dist.tar.gz
 

ステップ 3 SCE Subscriber API パッケージ tar ファイルを解凍します。

#>tar -xvf sce-java-api-dist.tar


 

Windows プラットフォームへの配布ファイルのインストール


ステップ 1 zip 解凍ツール(WinZip など)を使用してパッケージを解凍します。


 

SCE プラットフォームの設定

ここでは、API を正常に機能させるために SCE プラットフォームで実行される設定について説明します。

「前提条件」

「プル モードでの SCE の設定」

「RDR フォーマッタの設定」

「RDR サーバの設定」

「API 切断タイムアウトの設定方法」

前提条件

API は SCE プラットフォーム上の PRPC サーバに接続します。PRPC サーバはシスコが開発した独自の PRC プロトコルが動作するサーバです。詳細については、『 SCE User Guide 』を参照してください。

API を使用する前に、次の点を確認してください。

SCE が起動され稼働中であり、API のホスト マシンから到達できること

SCE 上の PRPC サーバが起動されていること

プル モードでの SCE の設定

プル モデル( プル モデルを参照)で稼働している SCE プラットフォームから、サブスクライバ情報に関する要求を送信できるようにするには、SCE プラットフォームの CLI(コマンドライン インターフェイス)を使用して、次のように設定します。

SCE プラットフォームについての詳細は、『 Cisco SCE 1000 2xGBE Installation and Configuration Guide 』または『 Cisco SCE 2000 4xGBE Installation and Configuration Guide 』を参照してください。


ステップ 1 サブスクライバ テンプレートを設定します。

(config if)#>subscriber template import CSV file
 

CSV ファイルのテンプレートおよびフォーマットの詳細については、『 Cisco Service Control Application for Broadband User Guide 』を参照してください。

ステップ 2 マッピングされていないサブスクライバ グループの範囲を設定します。

a. subscriber anonymous group import CLI を使用して、ファイルからアノニマス グループをインポートします。

(config if)#>subscriber anonymous group import CSV file
 

b. あるいは、 subscriber anonymous group name CLI を使用して、手動でアノニマス グループを定義します。

(config if)#>subscriber anonymous group name NAMEIP-range IP RANGE
 


 

クォータ関連通知の送信に関する RDR フォーマッタの設定

RDR フォーマッタからクォータ関連通知を送信できるようにするには、SCE プラットフォーム上で次のように RDR フォーマッタを設定します。


ステップ 1 RDR-formatter destination CLI を使用します。

#>RDR-formatter destination 127.0.0.1 port 33001 category number 4 priority 100
 


 

異なるカテゴリへのクォータ RDR タグのマッピング

デフォルトでは、クォータ RDR タグはカテゴリ 4 にマッピングされています。別のカテゴリが必要な場合は、次のコマンドを使用します。


ステップ 1 RDR-formatter rdr-mapping CLI を使用します。

#>RDR-formatter rdr-mapping tag-ID tag numbercategory-number number

) クォータ RDR タグ ID については、『Cisco Service Control Application for Broadband User Guide』を参照してください。



 

アプリケーションからクォータ関連通知を送信できるようにするには、『 Cisco Service Control Application for Broadband GUI 』の説明に従って、アプリケーションをイネーブルにする必要があります。設定方法については、『 Cisco Service Control Application for Broadband User Guide 』を参照してください。

RDR サーバの設定

クォータ通知を API が受信できるようにするには、RDR サーバをイネーブルにして、RDR フォーマッタで設定されているポートと同じポート上で待ち受ける必要があります。

「RDR サーバの設定の確認」

「RDR サーバのイネーブル化」

「RDR サーバ ポートの変更」

RDR サーバの設定の確認

RDR サーバの設定を確認するには、次の手順を実行します。


ステップ 1 show RDR-server CLI を使用します。

#>show RDR-serverRDR server is ONLINE
RDR server port is 33001
 


 

RDR サーバのイネーブル化

RDR サーバをイネーブルにするには、次の手順を実行します。


ステップ 1 RDR-server コンフィギュレーション CLI を使用します。

#>configure(config)#>RDR-server Default RDR server port is 33001
 


 

RDR サーバ ポートの変更

RDR サーバ ポートを変更するには、次の手順を実行します。


ステップ 1 RDR-server port CLI を使用します。

#>configure(config)#>RDR-server port port
 


 

API 切断タイムアウトの設定方法

SCE プラットフォームでは、切断した API を SCE プラットフォームに再接続するためのタイムアウトを設定できます。SCE はタイムアウト中にリソースを解放しないため、データは失われません。タイムアウトが経過しても、API が再接続しなかった場合、SCE は API が切断したとみなし、すべてのリソースを解放します。デフォルトのタイムアウト値は 5 分です。

「API 切断タイムアウトの設定」

「切断タイムアウトのデフォルト値へのリセット」

「タイムアウト値の表示」

API 切断タイムアウトの設定

API 切断タイムアウトを設定するには、次の手順を実行します。


ステップ 1 management-agent sce-api timeout CLI を使用します。

(config)# management-agent sce-api timeout timeout-in-sec
 


 

切断タイムアウトのデフォルト値へのリセット

API 切断タイムアウトをデフォルト値にリセットするには、次の手順を実行します。


ステップ 1 default management-agent sce-api timeout CLI を使用します。

(config)# default management-agent sce-api timeout
 


 

タイムアウト値の表示

タイムアウト値を表示するには、次の手順を実行します。


ステップ 1 show management-agent sce-api CLI を使用します。

# show management-agent sce-api