Device Provisioning Engine Command Line Interface

This appendix contains detailed information about the command line interface (CLI) commands that you can use to manage and monitor the Broadband Access Center for Cable (BAC) device provisioning engine (DPE). They have been grouped into these associations:

System Commands

This section describes the system commands that affect the entire DPE. These commands include:

clock set

Usage Guidelines

This command sets the current time, using the 24-hour format, and date used by the DPE. The new time takes effect immediately. The DPE uses GMT to keep time. When setting the time you must use GMT to prevent the incorrect time from being returned by the time server.

Note You do not have to use this command if the network time protocol (NTP) is being used. See the "ntp server (host)" section for additional information.

Syntax Description

When entering the clock set command, you must use this syntax:

clock set <hh:mm:ss> <day> <month> <yyyy>

Where:

<hh:mm:ss>—Identifies the current time in the 24 hour format. For example, 5 a.m. is identified as 05:00:00, and 11:37:30 p.m. is identified as 23:37:30.
<day>—Identifies the day specified as a two digit number.
<month>—Identifies the current month as a two digit number.
<yyyy>—Identifies the current year using four digits.

Examples

This is an example of how to use the clock set command:

dpe# clock set 11:26:00 21 12 2001

Fri Dec 21 11:26:00 GMT 2001

disable

Usage Guidelines

Use the disable command only when the DPE CLI is already enabled. Once the disable mode is activated, only those commands that allow viewing the system configuration are available.

Examples

This is an example of how to use the disable command:

dpe# disable

enable password

Usage Guidelines

This command is used to change the access password for entering into an enabled state on the DPE. You can only change the enable password when you are in the enabled mode. Once the password is changed, all users who, from that point forward, attempt to enter into an enabled mode, will be required to use the new password.

Note This command does not change the login password.

Syntax Description

When entering the enable password command, you can either provide the password on a command line or when prompted. The syntax you must use is:

enable password <password>

Where:

<password>—identifies the password currently in effect or, optionally, provides a new password. If this parameter is omitted, you are prompted for the password.

Examples

These are examples of how to use the enable password command:

Note In these examples, please note the different password messages that might appear.

Example 1:

dpe# enable password

New enable password:

Retype new enable password:

Password changed successfully.

Results:

These results occur when the password is changed successfully.

Example 2:

dpe# enable password

New enable password:

Retype new enable password:

Sorry, passwords do not match.

Results:

These results occur when the password is not entered consistently.

Example 3:

dpe# enable password cisco

Password changed successfully

Results:

These results occur when the password was successfully changed.

enable

Usage Guidelines

Use the enable command to enter the enabled mode. Viewing system configuration does not require the enabled mode. However, the enabled mode is required to change the system configuration, state, and data.

Examples

This is an example of how to use the enable command:

dpe# enable

Password:

dpe#

Note Refer to the "enable password" section for information on setting the password.

exit

Usage Guidelines

This command closes a Telnet or console connection to the DPE and returns to the login prompt on the console.

Examples

This is an example of how to use the exit command:

dpe# exit

Connection closed.

help

Usage Guidelines

This command displays a help screen to assist you in using the DPE CLI. If you need help on a particular command, or to list all available commands, enter either ? or system commands, respectively.

Command Types

Two types of help are provided:

1. Full help is available when you are ready to enter a command argument, such as show ?, and describes each possible argument.

2. Partial help is provided when you enter an abbreviated argument and want to know what arguments match the input. For example, show stat?.

Examples

This is an example of how to use the help command:

dpe# help

Help may be requested at any point in a command by entering a question mark '?'. If nothing matches, the help list will be empty and you must backup until entering a '?' shows the available options.

1) Full help is available when you are ready to enter a command argument (e.g. 'show ?') and describes each possible argument.

2) Partial help is provided when an abbreviated argument is entered and you want to know what arguments match the input (e.g. 'show stat?'.)

hostname

Usage Guidelines

This command is used to set the DPE host name. The hostname is used primarily for display in the DPE and should correspond to the DNS name for the DPEs IP address. If you change the host name, you must run the reload command for the changes to take effect.

Syntax Description

When entering the hostname command, you must use this syntax:

hostname <hostname>

Where:

<hostname>—identifies the host name of the DPE being addressed

Examples

This is an example of how to use the hostname command:

dpe# hostname BPR_DPE_name

%OK (Requires appliance restart "> reload")

interface ethernet 0...1 ip address

Usage Guidelines

This command sets the IP address of the Ethernet interface being used by the DPE. This IP address must be kept current with a valid gateway. If the gateway is invalid, rebooting could occur and this might cause the DPE to become unavailable on the network. If the IP address is configured incorrectly, use the DPE console port to reconfigure the device with a valid IP.

Note Changes do not take effect until you restart the device.

Syntax Description

When entering the interface ethernet <0...1> ip address command, you must use this syntax:

interface ethernet <0...1> ipaddress <x.x.x.x> <y.y.y.y>

Where:

<0...1>—identifies the Ethernet interface
<x.x.x.x>—identifies the IP address of the DPE being addressed
<y.y.y.y>—identifies the subnet mask

Examples

This is an example of how to use the interface ethernet <0...1> ip address command:

dpe# interface ethernet 0 ip address 10.10.10.5 255.255.255.0

%OK (Requires appliance restart "> reload")

interface ethernet 0...1 ip enabled

Usage Guidelines

This command controls whether or not the Ethernet interface is configured to support IP communications. If both interfaces are disabled, the device will have no network connectivity. Typically, both interfaces are enabled and connected to the network, to provide either redundancy or to use split-networking.

Syntax Description

When entering the interface ethernet <0...1> IP address command, you must use this syntax:

interface ethernet <0...1> ip enabled <true/false> 

Where:

<0...1>—identifies the Ethernet interface
<true/false>—indicates whether or not the IP interface on the DPE is enabled

Examples

This is an example of how to use the interface ethernet <0...1> ip enabled command:

dpe# interface ethernet 0 ip enabled true

%OK (Requires appliance restart "> reload")

interface ethernet 0...1 provisioning enabled

Usage Guidelines

This command controls whether or not the Ethernet interface(s) is used for provisioning operations. This command allows the use of split-networking techniques to isolate device facing communication from provisioning system side communications. Only ports that have provisioning enabled will be used for communication with the DHCP server. If both ports are enabled for provisioning, the DHCP server will send requests to both ports when processing requests from network devices.

Another technique, disabling provisioning on both interfaces, prevents the DPE from communicating with other devices. Doing this can improve performance when the DPE is undertaking a significant cache synchronization with the RDU.

Syntax Description

When entering the interface ethernet <0...1> provisioning enabled command, you must use this syntax:

interface ethernet <0...1> provisioning enabled <true/false>

Where:

<0...1>—identifies the Ethernet interface
<true/false>—indicates whether or not DPE provisioning has been enabled

Examples

This is an example of how to use the interface ethernet <0...1> provisioning enabled command:

dpe# interface ethernet 0 provisioning enabled true

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

interface ethernet 0...1 provisioning fqdn

Usage Guidelines

This command sets the fully qualified domain name for a specific interface.

Syntax Description

When entering the interface ethernet <0...1> provisioning fqdn command, you must use this syntax:

interface ethernet <0...1> provisioning-fqdn <fqdn>

Where:

<0...1>—identifies the Ethernet interface
<fqdn>—identifies the fully qualified domain name being set on the specified interface

Examples

This is an example of how to use the interface ethernet <0...1> fqdn command:

