Provisioning Devices

Available Languages

Download Options

PDF (407.9 KB)
View with Adobe Reader on a variety of devices

Updated:November 2, 2007

Bias-Free Language

The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.

Provisioning Devices

Table Of Contents

Provisioning Devices

High-Speed Data Devices

Case 1: Preprovisioned First Time Activation in Standard Mode

Case 2: Self-Provisioned First Time Activation in Standard Mode

Case 3: Modify an Existing Modem in Standard Mode

Case 4: Add a New Computer in Standard Mode

Case 5: Disable a Subscriber in Standard Mode

Case 6: Replace an Existing Modem in Promiscuous Mode

Case 7: Delete a Subscriber in Standard Mode

Case 8: Bulk Provision 100 Modems in Promiscuous Mode

Case 9: Preprovisioned First Time Activation in Promiscuous Mode

Case 10: Self-Provisioned First Time Activation in Promiscuous Mode

Case 11: Add a New Computer in Promiscuous Mode

Case 12: Self-Provisioned First Time Activation with Network Address Translation

Case 13: Add a New Computer Behind a Modem with Network Address Translation

Digital Set-Top Box Devices

Case 14: Preprovisioned First Time Activation for Digital Set-Top Box

Case 15: Modify an Existing Digital Set-Top Box

Case 16: Replace an Existing Digital Set-Top Box

Case 17: Remove an Existing Digital Set-Top Box

xGCP Devices

Case 18: Preprovisioned First Time Activation for Voice

Case 19: Activating an Additional Telephone Line on a Voice Device

Case 20: Disable an Existing Telephone Line on a Media Terminal Adapter

Case 21: Re-enable an Existing Telephone Line on a Media Terminal Adapter

Case 22: Replace an Existing Media Terminal Adapter

Case 23: Delete a Subscriber's Media Terminal Adapter

Device Searches

Case 24: Get Detailed Information for a Device

Case 25: Retrieve Devices Matching a Vendor Prefix

Provisioning Devices

The CSRC Device Provisioning Registrar (CSRC DPR) provisioning API provides a flow-through provisioning interface that allows you to integrate your provisioning systems, such as your operations support system (OSS), with CSRC. Your client programs access the CSRC system using the provisioning API.

To help you understand how to use the provisioning API, this chapter presents a series of use cases, including the calls you make to the provisioning API to add devices and services. The use cases in the following sections examine service provider scenarios as they relate to these provisioning workflows:

•High-speed data

•Digital set-top boxes

•Voice

•Device searches

Note This chapter uses pseudocode to illustrate calls to the provisioning API. This pseudocode resembles Java code, but is not intended for compilation. For sample code that you can compile, see the sample code directory installed with this product.

High-Speed Data Devices

This section provides pseudocode for the following use cases for high-speed data (HSD) devices.

•Case 1: Preprovisioned First Time Activation in Standard Mode

•Case 2: Self-Provisioned First Time Activation in Standard Mode

•Case 3: Modify an Existing Modem in Standard Mode

•Case 4: Add a New Computer in Standard Mode

•Case 5: Disable a Subscriber in Standard Mode

•Case 6: Replace an Existing Modem in Standard Mode

•Case 7: Delete a Subscriber in Standard Mode

•Case 8: Bulk Provision 100 Modems

•Case 9: Preprovisioned First Time Activation in Promiscuous Mode

•Case 10: Self-Provisioned First Time Activation in Promiscuous Mode

•Case 11: Add a New Computer in Promiscuous Mode

•Case 12: Self-Provisioned First Time Activation with Network Address Translation

•Case 13: Add a New Computer Behind a Modem with Network Address Translation

Case 1: Preprovisioned First Time Activation in Standard Mode

Scenario: A new subscriber contacts the service provider and requests service. The subscriber has a computer installed in a single dwelling unit.

Desired Outcome: Use the preprovisioning workflow model to bring a new unprovisioned cable modem and computer online so that they have the appropriate level of service.

Step 1 The service provider chooses a subscriber username and password for the billing system.

Step 2 The service provider selects the services that the subscriber can access.

Step 3 The service provider registers the device using their own user interface.

Step 4 The service provider's user interface passes information to CSRC, such as the modem's MAC address and the class of service. The new device is then registered with CSRC.
//To add a DOCSIS modem:
//MSO admin UI calls the provisioning API to pre-provision an HSD modem.
addDOCSISModem(
"1,6,00:11:22:33:44:55",
// macAddress: technician reads this off the modem
null,
// FQDN: not used in this example
"0123-45-6789",
// ownerID: here, account number from billing system
"Silver", 
// classOfService
"provisionedCM",
// modemClientClass: Cisco Network Registrar uses
//      to select a modem lease granting
//      provisioned access
null,
// cpeSelectionTags: not used in this example
null);
// properties: not used (but map could contain
//      optional data, such as a description field)
//-OR
//To add a DVB modem:
addDVBModem(
"1,6,aa:bb:cc:dd:ee:ff",
// macAddress: technician reads this off the modem
null,
// FQDN: not used in this example
"0123-45-6789", 
// ownerID: here, account number from billing system
"Silver",
// classOfService
"provisionedCM",
// modemClientClass: Network Registrar uses 
//      to select a lease granting provisioned access
null,
// cpeSelectionTags: not used in this example
propertiesMap);
// properties: map has values for channel number,
//      demodulator number, QOS index, and flags.
Step 5 The service provider's field technician installs the physical cable to the new subscriber's house and installs the preprovisioned device, connecting it to the subscriber's computer.

Step 6 The technician turns on the modem and CSRC gives it provisioned access.

Step 7 The technician turns on the computer and CSRC gives it restricted access.

Step 8 The technician starts a browser application on the computer and points the browser to the service provider's registration server (for example, an OSS user interface or a mediator).

Step 9 The technician uses the service provider's user interface to complete the steps required for registering the computer behind the provisioned cable modem.
// To register computer(s), MSO client registration program calls the following
// method:
addComputerByIPAddress(
"10.0.14.37",
// ipAddress: restricted access lease, from Network 
//    Registrar DHCP
null, 
// FQDN: not used in this example
"0123-45-6789",
// ownerID: here, account number from billing system
"provisionedCPE",
// clientClass: Network Registrar uses this to select 
//    a CPE lease
//     granting provisioned access
null); 
// properties: not used (but map could contain
//      optional data, such as a description field)
// After rebooting, the computer gets a different IP address: one that grants it
// registered access.
Step 10 The technician restarts the computer and the computer receives a new IP address. The cable modem and the computer are now both provisioned devices. The computer has access to the Internet through the service provider's network.

Case 2: Self-Provisioned First Time Activation in Standard Mode

Scenario: A subscriber has a computer (with a browser application) installed in a single dwelling unit and has purchased a DOCSIS cable modem.

Desired Outcome: Use the self-provisioning workflow model to bring a new unprovisioned DOCSIS cable modem and computer online so that they have the appropriate level of service.

Step 1 The subscriber purchases a DOCSIS cable modem, installs it in the home, and connects the computer to the cable modem.

Step 2 The subscriber turns on the modem and CSRC gives it restricted access.

Step 3 The subscriber turns on the computer, CSRC gives it restricted access.

Step 4 The subscriber starts a browser application on the computer and a spoofing DNS server points the browser to the service provider's registration server (for example, an OSS user interface or a mediator).

Step 5 The subscriber uses the service provider's user interface to complete the steps required for registration, including selecting class of service.

Step 6 The service provider's user interface passes the subscriber's information, such as the selected class of service and computer IP address, to CSRC. The subscriber's modem and computer are then registered with CSRC.
// MSO client registration program calls the provisioning API to auto-provision
// the modem and computer.
get-new-Batch()
// get a new batch for the subscriber computer lease
//      query
Map computerLease =
getDetailsforIPDevicebyIPAddress(
"10.0.14.38")
// ipAddress: restricted access computer lease, from
//    Network Registrar DHCP
String modemMACAddress =
// derive the modem MAC address from the computer's
//    lease
"1,6," + computerLease.RELAY_AGENT_REMOTE_ID;
get-new-Batch(NO_ACTIVATION)
// get a new batch for the "addModem" call --
//      ActivationMode.NO_ACTIVATION
//      means that CSRC does not reboot the modem.
// To add a DOCSIS modem:
addDOCSISModem(
modemMACadress,
// macAddress: derived from computer lease
null, 
// FQDN: not used in this example
"0123-45-6789",
// ownerID: here, account number from billing system
"Silver", 
// classOfService
"provisionedCM", 
// modemClientClass: Network Registrar uses this to 
//    select a modem
//      lease granting provisioned access
null,
// cpeSelectionTags: not used in this example
null,
// provisioningGroup: not used in this example
null); 
// properties: not used (but map could contain
// -OR-
//      optional data, such as a description field)
// To add a DVB modem:
addDVBModem(
modemMACadress,
// macAddress: derived from computer lease
null, 
// FQDN: not used in this example
"0123-45-6789",
// ownerID: here, account number from billing system
"Silver", 
// classOfService
"provisionedCM",
// modemClientClass: Network Registrar uses this to 
//    select a modem
//      lease granting provisioned access
null, 
// cpeSelectionTags: not used in this example
propertiesMap);
// properties: map has values for channel number,
//      demodulator number, QOS index, and flags.
get-new-Batch() 
// get a new batch for the "addComputer" call
addComputerByIPAddress(
"10.0.14.38", 
// ipAddress: restricted access lease, from Network 
//    Registrar DHCP
null,
// FQDN: not used in this example
"0123-45-6789", 
// ownerID: here, account number from billing system
"provisionedCPE", 
// clientClass: Network Registrar uses this to select 
a //    CPE lease
//      granting provisioned access
null); 
// properties: not used (but map could contain
//      optional data, such as a description field)
// The command to add the modem and the command to add the computer must be
// executed in two separate Batches.
// After rebooting, the modem and computer get new IP addresses: ones granting
// them registered access.
Step 7 The user interface instructs the subscriber to reboot the computer.

Step 8 The provisioning client calls resetIPDevice to reboot the modem and gives the modem provisioned access.

Step 9 When the computer is rebooted, it receives a new IP address and the cable modem and computer are now both provisioned devices. The computer has access to the Internet through the service provider's network.

Case 3: Modify an Existing Modem in Standard Mode

Scenario: A service provider's subscriber currently has Silver service. The subscriber has decided to upgrade to Gold service. The subscriber has a computer installed in the home.

Desired Outcome: Modify an existing modem's class of service and pass that change of service to the service provider's external systems.

Step 1 The subscriber starts the computer and points the browser to the service provider's user interface. The subscriber uses the user interface to remove the current Silver service and to select the Gold service.

