DPE Configuration Commands

This chapter describes the command line interface (CLI) commands that you can use to manage and monitor the Broadband Access Center (BAC) Device Provisioning Engine (DPE).

clear cache

Use this command to erase the entire DPE cache and reset the server to a clean state. When the DPE is restarted, it connects to the RDU and rebuilds the cache from the information stored in the RDU database.

Note Ensure that you stop the DPE before erasing the DPE cache by running the dpe stop command. For more information, see dpe start | stop.

You should only clear the cache when the DPE encounters a major problem. Running this command forces the DPE to rebuild or repopulate its device cache. This process may take an extended amount of time to complete.

After the command is entered, the DPE cache is cleared and a prompt appears to indicate how much disk space was cleared as a result. If the cache could not be cleared, the reason for the failure appears.

Syntax Description

Examples

dpe# clear cache

Clearing DPE cache...

+ 417792 bytes cleared.

dpe# clear cache

DPE must be stopped before clearing cache.

dpe# clear cache

Clearing DPE cache...

+ Cache already cleared.

dpe port

Use this command to specify the port on which the CLI server communicates with the DPE.

Note You must stop the DPE before changing its port number. If you attempt to run this command on an operational DPE, the following error message appears:

ERROR: DPE must be stopped before changing the port number.

The changes that you introduce through this command do not take effect until you restart the DPE. For information on stopping and starting the DPE, see dpe start | stop.

Syntax Description

dpe port port

Defaults

Examples

dpe# dpe port 49186

% OK

dpe provisioning-group primary

Use this command to specify the DPE as a member of a specified primary provisioning group. Most DPEs are configured with one primary provisioning group; however, selecting multiple provisioning groups might allow multiple DHCP servers to use this DPE.

When assigning new provisioning groups that have a large number of devices, restarting the DPE can take an extensive amount of time, depending on the number of devices in your network and the size of the devices' configurations. This delay is due to the fact that the cache for each provisioning group has to be synchronized; or, for new provisioning groups, completely rebuilt.

Note In normal situations, you must change the provisioning groups only when the DPE is first deployed on the network.

When you use this command, follow it by running the dpe reload command so that the changes take effect. See dpe reload, for additional information.

To remove configured primary provisioning groups, use the no form of this command. For more information, see no dpe provisioning-group primary.

Syntax Description

dpe provisioning-group primary name [name*]

•

name*—Allows the entry of multiple provisioning groups. When specifying multiple provisioning groups, you must insert a space between their names.

Note

Depending on the technology deployed, you can specify one or more provisioning groups to which the DPE can belong. This BAC release only supports CWMP technology, which requires the DPE to be in only one provisioning group.

Examples

dpe# dpe provisioning-group primary PrimaryProvGroup

% OK (Requires DPE restart "# dpe reload")

dpe# dpe provisioning-group primary provisioning-grp-1 provisioning-grp-2

% OK (Requires DPE restart "# dpe reload")

no dpe provisioning-group primary

Use this command to clear configured primary provisioning groups. If primary provisioning groups are not available, you can use the DPE as a backup for other provisioning groups or a TFTP file cache.

When you use this command, follow it by running the dpe reload command so that the changes take effect. See dpe reload, for additional information.

Syntax Description

Examples

dpe# no dpe provisioning-group primary

% OK (Requires DPE restart "# dpe reload")

dpe rdu-server

Use this command to identify the RDU to which this DPE connects. Normally, you configure the RDU on the default port, but for security reasons, you could configure it to run on a nondefault port.

When you use this command, follow it by running the dpe reload command so that the changes take effect. See dpe reload, for additional information.

Syntax Description

dpe rdu-server {host | ip} port

•

host—Identifies the fully qualified domain name of the host on which the RDU is running.

•

port—Identifies the port number on which RDU is listening for DPE connections (by default 49187).

Examples

dpe# dpe rdu-server rdu.cisco.com 49187

% OK (Requires DPE restart "# dpe reload")

