Table Of Contents
Prerequisites for the TR-069 Agent
Information About the 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
Enabling the TR-069 Agent on the CPE
Initiating a TR-069 Agent Session from the ACS
Configuring HTTP Digest Authentication Support
Monitoring and Troubleshooting the HTTP Cookies
Configuration Examples for TR-069 Agent
Setting Up the CPE to Communicate with the ACS: Example
Configuring and Enabling CWMP using the Autoinstall feature
Feature Information for TR-069 Agent
TR-069 Agent
First Published: July 11, 2008Last Updated: January 28, 2010The 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
Your software release may not support all the features documented in this module. For the latest feature information and caveats, see the release notes for your platform and software release. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the "Feature Information for TR-069 Agent" section.
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
•Feature Information for TR-069 Agent
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:
•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 | startup-config} </Target><ConfigCommandBlock> block of clis separated by newline [\n] character </ConfigCommandBlock><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 64Target => string with length 64On 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
Perfom the following tasks to configure and enable the TR-069 agent. If an Ethernet or Serial interface is used to communicate with ACS, then the following tasks need not be performed manually. These are automated by using the auto install feature. For more information on the autoinstall feature, refer to Using AutoInstall to Remotely Configure Cisco Networking Devices. For an example on configuring CWMP with the autoinstall feature, refer to "Configuring and Enabling CWMP using the Autoinstall feature" section.
•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. For more information about the ip http server and ip http secure-server commands, refer to the Cisco IOS Network Management Command Reference.
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
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
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
6. end
DETAILED STEPS
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
4. end
DETAILED STEPS
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
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
Configuration Examples for TR-069 Agent
This section provides the following configuration example:
•Setting Up the CPE to Communicate with the ACS: Example
•Configuring and Enabling CWMP using the Autoinstall feature
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.
!configure terminalcwmp agentmanagement server url http://172.25.117.78:7547/acsmanagement server password 0 labprovision code ABCDexitinterface ethernet 0/0cwmp wancwmp wan defaultexitcwmp agentenable downloadsession retry limit 12request outstanding 3parameter change notify interval 120!Configuring and Enabling CWMP using the Autoinstall feature
The following example shows how to configure CWMP using the autoinstall feature. Use the following set of commands in the network-config file or <hostname>-config file or router-config file in the TFTP server. No additional manual configuration is required for configuring CWMP on the device.
!cwmp agentenableenable downloadmanagement server password labmanagement server url http://10.1.98.229:7547/acsconnection request username user1connection request password lab!ip http server!Additional References
The following sections provide references related to the TR-069 Agent feature.
Related Documents
Related Topic Document TitleTR-069 Agent commands: complete command syntax, command mode, command history, defaults, usage guidelines, and examples
Cisco IOS commands
Standards
Standard TitleNo new or modified standards are supported by this feature, and support for existing standards has not been modified by this feature.
—
MIBs
MIB MIBs LinkNone
To locate and download MIBs for selected platforms, Cisco IOS releases, and feature sets, use Cisco MIB Locator found at the following URL:
RFCs
RFC TitleNo new or modified RFCs are supported by this feature, and support for existing RFCs has not been modified by this feature.
—
Technical Assistance
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 InformationTR-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:
•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.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at www.cisco.com/go/trademarks. Third party trademarks mentioned 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. (1005R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.
© 2008-2010 Cisco Systems, Inc. All rights reserved.