{{docname|Device Data Model for TR-069}}
{{appdate|November 2015}}
{{trname|TR-181i2a10}}
* Added MQTT model
* Added DNS Server updates
* Added new diagnostics state
* Incorporated new components from TR-157 Amendment 10
{{noreference}}The value MUST be the path name of a row in a layer 1 interface table. If the layer 1 device isn’t known, then {{param}} will be {{null}}.
For example: ''Device.Ethernet.Interface.2''
The datetime when {{param|Active}} last changed from {{true}} to {{false}} or from {{false}} to {{true}}. The initial detection of a host SHOULD be treated as a transition from {{false}} to {{true}}, showing the datetime when the host was first detected.
The ability to list inactive hosts is OPTIONAL. The length of time an inactive host remains listed in this table is a local matter to the CPE.
MQTT Base object describing all MQTT related parameters and objects {{bibref|MQTT31}},
{{numentries}}
{{numentries}}
Indicates the MQTT capabilities of the device.
Indicates the supported protocol versions. {{enum}}
Protocol according to {{bibref|MQTT31}}
Protocol according to {{bibref|MQTT311}}
Indicates the supported transport protocols. {{enum}}
Indicates the maximum number of subscriptions per MQTT client, which can be stored in the {{object|#.Client.{i}.Subscription}} table. A value of 0 means no limit.
Indicates the maximum number of bridges, which can be configured in the {{object|#.Broker.{i}.Bridge}} table. A value of 0 means no limit.
Indicates the maximum number of subscriptions, which can be stored per bridge instance in the {{object|#.Broker.{i}.Bridge.{i}.Subscription}} table. A value of 0 means no limit.
MQTT client table. Contains a list of configured MQTT clients.
{{datatype|expand}}
The textual name of the MQTT client.
Allows to enable or disable the MQTT client.
If a MQTT client gets enabled then the MQTT client has first to establish a MQTT broker session and then subscribe for all enabled topics in the {{object|Subscription.}} table. In case the {{param|CleanSession}} is set to {{false}} a subscription MUST only be sent for topics which haven't been subscribed before (see {{bibref|MQTT311|3.1.2.4}}).
If a connected MQTT client gets disabled ({{param|Status}} is either {{enum|Connecting|Status}} or {{enum|Connected|Status}}) then the MQTT client has to send a MQTT DISCONNECT message to disconnect from the MQTT broker ({{bibref|MQTT31|3.14}} or {{bibref|MQTT311|3.14}}), before setting the {{param|Status}} to {{enum|Disabled|Status}}.
Indicates the status of this MQTT client. {{enum}}
The {{enum|Error_Misconfigured}} value indicates that a necessary configuration value is undefined or invalid (e.g. The MQTT client can not use the defined port, because it is blocked)
The {{enum|Error_BrokerUnreachable}} value indicates that the connection to the MQTT broker could not be established.
The {{enum|Error}} value MAY be used by the CPE to indicate a locally defined error condition.
The MQTT client identifier used in the CONNECT message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.1}}). This parameter MUST NOT be {{empty}}, the CPE has to provide a default value for the parameter, which can be changed by the ACS.
A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well.
Username used to authenticate the CPE when making a connection to the MQTT broker. {{bibref|MQTT31|3.1}} recommends that the username has 12 characters or fewer, but this is not required.
If this parameter is {{empty}} no authentication parameters are sent in the MQTT CONNECT message.
Password used to authenticate the CPE when making a connection to the MQTT broker (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.4}}).
This password is only sent in the MQTT CONNECT message if {{param|Username}} is not {{empty}}.
Indicates the transport protocol to be used for the MQTT broker connection.
Specifies the MQTT protocol version used in the communication with the MQTT broker.
The value of the MQTT clean session flag in the MQTT CONNECT message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.4}}). If this flag is set to {{true}} (default), the MQTT broker will delete all subscription information after a Disconnect.
A change of this parameter is only effective after the next MQTT CONNECT message to the MQTT broker. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well.
Message retry time in {{units}} defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see {{bibref|MQTT31|4.2}} and {{bibref|MQTT311|4.4}}).
Connect retry time in {{units}} defines the wait time before a failed MQTT broker connection is retried.
A failure can either be on the connection level (the TCP/IP or TLS can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK message on a MQTT CONNECT message sent.
Keep Alive Time in {{units}} defines the maximum wait time after which a message has to be sent to the MQTT broker (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.10}}). If no regular messages can be sent a MQTT PINGREQ is sent.
A value of zero (0) means no keep alive message are sent and the MQTT client is not disconnected by the server.
A change of this parameter is only effective after the next MQTT CONNECT message to the MQTT broker. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well.
Disconnects the MQTT client from the MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT client is currently connected to the MQTT broker (Parameter {{param|Status|}} is {{enum|Connected|Status}}).
If the MQTT client is in a different state, the parameter has no effect.
This action parameter may be used to immediately apply changes in the MQTT connection settings.
Host name or IP address of the MQTT Broker.
Port number of the MQTT broker.
Enables or disables the will handling (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.5}}).. Changing this parameter while the MQTT client is connected will cause the client to disconnect and reconnect.
If the connection gets enabled and this parameter is set to {{true}} and either the parameter {{param|WillTopic}} or {{param|WillValue}} are {{empty}}, the CPE MUST set the {{param|Status}} to {{enum|Error_Misconfigured|Status}} (see {{bibref|MQTT311|3.1.2.5}}).
The Topic sent in the Will Message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.5}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}.
A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message.
If the will handling is enabled (Paramter {{param|WillEnable}} is set to {{true}}) and the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well.
The value sent in the Will Message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.5}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}.
A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message.
If the will handling is enabled (Paramter {{param|WillEnable}} is set to {{true}}) and the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well.
The MQTT QoS level assigned with the will message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.6}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}.
A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message.
If the will handling is enabled (Paramter {{param|WillEnable}} is set to {{true}}) and the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well.
Indicate to the MQTT broker to retain the Will over a Disconnect (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.7}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}.
A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message.
If the will handling is enabled (Paramter {{param|WillEnable}} is set to {{true}}) and the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well.
{{numentries}}
List of MQTT subscriptions handled by the MQTT client.
The MQTT client MUST subscribe with the MQTT broker for all subscription instances, whose parameter {{param|Enable}} is set to {{true}}, when it establishes a new connection to the MQTT broker. Disabled subscription instances with {{param|Enable}} set to {{false}} will be ignored during connection establishment.
{{datatype|expand}}
Setting Enable to {{true}} means the topic is subscribed at the MQTT broker with a MQTT SUBSCRIBE message, setting it to {{false}} will unsubscribe the topic from the MQTT broker with a MQTT UNSUBSCRIBE message. If the MQTT client is already connected with the Broker ({{param|#.Status}} is {{enum|Connected|#.Status}}), the MQTT SUBSCRIBE or UNSUBSCRIBE message is sent directly, otherwise it is sent after the next successful connect.
The actual status of the subscription is indicated with {{param|Status}}.
Indicates the status of this subscription. {{enum}}
The {{enum|Subscribed}} value indicates that the topic was successfully subscribed with the MQTT broker, the MQTT client received the SUBACK message for this topic from the server.
The {{enum|Subscribing}} value MAY be used by the CPE to indicate that the a SUBSCRIBE message for this topic was sent, and the CPE is waiting for a SUBACK message.
The {{enum|Unsubscribed}} value indicates that the topic is not reqistered with the MQTT broker.
The {{enum|Unsubscribing}} value MAY be used by the CPE to indicate that the an UNSUBSCRIBE message for this topic was sent, and the CPE is waiting for an UNSUBACK message.
If the {{param|Enable}} is set to {{false}} the status MUST be either {{enum|Unsubscribed}} or if the unsubscription failed {{enum|Error}}.
Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in {{bibref|MQTT31|Appendix A}} and {{bibref|MQTT311|4.7}}.
The MQTT QoS level assigned with the subscription (see {{bibref|MQTT31|4.1}} and {{bibref|MQTT311|4.3}}).
Contains the MQTT client statistics and usage information.
The CPE MUST reset the Stats parameters after the MQTT client gets (re-)enabled or if the MQTT client connects with a new MQTT broker (e.g. {{param|#.BrokerAddress}} has changed). The CPE MAY retain the values across a reboot if it reconnects with the same MQTT broker.
Time when the MQTT broker connection was established.
Time when the last publish message was sent to the MQTT broker.
Time when the last publish message was received from the MQTT broker.
Number of publish messages sent to the MQTT broker.
Number of publish messages received from to the MQTT broker.
Number of subscribe messages sent to the MQTT broker.
Number of unsubscribe messages sent to the MQTT broker.
Total number of MQTT messages sent to the MQTT broker.
Total number of MQTT messages received from the MQTT broker.
Number of connection errors.
Number of errors which prevented sending publish messages.
MQTT broker table. Contains a list of configured MQTT brokers.
{{datatype|expand}}
The textual name of the MQTT broker.
Allows to enable or disable the MQTT broker.
Indicates the status of the MQTT broker. {{enum}}
The "{{enum|Error_Misconfigured}}" value indicates that a necessary configuration value is undefined or invalid.
The "{{enum|Error}}" value MAY be used by the CPE to indicate a locally defined error condition.
Port used by the MQTT Broker.
If {{empty}} is specified, the CPE MUST bind the MQTT broker to all available interfaces.
Username used to authenticate the MQTT clients, which connect to the MQTT broker.
If this parameter is {{empty}} no authentication is used.
Password used used to authenticate the MQTT clients, which connect to the MQTT broker.
This password is only used if {{param|Username}} is not {{empty}}.
{{numentries}}
Configures MQTT bridges, which are used to communicate with other MQTT brokers.
{{datatype|expand}}
The textual name of the MQTT bridge used for identification.
Allows to enable or disable the MQTT Bridge.
Indicates the status of this MQTT Bridge. {{enum}}
The {{enum|Disabled}} value indicates that the MQTT bridge is not in service; parameter {{param|Enable}} is set to {{false}}.
The {{enum|Connecting}} value indicates that the MQTT bridge is currently established.
The {{enum|Connected}} value indicates that the MQTT bridge is currently active.
The {{enum|Error_Misconfigured}} value indicates that a necessary configuration value is undefined or invalid (e.g. No active Server entry, the MQTT broker can not use the defined bridge port, because it is blocked)
The {{enum|Error_BrokerUnreachable}} value indicates that the MQTT bridge connection to the remote MQTT broker could not be established.
The {{enum|Error}} value MAY be used to indicate a locally defined error condition.
The MQTT client identifier used in the CONNECT message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.1}}). This parameter MUST NOT be {{empty}}, the CPE has to provide a default value for the parameter, which may be changed by the ACS.
A change of this parameter is only communicated to the remote MQTT broker with the next MQTT CONNECT message. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well.
Username used to authenticate the MQTT broker when making a connection over the MQTT bridge (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.4}}). {{bibref|MQTT31|3.1}} recommends that the username has 12 characters or fewer, but this is not required.
If this parameter is {{empty}} no authentication parameters are sent in the MQTT CONNECT message.
Password used to authenticate the MQTT broker when making a connection over the MQTT bridge (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.4}}).
The password is only sent if {{param|Username}} is not {{empty}}.
Indicates the transport protocol to be used for the MQTT bridge connection.
Specifies the MQTT protocol version used in the MQTT bridge connection.
The value of the MQTT clean session flag in the MQTT bridge connection (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.4}}). If this flag is set to {{true}} (default), the remote MQTT broker will delete all subscription information after a Disconnect.
A change of this parameter is only effective after the next MQTT CONNECT message to the remote MQTT broker. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well.
Message retry time in {{units}} defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see {{bibref|MQTT31|4.2}} and {{bibref|MQTT311|4.4}}).
Connect retry time in {{units}} defines the wait time before a failed bridge connection is retried.
A failure can either be on the connection level (e.g. the TCP/IP or TLS conection can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK message on a MQTT CONNECT message sent.
Keep Alive Time in {{units}} defines the maximum wait time after which a message has to be sent to the remote MQTT broker (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.10}}). If no regular messages can be sent a MQTT PINGREQ is sent.
A value of zero (0) means no keep alive message are sent and the bridge is not disconnected by the server.
A change of this parameter is only effective after the next MQTT CONNECT message to the remote MQTT broker. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well.
Disconnects the MQTT bridge to the remote MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT bridge is currently connected to the remote MQTT broker (Parameter {{param|Status|}} is {{enum|Connected|Status}}).
If the MQTT bridge is in a different state, the parameter has no effect.
This action parameter may be used to immediately apply changes in the MQTT connection settings.
The algorithm used to select a server entry from the {{object|Server}} table
Select the server from the {{object|Server.}} table according to the sequence defined with the {{param|Server.{i}.Priority}} and {{param|Server.{i}.Weight}} values.
Select the servers round robin.
Select the servers randomly.
{{reference|the {{object|Server.}} instance that is used for this {{object}}, while the {{param|Status}} is {{enum|Connecting|Status}} or {{enum|Connected|Status}}. If the MQTT bridge is not connected the value MUST be an empty string}}
{{numentries}}
{{numentries}}
Each {{object}} instance represents a MQTT bridge server to be used for a {{object|##.Bridge}}. A remote MQTT broker, which is connected by a MQTT bridge can be reachable via several host addresses each represented by its own {{object}} table entry. For an active MQTT bridge at least one enabled entry has to exist.
If a MQTT bridge gets enabled by setting the parameter {{param|##.Bridge.{i}.Enable}} to {{true}}, which either has an empty {{object}} table or the {{object}} table only contains instances whose {{param|Enable}} is set to {{false}}, the {{param|##.Bridge.{i}.Status}} has to be set to {{enum|Error_Misconfigured|##.Bridge.{i}.Status}}.
Any attempt to delete an instance, which is currently in use ({{param|##.Bridge.{i}.ServerConnection}} refers to the instance to be deleted), has to be rejected.
Enables or disables this {{object}}.
{{datatype|expand}}
The priority of this {{object}} that is used by the {{object|##.Bridge}} when determining the {{object}} to connect to. The {{object|##.Bridge}} MUST contact the {{object}} with the lowest-numbered priority that the {{object|##.Bridge}} can reach as defined in {{bibref|RFC2782}}. The selection of {{object}}s with the same {{param}} value utilizes the {{param|Weight}} parameter to determine which {{object}} is selected by the {{object|##.Bridge}}.
This value is only used if {{param|##.Bridge.{i}.ServerSelectionAlgorithm}} is set to {{enum|Priority|##.Bridge.{i}.ServerSelectionAlgorithm}}.
This parameter specifies a relative weight for entries with the same {{param|Priority}}. The mechanism is defined in {{bibref|RFC2782}}. A value of -1 indicates that the implementation of this parameter is specific to the Vendor.
This value is only used if {{param|##.Bridge.{i}.ServerSelectionAlgorithm}} is set to {{enum|Priority|##.Bridge.{i}.ServerSelectionAlgorithm}}.
Fully Qualified Domain Name (FQDN) or IP address of the MQTT broker server this {{object|##.Bridge}} connects to.
If the value of this parameter is a FQDN that resolves to multiple addresses then each address SHOULD be attempted (in an implementation-specific order) until a connection can be made or all addresses are exhausted, in which case the next {{object}} instance (based on rules defined over the selected {{param|##.Bridge.{i}.ServerSelectionAlgorithm}}) SHOULD be used.
Port number of the MQTT broker server this {{object|##.Bridge}} connects to.
List of MQTT subscriptions handled over the bridge.
{{datatype|expand}}
Setting Enable to {{true}} activates the handling of this subscription instance. In case of incoming directions ({{param|Direction}} is either {{enum|in|Direction}} or {{enum|both|Direction}}) the topic is subscribed over the bridge at the remote MQTT broker with a MQTT SUBSCRIBE message if {{param}} is set to {{true}} or unsubscribed from the remote MQTT broker with a MQTT UNSUBSCRIBE message if the value is set to {{false}}.
The actual status of the subscription is indicated with {{param|Status}}.
Indicates the status of this subscription. {{enum}}
The {{enum|Enabled}} value indicates that the this subscription is active. In case of incoming directions ({{param|Direction}} is either {{enum|in|Direction}} or {{enum|both|Direction}}) the topic was successfully subscribed with the remote MQTT broker.
The {{enum|Disabled}} value indicates that this subscription is not used.
The {{enum|Error}} value indicates that an error occured (e.g. an subscription could not be made with the remote MQTT broker) and the subscription is not in use.
Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in {{bibref|MQTT31|Appendix A}} and {{bibref|MQTT311|4.7}}.
The direction of the subscription. {{enum}}.
Indicates that all matching topics will be sent over the bridge to the next MQTT broker.
Indicates that all matching topics will be received over the bridge from the next MQTT broker.
Indicates that all matching topics will be sent and received over the bridge.
The MQTT QoS level assigned with the subscription (see {{bibref|MQTT31|4.1}} and {{bibref|MQTT311|4.3}}).
The local prefix is used for remapping received topics to the local topics of the MQTT broker and to select the topics to be sent over bridge to the remote MQTT broker.
* In incoming direction ({{param|Direction}} is either {{enum|in|Direction}} or {{enum|both|Direction}}):
: For remote topics received over the bridge the MQTT broker adds the LocalPrefix in front of the received topic, before processing it.
:: '' ''
: ''Example:''
:: Topic is "/bus/+", LocalPrefix is "/local", Direction is "in"
:: MQTT broker receives message with topic "/bus/tr181" over bridge => MQTT broker uses topic "/local/bus/tr181" for internal processing
* In outgoing direction ({{param|Direction}} is either {{enum|out|Direction}} or {{enum|both|Direction}}):
: For selection of the topics to be sent over the bridge the MQTT broker uses the combination of {{param}} and {{param|Topic}} to match the topics to be sent over bridge, and removes the {{param}} from the selected topic before sending it over the bridge.
:: '' ''
: ''Example:''
:: Topic is "/bus/+", LocalPrefix is "/local", Direction is "out"
:: MQTT broker receives message with topic "/local/bus/tr181" from a MQTT client => MQTT broker sends topic "/bus/tr181" to remote MQTT broker
The remote prefix is used for remapping topics to the remote MQTT broker topic lists.
* In incoming direction ({{param|Direction}} is either {{enum|in|Direction}} or {{enum|both|Direction}}):
: For remote topics received over the bridge the MQTT broker removes the remote prefix topic from the received topic (before handling the {{param|LocalPrefix}}), before processing it.
:: '' ''
: ''Example:''
:: Topic is "/bus/+", LocalPrefix is "/local", RemotePrefix is "/remote", Direction is "in"
:: MQTT broker receives message with topic "/remote/bus/tr181" over bridge => MQTT broker uses topic "/local/bus/tr181" for internal processing
: During activation of the bridge, the MQTT broker prepends the {{param|Topic}} with {{param}} topic and subscribes to the remote MQTT broker with it, in order to receive all applicable remote topics.
:: '' ''
: ''Example:''
:: Topic is "/bus/+", RemotePrefix is "/remote", Direction is "in"
:: MQTT broker sends a subscription to the remote MQTT broker with the topic "/remote/bus/+".
* In outgoing direction ({{param|Direction}} is either {{enum|out|Direction}} or {{enum|both|Direction}}):
: For all topics to be sent over the bridge ({{param|Direction}} is either {{enum|out|Direction}} or {{enum|both|Direction}}), the RemotePrefix will be prepended to the topic after the {{param|LocalPrefix}} has been processed and before sending the message over the bridge.
:: '' ''
: ''Example:''
:: Topic is "/bus/+", LocalPrefix is "/local", RemotePrefix is "/remote" Direction is "out"
:: MQTT broker receives message with topic "/local/bus/tr181" from a MQTT client => MQTT broker sends topic "/remote/bus/tr181" to remote MQTT broker
The MQTT broker statistics values. These will reset with each MQTT broker start, either after reboot or if the MQTT broker gets (re-)enabled.
Total number of MQTT clients registered with the MQTT broker.
Number of MQTT clients, which have a connection with the MQTT broker established.
Number of MQTT clients, which have no connection with the MQTT broker established.
Number of subscriptions held by the MQTT broker.
Number of publish messages sent by the MQTT broker.
Number of publish messages received by the MQTT broker.
Total number of MQTT messages sent by the MQTT broker.
Total number of MQTT messages received by the MQTT broker.
Number of connection errors.
Number of errors which prevented sending publish messages
{{datatype|expand}}
{{datatype|expand}}
{{datatype|expand}}
{{datatype|expand}}
{{datatype|expand}}
{{datatype|expand}}
{{datatype|expand}}
{{datatype|expand}}
{{datatype|expand}}
{{datatype|expand}}
The operating standard that this associated device is connected with.
{{bibref|802.11a-1999}}
{{bibref|802.11b-1999}}
{{bibref|802.11g-2003}}
{{bibref|802.11n-2009}}
{{bibref|802.11ac-2013}}
The Mapping of Address and Port (MAP) object {{bibref|RFC7597}} {{bibref|RFC7599}} {{bibref|RFC7598}}. This object applies only to gateway devices that support IPv4 on the LAN side, include a {{object|#.NAT}}, and typically have only IPv6 connectivity on the WAN side.
See the MAP Theory of Operation {{bibref|TR-181i2a8|Appendix XV}} for a description of the working of this MAP data model.
MAP domain settings {{bibref|RFC7597}} {{bibref|RFC7599}}. Each instance models a MAP domain.
MAP supports two transport modes, both of which use NAPT44 (modified to use a restricted port range):
* MAP-E ({{param|TransportMode}} = {{enum|Encapsulation|TransportMode}}) uses an IPv4-in-IPv6 tunnel.
* MAP-T ({{param|TransportMode}} = {{enum|Translation|TransportMode}}) uses stateless NAT64.
Note: There is an n:1 relationship between a MAP domain and the associated {{param|WANInterface}}, i.e. in theory multiple MAP domains can be associated with a single WAN IP interface (each domain would have its own ''End-user IPv6 prefix'' and ''MAP IPv6 address'').
Note: The {{object}} table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to {{empty}}. However, doing so under these circumstances might cause the updated {{object}} row to then violate the table's unique key constraint; if this occurs, the CPE MUST set {{param|Status}} to {{enum|Error_Misconfigured|Status}} and disable the offending {{object}} row.
The transport mode to use.
Corresponds to the {{bibref|RFC7598}} ''S46_CONT_MAPE'' and ''S46_CONT_MAPT'' container options.
MAP-E {{bibref|RFC7597}}
MAP-T {{bibref|RFC7599}}
The MAP Border Relay (BR) address or prefix.
* For MAP-E this is the BR address and therefore MUST be a /128 {{bibref|RFC7597}}. Note this address can be an IPv6 anycast address. This address corresponds to the {{bibref|RFC7598}} ''OPTION_S46_BR'' (Border Relay) option.
* For MAP-T this is the BR prefix {{bibref|RFC7599}}. This address prefix corresponds to the {{bibref|RFC7598}} ''OPTION_S46_DMR'' (Default Mapping Rule) option.
Note: There will be a corresponding {{object|.Routing.Router.{i}.IPv4Forwarding}} default rule.
''Port-set ID'' (PSID) offset in {{units}}. The number of Port-sets is 2^{{param}}.
Corresponds to the {{bibref|RFC7598}} ''S46_PORTPARAMS'' (Port Parameters) option's ''offset'' field.
The length in {{units}} of the ''Port-set id'' (PSID) configured in the {{param|PSID}} parameter.
Corresponds to the {{bibref|RFC7598}} ''S46_PORTPARAMS'' (Port Parameters) option's ''PSID-len'' field.
''Port-set ID'' (PSID) to use in preference to the value extracted from the ''Embedded Address'' (EA) bits.
Only the high order {{param|PSIDLength}} bits of the {{param}} value are used, so the parameter is ignored when {{param|PSIDLength}} is zero.
Corresponds to the {{bibref|RFC7598}} ''S46_PORTPARAMS'' (Port Parameters) option's ''PSID'' field.
Whether to include low-numbered (system) ports in the Port-sets. Normally ports in the range [0:2^(16-{{param|PSIDOffset}})-1] are excluded, e.g. for the default {{param|PSIDOffset}} value of 4, ports [0:4095] are not included in the Port-sets.
This parameter is related to {{bibref|RFC7597}}'s ''N'', which is defined as ''the number of ports (e.g., 1024) excluded from the lower end of the range''. The parameter is relevant only when {{param|PSIDOffset}} is 0; {{false}} corresponds to ''N=1024'' and {{true}} corresponds to ''N=0''.
The MAP domain's Mapping Rules {{bibref|RFC7597}}. The rule with the longest match between its {{param|IPv6Prefix}} and the end-user {{param|#.IPv6Prefix}} is the Basic Mapping Rule (BMR). Any of the rules (including the BMR) can be a Forwarding Mapping Rule.
Created via a {{bibref|RFC7598}} ''S46_RULE'' option.
Present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI)
The ''Rule IPv6 prefix''.
The Rule IPv6 prefix is a leading part of the end-user {{param|#.IPv6Prefix}}, i.e. its length MUST be less than or equal to the length of the end-user ''IPv6Prefix'', and it MUST match the end-user ''IPv6Prefix''.
Corresponds to the {{bibref|RFC7598}} ''S46_RULE'' option's ''ipv6-prefix'' field.
The ''Rule IPv4 prefix''.
Corresponds to the {{bibref|RFC7598}} ''S46_RULE'' option's ''ipv4-prefix'' field.
The length in {{units}} of the ''Embedded Address (EA) bits'' in the end-user {{param|#.IPv6Prefix}}.
Corresponds to the {{bibref|RFC7598}} ''S46_RULE'' option's ''ea-len'' field.
Indicates whether this rule is a ''Forwarding Mapping Rule'' (FMR), i.e. can be used for forwarding.
Corresponds to the {{bibref|RFC7598}} ''S46_RULE'' option's ''flags'' field's ''F-Flag''.
NAT enabled but forced by a third party to be operationally disabled, e.g. because a {{object|##.MAP.Domain}} is enabled but there is no Basic Mapping Rule {{bibref|RFC7597}}.
NAT enabled but port mapping has been operationally disabled by a third party, e.g. because this is REQUIRED by the current {{object|##.Firewall}} level.
Assigned by MAP {{bibref|RFC7597}}, i.e. is this interface's ''MAP IPv6 address''
An absolute date and time in UTC at which time the CPE will perform a reboot.
If a CWMP session is in progress at the specified time, the CPE MUST wait until the session has ended before performing the reboot.
If the value specifies a date and time that has already passed (i.e., a past date and time), no reboot will be performed.
The number of seconds from the time the CWMP session in which this parameter value is set is ended until the CPE performs a reboot.
Whenever the CPE reboots, this value MUST be reset by the CPE to -1.
Properties for Dynamic DNS.
{{numentries}}
{{numentries}}
List of Dynamic DNS service names that are supported by the CPE.
Client properties for Dynamic DNS.
A dynamic DNS client is responsible for verifying IP address changes and updating information from a subscribed account on a Dynamic DNS Server.
For enabled table entries, if {{param|Server}} is not a valid reference then the table entry is inoperable and the CPE MUST set the {{param|Status}} to {{enum|Error_Misconfigured|Status}}.
Enables or disables this Dynamic DNS Client.
Status of this Dynamic DNS Client.
The Dynamic DNS Client is trying to connect to the Server.
The Dynamic DNS Client is in the authentication phase.
The Dynamic DNS Client has performed an update request since the last IP address change.
Error due to configuration.
An error has occurred during the communication with the Server. The {{param|LastError}} parameter is updated with the detail of this error.
The Client is disabled.
{{datatype|expand}}
The last error this Dynamic DNS Client has encountered.
The parameter MAY instead indicate a vendor-specific cause, which MUST use the format defined in {{bibref|TR-106}}.
The DynamicDNS server associated with this Dynamic DNS Client.
{{reference}}
The IP interface over which update queries to the server are sent.
{{reference}}
If an empty string is specified, the CPE MUST use its routing policy (Forwarding table entries), to determine the appropriate interface.
Username used by this Dynamic DNS Client to authenticate with the Server.
Password used by this Dynamic DNS Client to authenticate with the Server.
{{numentries}}
Each table entry represents a fully qualified domain name updated by this Dynamic DNS Client.
Enables or disables this Hostname.
Status of this Hostname.
The Hostname has been updated with the current IP address.
The IP address has changed since last update.
The Client is trying to update this Hostname.
The Hostname doesn't exist for this Dynamic DNS account.
The Hostname is disabled.
Fully qualified domain name that has to be updated with the IP address.
If the name is set to another value, the Client MUST immediately send an update request to the Server.
The date time of the last successful update of this name to the Dynamic DNS Server.
Table of Dynamic DNS servers available for this CPE.
Enables or disables Dynamic DNS Server.
The textual name of the Dynamic DNS Server.
{{datatype|expand}}
Dynamic DNS service used to contact this server.
{{reference}}
Host name or IP address of the Dynamic DNS server.
Port number of the Dynamic DNS server.
Indicates the protocols that are supported by the CPE for sending requests to the Dynamic DNS server. {{list}} This list depends on the Dynamic DNS service defined by the {{param|ServiceName}} parameter.
As defined in {{bibref|RFC2616}}
As defined in {{bibref|RFC2818}}
Indicates the protocol used to send requests to the Dynamic DNS server.
Interval (in {{units}}) between two checks for IP change.
A value of zero indicates that the CPE knows when IP changes and doesn’t need to check it periodically.
Initial retry interval (in {{units}}) after a failed request. This parameter can be used as a fixed value or as part of a retry interval calculation.
Maximum number of retries after a failed request. When the maximum number is reached, no further requests are sent until the context changes.
A value of 0 means that there are no retries after a failed request.
Provides basic MQTT client control and statistics
Adds client authentication, will handling and extends statistics
Adds client subscription control and access to received topics
Provides basic MQTT broker control and statistics
Adds client authentication and extends statistics
Adds parameters for MQTT network interconnection with Bridges