Cisco IOS and NX-OS Software

Table Of Contents

TR-069 Agent

Contents

Prerequisites for the TR-069 Agent

Information About the TR-069 Agent

TR-069 Agent

HTTP Digest Authentication Support

HTTP Cookie Support Per RFC2965

How to Configure and Enable the TR-069 Agent

Setting Up the CPE to Communicate with the ACS

Prerequisites

What to Do Next

Enabling the TR-069 Agent on the CPE

Prerequisites

Initiating a TR-069 Agent Session from the ACS

Prerequisites

Configuring HTTP Digest Authentication Support

Troubleshooting Tips

Clearing the HTTP Cookies

Troubleshooting Tips

Monitoring and Troubleshooting the HTTP Cookies

Configuration Examples for TR-069 Agent

Setting Up the CPE to Communicate with the ACS: Example

Additional References

Related Documents

Standards

MIBs

RFCs

Technical Assistance

Feature Information for TR-069 Agent

Glossary

TR-069 Agent

---

First Published: July 11, 2008

Last Updated: July 11, 2008

The digital subscriber line (DSL) Forum's TR-069, CPE WAN Management Protocol (CWMP), is used for communications between a customer premise equipment (CPE) and an auto-configuration server (ACS). The TR-069 Agent feature manages a collection of CPEs, with the primary capability for auto-configuration and dynamic service provisioning, software image management, status and performance monitoring and diagnostics.

Finding Feature Information in This Module

Your Cisco IOS software release may not support all of the features documented in this module. For the latest feature information and caveats, see the release notes for your platform and software release. To reach links to specific feature documentation in this module and to see a list of the releases in which each feature is supported, use the "Feature Information for TR-069 Agent" section.

Finding Support Information for Platforms and Cisco IOS and Catalyst OS Software Images

Use Cisco Feature Navigator to find information about platform support and Cisco IOS and Catalyst OS software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.

Contents

•Prerequisites for the TR-069 Agent

•Information About the TR-069 Agent

•How to Configure and Enable the TR-069 Agent

•Configuration Examples for TR-069 Agent

•Additional References

•Feature Information for TR-069 Agent

•Glossary

Prerequisites for the TR-069 Agent

The CPE should have an IP address and a WAN connection should be established to access the ACS.

Information About the TR-069 Agent

To configure the TR-069 Agent and related features, you should understand the following concepts:

•TR-069 Agent

•HTTP Digest Authentication Support

•HTTP Cookie Support Per RFC2965

TR-069 Agent

The TR-069 Agent allows an ACS to provision a CPE or collection of CPEs. The provisioning mechanism includes specific provisioning parameters and a general mechanism for adding vendor-specific provisioning capabilities as needed. The identification mechanisms included in the protocol allow CPE provisioning based either on the requirements of each specific CPE, or on collective criteria such as the CPE vendor, model, software version, or other criteria.

The provisioning mechanism allows CPE provisioning at the time of initial connection to the broadband access network and the ability to reprovision at any subsequent time. This includes support for asynchronous ACS-initiated reprovisioning of a CPE.

The TR-069 Agent also supports image upgrade, configuration application, file downloads, configuration and log file uploads, and CPE monitoring.

---

Note The TR-069 Agent CPE devices must be set up and enabled for TR-069. An ACS used to communicate with the CPE must be TR-069 compliant in order to enable the TR-069 Agent.

---

RPC Support

The following remote procedure calls (RPCs) supported with the TR-069 Agent:

•Standard RPCs

–GetRPCMethods

–SetParameterValues

–GetParameterValues

–GetParameterNames

–SetParameterAttributes

–GetParameterAttributes

–AddObject

–DeleteObject

–Reboot

–Download

–Upload

•Vendor RPCs

–X_00000C_SetConfiguration

–X_00000C_ShowStatus

CWMP Vendor Profile Schema

The following details the CWMP vendor profile schema:

•For SetConfiguration,

<cwmp:X_00000C_SetConfiguration>

<ErrorOption> rollback </ErrorOption>

<Target> running-config </Target>

<Target> startup-config </Target>

<ConfigCommandList array of strings[1..unbounded] each of length 256> 

<string> IOS Configuration command 1 </string> 

<string> IOS Configuration command 2 </string> 

</ConfigCommandList> 

<ParameterKey> parameterkey </ParameterKey>

