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.

<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

<X_00000C_SetConfigurationResponse>
<Status>0</Status>
</X_00000C_SetConfigurationResponse>

<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>

<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>
 

<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>
 

<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>

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.

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.

The CPE WAN Management Protocol (CWMP) can be used to remotely manage customer premise equipment (CPE) devices that are connected over a LAN through a gateway. If Auto Configuration Server (ACS) manages both the Device and the Gateway through which the device is connected , ACS determines the identity of the gateway by checking the device gateway association information. The ACS with the device gateway association profile can identify the end devices behind each gateway. The device gateway association constitutes Annex F (previously part of TR-111), part of the TR-069 standard. The mechanism defined for device gateway association relies on the Device’s use of Dynamic Host Configuration Protocol (DHCP) Option 125. The end devices will pass on their identity to the gateway via vendor-specific DHCP option. When the gateway receives this information, the gateway populates the ManageableDevice table containing identity information for each device on its LAN. The parameters, which are supported on the gateway as part of device gateway association is as follows:

• InternetGatewayDevice.ManagementServer.ManageableDeviceNumberOfEntries

• InternetGatewayDevice.ManagementServer.ManageableDevice.{i}

  • ManufacturerOUI

  • ProductClass

  • SerialNumber

The device gateway association functionality does not support configuring IP addresses manually on the end devices. The IP addresses are assigned to the end devices via DHCP by the gateway. You must configure renew deny unknown command under the DHCP server configuration to initiate the DHCP discovery process for the end devices after a gateway reload.

Figure 1. Device-Gateway Association using DHCP Discover

The following example shows how to set up the Device-Gateway Association and Port Mapping feature via a Dynamic Host Configuration Protocol (DHCP) on VLAN interface:

ip dhcp excluded-address 15.15.15.1
!
ip dhcp pool NET-POOL1
 network 15.15.15.0 255.255.255.0
 default-router 15.15.15.1
 lease 0 0 5
 renew deny unknown
 end
 interface Vlan102
  ip address pool NET-POOL1
  end

The CPE WAN Management Protocol (CWMP) can be used to remotely manage customer premise equipment (CPE) devices that are connected via a LAN through a network address translation (NAT) gateway. This can be achieved by making use of the PortMapping functionality. This feature helps in maintaining the privacy of the IP addresses of the end devices as the communication happens with the auto-configuration server (ACS) in the public domain. The gateway supports the following CWMP parameters:

• InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}. PortMappingNumberOfEntries

• InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANIPConnection.{i}.Port-Mapping.{i}.

  • PortMappingEnabled

  • PortMappingLeaseDuration

  • RemoteHost

  • ExternalPort

  • InternalPort

  • PortMappingProtocol

  • InternalClient

  • PortMappingDescription

• InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPP-Connection.{i}.PortMappingNumberOfEntries

• InternetGatewayDevice.WANDevice.{i}.WANConnectionDevice.{i}.WANPPP-Connection.{i}.PortMapping.{i}.

  • PortMappingEnabled

  • PortMappingLeaseDuration

  • RemoteHost

  • ExternalPort

  • InternalPort

  • PortMappingProtocol

  • InternalClient

  • PortMappingDescription

Note	The ACS must provide values for the mandatory parameters—ExternalPort, InternalPort, PortMappingProtocol, and InternalClient—to the gateway for adding the port mapping for an end device. There is no support to limit the portmapping to a particular host using RemoteHost parameter.

Figure 2. Connection request via a NAT Gateway using PortMapping table

The following is an example Port Mapping Support on a device configured as a gateway and ACS.

For the below parameters configured on ACS,

Destination IP (InternalClient) - 15.15.15.2
Source port (ExternalPort)  - 9000    
Destination port (InternalPort) - 7547
PortMappingProtocol - TCP

the following NAT command is configured on the gateway:

ip nat inside source static tcp 15.15.15.2 7547 10.194.145.170 9000 extendable

10.194.145.170 is the RemoteHost and the IP address of the device or gateway provisioned by ACS. This is the IP address corresponding to the interface with the configuration cwmp wan default command.