mirror/icwmp
1
0
Fork 0
mirror of https://dev.iopsys.eu/bbf/icwmp.git synced 2025-12-09 23:34:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
icwmp/schemas/uci/cwmp.json
Suvendhu Hansa dc2cf6979d
Support list of IP for incoming connection request
2025-04-04 12:25:09 +00:00

417 lines
14 KiB
JSON
Raw Blame History

{
"cwmp": [
{
"section": "acs",
"description": "Configure the ACS parameters, used by icwmp",
"multi": false,
"options": [
{
"name": "url",
"type": "string",
"required": "yes",
"default": "",
"description": "URL of ACS server"
},
{
"name": "userid",
"type": "string",
"required": "no",
"default": "",
"description": "Username for ACS server connection"
},
{
"name": "passwd",
"type": "string",
"required": "no",
"default": "",
"description": "Password for ACS server connection"
},
{
"name": "periodic_inform_enable",
"type": "boolean",
"required": "no",
"default": "1",
"description": "If set to **1**, the CPE must periodically open session with ACS by sending Inform message to the ACS."
},
{
"name": "periodic_inform_interval",
"type": "uinteger",
"required": "no",
"default": "86400",
"description": "The duration in seconds of the interval for which the CPE must attempt to connect with the ACS and call the Inform method."
},
{
"name": "periodic_inform_time",
"type": "uinteger",
"required": "no",
"default": "",
"description": "An absolute time reference to determine when the CPE will initiate the periodic Inform method calls."
},
{
"name": "dhcp_discovery",
"type": "string",
"required": "no",
"default": "",
"description": "if set to **enable**, the CPE will get the url of ACS from DHCP server Option 43."
},
{
"name": "compression",
"type": "boolean",
"required": "no",
"default": "",
"description": "if set to **1**, the CPE must use the HTTP Compression when communicating with the ACS."
},
{
"name": "retry_min_wait_interval",
"type": "uinteger",
"required": "no",
"default": "5",
"description": "The minimum wait interval for session retry (in seconds)"
},
{
"name": "retry_interval_multiplier",
"type": "uinteger",
"required": "no",
"default": "2000",
"description": "The retry interval multiplier for session retry session as described in the standard."
},
{
"name": "ssl_capath",
"type": "string",
"required": "no",
"default": "",
"description": "The path of ssl certificates for TR-069 sessions."
},
{
"name": "insecure_enable",
"type": "boolean",
"required": "no",
"default": "",
"description": "if set to **1**, the CPE skips validation of the ACS certificates."
},
{
"name": "http_disable_100continue",
"type": "boolean",
"required": "no",
"default": "",
"description": "if set to **1**, disables the http 100 continue behaviour."
},
{
"name": "dhcp_url",
"type": "string",
"required": "no",
"default": "",
"description": "the **url** of ACS server received from the DHCP server via Option 43. This parameter is automatically updated by daemon, When **'dhcp_discovery'** option is enabled."
},
{
"name": "ip_version",
"type": "string",
"required": "no",
"default": "",
"description": "IP version of ConnectionRequestURL"
},
{
"name": "get_rpc_methods",
"type": "boolean",
"required": "no",
"default": "1",
"description": "Enable/Disable optional GetRPCMethods to ACS"
}
]
},
{
"section": "cpe",
"description": "CWMP client configuration",
"multi": false,
"options": [
{
"name": "enable",
"type": "boolean",
"required": "no",
"default": "1",
"description": "if set to **1**, the cwmp client will be enabled. "
},
{
"name": "client_cert_path",
"type": "string",
"required": "no",
"default": "",
"description": "Full path client perm certificate, icwmp will send this certificate to ACS server for authentication."
},
{
"name": "client_key_path",
"type": "string",
"required": "no",
"default": "",
"description": "Full path of client key pem file"
},
{
"name": "manufacturer",
"type": "string",
"required": "no",
"default": "",
"description": "Overwrite DeviceId parameter"
},
{
"name": "manufacturer_oui",
"type": "string",
"required": "no",
"default": "",
"description": "Overwrite DeviceId parameter"
},
{
"name": "product_class",
"type": "string",
"required": "no",
"default": "",
"description": "Overwrite DeviceId parameter"
},
{
"name": "serial_number",
"type": "string",
"required": "no",
"default": "",
"description": "Overwrite DeviceId parameter"
},
{
"name": "software_version",
"type": "string",
"required": "no",
"default": "",
"description": "Overwrite DeviceId parameter"
},
{
"name": "model_name",
"type": "string",
"required": "no",
"default": "",
"description": "Overwrite DeviceId parameter"
},
{
"name": "description",
"type": "string",
"required": "no",
"default": "",
"description": "Overwrite DeviceId parameter"
},
{
"name": "default_lan_interface",
"type": "string",
"required": "no",
"default": "lan",
"description": "Configure the default lan interface of the device."
},
{
"name": "default_wan_interface",
"type": "string",
"required": "yes",
"default": "wan",
"description": "Configure the default wan interface that will be used for IPv4/IPv6 connection."
},
{
"name": "interface",
"type": "string",
"required": "no",
"default": "",
"description": "Use this option to define l3 device ifname directly, if this option is used default_wan_interface shall be ignored"
},
{
"name": "use_curl_ifname",
"type": "boolean",
"required": "no",
"default": "false",
"description": "If this option is set, then cwmp shall use l3 device ifname as CURLOPT_INTERFACE"
},
{
"name": "log_to_console",
"type": "string",
"required": "no",
"default": "",
"description": "If set to **1**, the log messages will be shown in the console/stdout."
},
{
"name": "log_to_file",
"type": "string",
"required": "no",
"default": "",
"description": "If set to **1**, the log messages will be saved in the log file."
},
{
"name": "log_severity",
"type": "string",
"required": "no",
"default": "",
"description": "Specifies the log type to use, by default **'INFO'**. The possible types are **'EMERG', 'ALERT', 'CRITIC' ,'ERROR', 'WARNING', 'NOTICE', 'INFO' and 'DEBUG'**."
},
{
"name": "log_file_name",
"type": "string",
"required": "no",
"default": "/var/log/icwmpd.log",
"description": "Specifies the path of the log file, by default **'/var/log/icwmpd.log'**."
},
{
"name": "log_max_size",
"type": "uinteger",
"required": "no",
"default": "102400",
"description": "Size of the log file. The default value is **102400**."
},
{
"name": "userid",
"type": "string",
"required": "no",
"default": "",
"description": "The username of the device used in a connection request from ACS to CPE."
},
{
"name": "passwd",
"type": "string",
"required": "no",
"default": "",
"description": "The password of the device when sending a connection request from ACS to CPE."
},
{
"name": "port",
"type": "uinteger",
"required": "no",
"default": "7547",
"description": "The port allowed for incoming connection request."
},
{
"name": "allowed_cr_ip",
"type": "list",
"required": "no",
"default": null,
"description": "List of subnets or ips from where incoming connection requests are allowed e.g 10.2.1.0/24 or 10.2.1.5/32. So connection requests are allowed with SRC IP in range of '10.2.1.1 - 10.2.1.254' or from 10.2.1.5 and with dest port same as <B>port</B>. Empty value means only destination port will be used and connection requests on the valid port will be accepted irrespective of any src IP."
},
{
"name": "path",
"type": "string",
"required": "no",
"default": "/",
"description": "CPE Connection request URI path"
},
{
"name": "instance_mode",
"type": "string",
"required": "no",
"default": "InstanceNumber",
"description": "Configure the instance mode to use. Supported instance modes are : <B>InstanceNumber</B> and <B>InstanceAlias</B>."
},
{
"name": "provisioning_code",
"type": "string",
"required": "no",
"default": "",
"description": "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."
},
{
"name": "amd_version",
"type": "uinteger",
"required": "no",
"default": "5",
"description": "Configure the amendment version to use."
},
{
"name": "session_timeout",
"type": "uinteger",
"required": "no",
"default": "60",
"description": "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."
},
{
"name": "notification",
"type": "boolean",
"required": "no",
"default": "",
"description": "If set to **1**, it enables the notification feature."
},
{
"name": "exec_download",
"type": "boolean",
"required": "no",
"default": "",
"description": "If set to **1**, Specifies if Download method is executed."
},
{
"name": "log_to_syslog",
"type": "boolean",
"required": "no",
"default": "",
"description": "If set to **1**, the cwmp log will be appended to busybox syslog."
},
{
"name": "periodic_notify_enable",
"type": "boolean",
"required": "no",
"default": "1",
"description": "If set to **1**, icwmp will be able to detect parameter value change at any time."
},
{
"name": "periodic_notify_interval",
"type": "integer",
"required": "no",
"default": "10",
"description": "Interval in sec to check for value change notifications"
},
{
"name": "custom_notify_json",
"type": "string",
"required": "no",
"default": "",
"description": "Define absolute path of the JSON containing parameters on which notification get enabled as per the definition. See readme for examples."
},
{
"name": "force_ipv4",
"type": "boolean",
"required": "no",
"default": "",
"description": "If set to 1, it forces the connectivity over v4 IP address."
},
{
"name": "fw_upgrade_keep_settings",
"type": "boolean",
"required": "no",
"default": "1",
"description": "If set to **1**, icwmp will keep the uci setting while doing firmware upgrade using Download RPC with '1 Firmware Upgrade Image'."
},
{
"name": "disable_datatype_check",
"type": "boolean",
"required": "no",
"default": "0",
"description": "If set to **1**, icwmp will skip datatype validation on SPV operations."
}
]
},
{
"section": "lwn",
"description": "Lightweight notification configuration",
"multi": false,
"options": [
{
"name": "enable",
"type": "boolean",
"required": "no",
"default": "0",
"description": "if set to **1**, the Lightweight Notifications will be enabled. "
},
{
"name": "hostname",
"type": "host",
"required": "no",
"default": "ACS url",
"description": "The hostname or address to be used when sending the UDP Lightweight Notifications."
},
{
"name": "port",
"type": "port",
"required": "no",
"default": "7547",
"description": "The port number to be used when sending UDP Lightweight Notifications."
}
]
}
]
}
Reference in a new issue View git blame Copy permalink