</cwmp:X_00000C_SetConfiguration>

ErrorOption => string with length 64

Target => string with length 64

On success,

<X_00000C_SetConfigurationResponse>

<Status>0</Status>

</X_00000C_SetConfigurationResponse>

On failure,

<SOAP:Fault>

<SOAP:faultcode>Client</SOAP:faultcode>

<SOAP:faultstring>CWMP fault</SOAP:faultstring>

<SOAP:detail>

<cwmp:Fault>

<FaultCode></FaultCode>

<FaultString></FaultString>

<cwmp:X_00000C_SetConfigurationFault>

<Command>IOS Configuration command that failed</Command>

<FaultCode>parse_cmd() return value</FaultCode>

</cwmp:X_00000C_SetConfigurationFault>

<cwmp:X_00000C_SetConfigurationFault>

<Command>IOS Configuration command that failed</Command>

<FaultCode>parse_cmd() return value</FaultCode>

</cwmp:X_00000C_SetConfigurationFault>

</cwmp:Fault>

</SOAP:detail>

</SOAP:Fault>

•For ShowStatus,

<cwmp:X_00000C_ShowStatus>

<ExecCommandList array of strings[1..unbounded] each of length 256 > 

<string> IOS Exec command 1 </string> 

<string> IOS Exec command 2 </string> 

<string> IOS Exec command 3 </string> 

</ExecCommandList> 

</cwmp:X_00000C_ShowStatus>

On success,

<cwmp:X_00000C_ShowStatusResponse>

<ExecResponseList array of ExecResponseStruct [1..unbounded]> 

<ExecResponseStruct> 

<Command> IOS Exec command 1 </Command> 

<Response> output of command 1</Response> 

</ExecResponseStruct> 

<ExecResponseStruct> 

<Command> IOS Exec command 2 </Command> 

<Response> output of command 2 </Response> 

</ExecResponseStruct> 

<ExecResponseStruct> 

<Command> IOS Exec command 3 </Command> 

<Response>output of command 3</Response> 

</ExecResponseStruct> 

</ExecResponseList> 

</cwmp:X_00000C_ShowStatusResponse>

On failure,

<SOAP:Fault>

<SOAP:faultcode>Client</SOAP:faultcode>

<SOAP:faultstring>CWMP fault</SOAP:faultstring>

<SOAP:detail>

<cwmp:Fault>

<FaultCode></FaultCode>

<FaultString></FaultString>

</cwmp:Fault>

</SOAP:detail>

</SOAP:Fault>

HTTP Digest Authentication Support

The TR-069 Agent uses HTTP as the transport and needs support for digest authentication from the HTTP client infrastructure.

---

Note This feature is not a TR-069 Agent-exclusive feature and can be used in other scenarios to configure HTTP Digest Authentication Support.

---

HTTP Cookie Support Per RFC2965

A cookie is a piece of HTTP state information generated and sent by an HTTP server in response to an HTTP request. The HTTP client returns the cookie containing the state information back to the HTTP server in its next HTTP request. This scenario is used to create a stateful session with HTTP requests and responses. The TR-069 Agent uses HTTP as the transport and needs support for both Netscape cookies and RFC 2965 in HTTP client infrastructure.

---

Note This feature is not a TR-069 Agent-exclusive feature and can be used in other scenarios to clear, monitor and troubleshoot HTTP cookies.

---

How to Configure and Enable the TR-069 Agent

This section contains the following tasks:

•Setting Up the CPE to Communicate with the ACS (required)

•Enabling the TR-069 Agent on the CPE (required)

•Initiating a TR-069 Agent Session from the ACS (optional)

•Configuring HTTP Digest Authentication Support (optional)

•Clearing the HTTP Cookies (optional)

•Monitoring and Troubleshooting the HTTP Cookies (optional)

Setting Up the CPE to Communicate with the ACS

Perform this task to configure the TR-069 Agent on the CPE.

Prerequisites

If the ACS URL is an HTTP URL, enable the Cisco IOS HTTP Server using the ip http server command.

If the ACS URL is an HTTPS URL, enable the Cisco IOS HTTP Secure Server using the ip http secure-server command.

---

Note For more information about the ip http server and ip http secure-server commands, refer to the Cisco IOS Network Management Command Reference, Release 12.4T.

---

SUMMARY STEPS

1. enable

2. configure terminal

3. cwmp agent