Step 2 CSRC writes the changed class of service information to LDAP.
// MSO client registration program calls the provisioning API to change the
// modem's class of service.
// For a DOCSIS modem:
changeDOCSISModemClassOfService(
"1,6,00:11:22:33:44:55",
// macAddress: unique identifier for this modem
"Gold"); 
// newClassOfService
// - OR -
// For a DVB modem:
changeDVBModemClassOfService(
"1,6,aa:bb:cc:dd:ee:ff",
// macAddress: unique identifier for this modem
"Gold");
// newClassOfService
changeDVBModemProperties(
"1,6,aa:bb:cc:dd:ee:ff",
// macAddress: unique identifier for this modem
propertiesMap,
// properties: map has new value for QOS index.
null); 
// propertyRemoves: not used in this example
Step 3 The user interface instructs the subscriber to reboot the computer.

Step 4 The provisioning client calls resetIPDevice to reboot the modem and gives the modem provisioned access.

Step 5 The subscriber can now access the service provider's network using the Gold service.

Case 4: Add a New Computer in Standard Mode

Scenario: The landlord of an apartment building has four tenants sharing a modem and accessing the service provider's network. The landlord wants to provide Internet access to a new tenant, sharing the building's modem. The new tenant has a computer connected to the modem.

Desired Outcome: Use the self-provisioning workflow model to bring a new unprovisioned computer online with a previously provisioned cable modem so that the new computer has the appropriate level of service.

Step 1 The subscriber turns on the computer, CSRC gives it restricted access.

Step 2 The subscriber starts a browser application on the computer and a spoofing DNS server points the browser to the service provider's registration server (for example, an OSS user interface or a mediator).

Step 3 The subscriber uses the service provider's user interface to complete the steps required for adding a new computer.
// To register computer(s), MSO client registration program calls the following
// method:
addComputerByIPAddress(
"10.0.14.39", 
// ipAddress: restricted access lease, from Network 
//    Registrar DHCP
null,
// FQDN: not used in this example
"0123-45-6789",
// ownerID: here, account number from billing system
"provisionedCPE",
// clientClass: Network Registrar uses this to select a 
//    CPE lease
//      granting provisioned access
null); 
// properties: not used (but map could contain
//      optional data, such as a description field)
// After rebooting, the computer gets a different IP address: one that grants it
// registered access.
Step 4 The user interface instructs the subscriber to reboot the computer so that CSRC can capture the new computer information.

Step 5 The computer is now a provisioned device with access to the appropriate level of service.

Case 5: Disable a Subscriber in Standard Mode

Scenario: A service provider needs to disable a subscriber from the network due to recurring tardiness in payment.

Desired Outcome: Disable an operational modem and computer so that the devices temporarily cannot access the service provider's network.

Step 1 The service provider uses their own user interface to disable the subscriber's device(s) information.

Step 2 The service provider's application uses the provisioning client program requests a list of all of the subscriber's devices from CSRC.
// MSO admin UI calls the provisioning API to get a list of all the subscriber's
// devices.
getIPDevicesByOwnerID(
"0123-45-6789");
// query all the devices for this account number
Step 3 The service provider's application uses the provisioning client to each of the subscriber's devices individually.

Step 4 The service provider's application uses the provisioning client to write the changed class of service information to CSRC.
// for each device in the retrieved list:
DeviceLoop:
{
if (Device.deviceType == DOCSIS_MODEM)
{
get-new-Batch(AUTOMATIC)
// get a new batch for each modem being
// disabled -- ActivationMode.AUTOMATIC
// means that CSRC will reboot the modem(s).
changeDOCSISModemClassOfService(
Device.MAC_ADDRESS,
// macAddress: unique identifier for this modem
"Disabled");
// newClassOfService: disable network access
}
else
if (Device.deviceType == DVB_MODEM)
{
get-new-Batch(AUTOMATIC)
// get a new batch for each modem being
//     disabled -- ActivationMode.AUTOMATIC 
//     means that CSRC will reboot the modem(s).
changeDVBModemClassOfService(
Device.MAC_ADDRESS,
// macAddress: unique identifier for this modem
"Disabled");
// newClassOfService: disable network access
changeDVBModemProperties(
Device.MAC_ADDRESS,
// macAddress: unique identifier for this modem
propertiesMap,
// properties: map has new value for QOS index.
null);
// propertyRemoves: not used in this example
}
else
continue;
}
// end DeviceLoop
Step 5 CSRC updates the LDAP directory server and notifies the service provider's provisioning client program.

Step 6 For a modem, CSRC can reboot the device to ensure that it is disabled immediately.
// Change commands were added to batches that were declared with
// ActivationMode.AUTOMATIC, so modems are automatically rebooted when the
// batches are posted and the change commands are executed. A modem is not
// actually rendered disabled until it reboots.
Case 6: Replace an Existing Modem in Promiscuous Mode

Scenario: A service provider wants to replace a broken modem.

Desired Outcome: Physically replace an existing modem. Provision the modem and a computer to have the appropriate level of service.

Step 1 The service provider preprovisions a modem.

Step 2 The service provider deletes the old modem and adds the new modem.
// MSO client registration program calls the provisioning API to delete the
// old modem and add the new 
modem.
get-new-Batch()
// get a new batch for the "deleteModem" call
// To delete a DOCSIS modem:
deleteDOCSISModem(
"1,6,00:11:22:33:44:55"
// macAddress: unique identifier for this modem
);
// - OR -
// To delete a DVB modem:
deleteDVBModem(
"1,6,aa:bb:cc:dd:ee:ff"
// macAddress: unique identifier for this modem
);
// To add a DOCSIS modem:
addDOCSISModemByIPAddress(
"10.0.15.22",
// ipAddress: restricted access lease, from Network 
//    Registrar DHCP
null,
// FQDN: not used in this example
"0123-45-6789",
// ownerID: here, account number from billing system
"Silver",
// classOfService
"provisionedCM",
// modemClientClass: Network Registrar uses this to 
//    select a modem
//      lease granting provisioned access
null,
// cpeSelectionTags: not used in this example
null);
// properties: not used (but map could contain
//      optional data, such as a description field)
// - OR -
// To add a DVB modem:
addDVBModemByIPAddress(
"10.0.15.23",
// ipAddress: restricted access lease, from Network 
//    Registrar DHCP
null,
// FQDN: not used in this example
"0123-45-6789",
// ownerID: here, account number from billing system
"Silver",
// classOfService
"provisionedCM",
// modemClientClass: Network Registrar uses this to 
//    select a modem
//      lease granting provisioned access
null,
// cpeSelectionTags: not used in this example
propertiesMap);
// properties: map has values for channel number,
//      demodulator number, QOS index, and flags.
// The commands to delete the old modem and add the new modem must be
// executed in two separate batches.
Step 3 The service provider replaces the modem and turns it on. The computer is rebooted.

Step 4 The cable modem is now a fully provisioned device. The modem and the computer behind it have the appropriate level of service.

Case 7: Delete a Subscriber in Standard Mode

Scenario: A service provider needs to delete a subscriber who has discontinued service.

Desired Outcome: Permanently remove all of the subscriber's devices from the service provider's network.

Step 1 The service provider's user interface discontinues service to the subscriber.

Step 2 The service provider's application uses the provisioning client program to request a list of all of the subscriber's devices from CSRC.

// MSO admin UI calls the provisioning API to get a list of all the subscriber's

// devices.

getIPDevicesByOwnerID(

"0123-45-6789");

// query all the devices for this account number

