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.
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 Table at the end of this document.
Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to
www.cisco.com/go/cfn. An account on Cisco.com is not required.
Prerequisites for the TR-069 Agent
The CPE should have an IP address and a WAN connection should be established to access the ACS.
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 64
Target => string with length 64
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 .
Perform this task to configure the TR-069 Agent on the CPE.
Before You Begin
If the ACS URL is an HTTP URL, enable the Cisco IOS HTTP Server using the
iphttpservercommand. If the ACS URL is an HTTPS URL, enable the Cisco IOS HTTP Secure Server using the
iphttpsecure-server command. For more information about the
iphttpserver and
iphttpsecure-server commands, refer to the
Cisco IOS Network Management Command Reference.
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
provisioncodecode-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
interfacetypenumber
Example:
Device# interface serial 0/0
Enters interface configuration mode.
Step 9
cwmpwan
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
cwmpwandefault
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 could 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
cwmpagent
Example:
Device(config)# cwmp agent
Enables TR-069 Agent configuration mode.
Step 13
enabledownload
Example:
Device(config-cwmp)# enable download
(Optional) Enables the CPE to permit a software download. By default, this command is disabled.
Step 14
sessionretrylimitsession-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
requestoutstandingrequest-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.
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 agent
enable
enable download
management server password lab
management server url http://10.1.98.229:7547/acs
connection request username user1
connection request password lab
!
ip http server
!
Additional References
The following sections provide references related to the TR-069 Agent feature.
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.
The following table provides release information about the feature or features described in this module. This table lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature.
Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to
www.cisco.com/go/cfn. An account on Cisco.com is not required.
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:
The following commands were introduced or modified:
cwmpagent,
cwmpwan,
cwmpwandefault,
debugcwmp,
enable,
enabledownload,
managementserverpassword,
managementserverurl,
parameterchangenotifyinterval,
provisioncode,
requestoutstanding,
sessionretrylimit,
showcwmpmap,showcwmpmethods,
showcwmpparameter,
showcwmppersistent,
showcwmpsession.
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:
The following commands were introduced or modified:
iphttpdigestalgorithm,
showiphttpclientconnection.
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:
The following commands were introduced or modified:
cleariphttpclientcookie,
debugiphttpclientcookie,
showcwmpmap,
showiphttpclientcookie.
Glossary
ACS--auto-configuration server.
CPE--customer premise equipment.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL:
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. (1110R)
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.