dpe# interface ethernet 0 fqdn dpe.cisco.com

%OK (Requires DPE restart "> reload")

ip default-gateway

Usage Guidelines

This command configures a default gateway for the DPE. This default gateway must be directly accessible by one of the DPE interfaces otherwise the DPE becomes unavailable.

You must verify this setting before attempting to reboot the DPE. If an incorrect value is configured, it may become necessary to physically connect to the DPE through the console port; long distances may make this impractical.

Syntax Description

When entering the ip default-gateway command, you must use this syntax:

ip default gateway <x.x.x.x>

Where:

(x.x.x.x)— is the IP address of the default gateway

Examples

This is an example of how to use the ip default-gateway command:

dpe# ip default-gateway 10.10.20.10

%OK (Requires appliance restart "> reload")

ip domain-name

Usage Guidelines

This command configures the DPE domain name for use when resolving names for communication operations, such as connecting to the RDU, or using the ping and traceroute commands. The domain name is also associated with the DPE.

Note The changes you introduce through this command take effect immediately.

Syntax Description

When entering the ip domain-name command, you must use this syntax:

ip domain-name <sub.domain.com>

Where:

<sub.domain.com>—identifies the fully qualified domain name (FQDN) of the DPE

Examples

This is an example of how to use the ip domain-name command:

dpe# ip domain-name cisco.com

%OK

ip name-server

Usage Guidelines

This command configures the IP address of the name servers for use on the DPE. These servers are used to resolve host names into IP addresses for communication. If an FQDN is used to specify the RDU, you must specify a valid name server for successful communication with the RDU.

Note The changes you introduce through this command take effect immediately.

Syntax Description

When entering the ip name-server command, you must use this syntax:

ip name-server <x.x.x.x>*

Where:

<x.x.x.x>—identifies the IP address of the name-server
*—allows the entry of multiple IP addresses if multiple name servers are used

Examples

This is an example of how to use the ip name-server command:

dpe# ip name-server 10.10.10.5 10.10.10.8

%OK

ip route

Usage Guidelines

This command configures a custom route on the DPE. Three parameters are required, as shown in the following syntax description.

Syntax Description

When entering the ip route command, you must use this syntax:

ip route <x.x.x.x> <y.y.y.y> <z.z.z.z>

Where:

<x.x.x.x>—identifies the destination network
<y.y.y.y>—identifies the subnet mask
<z.z.z.z>—identifies the gateway to use when communicating to this network

Examples

This is an example of how to use the ip route command:

dpe# ip route 10.10.10.5 255.255.255.0 10.10.20.10

%OK

no ip default-gateway

Usage Guidelines

This command clears the DPE's default gateway. If a default gateway is not specified, the DPE is only available with direct network connectivity or through the console port on the DPE.

Examples

This is an example of how to use the ip default-gateway command:

dpe# no ip default-gateway 

%OK (Requires appliance restart "> reload")

no ip domain-name

Usage Guidelines

This command clears the DPEs domain name. If a domain name is not specified, all remote host names must be specified using the fully qualified domain names.

Examples

This is an example of how to use the no ip domain-name command:

dpe# no ip domain-name

%OK

no ip name-server

Usage Guidelines

This command clears the DPE name servers. When no name servers are configured, all communication must be performed using explicit IP addresses.

Examples

This is an example of how to use the no ip name-server command:

dpe# no ip name-server

%OK

no ip route

Usage Guidelines

This command clears the specified custom route, but the default route cannot be removed this way. Use the ip default-gateway command to change the default route.

Note The changes you introduce through this command take effect immediately.

Syntax Description

When entering the no ip route command, you must use this syntax:

The no ip route command must be entered using this syntax:

no ip route <x.x.x.x>

Where:

<x.x.x.x>—identifies the route to be removed from the system

Examples

This is an example of how to use the no ip route command:

dpe# no ip route 10.10.10.5

%OK

no ntp server

Usage Guidelines

This command disables the network time protocol (NTP).

Examples

This is an example of how to use the no ntp command:

dpe# no ntp server

no tftp verify-ip

Usage Guidelines

This command disables the verification of requestor IP addresses on dynamic configuration TFTP requests.

Examples

This is an example of how to use the no tftp verify-ip command:

dpe# no tftp verify-ip 

%OK

ntp server (host)

Usage Guidelines

This command lets you specify one or more network time protocol (NTP) servers, for time synchronization, as hosts. You can specify as many hosts as required to identify all of the servers.

Examples

This is an example of how to use the ntp command with a single host:

dpe# ntp server clock.cisco.com

This is an example of how to use the ntp command with multiple hosts:

dpe# ntp server clock_1.cisco.com clock_2.cisco.com

ntp server (IP)

Usage Guidelines

This command lets you specify one or more network time protocol (NTP) servers, for time synchronization, using an IP address format. You can specify as many IP addresses as required to identify all of the servers.

Examples

This is an example of how to use the ntp command with a single IP address:

dpe# ntp server 10.10.10.5

This is an example of how to use the ntp command with multiple IP addresses:

dpe# ntp server 10.10.10.5 10.10.10.6

password

Usage Guidelines

This command changes the current system password. The password is changed automatically for future logins and for FTP access using the administrator account.

Note The changes you introduce through this command take effect for new users, but users who are currently logged on are not disconnected.

Syntax Description

When entering the password command, you must use this syntax:

password <password>

Where:

<password>—identifies the new DPE password

Examples

This are examples of how to use the password command:

Example 1

dpe# password

New password: 

Retype new password: 

Password changed successfully.

Results:

These results occur when the password is changed successfully.

Example 2

dpe# password

New password: 

Retype new password: 

Sorry, passwords do not match.

Results:

These results occur when the password is not entered consistently.

Example 3

dpe# password cisco

Password changed successfully.

Results:

These results occur when the password is changed (using an approach easier for scripting).

poweroff

Usage Guidelines

This command turns the DPE power off. It removes all current users from the system and shuts the DPE down cleanly. Prior to executing this command, you should verify that there has been no hard drive activity for approximately 30 seconds.

Caution Using the power switch on the device can potentially cause partial corruption of the DPE cache. This could result in the DPE needing more time to rebuild its cache the next time it is powered up.

Examples

This is an example, as shown from a Telnet session, of how to use the poweroff command:

dpe# poweroff

reload

Usage Guidelines

This command reboots the DPE, disconnecting all current users from the system.

Examples

This is an example of how to use the reload command:

dpe# reload

show clock

Usage Guidelines

This command shows the current system time and date.

Examples

This is an example of how to use the show clock command:

dpe# show clock

Fri Dec 21 11:39:31 GMT 2001

show commands

Usage Guidelines

Depending on the connection type in use (Telnet or console), this command displays all available DPE commands. For security reasons, this command is not available when a Telnet session is used and can only be set from the console mode.

Examples

This is an example of how to use the show commands command:

dpe# show commands 

> clear bundles

> clear cache

> clear logs

> clock set <hh:mm:ss> <1-31> <1-12> <yyyy>

> debug dpe cache

> debug dpe connection

Note The output presented in this example is trimmed.

show cpu

Usage Guidelines

This command identifies CPU usage for BAC activities that are currently running.

Examples

This is an example of how to use the show cpu command:

dpe# show cpu

avg-cpu:			%user		%nice		 %sys		%idle

  0.00 			 0.00		 0.00		100.00

show disk

Usage Guidelines

This command identifies how much of the current disk the DPE is using.

Examples

This is an example of how to use the show disk command:

