icwmp/docs/api/uci.cwmp.md

<tbody><tr><td colspan="2"><div style="font-weight: bold">cwmp</div><table style="width:100%"><tbody><tr><td><div style="font-weight: bold; font-size: 14px">section</div></td><td><div style="font-weight: bold; font-size: 14px">description</div></td><td><div style="font-weight: bold; font-size: 14px">multi</div></td><td><div style="font-weight: bold; font-size: 14px">options</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">acs</div></td><td class="td_row_even"><div class="td_row_even">This section configure the ACS parameters, used by cwmp client</div></td><td class="td_row_even"><div class="td_row_even">false</div></td><td class="td_row_even"><table style="width:100%"><tbody><tr><td><div style="font-weight: bold; font-size: 14px">name</div></td><td><div style="font-weight: bold; font-size: 14px">type</div></td><td><div style="font-weight: bold; font-size: 14px">required</div></td><td><div style="font-weight: bold; font-size: 14px">default</div></td><td><div style="font-weight: bold; font-size: 14px">description</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">url</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">yes</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">URL of ACS server</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">userid</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">Username for ACS server connection</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">passwd</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">Password for ACS server connection</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">periodic_inform_enable</div></td><td class="td_row_odd"><div class="td_row_odd">boolean</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">If set to **1**, the CPE must periodically open session with ACS by sending Inform message to the ACS.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">periodic_inform_interval</div></td><td class="td_row_even"><div class="td_row_even">uinteger</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">The duration in seconds of the interval for which the CPE must attempt to connect with the ACS and call the Inform method.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">periodic_inform_time</div></td><td class="td_row_odd"><div class="td_row_odd">uinteger</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">An absolute time reference to determine when the CPE will initiate the periodic Inform method calls.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">ParameterKey</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">Provides the ACS a reliable and extensible means to track changes made by the ACS.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">dhcp_discovery</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">if set to **enable**, the CPE will get the url of ACS from DHCP server Option 43.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">compression</div></td><td class="td_row_even"><div class="td_row_even">boolean</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">if set to **1**, the CPE must use the HTTP Compression when communicating with the ACS.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">retry_min_wait_interval</div></td><td class="td_row_odd"><div class="td_row_odd">uinteger</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">The min wait interval of rerty session (in seconds) as described in the standard.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">retry_interval_multiplier</div></td><td class="td_row_even"><div class="td_row_even">uinteger</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">The retry interval mulpilier of rerty session as described in the standard.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">https_ssl_capath</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">The path of ssl certicafications files. the ssl certification is for Upload and Downlod methods.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">ipv6_enable</div></td><td class="td_row_even"><div class="td_row_even">boolean</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">Enables IPv6 in cwmp</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">ssl_capath</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">The path of ssl certicafications files. the ssl certification is  for TR-069 sessions.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">insecure_enable</div></td><td class="td_row_even"><div class="td_row_even">boolean</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">if set to **1**, the CPE checks the validity of the ACS certificates.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">http_disable_100continue</div></td><td class="td_row_odd"><div class="td_row_odd">boolean</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">if set to **1**, disables the http 100 continue behaviour.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">dhcp_url</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">the **url** of ACS server received from the DHCP server Option 43 when **'dhcp_discovery'** option is enabled. This option is updated automatically by the daemon.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">ip_version</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">ip_version of ConnectionRequestURL</div></td></tr></tbody></table></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">cpe</div></td><td class="td_row_odd"><div class="td_row_odd">CWMP client configuration</div></td><td class="td_row_odd"><div class="td_row_odd">false</div></td><td class="td_row_odd"><table style="width:100%"><tbody><tr><td><div style="font-weight: bold; font-size: 14px">name</div></td><td><div style="font-weight: bold; font-size: 14px">type</div></td><td><div style="font-weight: bold; font-size: 14px">required</div></td><td><div style="font-weight: bold; font-size: 14px">default</div></td><td><div style="font-weight: bold; font-size: 14px">description</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">interface</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">Specifies the device interface to use for connecting to ACS.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">default_wan_interface</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">Specifies the default wan interface of the device.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">log_to_console</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">If set to **1**, the log messages will be shown in the console.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">log_to_file</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">If set to **1**, the log messages will be saved in the log file.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">log_severity</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">Specifies the log type to use, by default **'INFO'**. The possible types are **'EMERG', 'ALERT', 'CRITIC' ,'ERROR', 'WARNING', 'NOTICE', 'INFO' and 'DEBUG'**.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">log_file_name</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">Specifies the path of the log file, by default **'/var/log/icwmpd.log'**.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">log_max_size</div></td><td class="td_row_even"><div class="td_row_even">uinteger</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">Size of the log file. The default value is **102400**.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">userid</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">The username of the device used in a connection request from ACS to CPE.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">passwd</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">The password of the device when sending a connection request from ACS to CPE.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">port</div></td><td class="td_row_odd"><div class="td_row_odd">uinteger</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">The port used for connection request.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">ubus_socket</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">Specifies the path of the ubus socket file, by default **'NULL'**.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">provisioning_code</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">Specifies the primary service provider and other provisioning information, which may be used by the ACS to determine service provider-specific customization and provisioning parameters.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">amd_version</div></td><td class="td_row_even"><div class="td_row_even">uinteger</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">Specifies the amendment version to use. The default amendment version is **'5'**.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">instance_mode</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">Specifies the instance mode to use, by default **'InstanceNumber'**. Two instance modes are supported: **'InstanceNumber' and 'InstanceNumber'**.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">session_timeout</div></td><td class="td_row_even"><div class="td_row_even">uinteger</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">Represents the number of seconds that should be used by the ACS as the amount of time to wait before timing out a CWMP session due to the CPE not responding, by default **60**.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">notification</div></td><td class="td_row_odd"><div class="td_row_odd">boolean</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">If set to **1**, it enables the notification feature.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">exec_download</div></td><td class="td_row_even"><div class="td_row_even">boolean</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">If set to **1**, Specifies if Download method is executed.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">manufacturer</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">Specifies the manafacturer of the device, by default **iopsys**. If set, its value will be the value of **Device.DeviceInfo.Manufacturer** parameter.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">manufacturer_oui</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">Specifies the manafacturer oui of the device, by default empty. If set, its value will be the value of **Device.DeviceInfo.ManufacturerOUI** parameter.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">model_name</div></td><td class="td_row_odd"><div class="td_row_odd">string</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">Specifies the model name of the device, by default empty. If set, its value will be the value of **Device.DeviceInfo.ModelName** parameter.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">product_class</div></td><td class="td_row_even"><div class="td_row_even">string</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">Specifies the product class of the device, by default empty. If set, its value will be the value of **Device.DeviceInfo.ProductClass** parameter.</div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">log_to_syslog</div></td><td class="td_row_odd"><div class="td_row_odd">boolean</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">If set to **1**, the cwmp log will be appended to busybox syslog.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">periodic_notify_enable</div></td><td class="td_row_even"><div class="td_row_even">boolean</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">If set to **1**, icwmp will be able to detect parameter value change at any time.</div></td></tr></tbody></table></td></tr><tr><td class="td_row_even"><div class="td_row_even">lwn</div></td><td class="td_row_even"><div class="td_row_even">Lightweight notification configuration</div></td><td class="td_row_even"><div class="td_row_even">false</div></td><td class="td_row_even"><table style="width:100%"><tbody><tr><td><div style="font-weight: bold; font-size: 14px">name</div></td><td><div style="font-weight: bold; font-size: 14px">type</div></td><td><div style="font-weight: bold; font-size: 14px">required</div></td><td><div style="font-weight: bold; font-size: 14px">default</div></td><td><div style="font-weight: bold; font-size: 14px">description</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">enable</div></td><td class="td_row_even"><div class="td_row_even">boolean</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">if set to **1**, the Lightweight Notifications will be enabled. </div></td></tr><tr><td class="td_row_odd"><div class="td_row_odd">hostname</div></td><td class="td_row_odd"><div class="td_row_odd">host</div></td><td class="td_row_odd"><div class="td_row_odd">no</div></td><td class="td_row_odd"><div class="td_row_odd"></div></td><td class="td_row_odd"><div class="td_row_odd">The hostname or address to be used when sending the UDP Lightweight Notifications.</div></td></tr><tr><td class="td_row_even"><div class="td_row_even">port</div></td><td class="td_row_even"><div class="td_row_even">port</div></td><td class="td_row_even"><div class="td_row_even">no</div></td><td class="td_row_even"><div class="td_row_even"></div></td><td class="td_row_even"><div class="td_row_even">The port number to be used when sending UDP Lightweight Notifications.</div></td></tr></tbody></table></td></tr></tbody></table></td></tr></tbody>