Cisco Broadband Access Center アドミニストレータガイド Release 4.0

偏向のない言語

この製品のマニュアルセットは、偏向のない言語を使用するように配慮されています。このマニュアルセットでの偏向のない言語とは、年齢、障害、性別、人種的アイデンティティ、民族的アイデンティティ、性的指向、社会経済的地位、およびインターセクショナリティに基づく差別を意味しない言語として定義されています。製品ソフトウェアのユーザーインターフェイスにハードコードされている言語、RFP のドキュメントに基づいて使用されている言語、または参照されているサードパーティ製品で使用されている言語によりドキュメントに例外が存在する場合があります。シスコのインクルーシブランゲージに対する取り組みの詳細は、こちらをご覧ください。

翻訳について

このドキュメントは、米国シスコ発行ドキュメントの参考和訳です。リンク情報につきましては、日本語版掲載時点で、英語版にアップデートがあり、リンク先のページが移動/変更されている場合がありますことをご了承ください。あくまでも参考和訳となりますので、正式な内容については米国サイトのドキュメントを参照ください。

マニュアルのコンテンツ

このマニュアル内で検索

ご利用いただける言語

Download Options

Book Title

Cisco Broadband Access Center アドミニストレータガイド Release 4.0

Chapter Title

プロビジョニング API の使用例

PDF - Complete Book (4.55 MB) PDF - This Chapter (736.0 KB)
View with Adobe Reader on a variety of devices

検索結果

Updated:: 2017年5月30日

プロビジョニング API の使用例

この付録では、プロビジョニング Application Programming Interface（API; アプリケーションプログラミングインターフェイス）の最も一般的な使用例を取り上げます。詳細や、個々の API コールと機能を説明するサンプルの Java コードセグメントについては、Cisco Broadband Access Center (BAC) 4.0 の API Javadoc を参照してください。

次の使用例は、デバイスまたはサービス（またはその両方）のプロビジョニングに直接関連しています。サービスクラス、DHCP 基準、およびライセンスの管理など、多くの管理操作についてはここでは取り上げません。関連する API コールの詳細については、API Javadoc を参照することをお勧めします。これらのアクティビティのほとんどは、管理者のユーザインターフェイスを使用して実行することもできます。

この付録では、次の使用例について説明します。

• 「API クライアントの作成方法」

• 「使用例」

API クライアントの作成方法

各使用例を参照する前に、API クライアントの作成方法について十分に理解しておく必要があります。API クライアントを作成するには、この項で説明するワークフローを使用します。

ステップ 1 Provisioning API Command Engine（PACE）への接続を作成します。

// The PACE connection to use throughout the example. When

// executing multiple batches in a single process, it is advisable

// to use a single PACE connection that is retrieved at the start

// of the application. When done with the connection, YOU MUST

// explicitly close the connection with the releaseConnection()

// method call.

PACEConnection connection = null;

// Connect to the Regional Distribution Unit (RDU).

// The parameters defined at the beginning of this class are

// used here to establish the connection. Connections are

// maintained until releaseConnection() is called. If

// multiple calls to getInstance() are called with the same

// arguments, you must still call releaseConnection() on each

// connection you received.

// The call can fail for one of the following reasons:

// - The hostname / port is incorrect.

// - The authentication credentials are invalid.

try