dpe# show disk

Filesystem Size Used Avail Use% Mounted on

/dev/sda1 /dev/sda5 1.9G 14M 198M 57M 1.6G 13M 11% 1% / /opt

show hostname

Usage Guidelines

This command shows the DPEs host name.

Examples

This is an example of how to use the show hostname command:

dpe# show hostname

hostname = BPR_host

show interface ethernet <0...1> config

Usage Guidelines

This command shows the configuration for the Ethernet interface. These are the settings that the DPE uses when it reboots. Use the show interface ethernet <0...1> stats command to identify the currently configured IP address.

Syntax Description

When entering the show interface ethernet <0...1> config command, you must use this syntax:

show interface ethernet <0...1> config

Where:

<0...1>—identifies the Ethernet interface number

Examples

This is an example of how to use the show interface ethernet <0...1> config command:

dpe# show interface ethernet 0 config

ip address = 10.10.10.5

netmask = 255.255.255.0

enabled = true

for prov = true

show interface ethernet <0...1> stats

Usage Guidelines

This command shows statistics for the DPE's Ethernet interface.

Syntax Description

When entering the show interface ethernet <0...1> stats command, you must use this syntax:

show interface ethernet <0..1> stats

Where:

<0...1>—identifies the Ethernet interface number

Examples

This is an example of how to use the show interface ethernet <0...1> stats command:

dpe# show interface ethernet 0 stats
	eth0	Link encap:Ethernet HWaddr 00:B0:D0:F7:07:C2 inet addr:10.10.10.5 Bcast:10.10.10.2 Mask:255.255.255.0 UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1 RX packets:3539 errors:0 dropped:0 overruns:0 frame:0 TX packets:3233 errors:0 dropped:0 overruns:0 carrier:0 collisions:0 txqueuelen:100

show ip route

Usage Guidelines

This command shows the DPEs IP routing table, including any custom routes. the default gateway is indicated by The G flag in the flags column indicates the default gateway start.

Examples

This is an example of how to use the show ip route command:

dpe# show ip route
Destination	Gateway	Genmask	Flags	Metric	Ref	Use	Iface
10.10.10.5	10.10.20.10	255.255.255.0	U	O	O	O	eth0
10.10.10.6	10.10.20.25	255.255.255.125	U	O	O	O	lo
10.10.10.9	10.10.20.50	255.255.255.255	UG	0	0	0	eth0

show ip

Usage Guidelines

This command shows the DPEs current general IP settings. For specific interface settings, use the show interface commands. These are the settings used when the DPE is rebooted.

Examples

This is an example of how to use the show ip command:

dpe# show ip

hostname = BPR_host

domainname = cisco.com

gateway = 10.10.20.10

show memory

Usage Guidelines

This command identifies how much current memory and swap space the DPE is using.

Examples

This is an example of how to use the show memory command:

dpe# show memory

Mem: Swap: 255112K av, 265032K av, 148928K used 0K used 106184K free 265032 free OK shrd 5428K buff 72468K cached

show running-config

Usage Guidelines

This command displays the current configuration of the DPE.

All of the configuration options are displayed using the actual commands to set the options. If you copy this output, you can paste it back into the configurations for other DPEs modifications. In this way, you can quickly create the configurations for multiple devices needing identical configurations.

Note The values that are displayed by this command are dependent on whether a Telnet session or console connection is used.

Examples

This is an example of how to use the show running-config command:

dpe# show running-config 

dpe port 49186

dpe rdu-server server_x.cisco.com 49187

hostname dpe

interface ethernet 0 ip address 10.10.10.5 255.255.255.0

interface ethernet 0 ip enabled true

interface ethernet 0 provisioning enabled true

ip default-gateway 10.10.20.10

Note The output presented in this example is trimmed.

show tftp files

Usage Guidelines

This command identifies the files that are currently stored in the DPE cache. The file size is also shown.

Examples

This is an example of how to use the show tftp files command:

dpe# show tftp files

The list of TFTP files currently in DPE cache

filename										size

bronze.cm										310

gold.cm										310

silver.cm										310

show version

Usage Guidelines

This command is used to identify the current version of DPE software running on the device.

Examples

This is an example of how to use the show version command:

dpe# show version

Version: BPR 2.5 (cbpr_25_L_200303240515)

tftp verify-ip

Usage Guidelines

This command enables the verification of requestor IP addresses on dynamic configuration TFTP requests.

Examples

This is an example of how to use the tftp verify-ip command:

dpe# tftp verify-ip

%OK

uptime

Usage Guidelines

This command identifies how long the system has been operational. This information is useful when determining how frequently the device is rebooted. It is also helpful when checking the reliability of the DPE when it is in a stable condition.

Examples

This is an example of how to use the uptime command:

dpe# uptime

 11:54am up 2:07, 1 users, load average: 0.27, 0.08, 0.02

Support and Troubleshooting Commands

This section describes those CLI commands that assist in supporting and troubleshooting the operation of the DPE. These CLI commands include:

clear bundles

Usage Guidelines

This command clears any existing archived bundles on the DPE. These bundles are created using the support bundles commands and normally contain archived logs and archived state information of use to the Cisco TAC. You must ensure that all bundles are retrieved before using this command because the archived state is lost.

Examples

This is an example of how to use the clear bundles command:

dpe# clear bundles

Clearing Cisco support bundles...

+ 90112 bytes cleared.

host (host)

Usage Guidelines

The host (host) command looks up the IP address of a host using DNS. You can use this command to verify that the RDU's IP address can be successfully resolved. If a system domain name is specified, the host command will automatically attempt searching that domain as well when resolving host names.

Syntax Description

When entering the host (host) command, you must use this syntax:

host <host>

Where:

<host>—identifies the host to resolve through DNS

Examples

This is an example of how to use the host (host) command:

dpe# host dpe.cisco.com

dpe.cisco.com has address 10.10.10.5

host (IP)

Usage Guidelines

The host (IP) command looks up the host name for the specified IP address, and is used to verify that an IP address is correctly reverse-mapped in DNS. The IP address is reverse looked up on each of the configured name servers until the IP address is found.

Syntax Description

When entering the host (IP) command, you must use this syntax:

host <x.x.x.x>

Where:

<x.x.x.x>—identifies the IP address being pinged

Examples

This is an example of how to use the host (IP) command:

dpe# host 10.10.10.5

10.20.20.5 IN-ADDR.ARPA domain name pointer dpe.cisco.com

ping (host)

Usage Guidelines

The ping (host) command pings the specified host, using the host and domain name. Press Enter to stop the process. The ping command is useful in diagnosing network connectivity problems.

Syntax Description

When entering the ping (host) command, you must use this syntax:

ping <host>

Where:

<host>—identifies the host being pinged

Examples

This is an example of how to use the ping (host) command:

dpe# ping dpe.cisco.com

% Press <enter> to stop.

PING dpe.cisco.com (10.10.10.5) from 10.10.20.20 : 56(84) bytes of data.

64 bytes from 10.10.20.5: 64 bytes from 10.10.20.5: 64 bytes from 10.10.20.5: icmp_seq=0 ttl=241 time=105.113 msec icmp_seq=1 ttl=241 time=99.947 msec icmp_seq=2 ttl=241 time=99.951 msec

Stopped.

ping (IP)

Usage Guidelines

The ping (IP) command pings the specified host, using the hosts IP address. Press the Enter key to stop the process. Ping is useful in diagnosing network connectivity problems.

Syntax Description