This result occurs when you specify the fully qualified domain name of the RDU host.

dpe# dpe rdu-server 10.10.20.1 49187

% OK (Requires DPE restart "# dpe reload")

dpe reload

Use this command to restart the DPE, which must already be operating before performing the reload operation. If the DPE has not stopped within 60 seconds, the BAC process watchdog (bprAgent) forces the DPE to stop, and an alert message, indicating that this has occurred, appears. After that message appears, the DPE restarts.

Syntax Description

Examples

dpe# dpe reload

Process dpe has been restarted

dpe shared-secret

Use this command to set the shared secret used for communications with the RDU. Communication fails if the shared secret, which is set on the two servers, is not the same.

When you use this command, follow it by running the dpe reload command so that the changes take effect. See dpe reload, for additional information.

Syntax Description

dpe shared-secret secret

Defaults

Examples

dpe# dpe shared-secret private

% OK (Requires DPE restart "# dpe reload")

dpe start | stop

Syntax Description

dpe start | stop

•

start—Starts the DPE. You can use this command only when the DPE is not running. Having the DPE start successfully does not guarantee that the DPE will run successfully. Check the DPE log to ensure that the DPE has started correctly. Also, check the log periodically to ensure that no additional errors have occurred.

•

stop—Stops the DPE. You can use this command only when the DPE is running. If the DPE has not stopped within 60 seconds, the DPE agent forces the DPE to stop, and an alert message, indicating that this has occurred, appears.

Examples

dpe# dpe start

Process dpe has been started

dpe# dpe stop

dpe is stopped

interface ethernet provisioning enabled

Use this command to control whether the Ethernet interface(s) is used to handle provisioning requests. This command isolates the interactions of the DPE with the RDU from its interactions with CPE. Specifically, the fully qualified domain name of the enabled interface is set as the URL for file downloads that a CPE device performs (for information on setting the FQDN, see interface ethernet provisioning fqdn).

When you use this command, follow it by running the reload command so that the changes take effect. See dpe reload, for additional information.

Syntax Description

interface ethernet {intf0 | intf1} provisioning enabled {true | false}

Defaults

Examples

dpe# interface ethernet hme0 provisioning enabled true

% OK (Requires DPE restart "# dpe reload")

interface ethernet provisioning fqdn

Use this command to set the fully qualified domain name (FQDN) for a specific interface. The provisioning FQDN is the FQDN that is given to a CPE device to contact the specific DPE interface. In CWMP, this FQDN is used to construct the auto-configuration server URL when performing a CPE redirect or similar functions, unless a different value was configured on the provisioning group object at the RDU.

Note Remember to use the same FQDN for all DPEs in a given provisioning group. If DPEs are located behind the load-balancer, use the FQDN of the load balancer as the interface FQDN, and ensure that it is the same for all DPEs which are part of the same load-balancing group.

Before setting the FQDN for an interface, ensure that provisioning is enabled on that interface. To enable provisioning on an interface, see interface ethernet provisioning enabled.

When you use this command, you must follow it by running the reload command so that the changes take effect. See dpe reload, for additional information.

Syntax Description

interface ethernet {intf0 | intf1} provisioning fqdn fqdn

•

fqdn—Identifies the fully qualified domain name that is set on the specified interface.

Examples

dpe# interface ethernet hme0 provisioning fqdn cisco.com

% OK (Requires DPE restart "> dpe reload")

show device-config

If you run this command on an unlicensed DPE, a message similar to this one appears:

This DPE is not licensed. Your request cannot be serviced. 
Please check with your system administrator for a DPE license.

Syntax Description

show device-config device-ID

Examples

For the purpose of this example, assume that the device ID is 0014XX-XXX000000001.

dpe# dpe show device-config 0014XX-XXX000000001