4. management server url acs-url

5. management server password [encryption-type | cleartext-password] passwd

6. provision code code-string

7. exit

8. interface type number

9. cwmp wan

10. cwmp wan default

11. exit

12. cwmp agent

13. enable download

14. session retry limit session-count

15. request outstanding request-count

16. parameter change notify interval time-interval

DETAILED STEPS

	Command or Action	Purpose
Step 1	enable Example: Device> enable	Enables privileged EXEC mode. •Enter your password if prompted.
Step 2	configure terminal Example: Device# configure terminal	Enters global configuration mode.
Step 3	cwmp agent Example: Device(config)# cwmp agent	Enables TR-069 Agent configuration mode.
Step 4	management server url acs-url Example: Device(config-cwmp)# management server url http://172.25.117.78:7547/acs or Example: Device(config-cwmp)# management server url https://172.25.117.78:7547/acs	Specifies the HTTP/HTTPS URL to reach the ACS. This URL is used by the CPE to establish the TR-069 session with the ACS.
Step 5	management server password [encryption-type | cleartext-password] passwd Example: Device(config-cwmp)# management server password 0 cisco	Specifies the CPE password that is used in the authentication phase. •This password will be provided to the ACS when the CPE is challenged for credential as part of authentication during the session establishment.
Step 6	provision code code-string Example: Device(config-cwmp)# provision code ABCD	Specifies the provision code to be used by the CPE.
Step 7	exit Example: Device(config-cwmp)# exit	Exits TR-069 Agent configuration mode and returns to global configuration mode.
Step 8	interface type number Example: Device# interface serial 0/0	Enters interface configuration mode.
Step 9	cwmp wan Example: Device(config-if)# cwmp wan	(Optional) Defines the WAN interfaces on the CPE. Note Any interface without this command is considered a LAN interface by TR-069 protocol. There can be multiple WAN and LAN interfaces configured on the CPE. By default, an ATM interface on the CPE will be considered a WAN interface by the TR-069 protocol.
Step 10	cwmp wan default Example: Device(config-if)# cwmp wan default	Defines the default WAN interfaces on the CPE device. Note Among the multiple WAN interfaces, there can be only one default WAN interface in which the TR-069 communication will happen. If you try to configure this command on multiple interfaces, only the latest configuration will be active and the previous default WAN interface will become a WAN interface, ensuring only one interface is the default at any point in time.
Step 11	exit Example: Device(config-if)# exit	Exits interface configuration mode and returns to global configuration mode.
Step 12	cwmp agent Example: Device(config)# cwmp agent	Enables TR-069 Agent configuration mode.
Step 13	enable download Example: Device(config-cwmp)# enable download	(Optional) Enables the CPE to permit a software download. By default, this command is disabled.
Step 14	session retry limit session-count Example: Device(config-cwmp)# session retry limit 10	(Optional) Sets the session retry count whenever the TR-069 session establishment fails with the ACS. •The range for the session count argument is 0 to 15. •The default value is 11.
Step 15	request outstanding request-count Example: Device(config-cwmp)# request outstanding 6	(Optional) Sets the count for the number of requests that can be sent by CPE to ACS without receiving the acknowledgement. •The range for the request count argument is 0 to 10. •The default value is 5.
Step 16	parameter change notify interval time-interval Example: Device(config-cwmp)# parameter change notify interval 75	(Optional) Sets the time interval, in seconds, for the parameter change notifications. •The range for the time interval argument is 15 to 300. •The default value is 60.

What to Do Next

Proceed to the "Enabling the TR-069 Agent on the CPE" section.

Enabling the TR-069 Agent on the CPE

Perform this task to enable TR-069 Agent on your CPE.

Prerequisites

This task assumes that you have already set up the CPE using the tasks in the "Setting Up the CPE to Communicate with the ACS" section.

SUMMARY STEPS

1. enable

2. configure terminal

3. cwmp agent

4. enable

DETAILED STEPS

	Command or Action	Purpose
Step 1	enable Example: Device> enable	Enables privileged EXEC mode. •Enter your password if prompted.
Step 2	configure terminal Example: Device# configure terminal	Enters global configuration mode.
Step 3	cwmp agent Example: Device(config)# cwmp agent	Enables TR-069 Agent configuration mode.
Step 4	enable Example: Device(config-cwmp)# enable	Enables the CPE to initiate a TR-069 session with the ACS.