When entering the ping (IP) command, you must use this syntax:

ping <x.x.x.x>

Where:

<x.x.x.x> identifies the IP addesss of the host.

Examples

This is an example of how to use the ping (IP) command:

dpe# ping 10.10.20.5

% Press <enter> to stop.

PING dpe.cisco.com (10.10.10.5) from 10.10.20.20 : 56(84) bytes of data.

64 bytes from 10.10.20.5: 64 bytes from 10.10.20.5: 64 bytes from 10.10.20.5: icmp_seq=0 ttl=241 time=105.113 msec icmp_seq=1 ttl=241 time=99.947 msec icmp_seq=2 ttl=241 time=99.951 msec

64 bytes from 10.10.20.20: 64 bytes from 10.10.20.20: 64 bytes from 10.10.20.20: icmp_seq=0 ttl=241 time=101.005 msec icmp_seq=1 ttl=241 time=149.904 msec icmp_seq=2 ttl=241 time=119.886 msec

Stopped.

show bundles

Usage Guidelines

This command shows all bundles currently available in the outgoing directory. These bundles are created using the support bundle commands and are accessible from the DPEs FTP server.

Examples

This is an example of how to use the show bundles command:

Example 1

dpe# show bundles

/outgoing/state-20010817-113741.bpr

/outgoing/cache-20010817-113745.bpr

Results:

These results occur when there are bundles currently archived.

Example 2

dpe# show bundles

No bundles currently available.

Results:

These results occur when no bundles are currently archived.

support bundle cache

Usage Guidelines

This command bundles the current DPE cache. This is useful when archiving the cache for delivery to Cisco TAC. Once created, the bundle is available from the FTP server's outgoing directory.

Examples

This is an example of how to use the support bundle cache command:

dpe# support bundle cache

Creating cache bundle for Cisco support...

+ /outgoing/cache-20010817-113745.bpr

+ Adding DPE cache...

+ Adding supporting files...

+ Compressing cache bundle...

+ Size: 4045 bytes, 409600 uncompressed

support bundle state

Usage Guidelines

This command bundles the current DPE state. This is useful when archiving configuration and log files for the DPE for delivery to Cisco TAC. Once created, the bundle is available from the FTP server's outgoing directory.

Note When sending information to the Cisco TAC, you should send the DPE bundle obtained with this command, and the state bundle obtained at the RDU. That state bundle is generated by running the bundleState.sh command from the <BPR_HOME>/rdu/bin directory.

Examples

This is an example of how to use the support bundle state command:

dpe# support bundle state

Creating state bundle for Cisco support...

+ /outgoing/state-<date>-<time>.bpr

+ Adding a process listing to the support bundle...

+ Adding a network connection listing to the support bundle...

+ Adding and compressing files for support bundle...

+ Size: 1205782 bytes

Note A script <BPR_HOME>/rdu/bin/bundlestate is available on the RDU. This script, is used to bundle the RDU system state, including logs, when sending information to the TAC.

support daemon ftp enabled

Usage Guidelines

This command is used to enable or disable FTP service on the DPE-590. The FTP service is needed to upload upgrade bundles and to download support bundles. You can disable and enable it for short periods of time to perform these tasks.

Syntax Description

When entering the support daemon ftp enabled command, you must use this syntax:

support daemon ftp enabled <true/false>

Where:

<true>—enables FTP service on the DPE-590
<false>—disables FTP service on the DPE-590

Examples

This is an example of how to use the support daemon ftp enabled command:

dpe# support daemon ftp enable true

%OK (Requires appliance restart "> reload")

support daemon telnet enabled

This command is used to enable or disable the Telnet protocol on the DPE-590. Since Telnet is a relatively insecure protocol, the system can be made slightly more secure by disabling Telnet; you can still access the system from the console mode.

Syntax Description

When entering the support daemon telnet enabled command, you must use this syntax:

support daemon telnet enabled <true/false>

Where:

<true>—enables the Telnet interface on the DPE-590
<false>—disables the Telnet interface on the DPE-590

Examples

This is an example of how to use the support daemon telnet enabled command:

dpe# support daemon telnet enable true

%OK (Requires appliance restart "> reload")

traceroute (host)

Usage Guidelines

This command identifies the route to a specified host including each hop between the DPE and the destination host. This command is useful when verifying communication and determining if gateways and routes are correctly configured.

Syntax Description

When entering the traceroute (host) command, you must use this syntax:

traceroute <host>

Where:

<host>—identifies the host

Examples

This is an example of how to use the traceroute (host) command:

dpe# traceroute BPR_host.cisco.com

Press <enter> to stop.

traceroute to BPR_host.cisco.com (10.10.10.5), 30 hops max, 38 byte packets

1 10.10.10.5 0.454 ms 0.239 ms 0.230 ms

Stopped.

traceroute (IP)

Usage Guidelines

Syntax Description

When entering the traceroute (IP) command, you must use this syntax:

traceroute <x.x.x.x>

Where:

<x.x.x.x>—identifies the IP address of the host

Examples

This is an example of how to use the traceroute (IP) command:

dpe# traceroute 10.10.10.5

Press <enter> to stop.

traceroute to 10.10.10.5 (10.10.10.5), 30 hops max, 38 byte packets

1 10.10.10.5 0.454 ms 0.239 ms 0.230 ms

Stopped.

DPE Configuration Commands

This section describes the configuration commands that affect DPE. These commands include:

clear cache

Usage Guidelines

This command erases the entire DPE cache and resets the server back to a clean state. When the DPE is restarted, it will connect to the RDU and rebuild the cache from the information stored in the RDU's database. 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.

Examples

This is an example of how to use the clear cache command:

Example 1

dpe# clear cache

Clearing DPE cache...

+ 417792 bytes cleared.

Results:

These results occur when the cache is successfully cleared.

Example 2

dpe# clear cache

DPE must be stopped before clearing cache.

Results:

These results occur when the cache has not yet been stopped.

Example 3

dpe# clear cache

Clearing DPE cache...

+ Cache already cleared.

Results:

These results occur when cache has already been cleared.

dpe port

Usage Guidelines

This command sets the port number that the DPE will use to communicate with the Network Registrar extension points. Normally, you can leave this port number intact unless there is a need to change it for firewall reasons.

Note The changes you introduce through this command do not take effect until you restart the DPE.

Syntax Description

When entering the dpe port command, you must use this syntax:

dpe# dpe port <port>

Where:

(port)—identifies the port number assigned for connecting to the DPE

Examples

This is an example of how to use the dpe port command:

dpe# dpe port 49186

%OK

dpe provisioning-group primary

Usage Guidelines

This command sets the primary provisioning group(s) that the DPE server will use. Most DPEs are configured with one primary provisioning group, however, selecting multiple provisioning groups might allow multiple DHCP servers to use this DPE.

Note Whenever voice technology is enabled, a DPE can only belong to one provisioning group.

When assigning new provisioning groups that have a high number of devices, restarting the DPE can take an extensive amount of time. This is due to the fact that the cache for each provisioning group has to be synchronized or, for new provisioning groups, completely rebuilt.

Under normal situations, provisioning groups should only be changed when the DPE is first deployed on the network.

Note Provisioning group changes do not take effect until you restart the DPE.

Syntax Description

When entering the dpe provisioning-group primary command, you must use this syntax:

dpe provisioning-group primary <name>*

Where:

(name)—identifies the assigned primary provisioning group
*—allows the entry of multiple provisioning groups

Examples

