mirror/icwmp
1
0
Fork 0
mirror of https://dev.iopsys.eu/bbf/icwmp.git synced 2026-01-28 01:27:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
icwmp/schemas/uci/cwmp.json
vdutta 6a2ea866f3 Updated uci schema for firewall entry
2021-09-17 11:01:22 +01:00

333 lines
11 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": "",
"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": "",
"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": "",
"description": "The minimum wait interval for session retry (in seconds)"
},
{
"name": "retry_interval_multiplier",
"type": "uinteger",
"required": "no",
"default": "",
"description": "The retry interval multiplier for session retry session as described in the standard."
},
{
"name": "https_ssl_capath",
"type": "string",
"required": "no",
"default": "",
"description": "The path of ssl certificates. ssl certificates used for Upload and Download methods."
},
{
"name": "ipv6_enable",
"type": "boolean",
"required": "no",
"default": "",
"description": "Enables IPv6 in cwmp"
},
{
"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"
}
]
},
{
"section": "cpe",
"description": "CWMP client configuration",
"multi": false,
"options": [
{
"name": "interface",
"type": "string",
"required": "no",
"default": "",
"description": "Configure the Layer3 device interface name to use for connecting to ACS."
},
{
"name": "default_wan_interface",
"type": "string",
"required": "no",
"default": "",
"description": "Configure the default wan interface of the device."
},
{
"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": "",
"description": "The port used for connection request."
},
{
"name": "ubus_socket",
"type": "string",
"required": "no",
"default": "NULL",
"description": "Specifies the path of the ubus socket."
},
{
"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": "instance_mode",
"type": "string",
"required": "no",
"default": "InstanceNumber",
"description": "Configure the instance mode to use. Supported instance modes are : <B>InstanceNumber</B> and <B>InstanceNumber</B>."
},
{
"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": "",
"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": "forced_inform_json",
"type": "string",
"required": "no",
"default": "",
"description": "Define absolute path for the JSON containing additional parameters as forced inform parameter. See readme for examples."
},
{
"name": "boot_inform_json",
"type": "string",
"required": "no",
"default": "",
"description": "Define absolute path for the JSON containing additional parameters as boot inform parameter. These parameters only gets added if the notify event is '0 Bootstrap' or '1 Boot'. To enable value change notification, please use custom_notify_json, See readme for examples."
},
{
"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": "incoming_rule",
"type": "string",
"required": "no",
"default": "",
"description": "This configure firewall rules. Allowed values <IP_Only/Port_Only/IP_Port>. IP_Only means only acs ip as source ip used for firewall input rule, Port_Only means only destination port will be used and IP_Port or empty value meaning both ip and port will be used for firewall input rule."
}
]
},
{
"section": "lwn",
"description": "Lightweight notification configuration",
"multi": false,
"options": [
{
"name": "enable",
"type": "boolean",
"required": "no",
"default": "",
"description": "if set to **1**, the Lightweight Notifications will be enabled. "
},
{
"name": "hostname",
"type": "host",
"required": "no",
"default": "",
"description": "The hostname or address to be used when sending the UDP Lightweight Notifications."
},
{
"name": "port",
"type": "port",
"required": "no",
"default": "",
"description": "The port number to be used when sending UDP Lightweight Notifications."
}
]
}
]
}
Reference in a new issue View git blame Copy permalink