Initiating a TR-069 Agent Session from the ACS

Perform this task to initiate a TR-069 Agent session from the ACS with the CPE.

Prerequisites

This task assumes that you have already set up the CPE using the tasks in the "Setting Up the CPE to Communicate with the ACS" section and enabled the TR-069 Agent on the CPE using the tasks in the "Enabling the TR-069 Agent on the CPE" section.

SUMMARY STEPS

1. enable

2. configure terminal

3. cwmp agent

4. connection request username username

5. connection request password [encryption-type | cleartext-password] passwd

DETAILED STEPS

	Command or Action	Purpose
Step 1	enable Example: Device> enable	Enables privileged EXEC mode. •Enter your password if prompted.
Step 2	configure terminal Example: Device# configure terminal	Enters global configuration mode.
Step 3	cwmp agent Example: Device(config)# cwmp agent	Enables TR-069 Agent configuration mode.
Step 4	connection request username username Example: Device(config-cwmp)# connection request username cisco	Specifies the username used to authenticate an ACS which makes a connection request to a CPE.
Step 5	connection request username [encryption-type | cleartext-password] passwd Example: Device(config-cwmp)# connection request password 0 cisco	Specifies the password used to authenticate an ACS which makes a connection request to a CPE.

Configuring HTTP Digest Authentication Support

Perform this task to configure HTTP Digest Authentication Support.

SUMMARY STEPS

1. enable

2. configure terminal

3. ip http digest algorithm digest-algorithm

DETAILED STEPS

	Command or Action	Purpose
Step 1	enable Example: Device> enable	Enables privileged EXEC mode. •Enter your password if prompted.
Step 2	configure terminal Example: Device# configure terminal	Enters global configuration mode.
Step 3	ip http digest algorithm digest-algorithm Example: Device(config)# ip http digest algorithm md5	Configures the MD5 digest algorithm parameter. •The choices for the digest algorithm parameter are MD5 and MD5-sess. •MD5 is the default.

Troubleshooting Tips

The following command can help troubleshoot the HTTP Digest Authentication Support:

•show ip http client connection—Displays all open client connections.

Clearing the HTTP Cookies

Perform this task to clear the HTTP cookies.

SUMMARY STEPS

1. enable

2. clear ip http client cookie [domain cookie-domain | name cookie-name | session session-name]

DETAILED STEPS

	Command or Action	Purpose
Step 1	enable Example: Device> enable	Enables privileged EXEC mode. •Enter your password if prompted.
Step 2	clear ip http client cookie [domain cookie-domain | name cookie-name | session session-name] Example: Device# clear ip http client cookie name test	Clears the HTTP cookies.

Troubleshooting Tips

The following command can help troubleshoot the HTTP cookies:

•show ip http client cookie—Displays the HTTP cookies.

Monitoring and Troubleshooting the HTTP Cookies

Perform this task to monitor and troubleshoot the HTTP cookies.

SUMMARY STEPS

1. enable

2. show ip http client cookie {brief | summary} [domain cookie-domain | name cookie-name | session session-name]

3. debug ip http cookie

DETAILED STEPS

	Command or Action	Purpose
Step 1	enable Example: Device> enable	Enables privileged EXEC mode. •Enter your password if prompted.
Step 2	show ip http client cookie {brief | summary} [domain cookie-domain | name cookie-name | session session-name] Example: Device# show ip http client cookie brief name test	Shows the HTTP cookies.
Step 3	debug ip http cookie Example: Device# debug ip http cookie	Troubleshoots the HTTP cookies.

Configuration Examples for TR-069 Agent

This section provides the following configuration example:

•Setting Up the CPE to Communicate with the ACS: Example

Setting Up the CPE to Communicate with the ACS: Example

The following example shows how to set up the CPE to communicate with the ACS. The ACS URL is http://172.25.117.78:7547/acs and the password is lab.

Device# configure terminal

Device(config)# cwmp agent 

Device(config-cwmp)# management server url http://172.25.117.78:7547/acs

Device(config-cwmp)# management server password 0 lab

Device(config-cwmp)# provision code ABCD

Device(config-cwmp)# exit

Device(config)# interface ethernet 0/0

Device(config-if)# cwmp wan

Device(config-if)# cwmp wan default 

Device(config-if)# exit

Device(config)# cwmp agent

Device(config-cwmp)# enable download 