This is an example of how to use the dpe provisioning-group primary command:

dpe# dpe provisioning-group primary PrimaryProvGroup

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

dpe provisioning-group secondary

Usage Guidelines

This command sets the secondary provisioning group(s) for the DPE server to use. Most DPEs are configured with one primary provisioning group, however, selecting multiple provisioning groups might allow multiple DHCP servers to use this DPE. Secondary provisioning groups are used for provisioning only when the primary provisioning groups are not available or are overloaded.

Under normal situations, provisioning groups should only be changed when the device is first deployed on the network.

Note Provisioning group changes do not take effect until you restart the DPE.

Syntax Description

When entering the dpe provisioning-group secondary command, you must use this syntax:

dpe provisioning-group secondary <name>*

Where:

(name)—identifies the assigned secondary provisioning group
*—allows the entry of multiple provisioning groups

Examples

This is an example of how to use the dpe provisioning-group secondary command:

dpe# dpe provisioning-group secondary SecondaryProvGroup

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

dpe rdu-server (host)

Usage Guidelines

This command identifies the RDU to connect this DPE to. Normally, you configure the RDU on the default port but, for security reasons, you could configure it to run on a nonstandard port.

Note Changes do not take effect until you restart the DPE.

Syntax Description

When entering the dpe rdu-server command, you must use this syntax:

dpe rdu-server <host> <port>

Where:

<host>—identifies the host on which the RDU is running
<port>—identifies the port number on which RDU is listening for DPE connections (normally 49187)

Examples

This is an example of how to use the dpe rdu-server command:

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

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

dpe rdu-server (IP)

Usage Guidelines

This command assigns the RDU to connect this DPE to. Specify this as the IP address with the associated port. Normally, the RDU resides on the default port, but for security reasons the port might be configured to something non-standard.

Note Changes do not take effect until you restart the DPE.

Syntax Description

When entering the dpe rdu-server command, you must use this syntax:

dpe rdu-server <x.x.x.x> <port>

Where:

<x.x.x.x>—identifies the IP address of the RDU
<port>—identifies the port on which RDU is listening for DPE connections (normally 49187)

Examples

This is an example of how to use the dpe rdu-server command:

dpe# dpe rdu-server 10.10.20.1 49187

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

dpe reload

Usage Guidelines

This command restarts the DPE, which must already be operating before performing the reload operation. If the DPE has not stopped within 60 seconds, the BAC agent forces the DPE to stop and an alert message, indicating this has occurred, is displayed. After that message appears, the DPE restarts.

Examples

This is an example of how to use the dpe reload command:

dpe# dpe reload

dpe has been restarted

dpe shared-secret

Usage Guidelines

This command sets the shared secret used for communications with the RDU. Communications will fail if the shared secret, set on the two servers, is not the same. For security reasons, this command is only available through a console connection. It can not be accessed through a Telnet connection.

Note Changes do not take effect until you restart the DPE.

Syntax Description

When entering the dpe shared-secret command, you must use this syntax:

dpe shared-secret <secret>

Where:

<secret>—Identifies the RDU shared secret. This may appear as encrypted text when the command is run through the console mode or, if being run through a Telnet session, may simply indicate that the shared secret has been set.

Examples

This is an example of how to use the dpe shared-secret command:

dpe# dpe shared-secret private

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

dpe start

Usage Guidelines

This command starts the DPE, and you can only use it 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. In addition, check the log again periodically to make sure no additional errors have occurred.

Examples

This is an example of how to use the dpe start command:

dpe# dpe start

dpe has been started

dpe stop

Usage Guidelines

This command stops the DPR and can only be performed 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 this has occurred, is displayed.

Examples

This is an example of how to use the dpe stop command:

dpe# dpe stop

dpe has been started

ip domain-name <sub.domain.com>

This command lets you identify the local domain name for use, when performing DNS lookups, as the default domain for this DPE.

Examples

This is an example of how to use the ip domain-name <sub.domain.com> command:

dpe# ip domain-name cisco.com

%OK

no dpe provisioning-group primary

Usage Guidelines

This command clears configured primary provisioning groups. If primary provisioning groups are not available, you can use the DPE as either a backup for other provisioning groups or as a TFTP file cache.

Note Changes do not take effect until you restart the DPE.

Examples

This is an example of how to use the no dpe provisioning-group primary command:

dpe# no dpe provisioning-group primary

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

no dpe provisioning-group secondary

Usage Guidelines

This command clears configured secondary provisioning groups. If secondary provisioning groups are not available, the DPE can be used as a primary in other provisioning groups.

Note Changes introduced through this command do not take effect until you restart the DPE.

Examples

This is an example of how to use the no dpe provisioning-group secondary command:

dpe# no dpe provisioning-group secondary

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

show device-config

Usage Guidelines

This command shows the configuration of the device configuration

Syntax Description

When entering the show device-config command, you must use this syntax:

show device-config <mac>

Where:

<mac>—specifies a device's MAC address

Examples

This is an example of how to use the show device-config command. For the purpose of this example assume that the DPE MAC address is 1,6,00:00:00:00:00:03.

dpe# dpe show device-config 00:00:00:00:00:03

Retrieved the following configuration from DPE.

DHCP Configuration for device 1,6,00:00:00:00:00:03 in default provisioning-group

. . . . . . . . . . . . . . .

Note The output of this command has been trimmed for demonstration purposes.

show dpe

Usage Guidelines

This command checks to see if the DPE is running and displays the state of the process and, if running, its operational statistics. It does not indicate if the DPE is running successfully, only that the process itself is currently executing. However, DPE statistics that this command prints when the DPE is running, can be used to determine if the DPE is successfully servicing requests.

Examples

These examples show how to use the show dpe command:

Example 1

dpe# show dpe

CSRC BPR Device Provisioning Engine is not running

Results:

These results occur when the DPE is not running.

Example 2

dpe# show dpe

BPR Agent for BPR Provisioning Engine is running

dpe is running

Version BPR 2.5 (cbpr_25_L_200303251235).

Caching 0 device configs and 0 external files.

Received 0 cache hits and 0 misses.

Received 0 lease updates.

Connection status is Disconnected.

Sent 0 SNMP informs and 0 SNMP sets.

Received 0 MTA provisioning successful SNMP informs.

Received 0 MTA provisioning failed SNMP informs.

Running for 6 days 41 mins 35 secs.

Results:

These results occur when the DPE is running.

show dpe config

Usage Guidelines

This command shows the current DPE settings used when it is restarted. It is used to verify that all executed commands have been executed successfully.

Note The shared secret is protected data that is not displayed when the command is run in a Telnet session. When the command is run through a console connection, the configuration information is displayed.

Examples

This is an example of how to use the show dpe config command:

dpe# show dpe config

dpe port = 49186

rdu host = host.cisco.com

rdu port = 49187

primary groups = Default

secondary groups = [no value]

upgrade

Usage Guidelines

This command is used whenever the DPE requires a new software upgrade, using uploaded upgrade files. These files, which end in the file extension .bpr, should be FTP'd into the incoming directory. The upgrade process scans all available updates and determines which ones are required. It separates the files into these categories:

invalid—These are the files that do not match the format required by the DPE.
not applicable—The DPE does not accept these patches because either the update is from an earlier version, or because the difference between versions (the current and updated versions) is too great.
applicable—The DPE can upgrade using these files.

Examples

This is an example of how to use the upgrade command:

dpe# upgrade

Starting BPR upgrade process

+ Scanning for available updates...