Step 3 The service provider's application uses the provisioning client program to delete and reset each of the subscriber's devices individually.
// for each device in the retrieved list:
DeviceLoop:
{
get-new-Batch(NO_ACTIVATION)
// get a new batch for each modem being deleted
deleteIPDevice(
Device.MAC_ADDRESS);
// macAddress: unique identifier for this modem
resetIPDevice(
Device.MAC_ADDRESS);
// macAddress: unique identifier for this modem
// end DeviceLoop
Step 4 CSRC updates the LDAP directory server and notifies the service provider's provisioning client that the devices were deleted.

Case 8: Bulk Provision 100 Modems in Promiscuous Mode

Scenario: A service provider wants to preprovision 100 cable modems for distribution by a customer service representative at a service kiosk.

Desired Outcome: Modem data for all modems to be distributed to new subscribers is already online, so the customer service representative has a list of modems available for assignment.

Step 1 Modem MAC address data for new (or recycled) cable modems is collected into a list at the service provider's loading dock.

Step 2 Modems being assigned to a particular kiosk are bulk loaded into CSRC, flagged with the identifier for that kiosk.
get-new-Batch(NO_ACTIVATION)
// get a single batch for bulk load of 100 modems.
//    ActivationMode.NO_ACTIVATION
//    means that CSRC will NOT reboot the 
//    modem(s).
// Iterate through a list of modem MAC addresses. (Example assumes all modems are
// DOCSIS -- for DVB modems, use "addDVBModem" method.)
// for each modem MAC-address in list:
ModemLoop:
{
addDOCSISModem(
List.MAC_ADDRESS,
// macAddress: unique identifier for this modem
null,
// FQDN: not used in this example
kioskIDNumber,
// ownerID: here, each modem is flagged with the
//      identifier for the kiosk at which it will
//      be assigned to a new subscriber
"Bronze", 
// classOfService
"provisionedCM",
// modemClientClass: Network Registrar uses this to 
//    select a modem
//      lease granting provisioned access
null,
// cpeSelectionTags: not used in this example
null);
// properties: not used (but map could contain
//      optional data, such as a description field)
// end ModemLoop
Step 3 When the modems are distributed to new subscribers at the kiosk, the customer service representative will enter new service parameters, and will change the Owner ID field on the modem to reflect the new subscriber's account number.

Case 9: Preprovisioned First Time Activation in Promiscuous Mode

Scenario: A new subscriber contacts the service provider and requests service. The subscriber has a computer installed in a single dwelling unit.

Desired Outcome: Bring a new unprovisioned cable modem and computer online so that they have the appropriate level of service.

Step 1 The service provider chooses a subscriber username and password for the billing system.

Step 2 The service provider selects the services that the subscriber can access.

Step 3 The service provider registers the device using their own user interface.

Step 4 The service provider's user interface passes information to CSRC, such as the modem's MAC address and the class of service. Additionally, the modem gets a CPE selection tag setting that enables Network Registrar to select a provisioned address for any computers that will be connected behind the modem. The new modem is then registered with CSRC.
// MSO admin UI calls the provisioning API to pre-provision an HSD modem.
// To add a DOCSIS modem:
addDOCSISModem(
"1,6,00:11:22:33:44:55",
// macAddress: technician reads this off the modem
null,
// FQDN: not used in this example
"0123-45-6789",
// ownerID: here, account number from billing system
"Silver",
// classOfService
"provisionedCM",
// modemClientClass: Network Registrar uses this to 
//    select a modem
//      lease granting provisioned access
"provisionedCPE",
// cpeSelectionTags: instruct Network Registrar DHCP 
//    on scope
//      selection for non-tracked computers
null);
// properties: not used (but map could contain
//      optional data, such as a description field)
// - OR -
// To add a DVB modem:
addDVBModem(
"1,6,aa:bb:cc:dd:ee:ff",
// macAddress: technician reads this off the modem
null, 
// FQDN: not used in this example
"0123-45-6789",
// ownerID: here, account number from billing system
"Silver",
// classOfService
"provisionedCM",
// modemClientClass: Network Registrar uses this to 
//    select a modem
//      lease granting provisioned access
"provisionedCPE", 
// cpeSelectionTags: instruct Network Registrar DHCP 
//    on scope
//      selection for non-tracked computers
propertiesMap);
// properties: map has values for channel number,
//      demodulator number, QOS index, and flags.
Step 5 The service provider's field technician installs the physical cable to the new subscriber's house and installs the preprovisioned device, connecting it to the subscriber's computer.

Step 6 The technician turns on the modem and CSRC gives it provisioned access.

Step 7 The technician turns on the computer and CSRC gives it provisioned access. The cable modem and the computer are now both provisioned devices. The computer has access to the Internet through the service provider's network.

Case 10: Self-Provisioned First Time Activation in Promiscuous Mode

Scenario: The subscriber has a computer (with a browser application) installed in a single dwelling unit and has purchased a DOCSIS cable modem.

Desired Outcome: Bring a new unprovisioned DOCSIS cable modem and computer online with the appropriate level of service.

Step 1 The subscriber purchases a DOCSIS cable modem and installs it in the home.

Step 2 The subscriber turns on the modem, and CSRC gives it restricted access.

Step 3 The subscriber turns on the computer, and CSRC gives it restricted access.

Step 4 The subscriber starts a browser application on the computer and a spoofing DNS server points the browser to the service provider's registration server (for example, an OSS user interface or a mediator).

Step 5 The subscriber uses the service provider's user interface to complete the steps required for registration, including selecting class of service.

Step 6 The service provider's user interface passes the subscriber's information to CSRC, including the selected classes of service and computer IP address. The subscriber is then registered with CSRC.
// MSO client registration program calls the provisioning API to auto-provision
// the modem.
get-new-Batch()
// get a new batch for the subscriber computer lease
//      query
Map computerLease =
getDetailsforIPDevicebyIPAddress(
"10.0.14.57")
// ipAddress: restricted access computer lease, from
//    Network Registrar DHCP
get-new-Batch(NO_ACTIVATION)
// get a new batch for the "addModem" call 
// To add a DOCSIS modem:
addDOCSISModem(
modemMACaddress,
// macAddress = the relay-agent-remote-ID: derived 
// from the computer lease
null,
// FQDN: not used in this example
"0123-45-6789",
// ownerID: here, account number from billing system
"Silver", 
// classOfService
"provisionedCM", 
// modemClientClass: Network Registrar uses this to 
//    select a modem
//      lease granting provisioned access
"provisionedCPE",
// cpeSelectionTags: instruct Network Registrar DHCP 
//    on scope
//      selection for non-tracked computers
null);
// properties: not used (but map could contain
//      optional data, such as a description field)
// - OR -
// To add a DVB modem:
addDVBModem(
modemMACaddress
// macAddress: derived from computer lease
null, 
// FQDN: not used in this example
"0123-45-6789",
// ownerID: here, account number from billing system
"Silver", 
// classOfService
"provisionedCM",
// modemClientClass: Network Registrar uses this to 
//    select a modem
//      lease granting provisioned access
"provisionedCPE", 
// cpeSelectionTags: instruct Network Registrar DHCP 
//    on scope
//      selection for non-tracked computers
propertiesMap);
// properties: map has values for channel number,
//      demodulator number, QOS index, and flags.
// The computer is not registered with CSRC. The cpeSelectionTags parameter
// in the "addModem" method call will instruct Network Registrar DHCP on scope selection 
// for non-tracked computers.
// After rebooting, the modem and computer get new IP addresses: ones that grant
// them registered access.
Step 7 The user interface instructs the subscriber to reboot the computer.

Step 8 The provisioning client calls resetIPDevice to reboot the modem and gives the modem provisioned access.

Step 9 When the computer is rebooted, it receives a new IP address. The cable modem is now a provisioned device. The computer is not registered with CSRC, but it gains access to the Internet through the service provider's network.

Case 11: Add a New Computer in Promiscuous Mode

Scenario: A subscriber wishes to connect a second computer behind an installed cable modem.

Desired Outcome: Providing the subscriber's selected service permits connecting multiple CPEs, the subscriber has network access from both connected computers.

Note This case does not require calls to the provisioning API.

Step 1 The subscriber connects a second computer behind the cable modem.

Step 2 The subscriber turns on the computer.

Step 3 If the subscriber's selected service permits connecting multiple CPEs, CSRC gives the second computer access to the Internet.

Case 12: Self-Provisioned First Time Activation with Network Address Translation

Scenario: A university has purchased a DOCSIS cable modem with network address translation (NAT) and DHCP capability. The five occupants of the unit each have a computer installed with a browser application.

Desired Outcome: Use the self-provisioning workflow model to bring a new unprovisioned cable modem (with NAT) and the computers behind it online so that they have the appropriate level of service.

Step 1 The subscriber purchases a cable modem with NAT and DHCP capability, and installs it in a multiple dwelling unit.

Step 2 The subscriber turns on the modem and CSRC gives it restricted access.

Step 3 The subscriber connects a laptop computer to the cable modem, and the DHCP server in the modem provides an IP address to the laptop.

Step 4 The subscriber starts a browser application on the computer and a spoofing DNS server points the browser to the service provider's registration server (for example, an OSS user interface or a mediator).

Step 5 The subscriber uses the service provider's user interface to complete the steps required for registration of the modem. The registration user interface detects that the modem is using NAT and registers the modem, making sure that the modem gets a class of service that is compatible with NAT.
// MSO admin UI calls the provisioning API to query the details for the
// client device (with the IP address which has been determined from the
// web browser). Query may be performed based on MAC address or IP address.
Map deviceDetails =
getDetailsForIPDevice(
"10.0.15.22"); 
// ipAddress
// With NAT, the computer is never seen by the Network Registrar DHCP server. Instead,
// the modem has translated the IP address it assigned to the computer, so
// the web browser sees the modem's IP address. When the lease data is
// examined, the MAC address for the device and the relay-agent-remote-id are the
// same, indicating that this is an unprovisioned modem device, which is
// therefore presumed to be performing NAT.
boolean isNAT =
(deviceDetails.MAC_ADDRESS == `1,6' + deviceDetails.RELAY_AGENT_REMOTE_ID);
// MSO client registration program then calls the provisioning API to
// provision the NAT modem (with an appropriate class of service for NAT).
get-new-Batch(NO_ACTIVATION)
// get a new batch for the "addModem" call 
// To add a DOCSIS modem:
addDOCSISModemByIPAddress(
"10.0.15.22", 
// ipAddress: restricted access lease, from Network 
//    Registrar DHCP
null,
// FQDN: not used in this example
"0123-45-6789",
// ownerID: here, account number from billing system
"Silver-NAT",
// classOfService
"provisionedCM", 
// modemClientClass: Network Registrar uses this to 
//    select a modem
//      lease granting provisioned access
null,
// cpeSelectionTags: not used in this example
null);
// properties: not used (but map could contain
//      optional data, such as a description field)
// - OR -
// To add a DVB modem:
addDVBModemByIPAddress(
"10.0.15.22", 
// ipAddress: restricted access lease, from Network 
//    Registrar DHCP
null, 
// FQDN: not used in this example
"0123-45-6789", 
// ownerID: here, account number from billing system
"Silver-NAT",
// classOfService
"provisionedCM",
// modemClientClass: Network Registrar uses this to 
//    select a modem
//      lease granting provisioned access
null,
// cpeSelectionTags: not used in this example
propertiesMap); 
// properties: map has values for channel number,
//      demodulator number, QOS index, and flags.
Step 6 The user interface instructs the subscriber to reboot the computer.

Step 7 The provisioning client calls resetIPDevice to reboot the modem and gives the modem provisioned access.

Step 8 The cable modem is now fully provisioned and the computers behind it have full access to the service provider's network.

Note Certain cable modems with NAT may require you to reboot the computer to get the new class of service settings.

Case 13: Add a New Computer Behind a Modem with Network Address Translation

Scenario: The landlord of an apartment building has four tenants sharing a modem and accessing the service provider's network. The landlord wants to provide Internet access to a new tenant, sharing the building's modem. The modem has NAT and DHCP capability. The new tenant has a computer connected to the modem.

Desired Outcome: Use the self-provisioning workflow model to bring a new unprovisioned computer online with a previously provisioned cable modem so that the new computer has the appropriate level of service.

Note This case does not require calls to the provisioning API.

Step 1 The subscriber turns on the computer.

Step 2 The computer is now a provisioned device with access to the appropriate level of service.

Note The provisioned NAT modem hides the computers behind it from the network.

Digital Set-Top Box Devices

This section provides the following use cases and their associated pseudocode:

•Case 14: Preprovisioned First Time Activation for Digital Set-Top Box

•Case 15: Modify an Existing Digital Set-Top Box

•Case 16: Replace an Existing Digital Set-Top Box

•Case 17: Remove an Existing Digital Set-Top Box

Case 14: Preprovisioned First Time Activation for Digital Set-Top Box

Scenario: A new subscriber contacts the service provider and requests service. The service provider determines the type of service the customer wants (for example, interactive digital video and data, or just digital video).

Desired Outcome: Use the preprovisioning workflow model to bring a new unprovisioned DSTB online so that it has the appropriate level of service.

Step 1 The service provider chooses a subscriber username and password for the billing system.

Step 2 The service provider selects the services that the subscriber can access.

Step 3 The service provider selects an appropriate DSTB based on the services the subscriber can access. For example, digital video service requires a DVB DSTB, while digital video and interactive data require a DOCSIS/DVB DSTB.

Step 4 The service provider uses their own user interface to complete the steps required to register the DSTB.

Step 5 The service provider's user interface passes information to CSRC, such as the MAC addresses and classes of service for each component of the DSTB (for example, the DOCSIS cable modem, DVB cable modem, and computer middleware components). The DSTB is then registered with CSRC.
// MSO admin UI calls the provisioning API to pre-provision DOCSIS modem,
// DVB Modem, and DSTB middleware components of a DSTB.
get-new-Batch(NO_ACTIVATION)
// get a single batch for all 3 DSTB components. 
//      ActivationMode.NO_ACTIVATION
//      means that CSRC will NOT reboot the modem(s).
addDOCSISModem(
"1,6,00:11:22:33:44:55",
// macAddress: technician reads this off the modem
null,
// FQDN: not used in this example
"0123-45-6789", 
// ownerID: here, account number from billing system
"Bronze", 
// classOfService
"provisionedCM",
// modemClientClass: Network Registrar uses this to 
//    select a modem
//      lease granting provisioned access
null,
// cpeSelectionTags: not used in this example
null);
// properties: not used (but map could contain
//      optional data, such as a description field)
addDVBModem(
"1,6,aa:bb:cc:dd:ee:ff",
// macAddress: technician reads this off the modem
null,
// FQDN: not used in this example
"0123-45-6789", 
// ownerID: here, account number from billing system
"Bronze", 
// classOfService
"provisionedCM",
// modemClientClass: Network Registrar uses this to 
//    select a modem
//      lease granting provisioned access
null,
// cpeSelectionTags: not used in this example
propertiesMap);
// properties: map has values for channel number,
//      demodulator number, QOS index, and flags.
addDSTB(
"1,6,99:88:77:66:55:44",
// macAddress: technician reads this off the DSTB
null,
// FQDN: not used in this example
"0123-45-6789", 
// ownerID: here, account number from billing system
"provisionedDSTB", 
// clientClass: Network Registrar uses this to select 
//    a CPE lease granting provisioned access
"1,6,00:11:22:33:44:55",
// relatedDOCSISModemID: MAC address for DOCSIS modem
//      component
"1,6,aa:bb:cc:dd:ee:ff",
// relatedDVBModemID: MAC address for DVB modem
//      component
null);
// properties: not used (but map could contain
//      optional data, such as a description field)
Step 6 The service provider's field technician installs the physical cable to the new subscriber's home and installs the preprovisioned DSTB.

Step 7 The DSTB boots and CSRC gives it provisioned access.

Step 8 The technician verifies that the DSTB is operating properly for the services that the voice subscriber selected.

Case 15: Modify an Existing Digital Set-Top Box

Scenario: A subscriber currently has the Bronze service and wants to upgrade to the Silver service. The subscriber has a DSTB installed in the home.

Desired Outcome: Modify an existing DSTB's class of service and pass that change of service to the service provider's external systems.

Step 1 The subscriber starts the DSTB and points the browser to the service provider's user interface. The subscriber uses the user interface to remove the current Bronze service and to select the Silver service.

Step 2 The service provider's user interface passes information to CSRC, such as the IP address of the DSTB computer middleware and the new class of service.
// MSO admin UI calls the provisioning API to change service on a DSTB.
// CSRC queries the DSTB to find the related modem(s).
Map DSTB =
getDetailsForDSTBByIPAddress(
"10.0.17.49"); 
// query the DSTB
Step 3 CSRC writes the changed class of service information for the DSTB's related modem components to the LDAP directory server.
// MSO admin UI next calls the provisioning API to change service on
// the related DOCSIS modem and DVB modem components of the DSTB.
get-new-Batch(NO_ACTIVATION)
// get a separate batch for each component modem
changeDOCSISModemClassOfService(
DSTB.relatedDOCISModemID, 
// macAddress: the identifier (MAC address) for 
//      the related DOCSIS modem component
"Silver");
// newClassOfService
changeDVBModemClassOfService(
DSTB.relatedDVBModemID,
// macAddress: the identifier (MAC address) for 
//      the related DVB modem component
"Silver"); 
// newClassOfService
changeDVBModemProperties(
DSTB.relatedDVBModemID,
// macAddress: the identifier (MAC address) for 
//      the related DVB modem component
propertiesMap,
// properties: map has new value for QOS index.
null); 
// propertyRemoves: not used in this example
Step 4 The service provider instructs the subscriber to reboot the DSTB.

Step 5 The user can now access the service provider's network using the Silver level of service.

Case 16: Replace an Existing Digital Set-Top Box

Scenario: A service provider wants to replace an existing DSTB, currently installed in a subscriber's home, with a new one.

Desired Outcome: Physically replace an in-service DSTB with a new one. Provision the new box with the same classes of service as the old DSTB.

Step 1 The service provider, using their own user interface, accesses the data for the old DSTB. The new DSTB is then preprovisioned with the same class of service information as the old box.

Note Because CSRC supports only preprovisioning of a DSTB, the service provider must perform step one.
// MSO admin UI calls the provisioning API to access data for the old
// DSTB and its related modem components.
get-new-Batch()
// 1st query
Map DSTB =
getDetailsForDSTB(
"1,6,99:88:77:66:55:44");
// query the DSTB
get-new-Batch()
// 2nd query
Map DOCSISModem =
getDetailsForDOCSISModem(
DSTB.relatedDOCSISModemID);
// macAddress: the identifier (MAC address) for the
//      related DOCSIS modem component
Map DVBModem =
getDetailsForDVBModem(
DSTB.relatedDVBModemID);
// macAddress: the identifier (MAC address) for the
//      related DVB modem component
// MSO admin UI next calls the provisioning API to pre-provision DOCSIS modem,
// DVB Modem, and DSTB middleware components of a new DSTB, using service data
// from the old DSTB.
get-new-Batch(NO_ACTIVATION)
// get a single batch for all 3 DSTB components.
//    ActivationMode.NO_ACTIVATION
//    means that CSRC will NOT reboot the 
//    modem(s).
addDOCSISModem(
"1,6,00:11:22:33:44:66",
// macAddress: technician reads this off the modem
null, 
// FQDN: not used in this example
DSTB.OWNER_ID,
// ownerID: all 3 components get same ownerID
// Transfer remaining parameters from old modem
DOCSISModem.CLASS_OF_SERVICE,
// classOfService
DOCSISModem.CLIENT_CLASS, 
// modemClientClass
DOCSISModem.CPE_SELECTION_TAGS,
// cpeSelectionTags (may be null)
DOCSISModem.PROPERTIES); 
// properties (may be null)
addDVBModem(
"1,6,aa:bb:cc:dd:ee:dd",
// macAddress: technician reads this off the modem
null,
// FQDN: not used in this example
DSTB.OWNER_ID,
// ownerID: all 3 components get same owner ID
// Transfer remaining parameters from old modem
DVBModem.CLASS_OF_SERVICE,
// classOfService
DVBModem.CLIENT_CLASS, 
// modemClientClass
DVBModem.CPE_SELECTION_TAGS,
// cpeSelectionTags (may be null)
DVBModem.PROPERTIES);
// properties (may be null)
addDSTB(
"1,6,99:88:77:66:55:33",
// macAddress: technician reads this off the DSTB
null,
// FQDN: not used in this example
DSTB.OWNER_ID,
// ownerID: all 3 components get same owner ID
DSTB.CLIENT_CLASS, 
// clientClass: transfer from old DSTB
//    granting provisioned access
"1,6,00:11:22:33:44:66",
// relatedDOCSISModemID: MAC address for DOCSIS 
//    modem component (do NOT use value from old
//    box)
"1,6,aa:bb:cc:dd:ee:dd",
// relatedDVBModemID: MAC address for DVB modem
//      component (do NOT use value from old box)
DSTB.PROPERTIES);
// properties (may be null)
Step 2 The service provider sends the new DSTB to the subscriber, with instructions about how to swap the new box for the old one. The subscriber replaces the old DSTB with the new one.

Step 3 The subscriber returns the old DSTB to the service provider, and then the service provider can remove it from CSRC.

Case 17: Remove an Existing Digital Set-Top Box

Scenario: A subscriber wants to remove an existing DSTB currently installed in a subscriber's home.

Desired Outcome: Physically remove an existing DSTB from a subscriber's home.

Step 1 The subscriber removes an existing DSTB from the home.

Step 2 The subscriber sends the DSTB to the service provider.

Step 3 The service provider receives the DSTB into inventory. An inventory control person uses their own registration server (for example, an OSS user interface or a mediator) to remove the DSTB from active duty and places it in inventory.

Step 4 The service provider uses the registration server to remove each component of the DSTB from CSRC.
// MSO admin UI calls the provisioning API to remove the inactive DSTB and its
// component modems from CSRC.
deleteDSTB(
"1,6,99:88:77:66:55:44", 
// macAddress: unique identifier for this DSTB
true);
// deleteAllRelatedModems: true, so also delete 
//     related DOCSIS and/or DVB modems
xGCP Devices

This section provides the following use cases with their associated pseudocode:

•Case 18: Preprovisioned First Time Activation for Voice

•Case 19: Activating an Additional Telephone Line on a Voice Device

•Case 20: Disable an Existing Telephone Line on a Media Terminal Adapter

•Case 21: Re-enable an Existing Telephone Line on a Media Terminal Adapter

•Case 22: Replace an Existing Media Terminal Adapter

•Case 23: Delete a Subscriber's Media Terminal Adapter

Case 18: Preprovisioned First Time Activation for Voice

Scenario: A new subscriber contacts the service provider and requests voice service.

Desired Outcome: Use the preprovisioning workflow model to bring a new preprovisioned media terminal adapter (MTA) online so that it has the appropriate level of service to place and receive VoIP calls over the service provider's network.

Step 1 The service provider chooses a subscriber username and password for the billing system.

Step 2 The service provider selects the number of telephone lines to enable on the MTA, and selects the VoIP services and features that the subscriber can access on those lines.

Step 3 The service provider uses their own user interface to complete the steps required to register the device.

Step 4 The service provider's user interface passes device information to CSRC, such as addresses, classes of service, and VoIP services and feature assignments. The new device is then registered with CSRC.
// MSO client registration program calls the provisioning API
// to provision the xGCP MTA and one line
get-new-batch(NO_ACTIVATION)
// get a new batch for the addXGCPModemMTA
//    and addXGCPService calls --
//    ActivationMode.NO_ACTIVATION
//    means CSRC will not automatically
//    reboot the MTA.
// To add an xGCP Modem MTA.
// The device is called a Modem MTA since it is both a DOCSIS Modem
// and an MTA. This API call provisions
// both the DOCSIS Modem and the MTA itself.
addXGCPModemMTA(
"1,6,ff:00:ee:11:dd:22", 
// macAddress: technician reads this off the MTA
"jdoemta.myisp.com",
// FQDN that the service provider assigns
"0123-54-9876",
// ownerID: here, account number from billing system
"Gold",
// modemClassOfService: used to determine which
//     DOCSIS configuration template should be
//     used to build the DOCSIS configuration file.
null, 
// mtaDeviceClassOfService: not used in this example
"provisionedMTA",
// modemClientClass: Network Registrar uses this to 
//    select an MTA lease granting provisioning 
//    access
null,
// cpeSelectionTags: not used in this example
null,
// provisioningGroup: not used in this example
null); 
// properties: not used in this example
// To add service for a xGCP Modem MTA line
addXGCPService(
"1,6,ff:00:ee:11:dd:22",
// macAddress: unique identifier for this modem MTA
0,
// portNumber: Number of line to be enabled.
//     Line numbers are 0 based
"ca", 
// cmsQualifier: CMS qualifier for CMS which
//     will control this line
"ca1.whatever.net",
// cmsFQDN: CMS FQDN for CMS which
//     will control this line
5678,
// cmsPortNumber: CMS Port Number for CMS which
//     will control this line
"(978)123-4567",
// telephoneNumber: telephone number for this
//     line - for informational purposes
null); 
// properties: not used in this example
Step 5 The service provider's field technician installs the physical cable to the new subscriber's home and installs the preprovisioned MTA. Analog phones are then connected to the MTA lines enabled through the provisioning workflow.

Step 6 The MTA boots and CSRC gives it provisioned VoIP service through the service provider's network.

Case 19: Activating an Additional Telephone Line on a Voice Device

Scenario: A service provider needs to provision an additional telephone line on a previously provisioned voice device (MTA).

Desired Outcome: The subscriber can place and receive VoIP calls over an additional line using the service provider's network.

Step 1 The service provider uses their own user interface to enable an additional telephone line, as well as the VoIP services and features the subscribers can have access to for that new line.

Step 2 The service provider's user interface passes the information to CSRC.
// MSO client registration program calls the provisioning API
// to provision an additional line
get-new-batch(AUTOMATIC) 
// get a new batch for the
//    addXGCPService call --
//    ActivationMode.AUTOMATIC
//    means CSRS will reboot the MTA automatically.
// To add service for a xGCP Modem MTA line
addXGCPService(
"1,6,ff:00:ee:11:dd:22",
// macAddress: unique identifier for this modem MTA
1,
// portNumber: Number of line to be enabled.
//     Line numbers are 0 based
"ma", 
// cmsQualifier: CMS qualifier for CMS which
//     will control this line
"ma1.whatever.net",
// cmsFQDN: CMS FQDN for CMS which
//     will control this line
5678,
// cmsPortNumber: CMS Port Number for CMS which
//     will control this line
"(978)123-4568", 
// telephoneNumber: telephone number for this
//     line - for informational purposes
null);
// properties: not used in this example
Step 3 CSRC updates the LDAP directory server and reprovisions the MTA by rebooting the device.

Step 4 CSRC notifies the service provider's provisioning client program that the new line is now enabled.
// Because batch Activation is ActivationMode.AUTOMATIC,
// the additional line is enabled immediately after CSRC reboots the MTA.
Step 5 The subscriber can now place and receive telephone calls over the new telephone line.

Case 20: Disable an Existing Telephone Line on a Media Terminal Adapter

Scenario: A service provider needs to disable a telephone line for a subscriber who has voluntarily decided to discontinue service on the line, or due to recurring tardiness in payment.

Desired Outcome: Disable an operational telephone line.

Step 1 The service provider uses their own user interface to disable a previously provisioned telephone line.

Step 2 The service provider's user interface, acting as a CSRC client, passes the information to CSRC.
// MSO client registration program calls the provisioning API
// to disable a line
get-new-batch(AUTOMATIC) 
// get a new batch for the
//    deleteXGCPService call --
//    ActivationMode.AUTOMATIC
//    means that CSRC will automatically reboot
//    the MTA.
// To delete service for a xGCP Modem MTA line
deleteXGCPService(
"1,6,ff:00:ee:11:dd:22",
// macAddress: unique identifier for this modem MTA
1);
// portNumber: Number of line to be disabled.
//     Line numbers are 0 based
Step 3 CSRC removes the telephone line from LDAP.

Step 4 CSRC can reboot the MTA to ensure that the line is disabled immediately.
// Because batch Activation mode is ActivationMode.AUTOMATIC,
// the line is disabled immediately after CSRC reboots the MTA.
Step 5 CSRC notifies the service provider's provisioning client that the line is now disabled.

Step 6 After reboots, the subscriber cannot place and receive telephone calls.

Case 21: Re-enable an Existing Telephone Line on a Media Terminal Adapter

Scenario: A service provider needs to re-enable a telephone line for a subscriber. The telephone line was previously disabled (see Case 20).

Desired Outcome: Re-enable a telephone line so that the subscriber can place and receive telephone calls using the service provider's network.

Step 1 The service provider uses their own user interface to re-enable a telephone line.

Step 2 The service provider's user interface passes the information to CSRC.
// MSO client registration program calls the provisioning API
// to re-enable a line
get-new-batch(AUTOMATIC)
// get a new batch for the
//    addXGCPService call --
//    ActivationMode.AUTOMATIC
//    means CSRC will reboot the MTA automatically
// To add service for a xGCP Modem MTA line
addXGCPService(
"1,6,ff:00:ee:11:dd:22",
// macAddress: unique identifier for this modem MTA
1, 
// portNumber: Number of line to be re-enabled.
//     Line numbers are 0 based
"ma",
// cmsQualifier: CMS qualifier for CMS which
//     will control this line
"ma1.whatever.net",
// cmsFQDN: CMS FQDN for CMS which
//     will control this line
5678, 
// cmsPortNumber: CMS Port Number for CMS which
//     will control this line
"(978)123-4568",
// telephoneNumber: telephone number for this
//     line - for informational purposes
null);
// properties: not used in this example
Step 3 CSRC re-adds the telephone line to LDAP.

Step 4 CSRC can reboot the MTA to ensure that the line is re-enabled immediately.

Note In some cases, CSRC removes the telephone line from LDAP but does not reboot the MTA (see Case 20). In these cases, a reboot is not necessary.
// Because batch Activation mode is ActivationMode.AUTOMATIC,
// the line is re-enabled immediately after CSRC reboots the MTA.
Step 5 CSRC notifies the service provider's provisioning client that the line is now re-enabled.

Step 6 After reboots, the subscriber cannot place and receive telephone calls.

Case 22: Replace an Existing Media Terminal Adapter

Scenario: A service provider's subscriber wants to replace his or her MTA with a newer MTA, either because his or her existing MTA is broken, or he or she wants a newer model.

Desired Outcome: The old MTA is disabled. The new MTA is provisioned with the appropriate number of telephone lines.

Step 1 The service provider uses their own user interface to delete the old MTA, and add the new one with the appropriate number of telephone lines.

Step 2 The service provider's user interface passes the information to CSRC.
// The service provider's client calls a getDetailsForXGCPModemMTA method in order to
// to capture the current MTA's device information.
// The service provider's client calls the provisioning API
// to delete the old MTA
get-new-batch(NO_ACTIVATION)
// get a new batch for the deleteXGCPModemMTA
//    and addXGCPModemMTA call --
//    ActivationMode.NO_ACTIVATION
//    means CSRC will not reboot the MTAs 
//    automatically.
// To Delete an xGCP Modem MTA
deleteXGCPModemMTA(
""1,6,ff:00:ee:11:dd:22");
// macAddress: unique identifier for this modem MTA
// To add an xGCP Modem MTA.
addXGCPModemMTA(
"1,6,ff:00:ee:11:bb:55",
// macAddress: unique identifier for new modem MTA
"jdoemta.myisp.com",
// FQDN: assigned by the service provider
"0123-54-9876",
// ownerID: here, account number from billing system
"Gold", 
// modemClassOfService: used to determine which
//     DOCSIS configuration template should be
//     used to build the DOCSIS configuration file.
null, 
// mtaDeviceClassOfService: not used in this example
"provisionedMTA", 
// modemClientClass: Network Registrar uses this to 
//    select an MTA lease granting provisioning 
//    access
null, 
// cpeSelectionTags: not used in this example
null);
// properties: not used in this example
// To add service for an xGCP Modem MTA line
addXGCPService(
"1,6,ff:00:ee:11:bb:55",
// macAddress: unique identifier for this modem MTA
0, 
// portNumber: Number of line to be enabled.
//     Line numbers are 0 based
"ca", 
// cmsQualifier: CMS qualifier for CMS which
//     will control this line
"ca1.whatever.net",
// cmsFQDN: CMS FQDN for CMS which
/     will control this line
5678, 
// cmsPortNumber: CMS Port Number for CMS which
//     will control this line
"(978)123-4567",
// telephoneNumber: telephone number for this
//     line - for informational purposes
null);
// properties: not used in this example
Step 3 CSRC deletes the old MTA, and adds the new MTA and corresponding telephone lines to LDAP.

Step 4 CSRC can reboot the new MTA to ensure that it is enabled immediately.

Step 5 CSRC notifies the service provider's provisioning client that the old MTA has been deleted, and the new MTA is now operational.

Step 6 After reboots, the subscriber cannot place and receive telephone calls.

Case 23: Delete a Subscriber's Media Terminal Adapter

Scenario: A service provider needs to delete an MTA for a subscriber who has discontinued service.

Desired Outcome: Permanently remove the MTA, and associated telephone lines, from the service provider's network.

Step 1 The service provider uses their own user interface to delete the MTA.

Step 2 The service provider's user interface passes the information to CSRC.
// MSO client registration program calls the provisioning API
// to delete the old MTA
get-new-batch(NO_ACTIVATION)
// get a new batch for the
//    deleteXGCPModemMTA call --
// To Delete an xGCP Modem MTA
deleteXGCPModemMTA(
"1,6,ff:00:ee:11:bb:55");
// macAddress: unique identifier for this modem MTA
// addXGCPModemMTA
Step 3 CSRC deletes the MTA from LDAP.

Step 4 The provisioning client calls resetIPDevice to reboot the MTA, and the MTA is disabled.

Step 5 CSRC notifies the service provider's provisioning client that the MTA has been deleted.

Step 6 After reboots, the subscriber cannot place and receive telephone calls.

Device Searches

This section provides the following use cases and their associated pseudocode:

•Case 24: Get Detailed Information for a Device

•Case 25: Retrieve Devices Matching a Vendor Prefix

Case 24: Get Detailed Information for a Device

Scenario: A service provider wants to allow an administrator to view detailed information for a particular device.

Desired Outcome: The service provider's administrative application displays all known details about a given device, including MAC address, lease information, provisioned status of the device, and the device type (if known).

Step 1 The administrator enters either the MAC address or the IP address for the device being queried into the service provider's administrative user interface.

Step 2 CSRC queries the LDAP directory server for the details for that device.
// MSO admin UI calls the provisioning API to query the details for the
// requested device. Query may be performed based on MAC address or IP address,
// depending on what is known about the device.
Map deviceDetails =
getDetailsForIPDevice(
"1,6,00:11:22:33:44:55");
// macAddress: unique identifier for the device
// - OR -
Map deviceDetails =
getDetailsForIPDeviceByIPAddress(
"10.0.17.129"); 
// ipAddress
Step 3 The service provider's application then presents a detail page of device data, which can display everything that is known about the requested device. If the device has been connected to the service provider's network, this data will include lease information (for example, IP address, relay agent identifier). The data indicates whether or not the device has been provisioned, and, if it has, the data also includes the device type.
// extract device detail data from the map
String deviceType = (String)deviceDetails.get(DEVICE_TYPE);
String macAddress = (String)deviceDetails.get(MAC_ADDRESS);
String ipAddress  = (String)deviceDetails.get(IP_ADDRESS);
String relayAgentID  = (String)deviceDetails.get(RELAY_AGENT_ID);
Boolean isProvisioned = (Boolean)deviceDetails.get(IS_PROVISIONED);
// The admin UI now formats and prints the detail data to a view page
Case 25: Retrieve Devices Matching a Vendor Prefix

Scenario: A service provider wants to allow an administrator to view data for all devices matching a particular vendor prefix.

Desired Outcome: The service provider's administrative application displays a paged list of devices matching the requested vendor prefix, showing the device type, MAC address, client class, and provisioned status of the device.

Step 1 The administrator enters the substring matching the desired vendor prefix into the service provider's administrative user interface.

Step 2 CSRC queries the LDAP directory server for a list of all MAC addresses for the devices that match the requested vendor prefix.
// MSO admin UI calls the provisioning API to query all devices for a specified
// vendor prefix.
List deviceList =
getIPDevicesByMACAddress(
"1,6,ff:00:ee:*",
// macAddressPattern: the requested vendor prefix
10000); 
// maximumReturned: 
Step 3 The service provider's application divides the full list of device identifiers into sublists, requests details on these sublists from CSRC, and presents a page of device data. For each device, the code provides for display of the device type, MAC address, client class, and provisioned status of the device, one device per line.
// MSO admin UI calls the provisioning API to retrieve the first "page" of
// 20 devices from the list.
// use Java List S to get sublists
List pageList = deviceList.subList(0, 19);
// provisioning API gives list of detail maps for the sublist of devices
List pageDetailsMaps = getIPDeviceDetailsList(pageList);
// MSO admin UI iterates over the list of detail maps to extract data to
// format a summary page
Iterator iter = pageDetailsMaps.iterator();
while (iter.hasNext()) 
// loop once per output line
{
Map detailMap = (Map)iter.next();
// extract device detail data from each map
String deviceType = (String)detailMap.get(DEVICE_TYPE);
String macAddress = (String)detailMap.get(MAC_ADDRESS);
String clientClass = (String)detailMap.get(CLIENT_CLASS);
Boolean isProvisioned = (Boolean)detailMap.get(IS_PROVISIONED);
// format and print above data in output line
}

//To add a DOCSIS modem:
//MSO admin UI calls the provisioning API to pre-provision an HSD modem.
addDOCSISModem(
	"1,6,00:11:22:33:44:55",	// macAddress: technician reads this off the modem
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Silver",	// classOfService
	"provisionedCM",	// modemClientClass: Cisco Network Registrar uses
		// to select a modem lease granting
		// provisioned access
	null,	// cpeSelectionTags: not used in this example
	null);	// properties: not used (but map could contain
		// optional data, such as a description field)
//-OR
//To add a DVB modem:

addDVBModem(
	"1,6,aa:bb:cc:dd:ee:ff",	// macAddress: technician reads this off the modem
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Silver",	// classOfService
	"provisionedCM",	// modemClientClass: Network Registrar uses
		// to select a lease granting provisioned access
	null,	// cpeSelectionTags: not used in this example
	propertiesMap);	// properties: map has values for channel number,
		// demodulator number, QOS index, and flags.

// To register computer(s), MSO client registration program calls the following
// method:
addComputerByIPAddress(
	"10.0.14.37",	// ipAddress: restricted access lease, from Network // Registrar DHCP
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"provisionedCPE",	// clientClass: Network Registrar uses this to select // a CPE lease
		// granting provisioned access
	null);	// properties: not used (but map could contain
		// optional data, such as a description field)

// After rebooting, the computer gets a different IP address: one that grants it
// registered access.

// MSO client registration program calls the provisioning API to auto-provision
// the modem and computer.

get-new-Batch()	// get a new batch for the subscriber computer lease
		// query
Map computerLease =
	getDetailsforIPDevicebyIPAddress(
	"10.0.14.38")	// ipAddress: restricted access computer lease, from
		// Network Registrar DHCP

String modemMACAddress =	// derive the modem MAC address from the computer's
		// lease
	"1,6," + computerLease.RELAY_AGENT_REMOTE_ID;

get-new-Batch(NO_ACTIVATION)	// get a new batch for the "addModem" call --
		// ActivationMode.NO_ACTIVATION
		// means that CSRC does not reboot the modem.
// To add a DOCSIS modem:
addDOCSISModem(
	modemMACadress,	// macAddress: derived from computer lease
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Silver",	// classOfService
	"provisionedCM",	// modemClientClass: Network Registrar uses this to // select a modem
		// lease granting provisioned access
	null,	// cpeSelectionTags: not used in this example
	null,	// provisioningGroup: not used in this example
	null);	// properties: not used (but map could contain
// -OR-	// optional data, such as a description field)
// To add a DVB modem:
addDVBModem(
	modemMACadress,	// macAddress: derived from computer lease
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Silver",	// classOfService
	"provisionedCM",	// modemClientClass: Network Registrar uses this to // select a modem
		// lease granting provisioned access
	null,	// cpeSelectionTags: not used in this example
	propertiesMap);	// properties: map has values for channel number,
		// demodulator number, QOS index, and flags.
get-new-Batch()	// get a new batch for the "addComputer" call
addComputerByIPAddress(
	"10.0.14.38",	// ipAddress: restricted access lease, from Network // Registrar DHCP
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"provisionedCPE",	// clientClass: Network Registrar uses this to select a // CPE lease
		// granting provisioned access
	null);	// properties: not used (but map could contain
		// optional data, such as a description field)

// The command to add the modem and the command to add the computer must be
// executed in two separate Batches.
// After rebooting, the modem and computer get new IP addresses: ones granting
// them registered access.

// MSO client registration program calls the provisioning API to change the
// modem's class of service.
// For a DOCSIS modem:
changeDOCSISModemClassOfService(
	"1,6,00:11:22:33:44:55",	// macAddress: unique identifier for this modem
	"Gold");	// newClassOfService
// - OR -
// For a DVB modem:
changeDVBModemClassOfService(
	"1,6,aa:bb:cc:dd:ee:ff",	// macAddress: unique identifier for this modem
	"Gold");	// newClassOfService

changeDVBModemProperties(
	"1,6,aa:bb:cc:dd:ee:ff",	// macAddress: unique identifier for this modem
	propertiesMap,	// properties: map has new value for QOS index.
	null);	// propertyRemoves: not used in this example

// To register computer(s), MSO client registration program calls the following
// method:
addComputerByIPAddress(
	"10.0.14.39",	// ipAddress: restricted access lease, from Network // Registrar DHCP
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"provisionedCPE",	// clientClass: Network Registrar uses this to select a // CPE lease
		// granting provisioned access
	null);	// properties: not used (but map could contain
		// optional data, such as a description field)
// After rebooting, the computer gets a different IP address: one that grants it
// registered access.

// MSO admin UI calls the provisioning API to get a list of all the subscriber's
// devices.
getIPDevicesByOwnerID(
	"0123-45-6789");	// query all the devices for this account number

// Change commands were added to batches that were declared with
// ActivationMode.AUTOMATIC, so modems are automatically rebooted when the
// batches are posted and the change commands are executed. A modem is not
// actually rendered disabled until it reboots.

// MSO admin UI calls the provisioning API to get a list of all the subscriber's
// devices.
getIPDevicesByOwnerID(
	"0123-45-6789");	// query all the devices for this account number

// MSO admin UI calls the provisioning API to pre-provision an HSD modem.
// To add a DOCSIS modem:
addDOCSISModem(
	"1,6,00:11:22:33:44:55",	// macAddress: technician reads this off the modem
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Silver",	// classOfService
	"provisionedCM",	// modemClientClass: Network Registrar uses this to // select a modem
		// lease granting provisioned access
	"provisionedCPE",	// cpeSelectionTags: instruct Network Registrar DHCP // on scope
		// selection for non-tracked computers
	null);	// properties: not used (but map could contain
		// optional data, such as a description field)
// - OR -
// To add a DVB modem:
addDVBModem(
	"1,6,aa:bb:cc:dd:ee:ff",	// macAddress: technician reads this off the modem
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Silver",	// classOfService
	"provisionedCM",	// modemClientClass: Network Registrar uses this to // select a modem
		// lease granting provisioned access
	"provisionedCPE",	// cpeSelectionTags: instruct Network Registrar DHCP // on scope
		// selection for non-tracked computers
	propertiesMap);	// properties: map has values for channel number,
		// demodulator number, QOS index, and flags.

// MSO client registration program calls the provisioning API to auto-provision
// the modem.

get-new-Batch()	// get a new batch for the subscriber computer lease
		// query
Map computerLease =
	getDetailsforIPDevicebyIPAddress(
	"10.0.14.57")	// ipAddress: restricted access computer lease, from
		// Network Registrar DHCP

get-new-Batch(NO_ACTIVATION)	// get a new batch for the "addModem" call

// To add a DOCSIS modem:
addDOCSISModem(
	modemMACaddress,	// macAddress = the relay-agent-remote-ID: derived
		// from the computer lease
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Silver",	// classOfService
	"provisionedCM",	// modemClientClass: Network Registrar uses this to // select a modem
		// lease granting provisioned access
	"provisionedCPE",	// cpeSelectionTags: instruct Network Registrar DHCP // on scope
		// selection for non-tracked computers
	null);	// properties: not used (but map could contain
		// optional data, such as a description field)
// - OR -
// To add a DVB modem:
addDVBModem(
	modemMACaddress	// macAddress: derived from computer lease
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Silver",	// classOfService
	"provisionedCM",	// modemClientClass: Network Registrar uses this to // select a modem
		// lease granting provisioned access
	"provisionedCPE",	// cpeSelectionTags: instruct Network Registrar DHCP // on scope
		// selection for non-tracked computers
	propertiesMap);	// properties: map has values for channel number,
		// demodulator number, QOS index, and flags.

// The computer is not registered with CSRC. The cpeSelectionTags parameter
// in the "addModem" method call will instruct Network Registrar DHCP on scope selection
// for non-tracked computers.
// After rebooting, the modem and computer get new IP addresses: ones that grant
// them registered access.

// MSO admin UI calls the provisioning API to query the details for the
// client device (with the IP address which has been determined from the
// web browser). Query may be performed based on MAC address or IP address.
Map deviceDetails =
	getDetailsForIPDevice(
		"10.0.15.22");	// ipAddress

// With NAT, the computer is never seen by the Network Registrar DHCP server. Instead,
// the modem has translated the IP address it assigned to the computer, so
// the web browser sees the modem's IP address. When the lease data is
// examined, the MAC address for the device and the relay-agent-remote-id are the
// same, indicating that this is an unprovisioned modem device, which is
// therefore presumed to be performing NAT.

boolean isNAT =
	(deviceDetails.MAC_ADDRESS == `1,6' + deviceDetails.RELAY_AGENT_REMOTE_ID);

// MSO client registration program then calls the provisioning API to
// provision the NAT modem (with an appropriate class of service for NAT).

get-new-Batch(NO_ACTIVATION)	// get a new batch for the "addModem" call

// To add a DOCSIS modem:
addDOCSISModemByIPAddress(
	"10.0.15.22",	// ipAddress: restricted access lease, from Network // Registrar DHCP
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Silver-NAT",	// classOfService
	"provisionedCM",	// modemClientClass: Network Registrar uses this to // select a modem
			// lease granting provisioned access
	null,	// cpeSelectionTags: not used in this example
	null);	// properties: not used (but map could contain
			// optional data, such as a description field)
// - OR -
// To add a DVB modem:
addDVBModemByIPAddress(
	"10.0.15.22",	// ipAddress: restricted access lease, from Network // Registrar DHCP
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Silver-NAT",	// classOfService
	"provisionedCM",	// modemClientClass: Network Registrar uses this to // select a modem
			// lease granting provisioned access
	null,	// cpeSelectionTags: not used in this example
	propertiesMap);	// properties: map has values for channel number,
			// demodulator number, QOS index, and flags.

// MSO admin UI calls the provisioning API to pre-provision DOCSIS modem,
// DVB Modem, and DSTB middleware components of a DSTB.

get-new-Batch(NO_ACTIVATION)	// get a single batch for all 3 DSTB components.
		// ActivationMode.NO_ACTIVATION
		// means that CSRC will NOT reboot the modem(s).

addDOCSISModem(
	"1,6,00:11:22:33:44:55",	// macAddress: technician reads this off the modem
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Bronze",	// classOfService
	"provisionedCM",	// modemClientClass: Network Registrar uses this to // select a modem
		// lease granting provisioned access
	null,	// cpeSelectionTags: not used in this example
	null);	// properties: not used (but map could contain
		// optional data, such as a description field)
addDVBModem(
	"1,6,aa:bb:cc:dd:ee:ff",	// macAddress: technician reads this off the modem
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Bronze",	// classOfService
	"provisionedCM",	// modemClientClass: Network Registrar uses this to // select a modem
		// lease granting provisioned access
	null,	// cpeSelectionTags: not used in this example
	propertiesMap);	// properties: map has values for channel number,
		// demodulator number, QOS index, and flags.

addDSTB(
	"1,6,99:88:77:66:55:44",	// macAddress: technician reads this off the DSTB
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"provisionedDSTB",	// clientClass: Network Registrar uses this to select // a CPE lease granting provisioned access
	"1,6,00:11:22:33:44:55",	// relatedDOCSISModemID: MAC address for DOCSIS modem
		// component
	"1,6,aa:bb:cc:dd:ee:ff",	// relatedDVBModemID: MAC address for DVB modem
		// component
	null);	// properties: not used (but map could contain
		// optional data, such as a description field)

// MSO admin UI calls the provisioning API to change service on a DSTB.
// CSRC queries the DSTB to find the related modem(s).
Map DSTB =
getDetailsForDSTBByIPAddress(
	"10.0.17.49");	// query the DSTB

// MSO admin UI next calls the provisioning API to change service on
// the related DOCSIS modem and DVB modem components of the DSTB.
get-new-Batch(NO_ACTIVATION)	// get a separate batch for each component modem

changeDOCSISModemClassOfService(
	DSTB.relatedDOCISModemID,	// macAddress: the identifier (MAC address) for
		// the related DOCSIS modem component
	"Silver");	// newClassOfService

changeDVBModemClassOfService(
	DSTB.relatedDVBModemID,	// macAddress: the identifier (MAC address) for
		// the related DVB modem component
	"Silver");	// newClassOfService

changeDVBModemProperties(
	DSTB.relatedDVBModemID,	// macAddress: the identifier (MAC address) for
		// the related DVB modem component
	propertiesMap,	// properties: map has new value for QOS index.
	null);	// propertyRemoves: not used in this example

// MSO client registration program calls the provisioning API
// to provision the xGCP MTA and one line
get-new-batch(NO_ACTIVATION)	// get a new batch for the addXGCPModemMTA
		// and addXGCPService calls --
		// ActivationMode.NO_ACTIVATION
	// means CSRC will not automatically
		// reboot the MTA.

// To add an xGCP Modem MTA.
// The device is called a Modem MTA since it is both a DOCSIS Modem
// and an MTA. This API call provisions
// both the DOCSIS Modem and the MTA itself.
addXGCPModemMTA(
	"1,6,ff:00:ee:11:dd:22",	// macAddress: technician reads this off the MTA
	"jdoemta.myisp.com",	// FQDN that the service provider assigns
	"0123-54-9876",	// ownerID: here, account number from billing system
	"Gold",	// modemClassOfService: used to determine which
		// DOCSIS configuration template should be
		// used to build the DOCSIS configuration file.
	null,	// mtaDeviceClassOfService: not used in this example
	"provisionedMTA",	// modemClientClass: Network Registrar uses this to // select an MTA lease granting provisioning // access
	null,	// cpeSelectionTags: not used in this example
	null,	// provisioningGroup: not used in this example
	null);	// properties: not used in this example

// To add service for a xGCP Modem MTA line
addXGCPService(
	"1,6,ff:00:ee:11:dd:22",	// macAddress: unique identifier for this modem MTA
	0,	// portNumber: Number of line to be enabled.
		// Line numbers are 0 based
	"ca",	// cmsQualifier: CMS qualifier for CMS which
		// will control this line
	"ca1.whatever.net",	// cmsFQDN: CMS FQDN for CMS which
		// will control this line
	5678,	// cmsPortNumber: CMS Port Number for CMS which
		// will control this line
	"(978)123-4567",	// telephoneNumber: telephone number for this
		// line - for informational purposes
	null);	// properties: not used in this example

// MSO client registration program calls the provisioning API
// to provision an additional line
get-new-batch(AUTOMATIC)	// get a new batch for the
		// addXGCPService call --
		// ActivationMode.AUTOMATIC
	// means CSRS will reboot the MTA automatically.

// To add service for a xGCP Modem MTA line
addXGCPService(
	"1,6,ff:00:ee:11:dd:22",	// macAddress: unique identifier for this modem MTA
	1,	// portNumber: Number of line to be enabled.
		// Line numbers are 0 based
	"ma",	// cmsQualifier: CMS qualifier for CMS which
		// will control this line
	"ma1.whatever.net",	// cmsFQDN: CMS FQDN for CMS which
		// will control this line
	5678,	// cmsPortNumber: CMS Port Number for CMS which
		// will control this line
	"(978)123-4568",	// telephoneNumber: telephone number for this
		// line - for informational purposes
	null);	// properties: not used in this example

// Because batch Activation is ActivationMode.AUTOMATIC,
// the additional line is enabled immediately after CSRC reboots the MTA.

// MSO client registration program calls the provisioning API
// to disable a line
get-new-batch(AUTOMATIC)	// get a new batch for the
		// deleteXGCPService call --
		// ActivationMode.AUTOMATIC
	// means that CSRC will automatically reboot
		// the MTA.

// To delete service for a xGCP Modem MTA line
deleteXGCPService(
	"1,6,ff:00:ee:11:dd:22",	// macAddress: unique identifier for this modem MTA
	1);	// portNumber: Number of line to be disabled.
		// Line numbers are 0 based

// Because batch Activation mode is ActivationMode.AUTOMATIC,
// the line is disabled immediately after CSRC reboots the MTA.

// MSO client registration program calls the provisioning API
// to re-enable a line
get-new-batch(AUTOMATIC)	// get a new batch for the
		// addXGCPService call --
		// ActivationMode.AUTOMATIC
	// means CSRC will reboot the MTA automatically

// To add service for a xGCP Modem MTA line
addXGCPService(
	"1,6,ff:00:ee:11:dd:22",	// macAddress: unique identifier for this modem MTA
	1,	// portNumber: Number of line to be re-enabled.
		// Line numbers are 0 based
	"ma",	// cmsQualifier: CMS qualifier for CMS which
		// will control this line
	"ma1.whatever.net",	// cmsFQDN: CMS FQDN for CMS which
		// will control this line
	5678,	// cmsPortNumber: CMS Port Number for CMS which
		// will control this line
	"(978)123-4568",	// telephoneNumber: telephone number for this
		// line - for informational purposes
	null);	// properties: not used in this example

// Because batch Activation mode is ActivationMode.AUTOMATIC,
// the line is re-enabled immediately after CSRC reboots the MTA.

// MSO client registration program calls the provisioning API
// to delete the old MTA
get-new-batch(NO_ACTIVATION)	// get a new batch for the
		// deleteXGCPModemMTA call --

// To Delete an xGCP Modem MTA
deleteXGCPModemMTA(
	"1,6,ff:00:ee:11:bb:55");	// macAddress: unique identifier for this modem MTA
		// addXGCPModemMTA

// MSO admin UI calls the provisioning API to query the details for the
// requested device. Query may be performed based on MAC address or IP address,
// depending on what is known about the device.
Map deviceDetails =
	getDetailsForIPDevice(
		"1,6,00:11:22:33:44:55");	// macAddress: unique identifier for the device
// - OR -
Map deviceDetails =
	getDetailsForIPDeviceByIPAddress(
	"10.0.17.129");	// ipAddress

// extract device detail data from the map
String deviceType = (String)deviceDetails.get(DEVICE_TYPE);
String macAddress = (String)deviceDetails.get(MAC_ADDRESS);
String ipAddress = (String)deviceDetails.get(IP_ADDRESS);
String relayAgentID = (String)deviceDetails.get(RELAY_AGENT_ID);
Boolean isProvisioned = (Boolean)deviceDetails.get(IS_PROVISIONED);

// The admin UI now formats and prints the detail data to a view page

// MSO admin UI calls the provisioning API to query all devices for a specified
// vendor prefix.
List deviceList =
	getIPDevicesByMACAddress(
	"1,6,ff:00:ee:*",	// macAddressPattern: the requested vendor prefix
	10000);	// maximumReturned:

Was this Document Helpful?

Feedback

Contact Cisco

Open a Support Case
(Requires a Cisco Service Contract)

// for each device in the retrieved list:
DeviceLoop:
{
	if (Device.deviceType == DOCSIS_MODEM)
	{
		get-new-Batch(AUTOMATIC)	// get a new batch for each modem being
			// disabled -- ActivationMode.AUTOMATIC
			// means that CSRC will reboot the modem(s).
		changeDOCSISModemClassOfService(
		Device.MAC_ADDRESS,	// macAddress: unique identifier for this modem
		"Disabled");	// newClassOfService: disable network access

	}
	else
	if (Device.deviceType == DVB_MODEM)
	{

		get-new-Batch(AUTOMATIC)	// get a new batch for each modem being
			// disabled -- ActivationMode.AUTOMATIC
			// means that CSRC will reboot the modem(s).

		changeDVBModemClassOfService(
		Device.MAC_ADDRESS,	// macAddress: unique identifier for this modem
		"Disabled");	// newClassOfService: disable network access

		changeDVBModemProperties(
		Device.MAC_ADDRESS,	// macAddress: unique identifier for this modem
		propertiesMap,	// properties: map has new value for QOS index.
		null);	// propertyRemoves: not used in this example
	}
	else
		continue;
}
// end DeviceLoop

// MSO client registration program calls the provisioning API to delete the
// old modem and add the new modem.

get-new-Batch()		// get a new batch for the "deleteModem" call

// To delete a DOCSIS modem:
deleteDOCSISModem(
	"1,6,00:11:22:33:44:55"	// macAddress: unique identifier for this modem
	);
// - OR -
// To delete a DVB modem:
deleteDVBModem(
	"1,6,aa:bb:cc:dd:ee:ff"	// macAddress: unique identifier for this modem
	);

// To add a DOCSIS modem:
addDOCSISModemByIPAddress(
	"10.0.15.22",	// ipAddress: restricted access lease, from Network // Registrar DHCP
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Silver",	// classOfService
	"provisionedCM",	// modemClientClass: Network Registrar uses this to // select a modem
		// lease granting provisioned access
	null,	// cpeSelectionTags: not used in this example
	null);	// properties: not used (but map could contain
		// optional data, such as a description field)
// - OR -
// To add a DVB modem:
addDVBModemByIPAddress(
	"10.0.15.23",	// ipAddress: restricted access lease, from Network // Registrar DHCP
	null,	// FQDN: not used in this example
	"0123-45-6789",	// ownerID: here, account number from billing system
	"Silver",	// classOfService
	"provisionedCM",	// modemClientClass: Network Registrar uses this to // select a modem
		// lease granting provisioned access
	null,	// cpeSelectionTags: not used in this example
	propertiesMap);	// properties: map has values for channel number,
		// demodulator number, QOS index, and flags.

// The commands to delete the old modem and add the new modem must be
// executed in two separate batches.

get-new-Batch(NO_ACTIVATION)			// get a single batch for bulk load of 100 modems.
			// ActivationMode.NO_ACTIVATION
			// means that CSRC will NOT reboot the
			// modem(s).

// Iterate through a list of modem MAC addresses. (Example assumes all modems are
// DOCSIS -- for DVB modems, use "addDVBModem" method.)

// for each modem MAC-address in list:
ModemLoop:
{
	addDOCSISModem(
		List.MAC_ADDRESS,	// macAddress: unique identifier for this modem
		null,	// FQDN: not used in this example
		kioskIDNumber,	// ownerID: here, each modem is flagged with the
			// identifier for the kiosk at which it will
			// be assigned to a new subscriber
		"Bronze",	// classOfService
		"provisionedCM",	// modemClientClass: Network Registrar uses this to // select a modem
			// lease granting provisioned access
		null,	// cpeSelectionTags: not used in this example
		null);	// properties: not used (but map could contain
			// optional data, such as a description field)

// end ModemLoop

// MSO admin UI calls the provisioning API to access data for the old
// DSTB and its related modem components.
get-new-Batch()			// 1st query

Map DSTB =
	getDetailsForDSTB(
		"1,6,99:88:77:66:55:44");	// query the DSTB

get-new-Batch()			// 2nd query

Map DOCSISModem =
	getDetailsForDOCSISModem(
	DSTB.relatedDOCSISModemID);		// macAddress: the identifier (MAC address) for the
			// related DOCSIS modem component
Map DVBModem =
	getDetailsForDVBModem(
	DSTB.relatedDVBModemID);		// macAddress: the identifier (MAC address) for the
			// related DVB modem component

// MSO admin UI next calls the provisioning API to pre-provision DOCSIS modem,
// DVB Modem, and DSTB middleware components of a new DSTB, using service data
// from the old DSTB.

get-new-Batch(NO_ACTIVATION)			// get a single batch for all 3 DSTB components.
			// ActivationMode.NO_ACTIVATION
			// means that CSRC will NOT reboot the
			// modem(s).

addDOCSISModem(
	"1,6,00:11:22:33:44:66",		// macAddress: technician reads this off the modem
	null,		// FQDN: not used in this example
	DSTB.OWNER_ID,		// ownerID: all 3 components get same ownerID
			// Transfer remaining parameters from old modem
	DOCSISModem.CLASS_OF_SERVICE,		// classOfService
	DOCSISModem.CLIENT_CLASS,		// modemClientClass
	DOCSISModem.CPE_SELECTION_TAGS,		// cpeSelectionTags (may be null)
	DOCSISModem.PROPERTIES);		// properties (may be null)

addDVBModem(
	"1,6,aa:bb:cc:dd:ee:dd",		// macAddress: technician reads this off the modem
	null,		// FQDN: not used in this example
	DSTB.OWNER_ID,		// ownerID: all 3 components get same owner ID
			// Transfer remaining parameters from old modem
	DVBModem.CLASS_OF_SERVICE,		// classOfService
	DVBModem.CLIENT_CLASS,		// modemClientClass
	DVBModem.CPE_SELECTION_TAGS,		// cpeSelectionTags (may be null)
	DVBModem.PROPERTIES);		// properties (may be null)

addDSTB(
	"1,6,99:88:77:66:55:33",		// macAddress: technician reads this off the DSTB
	null,		// FQDN: not used in this example
	DSTB.OWNER_ID,		// ownerID: all 3 components get same owner ID
	DSTB.CLIENT_CLASS,		// clientClass: transfer from old DSTB
			// granting provisioned access
	"1,6,00:11:22:33:44:66",		// relatedDOCSISModemID: MAC address for DOCSIS
			// modem component (do NOT use value from old
			// box)
	"1,6,aa:bb:cc:dd:ee:dd",		// relatedDVBModemID: MAC address for DVB modem
			// component (do NOT use value from old box)
	DSTB.PROPERTIES);		// properties (may be null)

// MSO admin UI calls the provisioning API to remove the inactive DSTB and its
// component modems from CSRC.

deleteDSTB(
	"1,6,99:88:77:66:55:44",	// macAddress: unique identifier for this DSTB
	true);	// deleteAllRelatedModems: true, so also delete
		// related DOCSIS and/or DVB modems

// The service provider's client calls a getDetailsForXGCPModemMTA method in order to
// to capture the current MTA's device information.

// The service provider's client calls the provisioning API
// to delete the old MTA
get-new-batch(NO_ACTIVATION)		// get a new batch for the deleteXGCPModemMTA
		// and addXGCPModemMTA call --
		// ActivationMode.NO_ACTIVATION
		// means CSRC will not reboot the MTAs
		// automatically.

// To Delete an xGCP Modem MTA
deleteXGCPModemMTA(
	""1,6,ff:00:ee:11:dd:22");	// macAddress: unique identifier for this modem MTA


// To add an xGCP Modem MTA.
addXGCPModemMTA(
	"1,6,ff:00:ee:11:bb:55",	// macAddress: unique identifier for new modem MTA
	"jdoemta.myisp.com",	// FQDN: assigned by the service provider
	"0123-54-9876",	// ownerID: here, account number from billing system
	"Gold",	// modemClassOfService: used to determine which
		// DOCSIS configuration template should be
		// used to build the DOCSIS configuration file.
	null,	// mtaDeviceClassOfService: not used in this example
	"provisionedMTA",	// modemClientClass: Network Registrar uses this to // select an MTA lease granting provisioning // access
	null,	// cpeSelectionTags: not used in this example
	null);	// properties: not used in this example

// To add service for an xGCP Modem MTA line
addXGCPService(
	"1,6,ff:00:ee:11:bb:55",	// macAddress: unique identifier for this modem MTA
	0,	// portNumber: Number of line to be enabled.
		// Line numbers are 0 based
	"ca",	// cmsQualifier: CMS qualifier for CMS which
		// will control this line
	"ca1.whatever.net",	// cmsFQDN: CMS FQDN for CMS which
		/ will control this line
	5678,	// cmsPortNumber: CMS Port Number for CMS which
		// will control this line
	"(978)123-4567",	// telephoneNumber: telephone number for this
		// line - for informational purposes
	null);	// properties: not used in this example

// MSO admin UI calls the provisioning API to retrieve the first "page" of
// 20 devices from the list.

// use Java List S to get sublists
List pageList = deviceList.subList(0, 19);

// provisioning API gives list of detail maps for the sublist of devices
List pageDetailsMaps = getIPDeviceDetailsList(pageList);

// MSO admin UI iterates over the list of detail maps to extract data to
// format a summary page
Iterator iter = pageDetailsMaps.iterator();

while (iter.hasNext())		// loop once per output line
{
	Map detailMap = (Map)iter.next();

	// extract device detail data from each map
	String deviceType = (String)detailMap.get(DEVICE_TYPE);
	String macAddress = (String)detailMap.get(MAC_ADDRESS);
	String clientClass = (String)detailMap.get(CLIENT_CLASS);
	Boolean isProvisioned = (Boolean)detailMap.get(IS_PROVISIONED);
	// format and print above data in output line
}

Provisioning Devices

Available Languages

Download Options

Bias-Free Language

Table Of Contents