{

connection = PACEConnectionFactory.getInstance(

// RDU host rduHost,

// RDU port rduPort,

// User name userName,

// Password password);

}

catch (PACEConnectionException e)

{

// Handle connection error:

System.out.println("Failed to establish a PACEConnection to [" +

userName + "@" + rduHost + ":" + rduPort + "]; " +

e.getMessage());

System.exit(1);

}

ステップ 2 バッチの新しいインスタンスを作成します。

// To perform any operations in the Provisioning API, you must

// first create a batch. As you add commands to the batch,

// nothing gets executed until you post the batch.

// Multiple batches can be started concurrently against a

// single connection to the RDU.

Batch myBatch = connection.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

ステップ 3 API コマンドをバッチに登録します。このステップの例では、 getDetails(...) コールを使用しています。

// Use the Provisioning API to get all of the information for

// the specified MAC address. Since methods aren't actually

// executed until the batch is posted, the results are not

// returned until after post() completes. The getCommandStatus()

// followed by getData() calls must be used to access the results

// once the batch is posted.

final DeviceID modemMACAddress = DeviceID.getInstance("1,6,00:11:22:33:44:55",

KeyType.MAC_ADDRESS);

List options = new ArrayList();

options.add(DeviceDetailsOption.INCLUDE_LEASE_INFO);

myBatch.getDetails(modemMACAddress, options);

ステップ 4 バッチを Regional Distribution Unit（RDU）サーバに送信します。

// Executes the batch against the RDU. All of the

// methods are executed in the order entered.

BatchStatus bStatus = null;

try

{

// Post batch in synchronous fashion without a timeout. This method will block until

// results are returned. Other API calls are available to submit a batch with timeout // or in asynchronous (non-blocking) fashion.

bStatus = myBatch.post();

}

catch (ProvisioningException pe)

{

System.out.println("Failed to query for modem with MAC address [" +

modemMACAddress + "]; " + pe.getMessage());

System.exit(2);

}

ステップ 5 バッチのステータスを確認します。

// Check if any errors occurred during the execution of the

// batch. Exceptions occur during post() for truly exceptional

// situations such as failure of connectivity to RDU.

// Batch errors occur for inconsistencies such as no lease

// information for a device requiring activation. Command

// errors occur when a particular method has problems, such as

// trying to add a device that already exists.

//check batchStatus and commandStatus

//for any error

CommandStatus commandStatus = null;

if (batchStatus.getCommandCount() > 0)

{

commandStatus = batchStatus.getCommandStatus(0);

}

if (batchStatus.isError()

|| commandStatus == null

|| commandStatus.isError())

{

System.out.println("Failed to query for modem with MAC address [" +

modemMACAddress + "]; " + bs.getStatusCode().toString() + ", "

+ bs.getErrorMessage());

for (int i = 0; i < bs.getCommandCount(); i++)

{

CommandStatus cs = bs.getCommandStatus(i);

System.out.println("Cmd " + i + ": status code "

+ cs.getStatusCode().toString() + ", " + cs.getErrorMessage());

}

エラーがなければ、バッチコールは正常終了の結果を返します。

// Successfully queried for device.

System.out.println("Queried for DOCSIS modem with MAC address ["+

modemMACAddress + "]");

// Display the results of the command (TreeMap is sorted). The

// data returned from the batch call is stored on a per-command

// basis. In this example, there is only one command, but if

// you had multiple commands all possibly returning results, you

// could access each result by the index of when it was added.

// The first method added is always index 0. From the status of

// each command, you can then access the accompanying data by

// using the getData() call. Since methods can return data of

// different types, you will have to cast the response to the

// type indicated in the Provisioning API documentation.

Map deviceData = (Map)bStatus.getCommandStatus(0).getData();

// Created a sorted map view

Map<String, Object> deviceDetails = new TreeMap(deviceData);

for(String key: deviceDetails.keySet())

{

System.out.println(" " + key + "=" + deviceDetails.get(key));

}

ステップ 6 接続を解放します。

// Once the last batch has been executed, the connection can

// be closed to the RDU. It is important to explicitly

// close connections since it helps ensure clean shutdown of

// the Java virtual machine.

connection.releaseConnection();

使用例

この項には、次の使用例を記載しています。

• 「固定標準モードでセルフプロビジョニングされたモデムとコンピュータ」

• 「固定標準モードでの新しいコンピュータの追加」

• 「加入者のディセーブル化」

• 「モデムおよびセルフプロビジョニングされたコンピュータの事前プロビジョニング」

• 「既存のモデムの修正」

• 「加入者のデバイスの登録解除と削除」

• 「無差別モードでの最初のアクティベーションのセルフプロビジョニング」

• 「無差別モードでの 100 台のモデムの一括プロビジョニング」

• 「無差別モードでの最初のアクティベーションの事前プロビジョニング」

• 「既存のモデムの交換」

• 「無差別モードでの 2 台目のコンピュータの追加」

• 「NAT を使用した最初のアクティベーションのセルフプロビジョニング」

• 「NAT を持つモデムの背後への新しいコンピュータの追加」

• 「別の DHCP スコープへのデバイスの移動」

• 「イベントを使用したデバイス削除のロギング」

• 「イベントを使用した RDU 接続の監視」

• 「イベントを使用したバッチ完了のロギング」

• 「デバイスの詳細情報の取得」

• 「デバイスタイプを使用した検索」

• 「ベンダープレフィックスまたはサービスクラスを使用したデバイスの検索」

• 「PacketCable eMTA の事前プロビジョニング」

• 「PacketCable eMTA 上での SNMP クローニング」

• 「PacketCable eMTA の差分プロビジョニング」

• 「動的設定ファイルを使用した DOCSIS モデムの事前プロビジョニング」

• 「オプティミスティックロッキング」

• 「加入者の帯域幅の一時的なスロットリング」

• 「CableHome WAN-MAN の事前プロビジョニング」

• 「ファイアウォール設定を持つ CableHome」

• 「CableHome WAN-MAN のデバイス機能の取得」

• 「CableHome WAN-MAN のセルフプロビジョニング」

固定標準モードでセルフプロビジョニングされたモデムとコンピュータ

加入者は、戸建住宅内にコンピュータを設置し、DOCSIS ケーブルモデムを購入しました。コンピュータには Web ブラウザがインストールされています。

目的

次のワークフローを使用して、プロビジョニングされていない新しい DOCSIS ケーブルモデムとコンピュータをオンラインにし、適切なレベルのサービスを受けられるようにします。

ステップ 1 加入者は DOCSIS ケーブルモデムを購入して住宅内に設置し、コンピュータをケーブルモデムに接続します。

ステップ 2 加入者はモデムとコンピュータの電源をオンにし、BAC が制限付きアクセス権をモデムに付与します。コンピュータとモデムには、制限付きアクセスプールから IP アドレスが割り当てられます。

ステップ 3 加入者は Web ブラウザを起動します。スプーフィング DNS サーバにより、Web ブラウザがサービスプロバイダーの登録サーバ（OSS ユーザインターフェイスやメディエータなど）にアクセスします。

ステップ 4 加入者はサービスプロバイダーのユーザインターフェイスを使用して、サービスクラスの選択など、登録に必要な手順を終了します。

ステップ 5 サービスプロバイダーのユーザインターフェイスは、加入者の情報（選択されたサービスクラスやコンピュータの IP アドレスなど）を BAC に渡します。次に、BAC が加入者のモデムとコンピュータを登録します。

// First we query the computer's information to find the

// modem's MAC Address. We use the computer IP Address (the web browser

// received this when the subscriber opened the service provider’s

// web interface

PACEConnection connection = PACEConnectionFactory.getInstance(

"localhost", 49187, "admin", "changeme");

// NO_ACTIVATION is the activation mode because this is a query.

// NO_CONFIRMATION is the confirmation mode because we are not

// attempting to reset the device.

// NO_PUBLISHING is the publishing mode because we are not attempting

// to publish to external database.

Batch batch = connection.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

// register getAllForIPAddress to the batch

batch.getAllForIPAddress("10.0.14.38");

BatchStatus batchStatus = null;

// post the batch to RDU server

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

// Get the LeaseResults object after posting a batch.

CommandStatus commandStatus = batchStatus.getCommandStatus(0);

LeaseResults computerLease = (LeaseResults)commandStatus.getData();

// Derive the modem MAC address from computer's network

// information. The "1,6" is a standard prefix for an Ethernet

// device. The fully qualify MAC Address is required by BACC

StringBuffer modemMACAddress = new StringBuffer();

modemMACAddress.append("1,6,");

modemMACAddress.append(computerLease.getSingleLease().get("relay-agent-remote-id"));

// Create MacAddress object from the string

MACAddress modemMACAddressObject = new MACAddress(modemMACAddress.toString());

List<DeviceID> modemDeviceIDList = new ArrayList<DeviceID>();

modemDeviceIDList.add(modemMACAddressObject);

// Create a new batch to add modem device

batch = connection.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

// Register add API to the batch

batch.add(DeviceType.DOCSIS, modemDeviceIDList,

null, null, "0123-45-6789", "silver", "provisioned-cm", null);

// post the batch to RDU server

// Derive computer MAC address from computer's network information.

String computerMACAddress =

(String)computerLease.getSingleLease().get(DeviceDetailsKeys.MAC_ADDRESS);

// Create a map for computer property.

Map<String, Object> properties = new HashMap<String, Object>();

properties.put(IPDeviceKeys.MUST_BE_BEHIND_DEVICE, modemMACAddress.toString());

List<DeviceID> compDeviceIDList = new ArrayList<DeviceID>();

MACAddress computerMACAddressObject = new MACAddress(computerMACAddress);

compDeviceIDList.add(computerMACAddressObject);

// Register add API to the batch

batch.add(DeviceType.COMPUTER, compDeviceIDList,

null, null, "0123-45-6789", null, "provisioned-cpe", properties);

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

ステップ 6 プロビジョニングクライアントは performOperation(DeviceOperation deviceOperation, DeviceID deviceID, Map<String,Object> parameters を呼び出してモデムをリブートし、プロビジョニングされたアクセス権をモデムに付与します。

// Reset the computer

// Create a new batch

batch = connection.newBatch(

// No reset

ActivationMode.AUTOMATIC,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION);

// Register performOperation command to the batch

batch.performOperation(DeviceOperation.RESET, modemMACAddressObject, null);

// Post the batch to RDU server

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

ステップ 7 ユーザインターフェイスは、加入者にコンピュータをリブートするように求めます。

リブート後、コンピュータは新しい IP アドレスを受信します。これで、ケーブルモデムとコンピュータの両方が、プロビジョニングされたデバイスとなります。コンピュータは、サービスプロバイダーのネットワークを介してインターネットにアクセスできます。

固定標準モードでの新しいコンピュータの追加

Mmultiple System Operator（MSO; マルチプルシステムオペレータ）は、加入者に対し、ケーブルモデムの背後に 2 台のコンピュータを接続することを許可しています。加入者は 1 台のコンピュータをすでに登録しています。今度は、職場から自宅にラップトップコンピュータを持ち帰ってアクセスを設定しようとしています。加入者はハブを設置し、ラップトップをハブに接続します。

目的

次のワークフローを使用して、プロビジョニングされていない新しいコンピュータを、すでにプロビジョニングされているケーブルモデムを使用してオンラインにし、新しいコンピュータが適切なレベルのサービスを受けられるようにします。

ステップ 1 加入者は新しいコンピュータの電源をオンにし、BAC が制限付きアクセス権をコンピュータに付与します。

ステップ 2 加入者は新しいコンピュータの Web ブラウザを起動します。スプーフィング DNS サーバにより、Web ブラウザがサービスプロバイダーの登録サーバ（OSS ユーザインターフェイスやメディエータなど）にアクセスします。

ステップ 3 加入者はサービスプロバイダーのユーザインターフェイスを使用して、新しいコンピュータの追加に必要な手順を終了します。

ステップ 4 サービスプロバイダーのユーザインターフェイスは、加入者の情報（選択されたサービスクラスやコンピュータの IP アドレスなど）を BAC に渡します。次に、BAC が加入者のモデムとコンピュータを登録します。

// First we query the computer's information to find the

// modem's MAC Address. We use the computer IP address (the web browser

// received this when the subscriber opened the service provider’s

// web interface.

PACEConnection connection = PACEConnectionFactory.getInstance(

"localhost", 49187, "admin", "changeme");

// NO_ACTIVATION is the activation mode because this is a query

// NO_CONFIRMATION is the confirmation mode because we are not

// attempting to reset the device

// NO_PUBLISHING is the publishing mode because we are not attempting

// to publish to external database.

Batch batch = connection.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

// register getAllForIPAddress to the batch

batch.getAllForIPAddress("10.0.14.39");

BatchStatus batchStatus = null;

// post the batch to RDU server

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

// Get the LeaseResults object after posting a batch.

CommandStatus commandStatus = batchStatus.getCommandStatus(0);

LeaseResults computerLease = (LeaseResults)commandStatus.getData();

// derive the modem MAC address from computer's network

// information. The "1,6" is a standard prefix for an Ethernet

// device. The fully qualify MAC Address is required by BACC

StringBuffer modemMACAddress = new StringBuffer();

modemMACAddress.append("1,6,");

modemMACAddress.append(computerLease.getSingleLease().get("relay-agent-remote-id"));

// derive computer MAC address from computer's network information.

String computerMACAddress =

(String)computerLease.getSingleLease().get(DeviceDetailsKeys.MAC_ADDRESS);

//Create a map for computer property.

Map<String, Object> properties = new HashMap<String, Object>();

// setting IPDeviceKeys.MUST_BE_BEHIND_DEVICE on the computer ensures

// that when the computer boots, it will only receive its provisioned

// access when it is behind the given device. If it is not behind

// the given device, it will receive default access (unprovisioned)

// and hence fixed mode.

properties.put(IPDeviceKeys.MUST_BE_BEHIND_DEVICE, modemMACAddress);

// the IPDeviceKeys.MUST_BE_IN_PROV_GROUP ensures that the computer

// will receive its provisioned access only when it is brought up in

// the specified provisioning group. This prevents the computer

// (and/or) the modem from moving from one locality to another

// locality.

properties.put(IPDeviceKeys.MUST_BE_IN_PROV_GROUP, "bostonProvGroup");

List<DeviceID> compDeviceIDList = new ArrayList<DeviceID>();

MACAddress computerMACAddressObject = new MACAddress(computerMACAddress);

compDeviceIDList.add(computerMACAddressObject);

batch = connection.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

// register add API to the batch

batch.add(

DeviceType.COMPUTER, // deviceType: Computer

compDeviceIDList, // compDeviceIDList: the list of DeviceIDs derived from // computerLease

null, // hostName: not used in this example

null, // domainName: not used in this example

"0123-45-6789", // ownerName

null, // class of service: get the default COS

"provisionedCPE", // dhpcCriteria: Network Registrar uses this to

// select a modem lease granting provisioned IP address properties // device properties

);

// post the batch to RDU server

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

ステップ 5 ユーザインターフェイスは、加入者にコンピュータをリブートするように求めます。リブートすると、BAC が登録済みのサービスレベルをコンピュータに付与します。

これで、コンピュータはプロビジョニングされたデバイスとなり、適切なレベルのサービスにアクセスできます。

加入者のディセーブル化

加入者が滞納を繰り返した場合、サービスプロバイダーは加入者のインターネットアクセスをディセーブルにする必要があります。

目的

次のワークフローを使用して、動作中のケーブルモデムとコンピュータをディセーブルにします。その結果、デバイスがユーザのインターネットアクセスを一時的に制限します。また、この使用例では、ユーザのブラウザを特別なページにリダイレクトして、次のように通知することがあります。

You haven’t paid your bill so your Internet access has been disabled.

ステップ 1 サービスプロバイダーのアプリケーションはプロビジョニングクライアントプログラムを使用して、加入者のデバイスすべてのリストを BAC に要求します。

ステップ 2 次に、サービスプロバイダーのアプリケーションはプロビジョニングクライアントを使用して、加入者のデバイスを個々にディセーブルにするか、または制限します。

PACEConnection conn = PACEConnectionFactory.getInstance(

"localhost", 49187, "admin", "admin123");

//get all for owner ID

Batch batch = conn.newBatch();

batch.getAllForOwnerID("0123-45-6789");

BatchStatus batchStatus = null;

try

{

batchStatus = batch.post();

}

catch(Exception e)

{

e.printStackTrace();

}

CommandStatus commandStatus = batchStatus.getCommandStatus(0);

//batch success without error, retrieve the result

RecordSearchResults rcSearchResult = (RecordSearchResults)commandStatus.getData(); List<RecordData> resultList = rcSearchResult.getRecordData();

if (resultList != null)

{

// getting the data

for (int i=0; i<resultList.size(); i++)

{

RecordData rd = resultList.get(i);

Map<String, Object> detailMap = rd.getDetails();

//get the deviceType from the detail map

String deviceType =

(String)detailMap.get(DeviceDetailsKeys.DEVICE_TYPE);

Key primaryKey = rd.getPrimaryKey();

//only interest in DOCSIS

if (DeviceType.getDeviceType(deviceType)

.equals(DeviceType.DOCSIS))

{

//change COS

batch = conn.newBatch();

batch.changeClassOfService((DeviceID)primaryKey, "DisabledCOS");

//change DHCPCriteria

batch.changeDHCPCriteria((DeviceID)primaryKey, "DisabledDHCPCriteria");

batchStatus = null;

try

{

batchStatus = batch.post();

}

catch(Exception e)

{

e.printStackTrace();

}

//disable computer

else if (DeviceType.getDeviceType(deviceType)

.equals(DeviceType.COMPUTER))

{

//change DHCPCriteria

batch = conn.newBatch();

batch.changeClassOfService((DeviceID)primaryKey,

"DisabledComputerCOS");

batch.changeDHCPCriteria((DeviceID)primaryKey,

"DisabledComputerDHCPCriteria");

batchStatus = null;

try

{

batchStatus = batch.post();

}

catch(Exception e)

{

e.printStackTrace();

}

（注） DisabledCOS の特性を定義し、モデムをリセットするときに、モデムの背後の CPE に及ぼす影響を考慮しなければならないことがあります。これは、モデムの背後に音声エンドポイントが接続されている場合に特に重要です。ケーブルモデムの動作を中断すると、その時点で進行中の通話に影響を及ぼす可能性があるためです。

これで、加入者がディセーブルになります。

モデムおよびセルフプロビジョニングされたコンピュータの事前プロビジョニング

新しい加入者はサービスプロバイダーに連絡し、サービスを要求します。加入者は、戸建住宅内にコンピュータを設置しています。サービスプロバイダーは、すべてのケーブルモデムをまとめて事前プロビジョニングします。

目的

次のワークフローを使用して、事前プロビジョニングされたケーブルモデムとプロビジョニングされていないコンピュータを、ローミング標準モードでオンラインにします。この手順は、両方のデバイスが適切なレベルのサービスを受け、登録されるために必要です。

ステップ 1 サービスプロバイダーは、課金システムで使用される加入者のユーザ名とパスワードを選択します。

ステップ 2 サービスプロバイダーは、加入者がアクセスできるサービスを選択します。

ステップ 3 サービスプロバイダーの現場技術者は、新しい加入者の住宅内に物理ケーブルを敷設し、事前プロビジョニングされたデバイスを設置して、加入者のコンピュータに接続します。

ステップ 4 モデムの電源をオンにすると、BAC はプロビジョニングされた IP アドレスをモデムに付与します。

ステップ 5 コンピュータの電源をオンにすると、BAC はプライベート IP アドレスをコンピュータに付与します。

ステップ 6 コンピュータのブラウザアプリケーションを起動すると、ブラウザはサービスプロバイダーのユーザインターフェイスにアクセスします。

ステップ 7 サービスプロバイダーのユーザインターフェイスにアクセスすると、プロビジョニングされたケーブルモデムの背後にあるコンピュータの登録に必要な手順を終了します。

// First we query the computer's information to find the

// modem's MAC Address. We use the computer IP address (the web browser

// received this when the subscriber opened the service provider’s

// web interface

PACEConnection connection = PACEConnectionFactory.getInstance(

"localhost", 49187, "admin", "changeme");

// NO_ACTIVATION is the activation mode because this is a query

// NO_CONFIRMATION is the confirmation mode because we are not

// attempting to reset the device

// NO_PUBLISHING is the publishing mode because we are not attempting

// to publish to external database.

Batch batch = connection.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

// register getAllForIPAddress to the batch

batch.getAllForIPAddress("10.0.14.38");

BatchStatus batchStatus = null;

// post the batch to RDU server

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

// Get the LeaseResults object after posting a batch.

CommandStatus commandStatus = batchStatus.getCommandStatus(0);

LeaseResults computerLease = (LeaseResults)commandStatus.getData();

// derive computer MAC address from computer's network information.

String computerMACAddress =

(String)computerLease.getSingleLease().get(DeviceDetailsKeys.MAC_ADDRESS);

List<DeviceID> compDeviceIDList = new ArrayList<DeviceID>();

MACAddress computerMACAddressObject = new MACAddress(computerMACAddress);

compDeviceIDList.add(computerMACAddressObject);

// NO_ACTIVATION will generate new configuration for the computer,

// however it will not attempt to reset it.

// NO_CONFIRMATION is the confirmation mode because we are not

// attempting to reset the computer because this cannot be done.

batch = connection.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

// register add API to the batch

batch.add(

DeviceType.COMPUTER, // deviceType: Computer

compDeviceIDList, // compDeviceIDList: the list of DeviceIDs derived from // computerLease

null, // hostName: not used in this example

null, // domainName: not used in this example

"0123-45-6789", // ownerName

null, // class of service: get the default COS

"provisionedCPE", // dhpcCriteria: Network Registrar uses this to

// select a modem lease granting provisioned IP address

null // properties: not used

);

// post the batch to RDU server

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

（注） IPDeviceKeys.MUST_BE_BEHIND_DEVICE プロパティはコンピュータに設定されませんが、このプロパティを使用すると、ケーブルモデムの背後から別のケーブルモデムへのローミングが可能になります。

ステップ 8 コンピュータを再起動すると、コンピュータはプロビジョニングされた新しい IP アドレスを受信します。

これで、ケーブルモデムとコンピュータはいずれもプロビジョニングされたデバイスとなります。コンピュータは、サービスプロバイダーのネットワークを介してインターネットにアクセスできます。

既存のモデムの修正

サービスプロバイダーの加入者は、現在 Silver というレベルのサービスを受けていますが、 Gold サービスにアップグレードすることにしました。加入者は、住宅内にコンピュータを設置しています。

（注）この使用例の目的は、デバイスの修正方法を示すことです。この例は、ローミング標準以外のモードでプロビジョニングされたデバイスに適用できます。

目的

次のワークフローを使用して、既存のモデムのサービスクラスを修正し、そのサービスの変更をサービスプロバイダーの外部システムに渡します。

ステップ 1 加入者はサービスプロバイダーに電話をかけて、サービスのアップグレードを依頼します。サービスプロバイダーはユーザインターフェイスを使用して、サービスクラスを Silver から Gold に変更します。

ステップ 2 サービスプロバイダーのアプリケーションは、BAC で次の API コールを行います。

// NO_ACTIVATION is the activation mode because this is a query

// NO_CONFIRMATION is the confirmation mode because we are not

// attempting to reset the device

// NO_PUBLISHING is the publishing mode because we are not attempting

// to publish to external database.

Batch batch = connection.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

// replace changeClassOfService to this. Make sure the comment

// on top of this line is still there.

batch.changeClassOfService(new MACAddress("1,6,00:11:22:33:44:55")

// the MACAddress object

, "Gold");

// post the batch to the RDU

BatchStatus batchStatus = null;

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

これで、加入者はサービスプロバイダーのネットワークにアクセスし、Gold サービスを受けられるようになります。

加入者のデバイスの登録解除と削除

サービスプロバイダーは、サービスの利用を中止した加入者を削除する必要があります。

目的

次のワークフローを使用して、加入者のデバイスすべてをサービスプロバイダーのネットワークから完全に削除します。

ステップ 1 サービスプロバイダーのユーザインターフェイスで、加入者へのサービスを停止します。

ステップ 2 次のステップでは、加入者のデバイスの登録解除方法と削除方法について説明します。サービスプロバイダーによっては、故障の場合を除いてケーブルモデムをデータベースに残す場合があるため、デバイスの削除はオプションです。また、ステップ 2-a に従ってデバイスを登録解除した場合は、ステップ 2-b に従ってデバイスを削除することはできません。

a. デバイスを登録解除するには、サービスプロバイダーのアプリケーションがプロビジョニングクライアントプログラムを使用して、加入者のデバイスすべてのリストを BAC に要求します。次に、各デバイスを登録解除してリセットします。その結果、各デバイスがデフォルトの（プロビジョニングされていない）サービスレベルに低下します。

（注）「unregister」API へのパラメータに指定されたデバイスがすでに登録解除された状態にある場合は、API コールからのステータスコードが
CommandStatusCodes.CMD_ERROR_DEVICE_UNRE- GISTER_UNREGISTERED_ERROR に設定されます。これは通常および所定の動作です。

// MSO admin UI calls the provisioning API to get a list of

// all the subscriber's devices.

// Create a new connection

PACEConnection conn = PACEConnectionFactory.getInstance(

"localhost", 49187, "admin", "admin123");

// NO_ACTIVATION is the activation mode because this is a query

// NO_CONFIRMATION is the confirmation mode because we are not

// attempting to reset the device

// NO_PUBLISHING is the publishing mode because we are not attempting

// to publish to external database.

Batch batch = conn.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

batch.getAllForOwnerID("0123-45-6789"

// query all the devices for this account number

);

BatchStatus batchStatus = null;

try

{

batchStatus = batch.post();

}

catch(Exception e)

{

e.printStackTrace();

}

CommandStatus commandStatus = batchStatus.getCommandStatus(0);

//batch success without error, retrieve the result

RecordSearchResults rcSearchResult = (RecordSearchResults)commandStatus.getData();

List<RecordData> resultList = rcSearchResult.getRecordData();

// We need to unregister all the devices behind each modem(s) or else the

// unregister call for that modem will fail.

if (resultList != null)

{

//Unregister the COMPUTER

for (int i=0; i<resultList.size(); i++)

{

RecordData rd = resultList.get(i);

Map<String, Object> detailMap = rd.getDetails();

//get the deviceType from the detail map

String deviceType = (String)detailMap.get(DeviceDetailsKeys.DEVICE_TYPE);

//only interest in DOCSIS

if (DeviceType.getDeviceType(deviceType) .equals(DeviceType.COMPUTER))

{

Key primaryKey = rd.getPrimaryKey();

batch = conn.newBatch();

batch.unregister((DeviceID)primaryKey);

batchStatus = null;

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

// for each modem in the retrieved list:

for (int i=0; i<resultList.size(); i++)

{

RecordData rd = resultList.get(i);

Map<String, Object> detailMap = rd.getDetails();

//get the deviceType from the detail map

String deviceType = (String)detailMap.get(DeviceDetailsKeys.DEVICE_TYPE);

//only interest in DOCSIS

if (DeviceType.getDeviceType(deviceType) .equals(DeviceType.DOCSIS))

{

Key primaryKey = rd.getPrimaryKey();

batch = conn.newBatch();

batch.unregister((DeviceID)primaryKey);

batchStatus = null;

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

b. デバイスを削除するには、サービスプロバイダーのアプリケーションがプロビジョニングクライアントプログラムを使用して、加入者の残りのデバイスをデータベースから個別に削除します。

// Create a new connection

PACEConnection conn =

PACEConnectionFactory.getInstance("localhost", 49187, "admin", "admin123");

// NO_ACTIVATION is the activation mode because this is a query

// NO_CONFIRMATION is the confirmation mode because we are not

// attempting to reset the device

// NO_PUBLISHING is the publishing mode because we are not attempting

// to publish to external database.

Batch batch = conn.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publisining to external database

PublishingMode.NO_PUBLISHING);

batch.getAllForOwnerID("0123-45-6789" // query all the devices for this account // number

);

BatchStatus batchStatus = null;

try

{

batchStatus = batch.post();

}

catch(Exception e)

{

e.printStackTrace();

}

CommandStatus commandStatus = batchStatus.getCommandStatus(0);

//batch success without error, retrieve the result

RecordSearchResults rcSearchResult = (RecordSearchResults)commandStatus.getData();

List<RecordData> resultList = rcSearchResult.getRecordData();

if (resultList != null)

{

// for each modem in the retrieved list, delete it

for (int i=0; i<resultList.size(); i++)

{

RecordData rd = resultList.get(i);

Map<String, Object> detailMap = rd.getDetails();

//get the deviceType from the detail map

String deviceType = (String)detailMap.get(DeviceDetailsKeys.DEVICE_TYPE);

//only interest in DOCSIS

if (DeviceType.getDeviceType(deviceType) .equals(DeviceType.DOCSIS))

{

Key primaryKey = rd.getPrimaryKey();

//change COS

batch = conn.newBatch();

batch.delete((DeviceID)primaryKey, true);

batchStatus = null;

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

無差別モードでの最初のアクティベーションのセルフプロビジョニング

加入者は、戸建住宅内にコンピュータ（ブラウザアプリケーションがインストール済み）を設置し、DOCSIS ケーブルモデムを購入しました。

目的

ステップ 1 加入者は DOCSIS ケーブルモデムを購入し、住宅内に設置します。

ステップ 2 加入者はモデムの電源をオンにし、BAC は制限付きアクセス権をモデムに付与します。

ステップ 3 加入者はコンピュータのブラウザアプリケーションを起動します。スプーフィング DNS サーバにより、ブラウザがサービスプロバイダーの登録サーバ（OSS ユーザインターフェイスやメディエータなど）にアクセスします。

ステップ 4 加入者はサービスプロバイダーのユーザインターフェイスを使用して、サービスクラスの選択など、登録に必要な手順を終了します。

サービスプロバイダーのユーザインターフェイスは、加入者の情報（選択されたサービスクラスやコンピュータの IP アドレスなど）を BAC に渡します。加入者のケーブルモデムとコンピュータが BAC に登録されます。

ステップ 5 ユーザインターフェイスは、加入者にコンピュータをリブートするように求めます。

// Create a new connection

PACEConnection conn = PACEConnectionFactory.getInstance(

"localhost", 49187, "admin", "admin123");

Batch batch = conn.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

// NO_ACTIVATION is the activation mode because this is a

// query. NO_CONFIRMATION is the confirmation mode because

// we are not attempting to reset the device.

// First we query the computer's information to find the

// modem’s MAC address.

// We use the computer’s IP address (the web browser

// received this when the subscriber opened the service

// provider’s web interface).

// We also assume that "bostonProvGroup"

// is the provisioning group used in that locality.

List<String> provGroupList = new ArrayList<String>();

provGroupList.add("bostonProvGroup");

batch.getAllForIPAddress("10.0.14.38",

// ipAddress: restricted access computer lease

provGroupList

// provGroups: List containing provgroup

);

BatchStatus batchStatus = null;

// post the batch to RDU server

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

// Get the LeaseResults object after posting a batch.

CommandStatus commandStatus = batchStatus.getCommandStatus(0);

LeaseResults computerLease = (LeaseResults)commandStatus.getData();

// Derive the modem MAC address from the computer's network

// information. The 1,6, is a standard prefix for an Ethernet

// device. The fully qualified MAC address is required by BACC

StringBuffer modemMACAddress = new StringBuffer();

modemMACAddress.append("1,6,");

modemMACAddress.append(computerLease.getSingleLease().get("relay-agent-remote-id"));

//create MacAddress object from the string

MACAddress modemMACAddressObject = new MACAddress(modemMACAddress.toString());

List<DeviceID> modemDeviceIDList = new ArrayList<DeviceID>();

modemDeviceIDList.add(modemMACAddressObject);

// NO_ACTIVATION is the activation mode because this is a query

// NO_CONFIRMATION is the confirmation mode because we are not

// attempting to reset the device

// NO_PUBLISHING is the publishing mode because we are not attempting

// to publish to external database.

batch = conn.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

Map<String, Object> properties = new HashMap<String, Object>();

// Set the property PolicyKeys.COMPUTER_PROMISCUOUS_MODE_ENABLED

// to enable promiscuous mode on modem

properties.put(PolicyKeys.COMPUTER_PROMISCUOUS_MODE_ENABLED, Boolean.TRUE);

properties.put(PolicyKeys.COMPUTER_DHCP_CRITERIA, "provisionedCPE");

// enable promiscuous mode by changing the technology default

batch.changeDefaults(DeviceType.DOCSIS,

properties, null);

// post the batch to RDU server

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

batch = conn.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

batch.add(

DeviceType.DOCSIS, // deviceType: DOCSIS

modemDeviceIDList, // macAddress: derived from computer lease

null, // hostName: not used in this example

null, // domainName: not used in this example

"0123-45-6789", // ownerID: here, account number from billing system

"Silver", // ClassOfService

"provisionedCM", // DHCP Criteria: Network Registrar uses this to

// select a modem lease granting provisioned IP address

null // properties:

);

ステップ 6 プロビジョニングクライアントは performOperation(...) を呼び出してモデムをリブートし、プロビジョニングされたアクセス権をモデムに付与します。

// Reset the computer

// create a new batch

batch = conn.newBatch(

// No reset

ActivationMode.AUTOMATIC,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION);

// register performOperation command to the batch

batch.performOperation(DeviceOperation.RESET,

modemMACAddressObject, null);

// post the batch to RDU server

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

ステップ 7 コンピュータをリブートすると、コンピュータは新しい IP アドレスを受信します。

これで、ケーブルモデムはプロビジョニングされたデバイスとなります。コンピュータは BAC に登録されていませんが、サービスプロバイダーのネットワークを介してインターネットにアクセスできます。無差別モードのモデムの背後でオンラインになっているコンピュータは、引き続き、プロビジョニング APIを使用して利用することができます。

無差別モードでの 100 台のモデムの一括プロビジョニング

サービスプロバイダーのカスタマーサービス担当者が、サービスセンターで、配送する 100 台のケーブルモデムを事前プロビジョニングします。

目的

次のワークフローを使用して、すべてのモデムのモデムデータを新しい加入者に配送します。カスタマーサービス担当者は、割り当て可能なモデムのリストを持っています。

ステップ 1 サービスプロバイダーの発送センターで、新しいケーブルモデムまたは再利用するケーブルモデムの MAC アドレスデータがリストにまとめられます。

ステップ 2 特定のサービスセンターに割り当てられたモデムが BAC に一括ロードされ、そのサービスセンターの識別名が付けられます。

ステップ 3 サービスセンターでモデムを新しい加入者に配送する際、カスタマーサービス担当者が新しいサービスパラメータを入力し、モデムの Owner ID フィールドを新しい加入者のアカウント番号に合せて変更します。

// Create a new connection

PACEConnection conn = PACEConnectionFactory.getInstance(

"localhost", 49187, "admin", "admin123");

Batch batch = conn.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

// The activation mode for this batch should be NO_ACTIVATION.

// NO_ACTIVATION should be used in this situation because no

// network information exists for the devices because they

// have not booted yet. A configuration can’t be generated if no

// network information is present. And because the devices

// have not booted, they are not online and therefore cannot

// be reset. NO_CONFIRMATION is the confirmation mode because

// we are not attempting to reset the devices.

// Create a Map for the properties of the modem

Map properties;

// Set the property PolicyKeys.COMPUTER_PROMISCUOUS_MODE_ENABLED to

// enable promiscuous mode on modem.

// This could be done at a system level if promiscuous mode

// is your default provisioning mode.

properties.put(PolicyKeys.COMPUTER_PROMISCUOUS_MODE_ENABLED, Boolean.TRUE);

// The PolicyKeys.CPE_DHCP_CRITERIA is used to specify the DHCP

// Criteria to be used while selecting IP address scopes for

// CPE behind this modem in the promiscuous mode.

properties.put(PolicyKeys.COMPUTER_DHCP_CRITERIA, "provisionedCPE");

// enable promiscuous mode by changing the technology default

batch.changeDefaults(DeviceType.DOCSIS,properties, null);

BatchStatus batchStatus = null;

// post the batch to RDU server

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

// for each modem MAC-address in list:

ModemLoop:

{

batch = conn.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

batch.add(

DeviceType.DOCSIS, // deviceType: DOCSIS

modemMACAddressList, // modemMACAddressList: the list of deviceID

null, // hostName: not used in this example

null, // domainName: not used in this example

"0123-45-6789", // ownerID: here, account number from billing system "Silver", // ClassOfService

"provisionedCM", // DHCP Criteria: Network Registrar uses this to

// select a modem lease granting provisioned IP address properties // properties:

);

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

// end ModemLoop.

}

無差別モードでの最初のアクティベーションの事前プロビジョニング

新しい加入者はサービスプロバイダーに連絡し、サービスを要求します。加入者は、戸建住宅内にコンピュータを設置しています。

目的

次のワークフローを使用して、プロビジョニングされていない新しいケーブルモデムとコンピュータをオンラインにし、適切なレベルのサービスを受けられるようにします。

ステップ 1 サービスプロバイダーは、課金システムで使用される加入者のユーザ名とパスワードを選択します。

ステップ 2 サービスプロバイダーは、加入者がアクセスできるサービスを選択します。

ステップ 3 サービスプロバイダーは、独自のユーザインターフェイスを使用して、デバイスを登録します。

ステップ 4 サービスプロバイダーのユーザインターフェイスは、モデムの MAC アドレスやサービスクラスなどの情報を BAC に渡します。また、モデムが CPE DHCP 基準設定を取得します。この基準設定により、Network Registrar はモデムの背後に接続するコンピュータに対して、プロビジョニングされたアドレスを選択できます。次に、新しいモデムが BAC に登録されます。

ステップ 5 サービスプロバイダーの現場技術者は、新しい加入者の住宅内に物理ケーブルを敷設し、事前プロビジョニングされたデバイスを設置して、加入者のコンピュータに接続します。

// MSO admin UI calls the provisioning API to pre-provision

// an HSD modem.

// Create a new connection

PACEConnection conn = PACEConnectionFactory.getInstance(

"localhost", 49187, "admin", "admin123");

Batch batch = conn.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

// The activation mode for this batch should be NO_ACTIVATION.

// NO_ACTIVATION should be used in this situation because no

// network information exists for the modem because it has not

// booted. A configuration cannot be generated if no network

// information is present. And because the modem has not booted,

// it is not online and therefore cannot be reset.

// NO_CONFIRMATION is the confirmation mode because we are not

// attempting to reset the modem.

// Create a map for the properties of the modem.

Map<String, Object> properties = new HashMap<String, Object>();

// Set the property PolicyKeys.COMPUTER_PROMISCUOUS_MODE_ENABLED

// to enable promiscuous mode on modem

properties.put(PolicyKeys.COMPUTER_PROMISCUOUS_MODE_ENABLED, Boolean.TRUE);

properties.put(PolicyKeys.COMPUTER_DHCP_CRITERIA, "provisionedCPE");

// enable promiscuous mode by changing the technology default

batch.changeDefaults(DeviceType.DOCSIS, properties, null);

BatchStatus batchStatus = null;

// post the batch to RDU server

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

batch = conn.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

MACAddress macAddressObject = new MACAddress("1,6,00:11:22:33:44:55");

List<DeviceID> modemDeviceIDList = new ArrayList<DeviceID>();

modemDeviceIDList.add(macAddressObject);

batch.add(

DeviceType.DOCSIS, // deviceType: DOCSIS

modemDeviceIDList, // macAddress: derived from computer lease

null, // hostName: not used in this example

null, // domainName: not used in this example

"0123-45-6789", // ownerID: here, account number from billing system

"Silver", // ClassOfService

"provisionedCM", // DHCP Criteria: Network Registrar uses this to

// select a modem lease granting provisioned IP address

null // properties:

);

// post the batch to RDU server

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

ステップ 6 ケーブルモデムの電源をオンにすると、BAC はプロビジョニングされたアクセス権をケーブルモデムに付与します。

ステップ 7 コンピュータの電源をオンにすると、BAC はプロビジョニングされたアクセス権をコンピュータに付与します。

既存のモデムの交換

サービスプロバイダーは、故障したモデムを交換します。

（注）モデムから別のモデムへのローミングを制限するオプションがコンピュータに設定されている場合、モデムを交換したときは、コンピュータに設定されているモデムの MAC アドレスも変更する必要があります。

目的

次のワークフローを使用して、加入者に提供するサービスのレベルを変更することなく、既存のケーブルモデムを新しいモデムに物理的に交換します。

ステップ 1 サービスプロバイダーは、既存のモデムの MAC アドレスを新しいモデムの MAC アドレスに変更します。

// Create a new connection

PACEConnection conn = PACEConnectionFactory.getInstance(

"localhost", 49187, "admin", "admin123");

batch = conn.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

MACAddress macAddressObject = new MACAddress("1,6,00:11:22:33:44:55");

List<DeviceID> modemDeviceIDList = new ArrayList<DeviceID>();

modemDeviceIDList.add(macAddressObject);

// old macAddress: unique identifier for the old modem

MACAddress oldMacAddress = new MACAddress("1,6,00:11:22:33:44:55");

// new macAddress: unique identifier for the new modem

MACAddress newMacAddress = new MACAddress("1,6,00:11:22:33:44:66");

List<DeviceID> newDeviceIDs = new ArrayList<DeviceID>();

newDeviceIDs.add(newMacAddress);

batch.changeDeviceID(oldMacAddress, newDeviceIDs);

// post the batch to RDU server

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

ステップ 2 サービスプロバイダーは、ケーブルモデムを交換し、その電源をオンにします。

ステップ 3 コンピュータの電源もオンにする必要があります。

これで、ケーブルモデムは完全にプロビジョニングされたデバイスとなり、適切なレベルのサービスを受けられるようになります。ケーブルモデムの背後にあるコンピュータも同様です。

無差別モードでの 2 台目のコンピュータの追加

加入者は、設置されているケーブルモデムの背後に 2 台目のコンピュータを接続します。この例では、プロビジョニング API の呼び出しは必要ありません。

目的

次のワークフローを使用して、加入者が選択したサービスが複数の CPE セットの接続を許可すること、および接続された両方のコンピュータから加入者がネットワークにアクセスできることを確認します。

ステップ 1 加入者はケーブルモデムの背後に 2 台目のコンピュータを接続します。

ステップ 2 加入者はコンピュータの電源をオンにします。

加入者が選択したサービスが複数の CPE セットの接続を許可している場合、BAC はインターネットへのアクセス権を 2 台目のコンピュータに付与します。

NAT を使用した最初のアクティベーションのセルフプロビジョニング

大学で、Network Address Translation（NAT; ネットワークアドレス変換）および DHCP 機能を持つ DOCSIS ケーブルモデムが購入されました。建物の利用者 5 人はそれぞれ、ブラウザアプリケーションを持つコンピュータを設置しています。

目的

次のワークフローを使用して、プロビジョニングされていない新しいケーブルモデム（NAT を持つ）と、モデムの背後にあるコンピュータをオンラインにし、適切なレベルのサービスを受けられるようにします。

ステップ 1 加入者は NAT および DHCP 機能を持つケーブルモデムを購入し、集合住宅内に設置します。

ステップ 2 加入者はモデムの電源をオンにし、BAC は制限付きアクセス権をモデムに付与します。

ステップ 3 加入者はラップトップコンピュータをケーブルモデムに接続し、モデム内の DHCP サーバは IP アドレスをラップトップに付与します。

ステップ 4 加入者はコンピュータのブラウザアプリケーションを起動します。スプーフィング DNS サーバにより、ブラウザがサービスプロバイダーの登録サーバ（OSS ユーザインターフェイスやメディエータなど）にアクセスします。

ステップ 5 加入者はサービスプロバイダーのユーザインターフェイスを使用して、モデムのケーブルモデムの登録に必要な手順を終了します。登録用のユーザインターフェイスは、モデムで NAT が使用されていることを検出し、モデムを登録して、モデムが NAT 互換のサービスクラスを受けられることを確認します。詳細については、「固定標準モードでセルフプロビジョニングされたモデムとコンピュータ」を参照してください。

（注） NAT を持つ特定のケーブルモデムでは、新しいサービスクラス設定を取得するためにコンピュータをリブートするように求められる場合があります。ケーブルモデムと NAT デバイスが別々のデバイスである場合は、NAT デバイスもコンピュータの登録と同じように登録する必要があります。

NAT を持つモデムの背後への新しいコンピュータの追加

アパートには 4 人の借家人がいて、モデムを共有し、サービスプロバイダーのネットワークにアクセスしています。このアパートの大家が新しい借家人に対し、建物のモデムを共有したインターネットアクセスを提供します。モデムには NAT および DHCP 機能が含まれています。新しい借家人は、自分のコンピュータをモデムに接続しています。

（注）この例では、プロビジョニング API の呼び出しは必要ありません。

目的

ステップ 1 加入者はコンピュータの電源をオンにします。

ステップ 2 これで、コンピュータはプロビジョニングされたデバイスとなり、適切なレベルのサービスにアクセスできます。

プロビジョニングされた NAT モデムは、モデムの背後にあるコンピュータをネットワーク上で非表示にします。

別の DHCP スコープへのデバイスの移動

サービスプロバイダーは、ネットワークに番号を再割り当てします。これに伴い、登録済みケーブルモデムに、別の Network Registrar スコープの IP アドレスが必要になります。

目的

プロビジョニングクライアントは DHCP 基準を変更し、ケーブルモデムは対応する DHCP スコープから IP アドレスを受信します。

ステップ 1 DOCSIS モデムの DHCP 基準を「newmodemCriteria」に変更します。

// Create a new connection

PACEConnection conn = PACEConnectionFactory.getInstance(

"localhost", 49187, "admin", "admin123");

Batch batch = conn.newBatch(

// No reset

ActivationMode.AUTOMATIC,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

// AUTOMATIC is the Activation mode because we are attempting

// to reset the modem so that a phone line is disabled

// NO_CONFIRMATION is the Confirmation mode because we don't

// want the batch to fail if we can't reset the modem.

// This use case assumes that the DOCSIS modem has been

// previously added to the database

batch.changeDHCPCriteria(

new MACAddress("1,6,ff:00:ee:11:dd:22"), // Modem's MAC address or FQDN

"newmodemCriteria"

);

// post the batch to RDU server

BatchStatus batchStatus = null;

try

{

batchStatus = batch.post();

}

catch(ProvisioningException e)

{

e.printStackTrace();

}

ステップ 2 モデムは、「newmodemCriteria」によって対象とされたスコープから IP アドレスを取得します。

イベントを使用したデバイス削除のロギング

サービスプロバイダーは、複数のプロビジョニングクライアントを保有しており、デバイス削除をログに記録します。

目的

どのプロビジョニングクライアントがデバイスを削除しても、プロビジョニングクライアントはイベントを 1 か所のログに記録します。

ステップ 1 デバイス削除イベントのリスナーを作成します。このクラスは、DeviceAdapter 抽象クラスを拡張するか、または DeviceListener インターフェイスを実装する必要があります。また、イベントをログに記録するために deletedDevice(DeviceEvent ev) メソッドを無効にする必要もあります。

public DeviceDeletionLogger

extends DeviceAdapter

//Extend the DeviceAdapter class.

{

public void deletedDevice(DeviceEvent ev)

//Override deletedDevice.

{

logDeviceDeletion(ev.getDeviceID());

//Log the deletion.

}

ステップ 2 PACEConnection インターフェイスを使用して、イベントのリスナーと修飾子を登録します。

DeviceDeletionLogger deviceDeletionLogger =

new DeviceDeletionLogger();

// Modem's MAC address or FQDN "newmodemCriteria"

DeviceEventQualifier qualifier = new DeviceEventQualifier();

// We are interested only in device deletion.

qualifier.setDeletedDevice ();

// Add device listener using PACEConnection

connection.addDeviceListener(deviceDeletionLogger, qualifier

);

ステップ 3 システムからデバイスが削除されると、イベントが生成され、リスナーに通知されます。

イベントを使用した RDU 接続の監視

サービスプロバイダーは 1 つのプロビジョニングクライアントを実行しており、プロビジョニングクライアントと RDU 間の接続が切断された場合に通知されるようにします。

目的

次のワークフローを使用して、接続が切断された場合にイベントインターフェイスからサービスプロバイダーに通知されるように設定します。

ステップ 1 メッセージイベントのリスナーを作成します。このクラスは、 MessagingAdapter 抽象クラスを拡張するか、または MessagingListener インターフェイスを実装する必要があります。さらに、このクラスは connectionStopped(MessagingEvent ev) メソッドを無効にする必要もあります。

// Extend the service provider’s Java program using the

// provisioning client to receive Messaging events.

public MessagingNotifier

extends MessagingAdapter

//Extend the MessagingAdapter class.

{

public void connectionStopped(MessagingEvent ev)

//Override connectionStopped.

{

doNotification(ev.getAddress(), ev.getPort());

//Do the notification.

}

ステップ 2 PACEConnection インターフェイスを使用して、イベントのリスナーと修飾子を登録します。

MessagingQualifier qualifier =new MessagingQualifier();

qualifier.setConnectionDown();

MessagingNotifier messagingNotifier = new MessagingNotifier();

connnection.addMessagingListener(messagingNotifier, qualifier

);

ステップ 3 接続が切断されると、イベントが生成され、リスナーに通知されます。接続が中断した場合は常に、PACEConnection が自動的に RDU に再接続します。

イベントを使用したバッチ完了のロギング

サービスプロバイダーは、複数のプロビジョニングクライアントを保有しており、バッチ完了をログに記録します。

目的

どのプロビジョニングクライアントがバッチを完了しても、イベントを 1 か所のログに記録します。

ステップ 1 イベントのリスナーを作成します。このクラスは、BatchAdapter 抽象クラスを拡張するか、または BatchListener インターフェイスを実装する必要があります。また、イベントをログに記録するために completion(BatchEvent ev) メソッドを無効にする必要があります。

public BatchCompletionLogger

extends BatchAdapter

//Extend the BatchAdapterclass.

{

public void completion(BatchEvent ev)

//Override completion.

{

logBatchCompletion(ev.BatchStatus().getBatchID());

//Log the completion.

}

ステップ 2 PACEConnection インターフェイスを使用して、イベントのリスナーと修飾子を登録します。

BatchCompletionLogger batchCompletionLogger = new BatchCompletionLogger();

BatchEventQualifier qualifier = new BatchEventQualifier();

connection.addBatchListener(batchCompletionLogger , qualifier

);

ステップ 3 バッチが完了すると、イベントが生成され、リスナーに通知されます。

デバイスの詳細情報の取得

サービスプロバイダーは管理者に対して、特定のデバイスの詳細情報を表示することを許可します。

目的

サービスプロバイダーの管理アプリケーションは、特定のデバイスに関する既知の詳細をすべて表示します。この詳細には、MAC アドレス、リース情報、デバイスのプロビジョニングステータス、およびデバイスタイプ（既知の場合）などがあります。

ステップ 1 管理者は、サービスプロバイダーの管理者のユーザインターフェイスに、クエリーするデバイスの MAC アドレスを入力します。

ステップ 2 BAC は、デバイスの詳細を組み込みデータベースにクエリーします。

// The host name or IP address of the RDU. It is

// recommended that you normally use a fully-qualified domain name

// since it lends itself to the greatest flexibility going forward.

// For example, you could change the host running RDU without

// having to reassign IPs. For that reason, having an alias for

// the machine is better than a specific name.

final String rduHost = "localhost";

// The port number of RDU on the server.

final int rduPort = 49187;

// The user name for connecting to RDU.

final String userName = "admin";

// The password to use with the username.

final String password = "changeme";

// --------------------------------------------------------------------

// DEVICE PARAMETERS, see IPDevice.getDetails()

// --------------------------------------------------------------------

// The MAC address of the modem to be queried. MAC addresses in BAC

// must follow the simple "1,6,XX:XX:XX:XX:XX:XX" format.

final DeviceID modemMACAddress = DeviceID.getInstance("1,6,00:11:22:33:44:55",

KeyType.MAC_ADDRESS);

// The PACE connection to use throughout the example. When

// executing multiple batches in a single process, it is advisable

// to use a single PACE connection that is retrieved at the start

// of the application. When done with the connection, YOU MUST

// explicitly close the connection with the releaseConnection()

// method call.

PACEConnection connection = null;

// 1) Connect to the Regional Distribution Unit (RDU).

// The parameters defined at the beginning of this class are

// used here to establish the connection. Connections are

// maintained until releaseConnection() is called. If

// multiple calls to getInstance() are called with the same

// arguments, you must still call releaseConnection() on each

// connection you received.

// The call can fail for one of the following reasons:

// - The hostname / port is incorrect.

// - The authentication credentials are invalid.

try

{

connection = PACEConnectionFactory.getInstance(

// RDU host rduHost,

// RDU port rduPort,

// User name userName,

// Password password

);

}

catch (PACEConnectionException e)

{

// failed to get a connection

System.out.println("Failed to establish a PACEConnection to [" +

userName + "@" + rduHost + ":" + rduPort + "]; " +

e.getMessage());

System.exit(1);

}

// 2) Create a new batch instance.

// To perform any operations in the Provisioning API, you must

// first start a batch. As you make commands against the batch,

// nothing will actually start until you post the batch.

// Multiple batches can be started concurrently against a

// single connection to the RDU.

Batch myBatch = connection.newBatch(

// No reset

ActivationMode.NO_ACTIVATION,

// No need to confirm activation

ConfirmationMode.NO_CONFIRMATION,

// No publishing to external database

PublishingMode.NO_PUBLISHING);

// 3) Register the getDetails(...) with the batch.

// Use the Provisioning API to get all of the information for

// the specified MAC address. Since methods aren't actually

// executed until the batch is posted, the results are not

// returned until after post() completes. The getCommandStatus()

// followed by getData() calls must be used to access the results

// once the batch is posted.

final DeviceID modemMACAddress = DeviceID.getInstance("1,6,00:11:22:33:44:55",

KeyType.MAC_ADDRESS);

List options = new ArrayList();

options.add(DeviceDetailsOption.INCLUDE_LEASE_INFO);

myBatch.getDetails(modemMACAddress, options);

// 4) Post the batch to the server.

// Executes the batch against the RDU. All of the

// methods are executed in the order entered and the data

// changes are applied against the embedded database in RDU.

BatchStatus bStatus = null;

try

{

bStatus = myBatch.post();

}

catch (ProvisioningException pe)

{

System.out.println("Failed to query for modem with MAC address [" +

modemMACAddress + "]; " + pe.getMessage());

System.exit(2);

}

// 5) Check to see if the batch was successfully posted.

// Verify if any errors occurred during the execution of the

// batch. Exceptions occur during post() for truly exception

// situations such as failure of connectivity to RDU.

// Batch errors occur for inconsistencies such as no lease

// information for a device requiring activation. Command

// errors occur when a particular method has problems, such as

// trying to add a device that already exists.

if (bStatus.isError())

{

// Batch error occurred.

System.out.println("Failed to query for modem with MAC address [" +

modemMACAddress + "]; " + bStatus.getErrorMessage());

System.exit(3);

}

ステップ 3 サービスプロバイダーのアプリケーションは、デバイスデータの詳細に関するページを表示します。このページには、要求されたデバイスに関する既知の情報をすべて表示できます。デバイスがサービスプロバイダーのネットワークに接続された場合、このデータにはリース情報（IP アドレスやリレーエージェントの ID など）が含まれます。データは、デバイスがプロビジョニングされたかどうかを示します。プロビジョニングされた場合、データにはデバイスタイプも含まれます。