+ Determining applicable updates...

+ Compiling list of updates...

Invalid update files:

- update-FOOBAR.bpr

Updates not applicable:

- update-invalid.bpr ... BPR version 3.0 Beta-1

Applicable updates:

1 update-valid.bpr ..... BPR version 2.0 FC-2

Select update [exit]: 1

Updating with BPR version 2.0 FC-2

+ Starting update executor...

[SNIP]

+ Update succesful!

Log System Management Commands

This section describes the system commands that affect how you can manage DPE logs. These commands include:

Note Prior to using any debug command, you must ensure that DPE debugging is enabled. Run the debug on command to enable this function.

clear logs

Usage Guidelines

This command remove historic (out of date) log files that exist on the system. These files include:

DPE log files
hardware log files
syslog files

Over time, historic log files accumulate within the DPE. The support bundle state command is used to bundle these logs. Cisco recommends that you create a bundle before clearing logs. This ensures that no necessary files are accidently lost.

Examples

This is an example of how to use the clear logs command:

dpe# clear logs

Clearing historic log files...

+ Removing 1 DPE log files...

+ No more historic logs.

debug dpe cache

Usage Guidelines

This command enables the DPE cache debug logging, which involves messages pertaining to the DPE cache including:

logging requests for cache entries
updates to the cache
other interactions by DPE subsystems

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# debug dpe cache

%OK

debug dpe connection

Usage Guidelines

This command enables the debugging of the DPE connection, which logs communication subsystem status and error messages. This is useful for finding communication problems between the DPE and the RDU.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# debug dpe connection

%OK

debug dpe dpe-server

Usage Guidelines

This command enables debugging of the DPE server, which involves logging messages about the overall status and issues of the DPE server.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# debug dpe dpe-server

%OK

debug dpe event-manager

Usage Guidelines

This command enables debugging of the DPE event manager, which involves logging messages and conditions showing the state of the event manager.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# debug dpe event-manager

%OK

debug dpe exceptions

Usage Guidelines

This command enables or disables the debugging of DPE exceptions, which involves logging full stack traces for exceptions occurring during system operation. When unusual situations occur, where the system is apparently corrupt or behaving very badly, running this command can reveal very valuable information for Cisco TAC support.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# debug dpe exceptions

%OK

debug dpe framework

Usage Guidelines

This command enables the debugging of the DPE framework, which involves logging information about the DPE server's underlying framework. This underlying infrastructure provides for all of the various servers in BAC.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# debug dpe framework

%OK

debug dpe messaging

Usage Guidelines

This command enables the debugging of DPE messaging, which involves logging details about the DPEs messaging subsystem. This subsystem is used primarily for communication between the DPE and the RDU.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# debug dpe messaging

%OK

debug dpe tftp

Usage Guidelines

This command enables the debugging of TFTP transfers.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# debug dpe tftp

%OK

debug on

Usage Guidelines

This command enables the debug logging which can be helpful when troubleshooting possible system problems. Additionally, specific debugging categories must be enabled separately with commands like debug dpe cache.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# debug on

%OK

Caution Enabling debug logging may have a server impact on DPE performance. The DPE should never be left running, with debug turned on, for long periods of time.

log level

Usage Guidelines

This command lets you set the logging level that will be saved. There are seven different logging levels that can be set. These include:

log level 0-emergency—Sets the logging service to save all urgent messages.
log level 1-alert—Sets the logging service to save all activities that need immediate action and those of a more severe nature.
log level 2-critical—Sets the logging service to save all unusual conditions and those of a more severe nature.
log level 3-error—Sets the logging service to save all error messages and those of a more severe nature.
log level 4-warning—Sets the logging service to save all emergency messages and those of a more severe nature.
log level 5-notification—Sets the logging service to save all notification messages and those of a more severe nature.
log level 6-info—Sets the logging service to save all logging messages available.

The level that you select identifies the minimum log level that will be saved, as described in the Configuring Log Levels section, on page A-2.

Note Cisco recommends that you keep the RDU logging level at the Warning level to help maintain a steady operations state. The Information level is recommended if you need to maintain steady state performance during debug operations. You should however, exercise caution when running with the Information level set because this creates a great number of log entries which in itself can adversely impact performance.

no debug

Usage Guidelines

This command disables all debug logging.

Examples

This command requires no special syntax, and you enter it as shown here:

dpe# no debug on

%OK

no debug dpe cache

Usage Guidelines

This command disables DPE cache debug logging.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# no debug dpe cache

%OK

no debug dpe connection

Usage Guidelines

This command disables the debugging of the DPE connection.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# no debug dpe connection

%OK

no debug dpe dpe-server

Usage Guidelines

This command disables debugging of the DPE server.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# no debug dpe dpe-server

%OK

no debug dpe event-manager

Usage Guidelines

This command disables debugging of the DPE event manager.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# no debug dpe event-manager

%OK

no debug dpe exceptions

Usage Guidelines

This command disables the debugging of DPE exceptions.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# no debug dpe exceptions

%OK

no debug dpe framework

Usage Guidelines

This command disables the debugging of the DPE framework.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# no debug dpe framework

& OK

no debug dpe messaging

Usage Guidelines

This command disables the debugging of DPE messaging.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# no debug dpe messaging

%OK

no debug dpe tftp

Usage Guidelines

This command disables the debugging of TFTP messages.

Examples

This command requires no special syntax, and you enter it as shown in this example:

dpe# no debug dpe tftp

%OK

no syslog log-server

Usage Guidelines

This command clears the settings assigned to the syslog server. When the syslog mode is set to either both or remote, clearing the syslog log server results in the log mode being automatically set back to local until a new log server is configured.

Examples

This is an example of how to use the no syslog log-server command:

dpe# no syslog log-server

%OK (Requires appliance restart "> reload")

show log

Usage Guidelines

This command shows all recent log entries for the DPE. These logs contain general DPE process information, including logging all system errors or severe problems. Check this log, when the system is experiencing difficulties. If the log contains insufficient information, enable the debug logging function and experiment with the different categories related to the problem.

Syntax Description

When entering the show log command, you must use this syntax:

show log 

Examples

This is an example of how to use the show log command:

dpe# show log

2001 12 21 11:22:20 CDT: %BPR-5: Notification DPE: Device Provisioning Engine starting up

show log last <1..999>

Usage Guidelines

This command shows the specified number of recent log entries for the DPE. Check this log, when the system is experiencing difficulties and, if the log contains insufficient information, enable the debug logging function and experiment with the different categories related to the problem.

Syntax Description

When entering the show log last command, you must use this syntax:

show syslog last <1..999>

Where:

<1..999>—identifies the number of log entries that you want displayed

Examples

This is an example of how to use the show log last command:

dpe# show log last 1

2001 12 21 11:28:17 CDT: %BPR-5: Notification DPE: Device Provisioning Engine starting up

show log run

Usage Guidelines

This command displays the running DPE log, which starts showing all messages logged to the DPE log. The command continues to run until you press Enter. Check this log when the system is experiencing difficulties. If the log contains insufficient information, enable the debug logging function and experiment with the different categories related to the problem.

Examples

This is an example of how to use the show log run command:

dpe# show log run

Press <enter> to stop.

2001 12 21 11:43:43 CDT: %BPR-5: Notification DPE: Device Provisioning Engine starting up

2001 12 21 11:43:44 CDT: %BPR-6: Info DPE: Attempt to connect to RDU BPR_host.cisco.com:49187 failed;