HTTP configuration for device 0014XX-XXX000000001 in default provisioning-group:

   HTTP Configuration

       Instruction records:

          HttpAuthRecord :

             IS_PERSISTENT : true

             IS_AUTO_RUN : true

             USERNAME : 0014XX-XXX000000001

             PASSWORD : <value is set>

          RoutableIPAddressRecord :

             OPERATION_ID : 3c342b:10a8f88a32c:80000042

             UPDATE_IP : false

             HAS_ROUTABLE_IP : null

          Data Synchronization Instruction :

             IS_PERSISTENT : true

             IS_AUTO_RUN : true

             DATA_SYNC_PARAMS :

                InternetGatewayDevice.DeviceInfo.SoftwareVersion : null

                Inform.DeviceId.ProductClass : null

                Inform.DeviceId.ManufacturerOUI : null

                InternetGatewayDevice.DeviceInfo.HardwareVersion : null

                InternetGatewayDevice.ManagementServer.ParameterKey : null

                Inform.DeviceId.Manufacturer : null

                InternetGatewayDevice.DeviceInfo.ModelName : null

             FIRMWARE_CHANGED_PARAMS :

                InternetGatewayDevice.DeviceInfo.ModelName

          Firmware Rules Instruction :

             IS_PERSISTENT : true

             FIRMWARE_RULES :

             version : 1.0

             CwmpFirmwareRules :

                CwmpFirmwareRule: AcmeWAG54G2Rule

                   Expressions :

                         CwmpExpression:

                            Parameter : null

                            InformParameter : Inform.EventCode

                            RpcArgument : null

                            Value : [1 BOOT, 2 PERIODIC]

                            Operator : match

                         CwmpExpression:

                            Parameter : InternetGatewayDevice.DeviceInfo.SoftwareVersion

                            InformParameter : null

                            RpcArgument : null

                            Value : [66]

                            Operator : matchAllIgnoreCase

                   InternalFile :

                      FirmwareFile : sample-firmware-image.bin

                      FileDeliveryTransport : HTTP

             FORCE_FIRMWARE_UPGRADE : false

          Configuration Synchronization Instruction :

             OPERATION_ID : 3c342b:10a8f88a32c:80000043

             IS_PERSISTENT : true

             CONFIG :

                version : 1.0

                CwmpParameter :

                   fullName : InternetGatewayDevice.ManagementServer.PeriodicInformEnable

                   value : true

                   type : boolean

                   notification : 0

                CwmpParameter :

                   fullName : 
InternetGatewayDevice.ManagementServer.PeriodicInformInterval

                   value : 86400

                   type : unsignedInt

                   notification : 0

             CONFIG_REV_NUMBER : 559207259

             FORCE_CONFIG_UPGRADE : false

   Real Time Proxy Operations:

       Instruction records:

          No instruction found.

show dpe

Use this command to check if the DPE is running and displays the state of the process and, if running, its operational statistics. This command does not indicate if the DPE is running successfully, only that the process itself is currently executing. However, when the DPE is running, you can use statistics that this command prints to determine if the DPE is successfully servicing requests.

If you run this command on an unlicensed DPE, a message similar to this one appears:

This DPE is not licensed. Your request cannot be serviced. 
Please check with your system administrator for a DPE license.

Syntax Description

Examples

dpe# show dpe

BAC Agent is running

Process dpe is not running

dpe# show dpe

BAC Agent is running

Process dpe is running

Version BAC 3.0 (SOL_CBAC3_0_L_000000000000).

Caching 1 device configs and 1 external files.

0 sessions succeed and 0 sessions failed.

0 file requests succeed and 0 file requests failed.

0 immediate proxy operations received: 0 succeed, and 0 failed.

Connection status is Ready.

Running for 4 hours 30 mins 16 secs.

show dpe config

Use this command to show the current DPE settings. After the command is entered, the DPE configuration appears.

Syntax Description

Examples

dpe# show dpe config

dpe port         = 49186

rdu host         = host.abc.com

rdu port         = 49187

primary groups   = default

secondary groups = [no value]

Table Of Contents