Device(config-cwmp)# session retry limit 12

Device(config-cwmp)# request outstanding 3 

Device(config-cwmp)# parameter change notify interval 120 

Additional References

The following sections provide references related to the TR-069 Agent feature.

Related Documents

Related Topic	Document Title
TR-069 Agent commands: complete command syntax, command mode, command history, defaults, usage guidelines, and examples	Cisco IOS Network Management Command Reference, Release 12.4T

Standards

Standard	Title
No new or modified standards are supported by this feature, and support for existing standards has not been modified by this feature.	—

MIBs

MIB	MIBs Link
None	To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL: http://www.cisco.com/go/mibs

RFCs

RFC	Title
No new or modified RFCs are supported by this feature, and support for existing RFCs has not been modified by this feature.	—

Technical Assistance

Description

Link

The Cisco Support website provides extensive online resources, including documentation and tools for troubleshooting and resolving technical issues with Cisco products and technologies. To receive security and technical information about your products, you can subscribe to various services, such as the Product Alert Tool (accessed from Field Notices), the Cisco Technical Services Newsletter, and Really Simple Syndication (RSS) Feeds. Access to most tools on the Cisco Support website requires a Cisco.com user ID and password.

http://www.cisco.com/techsupport

Feature Information for TR-069 Agent

Table 1 lists the features in this module and provides links to specific configuration information. Only features that were introduced or modified in Cisco IOS Release 12.4(20)T or a later release appear in the table.

Not all commands may be available in your Cisco IOS software release. For release information about a specific command, see the command reference documentation.

Use Cisco Feature Navigator to find information about platform support and software image support. Cisco Feature Navigator enables you to determine which Cisco IOS and Catalyst OS software images support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.

---

Note Table 1 lists only the Cisco IOS software release that introduced support for a given feature in a given Cisco IOS software release train. Unless noted otherwise, subsequent releases of that Cisco IOS software release train also support that feature.

---

Table 1 Feature Information for TR-069 Agent 

Feature Name	Releases	Feature Information
TR-069 Agent	12.4(20)T	The TR-069 Agent feature manages a collection of CPEs, with the primary capability for auto-configuration and dynamic service provisioning, software image management, status and performance monitoring and diagnostics. The following sections provide information about this feature: •Setting Up the CPE to Communicate with the ACS •Enabling the TR-069 Agent on the CPE The following commands were introduced or modified: cwmp agent, cwmp wan, cwmp wan default, debug cwmp, enable, enable download, management server password, management server url, parameter change notify interval, provision code, request outstanding, session retry limit, show cwmp map, show cwmp methods, show cwmp parameter, show cwmp persistent, show cwmp session.
HTTP Digest Authentication Support	12.4(20)T	The TR-069 Agent uses HTTP as the transport and needs support for digest authentication from the HTTP client infrastructure. The following section provides information about this feature: •Configuring HTTP Digest Authentication Support The following commands were introduced or modified: ip http digest algorithm, show ip http client connection.
HTTP Cookie Support per RFC2965	12.4(20)T	TR-069 Agent uses HTTP as the transport and needs support for both Netscape cookies and RFC 2965 in HTTP client infrastructure. The following sections provide information about this feature: •Clearing the HTTP Cookies •Monitoring and Troubleshooting the HTTP Cookies The following commands were introduced or modified: clear ip http client cookie, debug ip http client cookie, show cwmp map, show ip http client cookie.

Glossary

ACS—auto-configuration server.

CPE—customer premise equipment.

CCDE, CCENT, Cisco Eos, Cisco Lumin, Cisco Nexus, Cisco StadiumVision, the Cisco logo, DCE, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn is a service mark; and Access Registrar, Aironet, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, EtherFast, EtherSwitch, Event Center, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iPhone, iQ Expertise, the iQ logo, iQ Net Readiness Scorecard, iQuick Study, IronPort, the IronPort logo, LightStream, Linksys, MediaTone, MeetingPlace, MGX, Networkers, Networking Academy, Network Registrar, PCNow, PIX, PowerPanels, ProConnect, ScriptShare, SenderBase, SMARTnet, Spectrum Expert, StackWise, The Fastest Way to Increase Your Internet Quotient, TransPath, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.

All other trademarks mentioned in this document or Website are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (0805R)

Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.

© 2008 Cisco Systems, Inc. All rights reserved.