2001 12 21 11:43:44 CDT: %BPR-6: Info TFTP: Ready to service requests

Stopped.

show syslog

Usage Guidelines

This command shows all recent DPE syslog entries. The syslog file contains information about the general DPE system, including alerts from various processes related to the DPE. Check this log when the system is experiencing difficulties.

Examples

This is an example of how to use the show syslog command:

dpe# show syslog

Jan  2 12:27:37 test-dpe-2 BPR: %DPE-1-109: Failed to connect to RDU

...

Note The output presented in this example is trimmed.

show syslog last

Usage Guidelines

This command shows the specified number of recent DPE syslog entries, including information about the general DPE system including alerts from various processes related to the DPE. Check this log when the system is experiencing difficulties.

Syntax Description

When entering this command, you must use this syntax:

show syslog last <1.999>

Where:

<1..999>—identifies the number of syslog entries that you want displayed

Examples

This is an example of how to use the show syslog last command:

dpe# show syslog last 1

Jan  2 12:27:37 test-dpe-2 BPR: %DPE-1-109: Failed to connect to RDU

show syslog run

Usage Guidelines

This command shows the running syslog, which starts showing all messages logged to the syslog. The command continues to run until you press Enter. The syslog contains information about the general DPE system including alerts from various processes related to the DPE. Check this log when the system is experiencing difficulties.

Examples

This is an example of how to use the show syslog run command:

dpe# show syslog run

Press <enter> to stop.

Jan  2 12:27:37 test-dpe-2 BPR: %DPE-1-109: Failed to connect to RDU

Stopped.

syslog log-server

Usage Guidelines

This command configures the log-server to send syslog messages whenever the syslog mode is set to either both or remote. When the mode is set to local changing this setting has no effect.

Syntax Description

When entering the syslog log-server command, and you must use this syntax:

syslog log-server <x.x.x.x>

Where:

<x.x.x.x>—identifies the log servers IP address

Examples

This is an example of how to use the syslog log-server command:

dpe# syslog log-server 10.10.10.15

%OK (Requires appliance restart "> reload")

syslog mode both

Usage Guidelines

Configures the syslog subsystem to send messages to a remote server and also logs them locally. The remote system must be configured with the syslog log-server command.

Examples

This is an example of how to use the syslog mode command:

dpe# syslog mode both

%OK (Requires appliance restart "> reload")

syslog mode local

Usage Guidelines

Configures the syslog subsystem to log messages locally only.

Examples

This is an example of how to use the syslog mode command:

dpe# syslog mode local

%OK (Requires appliance restart "> reload")

syslog mode remote

Usage Guidelines

Configures the syslog subsystem to send messages remotely and not log them locally. The remote system must be configured with the syslog log-server command.

Examples

This is an example of how to use the syslog mode command:

dpe# syslog mode remote

%OK (Requires appliance restart "> reload")

PacketCable (Voice Technology) Commands

This section describes the commands that affect the PacketCable (voice technology) features found in the DPE. These commands include:

debug dpe netsnmp
debug dpe registration
debug dpe snmp
no debug dpe netsnmp
no debug dpe registration
no debug dpe snmp
no packetcable
no packetcable registration-server encryption
no packetcable snmp key-material
packetcable enable
packetcable registration encryption
packetcable registration kdc-service-key
packetcable registration-server policy-privacy
packetcable snmp key-material
packetcable snmp timeout
show packetcable registration log
show packetcable registration log last <1..9999>
show packetcable registration log run
show packetcable snmp log
show packetcable snmp log last <1..9999>
show packetcable snmp log run

Note Prior to using any debug command, you must ensure that DPE debugging is enabled. Run the debug on command to enable this function.

debug dpe netsnmp

This command enables detailed debugging for the PacketCable SNMP service running on the DPE.

Examples

This is an example of how to use the debug dpe netsnmp command:

dpe# debug dpe netsnmp

%OK

debug dpe registration

Usage Guidelines

This command enables debugging for the PacketCable secure registration service running on the DPE.

Examples

This is an example of how to use the debug dpe registration command:

dpe# debug dpe registration

%OK

debug dpe snmp

Usage Guidelines

This command enables detailed debugging for the PacketCable SNMP service running on the DPE.

Examples

This is an example of how to use the debug dpe snmp command:

dpe# debug dpe snmp

%OK

no debug dpe netsnmp

This command disables detailed debugging for the PacketCable SNMP service running on the DPE.

Examples

This is an example of how to use the no debug dpe netsnmp command:

dpe# no debug dpe netsnmp

%OK

no debug dpe registration

Usage Guidelines

This command disables debugging for the PacketCable secure registration service running on the DPE.

Examples

This is an example of how to use the no debug dpe registration-server command:

dpe# no debug dpe registration-server

%OK

no debug dpe snmp

Usage Guidelines

This command disables detailed debugging for the PacketCable SNMP service running on the DPE.

Examples

This is an example of how to use the no debug dpe snmp command:

dpe# no debug dpe snmp

%OK

no packetcable

Usage Guidelines

This command is used to disable DPE PacketCable services.

Examples

This is an example of how to use the no packetcable command:

dpe# no packetcable

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

no packetcable registration-server encryption

Usage Guidelines

This command disables encryption on a MTA configuration file.

Syntax Description

When entering the no packetcable registration-server encryption command, you must use this syntax:

dpe# no packetcable registration-server encryption

%OK

no packetcable snmp key-material

Usage Guidelines

This command is used to clear the SNMPv3 service key and turn off the SNMPv3 cloning support. For security reasons, this command is not available when a Telnet session is used and can only be set from the console mode.

Syntax Description

When entering the command, you must use this syntax:

dpe# no packetcable snmp key-material

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

packetcable enable

Usage Guidelines

This command enables PacketCable services. To enable PacketCable, you need to:

Have at least one interface configured with an FQDN and have provisioning enabled.
Have the KDC service key set. See the "packetcable registration kdc-service-key" section for additional information.

Examples

This is an example of how to use the packetcable enable command:

dpe# packetcable enable

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

packetcable registration encryption

Usage Guidelines

This command enables encryption of MTA configuration files.

Examples

This is an example of how to use the packetcable registration encryption command:

dpe# packetcable registration encryption

%OK

packetcable registration kdc-service-key

Usage Guidelines

This command is used to generate and set a security key used for communication between KDC and DPE.

Syntax Description

When entering the packetcable registration kdc-service-key command, you must use this syntax:

dpe# packetcable registration kdc-service-key <password>

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

Where the <password> is any password, 6 to 20 characters in length, that you create.

Note The password that you enter for this command must match the password that is entered into the keygen tool when configuring the KDC. See the "Using the Keygen Tool" section 8-29 for additional information.

Examples

This is an example of how to use the packetcable registration kdc-service-key command:

dpe# packetcable registration kdc-service-key ciscosystems101

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

packetcable registration-server policy-privacy

This CLI command sets the customer policy regarding enforcement of SNMP privacy in MTA communications. Entering a zero value lets the MTA choose the SNMP-v3 privacy option. Entering a non zero value means that the provisioning server sets the privacy option in SNMPv3 to a specific protocol; currently limited to DES.

Syntax Description

When entering the packetcable registration-server policy-privacy command, you must use this syntax:

dpe# packetcable registration-server policy-privacy <value>

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

where:

<value>—Enter any zero, or non zero, value to identify the customer policy. The default value is 0, meaning that the MTA selects the privacy option.

Examples

This is an example of how to use the packetcable registration-server policy-privacy command:

dpe# packetcable registration-server policy-privacy 1

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

packetcable snmp key-material

Usage Guidelines

This command is used to generate and set a security key on the DPE to permit secure communication with the RDU. The secure communication channel with the RDU is only used for PacketCable SNMPv3 cloning support.

Note The same key has to be set on the RDU with a command line tool generateSharedSecret.sh located in the <BPR_HOME>/rdu/bin directory.

Syntax Description

When entering the packetcable snmp key-material command, you must use this syntax:

dpe# packetcable snmp key material <password>

Where the <password> is any password, 6 to 20 characters in length, that you create.

Note Once you run this CLI command, you must reload the DPE for the change to take affect.

Examples

This is an example of how to use the packetcable snmp key-material command:

dpe# packetcable snmp key material ciscosystems101

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

packetcable snmp timeout

Usage Guidelines

This command dynamically sets the time (in seconds) that the PacketCable SNMP service will wait for a response to any SNMP SET operation.

Syntax Description

When entering the packetcable snmp timeout command, you must use this syntax:

packetcable snmp timeout <time>

Where:

<time>—indicates the time the PacketCable SNMP service will wait, in seconds. The default value is 10 seconds.

Examples

This is an example of how to use the packetcable snmp timeout command:

dpe# packetcable snmp timeout 15

%OK

show packetcable registration log

This command shows recent PacketCable registration service log entries. This log contains information about the general PacketCable registration service including logging of provisioning errors or severe problems.

Examples

This is an example of how to use the show packetcable registration log command:

dpe# show packetcable registration log

DEBUG [MtaListener] 2002-09-16 14:57:48,878 (Sequence.java:141) - <== KERBEROS.TransitedEncoding.decode()

show packetcable registration log last <1..9999>

Usage Guidelines

This command displays a specified number of lines from the PacketCable registration service log file.

Syntax Description

When using this command, you must use this syntax:

show packetcable registration log last <1-9999>

Where:

<1-9999>—identifies the number of lines from the log file that you want to see.

Examples

This is an example of how to use the show packetcable registration log last command:

dpe# show packetcable registration log last 1 

INFO [MtaListener] 2002-09-16 14:57:48,901 (Sequence.java:115) - Looking for cryptix.asn1.lang.TaggedType

show packetcable registration log run

Usage Guidelines

This command displays the recent PacketCable registration service log file, and all new log messages, until the command is interrupted.

Examples

This is an example of how to use the show packetcable registration log run command:

dpe # show packetcable registration log run

% Press <enter> to stop.

Error [SS_MSG] 2003-03-18 14:35:44,000 - SNMP Service Tracing Set To 800

% Stopped.

show packetcable snmp log

This command shows recent log entries for the PacketCable SNMP provisioning service, which includes information about the general PacketCable SNMP provisioning service and the logging any MTA provisioning errors or severe problems.

Examples

This is an example of how to use the show packetcable registration log command:

dpe# show packetcable snmp log

Error [SS_MSG] 2003-03-18 14:30:44,000 - SNMP Service Tracing Set To 400 

...

Note The output presented in this example is trimmed.

show packetcable snmp log last <1..9999>

Usage Guidelines

This command displays a specified number of lines from the PacketCable SNMP log file.

Syntax Description

When using this command you must use this syntax:

show packetcable snmp log last <1..9999>

Where:

<1..9999>—identifies the number of lines from the log file that you want to see.

Examples

This is an example of how to use the show packetcable snmp log last command:

dpe# show packetcable snmp log last 1

Error [SS_MSG] 2003-03-18 14:35:44,000 - SNMP Service Tracing Set To 800

show packetcable snmp log run

Usage Guidelines

This command displays the recent PacketCable SNMP service log file, and all new log messages, until the command is interrupted.

Examples

This is an example of how to use the show packetcable snmp log run command:

dpe # show packetcable snmp log run

Press <enter> to stop.

2001 08 17 11:43:43 CDT: %CSRC-5: Notification DPE: CSRC Device Provisioning Engine starting up

2001 08 17 11:43:44 CDT: %CSRC-6: Info DPE: Attempt to connect to RDU dpe .cisco.com:49187 failed; 

2001 08 17 11:43:44 CDT: %CSRC-6: Info TFTP: Ready to service requests

Stopped.

SNMP Agent Commands

This section describes the commands that affect the DPE SNMP agent features found in the DPE. These commands include:

no snmp-server host

Usage Guidelines

This command is used to remove the specified host.

Syntax Description

When using this command, you must use this syntax:

no snmp-server host <ip> traps community <xxx> udp-port <###>

Where:

<ip>—identifies the hosts IP address

<xxx>—identifies the community

<###>—identifies the port number

Examples

This is an example of how to use this command:

dpe# no snmp-server host 10.10.10.5 traps community public udp-port 162

%OK (Requires SNMP server restart "> snmp-server reload")

snmp-server community

Usage Guidelines

This command sets up the community access string to allow access for external SNMP managers to the DPE SNMP agent.

Syntax Description

When entering the snmp-server community command, you must use this syntax:

snmp-server community string [ro | wr]

Where:

<string>—Identifies the SNMP community.
<ro>—Assigns a read only (ro) community string. Only get requests (queries) can be performed. The ro community string in this example (5urf5h0p) allows Get requests but no Set operations. The NMS and the managed device must reference the same community string.
<rw>—Assigns a read write (rw) community string. SNMP applications require rw access for Set operations. The rw community string enables write access to OID values.

Examples

This is an example of how to use the snmp-server community command:

dpe# snmp-server community 5urf5h0p ro

%OK (Requires SNMP restart "> snmp-server reload")

snmp-server host

Usage Guidelines

This command specifies the recipient of all SNMP notifications and is used to configure the DPE SNMP agent to send traps to multiple hosts. This command is used to specify the recipient of SNMP traps and notifications. It is possible to use multiple instances of this command to specify more than one trap recipient.

Syntax Description

When entering the snmp-server host command, you must use this syntax:

snmp-server host <host-addr> traps [community  <community>] [udp-port <port>]

Where:

<host-addr>—Specifies the IP address of the host to which traps are sent.
<community>—Specifies the trap community string to use while sending SNMP traps.
<port>—Identifies the UDP port used for sending the SNMP traps. The default UDP port number is 162.

Examples

This is an example of how to use the snmp-server host command:

dpe# snmp-server host 10.10.10.5 traps community public udp-port 162

%OK (Requires SNMP server restart "> snmp-server reload")

snmp-server reload

Usage Guidelines

This command reloads the SNMP agent process on the DPE.

Syntax Description

When entering this command, you must use this syntax:

snmp-server reload

Examples

This is an example of how to use the snmp-server reload command:

dpe# snmp-server reload

nativeSnmpAgent has been restarted

dpeSnmpAgent has been restarted

%OK

snmp-server start

Usage Guidelines

This command starts the SNMP agent process on the DPE.

Syntax Description

When entering this command, you must use this syntax:

snmp-server start

Examples

This is an example of how to use the snmp-server start command:

dpe# snmp-server start

nativeSnmpAgent has been started

dpeSnmpAgent has been started

%OK

snmp-server stop

Usage Guidelines

This command stops the SNMP agent process on the DPE.

Syntax Description

When entering this command, you must use this syntax:

snmp-server stop

Examples

This is an example of how to use the snmp-server stop command:

dpe# snmp-server stop

nativeSnmpAgent has been stopped

dpeSnmpAgent has been stopped

%OK

Table of Contents