diff --git a/test/tools/00-tr-181-2-19-1-cwmp-full.xml b/test/tools/00-tr-181-2-20-1-cwmp-full.xml similarity index 94% rename from test/tools/00-tr-181-2-19-1-cwmp-full.xml rename to test/tools/00-tr-181-2-20-1-cwmp-full.xml index ce3200f8..ee01d772 100644 --- a/test/tools/00-tr-181-2-19-1-cwmp-full.xml +++ b/test/tools/00-tr-181-2-20-1-cwmp-full.xml @@ -51,16 +51,16 @@ --> + spec="urn:broadband-forum-org:tr-181-2-20-1-cwmp" + file="tr-181-2-20-1-cwmp.xml"> @@ -1139,6 +1139,15 @@ 3GPP SA WG2 https://www.3gpp.org/ftp/Specs/html-info/23501.htm + + 3GPP TS 23.503 + + Policy and charging control framework for the 5G System (5GS); Stage 2 + + 3GPP CT WG4 + 2019 + https://www.3gpp.org/ftp/Specs/html-info/23503.htm + 3GPP TS 24.008 @@ -1186,6 +1195,16 @@ <category>Technical specification</category> <hyperlink>https://www.3gpp.org/ftp/Specs/html-info/24007.htm</hyperlink> </reference> + <reference id="3GPP-TS.31.101"> + <name>3GPP TS 31.101 (v17.1.0)</name> + <title> + UICC-terminal interface; Physical and logical characteristics + + 3GPP + + https://www.3gpp.org/ftp/Specs/archive/31_series/31.101/31101-h10.zip + + 3GPP TS 31.102 Characteristics of the USIM application @@ -1733,6 +1752,13 @@ 2011 https://www.itu.int/rec/T-REC-G.9973-201110-I/en + + G.Sup45 + Power conservation in optical access systems + ITU-T + September 2022 + https://www.itu.int/rec/T-REC-G.Sup45/en + G.9701 @@ -3267,7 +3293,7 @@ <name>JJ-300.00</name> <title>Home-network Topology Identifying Protocol TTC - 2011 + 2017 https://www.ttc.or.jp/application/files/1115/5443/0461/JJ-300.00Ev3.pdf @@ -3276,9 +3302,9 @@ JJ-300.01 The List of Device Categories TTC - 2011 + 2018 - https://www.ttc.or.jp/application/files/1115/5443/0461/JJ-300.00Ev3.pdf + https://www.ttc.or.jp/application/files/8315/5443/0461/JJ-300.01Ev2.1.pdf @@ -3534,6 +3560,10 @@ + + - + @@ -3847,7 +3935,7 @@ - + @@ -3889,14 +3977,14 @@ A {{object|Device.|absolute}} Event that was the result of a reboot triggered locally on the Device (NOT as a result - of a {{command|.Reboot()|model}}}} Command triggered by a + of a {{command|.Reboot()|model}} Command triggered by a remote trigger, e.g. another remote management protocol) A {{object|Device.|absolute}} Event that was the result of - a reboot triggered via the {{command|.Reboot()|model}}} + a reboot triggered via the {{command|.Reboot()|model}} Command or other remote trigger, e.g. another remote management protocol @@ -3944,14 +4032,14 @@ A {{object|Device.|absolute}} Event that was the result of a reboot triggered locally on the Device (NOT as a result of a - {{command|.Reboot()|model}}}} Command triggered by a remote + {{command|.Reboot()|model}} Command triggered by a remote trigger, e.g. another remote management protocol) A {{object|Device.|absolute}} Event that was the result of a - reboot triggered via the {{command|.Reboot()|model}}} Command + reboot triggered via the {{command|.Reboot()|model}} Command or other remote trigger, e.g. another remote management protocol @@ -3960,7 +4048,7 @@ A {{object|Device.|absolute}} Event that was the result of a factory reset triggered locally on the Device or remotely (as - a result of a {{command|.FactoryReset()|model}}} Command or + a result of a {{command|.FactoryReset()|model}} Command or other remote trigger, e.g. another remote management protocol), which is to be used when the Agent cannot differentiate between local and remote @@ -3970,7 +4058,7 @@ A {{object|Device.|absolute}} Event that was the result of a factory reset triggered locally on the Device (NOT as a - result of a {{command|.FactoryReset()|model}}} Command + result of a {{command|.FactoryReset()|model}} Command triggered by a remote trigger, e.g. another remote management protocol) @@ -4038,7 +4126,7 @@ A {{object|Device.|absolute}} Event that was the result of a factory reset triggered locally on the Device (NOT as a - result of a {{command|.FactoryReset()|model}}} Command + result of a {{command|.FactoryReset()|model}} Command trigger by a remote trigger, e.g. another remote management protocol) @@ -4697,13 +4785,15 @@ + version="2.12" status="obsoleted"> {{numentries}} {{deprecated|2.18|because the only contained parameter, {{param|Processor.{i}.Architecture}}, is no longer relevant for modern devices.}} + + {{obsoleted|2.20}} @@ -4936,11 +5026,15 @@ - + Username to be used by the Agent to authenticate with the file - server. This string is set to {{empty}} if no authentication is - required. + server. If {{param}} is not provided or is set to {{empty}}, an + alternative form of authentication (e.g., certificate-based + authentication) is required. + + Note: The mandatory requirement for this parameter was removed in + Device:2.20. @@ -4949,11 +5043,15 @@ - + Password to be used by the Agent to authenticate with the file - server. This string is set to {{empty}} if no authentication is - required. + server. If {{param}} is not provided or is set to {{empty}}, an + alternative form of authentication (e.g., certificate-based + authentication) is required. + + Note: The mandatory requirement for this parameter was removed in + Device:2.20. @@ -4961,6 +5059,45 @@ + + + + Specifies the client certificate that must be presented to the + remote server for mutual authentication. This certificate is used + to authenticate the client by the remote server, ensuring that + the remote server is communicating with a trusted client. The + client certificate must be issued by a trusted Certificate + Authority (CA) and should match the client's private key. This + parameter is applicable only when a TLS session is being used. + + + + + + + + + + + + Specifies the group of CA certificate(s) that the client must use + to validate the certificate presented by the remote server. These + CA certificates form a trust chain that the server certificate + must match, ensuring that only servers with trusted certificates + can establish a connection. This parameter supports multiple CA + certificates to accommodate different server certificate issuers. + This parameter is applicable only when a TLS session is being + used. + + + + + + + + @@ -4993,11 +5130,15 @@ - + Username to be used by the Agent to authenticate with the file - server. This string is set to {{empty}} if no authentication is - required. + server. If {{param}} is not provided or is set to {{empty}}, an + alternative form of authentication (e.g., certificate-based + authentication) is required. + + Note: The mandatory requirement for this parameter was removed in + Device:2.20. @@ -5006,11 +5147,15 @@ - + Password to be used by the Agent to authenticate with the file - server. This string is set to {{empty}} if no authentication is - required. + server. If {{param}} is not provided or is set to {{empty}}, an + alternative form of authentication (e.g., certificate-based + authentication) is required. + + Note: The mandatory requirement for this parameter was removed in + Device:2.20. @@ -5019,6 +5164,45 @@ + + + Specifies the client certificate that must be presented to the + remote server for mutual authentication. This certificate is used + to authenticate the client by the remote server, ensuring that + the remote server is communicating with a trusted client. The + client certificate must be issued by a trusted Certificate + Authority (CA) and should match the client's private key. This + parameter is applicable only when a TLS session is being used. + + + + + + + + + + + + Specifies the group of CA certificate(s) that the client must use + to validate the certificate presented by the remote server. These + CA certificates form a trust chain that the server certificate + must match, ensuring that only servers with trusted certificates + can establish a connection. This parameter supports multiple CA + certificates to accommodate different server certificate issuers. + This parameter is applicable only when a TLS session is being + used. + + + + + + + + + The size of the file to be downloaded in bytes. @@ -5439,9 +5623,9 @@ numEntriesParameter="CPUNumberOfEntries" minEntries="0" maxEntries="unbounded" dmr:fixedObject="true" version="2.18"> - Each instance in the table represents a CPU on this device. Here CPU - can imply main CPU (where system software is executed) or - hardware/network acceleration CPU (responsible for data plane traffic). + This object describes the utilization metrics for each CPU on the + device. It also defines the monitoring actions that are automatically + triggered when specific utilization thresholds are crossed. @@ -6250,6 +6434,50 @@ + + + + This event is triggered when the temperature sensor detects a high + temperature. If the {{param|Enable}} parameter is {{true}}, the event + is triggered exactly once when the {{param|Value}} value rises above + {{param|HighAlarmValue}}. + + + + + The current temperature value that triggered the event. This value + is in {{units}}. + + + + + + + + + + + + + This event is triggered when the temperature sensor detects a low + temperature. If the {{param|Enable}} parameter is {{true}}, the event + is triggered exactly once when the {{param|Value}} value falls below + {{param|LowAlarmValue}}. + + + + + The current temperature value that triggered the event. This value + is in {{units}}. + + + + + + + + + + maxEntries="unbounded" version="2.12" status="obsoleted"> Each table entry represents a hardware or virtual processor that resides on this device. {{deprecated|2.18|because the only contained parameter, {{param|Architecture}}, is no longer relevant for modern devices.}} + + {{obsoleted|2.20}} @@ -6625,11 +6855,11 @@ - This command is issued to upload the log file specified by this - Vendor Log File instance. + This command is issued to upload the log information specified by + this {{object}} instance. All results of the actual upload will be contained within the - {{event|##.LocalAgent.TransferComplete!}} event. + {{event|.LocalAgent.TransferComplete!}} event. @@ -6656,11 +6886,15 @@ - + Username to be used by the Agent to authenticate with the file - server. This string is set to {{empty}} if no authentication is - required. + server. If {{param}} is not provided or is set to {{empty}}, an + alternative form of authentication (e.g., certificate-based + authentication) is required. + + Note: The mandatory requirement for this parameter was removed in + Device:2.20. @@ -6669,11 +6903,15 @@ - + Password to be used by the Agent to authenticate with the file - server. This string is set to {{empty}} if no authentication is - required. + server. If {{param}} is not provided or is set to {{empty}}, an + alternative form of authentication (e.g., certificate-based + authentication) is required. + + Note: The mandatory requirement for this parameter was removed in + Device:2.20. @@ -6681,6 +6919,45 @@ + + + + Specifies the client certificate that must be presented to the + remote server for mutual authentication. This certificate is used + to authenticate the client by the remote server, ensuring that + the remote server is communicating with a trusted client. The + client certificate must be issued by a trusted Certificate + Authority (CA) and should match the client's private key. This + parameter is applicable only when a TLS session is being used. + + + + + + + + + + + + Specifies the group of CA certificate(s) that the client must use + to validate the certificate presented by the remote server. These + CA certificates form a trust chain that the server certificate + must match, ensuring that only servers with trusted certificates + can establish a connection. This parameter supports multiple CA + certificates to accommodate different server certificate issuers. + This parameter is applicable only when a TLS session is being + used. + + + + + + + + @@ -7522,8 +7799,8 @@ - This command is issued to upload the Kernel fault information - specified by this KernelFault instance. + This command is issued to upload the log information specified by + this {{object}} instance. All results of the actual upload will be contained within the {{event|.LocalAgent.TransferComplete!}} event. @@ -7553,11 +7830,15 @@ - + Username to be used by the Agent to authenticate with the file - server. This string is set to {{empty}} if no authentication is - required. + server. If {{param}} is not provided or is set to {{empty}}, an + alternative form of authentication (e.g., certificate-based + authentication) is required. + + Note: The mandatory requirement for this parameter was removed in + Device:2.20. @@ -7566,11 +7847,15 @@ - + Password to be used by the Agent to authenticate with the file - server. This string is set to {{empty}} if no authentication is - required. + server. If {{param}} is not provided or is set to {{empty}}, an + alternative form of authentication (e.g., certificate-based + authentication) is required. + + Note: The mandatory requirement for this parameter was removed in + Device:2.20. @@ -7578,6 +7863,45 @@ + + + + Specifies the client certificate that must be presented to the + remote server for mutual authentication. This certificate is used + to authenticate the client by the remote server, ensuring that + the remote server is communicating with a trusted client. The + client certificate must be issued by a trusted Certificate + Authority (CA) and should match the client's private key. This + parameter is applicable only when a TLS session is being used. + + + + + + + + + + + + Specifies the group of CA certificate(s) that the client must use + to validate the certificate presented by the remote server. These + CA certificates form a trust chain that the server certificate + must match, ensuring that only servers with trusted certificates + can establish a connection. This parameter supports multiple CA + certificates to accommodate different server certificate issuers. + This parameter is applicable only when a TLS session is being + used. + + + + + + + + @@ -7784,8 +8108,8 @@ - This command is issued to upload the Fault information specified by - this Fault instance. + This command is issued to upload the log information specified by + this {{object}} instance. All results of the actual upload will be contained within the {{event|.LocalAgent.TransferComplete!}} event. @@ -7815,11 +8139,15 @@ - + Username to be used by the Agent to authenticate with the file - server. This string is set to {{empty}} if no authentication is - required. + server. If {{param}} is not provided or is set to {{empty}}, an + alternative form of authentication (e.g., certificate-based + authentication) is required. + + Note: The mandatory requirement for this parameter was removed in + Device:2.20. @@ -7828,11 +8156,15 @@ - + Password to be used by the Agent to authenticate with the file - server. This string is set to {{empty}} if no authentication is - required. + server. If {{param}} is not provided or is set to {{empty}}, an + alternative form of authentication (e.g., certificate-based + authentication) is required. + + Note: The mandatory requirement for this parameter was removed in + Device:2.20. @@ -7840,6 +8172,45 @@ + + + + Specifies the client certificate that must be presented to the + remote server for mutual authentication. This certificate is used + to authenticate the client by the remote server, ensuring that + the remote server is communicating with a trusted client. The + client certificate must be issued by a trusted Certificate + Authority (CA) and should match the client's private key. This + parameter is applicable only when a TLS session is being used. + + + + + + + + + + + + Specifies the group of CA certificate(s) that the client must use + to validate the certificate presented by the remote server. These + CA certificates form a trust chain that the server certificate + must match, ensuring that only servers with trusted certificates + can establish a connection. This parameter supports multiple CA + certificates to accommodate different server certificate issuers. + This parameter is applicable only when a TLS session is being + used. + + + + + + + + @@ -7893,6 +8264,37 @@ + + + The current boot cycle of the device (e.g. Warm or Cold). + + + + + + The device's boot cycle could not be determined. + + + + + The device performed a warm boot. + + This typically occurs during a restart without a full power + cycle (e.g. a software-initiated restart). + + + + + The device performed a cold boot. + + This indicates that power was applied to the device from a + completely off state. + + + + + + The number of times the device has cold rebooted since the last @@ -8015,23 +8417,22 @@ A {{object|Device.|absolute}} Event that was the result of a reboot triggered locally on the Device (NOT as a result of a - {{command|.Reboot()|model}}}} Command triggered by a remote + {{command|.Reboot()|model}} Command triggered by a remote trigger, e.g. another remote management protocol) A {{object|Device.|absolute}} Event that was the result of a - reboot triggered via the {{command|.Reboot()|model}}} Command - or other remote trigger, e.g. another remote management - protocol + reboot triggered via the {{command|.Reboot()|model}} Command or + other remote trigger, e.g. another remote management protocol A {{object|Device.|absolute}} Event that was the result of a factory reset triggered locally on the Device or remotely (as a - result of a {{command|.FactoryReset()|model}}} Command or other + result of a {{command|.FactoryReset()|model}} Command or other remote trigger, e.g. another remote management protocol), which is to be used when the Agent cannot differentiate between local and remote @@ -8041,7 +8442,7 @@ A {{object|Device.|absolute}} Event that was the result of a factory reset triggered locally on the Device (NOT as a result - of a {{command|.FactoryReset()|model}}} Command triggered by a + of a {{command|.FactoryReset()|model}} Command triggered by a remote trigger, e.g. another remote management protocol) @@ -9500,8 +9901,9 @@ - Allow access from any IPv4 address. The source prefixes defined in - {{param|IPv4AllowedSourcePrefix}} will be ignored. + Allow incoming IP connections from any IPv4 address. The source + prefixes defined in {{param|IPv4AllowedSourcePrefix}} will be + ignored. @@ -9512,10 +9914,11 @@ - Allow only access from the provided list of IPv4 prefixes. + Allow only incoming IP connections from the provided list of IPv4 + prefixes. When {{param}} is set to {{empty}} and {{param|AllowAllIPv4}} is set - to ''false'', no incoming connections are allowed. + to ''false'', no incoming IP connections are allowed. When {{param|AllowAllIPv4}} is set ''true'', {{param}} is ignored. @@ -9529,8 +9932,9 @@ - Allow access from any IPv6 address. The source prefixes defined in - {{param|IPv6AllowedSourcePrefix}} will be ignored. + Allow incoming IP connections from any IPv6 address. The source + prefixes defined in {{param|IPv6AllowedSourcePrefix}} will be + ignored. @@ -9541,10 +9945,11 @@ - Allow only access from the provided list of IPv6 prefixes. + Allow only incoming IP connections from the provided list of IPv6 + prefixes. When {{param}} is set to {{empty}} and {{param|AllowAllIPv6}} is set - to ''false'', no incoming connections are allowed. + to ''false'', no incoming IP connections are allowed. When {{param|AllowAllIPv6}} is set ''true'', {{param}} is ignored. @@ -10401,7 +10806,7 @@ in units of 1% above the nominal bit rate. A value of zero indicates that this field is not specified. However this field may contain the nominal bit rate in units of 250MBd if the value in - {{param|BRNominal}} is 255. See {{bibref|SFF-8472|Section 8.4}}} - + {{param|BRNominal}} is 255. See {{bibref|SFF-8472|Section 8.4}} - Address 0xA0, Byte 66. @@ -10419,7 +10824,7 @@ of zero indicates that this field is not specified. However this field may also specify range of signaling rates specified in units of +/- 1{{units}} around the nominal signaling rate. See - {{bibref|SFF-8472|Section 8.5}}} - Address 0xA0, Byte 67. + {{bibref|SFF-8472|Section 8.5}} - Address 0xA0, Byte 67. @@ -10477,19 +10882,18 @@ - This value specifies link length that is supported by the transceiver - while operating in compliance with applicable standards using 50 - micron multimode OM2 [500MHz*km at 850nm] fiber. The value is in - units of {{units}}. A value of 255 means that the transceiver - supports a link length greater than 2.54 km A value of zero means - that the transceiver does not support 50 micron multimode fiber or - that the length information must be determined from the transceiver - technology. + This value specifies the link length that is supported by the + transceiver while operating in compliance with the applicable + standards using single-mode fiber. The value is in units of + {{units}}. A value of 255 means that the transceiver supports a link + length greater than 25.4 km. A value of zero means that the + transceiver does not support single-mode fiber or that the length + information must be determined from the transceiver technology. - + @@ -10500,10 +10904,10 @@ while operating in compliance with applicable standards using 50 micron multimode OM2 [500MHz*km at 850nm,] fiber. The value is in units of {{units}}. A value of 255 means that the transceiver - supports a link length greater than 2.54 km A value of zero means - that the transceiver does not support 50 micron multimode fiber or - that the length information must be determined from the transceiver - technology. + supports a link length greater than 2.54 km. A value of zero means + that the transceiver does not support 50 micron multimode OM2 fiber + or that the length information must be determined from the + transceiver technology. @@ -10517,10 +10921,10 @@ This value specifies link length that is supported by the transceiver while operating in compliance with applicable standards using 62.5 - micron multimode OM1 [200 MHzkm at 850nm, 500 MHzkm at 1310nm] fiber. - The value is in units of {{units}} . A value of 255 means that the - transceiver supports a link length greater than 2.54 km. A value of - zero means that the transceiver does not support 62.5 micron + micron multimode OM1 [200 MHz*km at 850nm, 500 MHz*km at 1310nm] + fiber. The value is in units of {{units}} . A value of 255 means that + the transceiver supports a link length greater than 2.54 km. A value + of zero means that the transceiver does not support 62.5 micron multimode fiber or that the length information must be determined from the transceiver technology. @@ -10539,9 +10943,9 @@ micron multimode OM3 [2000 MHz*km] fiber. The value is in units of {{units}}. A value of 255 means that the transceiver supports a link length greater than 2.54 km. A value of zero means that the - transceiver does not support 50 micron multimode fiber or that the - length information must be determined from the transceiver - Technology. + transceiver does not support 50 micron multimode OM3 fiber or that + the length information must be determined from the transceiver + technology. @@ -11622,7 +12026,7 @@ - + Enables or disables the interface. @@ -11643,7 +12047,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -11695,7 +12099,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -11706,7 +12110,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -11718,7 +12122,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -13935,7 +14339,7 @@ - + Enables or disables the interface. @@ -13946,7 +14350,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -13995,7 +14399,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -14006,7 +14410,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -14018,7 +14422,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -14993,7 +15397,7 @@ - + Enables or disables the interface. @@ -15004,7 +15408,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -15053,7 +15457,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -15064,7 +15468,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -15076,7 +15480,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -17582,7 +17986,7 @@ - + Enables or disables the interface. @@ -17593,7 +17997,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -17645,7 +18049,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -17656,7 +18060,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -17668,7 +18072,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -19402,7 +19806,7 @@ - + Enables or disables the optical interface. @@ -19413,7 +19817,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -19465,7 +19869,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -19476,7 +19880,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -19488,7 +19892,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -19895,7 +20299,7 @@ - + Enables or disables the interface. @@ -19906,7 +20310,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -19970,7 +20374,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -19981,7 +20385,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -19993,7 +20397,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -20090,11 +20494,15 @@ Access technology that is currently in use. + + Note: The ''Unknown'' value was added in Device:2.20. - + + @@ -20209,6 +20617,37 @@ + + + The current NR mode being used. + + + + + NR mode is unknown + + + + NR is operating in standalone mode. + + This mode is only valid when the + {{param|SupportedAccessTechnologies}} is equal to + {{enum|NR|SupportedAccessTechnologies}}. + + + + + NR is operating in non-standalone mode. + + This mode is only valid when the + {{param|SupportedAccessTechnologies}} is equal to + {{enum|NR|SupportedAccessTechnologies}}. + + + + + + The current maximum attainable data rate upstream (expressed in @@ -20645,9 +21084,11 @@ - + Specifies the storage location e.g. SM SIM card, ME device memory. + + Note: The access type was changed to ''readOnly'' in Device:2.20.1 @@ -20926,11 +21367,15 @@ - Access Point Name. + Access Point Name. In 5G, this is conceptually equivalent to the Data + Network Name (DNN) {{bibref|3GPP-TS.23.003|Clause 9A}}. + + Note: The description and maximum string length requirements were + updated in Device:2.20.1 to be compliant with DNN. - + @@ -21075,9 +21520,11 @@ - + The current status of the SIM. + + Note: access type was made `readOnly` in Device:2.20.1. @@ -21303,11 +21750,15 @@ Allows the Controller to change the USIM PIN used for SIM card - activation. + activation. The PIN is used for user verification and to control + access to the USIM. For more information, see + {{bibref|3GPP-TS.31.101|Chapter 9.6}}. + + Note: The PIN length was updated in Device:2.20.1. - + @@ -21485,7 +21936,7 @@ - + Enables or disables the interface. @@ -21497,7 +21948,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -21547,7 +21998,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -21558,7 +22009,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -21570,7 +22021,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -22250,7 +22701,7 @@ - + Enables or disables the interface. @@ -22261,7 +22712,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -22313,7 +22764,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -22324,7 +22775,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -22336,7 +22787,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -22649,7 +23100,7 @@ - + Enables or disables the interface. @@ -22660,7 +23111,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -22712,7 +23163,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -22723,7 +23174,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -22735,7 +23186,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -23750,7 +24201,7 @@ - + Enables or disables the interface. @@ -23761,7 +24212,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -23810,7 +24261,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -23821,7 +24272,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -23833,7 +24284,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -24746,7 +25197,7 @@ - + Enables or disables the interface. @@ -24758,7 +25209,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -24808,7 +25259,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -24819,7 +25270,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -24831,7 +25282,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -25172,7 +25623,7 @@ - + Enables or disables the interface. @@ -25183,7 +25634,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -25235,7 +25686,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -25246,7 +25697,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -25258,7 +25709,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -25312,6 +25763,54 @@ + + + Describes the possible power states of the {{object}} regardless of + its current administrative state. + + + + + + + Indicates that the {{object}} is powered on. + + + + + Indicates that the {{object}} is powered off, using no power. + + When powered off, the {{object}} must be properly stopped. In + particular, if applicable, a dying gasp message on the + interface MUST be properly administered according to the + respective standards. + + + + + Indicates that the {{object}} is in a low-power state, using + minimal power. + + + + + + + + + Reports the current power status of the {{object}}. + + {{reference}} + + {{enum}} + + + + + + + + The unique manufacturer-assigned Ethernet hardware address of the @@ -25597,6 +26096,27 @@ + + + + Sets the power state of the {{object}} asynchronously. + + + + + + Targeted power state. + + {{enum}} + + + + + + + + + - + Enables or disables the interface. @@ -25854,7 +26374,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -25904,7 +26424,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -25915,7 +26435,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -25927,7 +26447,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -26262,7 +26782,7 @@ - + Enables or disables the interface. @@ -26274,7 +26794,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -26324,7 +26844,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -26335,7 +26855,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -26347,7 +26867,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -26651,7 +27171,7 @@ - + Enables or disables the interface. @@ -26663,7 +27183,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -26713,7 +27233,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -26724,7 +27244,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -26736,7 +27256,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -27494,7 +28014,7 @@ - + Enables or disables the interface. @@ -27505,7 +28025,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -27557,7 +28077,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -27568,7 +28088,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -27580,7 +28100,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -27895,6 +28415,54 @@ + + + Describes the possible power states of the {{object}} regardless of + its current administrative state. + + + + + + + Indicates that the {{object}} is powered on. + + + + + Indicates that the {{object}} is powered off, using no power. + + When powered off, the {{object}} must be properly stopped. In + particular, if applicable, a dying gasp message on the + interface MUST be properly administered according to the + respective standards. + + + + + Indicates that the {{object}} is in a low-power state, using + minimal power. + + + + + + + + + Reports the current power status of the {{object}}. + + {{reference}} + + {{enum}} + + + + + + + + The textual name of the port. @@ -27990,6 +28558,27 @@ + + + + Sets the power state of the {{object}} asynchronously. + + + + + + Targeted power state. + + {{enum}} + + + + + + + + + + + + + {{numentries}} + + + + + + + + + When set to {{true}}, all USB devices are allowed to connect to the + Device and the configuration mentioned in + {{object|.USB.USBHosts.AllowedDevice.}} is ignored. + + When set to {{false}}, only USB devices listed in + {{object|.USB.USBHosts.AllowedDevice.}} are allowed to connect to the + Device. Any USB device not explicitly listed will be rendered + inactive. + + + + + + + + Indicates the low-level device state, directly mapping to the + "Visible Device States" in {{bibref|USB2.0|Table 9-1 Visible Device + States}}. + + + + + + The device is physically connected to the USB port. This is the + initial state upon connection, before the host has necessarily + detected or powered it. + + See {{bibref|USB2.0|9.1.1.1 Attached}}. + + + + + The device is receiving power from the host but has not yet + been reset. The host is aware of the connection. + + See {{bibref|USB2.0|9.1.1.2 Powered}}. + + + + + The device has been reset by the host and is now communicating + on the default address. It is waiting for the host to assign it + a unique address. + + See {{bibref|USB2.0|9.1.1.3 Default}}. + + + + + A unique device address has been assigned by the host. The + device is now in the Address state, ready for the host to learn + about its capabilities by reading its descriptors. + + See {{bibref|USB2.0|9.1.1.4 Address}}. + + + + + The device has been successfully configured by the host. It is + now fully operational and its interfaces are active. + + See {{bibref|USB2.0|9.1.1.5 Configured}}. + + + + + The device is in a low-power state to conserve energy. It + maintains its address and configuration but is not actively + communicating until it receives a resume signal from the host. + + See {{bibref|USB2.0|9.1.1.6 Suspended}}. + + + + + + + + + When {{true}}, the associated USB device is allowed to connect to the + Device USB Host controller(s) based on the configuration in + {{object|.USB.USBHosts.AllowedDevice.}} and + {{param|##.AllowAllDevices}}. + + When {{false}}, the associated USB device is not allowed to connect. + + + + + + {{numentries}} @@ -28469,6 +29162,189 @@ + + + Table of USB devices permitted to connect to the Device USB Host + controller(s). Each entry in this table defines an allowed device based + on its e.g. USB Vendor ID and Product ID. Only USB devices listed here + will be accepted by the Device; any USB device not explicitly listed + will be rendered inactive. + + When a USB device is rendered inactive, the parameter value of + {{param|#.Host.{i}.Device.{i}.IsAllowed}} is set to {{false}}, which + prevents the {{param|#.Host.{i}.Device.{i}.DeviceState}} from reaching + the {{enum|Configured|#.Host.{i}.Device.{i}.DeviceState}} status. + + + + + + + + {{datatype|expand}} + + + + + + + + + Enables or disables whether the corresponding allowed USB device + entry is active. If set to {{true}}, the device defined by this entry + is permitted to connect to the system. If {{false}}, the device is + ignored even if its identifiers match. + + + + + + + + + A user-friendly description of the allowed USB device entry. + + + + + + + + + + + Classification criterion. + + Class Code assigned by USB-IF, which can be expressed as a two-digit + hexadecimal string (e.g., `00`), but can also include a wildcard + character. When `00`, the device specifies its own class code. When + `FF`, the class code is vendor-specific. The `*` wildcard may be used + to match any value, either fully (e.g., `*`) or partially (e.g., `F*` + or `*3`). When empty, the device is not classified by Device Class. + + + + + + + + + + + + Classification criterion. + + Subclass code assigned by USB-IF, expressed as a two-digit + hexadecimal string (e.g., `01`), but can also include a wildcard + character. The `*` wildcard may be used to match any value, either + fully (e.g., `*`) or partially (e.g., `0*` or `*3`). When empty, the + device is not classified by Device Subclass. + + + + + + + + + + + + Classification criterion. + + Protocol code assigned by USB-IF, expressed as a two-digit + hexadecimal string (e.g., `02`), but can also include a wildcard + character. The `*` wildcard may be used to match any value, either + fully (e.g., `*`) or partially (e.g., `0*` or `*2`). When empty, the + device is not classified by Device Protocol. + + + + + + + + + + + + Classification criterion. + + Product ID assigned by the manufacturer, expressed as a two- to + four-digit hexadecimal string (e.g., `5678`), but can also include a + wildcard character. The `*` wildcard may be used to match any value, + either fully (e.g., `*`) or partially (e.g., `5*`). When empty, the + device is not classified by Product ID. + + + + + + + + + + + + Classification criterion. + + Vendor ID assigned by USB-IF, expressed as a two- to four-digit + hexadecimal string (e.g., `1234`), but can also include a wildcard + character. The `*` wildcard may be used to match any value, either + fully (e.g., `*`) or partially (e.g., `1*`). When empty, the device + is not classified by Vendor ID. + + + + + + + + + + + + Each item defines an allowed USB interface in the format + 'InterfaceClass:InterfaceSubClass:InterfaceProtocol', using two-digit + hexadecimal values (e.g., `FF`), but can also include a wildcard + character. + + The `*` wildcard may be used to match any value, either fully (e.g., + `*`) or partially (e.g., `F*`). + + A connected device is allowed only if all of its interfaces match + entries in this list. + + * InterfaceClass: USB Class Code (`00` = per-interface class, `FF` = + vendor-specific) + + * InterfaceSubClass: USB Subclass Code + + * InterfaceProtocol: USB Protocol Code + + Example: An USB Device might expose two interfaces: + + * `0xFF:0x02:0x01` for diagnostics + + * `0xFF:0x02:0x02` for data + + These can be allowed by listing both explicitly, or using patterns + like `FF:02:*` or `F*:0*:0*`. + + When empty, the device is not classified by Interfaces. + + + + + + + + + + + @@ -28504,7 +29380,7 @@ - + Enables or disables the interface. @@ -28515,7 +29391,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -28567,7 +29443,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -28578,7 +29454,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -28590,7 +29466,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -30238,7 +31114,7 @@ - Enables or disables the interface. @@ -30251,7 +31127,8 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -30303,7 +31180,8 @@ - + The textual name of the interface as assigned by the CPE. @@ -30314,7 +31192,7 @@ - The accumulated time in {{units}} since the interface entered its @@ -30327,7 +31205,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -30637,7 +31515,7 @@ - Indicates whether link-layer security is enabled or disabled. @@ -30651,6 +31529,8 @@ {{param|PrivacyEnabledSetting}}}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -31745,7 +32625,7 @@ - The value in dB by which to reduce the setting of the transmit power @@ -31764,6 +32644,8 @@ {{deprecated|2.17|for MoCA 2.5}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -32877,7 +33759,7 @@ id="moca25TrapNodeDropNcChg/1.3.6.1.4.1.31621.1.3.0.11" version="2.17"> - This trap is sent when {{param|NodeDropTrapEn}} is {{true}}}, + This trap is sent when {{param|NodeDropTrapEn}} is {{true}}, indicates that there is a NC change when the Node is Non-Secured Admitted Node. @@ -33945,7 +34827,7 @@ The reduction in transmitter level due to power control. @@ -33958,6 +34840,8 @@ {{bibref|MOCA20-MIB}}}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -33965,8 +34849,7 @@ + status="deleted" id="mocaNodeRxPower/1.3.6.1.4.1.31621.1.2.1.11.1.7"> The power level (in {{units}}) received at the MoCA interface from this remote device. @@ -33979,6 +34862,8 @@ {{bibref|MOCA20-MIB}}}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -34129,7 +35014,7 @@ - The signal to noise level received at this interface from this remote @@ -34143,6 +35028,8 @@ {{bibref|MOCA20-MIB}}}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -34882,7 +35769,7 @@ - + Enables or disables the interface. @@ -34893,7 +35780,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -34945,7 +35832,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -34956,7 +35843,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -34968,7 +35855,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -36837,7 +37724,7 @@ - + Enables or disables the interface. @@ -36848,7 +37735,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -36900,7 +37787,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -36911,7 +37798,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -36923,7 +37810,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -36974,6 +37861,49 @@ + + + The type of HomePlug interface. + + + + + + Indicates that this is a physical HomePlug interface embedded + in the Device. + + + + + Indicates that this is a logical HomePlug interface that + operates over an Ethernet interface. + + It is used for gathering statistics from HomePlug devices in + the network and should be used when no embedded HomePlug + interface is available in the Device. + + + + + + + + + The Layer 2 Ethernet Interface over which the network protocol + operates, when the Type parameter is {{enum|Logical|Type}}. + + + + + + + + The MAC Address of the interface. @@ -37373,6 +38303,26 @@ + + + The manufacturer of the remote HomePlug device. + + + + + + + + + + + The firmware version of the remote HomePlug device. + + + + + + The PHY transmit Rate (expressed in {{units}}) to this remote device. @@ -37485,7 +38435,7 @@ - + Enables or disables the interface. @@ -37496,7 +38446,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -37548,7 +38498,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -37559,7 +38509,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -37571,7 +38521,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -38580,6 +39530,9 @@ The {{enum|WPA2-PSK-WPA3-SAE}} value is the same as WPA3-Personal-Transition. + + The {{enum|WPA2-PSK-WPA3-SAE-RSNO}} value is the same as + WPA3-Personal-Compatibility. @@ -38595,6 +39548,7 @@ + @@ -38606,6 +39560,7 @@ When {{param|SecurityModeEnabled}} is one of {{enum|WPA3-SAE|SecurityModeEnabled}}, {{enum|WPA2-PSK-WPA3-SAE|SecurityModeEnabled}}, or + {{enum|WPA2-PSK-WPA3-SAE-RSNO|SecurityModeEnabled}}, or {{enum|WPA3-Enterprise|SecurityModeEnabled}}, {{enum|TKIP}} is not valid, and should not be in the list. @@ -41789,6 +42744,7 @@ If the instance of this {{object|##}} is the same as {{object|Device.WiFi.Radio.{i}.}}, then this parameter is the same as + the first two octets of {{param|Device.WiFi.Radio.{i}.RegulatoryDomain}}. @@ -42967,7 +43923,7 @@ anticipated channel preference. Operating Class contains an enumerated value from - {{bibref|802.11ax|Table E-4}}}. + {{bibref|802.11ax|Table E-4}}. @@ -43286,7 +44242,7 @@ This object represents an individual Access Point device. - + Organizationally unique identifier of the Access Point device manufacturer. Represented as a six hexadecimal-digit value using all @@ -43303,6 +44259,8 @@ {{deprecated|2.18|because it was essentially the same as {{param|#.Manufacturer}}.}} + + {{obsoleted|2.20}} @@ -43340,13 +44298,15 @@ + status="obsoleted"> This parameter represents the status of Wi-Fi CERTIFIED EasyMeshTM controller functionality. {{enum}} {{deprecated|2.18|because it was the same as {{param|#.ControllerOperationMode}}.}} + + {{obsoleted|2.20}} @@ -43400,15 +44360,15 @@ The endpoints of the backhaul interface are represented by the (Device's ID and interface MAC Address). This object represents the upward view of the backhaul interface. The two endpoints of the - backhaul interface are - ({{param|BackhaulDeviceID|deprecated}}, - {{param|BackhaulMACAddress|deprecated}}) of the uplinked Backhaul - Device - {{param|MACAddress|deprecated}} of this Access Point Device. + backhaul interface are - ({{param|BackhaulDeviceID|obsoleted}}, + {{param|BackhaulMACAddress|obsoleted}}) of the uplinked Backhaul Device + - {{param|MACAddress|obsoleted}} of this Access Point Device. {{empty}} is reserved for the {{object}} instance that represents the Multi-AP Controller. - + The medium being used to backhaul this Access Point Device to the Backhaul Access Point Device. The {{enum|None}} value is reserved for @@ -43417,6 +44377,8 @@ {{deprecated|2.18|because it was essentially the same as {{param|##.BackhaulMediaType}}.}} + + {{obsoleted|2.20}} @@ -43433,11 +44395,11 @@ + status="obsoleted"> The MAC Address at the far end of the backhaul link of the interface on the network that is providing a backhaul for this Access Point - Device. This along with {{param|BackhaulDeviceID|deprecated}}, helps + Device. This along with {{param|BackhaulDeviceID|obsoleted}}, helps to identify the backhaul interface endpoint. {{empty}} is reserved for the {{object}} instance that represents the @@ -43445,26 +44407,30 @@ {{deprecated|2.18|because it was the same as {{param|##.BackhaulMACAddress}}.}} + + {{obsoleted|2.20}} - + The Device's ID of the Device on the network that is providing a Backhaul Link for this Access Point Device. {{deprecated|2.18|because it was essentially the same as {{param|##.BackhaulALID}}.}} + + {{obsoleted|2.20}} - + The MAC Address at the near end of the backhaul link of this Access Point Device's backhaul interface that is connecting via @@ -43473,6 +44439,8 @@ {{deprecated|2.18|because it was the same as {{param|##.Radio.{i}.BackhaulSta.MACAddress}}.}} + + {{obsoleted|2.20}} @@ -43635,7 +44603,7 @@ The total number of bytes transmitted across the backhaul medium (as - identified by the value of the {{param|###.BackhaulMediaType}}}} + identified by the value of the {{param|###.BackhaulMediaType}} parameter), including framing characters. @@ -43799,6 +44767,19 @@ + + + {{param}} is a reference to the RadioTemplate selected for this + {{object}}. + + + + + + + + An indicator of the average radio noise plus interference power @@ -47290,6 +48271,33 @@ + + + {{param}} is a reference to the BSSTemplate selected for this + {{object}}. + + + + + + + + + + + {{param}} is a reference to the SecurityTemplate selected for this + {{object}}. + + + + + + + + Time in {{units}} since the last change to the {{param|Enabled}} @@ -49571,7 +50579,7 @@ The counters contained in {{object}} are all reset on reboot. - + Date and time in UTC when the device was associated. @@ -49582,13 +50590,15 @@ {{deprecated|2.18|because it was essentially the same as {{param|#.LastConnectTime}}.}} + + {{obsoleted|2.20}} - + An indicator of the average radio noise plus interference power measured on the uplink from the Associated Device (STA) to the Access @@ -49604,6 +50614,8 @@ {{deprecated|2.18|because it should be the same as {{param|###.Noise}}.}} + + {{obsoleted|2.20}} @@ -49621,7 +50633,7 @@ - + This command represents a request to disassociate this associated device. @@ -49629,6 +50641,8 @@ {{deprecated|2.18|because {{command|#.ClientSteer()}} and {{object|#####.STABlock.{i}.}} cover the use cases for this (client steering and client blocking).}} + + {{obsoleted|2.20}} @@ -49691,7 +50705,7 @@ - + This command requests initiation of a BSS Transition Management (BTM) request to influence this client's roaming behavior to another BSS as @@ -49699,6 +50713,8 @@ {{deprecated|2.18|because it is superseded by {{command|#.ClientSteer()}}.}} + + {{obsoleted|2.20}} @@ -50611,7 +51627,7 @@ network. - + {{list}} List items represent channels in the non-occupancy list due to radars detected by Dynamic Frequency Selection (DFS) Channel @@ -50619,6 +51635,8 @@ {{deprecated|2.18|because it was superseded by {{object|##.CACStatus.{i}.}}.}} + + {{obsoleted|2.20}} @@ -50629,7 +51647,7 @@ + status="obsoleted"> This command represents a request to initiate a full scan on this radio, including all channels supported by this radio, for a specific @@ -50645,6 +51663,8 @@ {{deprecated|2.18|because is was superseded by {{command|#.ChannelScanRequest()}} and performed the same function as {{command|#####.Radio.{i}.FullScan()}}.}} + + {{obsoleted|2.20}} @@ -51044,6 +52064,9 @@ The {{enum|WPA2-PSK-WPA3-SAE}} value is the same as WPA3-Personal-Transition. + + The {{enum|WPA2-PSK-WPA3-SAE-RSNO}} value is the same as + WPA3-Personal-Compatibility. @@ -51059,6 +52082,7 @@ + @@ -51070,6 +52094,7 @@ When {{param|SecurityModeEnabled}} is one of {{enum|WPA3-SAE|SecurityModeEnabled}}, {{enum|WPA2-PSK-WPA3-SAE|SecurityModeEnabled}}, or + {{enum|WPA2-PSK-WPA3-SAE-RSNO|SecurityModeEnabled}}, or {{enum|WPA3-Enterprise|SecurityModeEnabled}}, {{enum|TKIP}} is not valid, and should not be in the list. @@ -51208,7 +52233,7 @@ + status="obsoleted"> This parameter represents a request to initiate a channel scan on this radio on the given channel using a specific {{param|DwellTime}}. @@ -51223,6 +52248,8 @@ {{deprecated|2.18|because is was superseded by {{command|#.ChannelScanRequest()}} and performed the same function as {{command|#####.Radio.{i}.ChannelScan()}}.}} + + {{obsoleted|2.20}} @@ -51662,6 +52689,9 @@ The {{enum|WPA2-PSK-WPA3-SAE}} value is the same as WPA3-Personal-Transition. + + The {{enum|WPA2-PSK-WPA3-SAE-RSNO}} value is the same as + WPA3-Personal-Compatibility. @@ -51677,6 +52707,7 @@ + @@ -51688,6 +52719,7 @@ When {{param|SecurityModeEnabled}} is one of {{enum|WPA3-SAE|SecurityModeEnabled}}, {{enum|WPA2-PSK-WPA3-SAE|SecurityModeEnabled}}, or + {{enum|WPA2-PSK-WPA3-SAE-RSNO|SecurityModeEnabled}}, or {{enum|WPA3-Enterprise|SecurityModeEnabled}}, {{enum|TKIP}} is not valid, and should not be in the list. @@ -51948,6 +52980,19 @@ + + + {{param}} is a reference to the APMLDTemplate selected for this + {{object}}. + + + + + + + + {{numentries}} @@ -53155,7 +54200,7 @@ + status="deleted"> {{numentries}} @@ -53163,6 +54208,8 @@ instead}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -53547,7 +54594,7 @@ access="readOnly" numEntriesParameter="AssociationEventDataNumberOfEntries" minEntries="0" maxEntries="unbounded" dmr:noUniqueKeys="true" - version="2.13" status="obsoleted"> + version="2.13" status="deleted"> The events generated when an Associated Device (STA) associates to a BSS. @@ -53556,6 +54603,8 @@ instead}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -53688,7 +54737,7 @@ + status="deleted"> Describes the Wi-Fi 6 capabilities of the Associated Device (STA). @@ -53696,6 +54745,8 @@ instead}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -53936,7 +54987,7 @@ + access="readOnly" status="deleted"> {{numentries}} @@ -53944,6 +54995,8 @@ instead}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -54332,7 +55385,7 @@ access="readOnly" numEntriesParameter="DisassociationEventDataNumberOfEntries" minEntries="0" maxEntries="unbounded" dmr:noUniqueKeys="true" - version="2.13" status="obsoleted"> + version="2.13" status="deleted"> The events generated when an Associated Device (STA) disassociates from a BSS. @@ -54341,6 +55394,8 @@ instead}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -54650,7 +55705,7 @@ + access="readOnly" status="deleted"> {{numentries}} @@ -54658,6 +55713,8 @@ instead}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -54729,7 +55786,7 @@ access="readOnly" numEntriesParameter="FailedConnectionEventDataNumberOfEntries" minEntries="0" maxEntries="unbounded" version="2.15" - dmr:noUniqueKeys="true" status="obsoleted"> + dmr:noUniqueKeys="true" status="deleted"> This object describes the data provided with a failed connection event @@ -54737,6 +55794,8 @@ instead}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -54792,6 +55851,1476 @@ + + + Wi-Fi Configuration Templates provide a comprehensive way to configure + Wi-Fi. Configuration Templates can be applied across multiple + deployments in an operator's network, and across multiple APs, radios + and BSSs. A set of Configuration Templates can be pre-defined, which + can then handle many different services and scenarios by matching flags + to select a particular template depending on AP or radio capabilities + and topology. Different BSSs can be configured across different radios + to provision different types of services. + + A detailed description of how to use Wi-Fi Configuration Templates is + in {{bibref|DataElements|Section 3.4}}. The Configuration Template + Manager (CTM) interprets and implements Configuration Templates for + each deployment. + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + + This {{object}} either has the Configuration Template Manager (CTM) + deploy BSS(s) according to the templates, or has all BSS(s) be + disabled. + + + + + Indicates whether any BSS may be deployed in the Wi-Fi network. + + : {{true}}: BSS(s) are deployed according to the template matching + process. + + : {{false}}: No BSS is deployed in the network. + + + + + + + + + The TopologyFlag is used to specify a list of EasyMesh Agents on + which BSS(es) are deployed according to the template matching + process. If an EasyMesh Agent does not match any value in the list, + then no BSS is deployed on this EasyMesh Agent. + + These values refer to the network topology role of the EasyMesh Agent + as determined by the EasyMesh Controller. + + This flag matches if any of the list items match (logical OR). + + {{list}}{{enum}} + + + + + + + Colocated with the EasyMesh Controller. + + + + + Not colocated with the EasyMesh Controller. + + + + + Uses wired backhaul, i.e. all links between this EasyMesh Agent + and the EasyMesh Controller are wired. + + + + + Uses wireless backhaul, i.e. at least one link between this + EasyMesh Agent and the EasyMesh Controller is wireless. + + + + + Indicates an IEEE 1905 ALID, the value of which is a list item + in {{param|IEEE1905ALID}}. + + + + + + + + + {{list}} IEEE 1905 {{bibref|IEEE1905.1a}} Abstraction-Layer ID + (ALID). + + This matches if any of the list items match (logical OR). This should + match an entry in {{param|##.DataElements.Network.Device.{i}.ID}}. + + + + + + + + + + Incicates the Primary SSCTemplate. + + The PrimaryVLANID in the EasyMesh network is the VLANID of the + SSCTemplate referenced by {{param}}. If this value is empty, then + Traffic Separation is not used. {{bibref|EasyMesh|Section 19}}. + + + + + + + + + + + Indicates the Primary SSCTemplate. + + The value must be the {{param|#.SSCTemplate.{i}.SSCTemplateID}} to + identify an instance of {{object|#.SSCTemplate}}. If this value is + empty, then Traffic Separation is not used. {{bibref|EasyMesh|Section + 19}}. + + + + + + + + + + Table of Basic Service Set (BSS) templates for Wi-Fi configuration. + + + + + + + + + + + {{datatype|expand}} + + + + + + + + + Static and persistent ID element. At most one {{object}} instance can + exist with a given value for {{param}}. + + + + + + + + + This value indicates in which order the {{object}} are to be matched + for a reported radio. 255 is the highest priority, 0 is the lowest + priority. + + + + + + + + + + + This {{object}} is linked to {{param}}. + + + + + + + + + + + This {{object}} is linked to {{param}}. + + + + + + + + + + + This {{object}} is linked to {{param}}. + + + + + + + + + + + This {{object}} is linked to {{param}}. + + + + + + + + + + + Indicates the {{param|#.RadioTemplate.{i}.RadioTemplateID}} that is + linked with this {{object}}. + + + + + + + + + Indicates the {{param|#.SSCTemplate.{i}.SSCTemplateID}} that is + linked with this {{object}}. + + + + + + + + + Indicates the {{param|#.APMLDTemplate.{i}.APMLDTemplateID}} that is + linked with this {{object}}. + + + + + + + + + Indicates the {{param|#.SecurityGroup.{i}.SecurityGroupID}} of the + {{object|#.SecurityGroup.{i}}} in which a matching + {{object|#.SecurityTemplate}} is searched. + + + + + + + + + The topology flag is used to specify a list of EasyMesh Agents for + which this {{object}} is considered by the Configuration Template + Manager during the matching process. If an Agent does not match any + value in the list, then no BSS matching this BSSTemplate is deployed + on the EasyMesh Agent. These values refer to the network topology + point of the EasyMesh Agent as determined by the EasyMesh Controller. + + This flag matches if any of the list items match (logical OR). + + {{list}}{{enum}} + + + + + + + Colocated with the EasyMesh Controller. + + + + + Not colocated with the EasyMesh Controller. + + + + + Uses wired backhaul, i.e. all links between this EasyMesh Agent + and the EasyMesh Controller are wired. + + + + + Uses wireless backhaul, i.e. at least one link between this + EasyMesh Agent and the EasyMesh Controller is wireless. + + + + + Indicates an IEEE 1905 ALID, the value of which is a list item + in {{param|IEEE1905ALID}}. + + + + + + + + + {{list}} IEEE 1905 {{bibref|IEEE1905.1a}} Abstraction-Layer ID + (ALID). + + This flag matches if any of the list items match (logical OR). This + should match an entry in + {{param|##.DataElements.Network.Device.{i}.ID}}. + + + + + + + + + + Indicates the maximum number of wireless hops (consecutive or not) + allowed between the EasyMesh Controller and the EasyMesh Agent. + + In single-AP deployment, this flag is ignored. + + + + + + + + + + + Indicates the 1905 Security of the EasyMesh Agent + {{bibref|EasyMesh|Section 17.2.77}}. {{enum}} + + + + + + Indicates that 1905 Security is supported and being used by the + EasyMesh Agent. + + + + + Indicates that 1905 Security is not being used by the EasyMesh + Agent. + + + + No requirement for matching. + + + + + + + + Determines if this template is considered by the Configuration + Template Manager in the template matching process. + + + + + + + + + The Service Set Identifier (SSID) used as an identifier by all + deployed BSSs linked to this {{object}}. + + + + + + + + + The KeyPassphrase to be used by all deployed BSSs linked to this + {{object}}. + + + + + + + + + Indicates if the {{param|SSID}} is advertised in beacons + + : {{true}}: this {{param|SSID}} is to be advertised in beacons. + + : {{false}}: this {{param|SSID}} is not to be advertised in beacons. + + + + + + + + + + Table of RadioTemplates for Wi-Fi configuration. + + + + + + + + + + + {{datatype|expand}} + + + + + + + + + Static and persistent ID element. At most one {{object}} instance can + exist with a given value for {{param}}. + + Note that {{param}} is not the same as + {{param|##.DataElements.Network.Device.{i}.Radio.{i}.ID}}. + + + + + + + + + This value indicates in which order the {{object}} are to be matched + for a radio under configuration. 255 is the highest priority, 0 is + the lowest priority. + + + + + + + + + + + Determines if this {{object}} is considered by the Configuration + Template Manager (CTM) in the template matching process. + + This value is independent from the value of any + {{param|##.Radio.{i}.Enable}}. This value is also independent from + the value of any + {{param|##.DataElements.Network.Device.{i}.Radio.{i}.Enabled}}. + + + + + + + + + {{list}} Each list item is a global valid operating class as defined + in {{bibref|802.11ax|Table E-4}}). + + Indicates the Operating Classes the Radio can operate on. Exactly one + of {{param}} or {{param|BandFlag}} must be empty and exactly one must + be filled in. + + A Radio must be able to operate on at least one channel of each + Operating Class specified in this list to satisfy this condition. + + + + + + + + + + + + Indicates frequency bands the Radio can operate on. All listed UNII + bands are to be in the same 2.4, 5 or 6 GHz band. + + Exactly one of {{param|OpClassFlag}} or {{param}} must be empty. + + {{list}}{{enum}} + + + + + + 2.4 GHz band + + + The entire 5 GHz band + + + The entire 6 GHz band + + + 5 GHz UNII-1 band, 5.15 to 5.25 GHz + + + 5 GHz UNII-2 band, 5.25 to 5.725 GHz + + + 5 GHz UNII-3 band, 5.725 to 5.85 GHz + + + 5 GHz UNII-4 band, 5.85 to 5.925 GHz + + + 6 GHz UNII-5 band, 5.925 to 6.425 GHz + + + 6 GHz UNII-6 band, 6.425 to 6.525 GHz + + + 6 GHz UNII-7 band, 6.525 to 6.875 GHz + + + 6 GHz UNII-8 band, 6.875 to 7.125 GHz + + + Sub 1 GHz band, 800 MHz to 928 MHz + + + + + + + + {{list}} Each list item indicates a supported Wi-Fi Generation. Each + list item indicates a Supported Generation of Generational + Capabilities Indication attribute. + + For example {{param}} could be "5,6,7". + + + + + + + + + + + + Indicates Dynamic Frequency Selection (DFS) support. {{enum}} + + + + + Device supports DFS. + + + Device does not support DFS. + + + No requirement for matching. + + + + + + + + Indicates Automated Frequency Coordination (AFC) support. {{enum}} + + + + + Device supports AFC. + + + Device does not support AFC. + + + No requirement for matching. + + + + + + + + This is the upper limit on nominal transmit Equivalent Isotropically + Radiated Power (EIRP) that this radio is allowed to use for the + current operating class. In units of decibels relative to 1 mW + {{units}}. + + + + + + + + + + + + {{list}} Each list item indicates a Wi-Fi Generation deployed on this + EasyMesh Agent or this device. The last list item may be followed by + a "+" to indicate the inclusion of any existing Wi-Fi Generation + above it. If an EasyMesh agent or device supports a Wi-Fi Generation + not in the list, then that Wi-Fi Generation is disabled on the + EasyMesh agent or device. + + For example, "6,7+" means Wi-Fi 6, Wi-Fi 7 and any newer Wi-Fi + Generation. + + Note: {{param}} may include Wi-Fi Generations not supported by a + radio to which this {{object}} is deployed. + + + + + + + + + + + Table of SecurityTemplates for Wi-Fi configuration {{bibref|WPA3v3.0}}. + + + + + + + + + + + {{datatype|expand}} + + + + + + + + + Static and persistent ID element. At most one {{object}} instance can + exist with a given value for {{param}}. + + + + + + + + + Determines if this template is considered by the Configuration + Template Manager in the template matching process. + + + + + + + + + This value indicates in which order the {{object}} are to be matched. + 255 is the highest priority, 0 is the lowest priority. + + + + + + + + + + + Indicates support for Robust Security Network (RSN) Overriding + (RSNO). RSN Overriding (RSNO) is also known as MRSNO and is used in + WPA3-Personal Compatibility Mode. {{enum}} + + + + + + The AP shall indicate support for RSNO for this flag to match. + + + + + The AP shall not indicate support for RSNO for this flag to + match. + + + + This flag matches in all cases. + + + + + + + + {{list}} Authentication and Key Management (AKM) suite selector. Only + the listed enumeration values are allowed in this string. {{enum}} + + + + + + indicates AKM 00-0F-AC:2 + + + indicates AKM 50-6F-9A:2 + + + indicates AKM 00-0F-AC:8 + + + indicates AKM 00-0F-AC:24 + + + + indicates an AKM suite selector, the value of which is + indicated in {{param|SupportedAKMSuiteSelectorFlag}}. + + + + + + + + + {{list}} AKM suite selector, the AKM suite selector (OUI and type) is + encoded as a 4-octet hex-encoded value without internal delimiters, + e.g. 506F9A02 {{bibref|802.11-2020|Table 9-151}}. + + {{param}} applies if {{param|SupportedAKMSuiteFlag}} includes value + "SuiteSelector". + + + + + + + + + + + + {{list}} The AP advertises support in its beacon frames for each + Wi-Fi generation in this list for this flag to match. + + For example {{param}} could be "5,6,7". + + + + + + + + + + + + Concatenation of all BSS Security related IEs with Element IDs, + without delimiters as hex encoded octets {{bibref|EasyMesh}}. + + Note that this {{param}} and the {{object|RSNE}}, {{object|RSNOE}}, + {{object|RSNO2E}}, {{object|RSNXE}}, {{object|RSNXOE}} objects are + independent and may be set separately. If this {{param}} is not + empty, the Configuration Template Manager (CTM) uses the value of + this {{param}} and ignores the content of the + RSNE/RSNOE/RSNO2E/RSNXE/RSNXOE objects. + + + + + + + + + + This object describes the Robust Security Network Element (RSNE). This + object is only used by the Configuration Template Manager if the + {{param|#.SecurityIEs}} is empty. + + + + + Cipher suite selector used to protect group addressed data frames. + This is the name of a cipher suite, as defined in + {{bibref|802.11-2020|Table 9-149}}. + + The following is an example value: "CCMP-128". + + + + + + + + + {{list}} Each list item is a cipher suite selector used to protect + individually addressed Data frames, as defined in + {{bibref|802.11-2020|Table 9-149}}. + + The following is an example value: "CCMP-128". + + + + + + + + + + Authentication and Key Management (AKM) suite + {{bibref|802.11-2020|Table 9-151}}. {{list}}{{enum}} + + + + + + indicates AKM 00-0F-AC:2 + + + indicates AKM 50-6F-9A:2 + + + indicates AKM 00-0F-AC:8 + + + indicates AKM 00-0F-AC:24 + + + + indicates an AKM suite selector, the value of which is + indicated in {{param|AKMSuiteSelector}}. + + + + + + + + + {{list}} AKM suite selector, the AKM suite selector (OUI and type) is + encoded as a 4-octet hex-encoded value without internal delimiters, + e.g. 506F9A02 {{bibref|802.11-2020|Table 9-151}}. + + {{param}} applies if {{param|AKMSuite}} includes value + "SuiteSelector". + + + + + + + + + + + + Indicates the expected support for Management Frame Protection (MFP), + aka Protected Management Frame (PMF). + + {{bibref|WPA3v3.0}} and see also the WPA3 and Wi-Fi Enhanced Open + Deployment Guide v1.1.pdf, Table 3, row PMF. + + + + + + + + + + + + + Cipher suite selector used to protect group addressed robust + Management frames. This is the name of a cipher suite, as defined in + {{bibref|802.11-2020|Table 9-149}}. + + The following is an example value: "BIP-CMAC-128". + + + + + + + + + + This object describes the RSNOE element. This object is only used by + the Configuration Template Manager if the {{param|#.SecurityIEs}} is + empty. + + + + + Cipher suite selector used to protect group addressed data frames. + This is the name of a cipher suite, as defined in + {{bibref|802.11-2020|Table 9-149}}. + + The following is an example value: "CCMP-128". + + + + + + + + + {{list}} Each list item is a cipher suite selector used to protect + individually addressed Data frames, as defined in + {{bibref|802.11-2020|Table 9-149}}. + + The following is an example value: "CCMP-128". + + + + + + + + + + Authentication and Key Management (AKM) suite + {{bibref|802.11-2020|Table 9-151}}. {{list}}{{enum}} + + + + + + indicates AKM 00-0F-AC:2 + + + indicates AKM 50-6F-9A:2 + + + indicates AKM 00-0F-AC:8 + + + indicates AKM 00-0F-AC:24 + + + + indicates an AKM suite selector, the value of which is + indicated in {{param|AKMSuiteSelector}}. + + + + + + + + + {{list}} AKM suite selector, the AKM suite selector (OUI and type) is + encoded as a 4-octet hex-encoded value without internal delimiters, + e.g. 506F9A02 {{bibref|802.11-2020|Table 9-151}}. + + {{param}} applies if {{param|AKMSuite}} includes value + "SuiteSelector". + + + + + + + + + + + + Indicates the expected support for Management Frame Protection (MFP), + aka Protected Management Frame (PMF). + + {{bibref|WPA3v3.0}} and see also the WPA3 and Wi-Fi Enhanced Open + Deployment Guide v1.1.pdf, Table 3, row PMF. + + + + + + + + + + + + + Cipher suite selector used to protect group addressed robust + Management frames. This is the name of a cipher suite, as defined in + {{bibref|802.11-2020|Table 9-149}}. + + The following is an example value: "BIP-CMAC-128". + + + + + + + + + + This object describes the RSNO2E element. This object is only used by + the Configuration Template Manager if the {{param|#.SecurityIEs}} is + empty. + + + + + Cipher suite selector used to protect group addressed data frames. + This is the name of a cipher suite, as defined in + {{bibref|802.11-2020|Table 9-149}}. + + The following is an example value: "CCMP-128". + + + + + + + + + {{list}} Each list item is a cipher suite selector used to protect + individually addressed Data frames, as defined in + {{bibref|802.11-2020|Table 9-149}}. + + The following is an example value: "CCMP-128". + + + + + + + + + + Authentication and Key Management (AKM) suite + {{bibref|802.11-2020|Table 9-151}}. {{list}}{{enum}} + + + + + + indicates AKM 00-0F-AC:2 + + + indicates AKM 50-6F-9A:2 + + + indicates AKM 00-0F-AC:8 + + + indicates AKM 00-0F-AC:24 + + + + indicates an AKM suite selector, the value of which is + indicated in {{param|AKMSuiteSelector}}. + + + + + + + + + {{list}} AKM suite selector, the AKM suite selector (OUI and type) is + encoded as a 4-octet hex-encoded value without internal delimiters, + e.g. 506F9A02 {{bibref|802.11-2020|Table 9-151}}. + + {{param}} applies if {{param|AKMSuite}} includes value + "SuiteSelector". + + + + + + + + + + + + Indicates the expected support for Management Frame Protection (MFP), + aka Protected Management Frame (PMF). + + {{bibref|WPA3v3.0}} and see also the WPA3 and Wi-Fi Enhanced Open + Deployment Guide v1.1.pdf, Table 3, row PMF. + + + + + + + + + + + + + Cipher suite selector used to protect group addressed robust + Management frames. This is the name of a cipher suite, as defined in + {{bibref|802.11-2020|Table 9-149}}. + + The following is an example value: "BIP-CMAC-128". + + + + + + + + + + This object indicates the value the BSS transmits in the RSNXE element. + + This object is only used by the Configuration Template Manager if the + {{param|#.SecurityIEs}} is empty. + + + + + Indicates if the BSS will support Simultaneous Authentication of + Equals (SAE) hash-to-element {{true}}, or not {{false}}. + + {{true}}: BSS sets SAE hash-to-element to 1. {{false}}: BSS sets SAE + hash-to-element to 0. + + + + + + + + + + This object indicates the value the BSS transmits in the RSNXOE + element. This object is only used by the Configuration Template Manager + if the {{param|#.SecurityIEs}} is empty. + + + + + Indicates if the BSS will support Simultaneous Authentication of + Equals (SAE) hash-to-element {{true}}, or not {{false}}. + + {{true}}: BSS sets SAE hash-to-element to 1. {{false}}: BSS sets SAE + hash-to-element to 0. + + + + + + + + + + Table of SecurityGroups for Wi-Fi configuration {{bibref|WPA3v3.0}}. + + + + + + + + This is the friendly name of this {{object}} which may be advertised + to the end user in a graphical interface. + + + + + + + + + Indicates the list of {{object|#.SecurityTemplate}} for this + {{object}}. + + + + + + + + + + + + Indicates the {{param|#.SecurityTemplate.{i}.SecurityTemplateID}} in + this entry of this {{object}}. + + + + + + + + + + + Table of AP Multi-Link Device (MLD) templates (APMLDTemplate) for Wi-Fi + configuration {{bibref|EasyMesh|Section 17.2.96, Agent AP MLD + Configuration TLV}}. + + + + + + + + + + + {{datatype|expand}} + + + + + + + + + Static and persistent ID element. At most one {{object}} instance can + exist with a given value for {{param}}. + + + + + + + + + Indicates whether or not Multi-Link Operation (MLO) is enabled. If + set to {{false}}, then MLO support is disabled and each deployment of + a BSSTemplate related to this {{object}} results in an AP MLD with a + single affiliated AP. However, this does not disable the BSSs that + are in the {{object|#.BSSTemplate.{i}}} linked to this {{object}}. + + + + + + + + + Indicates whether or not Simultaneous Transmit and Receive (STR) mode + is to be enabled on the AP MLD. + + + + + + + + + Indicates whether or not Non-Simultaneous Transmit and Receive (NSTR) + mode is to be enabled on the AP MLD. + + + + + + + + + Indicates whether or not Enhanced Multi-Link Single-Radio (EMLSR) + mode is to be enabled on the AP MLD. + + + + + + + + + Indicates whether or not Enhanced Multi-Link Multi-Radio (EMLMR) mode + is to be enabled on the AP MLD. + + + + + + + + + Indicates whether the TID-to-link Mapping Negotiation Support + subfield in the MLD Capabilities and Operations field of the Basic + Multi-Link element is (to be) enabled by any deployed AP MLD linked + to this {{object}}. + + + + + + + + + + Table of Service Set Collection (SSC) templates (SSCTemplate) for Wi-Fi + configuration. + + + + + + + + + + + {{datatype|expand}} + + + + + + + + + Static and persistent ID element. At most one {{object}} instance can + exist with a given value for {{param}}. + + + + + + + + + If set to {{false}}, then all BSSs that are linked with this + {{object}} are disabled, which means that these BSSs cease to offer + service. + + + + + + + + + The VLAN ID (VID) for all BSSs that are part of this {{object}}. A + value of 0 indicates that no VLAN shall be configured on the BSSs + belonging to this {{object}}. + + + + + + + + + + + Indicates the use of the BSSs that are part of this {{object}}. + {{list}}{{enum}} + + + + + + + + + + + @@ -54817,7 +57346,7 @@ - + Enables or disables the interface. @@ -54833,7 +57362,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -54885,7 +57414,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -54896,7 +57425,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -54908,7 +57437,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -54970,6 +57499,54 @@ + + + Describes the possible power states of the {{object}} regardless of + its current administrative state. + + + + + + + Indicates that the {{object}} is powered on. + + + + + Indicates that the {{object}} is powered off, using no power. + + When powered off, the {{object}} must be properly stopped. In + particular, if applicable, a dying gasp message on the + interface MUST be properly administered according to the + respective standards. + + + + + Indicates that the {{object}} is in a low-power state, using + minimal power. + + + + + + + + + Reports the current power status of the {{object}}. + + {{reference}} + + {{enum}} + + + + + + + + {{list}} List items indicate the frequency bands at which the radio @@ -55597,8 +58174,8 @@ either " " (all environments), "O" (outside) or "I" (inside). If the instance of this {{object|##}} is the same as - {{object|Device.WiFi.DataElements.Network.Device.{i}.}}, then this - parameter is the same as + {{object|Device.WiFi.DataElements.Network.Device.{i}.}}, then the + first two octets of this parameter are the same as {{param|Device.WiFi.DataElements.Network.Device.{i}.CountryCode}}. @@ -55847,6 +58424,209 @@ + + + The bit pattern of the configured receive antennas that need to be + activated. + + This parameter uses a bitmap to specify which receive antennas need + to be enabled. Each bit in the unsigned integer corresponds to a + specific antenna. If a bit is set to '1', the corresponding antenna + is activated for reception. If a bit is set to '0', the antenna is + deactivated. + + How the Bitmap Works: + + * Bit 0 (LSB): Corresponds to Antenna 0. If the value is odd (e.g., + 1, 3, 5...), Antenna 0 is enabled. + + * Bit 1: Corresponds to Antenna 1. + + * Bit 2: Corresponds to Antenna 2. + + * And so on... + + * Bit N: Corresponds to Antenna N. + + Examples: + + * `0`: No receive antennas are activated. + + * `1`: Only Antenna 0 is activated for reception. + + * `2`: Only Antenna 1 is activated for reception. + + * `3`: Antenna 0 and Antenna 1 are activated for reception. + + * `255`: All 8 possible receive antennas (Antenna 0 through Antenna + 7) are activated. + + The value MUST be within the range of + {{param|SupportedReceiveAntennas}}, meaning you cannot attempt to + activate an antenna that is not physically supported by the device. + + Valid values are: {{range}}. + + + + + + A value of ''-1'' indicates the automatic selection of the + receive antennas. + + + + + + + + + + The bit pattern of the configured transmit antennas that need to be + activated. + + This parameter uses a bitmap to specify which receive antennas need + to be enabled. Each bit in the unsigned integer corresponds to a + specific antenna. If a bit is set to '1', the corresponding antenna + is activated for reception. If a bit is set to '0', the antenna is + deactivated. + + How the Bitmap Works: + + * Bit 0 (LSB): Corresponds to Antenna 0. If the value is odd (e.g., + 1, 3, 5...), Antenna 0 is enabled. + + * Bit 1: Corresponds to Antenna 1. + + * Bit 2: Corresponds to Antenna 2. + + * And so on... + + * Bit N: Corresponds to Antenna N. + + Examples: + + * `0`: No receive antennas are activated. + + * `1`: Only Antenna 0 is activated for reception. + + * `2`: Only Antenna 1 is activated for reception. + + * `3`: Antenna 0 and Antenna 1 are activated for reception. + + * `255`: All 8 possible receive antennas (Antenna 0 through Antenna + 7) are activated. + + The value MUST be within the range of + {{param|SupportedReceiveAntennas}}, meaning you cannot attempt to + activate an antenna that is not physically supported by the device. + + Valid values are: {{range}}. + + + + + + A value of ''-1'' indicates the automatic selection of the + transmit antennas. + + + + + + + + + + Specifies the maximum number of antennas, used for receiving on this + radio. + + Valid values are: {{range}}. + + + + + + + A value of ''-1'' means that this feature is not supported. + + + + + + + + + Specifies the maximum number of antennas, used for receiving on this + radio. + + Valid values are: {{range}}. + + + + + + + A value of ''-1'' means that this feature is not supported. + + + + + + + + + The bit pattern of the receive antennas actively in use. + + This parameter uses a bitmap to specify which receive antennas are + enabled. Each bit in the unsigned integer corresponds to a specific + antenna. If a bit is set to '1', the corresponding antenna is + activated for reception. If a bit is set to '0', the antenna is + deactivated. + + Valid values are: {{range}}. + + + + + + + A value of ''-1'' means that this feature is not supported. + + + + + + + + + The bit pattern of the transmit antennas actively in use. + + This parameter uses a bitmap to specify which transmit antennas are + enabled. Each bit in the unsigned integer corresponds to a specific + antenna. If a bit is set to '1', the corresponding antenna is + activated for reception. If a bit is set to '0', the antenna is + deactivated. + + Valid values are: {{range}}. + + + + + + + A value of ''-1'' means that this feature is not supported. + + + + + + This command requests initiation of a Remote Measurement request to @@ -56438,6 +59218,9 @@ The {{enum|WPA2-PSK-WPA3-SAE}} value is the same as WPA3-Personal-Transition. + + The {{enum|WPA2-PSK-WPA3-SAE-RSNO}} value is the same as + WPA3-Personal-Compatibility. @@ -56453,6 +59236,7 @@ + @@ -56464,6 +59248,7 @@ When {{param|SecurityModeEnabled}} is one of {{enum|WPA3-SAE|SecurityModeEnabled}}, {{enum|WPA2-PSK-WPA3-SAE|SecurityModeEnabled}}, or + {{enum|WPA2-PSK-WPA3-SAE-RSNO|SecurityModeEnabled}}, or {{enum|WPA3-Enterprise|SecurityModeEnabled}}, {{enum|TKIP}} is not valid, and should not be in the list. @@ -57051,6 +59836,9 @@ The {{enum|WPA2-PSK-WPA3-SAE}} value is the same as WPA3-Personal-Transition. + + The {{enum|WPA2-PSK-WPA3-SAE-RSNO}} value is the same as + WPA3-Personal-Compatibility. @@ -57066,6 +59854,7 @@ + @@ -57077,6 +59866,7 @@ When {{param|SecurityModeEnabled}} is one of {{enum|WPA3-SAE|SecurityModeEnabled}}, {{enum|WPA2-PSK-WPA3-SAE|SecurityModeEnabled}}, or + {{enum|WPA2-PSK-WPA3-SAE-RSNO|SecurityModeEnabled}}, or {{enum|WPA3-Enterprise|SecurityModeEnabled}}, {{enum|TKIP}} is not valid, and should not be in the list. @@ -57213,6 +60003,27 @@ + + + + Sets the power state of the {{object}} asynchronously. + + + + + + Targeted power state. + + {{enum}} + + + + + + + + + + + + This object represents the capabilities of the radio which may be + different from the current operational configuration. + + + + + + This object describes the Wi-Fi 7 capabilities for the AP role. + {{bibref|EasyMesh}} Source: Wi-Fi 7 Agent Capabilities TLV. + + + + + Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is + supported. + + + + + + + + + Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is + supported. + + + + + + + + + Indicates if Simultaneous Transmit and Receive (STR) operation is + supported. + + + + + + + + + Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation + is supported. + + + + + + + + + Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is + supported. + + + + + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + + This object describes the required frequency separation from the + specified radio {{param|RUID}} for MLO Enhanced Multi-Link Multi-Radio + (EMLMR) operation. {{bibref|EasyMesh}} Source: Wi-Fi 7 Agent + Capabilities TLV. + + + + + + + + The Radio unique identifier (RUID) of another radio to which the + specified frequency separation gap applies. + + + + + + + + + Frequency separation to the specified radio for the particular MLO + operation mode. A value of 0 indicates that no frequency separation + information is provided. Set to a nonzero value to indicate the + required frequency gap is ({{param}} - 1) x {{units}}. + + + + + + + + + + + + This object describes the required frequency separation from the + specified radio {{param|RUID}} for MLO Enhanced Multi-Link Single-Radio + (EMLSR) operation. {{bibref|EasyMesh}} Source: Wi-Fi 7 Agent + Capabilities TLV. + + + + + + + + The Radio unique identifier (RUID) of another radio to which the + specified frequency separation gap applies. + + + + + + + + + Frequency separation to the specified radio for the particular MLO + operation mode. A value of 0 indicates that no frequency separation + information is provided. Set to a nonzero value to indicate the + required frequency gap is ({{param}} - 1) x {{units}}. + + + + + + + + + + + + This object describes the required frequency separation from the + specified radio {{param|RUID}} for MLO Simultaneous Transmit and + Receive (STR) operation. {{bibref|EasyMesh}} Source: Wi-Fi 7 Agent + Capabilities TLV. + + + + + + + + The Radio unique identifier (RUID) of another radio to which the + specified frequency separation gap applies. + + + + + + + + + Frequency separation to the specified radio for the particular MLO + operation mode. A value of 0 indicates that no frequency separation + information is provided. Set to a nonzero value to indicate the + required frequency gap is ({{param}} - 1) x {{units}}. + + + + + + + + + + + + This object describes the required frequency separation from the + specified radio {{param|RUID}} for MLO Non-Simultaneous Transmit and + Receive (NSTR) operation. {{bibref|EasyMesh}} Source: Wi-Fi 7 Agent + Capabilities TLV. + + + + + + + + The Radio unique identifier (RUID) of another radio to which the + specified frequency separation gap applies. + + + + + + + + + Frequency separation to the specified radio for the particular MLO + operation mode. A value of 0 indicates that no frequency separation + information is provided. Set to a nonzero value to indicate the + required frequency gap is ({{param}} - 1) x {{units}}. + + + + + + + + + + + + This object describes the Wi-Fi 7 capabilities for the backhaul Station + (bSTA) role. {{bibref|EasyMesh}} Source: Wi-Fi 7 Agent Capabilities + TLV. + + + + + Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is + supported. + + + + + + + + + Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is + supported. + + + + + + + + + Indicates if Simultaneous Transmit and Receive (STR) operation is + supported. + + + + + + + + + Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation + is supported. + + + + + + + + + Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is + supported. + + + + + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + + This object describes the required frequency separation from the + specified radio {{param|RUID}} for MLO Enhanced Multi-Link Multi-Radio + (EMLMR) operation. {{bibref|EasyMesh}} Source: Wi-Fi 7 Agent + Capabilities TLV. + + + + + + + + The Radio unique identifier (RUID) of another radio to which the + specified frequency separation gap applies. + + + + + + + + + Frequency separation to the specified radio for the particular MLO + operation mode. A value of 0 indicates that no frequency separation + information is provided. Set to a nonzero value to indicate the + required frequency gap is ({{param}} - 1) x {{units}}. + + + + + + + + + + + + This object describes the required frequency separation from the + specified radio {{param|RUID}} for MLO Enhanced Multi-Link Single-Radio + (EMLSR) operation. {{bibref|EasyMesh}} Source: Wi-Fi 7 Agent + Capabilities TLV. + + + + + + + + The Radio unique identifier (RUID) of another radio to which the + specified frequency separation gap applies. + + + + + + + + + Frequency separation to the specified radio for the particular MLO + operation mode. A value of 0 indicates that no frequency separation + information is provided. Set to a nonzero value to indicate the + required frequency gap is ({{param}} - 1) x {{units}}. + + + + + + + + + + + + This object describes the required frequency separation from the + specified radio {{param|RUID}} for MLO Simultaneous Transmit and + Receive (STR) operation. {{bibref|EasyMesh}} Source: Wi-Fi 7 Agent + Capabilities TLV. + + + + + + + + The Radio unique identifier (RUID) of another radio to which the + specified frequency separation gap applies. + + + + + + + + + Frequency separation to the specified radio for the particular MLO + operation mode. A value of 0 indicates that no frequency separation + information is provided. Set to a nonzero value to indicate the + required frequency gap is ({{param}} - 1) x {{units}}. + + + + + + + + + + + + This object describes the required frequency separation from the + specified radio {{param|RUID}} for MLO Non-Simultaneous Transmit and + Receive (NSTR) operation. {{bibref|EasyMesh}} Source: Wi-Fi 7 Agent + Capabilities TLV. + + + + + + + + The Radio unique identifier (RUID) of another radio to which the + specified frequency separation gap applies. + + + + + + + + + Frequency separation to the specified radio for the particular MLO + operation mode. A value of 0 indicates that no frequency separation + information is provided. Set to a nonzero value to indicate the + required frequency gap is ({{param}} - 1) x {{units}}. + + + + + + + + + @@ -57607,7 +60935,7 @@ - + Enables or disables the interface. @@ -57624,7 +60952,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -57674,7 +61002,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -57685,7 +61013,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -57702,7 +61030,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -57777,6 +61105,18 @@ + + + Maximum Transmission Unit for this interface (expressed in + {{units}}). + + + + + + + + The current service set identifier in use by the connection. The SSID @@ -58492,6 +61832,9 @@ The {{enum|WPA3-Personal-Transition}} value is the same as WPA2-PSK-WPA3-SAE. + + The {{enum|WPA3-Personal-Compatibility}} value is the same as + WPA2-PSK-WPA3-SAE-RSNO. @@ -58509,6 +61852,7 @@ + @@ -58746,6 +62090,31 @@ + + + Enable SAE with group dependant hash usage in WPA3 security modes. + This flag enables or disables the use of SAE with group dependant + hash instead of simple SAE applicable when {{param|ModeEnabled}} is + set to {{enum|WPA3-Personal|ModeEnabled}}, + {{enum|WPA3-Personal-Transition|ModeEnabled}}, or + {{enum|WPA3-Enterprise|ModeEnabled}}. If {{param}} is set to + {{enum|Disabled}}, then only AKM8 shall be used. If it is set to + {{enum|Transition}}, then both AKM8 and AKM24 shall be used. Finally, + if {{param}} is set to {{enum|Enabled}}, then only AKM24 shall be + used. {{enum|Enabled}} is invalid when {{param|ModeEnabled}} is set + to {{enum|WPA3-Personal-Transition|ModeEnabled}}. + + + + + + + + + + + Signaling and Payload Protected for A-MSDU frames. @@ -59607,7 +62976,7 @@ If the instance of this {{object}} is the same as {{object|Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.}}, then this parameter is the same as - {{param|Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.Noise|deprecated}}. + {{param|Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.MultiAPSTA.Noise|obsoleted}}. @@ -60471,6 +63840,7 @@ + @@ -60694,6 +64064,31 @@ + + + + Enable SAE with group dependant hash usage in WPA3 security modes. + This flag enables or disables the use of SAE with group dependant + hash instead of simple SAE applicable when {{param|ModeEnabled}} is + set to {{enum|WPA3-Personal|ModeEnabled}}, + {{enum|WPA3-Personal-Transition|ModeEnabled}}, or + {{enum|WPA3-Enterprise|ModeEnabled}}. If {{param}} is set to + {{enum|Disabled}}, then only AKM8 shall be used. If it is set to + {{enum|Transition}}, then both AKM8 and AKM24 shall be used. Finally, + if {{param}} is set to {{enum|Enabled}}, then only AKM24 shall be + used. {{enum|Enabled}} is invalid when {{param|ModeEnabled}} is set + to {{enum|WPA3-Personal-Transition|ModeEnabled}}. + + + + + + + + + + - + Enables or disables the interface. @@ -61291,7 +64686,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -61343,7 +64738,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -61354,7 +64749,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -61366,7 +64761,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -61417,6 +64812,54 @@ + + + Describes the possible power states of the {{object}} regardless of + its current administrative state. + + + + + + + Indicates that the {{object}} is powered on. + + + + + Indicates that the {{object}} is powered off, using no power. + + When powered off, the {{object}} must be properly stopped. In + particular, if applicable, a dying gasp message on the + interface MUST be properly administered according to the + respective standards. + + + + + Indicates that the {{object}} is in a low-power state, using + minimal power. + + + + + + + + + Reports the current power status of the {{object}}. + + {{reference}} + + {{enum}} + + + + + + + + {{list}} List items represent supported transmit power levels as @@ -61579,6 +65022,27 @@ + + + + Sets the power state of the {{object}} asynchronously. + + + + + + Targeted power state. + + {{enum}} + + + + + + + + + - + Enables or disables the interface. @@ -61729,7 +65193,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -61779,7 +65243,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -61790,7 +65254,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -61802,7 +65266,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -62929,7 +66393,7 @@ - + Enables or disables the interface. @@ -62940,7 +66404,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -62992,7 +66456,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -63003,7 +66467,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -63015,7 +66479,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -64876,7 +68340,7 @@ - + Enables or disables the interface. @@ -64888,7 +68352,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -64938,7 +68402,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -64949,7 +68413,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -64961,7 +68425,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -66972,7 +70436,7 @@ - + Enables or disables the interface. @@ -66984,7 +70448,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -67034,7 +70498,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -67045,7 +70509,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -67057,7 +70521,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -67917,7 +71381,7 @@ - + Enables or disables the interface (regardless of {{param|IPv4Enable}} and {{param|IPv6Enable}}). @@ -67952,7 +71416,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -68002,7 +71466,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -68013,7 +71477,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -68025,7 +71489,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -72064,7 +75528,7 @@ - + The Fully Qualified Domain Name (FQDN) or IP address of the Test Endpoint to perform the UDP Capacity tests with. @@ -72074,6 +75538,8 @@ to {{bibref|TR-471}} for details}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -72102,7 +75568,7 @@ - + Port on the Test Endpoint host. @@ -72111,6 +75577,8 @@ to {{bibref|TR-471}} for details}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -72204,7 +75672,7 @@ - The number of connections to be used in the test. The default @@ -72217,6 +75685,8 @@ related parameters. Refer to {{bibref|TR-471}} for details}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -73496,10 +76966,10 @@ Results of measurements using the maximum IP-Layer Capacity metric calculation for a single interval from {{bibref|TR-471}} Equation 1, for time interval of duration - {{param|#.TestSubInterval}} ending at - {{param|TimeOfSubInterval}} across all connections for this - test. Result is expressed in {{units}} with 2 digits beyond the - decimal. 10^6^ bits/second = 1 {{units}}. + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections + for this test. Result is expressed in {{units}} with 2 digits + beyond the decimal. 10^6^ bits/second = 1 {{units}}. @@ -73512,8 +76982,9 @@ Time in UTC of end of sub-interval when {{param|IPLayerCapacity}} was measured. Value MUST be specified - to {{param|#.TimestampResolution}} precision. For example: - 2008-04-09T15:01:05.123456Z + to + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TimestampResolution}} + precision. For example: 2008-04-09T15:01:05.123456Z @@ -73523,9 +76994,11 @@ Ratio of lost packets to total packets, for time interval of - duration {{param|#.TestSubInterval}} ending at - {{param|TimeOfSubInterval}} across all connections for this - test. This value is expressed as a decimal to 9 decimal digits. + duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections + for this test. This value is expressed as a decimal to 9 + decimal digits. @@ -73535,11 +77008,12 @@ The range of Round Trip Time (RTT), for time interval of - duration {{param|#.TestSubInterval}} ending at - {{param|TimeOfSubInterval}} across all connections for this - test. See {{bibref|TR-471}} for description of how value is - calculated. This value is expressed in {{units}}. This value is - expressed as a decimal to 9 decimal digits. + duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections + for this test. See {{bibref|TR-471}} for description of how + value is calculated. This value is expressed in {{units}}. This + value is expressed as a decimal to 9 decimal digits. @@ -73551,11 +77025,12 @@ The range of Packet Delay Variation (PDV), for time interval of - duration {{param|#.TestSubInterval}} ending at - {{param|TimeOfSubInterval}} across all connections for this - test. See {{bibref|TR-471}} for description of how value is - calculated. This value is expressed in {{units}}. This value is - expressed as a decimal to 9 decimal digits. + duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections + for this test. See {{bibref|TR-471}} for description of how + value is calculated. This value is expressed in {{units}}. This + value is expressed as a decimal to 9 decimal digits. @@ -73567,14 +77042,14 @@ The minimum one-way delay, for time interval of duration - {{param|#.TestSubInterval}} ending at - {{param|TimeOfSubInterval}} across all connections for this - test. The minimum one-way delay is calculated at the conclusion - of the test and SHALL be calculated using the conditional - distribution of all packets with a finite one-way delay value - (undefined delays are excluded). This value is expressed in - {{units}}. This value is expressed as a decimal to 9 decimal - digits. + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections + for this test. The minimum one-way delay is calculated at the + conclusion of the test and SHALL be calculated using the + conditional distribution of all packets with a finite one-way + delay value (undefined delays are excluded). This value is + expressed in {{units}}. This value is expressed as a decimal to + 9 decimal digits. @@ -73586,9 +77061,11 @@ Ratio of reordered packets to total packets, for time interval - of duration {{param|#.TestSubInterval}} ending at - {{param|TimeOfSubInterval}} across all connections for this - test. This value is expressed as a decimal to 9 decimal digits. + of duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections + for this test. This value is expressed as a decimal to 9 + decimal digits. @@ -73598,9 +77075,11 @@ Ratio of replicated packets to total packets, for time interval - of duration {{param|#.TestSubInterval}} ending at - {{param|TimeOfSubInterval}} across all connections for this - test. This value is expressed as a decimal to 9 decimal digits. + of duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections + for this test. This value is expressed as a decimal to 9 + decimal digits. @@ -73609,14 +77088,17 @@ - The number of bits observed on the {{param|#.Interface}} during - an IP-Layer Capacity test for time interval of duration - {{param|#.TestSubInterval}} ending at - {{param|TimeOfSubInterval}}, divided by the duration of - {{param|#.TestSubInterval}}. Result is expressed in Mbps with 2 - digits beyond the decimal. 10^6^ bits/second = 1 {{units}}. - This is primarily a diagnostic measurement. Measurement - direction follows the {{param|#.Role}}. + The number of bits observed on the + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}Interface}} + during an IP-Layer Capacity test for time interval of duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}}, divided by the duration + of + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}}. + Result is expressed in Mbps with 2 digits beyond the decimal. + 10^6^ bits/second = 1 {{units}}. This is primarily a diagnostic + measurement. Measurement direction follows the + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}Role}}. @@ -73628,6 +77110,157 @@ + + + This event provides a mechanism to deliver IPLayerCapacity + incremental results to a USP Controller during the execution of the + diagnostics test. + + + + + Results of measurements using the maximum IP-Layer Capacity metric + calculation for a single interval from {{bibref|TR-471}} Equation + 1, for time interval of duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections for + this test. Result is expressed in {{units}} with 2 digits beyond + the decimal. 10^6^ bits/second = 1 {{units}}. + + + + + + + + + + + Time in UTC of end of sub-interval when {{param|IPLayerCapacity}} + was measured. Value MUST be specified to + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TimestampResolution}} + precision. For example: 2008-04-09T15:01:05.123456Z + + + + + + + + + Ratio of lost packets to total packets, for time interval of + duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections for + this test. This value is expressed as a decimal to 9 decimal + digits. + + + + + + + + + The range of Round Trip Time (RTT), for time interval of duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections for + this test. See {{bibref|TR-471}} for description of how value is + calculated. This value is expressed in {{units}}. This value is + expressed as a decimal to 9 decimal digits. + + + + + + + + + + + The range of Packet Delay Variation (PDV), for time interval of + duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections for + this test. See {{bibref|TR-471}} for description of how value is + calculated. This value is expressed in {{units}}. This value is + expressed as a decimal to 9 decimal digits. + + + + + + + + + + + The minimum one-way delay, for time interval of duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections for + this test. The minimum one-way delay is calculated at the + conclusion of the test and SHALL be calculated using the + conditional distribution of all packets with a finite one-way delay + value (undefined delays are excluded). This value is expressed in + {{units}}. This value is expressed as a decimal to 9 decimal + digits. + + + + + + + + + + + Ratio of reordered packets to total packets, for time interval of + duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections for + this test. This value is expressed as a decimal to 9 decimal + digits. + + + + + + + + + Ratio of replicated packets to total packets, for time interval of + duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}} across all connections for + this test. This value is expressed as a decimal to 9 decimal + digits. + + + + + + + + + The number of bits observed on the + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}Interface}} + during an IP-Layer Capacity test for time interval of duration + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}} + ending at {{param|TimeOfSubInterval}}, divided by the duration of + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}TestSubInterval}}. + Result is expressed in Mbps with 2 digits beyond the decimal. 10^6^ + bits/second = 1 {{units}}. This is primarily a diagnostic + measurement. Measurement direction follows the + {{param|{{template|IP-LAYER-CAPACITY-DIAG-PARENT}}Role}}. + + + + + + + + + This command provides access to a diagnostics test that performs @@ -74694,8 +78327,20 @@ - - + + + {{deprecated|2.20|because the correct value is + {{enum|HMAC-SHA2-384-192}} + + + + + {{deprecated|2.20|because the correct value is + {{enum|HMAC-SHA2-512-256}} + + + + @@ -76237,7 +79882,7 @@ to decryption errors. Note that this refers to IKEv2 protocol {{units}}, and not to - {units}} carried by other SAs. + {{units}} carried by other SAs. @@ -76720,7 +80365,7 @@ - + Enables or disables the interface. @@ -76732,7 +80377,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -76782,7 +80427,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -76793,7 +80438,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -76805,7 +80450,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -77632,7 +81277,7 @@ - + Enables or disables the interface. @@ -77644,7 +81289,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -77694,7 +81339,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -77705,7 +81350,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -77717,7 +81362,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -78594,7 +82239,7 @@ - + Enables or disables the interface. @@ -78606,7 +82251,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -78656,7 +82301,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -78667,7 +82312,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -78679,7 +82324,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -79566,7 +83211,7 @@ interface. - + Enables or disables the interface. @@ -79578,7 +83223,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -79620,19 +83265,21 @@ + status="obsoleted"> {{datatype|expand}} {{deprecated|2.18|because {{object|#}} already has an Alias parameter.}} + + {{obsoleted|2.20}} - + The textual name of the interface as assigned by the CPE. @@ -79643,7 +83290,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -79655,7 +83302,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -80232,6 +83879,15 @@ + + + + {{numentries}} + + + + + + + + + + + + + + + The identifier of the routing table, as defined by the system upon + creation. + + + + + + + + + + + The name of the routing table. + + + + + + + @@ -80346,6 +84031,8 @@ + + @@ -80477,6 +84164,32 @@ + + + Source IPv4 address is a filter to the packets for which the route + applies. {{empty}} indicates no source address is specified. + + + + + + + + + + Source subnet mask. {{empty}} indicates no source subnet mask is + specified. + + If a source subnet mask is specified, the {{param}} is ANDed with the + source address before comparing with the {{param|SourceIPAddress}}. + Otherwise, the full source address is used as is. + + + + + + + Identifier of a set of classes or flows that have the corresponding @@ -80578,6 +84291,25 @@ + + + + Maximum Transmission Unit for this route (expressed in {{units}}). + + Valid values are: {{range}}. + + + + + + + A value of -1 indicates no {{param}} is specified. + + + + + + + + + Source IPv6 prefix. {{empty}} indicates that it matches all source + prefixes. All bits to the right of the prefix MUST be zero, e.g. + 2001:edff:fe6a:f76::/64. + + Routes with a 128-bit prefix length (/128) are host routes for a + specific IPv6 source, e.g. 2001:db8:28:2:713e:a426:d167:37ab/128. + + + + + + + + + + Maximum Transmission Unit for this route (expressed in {{units}}). + + Valid values are: {{range}}. + + + + + + + A value of -1 indicates no {{param}} is specified. + + + + + + + Identifier of a set of classes or flows that have the corresponding @@ -80847,6 +84613,278 @@ + + + Routing policy table. + + + + + + + + Enables or disables this {{object}} table entry. + + + + + + + + + + {{datatype|expand}} + + + + + + + + + The status of this {{object}} table entry. + + + + + + + + + + + + + + {{reference}} Specify the routing table to use for traffic matching + criterion. Example: Device.Routing.Router.1. + + + + + + + + + + + + + The priority of this {{object}} table entry, determining the order in + which rules are processed. + + A lower numerical value indicates higher precedence, meaning rules + are evaluated in increasing order of priority. + + A value of 0 represents the highest precedence. + + + + + + + + + Specifies the IP protocol version, following the definitions in + {{bibref|IANA-ipversionnumbers}}. Valid values are: {{range}}. + + + + + + IPv4 + + + + + IPv6 + + + + + No specific IP version is required + + + + + + + + + + {{object}} criterion. + + Protocol number. A value of -1 indicates this criterion is not used + for matching. + + + + + + + + + + + + {{object}} criterion. + + {{reference}} Specify the ingress interface the packet is coming + from. Example: Device.IP.Interface.1. + + + + + + + + + + + + + {{object}} criterion. + + {{reference}} Specify the egress interface the packet is sent to. + Example: Device.IP.Interface.1. + + + + + + + + + + + + + {{object}} criterion. + + Source IP address prefix, represented as an IP routing prefix using + CIDR notation (defined in {{bibref|RFC4632}}). + + The IP version of {{param|IPVersion}} determines whether {{param}} is + interpreted as an IPv4 or IPv6 prefix. + + An {{empty}} indicates this criterion is not used for matching. + + + + + + + + + + {{object}} criterion. + + Destination IP address prefix, represented as an IP routing prefix + using CIDR notation (defined in {{bibref|RFC4632}}). + + The IP version of {{param|IPVersion}} determines whether {{param}} is + interpreted as an IPv4 or IPv6 prefix. + + An {{empty}} indicates this criterion is not used for matching. + + + + + + + + + + {{object}} criterion. + + Source port number. A value of -1 indicates this criterion is not + used for matching. + + + + + + + + + + + + {{object}} criterion. + + If specified, indicates the {{object}} criterion is to include the + port range from {{param|SourcePort}} through {{param}} (inclusive). + If specified, {{param}} MUST be greater than or equal to + {{param|SourcePort}}. + + A value of -1 indicates that no port range is specified. + + + + + + + + + + + + {{object}} criterion. + + Destination port number. A value of ''-1'' indicates this criterion + is not used for matching. + + + + + + + + + + + + {{object}} criterion. + + If specified, indicates the {{object}} criterion is to include the + port range from {{param|DestPort}} through {{param}} (inclusive). If + specified, {{param}} MUST be greater than or equal to + {{param|DestPort}}. + + A value of -1 indicates that no port range is specified. + + + + + + + + + + + + Identifier of a set of classes or flows that have the corresponding + {{param}} value as defined in the {{object|.QoS}} object. + + A value of -1 indicates no {{param}} is specified. + + If specified, this {{object}} entry is to apply only to traffic + associated with the specified classes and flows. + + + + + + + + + + @@ -87000,6 +91038,26 @@ + + + Specifies the threshold related to the number of Host entries that + are retained in the {{object|Device.Hosts.Host.{i}.}} table. + + If this threshold is exceeded, the device removes the inactive Host + entry with the oldest {{param|Host.{i}.ActiveLastChange}} timestamp + that is, the Host entry for which {{param|Host.{i}.Active}} is + {{false}} and the host entry for which has been inactive the longest. + + A value of '-1' disables this mechanism. + + + + + + + + @@ -87009,6 +91067,45 @@ + + + + Removes Host entries where {{param|Host.{i}.Active}} is {{false}}, + and the Host has been inactive for longer than + {{param|MinimumInactiveTime}}. + + The inactivity duration is calculated based on the + {{param|Host.{i}.ActiveLastChange}} timestamp. + + + + + + Specifies the minimum duration, in {{units}}, for which a Host + must be inactive before being removed. + + When {{param}} is not specified, all inactive Host entries are + removed. + + + + + + + + + + + + + Indicates the total number of hosts successfully removed. + + + + + + + @@ -87322,7 +91420,8 @@ Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are {{object|WANStats}} statistics collected for - the entry in the past seven days. + the entry in the past seven days, unless requested by a Controller or + if the {{param|#.CleanupHostsThreshold}} parameter value is reached. @@ -87614,9 +91713,10 @@ - Each reference provides a schedule where time based access can be - enabled. When {{param}} is {{empty}} the {{object}} is not scheduled, - and the {{param|Enable}} defines the operational state. + Each reference provides a time schedule that controls when the + associated feature or resource is active or inactive. When {{param}} + is {{empty}} the {{object}} is not scheduled, and the + {{param|Enable}} defines the operational state. @@ -87629,10 +91729,12 @@ + status="obsoleted"> {{deprecated|2.18|in favor of {{object|.Schedules.}}}} + {{obsoleted|2.20}} + {{numentries}} @@ -87644,10 +91746,12 @@ + version="2.14" status="obsoleted"> {{deprecated|2.18|in favor of {{object|.Schedules.}}}} + {{obsoleted|2.20}} + Each instance of this object provides a schedule where access is enabled. @@ -88715,7 +92819,7 @@ + status="deleted" version="2.12"> {{reference|the {{object|##.IP.Interface}} object instance from which DNS-SD services are advertised}} @@ -88726,6 +92830,8 @@ {{deprecated|2.17|in favor of {{param|Advertise.{i}.Interface}}}} {{obsoleted|2.19}} + + {{deleted|2.20}} @@ -89228,6 +93334,50 @@ + + + The DNS Rebind Protection object contains parameters to enable or + disable protection against DNS rebind attacks. + + It prevents DNS-based malicious software that tries to bypass the + browser’s policies, by filtering or refusing DNS answers that point to + private or local IP addresses, it stops external sites from reaching + LAN devices. + + + + + Enables or Disables protection against DNS rebind attacks + + + + + + + + + Each item of the list represents an IP address or a CIDR notation + that should not be protected against rebind attacks. + + + + + + + + + + Each item of the list represents a domain name and its subdomain + names that should not be protected against rebind attacks. + + + + + + + + @@ -89837,9 +93987,10 @@ - Each reference provides a schedule where time based access can be - enabled. When {{param}} is {{empty}} the {{object}} is not scheduled, - and the {{param|Enable}} defines the operational state. + Each reference provides a time schedule that controls when the + associated feature or resource is active or inactive. When {{param}} + is {{empty}} the {{object}} is not scheduled, and the + {{param|Enable}} defines the operational state. @@ -90084,9 +94235,10 @@ - Each reference provides a schedule where time based access can be - enabled. When {{param}} is {{empty}} the {{object}} is not scheduled, - and the {{param|Enable}} defines the operational state. + Each reference provides a time schedule that controls when the + associated feature or resource is active or inactive. When {{param}} + is {{empty}} the {{object}} is not scheduled, and the + {{param|Enable}} defines the operational state. @@ -91690,6 +95842,14 @@ + + + + The {{object}} will release its DHCPv4-supplied information (i.e. the + Agent will send a release message to the DHCPv4 server to indicate + that it will no longer use the obtained address and/or subnet). + + + + + + The {{object}} will release its DHCPv6-supplied information (i.e. the + Agent will send a Release message to the DHCPv6 server to indicate + that it will no longer use the obtained addresses and/or prefixes). + + This object contains parameters relating to the role characteristics. + + If this object is referenced by a + {{param|.SoftwareModules.ExecutionUnit.{i}.RequiredUserRoles}}, then + the device MAY reject deletion requests, as it could cause instability + in the environment. @@ -96726,6 +100899,87 @@ + + + When {{param|#.UPnPIGD}} is set to {{true}}, this object defines the + configuration parameters of the UPnP-IGD service embedded in the + device. + + + + + Specifies the maximum duration, in {{units}}, for a UPnP-IGD port + mapping lease that the UPnP-IGD service will grant. When a UPnP + control point requests a lease duration exceeding this value, the + UPnP-IGD service will still grant the port mapping request, but the + actual lease lifetime will be capped at this value. Once this maximum + lifetime expires, the port mapping will be automatically removed. + + A value of 0 indicates no {{param}} is specified. + + + + + + + + + + + + Specifies the interval, in {{units}}, at which the Device's UPnP-IGD + service automatically cleans up inactive UPnP port mappings. + + A port mapping is typically considered inactive if no network traffic + has been observed traversing it for a predefined timeout period, + which is an implementation-specific value within the UPnP-IGD + service. During the cleanup process, mappings that meet this + inactivity criteria are removed. + + A value of ''0'' disables this automatic cleanup mechanism, causing + port mappings to persist until explicitly removed by the control + point or the UPnP-IGD service restarts. + + + + + + + + + + + + Indicates whether the Device allows port forwarding requests from + UPnP control points even when the external (WAN) interface of the IGD + has a private or reserved IPv4 address. + + When set to {{true}}, the IGD service will process and attempt to + establish port mappings despite having a non-public IP address on its + WAN interface. + + When set to {{false}}, the IGD will prevent the establishment of port + mappings if it detects a private or reserved IP address on its WAN + interface. + + + + + + + + + + Enables or disables IPv6 support for the UPnP IGD service. + + + + + + + + @@ -99361,6 +103615,34 @@ + + + + Specifies the number of packets that can be processed per unit of + time. A value of -1 indicates this criterion is not used for + matching. + + + + + + + + + + + + Specifies the maximum number of packets that can be processed in a + short burst before the {{param|FloodLimit}} is enforced again. A + value of -1 indicates this criterion is not used for matching. + + + + + + + + - Each reference provides a schedule where time based access can be - enabled. When {{param}} is {{empty}} the {{object}} is not scheduled, - and the {{param|Enable}} defines the operational state. + Each reference provides a time schedule that controls when the + associated feature or resource is active or inactive. When {{param}} + is {{empty}} the {{object}} is not scheduled, and the + {{param|Enable}} defines the operational state. @@ -101876,6 +106159,900 @@ + + + This object serves as the central control for managing file uploads to + a remote server. It allows for periodic transfers of various file + types, such as logs, crash dumps, and kernel oopses. Individual upload + configurations are defined within instances of the {{object|Profile}} + object. + + + + + Globally enables or disables the entire file transfer service managed + by this object. When disabled, no file transfers will occur, + regardless of individual profile or transfer configurations. + + + + + + + + + Indicates the protocols that are supported. + + + + + + As defined in {{bibref|RFC9110}}. + + + + User Services Platform (USP - {{bibref|TR-369|Annex A}}) Event + Notification + + + + + + + + + Indicates the file types that are supported for upload. + + + + + + + The file to be uploaded is a vendor-specific log file and is + part of {{object|.DeviceInfo.VendorLogFile.}}. + + + + + The file to be uploaded is a process fault file and is part of + {{object|.DeviceInfo.ProcessFaults.}}. + + + + + The file to be uploaded is a kernel fault file and is part of + {{object|.DeviceInfo.KernelFaults.}}. + + + + + The file to be uploaded is a log file that is rotated and is + part of {{object|.DeviceInfo.LogRotate.}}. + + + + + + + + + Indicates the HTTP Compression mechanism(s) supported by this Device + for the purposes of transferring the data. + + + + + + + As defined in {{bibref|RFC2616|Section 3.5}} + + + + + As defined in {{bibref|RFC2616|Section 3.5}} + + + + + As defined in {{bibref|RFC2616|Section 3.5}} + + + + + + + + + Indicates the HTTP method(s) supported by this Device for the + purposes of transferring data. + + + + + + + As defined in {{bibref|RFC2616|Section 9.5}} + + + + + As defined in {{bibref|RFC2616|Section 9.6}} + + + + + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + + This object defines a reusable profile for configuring file uploads. + Each profile specifies the common parameters for transferring files to + a remote server, such as the protocol to be used. Multiple transfer + tasks ({{object|#.Transfer}}) can reference the same profile. + + + + + + + + + + + {{datatype|expand}} + + + + + + + + + The textual name of the profile as assigned by the Device. + + + + + + + + + + + {{reference|the {{object|.LocalAgent.Controller}} instance that + created {{object}}|delete}} + + The value of this parameter is automatically populated by the USP + Agent upon {{object}} creation using the reference to the USP + Controller that created the instance. + + Only the USP Controller referenced by {{param}} parameter will + receive a {{event|#.Transfer.{i}.Push!}} Event (assuming it has an + associated Subscription) when the Profile has {{param|Protocol}} + configured to {{enum|USPEventNotif|Protocol}}, even if another USP + Controller has an associated Subscription. + + + + + + + + + + + Protocol being used. + + + + + + + + + + + + This object defines the HTTP/HTTPS transport properties for a transfer + file upload profile. This object is used when the {{param|#.Protocol}} + parameter has a value of {{enum|HTTP|##.ProtocolsSupported}}. + + For authentication purposes the Device MUST support HTTP Basic and + Digest Access Authentication as defined in {{bibref|RFC7617}} and + {{bibref|RFC7616}}. + + + + + The URL of the server receiving the periodic file uploads. + + + + + + + + + Username used to authenticate the Device when making a connection to + the file upload server. + + {{empty}} indicates that the username will not be used during the + authentication process. + + + + + + + + + + + Password used to authenticate the Device when making a connection to + the file upload server. + + {{empty}} indicates that the password will not be used during the + authentication process. + + + + + + + + + + + Specifies the client certificate that must be presented to the remote + server for mutual authentication. This certificate is used to + authenticate the client by the remote server, ensuring that the + remote server is communicating with a trusted client. The client + certificate must be issued by a trusted Certificate Authority (CA) + and should match the client's private key. This parameter is + applicable only when a TLS session is being used. + + + + + + + + + + + + Specifies the group of CA certificate(s) that the client must use to + validate the certificate presented by the remote server. These CA + certificates form a trust chain that the server certificate must + match, ensuring that only servers with trusted certificates can + establish a connection. This parameter supports multiple CA + certificates to accommodate different server certificate issuers. + This parameter is applicable only when a TLS session is being used. + + + + + + + + + + + + Specifies the IP protocol version, following the definitions in + {{bibref|IANA-ipversionnumbers}}. Valid values are: {{range}}. + + + + + + IPv4 + + + + + IPv6 + + + + + No specific IP version is required + + + + + + + + + + The value of this parameter represents the HTTP Compression mechanism + to be used by the Device when transferring data to the file upload + server. + + + + + + + + + + + The value of this parameter represents the HTTP method to be used by + the Device when transferring data to the file upload server. + + + + + + + + + + + When {{true}}, the Device retries unsuccessful attempts to transfer + the remaining files. + + + + + + + + + Configures the data transfer retry wait interval, in {{units}}. + + The device MUST use a random value between {{param}} and ({{param}} * + {{param|RetryIntervalMultiplier}} / 1000) as the first retry wait + interval. Other values in the retry pattern MUST be calculated using + this value as a starting point. + + + + + + + + + + + + Configures the data transfer retry maximum wait interval, in + {{units}}. If the calculated interval is higher than the specifed + {{param}} value then {{param}} value should be used. + + + + + + + + + + + + + Configures the retry interval multiplier. + + This value is expressed in units of 0.001. Hence the values of the + multiplier range between 1.000 and 65.535. + + The device MUST use a random value between + {{param|RetryMinimumWaitInterval}} and + ({{param|RetryMinimumWaitInterval}} * {{param}} / 1000) as the first + retry wait interval. Other values in the retry pattern MUST be + calculated using this value as a starting point. + + + + + + + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + + This object represents an instance of a parameter to be used in the + report header used as part of the HTTP Request-URI transmitted by the + CPE to the collection server using the Request-URI in addition to the + parameters required by {{template|BULK-DATA-HTTP-QUERY-REF}}. + + + + + Name of the Request-URI parameter. + + If {{param}} is {{empty}}, the name of the Request-URI parameter is + the value of {{param|Reference}}. + + + + + + + + + + + The value MUST be the path name of a parameter to be used as the + Request-URI parameter. + + If the value of this parameter is {{empty}}, then this object is not + encoded in the report header. + + + + + + + + + + + + + This object allows defining custom HTTP request header fields to be + included in the outbound HTTP requests to the remote server when using + this profile. As defined in {{bibref|RFC2616|Section 5.3 Request Header + Fields}}. Each instance can specify either a static value or + dynamically reference a device parameter. + + + + + The name of the custom HTTP header field to be added to the request. + + Either {{param|Value}} or {{param|Reference}} MUST be specified. If + both are specified, the value of {{param|Value}} will be used. If + both are {{empty}}, this object is not included in the HTTP request. + + + + + + + + + + + The static value of the HTTP header field. If this parameter is + {{empty}}, the value of the header field will be the current value of + the device parameter specified in {{param|Reference}}. + + + + + + + + + + + The path name of a device parameter whose current value will be used + as the value of this HTTP header field. + + + + + + + + + + + + + This object specifies the parameters for an individual file transfer + task. Each instance specifies a file to be transferred, the method of + transfer (periodic or on-demand), and a reference to a + {{object|#.Profile.{i}.}} object containing the server connection + details. + + The {{param|Status}} parameter reflects the current state of the + transfer process, which can transition through the following sequences: + + * Idle → Uploading → Success → Idle + + * Idle → Uploading → Error → Idle + + * Idle → Creating → Error → Idle + + * Idle → Creating → Uploading → Success → Idle + + * Idle → Creating → Uploading → Error → Idle + + + + + + + + Enables or disables this specific file transfer task. If this entry + is disabled then the transfer is not performed. + + + + + + + + + + {{datatype|expand}} + + + + + + + + + Indicates the current status of this file transfer task. + + + + + + The transfer task is currently inactive and waiting for a + trigger or scheduled time. + + + + + The Device is currently preparing the file for transfer (e.g., + running a pre-hook script). + + + + + The Device is currently in the process of uploading the file to + the remote server. + + + + + The file transfer was completed successfully. + + + + + The file transfer encountered an error. + + + + + + + + + Indicates the Origin of the {{object}} instance. + + + + + + Used for indicating that the transfer task was created by the + end-user. For example through the web user interface. + + + + + Used for indicating that the transfer task was created by the + system itself. + + + + + Used for indicating that the transfer task was created by a + Controller. + + + + + + + + + + Specifies the type of file to be uploaded. The actual file path and + any pre- or post-processing scripts associated with this file type + are implementation-specific on the Device. + + + + + + + + + + + The path reference to the object that contains the file(s) to be + uploaded. Only applicable when {{param|Type}} matches values of + {{enum|VendorLogFile|Type}} or {{enum|LogRotate|Type}}. For other + {{param|Type}} values, this parameter is not applicable, because all + files of the selected type will be uploaded, e.g. when {{param|Type}} + equals {{enum|ProcessFaults|Type}} all process faults will be + uploaded. + + When {{param}} is {{empty}}, depending on the {{param|Type}} all + references will be uploaded. + + + + + + + + + + + + Reference to profile instance to be used to perform the transfer. + + + + + + + + + + + The file upload interval in {{units}}. Each file upload is tried + based on this interval and {{param|TimeReference}}. + + File upload intervals MUST begin every {{param}} {{units}}. + + If {{param}} is changed while Periodic File Upload is enabled, the + first file upload interval begins immediately. + + For example, if {{param}} is 86400 (a day) and if + {{param|TimeReference}} is set to UTC midnight on some day (in the + past, present, or future) then the Device will upload its file(s) at + midnight every 24 hours. + + + + + + + + + + + + + An absolute time reference in UTC to determine when the file will be + transmitted. Each file upload interval MUST complete at this + reference time plus or minus an integer multiple of + {{param|UploadInterval}}, unless unable to due to higher prioritized + operations. + + {{param}} is used only to set the "phase" of the file upload + intervals. The actual value of {{param}} can be arbitrarily far into + the past or future. + + If {{param}} is changed while periodic file upload is enabled, the + first file upload interval begins immediately. + + The Unknown Time value as defined in {{bibref|TR-106}} indicates that + no particular time reference is specified. That is, the Device MAY + locally choose the time reference, and is required only to adhere to + the specified file upload intervals. + + If absolute time is not available to the Device, its file upload + interval behavior MUST be the same as if the {{param}} parameter was + set to the Unknown Time value. + + For example, if {{param|UploadInterval}} is 86400 (a day) and if + {{param}} is set to UTC midnight on some day (in the past, present, + or future) then the Device will upload its file(s) at midnight every + 24 hours. + + Note that, if {{param}} is set to a time other than the Unknown Time, + the first file upload interval (which has to begin immediately) will + almost certainly be shorter than {{param|UploadInterval}}). This is + why {{param}} is defined in terms of when file upload intervals + complete rather than start. + + + + + + + + + + The UTC date and time of the next scheduled file upload for this + periodic transfer task. + + + + + + + + + + This command forces the Device to immediately attempt to transfer the + file associated with this transfer task, regardless of the scheduled + time; The {{param|Status}} is updated to {{enum|Uploading|Status}}, + the {{param|NextTransferDate}} remains unchanged. + + All results of the actual upload will be contained within the + {{event|.LocalAgent.TransferComplete!}} event. + + + + + + Push event for delivering a periodic file transfer report within a + USP Notification message. + + + + + The contents of the periodic file transfer report. + + + + + + + + + + + This object provides statistical information about the success and + failure of individual file transfer tasks. + + + + + The date and time at which of the last successful transfer. + + + + + + + + + The date and time at which of the last failed transfer. + + + + + + + + + Error code of the last failed transfer as described in + https://tr369.org/tr-369-usp-error-code-details/. + + + + + + + + + Counter of successful transfer. + + + + + + + + + Counter of failed transfer. + + + + + + + + + + This object provides aggregated statistical information about all file + upload activities managed by the + {{object|Device.PeriodicFileTransfer.}} object. + + + + + A counter representing the total number of successful file uploads + across all transfer tasks since the last system reset or counter + reset. + + + + + + + + + A counter representing the total number of failed file uploads across + all transfer tasks since the last system reset or counter reset. + + + + + + + @@ -102850,6 +108027,44 @@ + + + + Returns the path to the X.509 certificate and its corresponding + private key that is associated with the entry of the {{object}} + table. + + + + + + The absolute or relative path to the certificate file, specified + as an {{bibref|RFC8089}} (The file URI Scheme). + + + + + + + + + The URI for the private key associated with this certificate, + formatted according to {{bibref|RFC7512}}. This URI should point + to the key's location on a hardware security module (HSM) or + other cryptographic token. + + For security reasons, the URI MUST NOT include any PIN + information (e.g.,`pin-value`). The service responsible for + managing the token should inject the required PIN at runtime. + This practice prevents unauthorized access and malicious reuse of + the private key by other services. + + + + + + + - Top level object for dynamically managed software applications. + Top level object for dynamically managed applications. - The {{datatype}} that specifies the location of the DU to be - installed. + The {{datatype}} that specifies the location of the Deployment + Unit to be installed. The URL MUST NOT include the "userinfo" component, as defined in {{bibref|RFC3986}}. @@ -105984,7 +111199,8 @@ - The UUID (see {{bibref|RFC4122}}) of the DU to be installed. + The UUID (see {{bibref|RFC4122}}) of the Deployment Unit to be + installed. If this parameter is {{empty}} the device MUST generate the UUID based on the rules defined in {{bibref|RFC4122}} and @@ -106023,9 +111239,9 @@ - This parameter indicates whether the containerized application - runs in privileged mode. {{false}} - Unprivileged Container. - {{true}} - Privileged Container. + This parameter indicates whether the application runs in + privileged mode. {{false}} - Unprivileged Container. {{true}} - + Privileged Container. @@ -106035,10 +111251,11 @@ - Number of UIDs (EU User Identifiers) that this container will - need as part of its user namespace. UIDs are unique identifiers - associated with each user and system process that is used to - determine the allocation and isolation of system resources. + Number of UIDs (Execution Unit User Identifiers) that this + container will need as part of its user namespace. UIDs are + unique identifiers associated with each user and system process + that is used to determine the allocation and isolation of system + resources. {{deprecated|2.19|because this parameter should not be required.}} @@ -106051,8 +111268,8 @@ - A reference to the Execution Environment upon which the DU is to - be installed. + A reference to the Execution Environment upon which the + Deployment Unit is to be installed. If {{empty}} the device MUST choose the Execution Environment to use. @@ -106069,9 +111286,9 @@ The {{datatype}} which can be used to fetch the signature for - this DU. The {{datatype}} may use the "data" scheme defined in - {{bibref|RFC2397}} in order to incorporate the signature into the - command directly. + this Deployment Unit. The {{datatype}} may use the "data" scheme + defined in {{bibref|RFC2397}} in order to incorporate the + signature into the command directly. Several signature formats are in common use; the device may deduce the format used from the Content-Type of the retrieved @@ -106083,9 +111300,9 @@ HTTPS transport MUST be supported. Other optional transports MAY be supported. - The absence of this parameter indicates that the DU is unsigned. - If this is contrary to the security policy of the device then the - command will be rejected. + The absence of this parameter indicates that the Deployment Unit + is unsigned. If this is contrary to the security policy of the + device then the command will be rejected. @@ -106113,9 +111330,10 @@ need to be assigned in order to be able to function at all. If any of these roles are not present in the {{param|#.ExecEnv.{i}.AvailableRoles}} of the - {{object|#.ExecEnv}} into which the DU is to be installed then - the command will fail. Some Agents may apply further filtering - for roles which are considered security- or privacy-sensitive. + {{object|#.ExecEnv}} into which the Deployment Unit is to be + installed then the command will fail. Some Agents may apply + further filtering for roles which are considered security- or + privacy-sensitive. Each entry in the list is the Name of a row in {{object|##.LocalAgent.ControllerTrust.Role}}. If there is no @@ -106143,9 +111361,10 @@ {{object|##.LocalAgent.ControllerTrust.Role}}. If there is no such row, or the matching row is not present in the {{param|#.ExecEnv.{i}.AvailableRoles}} of the Execution - Environment into which the DU is to be installed, then the entry - will be ignored. Some Agents may apply further filtering for - roles which are considered security- or privacy-sensitive. + Environment into which the Deployment Unit is to be installed, + then the entry will be ignored. Some Agents may apply further + filtering for roles which are considered security- or + privacy-sensitive. If this argument is absent or empty then no additional roles are required in order for the application to be able to provide its @@ -106165,16 +111384,20 @@ will need to be assigned in order to be able to function at all. If any of these User Roles are not present in the {{param|#.ExecEnv.{i}.AvailableUserRoles}} of the - {{object|#.ExecEnv}} into which the DU is to be installed then - the command will fail. Some Agents may apply further filtering - for User Roles which are considered security- or - privacy-sensitive. + {{object|#.ExecEnv}} into which the Deployment Unit is to be + installed then the command will fail. Some Agents may apply + further filtering for User Roles which are considered security- + or privacy-sensitive. Each entry in the list is the Name of a row in {{object|##.Users.Role}}. If there is no such row then the command will fail, as installation requires a User Role which is not available on the Device. + The resulting capabilities list of the required User Roles is + listed in + {{param|##.ExecutionUnit.{i}.AvailableUserRoleCapabilities}}. + If this argument is absent or empty then no User Roles are required in order for the application to function. @@ -106190,7 +111413,7 @@ Each entry in the list is an Object Path, Command Path, Event Path, or Parameter Path that determines the element(s) of the - data model that the the application installed by this command has + data model that the application installed by this command has permission to register. The information provided in this input arguement is placed in the @@ -106226,9 +111449,10 @@ command. An auto-restart may be triggered if the Agent determines that the - EU has terminated abnormally. An exponential backoff algorithm is - applied (increasing each time the delay before the EU is - re-launched) in order to prevent continual re-starting of the EU. + Execution Unit has terminated abnormally. An exponential backoff + algorithm is applied (increasing each time the delay before the + Execution Unit is re-launched) in order to prevent continual + re-starting of the Execution Unit. The retry interval range is controlled by two Parameters, {{param|RetryMinimumWaitInterval}} and @@ -106238,14 +111462,15 @@ ''k'' the value of {{param|RetryIntervalMultiplier}}, and ''n'' the current value of {{param|##.ExecutionUnit.{i}.AutoRestart.RetryCount}}. Then on - the next occasion that the Agent determines that the EU has - terminated abnormally, the delay before re-starting the EU must - lie between ''m * (k/1000)^n^'' and ''m * (k/1000)^(n+1)^'' - seconds, so long as ''m * (k/1000)^n^'' evaluates to a value less - than {{param|RetryMaximumWaitInterval}}. Once this point has been + the next occasion that the Agent determines that the Execution + Unit has terminated abnormally, the delay before re-starting the + Execution Unit must lie between ''m * (k/1000)^n^'' and ''m * + (k/1000)^(n+1)^'' seconds, so long as ''m * (k/1000)^n^'' + evaluates to a value less than + {{param|RetryMaximumWaitInterval}}. Once this point has been reached, on all subsequent occasions that the Agent determines - that the EU has terminated abnormally the delay before - re-starting the EU must lie between + that the Execution Unit has terminated abnormally the delay + before re-starting the Execution Unit must lie between {{param|RetryMaximumWaitInterval}}'' * (1000/k)'' and {{param|RetryMaximumWaitInterval}} seconds. @@ -106264,7 +111489,8 @@ Configures the initial delay in {{units}} between detecting - that the EU has terminated abnormally and re-starting it. + that the Execution Unit has terminated abnormally and + re-starting it. @@ -106275,8 +111501,8 @@ - Maximum delay in {{units}} between detecting that the EU has - terminated abnormally and re-starting it. + Maximum delay in {{units}} between detecting that the Execution + Unit has terminated abnormally and re-starting it. @@ -106311,8 +111537,8 @@ - If the EU runs for this number of {{units}} without terminating - abnormally the Agent MAY reset its + If the Execution Unit runs for this number of {{units}} without + terminating abnormally the Agent MAY reset its {{param|##.ExecutionUnit.{i}.AutoRestart.RetryCount}} to zero, thereby resetting the exponential backoff algorithm. A value of zero disables this behavior. @@ -106330,7 +111556,7 @@ version="2.16"> Defines the resource restrictions for any Execution Unit which is - created by installation of the DeploymentUnit. If this object is + created by installation of the Deployment Unit. If this object is absent then no resource restrictions will be applied. @@ -106393,7 +111619,7 @@ functioning of the {{object|##.DeploymentUnit}}. The device should create these application data volumes and add them to the {{object|##.ExecEnv.{i}.ApplicationData}} table, with the UUID of - the DU as ApplicationUUID. + the Deployment Unit as ApplicationUUID. @@ -106449,7 +111675,7 @@ or a restart of the {{object|##.DeploymentUnit}}. The application data will be lost on removal of the - {{object|##.ExecEnv}} in which the DeploymentUnit is to + {{object|##.ExecEnv}} in which the Deployment Unit is to be installed. The application data will be retained on @@ -106481,7 +111707,7 @@ This parameter describes the {{object|##.ExecutionUnit.{i}.HostObject}} instances which should be added to any {{object|##.ExecutionUnit}} created by - installation of the DeploymentUnit. + installation of the Deployment Unit. @@ -106503,8 +111729,8 @@ The object identifier by which the object may be accessed by the ExecutionUnit. This object identifier MUST be valid in the - context of the Execution Environment in which the ExecutionUnit - is installed. + context of the Execution Environment in which the Execution + Unit is installed. @@ -106532,7 +111758,7 @@ This parameter describes the {{object|##.ExecutionUnit.{i}.EnvVariable}} instances which should be added to any {{object|##.ExecutionUnit}} created by - installation of the DeploymentUnit. + installation of the Deployment Unit. @@ -106562,7 +111788,7 @@ - Specifies the network configuration for any ExecutionUnit which + Specifies the network configuration for any Execution Unit which is created by the installation of the DeploymentUnit. When this argument or any of its child objects are missing, the @@ -106570,14 +111796,32 @@ be available to the ExecutionUnit. + + + Specifies whether the resulting Execution Unit will share the + same network namespace as its ExecEnv parent or not. + + If this parameter is set to {{true}}, both + {{param|AccessInterfaces}} list and + {{object|NetworkConfig.PortMapping.{i}.}} input arguments will + be ignored. + + The default value MUST be {{false}}. + + + + + + The network interfaces which the application installed by this command will be allowed to send traffic through it. If any of these access interface are not present in the {{param|.SoftwareModules.ExecEnv.{i}.AvailableAccessInterfaces}} - of the ExecEnv into which the DU is to be installed then the - command will fail. + of the ExecEnv into which the Deployment Unit is to be + installed then the command will fail. Some Agents may apply further filtering for access interfaces which are considered security- or privacy-sensitive. Each entry @@ -106591,7 +111835,7 @@ available. When this argument is absent or {{empty}} then no outgoing - network access is required for the ExecutionUnit to function. + network access is required for the Execution Unit to function. @@ -106605,11 +111849,11 @@ - Defines the list of required port mapping rules for any - ExecutionUnit which is created as a result of this command. If - this command encounters any issue in providing the requested - mapping, such as the port already being used or reserved, then it - will fail. + Defines the list of required port mapping rules for any Execution + Unit which is created as a result of this command. If this + command encounters any issue in providing the requested mapping, + such as the port already being used or reserved, then it will + fail. @@ -106633,7 +111877,7 @@ The external port that the NAT gateway would listen on for traffic to a corresponding InternalPort. Inbound packets to this external port on the selected interface MUST be forwarded - to the IP address associated with the ExecutionUnit on the + to the IP address associated with the Execution Unit on the InternalPort. @@ -106645,8 +111889,8 @@ - The port on ExecutionUnit that the gateway MUST forward traffic - to. + The port on Execution Unit that the gateway MUST forward + traffic to. @@ -106714,27 +111958,28 @@ This event informs a Controller of the completion (successful or - unsuccessful) of a DU state change. + unsuccessful) of a Deployment Unit state change. When used, this event MUST be issued after the device has completed - any file transfers and carried out all operations related to the DU - State Change. + any file transfers and carried out all operations related to the + Deployment Unit State Change. - This event MAY contain the results from multiple DU state changes; it - is implementation specific how the device chooses to aggregate the DU - state changes, although the device MUST notify the Controller of any - DU state changes within 24 hours of the time the operations were - completed by the device. + This event MAY contain the results from multiple Deployment Unit + state changes; it is implementation specific how the device chooses + to aggregate the Deployment Unit state changes, although the device + MUST notify the Controller of any Deployment Unit state changes + within 24 hours of the time the operations were completed by the + device. The device SHOULD make every attempt to aggregate, as much as - possible, the DU State Change notifications to the Controller in the - interest of scalability. + possible, the Deployment Unit State Change notifications to the + Controller in the interest of scalability. - The UUID as defined in {{bibref|RFC4122}} of the DU that affected - by the state change. + The UUID as defined in {{bibref|RFC4122}} of the Deployment Unit + that affected by the state change. @@ -106743,7 +111988,8 @@ - A reference to the DU that was affected by the state change. + A reference to the Deployment Unit that was affected by the state + change. @@ -106755,13 +112001,14 @@ - In the case of an Install, this will be the version of the DU - created. In the case of an Update, it will be the updated version - of the DU. In the case of an Uninstall, it will be the version of - the uninstalled DU. + In the case of an Install, this will be the version of the + Deployment Unit created. In the case of an Update, it will be the + updated version of the Deployment Unit. In the case of an + Uninstall, it will be the version of the uninstalled Deployment + Unit. This MUST match the {{param|#.DeploymentUnit.{i}.Version}} - Parameter contained within the instance of the DeploymentUnit that + Parameter contained within the instance of the Deployment Unit that is contained within the {{param|DeploymentUnitRef}} argument. @@ -106773,22 +112020,23 @@ - The current state of the created DU. + The current state of the created Deployment Unit. - The DU is in an Installed state due to one of the following: - successful Install, successful Update, failed Update, or - failed Uninstall. In the case of a failed Update or failed - Uninstall the Fault argument will contain an explanation of - the failure. + The Deployment Unit is in an Installed state due to one of + the following: successful Install, successful Update, failed + Update, or failed Uninstall. In the case of a failed Update + or failed Uninstall the Fault argument will contain an + explanation of the failure. - The DU was successfully uninstalled from the device. + The Deployment Unit was successfully uninstalled from the + device. {{deprecated|2.19|due to a typographical error in capitalization}} @@ -106796,13 +112044,15 @@ - The DU was successfully uninstalled from the device. + The Deployment Unit was successfully uninstalled from the + device. - The DU could not be installed in which case a DU instance - MUST NOT be created in the Data Model. + The Deployment Unit could not be installed in which case a + Deployment Unit instance MUST NOT be created in the Data + Model. @@ -106811,7 +112061,8 @@ - Whether or not the DU operation resolved all of its dependencies. + Whether or not the Deployment Unit operation resolved all of its + dependencies. In the case of a successful Uninstall, this value is meaningless and should be {{true}}. @@ -106825,17 +112076,20 @@ The Execution Units affected by this operation. - In the case of an Install, this will be the list of EUs that were - created as a result of the DU’s installation. + In the case of an Install, this will be the list of Execution Units + that were created as a result of the Deployment Unit’s + installation. - In the case of an Update, this will be the list of all EUs - currently associated with the updated DU, including those that were - created through the initial DU installation and any updates that - had already occurred but not including any EUs that no longer exist - on the device because of this or previous updates. + In the case of an Update, this will be the list of all Execution + Units currently associated with the updated Deployment Unit, + including those that were created through the initial Deployment + Unit installation and any updates that had already occurred but not + including any Execution Units that no longer exist on the device + because of this or previous updates. - In the case of an Uninstall, this will be the list of the EUs - removed from the device due to the DU being removed. + In the case of an Uninstall, this will be the list of the Execution + Units removed from the device due to the Deployment Unit being + removed. @@ -106874,25 +112128,27 @@ - The operation that was performed against the DU causing the DU - state change. + The operation that was performed against the Deployment Unit + causing the Deployment Unit state change. - The operation attempted was the Installation of a DU. + The operation attempted was the Installation of a Deployment + Unit. - The operation attempted was the Update of an existing DU. + The operation attempted was the Update of an existing + Deployment Unit. The operation attempted was the Un-Installation of an - existing DU. + existing Deployment Unit. @@ -106947,50 +112203,52 @@ Module Management"}}, it SHOULD reject the operation with a 7229 (Invalid Deployment Unit State) fault code. - *If a requested operation attempts to Uninstall a DU that caused - an EE to come into existence, where that EE has at least 1 - installed DU or at least 1 child EE, then the device SHOULD - reject the operation with a 7229 (Invalid Deployment Unit State) + *If a requested operation attempts to Uninstall a Deployment Unit + that caused an EE to come into existence, where that EE has at + least 1 installed Deployment Unit or at least 1 child EE, then + the device SHOULD reject the operation with a 7229 (Invalid + Deployment Unit State) fault code. + + *If a requested operation attempts to Uninstall a Deployment Unit + that caused an ExecEnvClass to come into existence, where at + least one EE exists which instantiates that ExecEnvClass, then + the device SHOULD reject the operation with a 7229 (Invalid + Deployment Unit State) fault code. + + *If a requested operation attempts to Install or Update a + Deployment Unit and the server specified in the URL is not + currently reachable or the request times out, then the device + SHOULD reject the operation with a 7033 (Server Unreachable) fault code. - *If a requested operation attempts to Uninstall a DU that caused - an ExecEnvClass to come into existence, where at least one EE - exists which instantiates that ExecEnvClass, then the device - SHOULD reject the operation with a 7229 (Invalid Deployment Unit - State) fault code. + *If a requested operation attempts to Install or Update a + Deployment Unit and the server specified in the URL fails + security checks (e.g. by not presenting a valid certificate), + then the device SHOULD reject the operation with a 7034 (Server + Insecure) fault code. - *If a requested operation attempts to Install or Update a DU and - the server specified in the URL is not currently reachable or - the request times out, then the device SHOULD reject the - operation with a 7033 (Server Unreachable) fault code. + *If a requested operation attempts to Install or Update a + Deployment Unit and the file returned by the server appears to + be corrupt, then the device SHOULD reject the operation with a + 7035 (Corrupt Data) fault code. - *If a requested operation attempts to Install or Update a DU and - the server specified in the URL fails security checks (e.g. by - not presenting a valid certificate), then the device SHOULD - reject the operation with a 7034 (Server Insecure) fault code. + *If a requested operation attempts to Install or Update a + Deployment Unit and the file returned by the server does not + match the signature provided, or a required signature is absent, + then the device SHOULD reject the operation with a 7036 (Bad + Signature) fault code. - *If a requested operation attempts to Install or Update a DU and - the file returned by the server appears to be corrupt, then the - device SHOULD reject the operation with a 7035 (Corrupt Data) - fault code. + *If a requested operation attempts to Install or Update a + Deployment Unit and includes a RequestedRole argument which + contains at least one Role which is not in the EE's + AvailableRoles list, then the device SHOULD reject the operation + with a 7032 (Unavailable Role) fault code. - *If a requested operation attempts to Install or Update a DU and - the file returned by the server does not match the signature - provided, or a required signature is absent, then the device - SHOULD reject the operation with a 7036 (Bad Signature) fault - code. - - *If a requested operation attempts to Install or Update a DU and - includes a RequestedRole argument which contains at least one - Role which is not in the EE's AvailableRoles list, then the - device SHOULD reject the operation with a 7032 (Unavailable - Role) fault code. - - *If a requested operation attempts to Install or Update a DU and - includes a RequestedUserRole argument which contains at least - one User Role which is not in the EE's AvailableUserRoles list, - then the device SHOULD reject the operation with a 7037 - (Unavailable User Role) fault code. + *If a requested operation attempts to Install or Update a + Deployment Unit and includes a RequestedUserRole argument which + contains at least one User Role which is not in the EE's + AvailableUserRoles list, then the device SHOULD reject the + operation with a 7037 (Unavailable User Role) fault code. @@ -107078,7 +112336,7 @@ - A reference to the DeploymentUnit (if any) by which this {{object}} + A reference to the Deployment Unit (if any) by which this {{object}} was created. @@ -107147,9 +112405,9 @@ The roles which are available to Deployment Units installed into the new instance. Only the listed roles may be assigned to any - DeploymentUnit installed into the instance. If this parameter is + Deployment Unit installed into the instance. If this parameter is missing or {{empty}} then no roles may be assigned to any - DeploymentUnit installed into the instance. + Deployment Unit installed into the instance. Each entry in the list is the Name of a row in {{object|###.LocalAgent.ControllerTrust.Role}}. If there is no @@ -107167,9 +112425,9 @@ The User Roles which are available to Deployment Units installed into the new instance. Only the listed User Roles may be assigned - to any DeploymentUnit installed into the instance. If this + to any Deployment Unit installed into the instance. If this parameter is missing or {{empty}} then no User Roles may be - assigned to any DeploymentUnit installed into the instance. + assigned to any Deployment Unit installed into the instance. Each entry in the list is the Name of a row in {{object|###.Users.Role}}. If there is no such row then the entry @@ -107636,12 +112894,14 @@ - + Represents the processors that this {{object}} has available to it. {{deprecated|2.18|because the referenced object,{{object|##.DeviceInfo.Processor.}}, is deprecated.}} + + {{obsoleted|2.20}} @@ -107750,7 +113010,7 @@ DeploymentUnit. If this parameter is missing or {{empty}} then no roles will be - assigned to any DeploymentUnit installed into this {{object}}. + assigned to any Deployment Unit installed into this {{object}}. @@ -107766,7 +113026,7 @@ version="2.17"> Represents the network interface through which the outgoing traffic - from the ExecutionUnit running in this {{object}} may be allowed. + from the Execution Unit running in this {{object}} may be allowed. This value can be altered by executing the {{command|ModifyAvailableAccessInterfaces()}}. @@ -107972,7 +113232,7 @@ Deployment Units installed into this {{object}}. The command will fail if the new list of access interfaces doesn't - contain an access interface required for a DeploymentUnit installed + contain an access interface required for a Deployment Unit installed previously into the {{object}}. @@ -107980,7 +113240,7 @@ The new list of access interfaces which may be assigned to any - DeploymentUnit installed into the {{object}} this list replaces + Deployment Unit installed into the {{object}} this list replaces the previous value of {{param|#.AvailableAccessInterfaces}}. If this parameter is an empty string then no access interface may be assigned to any DeploymentUnit installed into the {{object}}. @@ -108099,17 +113359,18 @@ If this parameter is present and is {{true}}, the ExecEnv will be - removed even if one or more DU is installed in it. A + removed even if one or more Deployment Unit is installed in it. A {{event|###.DUStateChange!}} Event with {{param|###.DUStateChange!.OperationPerformed}} set to {{enum|Uninstall|###.DUStateChange!.OperationPerformed}} will be - issued for each DU which is removed as a result of the operation. - Any Application Data associated with the DU will be lost. + issued for each Deployment Unit which is removed as a result of + the operation. Any Application Data associated with the + Deployment Unit will be lost. If this parameter is absent or {{false}}, the operation will fail - if any DU is installed in the EE; in the case of such a failure - the EE will continue to exist and its Status will not change, nor - will any Application Data be lost. + if any Deployment Unit is installed in the EE; in the case of + such a failure the EE will continue to exist and its Status will + not change, nor will any Application Data be lost. @@ -108599,8 +113860,8 @@ - The {{datatype}} that specifies the location of the DU to be - installed. + The {{datatype}} that specifies the location of the Deployment + Unit to be installed. The URL MUST NOT include the "userinfo" component, as defined in {{bibref|RFC3986}}. @@ -108646,9 +113907,9 @@ - This parameter determines whether the containerized application - runs in privileged mode. {{false}} - Unprivileged Container. - {{true}} - Privileged Container. + This parameter determines whether the application runs in + privileged mode. {{false}} - Unprivileged Container. {{true}} - + Privileged Container. @@ -108658,10 +113919,11 @@ - Number of UIDs (EU User Identifiers) that this container will - need as part of its user namespace. UIDs are unique identifiers - associated with each user and system process that is used to - determine the allocation and isolation of system resources. + Number of UIDs (Execution Unit User Identifiers) that this + container will need as part of its user namespace. UIDs are + unique identifiers associated with each user and system process + that is used to determine the allocation and isolation of system + resources. {{deprecated|2.19|because this parameter should not be required.}} @@ -108675,9 +113937,9 @@ The {{datatype}} which can be used to fetch the signature for - this DU. The {{datatype}} may use the "data" scheme defined in - {{bibref|RFC2397}} in order to incorporate the signature into the - command directly. + this Deployment Unit. The {{datatype}} may use the "data" scheme + defined in {{bibref|RFC2397}} in order to incorporate the + signature into the command directly. Several signature formats are in common use; the device may deduce the format used from the Content-Type of the retrieved @@ -108689,9 +113951,9 @@ HTTPS transport MUST be supported. Other optional transports MAY be supported. - The absence of this parameter indicates that the DU is unsigned. - If this is contrary to the security policy of the device then the - command will be rejected. + The absence of this parameter indicates that the Deployment Unit + is unsigned. If this is contrary to the security policy of the + device then the command will be rejected. @@ -108707,9 +113969,10 @@ If any of these roles are not present in the {{param|##.ExecEnv.{i}.AvailableRoles}} of the - {{object|###.ExecEnv}} in which the DU is installed then the - command will fail. Some Agents may apply further filtering for - roles which are considered security- or privacy-sensitive. + {{object|###.ExecEnv}} in which the Deployment Unit is installed + then the command will fail. Some Agents may apply further + filtering for roles which are considered security- or + privacy-sensitive. Each entry in the list is the Name of a row in {{object|###.LocalAgent.ControllerTrust.Role}}. If there is no @@ -108738,9 +114001,10 @@ {{object|###.LocalAgent.ControllerTrust.Role}}. If there is no such row, or the matching row is not present in the {{param|##.ExecEnv.{i}.AvailableRoles}} of the Execution - Environment into which the DU is to be installed, then the entry - will be ignored. Some Agents may apply further filtering, for - roles which are considered security- or privacy-sensitive. + Environment into which the Deployment Unit is to be installed, + then the entry will be ignored. Some Agents may apply further + filtering, for roles which are considered security- or + privacy-sensitive. If this argument is empty then no additional roles are required in order for the application to be able to provide its full @@ -108763,15 +114027,20 @@ If any of these User Roles are not present in the {{param|##.ExecEnv.{i}.AvailableUserRoles}} of the - {{object|###.ExecEnv}} in which the DU is installed then the - command will fail. Some Agents may apply further filtering for - User Roles which are considered security- or privacy-sensitive. + {{object|###.ExecEnv}} in which the Deployment Unit is installed + then the command will fail. Some Agents may apply further + filtering for User Roles which are considered security- or + privacy-sensitive. Each entry in the list is the Name of a row in {{object|###.Users.Role}}. If there is no such row then the command will fail, as installation requires a User Role which is not available on the Device. + The resulting capabilities list of the required User Roles is + listed in + {{param|##.ExecutionUnit.{i}.AvailableUserRoleCapabilities}}. + If this argument is {{empty}} then no User Roles are required in order for the application to function. @@ -109059,8 +114328,8 @@ The object identifier by which the object may be accessed by the ExecutionUnit. This object identifier MUST be valid in the - context of the Execution Environment in which the ExecutionUnit - is installed. + context of the Execution Environment in which the Execution + Unit is installed. @@ -109120,7 +114389,7 @@ - Specifies the network configuration for any ExecutionUnit which + Specifies the network configuration for any Execution Unit which is created by the update of the DeploymentUnit. The new network configuration supersedes any previous configuration. @@ -109129,14 +114398,32 @@ network configuration remains unaltered. + + + Specifies whether the resulting Execution Unit will share the + same network namespace as its ExecEnv parent or not. + + If this parameter is set to {{true}}, both + {{param|AccessInterfaces}} list and + {{object|NetworkConfig.PortMapping.{i}.}} input arguments will + be ignored. + + The default value MUST be {{false}}. + + + + + + The network interfaces which the application updated by this command will be allowed to send traffic through it. If any of these access interface are not present in the {{param|.SoftwareModules.ExecEnv.{i}.AvailableAccessInterfaces}} - of the ExecEnv into which the DU is to be updated then the - command will fail. + of the ExecEnv into which the Deployment Unit is to be updated + then the command will fail. Some Agents may apply further filtering for access interfaces which are considered security- or privacy-sensitive. Each entry @@ -109159,8 +114446,8 @@ {{command|.SoftwareModules.DeploymentUnit.{i}.Update()}}, {{param}} configuration supersedes any previous configuration. If {{param}} is absent or {{empty}}, it indicate that no - outgoing network access is required for the resulting - ExecutionUnit to function. + outgoing network access is required for the resulting Execution + Unit to function. @@ -109174,11 +114461,11 @@ - Defines the list of required port mapping rules for any - ExecutionUnit which is created as a result of this command. If - this command encounters any issue in providing the requested - mapping, such as the port already being used or reserved, then it - will fail. + Defines the list of required port mapping rules for any Execution + Unit which is created as a result of this command. If this + command encounters any issue in providing the requested mapping, + such as the port already being used or reserved, then it will + fail. When the argument {{object|NetworkConfig}} is absent or {{empty}} for the {{command|.SoftwareModules.DeploymentUnit.{i}.Update()}}, @@ -109188,7 +114475,7 @@ {{command|.SoftwareModules.DeploymentUnit.{i}.Update()}}, {{object}} configuration supersedes any previous configuration. If {{object}} is absent or {{empty}}, it indicate that no port - mapping is required for the resulting ExecutionUnit to function. + mapping is required for the resulting Execution Unit to function. @@ -109212,7 +114499,7 @@ The external port that the NAT gateway would listen on for traffic to a corresponding InternalPort. Inbound packets to this external port on the selected interface MUST be forwarded - to the IP address associated with the ExecutionUnit on the + to the IP address associated with the Execution Unit on the InternalPort. @@ -109224,8 +114511,8 @@ - The port on ExecutionUnit that the gateway MUST forward traffic - to. + The port on Execution Unit that the gateway MUST forward + traffic to. @@ -109616,9 +114903,9 @@ This parameter is allocated by the host system. This is the user identifier within the execution unit's environment. This UID is local - to the execution unit and is used by the EU's internal processes to - manage permissions. By default, processes within the EU execute as - root (UID 0) unless otherwise specified. + to the execution unit and is used by the Execution Unit's internal + processes to manage permissions. By default, processes within the + Execution Unit execute as root (UID 0) unless otherwise specified. @@ -109629,8 +114916,8 @@ This parameter is allocated by the host system. This is the group identifier within the execution unit's environment. This GID is local - to the execution unit and is used by the EU's internal processes to - manage permissions. + to the execution unit and is used by the Execution Unit's internal + processes to manage permissions. @@ -109640,8 +114927,8 @@ This parameter is allocated by the host system. This is the user - identifier on the host system where this EU is running. This UID is - system wide and is managed by the kernel. + identifier on the host system where this Execution Unit is running. + This UID is system wide and is managed by the kernel. @@ -109651,8 +114938,8 @@ This parameter is allocated by the host system. This is the group - identifier on the host system where this EU is running. This GID is - system wide and is managed by the kernel. + identifier on the host system where this Execution Unit is running. + This GID is system wide and is managed by the kernel. @@ -109661,7 +114948,7 @@ - The date and time when the EU was created. + The date and time when the Execution Unit was created. @@ -109670,8 +114957,8 @@ - The amount of time in {{units}} that this EU has been up and running - since it was activated. + The amount of time in {{units}} that this Execution Unit has been up + and running since it was activated. @@ -109822,6 +115109,82 @@ + + + Each item in the list represents a mandatory ControllerTrust Role + that was required by {{param|#.InstallDU().RequiredRoles}} or + {{param|#.DeploymentUnit.{i}.Update().RequiredRoles}} when the + {{object}} was created or updated. + + Note, the description of the + {{object|.LocalAgent.ControllerTrust.Role.}} table indicates that the + device MAY reject deletion requests for specific instances of that + object, which could cause instability for this {{object}}. + + + + + + + + + + + + Each item in the list represents an optional ControllerTrust Role + that was required by {{param|#.InstallDU().OptionalRoles}} or + {{param|#.DeploymentUnit.{i}.Update().OptionalRoles}} when the + {{object}} was created or updated. + + + + + + + + + + + + Each item in the list represents a User Role that was required by + {{param|#.InstallDU().RequiredUserRoles}} or + {{param|#.DeploymentUnit.{i}.Update().RequiredUserRoles}} when the + {{object}} was created or updated. + + Note, the description of the {{object|.Users.Role.}} table indicates + that the device MAY reject deletion requests for specific instances + of that object, which could cause instability for this {{object}}. + + + + + + + + + + + + This is the list of User Role instances that in turn yields a set of + capabilities available to this {{object}}. This list is evaluated + only at the start of this {{object}} based on the configuration of + {{param|RequiredUserRoles}} and + {{param|.Users.Role.{i}.RequiredCapabilities}}. + + + + + + + + + Set the state transition that the Controller is requesting for this @@ -109898,12 +115261,14 @@ - Configures the parameters of the auto-restart algorithm for this EU. + Configures the parameters of the auto-restart algorithm for this + Execution Unit. - An auto-restart may be triggered if the Agent determines that the EU - has terminated abnormally. An exponential backoff algorithm is applied - (increasing each time the delay before the EU is re-launched) in order - to prevent continual re-starting of the EU. + An auto-restart may be triggered if the Agent determines that the + Execution Unit has terminated abnormally. An exponential backoff + algorithm is applied (increasing each time the delay before the + Execution Unit is re-launched) in order to prevent continual + re-starting of the Execution Unit. The retry interval range is controlled by two Parameters, {{param|RetryMinimumWaitInterval}} and @@ -109912,19 +115277,20 @@ Let ''m'' be the value of {{param|RetryMinimumWaitInterval}}, ''k'' the value of {{param|RetryIntervalMultiplier}}, and ''n'' the current value of {{param|RetryCount}}. Then on the next occasion that the Agent - determines that the EU has terminated abnormally, the delay before - re-starting the EU must lie between ''m * (k/1000)^n^'' and ''m * - (k/1000)^(n+1)^'' seconds, so long as ''m * (k/1000)^n^'' evaluates to - a value less than {{param|RetryMaximumWaitInterval}}. Once this point - has been reached, on all subsequent occasion that the Agent determines - that the EU has terminated abnormally the delay before re-starting the - EU must lie between {{param|RetryMaximumWaitInterval}}'' * (1000/k)'' - and {{param|RetryMaximumWaitInterval}} seconds. + determines that the Execution Unit has terminated abnormally, the delay + before re-starting the Execution Unit must lie between ''m * + (k/1000)^n^'' and ''m * (k/1000)^(n+1)^'' seconds, so long as ''m * + (k/1000)^n^'' evaluates to a value less than + {{param|RetryMaximumWaitInterval}}. Once this point has been reached, + on all subsequent occasion that the Agent determines that the Execution + Unit has terminated abnormally the delay before re-starting the + Execution Unit must lie between {{param|RetryMaximumWaitInterval}}'' * + (1000/k)'' and {{param|RetryMaximumWaitInterval}} seconds. - Enable the auto-restart feature for this EU. + Enable the auto-restart feature for this Execution Unit. @@ -109935,7 +115301,7 @@ Configures the initial delay in {{units}} between detecting that the - EU has terminated abnormally and re-starting it. + Execution Unit has terminated abnormally and re-starting it. @@ -109947,7 +115313,7 @@ Configures the maximum delay in {{units}} between detecting that the - EU has terminated abnormally and re-starting it. + Execution Unit has terminated abnormally and re-starting it. @@ -109980,10 +115346,10 @@ - If the EU runs for this number of {{units}} without terminating - abnormally the Agent MAY reset the {{param|RetryCount}} to zero, - thereby resetting the exponential backoff algorithm. A value of zero - disables this behavior. + If the Execution Unit runs for this number of {{units}} without + terminating abnormally the Agent MAY reset the {{param|RetryCount}} + to zero, thereby resetting the exponential backoff algorithm. A value + of zero disables this behavior. @@ -109994,9 +115360,9 @@ - The number times the EU has terminated abnormally and a restart has - been attempted. Resetting this parameter to zero has the effect of - re-initialising the exponential back-off algorithm. + The number times the Execution Unit has terminated abnormally and a + restart has been attempted. Resetting this parameter to zero has the + effect of re-initialising the exponential back-off algorithm. Invoking the {{command|#.Restart()}} command also has the effect of resetting this parameter to zero. @@ -110033,14 +115399,14 @@ Parameters of the network configuration for this ExecutionUnit. - When no network configuration is provided, the EU will not have any - network access. + When no network configuration is provided, the Execution Unit will not + have any network access. Represents the network interface through which the traffic from the - EU will be allowed. + Execution Unit will be allowed. @@ -110053,7 +115419,8 @@ - Represents the list of Port mappings associated with this EU. + Represents the list of Port mappings associated with this Execution + Unit. @@ -110098,7 +115465,7 @@ The object identifier by which the object may be accessed by the ExecutionUnit. This object identifier MUST be valid in the context of - the Execution Environment in which the ExecutionUnit is installed. + the Execution Environment in which the Execution Unit is installed. @@ -113041,9 +118408,40 @@ + + + Specifies the IP protocol version, following the definitions in + {{bibref|IANA-ipversionnumbers}}. Valid values are: {{range}}. + + + + + + IPv4 + + + + + IPv6 + + + + + No specific IP version is required + + + + + + + Host name or IP address of the MQTT Broker. + + If the value of this parameter is an host name, the resolved IP + address will be either IPv4 or IPv6, based on the value of the + {{param|IPVersion}} parameter. @@ -113499,6 +118897,44 @@ + + + Specifies the client certificate that must be presented to the remote + server for mutual authentication. This certificate is used to + authenticate the client by the remote server, ensuring that the + remote server is communicating with a trusted client. The client + certificate must be issued by a trusted Certificate Authority (CA) + and should match the client's private key. This parameter is + applicable only when a TLS session is being used. + + + + + + + + + + + + Specifies the group of CA certificate(s) that the client must use to + validate the certificate presented by the remote server. These CA + certificates form a trust chain that the server certificate must + match, ensuring that only servers with trusted certificates can + establish a connection. This parameter supports multiple CA + certificates to accommodate different server certificate issuers. + This parameter is applicable only when a TLS session is being used. + + + + + + + + + @@ -114057,6 +119493,47 @@ + + + Specifies the IP protocol version, following the definitions in + {{bibref|IANA-ipversionnumbers}}. Valid values are: {{range}}. + + + + + + IPv4 + + + + + IPv6 + + + + + No specific IP version is required + + + + + + + + + + Indicates the transport protocol to be used for the MQTT broker + connection. + + + + + + + + + Port used by the MQTT Broker. @@ -114072,7 +119549,9 @@ If {{empty}} is specified, the CPE MUST bind the MQTT broker to all - available interfaces. + available interfaces, which depends on the value of the + {{param|IPVersion}} parameter. Meaning that the broker will bind to + an IPv4 address, an IPv6 address, or both. @@ -114111,6 +119590,44 @@ + + + Specifies the server certificate to be presented by the server during + the TLS handshake. This certificate is used to authenticate the + server to remote clients, ensuring that the clients are connecting to + a legitimate server. The server certificate must be issued by a + trusted Certificate Authority (CA) and should match the server's + private key. This parameter is applicable only when a TLS session is + being used. + + + + + + + + + + + + Specifies the group of CA certificate(s) that the server must use to + validate the certificate presented by the remote client. These CA + certificates form a trust chain that the client certificate must + match, ensuring that only clients with trusted certificates can + establish a connection. This parameter supports multiple CA + certificates to accommodate different client certificate issuers. + This parameter is applicable only when a TLS session is being used. + + + + + + + + + {{numentries}} @@ -114370,6 +119887,44 @@ + + + Specifies the client certificate that must be presented to the remote + server for mutual authentication. This certificate is used to + authenticate the client by the remote server, ensuring that the + remote server is communicating with a trusted client. The client + certificate must be issued by a trusted Certificate Authority (CA) + and should match the client's private key. This parameter is + applicable only when a TLS session is being used. + + + + + + + + + + + + Specifies the group of CA certificate(s) that the client must use to + validate the certificate presented by the remote server. These CA + certificates form a trust chain that the server certificate must + match, ensuring that only servers with trusted certificates can + establish a connection. This parameter supports multiple CA + certificates to accommodate different server certificate issuers. + This parameter is applicable only when a TLS session is being used. + + + + + + + + + Message retry time in {{units}} defines the wait time before a MQTT @@ -114554,6 +120109,33 @@ + + + Specifies the IP protocol version, following the definitions in + {{bibref|IANA-ipversionnumbers}}. Valid values are: {{range}}. + + + + + + IPv4 + + + + + IPv6 + + + + + No specific IP version is required + + + + + + + Fully Qualified Domain Name (FQDN) or IP address of the MQTT broker @@ -114565,6 +120147,10 @@ addresses are exhausted, in which case the next {{object}} instance (based on rules defined over the selected {{param|##.Bridge.{i}.ServerSelectionAlgorithm}}) SHOULD be used. + + If the value of this parameter is an host name, the resolved IP + address will be either IPv4 or IPv6, based on the value of the + {{param|IPVersion}} parameter. @@ -115365,6 +120951,29 @@ This object describes the LEDs on the device. + + + The maximum allowed brightness level for all LEDs, expressed as a + {{units}}. + + This value is relative to the maximum allowed brightness value of + each LED, which is specified in {{param|LED.{i}.MaxBrightness}}. + + Valid values are: {{range}}. + + + + + + The value 0 indicates that all LEDs are turned off, while the + value 100 indicates the maximum brightness. + + + + + + + {{numentries}} @@ -115651,6 +121260,9 @@ The desired brightness level for this element of the cycle period, expressed as a {{units}}, relative to the maximum allowed brightness value specified in {{param|#.MaxBrightness}}. + + The value should not exceed the maximum brightness level specified in + {{param|##.BrightnessLimiter}}. @@ -116045,7 +121657,7 @@ Identifier of the measurement point indicating where the measurement - agent is located on a path as defined in [bibref|RFC7398}}. + agent is located on a path as defined in {{bibref|RFC7398}}. @@ -118647,7 +124259,7 @@ establishment. Table entries are used in precedence order until a successful PDU session is established. - See ((bibref|3GPP-TS.23.503|Annex A}} for an example URSP rule + See {{bibref|3GPP-TS.23.503|Annex A}} for an example URSP rule traversal. @@ -119584,7 +125196,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -119633,7 +125245,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -119644,7 +125256,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -119656,7 +125268,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -119930,7 +125542,7 @@ - + Enables or disables the interface. @@ -119942,7 +125554,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -119992,7 +125604,7 @@ - + The textual name of the logical interface as assigned by a static configuration file or dynamically by a controller. @@ -120004,7 +125616,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -120016,7 +125628,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -120297,6 +125909,54 @@ + + + Describes the possible power states of the {{object}} regardless of + its current administrative state. + + + + + + + Indicates that the {{object}} is powered on. + + + + + Indicates that the {{object}} is powered off, using no power. + + When powered off, the {{object}} must be properly stopped. In + particular, if applicable, a dying gasp message on the + interface MUST be properly administered according to the + respective standards. + + + + + Indicates that the {{object}} is in a low-power state, using + minimal power. + + + + + + + + + Reports the current power status of the {{object}}. + + {{reference}} + + {{enum}} + + + + + + + + The textual name of the ONU as assigned by the CPE. @@ -120363,6 +126023,27 @@ + + + + Sets the power state of the {{object}} asynchronously. + + + + + + Targeted power state. + + {{enum}} + + + + + + + + + - + Indicates whether this interface is enabled ({{true}}) or not ({{false}}). If the ONU is managed via OMCI, the interface is enabled @@ -120410,7 +126091,7 @@ - + The current operational state of the interface (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} @@ -120466,7 +126147,7 @@ - + The textual name of the interface as assigned by the CPE. @@ -120477,7 +126158,7 @@ - + The accumulated time in {{units}} since the interface entered its current operational state. @@ -120489,7 +126170,7 @@ - + {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. @@ -122304,6 +127985,192 @@ + + + This object models the power reduction management capabilities of the + ONU. It is based on {{bibref|G.988|Section 9.1.14 ONU dynamic power + management control}}. + + When {{param|OLTSleepAllow}} is true then the ONU is allowed to enter a + low power state. + + {{bibref|G.Sup45|Clause 7.5.2 Main power-saving methods}}. + + {{bibref|G.988|Section 9.1.14 ONU dynamic power management control}}. + + + + + This parameter indicates the sleep mode capability of the {{object}}. + + This parameter is based on {{bibref|G.988|Section 9.1.14 ONU dynamic + power management control}}. + + An {{empty}} string indicates that no capabilities are supported. + + + + + + + + + + + + + + This parameter indicates that the ONU is allowed, by the OLT, to + apply the power reduction mode. + + + + + + + + + This parameter indicates the current power reduction management + status of the ONU. + + The ONU can be in one of the following states: {{enum}}. + + + + + + The ONU is fully operational and not in a low power state + + + + + The ONU is in Low Power Watchful Sleep Mode + + + + The ONU is in Low Power Doze Mode + + + The ONU is in Low Power Sleep Mode + + + + + + + + Optical Network Unit (ONU) vendor's statement of the complete + transceiver initialization time: the worst-case time required for the + ONU to regain full functionality when leaving the asleep state (i.e., + turning on both the receiver and the transmitter and acquiring + synchronization to the downstream flow), measured in units of + {{units}}. The value zero indicates that the sleeping ONU can respond + to a bandwidth grant without delay. + + Reference {{bibref|G.988|Section 9.1.14 ONU dynamic power management + control}} + + + + + + + + + + + This parameter is the Optical Network Unit (ONU) vendor's statement + of the transmitter initialization time: the time required for the ONU + to regain full functionality when leaving the listen state (i.e., + turning on the transmitter), measured in units of {{units}}. The + value zero indicates that the dozing ONU can respond to a bandwidth + grant without delay. + + Reference {{bibref|G.988|Section 9.1.14 ONU dynamic power management + control}} + + + + + + + + + + + The Isleep/Ilowpower attribute specifies the maximum time the ONU + spends in its asleep, listen, or low-power states, as a count of + {{units}}. Local or remote events may truncate the ONU's sojourn in + these states. The default value of this attribute is 0. + + + + + + + + + + + The Iaware attribute specifies the time the ONU spends in its aware + state, as a count of {{units}}, before it re-enters asleep or listen + states. Local or remote events may independently cause the ONU to + enter an active state rather than returning to a sleep state. The + default value of this attribute is 0. + + Reference {{bibref|G.988|Section 9.1.14 ONU dynamic power management + control}} + + + + + + + + + + + The Ihold attribute specifies the minimum time during which the ONU + remains in the active held state, as a count of {{units}}. Its + initial value is zero. + + Reference {{bibref|G.988|Section 9.1.14 ONU dynamic power management + control}} + + + + + + + + + + + This parameter designates maximum sleep interval values for doze mode + and cyclic sleep mode separately. When it supports this attribute, + the ONU ignores the value of the maximum sleep interval attribute. + Maximum sleep interval for doze mode and cyclic sleep mode are both 4 + bytes. Maximum sleep interval for doze mode specifies the maximum + time the ONU spends in its listen state, as a count of {{units}}. + Local or remote events may truncate the ONU's sojourn in these + states. The default value is 0. Maximum sleep interval for cyclic + sleep mode specifies the maximum time the ONU spends in its asleep + state, as a count of {{units}}. Local or remote events may truncate + the ONU's sojourn in these states. The default value is 0. If + watchful sleep is enabled, the ONU ignores this attribute. + + Reference {{bibref|G.988|Section 9.1.14 ONU dynamic power management + control}} + + + + + + + + + @@ -122522,10 +128389,24 @@ + + + The time, in {{units}}, that an IP address is banned after exceeding + the {{param|MaxAuthTries}}. A value of ''0'' disables this feature. + + + + + + + + + - Allow access from any IPv4 address. The source prefixes defined in - {{param|IPv4AllowedSourcePrefix}} will be ignored. + Allow incoming IP connections from any IPv4 address. The source + prefixes defined in {{param|IPv4AllowedSourcePrefix}} will be + ignored. @@ -122536,10 +128417,11 @@ - Allow only access from the provided list of IPv4 prefixes. + Allow only incoming IP connections from the provided list of IPv4 + prefixes. When {{param}} is set to {{empty}} and {{param|AllowAllIPv4}} is set - to ''false'', no incoming connections are allowed. + to ''false'', no incoming IP connections are allowed. When {{param|AllowAllIPv4}} is set ''true'', {{param}} is ignored. @@ -122553,8 +128435,9 @@ - Allow access from any IPv6 address. The source prefixes defined in - {{param|IPv6AllowedSourcePrefix}} will be ignored. + Allow incoming IP connections from any IPv6 address. The source + prefixes defined in {{param|IPv6AllowedSourcePrefix}} will be + ignored. @@ -122565,10 +128448,11 @@ - Allow only access from the provided list of IPv6 prefixes. + Allow only incoming IP connections from the provided list of IPv6 + prefixes. When {{param}} is set to {{empty}} and {{param|AllowAllIPv6}} is set - to ''false'', no incoming connections are allowed. + to ''false'', no incoming IP connections are allowed. When {{param|AllowAllIPv6}} is set ''true'', {{param}} is ignored. @@ -122940,6 +128824,61 @@ + + + + {{numentries}} + + + + + + + + + + This object contains the authentication details for USP Endpoints + connecting to Unix Domain Sockets requiring authentication. Endpoints + not present in this table will be unable to authenticate successsfully + on Unix Domain Sockets requiring authentication. + + + + + + + + Enable/Disable this {{object}} instance. + + + + + + + + + The unique USP identifier of the USP Endpoint. + + + + + + + + + Expected password to be used by the USP Endpoint to authenticate. If + set to an empty string, the USP Endpoint will be unable to + authenticate successsfully on Unix Domain Sockets requiring + authentication. + + + + + + + + + When {{true}}, USP Endpoints connecting to this Unix Domain Socket + MUST authenticate themselves. + + + + + + + + + When {{true}}, USP Agents connecting to this Unix Domain Socket are + only allowed to register data model paths permitted by the + {{object|##.USPServices.Trust}} table. When {{false}}, USP Agents + connecting to this Unix Domain Socket may register any data model + paths (subject to the rules affecting USP Services). + + + + + - Each instance of this object provides a schedule where access is - enabled. + Represents a schedule that can be applied to a feature or resource. @@ -124233,7 +130195,7 @@ - {{list|the days for which access is enabled}} {{enum}} + {{list|the days on which the schedule is active}} {{enum}} @@ -124268,13 +130230,14 @@ - The duration, in {{units}}, which the access is enabled. + The duration, in {{units}}, for which the associated schedule is + active. - If the {{param|StartTime}} is not defined, duration is the total time - access is allowed during a calendar day. + If {{param|StartTime}} is not defined, this duration represents the + total time the schedule is active during a calendar day. - If a {{param|StartTime}} is defined, access is allowed for the - {{param}} period starting from {{param|StartTime}}. + If {{param|StartTime}} is defined, the schedule is active for the + specified duration starting from {{param|StartTime}}. @@ -124286,9 +130249,19 @@ - When enabled, the Inverse Mode reverses the default behavior of the - schedule, creating a dynamic where actions that are typically - activated are now deactivated, and vice versa. + When enabled, this parameter inverts the behavior of the associated + schedule. Actions that would normally be active during the defined + schedule are instead inactive, and actions that would normally be + inactive are instead active. + + For example: If a schedule defines Internet access on Monday from + 16:00 to 17:00: + + * With {{param}} = {{false}}, Internet access is permitted only + between 16:00 and 17:00 on Monday. + + * With {{param}} = {{true}}, Internet access is permitted at all + times except between 16:00 and 17:00 on Monday. @@ -125034,6 +131007,57 @@ + + + Enables or disables the interface. + + This parameter is based on ''ifAdminStatus'' from {{bibref|RFC2863}}. + + + + + + + + + The current operational state of the interface (see + {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} + + When {{param|Enable}} is {{false}} then {{param}} SHOULD normally be + {{enum|Down}} (or {{enum|NotPresent}} or {{enum|Error}} if there is a + fault condition on the interface). + + When {{param|Enable}} is changed to {{true}} then {{param}} SHOULD + change to {{enum|Up}} if and only if the interface is able to + transmit and receive network traffic; it SHOULD change to + {{enum|Dormant}} if and only if the interface is operable but is + waiting for external actions before it can transmit and receive + network traffic (and subsequently change to {{enum|Up}} if still + operable when the expected actions have completed); it SHOULD change + to {{enum|LowerLayerDown}} if and only if the interface is prevented + from entering the {{enum|Up}} state because one or more of the + interfaces beneath it is down; it SHOULD remain in the {{enum|Error}} + state if there is an error or other fault condition detected on the + interface; it SHOULD remain in the {{enum|NotPresent}} state if the + interface has missing (typically hardware) components; it SHOULD + change to {{enum|Unknown}} if the state of the interface can not be + determined for some reason. + + This parameter is based on ''ifOperStatus'' from {{bibref|RFC2863}}. + + + + + + + + + + + + + + {{datatype|expand}} @@ -125043,6 +131067,44 @@ + + + The textual name of the interface as assigned by the CPE. + + + + + + + + + + + The accumulated time in {{units}} since the interface entered its + current operational state. + + + + + + + + + + + {{list}} {{reference|an interface object that is stacked immediately + below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. + + + + + + + + + + + {{reference}} The IP Interface associated with the ''Session'' entry. @@ -125079,6 +131141,7 @@ + @@ -125117,6 +131180,163 @@ + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + + This object models IPv4 network information that the Cellular modem + received from the network. + + + + + + + + + + + + {{datatype|expand}} + + + + + + + + + IPv4 address. + + + + + + + + + Subnet mask. + + + + + + + + + IPv4 address of the gateway. + + + + + + + + + Maximum Transmission Unit for this link (expressed in {{units}}). + + {{range}} + + + + + + + + + + + + + This object models IPv6 network information that the Cellular modem + received from the network. + + + + + + + + + + + {{datatype|expand}} + + + + + + + + + IPv6 address. + + + + + + + + + IPv6 prefix. {{empty}} indicates that it matches all destination + prefixes (i.e. equivalent to "::/0"). All bits to the right of the + prefix MUST be zero, e.g. 2001:edff:fe6a:f76::/64. + + Routes with a 128-bit prefix length (/128) are host routes for a + specific IPv6 destination, e.g. + 2001:db8:28:2:713e:a426:d167:37ab/128. + + + + + + + + + IPv6 address of the next hop. + + + + + + + + + Maximum Transmission Unit for this link (expressed in {{units}}). + + {{range}} + + + + + + + + + + + Represents the hardware configuration of the device, including details + about the CPU, memory, and other hardware components. + + + + + + Represents the system's CPU configuration, providing details about each + individual processor core, its capabilities, and its current operating + state. + + + + + {{numentries}} + + + + + + + + + + Represents a single CPU instance with configurable parameters related + to its operational settings. + + + + + + + + {{datatype|expand}} + + + + + + + + + + Represents the CPU's Dynamic Voltage and Frequency Scaling (DVFS) + configuration. DVFS allows the operating voltage and frequency of the + CPU to be dynamically adjusted to optimize power consumption and + performance based on workload demands. + + + + + Enables or disables Dynamic Voltage and Frequency Scaling (DVFS) for + this CPU. + + This parameter is only applicable if {{param|Supported}} is {{true}}. + + If {{param|Supported}} is {{false}} and this parameter is {{true}} + the {{param|Status}} will be set to {{enum|Unsupported|Status}}. When + this parameter is set to {{false}}, the {{param|Status}} will be set + to {{enum|Disabled|Status}}. + + + + + + + + + Indicates the status of Dynamic Voltage and Frequency Scaling (DVFS) + for this CPU. + + + + + Indicates that DVFS is disabled. + + + + Indicates that DVFS is enabled and supported by the CPU. + + + + + Indicates that this CPU does not support DVFS, in which case + {{param|Supported}} will be {{false}}. + + + + + + + + + Indicates whether this CPU supports DVFS. + + + + + + + + + The current operating frequency of the CPU in {{units}}. + + + + + + + + + + + The minimum frequency that the CPU hardware is capable of operating + at, in {{units}}. + + + + + + + + + + + The maximum frequency that the CPU hardware is capable of operating + at, in {{units}}. + + + + + + + + + + + The minimum operating frequency allowed for the CPU in {{units}}. + + This value must be between {{param|MinFrequency}} and + {{param|MaxFrequency}}, and part of the + {{param|ScalingAvailableFrequencies}} list. + + This value must be less than {{param|ScalingMaxFrequency}}. + + + + + + + + + + + The maximum operating frequency allowed for the CPU in {{units}}. + + This value must be between {{param|MinFrequency}} and + {{param|MaxFrequency}}, and part of the + {{param|ScalingAvailableFrequencies}} list. + + This value must be greater than {{param|ScalingMinFrequency}}. + + + + + + + + + + + The available frequencies for CPU scaling in {{units}}. + + + + + + + + + + + + Indicates the CPU frequency governor to be used. + + + + + + + + + + + A list of available CPU frequency governors for this CPU. + + + + + + + + + + + + + + + + + + This object describes the overall power management capabilities and + status of the device, typically referring to the main gateway's power + states and features. + + + + + + This object provides the capability for the Device to enter and exit + standby. This functionality allows the Device to operate in a low-power + condition. + + + + + Describes the possible standby states of the Device. + + + + + + Deep sleep functionality is currently enabled and operational. + + + + + + + + + Indicates the current operational status of the standby feature. + + + + + + The standby functionality is currently disabled. + + + + + Standby functionality is currently enabled and scheduled. + + + + + An unspecified error has occurred with the standby feature. + + + + + Standby functionality is enabled but is misconfigured, + preventing proper operation. + + + + + + + + + Each reference provides a specific schedule entry that triggers the + device to enter and exit standby mode. The referenced schedule + defines when the standby transition should occur and when the device + should wake up. + + Overlapping schedules are not allowed. + + + + + + + + + + + + Indicates that the current boot cycle was a result of exiting standby + mode. The parameter value is only set during the device boot process. + + + + + + + + + Indicates that the device is capable of maintaining a network + connection and responding to communications via the network + connection while in a standby state. + + + + + + + + + Indicates that the device is capable of maintaining and responding to + timers while in a standby state. + + + + + + + + + Request the Device to enter a specific standby mode, allowing it to + enter a low-power state. + + + + + + The targeted standby mode to enter. + + {{reference}} + + {{enum}} + + + + + + + + + + + + + + This object contains parameters for monitoring the connection status of + interfaces. It allows the Device to monitor interfaces using ARP + (Address Resolution Protocol) or ND (Neighbor Discovery) packets, + depending on the IP version used by the interface. + + The CPE can enable or disable the connection monitor and configure + individual entries for each interface. Each entry can be enabled or + disabled independently, allowing for flexible monitoring + configurations. + + + + + Enables or disables the connection monitor. + + + + + + + + + The current operational state of the monitor. + + + + + + + + + + + + + {{numentries}} + + + + + + + + + + This object contains parameters for monitoring the connection. + + The device can enable or disable the connection monitor and configure + individual entries for different interfaces. Depending on + {{param|Method}}, the device can use different methods to test + connectivity, such as ARP, ND, Ping, BFDEcho or DNS. + + During normal operation, a connectivity check is performed every + {{param|MonitorInterval}}. If a check fails, due to no response within + {{param|MaxResponseTimeout}}, then the device enters a failure state. + In this failure state, it performs subsequent checks more frequently, + every {{param|FailInterval}}. The {{param|NumberOfAttempts}} counter is + incremented for each failed check and the value of the parameter + {{param|MonitoringStatus}} status is set to + {{enum|Unresponsive|MonitoringStatus}}. + + If this counter equals the {{param|Action.{i}.AttemptCount}} threshold, + the configured {{param|Action.{i}.Action}} is triggered. + + If a check succeeds at any point, the {{param|NumberOfAttempts}} + counter is reset, the monitor interval reverts to the normal + {{param|MonitorInterval}} and the {{param|MonitoringStatus}} status is + set to {{enum|Up|MonitoringStatus}}. + + + + + + + + Enables or disables the entry. + + + + + + + + + The current operational state of the entry. + + + + + + + + Indicates an error state for the entry, which may occur if + there are issues with the connection monitoring process. + + + + + Indicates an error state for the entry due to misconfiguration. + + + + + + + + + {{datatype|expand}} + + + + + + + + + This parameter specifies the interface to be monitored. Typically + this is the WAN interface. + + + + + + + + + + + + + The interval at which the Device monitors the connection status of + the interface, in {{units}}. + + + + + + + + + + + + + The interval at which the Device checks for connection failures after + the initial monitor interval, in {{units}}. + + + + + + + + + + + + + The maximum time the Device waits for a response after sending a + connectivity test packet, in {{units}}. + + + + + + + + + + + + + The current number of failed attempts when no reply is obtained. + + This parameter is reset to zero when the last {{object|Action}} has + been executed or when a connectivity test succeeds. + + + + + + + + + The connectivity test method to be performed on the + {{param|Interface}}. + + + + + + Tests Layer 2 connectivity for IPv4 by sending an ARP Request + to the default gateway. A successful ARP Reply from the gateway + is required to pass the test. + + + + + Tests Layer 2 connectivity for IPv6 by sending a Neighbor + Solicitation (NS) message to the default gateway. A successful + Neighbor Advertisement (NA) response is required to pass the + test. + + + + + Tests Layer 3 connectivity by sending ICMP Echo Request packets + to the default gateway. A successful ICMP Echo Reply is + required to pass the test. + + + + + Tests Layer 2 connectivity by sending a Bidirectional + Forwarding Detection Echo packet to the default gateway. A + successful Echo Reply is required to pass the test. + + + + + Tests DNS resolution and general Internet access by sending a + query to a configured DNS server. + + + + + + + + + Specifies the IP protocol version, following the definitions in + {{bibref|IANA-ipversionnumbers}}. Valid values are: {{range}}. + + + + + + IPv4 + + + + + IPv6 + + + + + No specific IP version is required + + + + + + + + + + The destination address (IP address or FQDN) to which connectivity + test packets are sent. When {{param|IPVersion}} is set to '-1',the + implementation will chose and use only one IP version for testing the + connectivity. It will try to use IPv6 first, and if that fails, it + will fall back to IPv4. + + When {{param|Method}} is set to {{enum|ARP|Method}} or + {{enum|ND|Method}} this parameter specifies the IP address of the + network device under test. The Device will send ARP requests (for + IPv4) or Neighbor Solicitation messages (for IPv6) to this address to + check connectivity. When {{empty}} the Device will use the default + gateway IP address from the Interface specified in the + {{param|Interface}} parameter. + + When {{param|Method}} is set to {{enum|Ping|Method}} this parameter + specifies the IP address to which ICMP Echo Request packets are sent. + The Device will send ICMP Echo Requests to this address to check + connectivity. When {{empty}} the Device will use the default gateway + IP address from the Interface specified in the {{param|Interface}} + parameter. + + When {{param|Method}} is set to {{enum|BFDEcho|Method}} this + parameter specifies the IP address to which BFD echo packets are + sent. The Device will send BFD Echo packets to this address to check + connectivity. When {{empty}} the Device will use the default gateway + IP address from the Interface specified in the {{param|Interface}} + parameter. + + When {{param|Method}} is set to {{enum|DNS|Method}} this parameter + specifies the DNS server (IP address or FQDN) to which DNS queries + are sent. When {{empty}} the Device will use the default DNS server + configured on the Interface specified in the {{param|Interface}} + parameter. + + + + + + + + + Diffserv code point to be used for outgoing connection monitoring + traffic. + + + + + + + + + + + + The Ethernet Priority for this {{object}} entry, also known as 802.1p + Priority, is a 3-bit field used to indicate the priority of network + traffic. + + A value of ''-1'' indicates that the Ethernet priority should not be + changed for this {{object}}. + + + + + + + + + + + The current monitoring status of the connection. + + + + + + Indicates that the monitored connection is currently up and + responsive. + + + + + Indicates that the monitored connection is currently + unresponsive, meaning that connectivity tests have failed. + + + + + + + + + {{numentries}} + + + + + + + + + + This object contains parameters for actions to be taken when a + connection failure is detected. Each action can be configured + independently and can be enabled or disabled. + + The Device will perform the specified action when the value of + {{param|#.NumberOfAttempts}} equals the value of {{param|AttemptCount}} + parameter. + + Multiple actions can be defined for a connection. As failures persist, + the {{param|#.NumberOfAttempts}} will continue to increment, which can + trigger subsequent actions with higher {{param|AttemptCount}} values. + The {{param|#.NumberOfAttempts}} counter is reset to zero only after + the last action has been executed or when a connectivity test succeeds. + + + + + + + + + + + {{datatype|expand}} + + + + + + + + + Enables or disables the {{object}} entry. + + + + + + + + + Indicates the action to be taken when the connection's + {{param|#.NumberOfAttempts}} is equal to the value of this parameter. + + + + + + + + + + + + This parameter indicates the action taken by the Device when a + connection failure is detected. It can be used to trigger specific + actions such as restarting the DHCP client or Interface. + + + + + + No action is taken when a connection failure is detected. + + + + Restart the DHCP client. + + + Restart the Interface. + + + Reboot the Device. + + + + + + + + This parameter specifies the object path to which the + {{param|Action}} applies. + + When {{param|Action}} is set to {{enum|RestartDHCP|Action}}, this + parameter specifies the path to the DHCPv4 Client instance (e.g., + `Device.DHCPv4.Client.1`) that should be restarted. If this parameter + is {{empty}}, the Device will attempt to restart the DHCP client + associated with the {{param|#.Interface}} of the parent {{object|#.}} + object. + + When {{param|Action}} is set to {{enum|RestartInterface|Action}}, + this parameter specifies the path to the Interface instance (e.g., + `Device.IP.Interface.2` or `Device.Logical.Interface.3`) that should + be restarted. If this parameter is {{empty}}, the Device will restart + the {{param|#.Interface}} of the parent {{object|#.}} object. + + When {{param|Action}} is set to {{enum|Reboot|Action}} or + {{enum|None|Action}}, this parameter is not applicable and its value + will be ignored. + + + + + + + + + + + + + This object contains statistics for the connection monitoring entry. It + provides counters for connection test failures, total triggered + actions. + + + + + The total number of failed attempts when no reply is obtained, since + the last boot. + + + + + + + + + Total amount of triggered actions since last boot. + + + + + + + + + + This object contains configuration and status for the WireGuard + subsystem. The WireGuard subsystem is used to create secure tunnels + between devices using the WireGuard protocol. + + + + + {{numentries}} + + + + + + + + + {{numentries}} + + + + + + + + + + WireGuard Tunnel table, models the WireGuard Tunnel instance and + represents the entry point and exit point of the tunnel in relation to + the WAN interface. A {{object}} object has one or more + {{object|Interface}} objects that further define the sessions or flows + within the tunnel. + + + + + + + + + + + Enables or disables the tunnel. + + + + + + + + + The current operational state of the tunnel. + + + + + + + + + + + + + {{datatype|expand}} + + + + + + + + + The private key for this WireGuard tunnel. + + + + + + + + + The public key for this WireGuard tunnel, corresponding to the + {{param|PrivateKey}}. + + + + + + + + + The port on which this WireGuard tunnel will listen for incoming + connections. If set to 0, a random port will be chosen by the device. + + + + + + + + + + + Each element represents a reference to the peers associated with this + {{object}} entry. + + + + + + + + + + + + {{numentries}} + + + + + + + + + + WireGuard Interface table (a stackable interface object as described in + {{bibref|TR-181i2|Section 4.2}}). + + The {{object}} object provides a way to discriminate how sessions or + flows are encapsulated within the WireGuard Tunnel. In addition the + {{object}} object represents the entry point and exit point of the + tunnel in relation to the LAN interface. + + Compared to other tunnel protocols, WireGuard does not have a concept + of multiple interfaces within a tunnel. Therefore, a WireGuard Tunnel + will only have one {{object}} instance. + + + + + + + + + + + Enables or disables the interface. + + This parameter is based on ''ifAdminStatus'' from {{bibref|RFC2863}}. + + + + + + + + + + The current operational state of the interface (see + {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} + + When {{param|Enable}} is {{false}} then {{param}} SHOULD normally be + {{enum|Down}} (or {{enum|NotPresent}} or {{enum|Error}} if there is a + fault condition on the interface). + + When {{param|Enable}} is changed to {{true}} then {{param}} SHOULD + change to {{enum|Up}} if and only if the interface is able to + transmit and receive network traffic; it SHOULD change to + {{enum|Dormant}} if and only if the interface is operable but is + waiting for external actions before it can transmit and receive + network traffic (and subsequently change to {{enum|Up}} if still + operable when the expected actions have completed); it SHOULD change + to {{enum|LowerLayerDown}} if and only if the interface is prevented + from entering the {{enum|Up}} state because one or more of the + interfaces beneath it is down; it SHOULD remain in the {{enum|Error}} + state if there is an error or other fault condition detected on the + interface; it SHOULD remain in the {{enum|NotPresent}} state if the + interface has missing (typically hardware) components; it SHOULD + change to {{enum|Unknown}} if the state of the interface can not be + determined for some reason. + + This parameter is based on ''ifOperStatus'' from {{bibref|RFC2863}}. + + + + + + + + + + + + + + + + + + {{datatype|expand}} + + + + + + + + + The textual name of the interface as assigned by the CPE. + + + + + + + + + + + The accumulated time in {{units}} since the interface entered its + current operational state. + + + + + + + + + + + {{list}} {{reference|an interface object that is stacked immediately + below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. + + + + + + + + + + + + + + + + Throughput statistics for this interface. + + The CPE MUST reset the interface's Stats parameters (unless otherwise + stated in individual object or parameter descriptions) either when the + interface becomes operationally down due to a previous administrative + down (i.e. the interface's {{param|#.Status}} parameter transitions to + a down state after the interface is disabled) or when the interface + becomes administratively up (i.e. the interface's {{param|#.Enable}} + parameter transitions from {{false}} to {{true}}). Administrative and + operational interface status is discussed in {{bibref|TR-181i2|section + 4.2.2}}. + + + + + Reset all this object's statistics counters to zero. + + + + + + The total number of {{units}} transmitted out of the interface, + including framing characters. + + + + + + + + + + + The total number of {{units}} received on the interface, including + framing characters. + + + + + + + + + + + The total number of {{units}} transmitted out of the interface. + + + + + + + + + + + The total number of {{units}} received on the interface. + + + + + + + + + + + The total number of outbound {{units}} that could not be transmitted + because of errors. + + + + + + + + + + + The total number of inbound {{units}} that contained errors + preventing them from being delivered to a higher-layer protocol. + + + + + + + + + + + The total number of {{units}} requested for transmission which were + not addressed to a multicast or broadcast address at this layer, + including those that were discarded or not sent. + + + + + + + + + + + The total number of outbound {{units}} which were chosen to be + discarded even though no errors had been detected to prevent their + being transmitted. One possible reason for discarding such a packet + could be to free up buffer space. + + + + + + + + + + + The total number of inbound {{units}} which were chosen to be + discarded even though no errors had been detected to prevent their + being delivered. One possible reason for discarding such a packet + could be to free up buffer space. + + + + + + + + + + + The total number of {{units}} that higher-level protocols requested + for transmission and which were addressed to a multicast address at + this layer, including those that were discarded or not sent. + + + + + + + + + + + The total number of received {{units}}, delivered by this layer to a + higher layer, which were not addressed to a multicast or broadcast + address at this layer. + + + + + + + + + + + The total number of received {{units}}, delivered by this layer to a + higher layer, which were addressed to a multicast address at this + layer. + + + + + + + + + + + The total number of {{units}} that higher-level protocols requested + for transmission and which were addressed to a broadcast address at + this layer, including those that were discarded or not sent. + + Note that IPv6 does not define broadcast addresses, so IPv6 {{units}} + will never cause this counter to increment. + + + + + + + + + + + The total number of received {{units}}, delivered by this layer to a + higher layer, which were addressed to a broadcast address at this + layer. + + Note that IPv6 does not define broadcast addresses, so IPv6 {{units}} + will never cause this counter to increment. + + + + + + + + + + + The total number of {{units}} received via the interface which were + discarded because of an unknown or unsupported protocol. + + + + + + + + + + + + Statistics for this WireGuard tunnel, i.e. all traffic that has passed + through the tunnel. + + The device MUST reset the tunnel's Stats parameters (unless otherwise + stated in individual object or parameter descriptions) either when the + tunnel becomes operationally down due to a previous administrative down + (i.e., Status parameter transitions to a disabled state after the + tunnel has been disabled) or when the tunnel becomes administratively + up (i.e. the Enable parameter transitioned from {{false}} to {{true}}). + + + + + The total number of {{units}} sent by the tunnel. + + + + + + + + + + + The total number of {{units}} received by the tunnel. + + + + + + + + + + + The total number of {{units}} sent by the tunnel. + + + + + + + + + + + The total number of {{units}} received by the tunnel. + + + + + + + + + + + The total number of {{units}} discarded by the tunnel due to any + error. This can include packets dropped due to a lack of transmit + buffers. + + + + + + + + + + + The total number of {{units}} received by the tunnel that contained + errors preventing them from being delivered to a higher-layer + protocol. + + + + + + + + + + + + WireGuard Peer table, an entry in this table represents a WireGuard + peer. + + + + + + + + + + + Enables or disables this Peer configuration. + + + + + + + + + {{datatype|expand}} + + + + + + + + + Public key of the peer. + + + + + + + + + The pre-shared key for this WireGuard Peer. + + When {{empty}} is provided, no pre-shared key is used. + + + + + + + + + Each item represents an IPv4/v6 subnets in CIDR notation from which + incoming traffic is allowed and to which outgoing traffic is directed + for this peer. + + '0.0.0.0/0' maybe specified for matching all IPv4 addresses and + '::/0' for matching all IPv6 addresses. + + When {{empty}} is provided, no traffic is routed to this peer. + + + + + + + + + + The remote network address (IP or hostname) of the peer. + + {{empty}} indicates that the endpoint address is not used. + + + + + + + + + The UDP port of the remote peer. + + A value of `-1` indicates that the endpoint port is not used. + + + + + + + + + + + + An interval in {{units}} to send an authenticated empty packet to the + peer. This is useful for keeping NAT mappings alive. A value of `0` + disables this feature. + + + + + + + + + + + + The amount of time in {{units}} since the last handshake was sent + with this peer. + + + + + + + + + @@ -126861,14 +134630,14 @@ {{param|ThresholdParam}} may only reference integer parameters and {{param|ThresholdValue}} only uses integer values. For example: - {{param|ReferencePath}}: - Device.Ethernet.Interface.[Enable=="1"].Stats. + * {{param|ReferencePath}}: + Device.Ethernet.Interface.[Enable=="1"].Stats. - {{param|ThresholdParam}}: BytesSent + * {{param|ThresholdParam}}: BytesSent - {{param|ThresholdOperator}}: Rise + * {{param|ThresholdOperator}}: Rise - {{param|ThresholdValue}}: 100000 + * {{param|ThresholdValue}}: 100000 This would trigger a {{event|Triggered!}} Event whenever a value of a parameter matching @@ -128327,7 +136096,7 @@ - A reference to the Unix Domain Socket used by this Agent when + A reference to the Unix Domain Socket used by the Controller when communicating via the UDS MTP. @@ -129127,6 +136896,12 @@ Target that evaluates to the same instantiated Object/Parameter for multiple Roles, then the permissions to be used are a union of the identified permissions. + + If this object is referenced in + {{param|.SoftwareModules.ExecutionUnit.{i}.RequiredRoles}}, then the + device MAY reject deletion requests, as it could cause instability to + the {{object|.SoftwareModules.ExecutionUnit.{i}.}} referencing the + Role. @@ -129335,7 +137110,9 @@ Instantiated Object type of Targets: # Read: Grants the capability to read the instance numbers and unique - keys of the Instantiated Object via GetInstances. + keys of the Instantiated Object via GetInstances, and to read the + meta-information of the Object via GetSupportedDM when an + Instantiated Data Model Object Path is being used. # Write: Grants the capability to remove an existing instance of an Instantiated Object via Delete (e.g. @@ -129798,7 +137575,7 @@ model parameter to configure and the value to configure it with. Each entry in the comma-separated list will use the following format: - <Parameter Name>=<Parameter Value> + <*Parameter Name*>=<*Parameter Value*> The Parameter Value will be formatted per the value type, which means that string values will be quoted while unsignedInt values will be @@ -130148,9 +137925,12 @@ + maxEntries="1" version="2.12" status="deprecated"> Capabilities of a Device as it pertains to entering a standby state. + + {{deprecated|2.20|because it has been moved to + {{object|Device.Hardware.PowerManagement.Standby.}}}} @@ -131169,14 +138949,26 @@ + + + + + + {{numentries}} + + + + + - Human-readable description of the {{object}}. e.g. a more detailed - description of {{param|Type}}. + Human-readable description of the {{object}}. For example, a more + detailed description of {{param|Type}}. @@ -131397,6 +139189,122 @@ + + + {{object}} provides information to an actuator that sensor changed from + one state to another state. In addition to the state change, the + {{object}} can provide additional information about the type of + transition via {{param|Transition}} and the pulse duration via + {{param|Duration}}. + + + + + {{datatype|expand}} + + + + + + + + + Human-readable description of the {{object}}. For example, a more + detailed description of {{param|Type}}. + + + + + + + + + + + Some {{object}} instances can provide a duration together with the + latest state change. The duration is an indication of the time, + measured in {{units}}, between the start of the state change and the + end of the state change: i.e., returning to its orignal state. The + original state can be a low state or high state. + + + + + + + + + + + + Indicates the moment a pulse is generated. This can be a + {{enum|RisingEdge}} transition: in case the sensor changes from low + to high state. {{enum|FallingEdge}} transition: in case the sensor + changes from high to low state. + + + + + + The sensor changes from low to high state. + + + + + The sensor changes from high to low state. + + + + + + + + + Generate a Pulse with a {{enum|RisingEdge|Transition}} transition for + a duration of {{param|Duration}}. + + + + + + Time between the start of the state change and the return to its + original state. {{param}} is measured in {{units}}. + + + + + + + + + + + + + + Generate a Pulse with a {{enum|FallingEdge|Transition}} transition + for a duration of {{param|Duration}}. + + + + + + Time between the start of the state change and the return to its + original state. {{param}} is measured in {{units}}. + + + + + + + + + + + + @@ -131861,6 +139769,192 @@ + + + This {{object}} only exists in a Sensor IoTCapability. Adding a + {{object}} instance to a Control IoTCapability MUST fail. Each entry in + this table describes the link between this Sensor IoTCapability and a + specific Control IoTCapability. + + When a Sensor IoT Capability is bound to a Control IoT Capability, then + for each Value parameter updates of the Sensor IoTCapability, the Agent + evaluates the needs to update the Value parameter of the bound Control + IoTCapability. + + + + + + + + {{datatype|expand}} + + + + + + + + + Friendly name for this binding. + + + + + + + + + + + Description of the binding's intent and function. + + + + + + + + + + + When {{true}}, the binding is active; otherwise, no data flow occurs + and the Value parameter of {{param|ControlIoTCapability}} is not + updated. + + + + + + + + + A valid {{param}} is a reference to a Control IoTCapability in the + {{object|##.IoTCapability}} table. Setting {{param}} to a Sensor + IoTCapability MUST fail. It references the Control IoTCapability to + use as the binding destination on which the Agent updates the Value + parameter. As a mountable object {{object|##.IoTCapability}} may also + be mounted on one of the following mountpoints: + + * {{object|##.Node.{i}.}}, + + * {{object|##.ProxiedDevice.{i}.}}, + + * {{object|##.ProxiedDevice.{i}.Node.{i}.}} + + + + + + + + + + + + A {{object}} is used to reflect the functionality of a sensor that + changed state from low to high or high to low. A {{object}} provides a + trigger on the rising edge of this state change, which is identified by + {{param|Transition}}. Some {{object}} instances have the possibility to + provide a pulse duration {{param|Duration}} together with the latest + state change. + + + + + {{datatype|expand}} + + + + + + + + + Human-readable description of the {{object}}. For example, a more + detailed description of {{param|Type}}. + + + + + + + + + + + The date and time in UTC when {{param|Duration}} or + {{param|Transition}}has been changed to the current value. + + + + + + + + + The date and time in UTC when the {{object}} has received data. + + + + + + + + + Some {{object}} instances can provide a duration together with the + latest state change. The duration is an indication of the time, + measured in {{units}}, between the start of the state change and the + end of the state change: i.e., returning to its orignal state. The + original state can be a low state or high state. + + + + + + + + + + + Unit in which {{param|Duration}} is expressed in {{units}}. + + + + + + + + + + + Indicates the moment a pulse is generated. This can be a + {{enum|RisingEdge}} transition: in case the sensor changes from low + to high state. {{enum|FallingEdge}} transition: in case the sensor + changes from high to low state. + + + + + + The sensor changes from low to high state. + + + + + The sensor changes from high to low state. + + + + + + + @@ -131966,7 +140060,7 @@ - + @@ -133297,7 +141391,7 @@ - + @@ -133316,7 +141410,7 @@ + status="deleted"/> @@ -135565,7 +143659,7 @@ - + @@ -135574,10 +143668,10 @@ + status="obsoleted"/> + requirement="present" status="obsoleted"> @@ -137617,6 +145711,46 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Parameters to control ACA (Alternate Channel Assessment) for the MoCA diff --git a/tools/datamodel.json b/tools/datamodel.json index 4d522342..89b1dafa 100644 --- a/tools/datamodel.json +++ b/tools/datamodel.json @@ -24,7 +24,7 @@ } ], "pattern": [ - "2\\.\\d+" + "2\\.\\d+(\\.\\d+)?" ] }, "InterfaceStackNumberOfEntries": { @@ -14566,7 +14566,7 @@ "cwmp", "usp" ], - "description": "<> <.Architecture>>, is no longer relevant for modern devices.>>", + "description": "<> <.Architecture>>, is no longer relevant for modern devices.>> <>", "datatype": "unsignedInt" }, "LogRotateNumberOfEntries": { @@ -14809,11 +14809,10 @@ "type": "string", "read": true, "write": true, - "mandatory": true, "protocols": [ "usp" ], - "description": "Username to be used by the Agent to authenticate with the file server. This string is set to <> if no authentication is required.", + "description": "Username to be used by the Agent to authenticate with the file server. If <> is not provided or is set to <>, an alternative form of authentication (e.g., certificate-based authentication) is required. Note: The mandatory requirement for this parameter was removed in Device:2.20.", "datatype": "string", "range": [ { @@ -14825,17 +14824,36 @@ "type": "string", "read": true, "write": true, - "mandatory": true, "protocols": [ "usp" ], - "description": "Password to be used by the Agent to authenticate with the file server. This string is set to <> if no authentication is required.", + "description": "Password to be used by the Agent to authenticate with the file server. If <> is not provided or is set to <>, an alternative form of authentication (e.g., certificate-based authentication) is required. Note: The mandatory requirement for this parameter was removed in Device:2.20.", "datatype": "string", "range": [ { "max": 256 } ] + }, + "Certificate": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Specifies the client certificate that must be presented to the remote server for mutual authentication. This certificate is used to authenticate the client by the remote server, ensuring that the remote server is communicating with a trusted client. The client certificate must be issued by a trusted Certificate Authority (CA) and should match the clients private key. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, + "CABundle": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Specifies the group of CA certificate(s) that the client must use to validate the certificate presented by the remote server. These CA certificates form a trust chain that the server certificate must match, ensuring that only servers with trusted certificates can establish a connection. This parameter supports multiple CA certificates to accommodate different server certificate issuers. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" } } }, @@ -14866,11 +14884,10 @@ "type": "string", "read": true, "write": true, - "mandatory": true, "protocols": [ "usp" ], - "description": "Username to be used by the Agent to authenticate with the file server. This string is set to <> if no authentication is required.", + "description": "Username to be used by the Agent to authenticate with the file server. If <> is not provided or is set to <>, an alternative form of authentication (e.g., certificate-based authentication) is required. Note: The mandatory requirement for this parameter was removed in Device:2.20.", "datatype": "string", "range": [ { @@ -14882,11 +14899,10 @@ "type": "string", "read": true, "write": true, - "mandatory": true, "protocols": [ "usp" ], - "description": "Password to be used by the Agent to authenticate with the file server. This string is set to <> if no authentication is required.", + "description": "Password to be used by the Agent to authenticate with the file server. If <> is not provided or is set to <>, an alternative form of authentication (e.g., certificate-based authentication) is required. Note: The mandatory requirement for this parameter was removed in Device:2.20.", "datatype": "string", "range": [ { @@ -14894,6 +14910,26 @@ } ] }, + "Certificate": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Specifies the client certificate that must be presented to the remote server for mutual authentication. This certificate is used to authenticate the client by the remote server, ensuring that the remote server is communicating with a trusted client. The client certificate must be issued by a trusted Certificate Authority (CA) and should match the clients private key. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, + "CABundle": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Specifies the group of CA certificate(s) that the client must use to validate the certificate presented by the remote server. These CA certificates form a trust chain that the server certificate must match, ensuring that only servers with trusted certificates can establish a connection. This parameter supports multiple CA certificates to accommodate different server certificate issuers. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, "FileSize": { "type": "unsignedInt", "read": true, @@ -15228,7 +15264,7 @@ "cwmp", "usp" ], - "description": "Each instance in the table represents a CPU on this device. Here CPU can imply main CPU (where system software is executed) or hardware/network acceleration CPU (responsible for data plane traffic).", + "description": "This object describes the utilization metrics for each CPU on the device. It also defines the monitoring actions that are automatically triggered when specific utilization thresholds are crossed.", "uniqueKeys": [ "Name", "Alias" @@ -16014,6 +16050,54 @@ "protocols": [ "usp" ] + }, + "HighTemperatureAlarm!": { + "type": "event", + "protocols": [ + "usp" + ], + "output": { + "Value": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "The current temperature value that triggered the event. This value is in <>.", + "datatype": "int", + "range": [ + { + "min": -274 + } + ], + "unit": "degrees celsius" + } + } + }, + "LowTemperatureAlarm!": { + "type": "event", + "protocols": [ + "usp" + ], + "output": { + "Value": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "The current temperature value that triggered the event. This value is in <>.", + "datatype": "int", + "range": [ + { + "min": -274 + } + ], + "unit": "degrees celsius" + } + } } } }, @@ -16065,7 +16149,7 @@ "cwmp", "usp" ], - "description": "Each table entry represents a hardware or virtual processor that resides on this device. <>, is no longer relevant for modern devices.>>", + "description": "Each table entry represents a hardware or virtual processor that resides on this device. <>, is no longer relevant for modern devices.>> <>", "uniqueKeys": [ "Alias" ], @@ -16392,11 +16476,10 @@ "type": "string", "read": true, "write": true, - "mandatory": true, "protocols": [ "usp" ], - "description": "Username to be used by the Agent to authenticate with the file server. This string is set to <> if no authentication is required.", + "description": "Username to be used by the Agent to authenticate with the file server. If <> is not provided or is set to <>, an alternative form of authentication (e.g., certificate-based authentication) is required. Note: The mandatory requirement for this parameter was removed in Device:2.20.", "datatype": "string", "range": [ { @@ -16408,17 +16491,36 @@ "type": "string", "read": true, "write": true, - "mandatory": true, "protocols": [ "usp" ], - "description": "Password to be used by the Agent to authenticate with the file server. This string is set to <> if no authentication is required.", + "description": "Password to be used by the Agent to authenticate with the file server. If <> is not provided or is set to <>, an alternative form of authentication (e.g., certificate-based authentication) is required. Note: The mandatory requirement for this parameter was removed in Device:2.20.", "datatype": "string", "range": [ { "max": 256 } ] + }, + "Certificate": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Specifies the client certificate that must be presented to the remote server for mutual authentication. This certificate is used to authenticate the client by the remote server, ensuring that the remote server is communicating with a trusted client. The client certificate must be issued by a trusted Certificate Authority (CA) and should match the clients private key. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, + "CABundle": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Specifies the group of CA certificate(s) that the client must use to validate the certificate presented by the remote server. These CA certificates form a trust chain that the server certificate must match, ensuring that only servers with trusted certificates can establish a connection. This parameter supports multiple CA certificates to accommodate different server certificate issuers. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" } } } @@ -16995,11 +17097,10 @@ "type": "string", "read": true, "write": true, - "mandatory": true, "protocols": [ "usp" ], - "description": "Username to be used by the Agent to authenticate with the file server. This string is set to <> if no authentication is required.", + "description": "Username to be used by the Agent to authenticate with the file server. If <> is not provided or is set to <>, an alternative form of authentication (e.g., certificate-based authentication) is required. Note: The mandatory requirement for this parameter was removed in Device:2.20.", "datatype": "string", "range": [ { @@ -17011,17 +17112,36 @@ "type": "string", "read": true, "write": true, - "mandatory": true, "protocols": [ "usp" ], - "description": "Password to be used by the Agent to authenticate with the file server. This string is set to <> if no authentication is required.", + "description": "Password to be used by the Agent to authenticate with the file server. If <> is not provided or is set to <>, an alternative form of authentication (e.g., certificate-based authentication) is required. Note: The mandatory requirement for this parameter was removed in Device:2.20.", "datatype": "string", "range": [ { "max": 256 } ] + }, + "Certificate": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Specifies the client certificate that must be presented to the remote server for mutual authentication. This certificate is used to authenticate the client by the remote server, ensuring that the remote server is communicating with a trusted client. The client certificate must be issued by a trusted Certificate Authority (CA) and should match the clients private key. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, + "CABundle": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Specifies the group of CA certificate(s) that the client must use to validate the certificate presented by the remote server. These CA certificates form a trust chain that the server certificate must match, ensuring that only servers with trusted certificates can establish a connection. This parameter supports multiple CA certificates to accommodate different server certificate issuers. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" } } }, @@ -17255,11 +17375,10 @@ "type": "string", "read": true, "write": true, - "mandatory": true, "protocols": [ "usp" ], - "description": "Username to be used by the Agent to authenticate with the file server. This string is set to <> if no authentication is required.", + "description": "Username to be used by the Agent to authenticate with the file server. If <> is not provided or is set to <>, an alternative form of authentication (e.g., certificate-based authentication) is required. Note: The mandatory requirement for this parameter was removed in Device:2.20.", "datatype": "string", "range": [ { @@ -17271,17 +17390,36 @@ "type": "string", "read": true, "write": true, - "mandatory": true, "protocols": [ "usp" ], - "description": "Password to be used by the Agent to authenticate with the file server. This string is set to <> if no authentication is required.", + "description": "Password to be used by the Agent to authenticate with the file server. If <> is not provided or is set to <>, an alternative form of authentication (e.g., certificate-based authentication) is required. Note: The mandatory requirement for this parameter was removed in Device:2.20.", "datatype": "string", "range": [ { "max": 256 } ] + }, + "Certificate": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Specifies the client certificate that must be presented to the remote server for mutual authentication. This certificate is used to authenticate the client by the remote server, ensuring that the remote server is communicating with a trusted client. The client certificate must be issued by a trusted Certificate Authority (CA) and should match the clients private key. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, + "CABundle": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Specifies the group of CA certificate(s) that the client must use to validate the certificate presented by the remote server. These CA certificates form a trust chain that the server certificate must match, ensuring that only servers with trusted certificates can establish a connection. This parameter supports multiple CA certificates to accommodate different server certificate issuers. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" } } }, @@ -17486,6 +17624,21 @@ "description": "The number of times the device has rebooted by a sw/hw watchdog since the last factory reset. The watchdog is a component within the operating system kernel or Device responsible for monitoring user-space activities. If it detects non-responsiveness in user-space processes, it triggers a reboot of the device.", "datatype": "unsignedInt" }, + "CurrentBootCycle": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "The current boot cycle of the device (e.g. Warm or Cold).", + "datatype": "string", + "enumerations": [ + "Unknown", + "Warm", + "Cold" + ] + }, "ColdBootCount": { "type": "unsignedInt", "read": true, @@ -17739,6 +17892,54 @@ "description": "An absolute time reference in UTC to determine when the CPE will initiate the periodic Inform method calls. Each Inform call MUST occur at this reference time plus or minus an integer multiple of the <>. <> is used only to set the phase of the periodic Informs. The actual value of <> can be arbitrarily far into the past or future. For example, if <> is 86400 (a day) and if <> is set to UTC midnight on some day (in the past, present, or future) then periodic Informs will occur every day at UTC midnight. These MUST begin on the very next midnight, even if <> refers to a day in the future. The Unknown Time value defined in <> indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and needs only to adhere to the specified <>. If absolute time is not available to the CPE, its periodic Inform behavior MUST be the same as if the <> parameter was set to the Unknown Time value.", "datatype": "dateTime" }, + "PendingScheduleInforms": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp" + ], + "description": "Each entry in the list represents the absolute time at which the CPE is going to send a ScheduleInform RPC to the ACS. <> means that there are no pending ScheduledInform RPCs requested by the ACS.", + "list": { + "datatype": "dateTime" + } + }, + "UpgradePending": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp" + ], + "description": "Indicates whether a firmware upgrade is scheduled or in progress. A value of <> signifies that an upgrade is pending (e.g., scheduled after a delay) or is actively being performed. A value of <> indicates no upgrade is scheduled or in progress. The device MUST NOT enter a low-power state (I.e. Deep Standby) that could interrupt network connectivity or break the firmware upgrade process while this parameter is <>.", + "datatype": "boolean" + }, + "DeliveredEvents": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp" + ], + "description": "Each entry represents an Event Code and its associated Command Key, where applicable as defined in <>, that was delivered to the ACS during the last session. The format for each entry is the Event Code itself followed by the Command Key in parentheses with an empty set of parentheses if the Command Key is not applicable. Furthermore, any spaces in the values MUST be percent encoded as defined in <>. E.g. <> = 4%20VALUE%20CHANGE,7%20TRANSFER%20COMPLETE,M%20Download(20326379).", + "list": { + "datatype": "string" + } + }, + "SessionStatus": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp" + ], + "description": "This parameter indicates the session status of the CWMP Agent.", + "datatype": "string", + "enumerations": [ + "Idle", + "InProgress" + ] + }, "ParameterKey": { "type": "string", "read": true, @@ -18251,6 +18452,54 @@ "description": "Indicates whether or not instance wildcards are supported. A <> value indicates that the CPE supports instance wildcards for GPV, GPN and GPA RPC calls, as defined in [TR-069].", "datatype": "boolean" }, + "AllowAllIPv4": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp" + ], + "description": "Allow incoming IP connections from any IPv4 address. The source prefixes defined in <> will be ignored.", + "default": "true", + "datatype": "boolean" + }, + "IPv4AllowedSourcePrefix": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp" + ], + "description": "Allow only incoming IP connections from the provided list of IPv4 prefixes. When <> is set to <> and <> is set to false, no incoming IP connections are allowed. When <> is set true, <> is ignored.", + "list": { + "datatype": "string", + "maxsize": 1024 + } + }, + "AllowAllIPv6": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp" + ], + "description": "Allow incoming IP connections from any IPv6 address. The source prefixes defined in <> will be ignored.", + "default": "true", + "datatype": "boolean" + }, + "IPv6AllowedSourcePrefix": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp" + ], + "description": "Allow only incoming IP connections from the provided list of IPv6 prefixes. When <> is set to <> and <> is set to false, no incoming IP connections are allowed. When <> is set true, <> is ignored.", + "list": { + "datatype": "string", + "maxsize": 1024 + } + }, "InformParameterNumberOfEntries": { "type": "unsignedInt", "read": true, @@ -20582,7 +20831,7 @@ "cwmp", "usp" ], - "description": "Allow access from any IPv4 address. The source prefixes defined in <> will be ignored.", + "description": "Allow incoming IP connections from any IPv4 address. The source prefixes defined in <> will be ignored.", "default": "false", "datatype": "boolean" }, @@ -20594,7 +20843,7 @@ "cwmp", "usp" ], - "description": "Allow only access from the provided list of IPv4 prefixes. When <> is set to <> and <> is set to false, no incoming connections are allowed. When <> is set true, <> is ignored.", + "description": "Allow only incoming IP connections from the provided list of IPv4 prefixes. When <> is set to <> and <> is set to false, no incoming IP connections are allowed. When <> is set true, <> is ignored.", "list": { "datatype": "string", "maxsize": 1024 @@ -20608,7 +20857,7 @@ "cwmp", "usp" ], - "description": "Allow access from any IPv6 address. The source prefixes defined in <> will be ignored.", + "description": "Allow incoming IP connections from any IPv6 address. The source prefixes defined in <> will be ignored.", "default": "false", "datatype": "boolean" }, @@ -20620,7 +20869,7 @@ "cwmp", "usp" ], - "description": "Allow only access from the provided list of IPv6 prefixes. When <> is set to <> and <> is set to false, no incoming connections are allowed. When <> is set true, <> is ignored.", + "description": "Allow only incoming IP connections from the provided list of IPv6 prefixes. When <> is set to <> and <> is set to false, no incoming IP connections are allowed. When <> is set true, <> is ignored.", "list": { "datatype": "string", "maxsize": 1024 @@ -21539,7 +21788,7 @@ "cwmp", "usp" ], - "description": "This is the upper bit rate margin in units of 1%, within which the transceiver will still meet its specifications (BR, max) is specified in units of 1% above the nominal bit rate. A value of zero indicates that this field is not specified. However this field may contain the nominal bit rate in units of 250MBd if the value in <> is 255. See <>> - Address 0xA0, Byte 66.", + "description": "This is the upper bit rate margin in units of 1%, within which the transceiver will still meet its specifications (BR, max) is specified in units of 1% above the nominal bit rate. A value of zero indicates that this field is not specified. However this field may contain the nominal bit rate in units of 250MBd if the value in <> is 255. See <> - Address 0xA0, Byte 66.", "datatype": "unsignedInt", "range": [ { @@ -21556,7 +21805,7 @@ "cwmp", "usp" ], - "description": "This is the lower bit rate margin in units of <>, within which the transceiver will still meet its specifications (BR, min) is specified in units of 1<> below the nominal bit rate. A value of zero indicates that this field is not specified. However this field may also specify range of signaling rates specified in units of +/- 1<> around the nominal signaling rate. See <>> - Address 0xA0, Byte 67.", + "description": "This is the lower bit rate margin in units of <>, within which the transceiver will still meet its specifications (BR, min) is specified in units of 1<> below the nominal bit rate. A value of zero indicates that this field is not specified. However this field may also specify range of signaling rates specified in units of +/- 1<> around the nominal signaling rate. See <> - Address 0xA0, Byte 67.", "datatype": "unsignedInt", "range": [ { @@ -21627,7 +21876,7 @@ "cwmp", "usp" ], - "description": "This value specifies link length that is supported by the transceiver while operating in compliance with applicable standards using 50 micron multimode OM2 [500MHz*km at 850nm] fiber. The value is in units of <>. A value of 255 means that the transceiver supports a link length greater than 2.54 km A value of zero means that the transceiver does not support 50 micron multimode fiber or that the length information must be determined from the transceiver technology.", + "description": "This value specifies the link length that is supported by the transceiver while operating in compliance with the applicable standards using single-mode fiber. The value is in units of <>. A value of 255 means that the transceiver supports a link length greater than 25.4 km. A value of zero means that the transceiver does not support single-mode fiber or that the length information must be determined from the transceiver technology.", "datatype": "unsignedInt", "range": [ { @@ -21635,7 +21884,7 @@ "max": 255 } ], - "unit": "10 meters" + "unit": "100 meters" }, "LengthOM2": { "type": "unsignedInt", @@ -21645,7 +21894,7 @@ "cwmp", "usp" ], - "description": "This value specifies link length that is supported by the transceiver while operating in compliance with applicable standards using 50 micron multimode OM2 [500MHz*km at 850nm,] fiber. The value is in units of <>. A value of 255 means that the transceiver supports a link length greater than 2.54 km A value of zero means that the transceiver does not support 50 micron multimode fiber or that the length information must be determined from the transceiver technology.", + "description": "This value specifies link length that is supported by the transceiver while operating in compliance with applicable standards using 50 micron multimode OM2 [500MHz*km at 850nm,] fiber. The value is in units of <>. A value of 255 means that the transceiver supports a link length greater than 2.54 km. A value of zero means that the transceiver does not support 50 micron multimode OM2 fiber or that the length information must be determined from the transceiver technology.", "datatype": "unsignedInt", "range": [ { @@ -21663,7 +21912,7 @@ "cwmp", "usp" ], - "description": "This value specifies link length that is supported by the transceiver while operating in compliance with applicable standards using 62.5 micron multimode OM1 [200 MHzkm at 850nm, 500 MHzkm at 1310nm] fiber. The value is in units of <> . A value of 255 means that the transceiver supports a link length greater than 2.54 km. A value of zero means that the transceiver does not support 62.5 micron multimode fiber or that the length information must be determined from the transceiver technology.", + "description": "This value specifies link length that is supported by the transceiver while operating in compliance with applicable standards using 62.5 micron multimode OM1 [200 MHz*km at 850nm, 500 MHz*km at 1310nm] fiber. The value is in units of <> . A value of 255 means that the transceiver supports a link length greater than 2.54 km. A value of zero means that the transceiver does not support 62.5 micron multimode fiber or that the length information must be determined from the transceiver technology.", "datatype": "unsignedInt", "range": [ { @@ -21681,7 +21930,7 @@ "cwmp", "usp" ], - "description": "This value specifies link length that is supported by the transceiver while operating in compliance with applicable standards using 50 micron multimode OM3 [2000 MHz*km] fiber. The value is in units of <>. A value of 255 means that the transceiver supports a link length greater than 2.54 km. A value of zero means that the transceiver does not support 50 micron multimode fiber or that the length information must be determined from the transceiver Technology.", + "description": "This value specifies link length that is supported by the transceiver while operating in compliance with applicable standards using 50 micron multimode OM3 [2000 MHz*km] fiber. The value is in units of <>. A value of 255 means that the transceiver supports a link length greater than 2.54 km. A value of zero means that the transceiver does not support 50 micron multimode OM3 fiber or that the length information must be determined from the transceiver technology.", "datatype": "unsignedInt", "range": [ { @@ -30742,7 +30991,8 @@ "cwmp", "usp" ], - "description": "Access technology that is currently in use.", + "description": "Access technology that is currently in use. Note: The Unknown value was added in Device:2.20.", + "default": "Unknown", "datatype": "string" }, "AvailableNetworks": { @@ -30831,6 +31081,22 @@ "datatype": "int", "unit": "dBm" }, + "Mode": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The current NR mode being used.", + "datatype": "string", + "enumerations": [ + "Unknown", + "Standalone", + "NonStandalone" + ] + }, "UpstreamMaxBitRate": { "type": "unsignedInt", "read": true, @@ -31244,12 +31510,12 @@ "Location": { "type": "string", "read": true, - "write": true, + "write": false, "protocols": [ "cwmp", "usp" ], - "description": "Specifies the storage location e.g. SM SIM card, ME device memory.", + "description": "Specifies the storage location e.g. SM SIM card, ME device memory. Note: The access type was changed to readOnly in Device:2.20.1", "datatype": "string", "range": [ { @@ -31524,11 +31790,11 @@ "cwmp", "usp" ], - "description": "Access Point Name.", + "description": "Access Point Name. In 5G, this is conceptually equivalent to the Data Network Name (DNN) <>. Note: The description and maximum string length requirements were updated in Device:2.20.1 to be compliant with DNN.", "datatype": "string", "range": [ { - "max": 64 + "max": 100 } ] }, @@ -31695,12 +31961,12 @@ "Status": { "type": "string", "read": true, - "write": true, + "write": false, "protocols": [ "cwmp", "usp" ], - "description": "The current status of the SIM.", + "description": "The current status of the SIM. Note: access type was made `readOnly` in Device:2.20.1.", "datatype": "string", "enumerations": [ "None", @@ -31904,12 +32170,10 @@ "cwmp", "usp" ], - "description": "Allows the Controller to change the USIM PIN used for SIM card activation.", + "description": "Allows the Controller to change the USIM PIN used for SIM card activation. The PIN is used for user verification and to control access to the USIM. For more information, see <>. Note: The PIN length was updated in Device:2.20.1.", "datatype": "string", - "range": [ - { - "max": 4 - } + "pattern": [ + "[0-9]{4,8}" ] }, "ProtectionScheme": { @@ -35569,6 +35833,35 @@ ], "unit": "Mbps" }, + "PowerCapability": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Describes the possible power states of the <> regardless of its current administrative state.", + "list": { + "datatype": "string", + "enumerations": [ + "On", + "Off", + "LowPower" + ] + } + }, + "PowerStatus": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Reports the current power status of the <>. <> <>", + "datatype": "string" + }, "MACAddress": { "type": "string", "read": true, @@ -35801,6 +36094,26 @@ ] } }, + "ChangePowerMode()": { + "type": "command", + "async": true, + "protocols": [ + "usp" + ], + "input": { + "PowerState": { + "type": "string", + "read": true, + "write": true, + "mandatory": true, + "protocols": [ + "usp" + ], + "description": "Targeted power state. <>", + "datatype": "string" + } + } + }, "Device.Ethernet.Interface.{i}.Stats.": { "type": "object", "protocols": [ @@ -37840,6 +38153,35 @@ "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", "datatype": "_AliasCWMP" }, + "PowerCapability": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Describes the possible power states of the <> regardless of its current administrative state.", + "list": { + "datatype": "string", + "enumerations": [ + "On", + "Off", + "LowPower" + ] + } + }, + "PowerStatus": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Reports the current power status of the <>. <> <>", + "datatype": "string" + }, "Name": { "type": "string", "read": true, @@ -37938,6 +38280,26 @@ "Bus", "Unknown" ] + }, + "ChangePowerMode()": { + "type": "command", + "async": true, + "protocols": [ + "usp" + ], + "input": { + "PowerState": { + "type": "string", + "read": true, + "write": true, + "mandatory": true, + "protocols": [ + "usp" + ], + "description": "Targeted power state. <>", + "datatype": "string" + } + } } }, "Device.USB.USBHosts.": { @@ -37960,6 +38322,28 @@ "description": "<>", "datatype": "unsignedInt" }, + "AllowedDeviceNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "AllowAllDevices": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "When set to <>, all USB devices are allowed to connect to the Device and the configuration mentioned in <> is ignored. When set to <>, only USB devices listed in <> are allowed to connect to the Device. Any USB device not explicitly listed will be rendered inactive.", + "datatype": "boolean" + }, "Device.USB.USBHosts.Host.{i}.": { "type": "object", "protocols": [ @@ -38356,6 +38740,36 @@ "description": "When <> the associated device is at least partly powered by a local source (see <>). When <> the associated device draws all the current it needs from the USB bus.", "datatype": "boolean" }, + "DeviceState": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the low-level device state, directly mapping to the Visible Device States in <>.", + "datatype": "string", + "enumerations": [ + "Attached", + "Powered", + "Default", + "Address", + "Configured", + "Suspended" + ] + }, + "IsAllowed": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "When <>, the associated USB device is allowed to connect to the Device USB Host controller(s) based on the configuration in <> and <>. When <>, the associated USB device is not allowed to connect.", + "datatype": "boolean" + }, "ConfigurationNumberOfEntries": { "type": "unsignedInt", "read": true, @@ -38480,6 +38894,149 @@ } } } + }, + "Device.USB.USBHosts.AllowedDevice.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Table of USB devices permitted to connect to the Device USB Host controller(s). Each entry in this table defines an allowed device based on its e.g. USB Vendor ID and Product ID. Only USB devices listed here will be accepted by the Device; any USB device not explicitly listed will be rendered inactive. When a USB device is rendered inactive, the parameter value of <.Device..IsAllowed>> is set to <>, which prevents the <.Device..DeviceState>> from reaching the <.Device..DeviceState>> status.", + "uniqueKeys": [ + "Alias" + ], + "access": true, + "array": true, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enables or disables whether the corresponding allowed USB device entry is active. If set to <>, the device defined by this entry is permitted to connect to the system. If <>, the device is ignored even if its identifiers match.", + "datatype": "boolean" + }, + "Description": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A user-friendly description of the allowed USB device entry.", + "datatype": "string", + "range": [ + { + "max": 64 + } + ] + }, + "DeviceClass": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Classification criterion. Class Code assigned by USB-IF, which can be expressed as a two-digit hexadecimal string (e.g., `00`), but can also include a wildcard character. When `00`, the device specifies its own class code. When `FF`, the class code is vendor-specific. The `*` wildcard may be used to match any value, either fully (e.g., `*`) or partially (e.g., `F*` or `*3`). When empty, the device is not classified by Device Class.", + "datatype": "string", + "pattern": [ + "", + "[0-9A-Fa-f*]{2}" + ] + }, + "DeviceSubClass": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Classification criterion. Subclass code assigned by USB-IF, expressed as a two-digit hexadecimal string (e.g., `01`), but can also include a wildcard character. The `*` wildcard may be used to match any value, either fully (e.g., `*`) or partially (e.g., `0*` or `*3`). When empty, the device is not classified by Device Subclass.", + "datatype": "string", + "pattern": [ + "", + "[0-9A-Fa-f*]{2}" + ] + }, + "DeviceProtocol": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Classification criterion. Protocol code assigned by USB-IF, expressed as a two-digit hexadecimal string (e.g., `02`), but can also include a wildcard character. The `*` wildcard may be used to match any value, either fully (e.g., `*`) or partially (e.g., `0*` or `*2`). When empty, the device is not classified by Device Protocol.", + "datatype": "string", + "pattern": [ + "", + "[0-9A-Fa-f*]{2}" + ] + }, + "ProductID": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Classification criterion. Product ID assigned by the manufacturer, expressed as a two- to four-digit hexadecimal string (e.g., `5678`), but can also include a wildcard character. The `*` wildcard may be used to match any value, either fully (e.g., `*`) or partially (e.g., `5*`). When empty, the device is not classified by Product ID.", + "datatype": "string", + "pattern": [ + "", + "[0-9A-Fa-f*]{4}" + ] + }, + "VendorID": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Classification criterion. Vendor ID assigned by USB-IF, expressed as a two- to four-digit hexadecimal string (e.g., `1234`), but can also include a wildcard character. The `*` wildcard may be used to match any value, either fully (e.g., `*`) or partially (e.g., `1*`). When empty, the device is not classified by Vendor ID.", + "datatype": "string", + "pattern": [ + "", + "[0-9A-Fa-f*]{4}" + ] + }, + "Interfaces": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Each item defines an allowed USB interface in the format InterfaceClass:InterfaceSubClass:InterfaceProtocol, using two-digit hexadecimal values (e.g., `FF`), but can also include a wildcard character. The `*` wildcard may be used to match any value, either fully (e.g., `*`) or partially (e.g., `F*`). A connected device is allowed only if all of its interfaces match entries in this list. * InterfaceClass: USB Class Code (`00` = per-interface class, `FF` = vendor-specific) * InterfaceSubClass: USB Subclass Code * InterfaceProtocol: USB Protocol Code Example: An USB Device might expose two interfaces: * `0xFF:0x02:0x01` for diagnostics * `0xFF:0x02:0x02` for data These can be allowed by listing both explicitly, or using patterns like `FF:02:*` or `F*:0*:0*`. When empty, the device is not classified by Interfaces.", + "list": { + "datatype": "string", + "pattern": [ + "", + "[0-9A-Fa-f*]{2}:[0-9A-Fa-f*]{2}:[0-9A-Fa-f*]{2}" + ] + } + } } } }, @@ -40881,7 +41438,7 @@ "cwmp", "usp" ], - "description": "Indicates whether link-layer security is enabled or disabled. This parameter is based on mocaIfPrivacyEnable from <>. <> are associated with the same underlying MIB object and it is therefore unnecessary. If implemented, it MUST return the same value as <>>> <>", + "description": "Indicates whether link-layer security is enabled or disabled. This parameter is based on mocaIfPrivacyEnable from <>. <> are associated with the same underlying MIB object and it is therefore unnecessary. If implemented, it MUST return the same value as <>>> <> <>", "datatype": "boolean" }, "AccessControlEnable": { @@ -41772,7 +42329,7 @@ "cwmp", "usp" ], - "description": "The value in dB by which to reduce the setting of the transmit power of the Beacon from the maximum transmit power (BEACON_PWR_BACKOFF Managed Parameter). The beacon transmit power SHALL only be changed when <> is not <>, which means the interface is not part of a MoCA network. If changed, the parameter may not take effect until the MoCA interface is restarted. This parameter is based on mocaIfBeaconPowerLimit from <>. Note that this parameter maps to different MIB objects for MoCA 1.0/1.1 and MoCA 2.0. <> <>", + "description": "The value in dB by which to reduce the setting of the transmit power of the Beacon from the maximum transmit power (BEACON_PWR_BACKOFF Managed Parameter). The beacon transmit power SHALL only be changed when <> is not <>, which means the interface is not part of a MoCA network. If changed, the parameter may not take effect until the MoCA interface is restarted. This parameter is based on mocaIfBeaconPowerLimit from <>. Note that this parameter maps to different MIB objects for MoCA 1.0/1.1 and MoCA 2.0. <> <> <>", "default": "0", "datatype": "MocaDB" }, @@ -42563,7 +43120,7 @@ "protocols": [ "cwmp" ], - "description": "This trap is sent when <> is <>>, indicates that there is a NC change when the Node is Non-Secured Admitted Node. This parameter is a counter that is incremented whenever the event occurs.", + "description": "This trap is sent when <> is <>, indicates that there is a NC change when the Node is Non-Secured Admitted Node. This parameter is a counter that is incremented whenever the event occurs.", "datatype": "unsignedInt" }, "BelowPhyThresholdTrap!": { @@ -43970,7 +44527,7 @@ "cwmp", "usp" ], - "description": "The reduction in transmitter level due to power control. This parameter is based on mocaNodeTxPowerReduction from <>. <.Mesh..PowerReduction>>. See <>>> <>", + "description": "The reduction in transmitter level due to power control. This parameter is based on mocaNodeTxPowerReduction from <>. <.Mesh..PowerReduction>>. See <>>> <> <>", "datatype": "MocaDB" }, "RxPowerLevel": { @@ -43982,7 +44539,7 @@ "cwmp", "usp" ], - "description": "The power level (in <>) received at the MoCA interface from this remote device. This parameter is based on mocaNodeRxPower from <>. <.Mesh..Power>>. See <>>> <>", + "description": "The power level (in <>) received at the MoCA interface from this remote device. This parameter is based on mocaNodeRxPower from <>. <.Mesh..Power>>. See <>>> <> <>", "datatype": "unsignedInt", "unit": "dBm" }, @@ -44112,7 +44669,7 @@ "cwmp", "usp" ], - "description": "The signal to noise level received at this interface from this remote device. This parameter is based on mocaNodeSNR from <>. <.Mesh..RxSNR>>. See <>>> <>", + "description": "The signal to noise level received at this interface from this remote device. This parameter is based on mocaNodeSNR from <>. <.Mesh..RxSNR>>. See <>>> <> <>", "datatype": "MocaDB" }, "Active": { @@ -46672,6 +47229,32 @@ "datatype": "unsignedInt", "unit": "Mbps" }, + "Type": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The type of HomePlug interface.", + "datatype": "string", + "enumerations": [ + "Embedded", + "Logical" + ] + }, + "Interface": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Layer 2 Ethernet Interface over which the network protocol operates, when the Type parameter is <>.", + "datatype": "string" + }, "MACAddress": { "type": "string", "read": true, @@ -47072,6 +47655,33 @@ "([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])" ] }, + "Manufacturer": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The manufacturer of the remote HomePlug device.", + "datatype": "string", + "range": [ + { + "max": 64 + } + ] + }, + "FirmwareVersion": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The firmware version of the remote HomePlug device.", + "datatype": "string" + }, "TxPhyRate": { "type": "unsignedInt", "read": true, @@ -51006,7 +51616,7 @@ "cwmp", "usp" ], - "description": "Two-character country code in which the Multi-AP Agent is operating according to <>. The characters are encoded as UTF-8. If the instance of this <> is the same as <.>>, then this parameter is the same as <.RegulatoryDomain>>.", + "description": "Two-character country code in which the Multi-AP Agent is operating according to <>. The characters are encoded as UTF-8. If the instance of this <> is the same as <.>>, then this parameter is the same as the first two octets of <.RegulatoryDomain>>.", "datatype": "string", "range": [ { @@ -52213,7 +52823,7 @@ "cwmp", "usp" ], - "description": "This object contains a table of Wi-Fi 6 <> operating classes, and channels within those operating classes, which have anticipated channel preference. Operating Class contains an enumerated value from <>>.", + "description": "This object contains a table of Wi-Fi 6 <> operating classes, and channels within those operating classes, which have anticipated channel preference. Operating Class contains an enumerated value from <>.", "uniqueKeys": [ "OpClass" ], @@ -52566,7 +53176,7 @@ "cwmp", "usp" ], - "description": "Organizationally unique identifier of the Access Point device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. <> The value MUST be a valid OUI as defined in <>. This value MUST remain fixed over the lifetime of the device, including across firmware updates. If the instance of this <> is the same as <>, then this parameter is the same as <>. <>.>>", + "description": "Organizationally unique identifier of the Access Point device manufacturer. Represented as a six hexadecimal-digit value using all upper-case letters and including any leading zeros. <> The value MUST be a valid OUI as defined in <>. This value MUST remain fixed over the lifetime of the device, including across firmware updates. If the instance of this <> is the same as <>, then this parameter is the same as <>. <>.>> <>", "datatype": "string", "range": [ { @@ -52609,7 +53219,7 @@ "cwmp", "usp" ], - "description": "This parameter represents the status of Wi-Fi CERTIFIED EasyMeshTM controller functionality. Enumeration of: NotSupported, SupportedNotEnabled, Running. <>.>>", + "description": "This parameter represents the status of Wi-Fi CERTIFIED EasyMeshTM controller functionality. Enumeration of: NotSupported, SupportedNotEnabled, Running. <>.>> <>", "datatype": "string", "enumerations": [ "NotSupported", @@ -52639,7 +53249,7 @@ "cwmp", "usp" ], - "description": "This object represents an individual Access Point devices Backhaul and unique aspects in the Wi-Fi network. The endpoints of the backhaul interface are represented by the (Devices ID and interface MAC Address). This object represents the upward view of the backhaul interface. The two endpoints of the backhaul interface are - (<>, <>) of the uplinked Backhaul Device - <> of this Access Point Device. <> is reserved for the <> instance that represents the Multi-AP Controller.", + "description": "This object represents an individual Access Point devices Backhaul and unique aspects in the Wi-Fi network. The endpoints of the backhaul interface are represented by the (Devices ID and interface MAC Address). This object represents the upward view of the backhaul interface. The two endpoints of the backhaul interface are - (<>, <>) of the uplinked Backhaul Device - <> of this Access Point Device. <> is reserved for the <> instance that represents the Multi-AP Controller.", "access": false, "array": false, "LinkType": { @@ -52651,7 +53261,7 @@ "cwmp", "usp" ], - "description": "The medium being used to backhaul this Access Point Device to the Backhaul Access Point Device. The <> value is reserved for the <> instance that represents the Multi-AP Controller. Enumeration of: None, Wi-Fi, MoCA, Ethernet, G.hn, HPNA, HomePlug, UPA. <>.>>", + "description": "The medium being used to backhaul this Access Point Device to the Backhaul Access Point Device. The <> value is reserved for the <> instance that represents the Multi-AP Controller. Enumeration of: None, Wi-Fi, MoCA, Ethernet, G.hn, HPNA, HomePlug, UPA. <>.>> <>", "datatype": "string", "enumerations": [ "None", @@ -52673,7 +53283,7 @@ "cwmp", "usp" ], - "description": "The MAC Address at the far end of the backhaul link of the interface on the network that is providing a backhaul for this Access Point Device. This along with <>, helps to identify the backhaul interface endpoint. <> is reserved for the <> instance that represents the Multi-AP Controller. <>.>>", + "description": "The MAC Address at the far end of the backhaul link of the interface on the network that is providing a backhaul for this Access Point Device. This along with <>, helps to identify the backhaul interface endpoint. <> is reserved for the <> instance that represents the Multi-AP Controller. <>.>> <>", "datatype": "MACAddress", "range": [ { @@ -52694,7 +53304,7 @@ "cwmp", "usp" ], - "description": "The Devices ID of the Device on the network that is providing a Backhaul Link for this Access Point Device. <>.>>", + "description": "The Devices ID of the Device on the network that is providing a Backhaul Link for this Access Point Device. <>.>> <>", "datatype": "MACAddress", "range": [ { @@ -52715,7 +53325,7 @@ "cwmp", "usp" ], - "description": "The MAC Address at the near end of the backhaul link of this Access Point Devices backhaul interface that is connecting via <> to <> of the Backhaul Device identified by <>. <.BackhaulSta.MACAddress>>.>>", + "description": "The MAC Address at the near end of the backhaul link of this Access Point Devices backhaul interface that is connecting via <> to <> of the Backhaul Device identified by <>. <.BackhaulSta.MACAddress>>.>> <>", "datatype": "MACAddress", "range": [ { @@ -52900,7 +53510,7 @@ "cwmp", "usp" ], - "description": "The total number of bytes transmitted across the backhaul medium (as identified by the value of the <>>> parameter), including framing characters.", + "description": "The total number of bytes transmitted across the backhaul medium (as identified by the value of the <> parameter), including framing characters.", "datatype": "StatsCounter64" }, "BytesReceived": { @@ -53070,6 +53680,17 @@ "description": "Indicates whether this radio is enabled or disabled. If the instance of this <> is the same as <.>>, then this parameter is the same as <.Enable>>.", "datatype": "boolean" }, + "RadioTemplateRef": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> is a reference to the RadioTemplate selected for this <>.", + "datatype": "string" + }, "Noise": { "type": "unsignedInt", "read": true, @@ -56647,6 +57268,28 @@ "description": "Whether the BSSID is currently enabled (beaconing frames are being sent) or disabled. If the instance of this <> is the same as <.>>, then this parameter is the same as <.Enable>>.", "datatype": "boolean" }, + "BSSTemplateRef": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> is a reference to the BSSTemplate selected for this <>.", + "datatype": "string" + }, + "SecurityTemplateRef": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> is a reference to the SecurityTemplate selected for this <>.", + "datatype": "string" + }, "LastChange": { "type": "unsignedInt", "read": true, @@ -58997,7 +59640,7 @@ "cwmp", "usp" ], - "description": "Date and time in UTC when the device was associated. If the instance of this <> is the same as <.AssociatedDevice..>>, then this parameter is the same as <.AssociatedDevice..AssociationTime>>. <>.>>", + "description": "Date and time in UTC when the device was associated. If the instance of this <> is the same as <.AssociatedDevice..>>, then this parameter is the same as <.AssociatedDevice..AssociationTime>>. <>.>> <>", "datatype": "dateTime" }, "Noise": { @@ -59009,7 +59652,7 @@ "cwmp", "usp" ], - "description": "An indicator of the average radio noise plus interference power measured on the uplink from the Associated Device (STA) to the Access Point (AP). Encoded as defined for ANPI in <>. If the instance of this <> is the same as <.AssociatedDevice..>>, then this parameter is the same as <.AssociatedDevice..Noise>>. <>.>>", + "description": "An indicator of the average radio noise plus interference power measured on the uplink from the Associated Device (STA) to the Access Point (AP). Encoded as defined for ANPI in <>. If the instance of this <> is the same as <.AssociatedDevice..>>, then this parameter is the same as <.AssociatedDevice..Noise>>. <>.>> <>", "datatype": "unsignedInt", "range": [ { @@ -60141,7 +60784,7 @@ "cwmp", "usp" ], - "description": "<> List items represent channels in the non-occupancy list due to radars detected by Dynamic Frequency Selection (DFS) Channel Availability Check (CAC). <.>>.>>", + "description": "<> List items represent channels in the non-occupancy list due to radars detected by Dynamic Frequency Selection (DFS) Channel Availability Check (CAC). <.>>.>> <>", "list": { "datatype": "unsignedInt", "maxsize": 1024 @@ -60451,6 +61094,17 @@ "([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])" ] }, + "APMLDTemplateRef": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> is a reference to the APMLDTemplate selected for this <>.", + "datatype": "string" + }, "TIDLinkMapNumberOfEntries": { "type": "unsignedInt", "read": true, @@ -61888,7 +62542,7 @@ "cwmp", "usp" ], - "description": "<> <> <>", + "description": "<> <> <> <>", "datatype": "unsignedInt" }, "Associated!": { @@ -62053,7 +62707,7 @@ "cwmp", "usp" ], - "description": "The events generated when an Associated Device (STA) associates to a BSS. <> <>", + "description": "The events generated when an Associated Device (STA) associates to a BSS. <> <> <>", "access": false, "array": true, "TimeStamp": { @@ -62229,7 +62883,7 @@ "cwmp", "usp" ], - "description": "Describes the Wi-Fi 6 capabilities of the Associated Device (STA). <> <>", + "description": "Describes the Wi-Fi 6 capabilities of the Associated Device (STA). <> <> <>", "access": false, "array": false, "HE160": { @@ -62555,7 +63209,7 @@ "cwmp", "usp" ], - "description": "<> <> <>", + "description": "<> <> <> <>", "datatype": "unsignedInt" }, "Disassociated!": { @@ -62856,7 +63510,7 @@ "cwmp", "usp" ], - "description": "The events generated when an Associated Device (STA) disassociates from a BSS. <> <>", + "description": "The events generated when an Associated Device (STA) disassociates from a BSS. <> <> <>", "access": false, "array": true, "BSSID": { @@ -63208,7 +63862,7 @@ "cwmp", "usp" ], - "description": "<> <> <>", + "description": "<> <> <> <>", "datatype": "unsignedInt" }, "FailedConnection!": { @@ -63294,7 +63948,7 @@ "cwmp", "usp" ], - "description": "This object describes the data provided with a failed connection event <> <>", + "description": "This object describes the data provided with a failed connection event <> <> <>", "access": false, "array": true, "BSSID": { @@ -63378,6 +64032,1337 @@ } } }, + "Device.WiFi.Templates.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Wi-Fi Configuration Templates provide a comprehensive way to configure Wi-Fi. Configuration Templates can be applied across multiple deployments in an operators network, and across multiple APs, radios and BSSs. A set of Configuration Templates can be pre-defined, which can then handle many different services and scenarios by matching flags to select a particular template depending on AP or radio capabilities and topology. Different BSSs can be configured across different radios to provision different types of services. A detailed description of how to use Wi-Fi Configuration Templates is in <>. The Configuration Template Manager (CTM) interprets and implements Configuration Templates for each deployment.", + "access": false, + "array": false, + "BSSTemplateNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "RadioTemplateNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "SecurityTemplateNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "SecurityGroupNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "APMLDTemplateNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "SSCTemplateNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "Device.WiFi.Templates.Network.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This <> either has the Configuration Template Manager (CTM) deploy BSS(s) according to the templates, or has all BSS(s) be disabled.", + "access": false, + "array": false, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates whether any BSS may be deployed in the Wi-Fi network. : <>: BSS(s) are deployed according to the template matching process. : <>: No BSS is deployed in the network.", + "datatype": "boolean" + }, + "TopologyFlag": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The TopologyFlag is used to specify a list of EasyMesh Agents on which BSS(es) are deployed according to the template matching process. If an EasyMesh Agent does not match any value in the list, then no BSS is deployed on this EasyMesh Agent. These values refer to the network topology role of the EasyMesh Agent as determined by the EasyMesh Controller. This flag matches if any of the list items match (logical OR). <>Enumeration of: Root, Repeater, Wired_Repeater, Wireless_Repeater, ALID.", + "list": { + "datatype": "string", + "enumerations": [ + "Root", + "Repeater", + "Wired_Repeater", + "Wireless_Repeater", + "ALID" + ] + } + }, + "IEEE1905ALID": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> IEEE 1905 <> Abstraction-Layer ID (ALID). This matches if any of the list items match (logical OR). This should match an entry in <.ID>>.", + "list": { + "datatype": "MACAddress", + "range": [ + { + "max": 17 + } + ], + "pattern": [ + "", + "([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])" + ] + } + }, + "PrimarySSCTemplateReference": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Incicates the Primary SSCTemplate. The PrimaryVLANID in the EasyMesh network is the VLANID of the SSCTemplate referenced by <>. If this value is empty, then Traffic Separation is not used. <>.", + "datatype": "string" + }, + "PrimarySSCTemplateID": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the Primary SSCTemplate. The value must be the <.SSCTemplateID>> to identify an instance of <>. If this value is empty, then Traffic Separation is not used. <>.", + "datatype": "string" + } + }, + "Device.WiFi.Templates.BSSTemplate.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Table of Basic Service Set (BSS) templates for Wi-Fi configuration.", + "uniqueKeys": [ + "BSSTemplateID", + "Alias" + ], + "access": true, + "array": true, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "BSSTemplateID": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Static and persistent ID element. At most one <> instance can exist with a given value for <>.", + "datatype": "string" + }, + "Priority": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This value indicates in which order the <> are to be matched for a reported radio. 255 is the highest priority, 0 is the lowest priority.", + "datatype": "unsignedInt", + "range": [ + { + "max": 255 + } + ] + }, + "RadioTemplateReference": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This <> is linked to <>.", + "datatype": "string" + }, + "SSCTemplateReference": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This <> is linked to <>.", + "datatype": "string" + }, + "APMLDTemplateReference": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This <> is linked to <>.", + "datatype": "string" + }, + "SecurityGroupReference": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This <> is linked to <>.", + "datatype": "string" + }, + "LinkedRadioTemplateID": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the <.RadioTemplateID>> that is linked with this <>.", + "datatype": "string" + }, + "LinkedSSCTemplateID": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the <.SSCTemplateID>> that is linked with this <>.", + "datatype": "string" + }, + "LinkedAPMLDTemplateID": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the <.APMLDTemplateID>> that is linked with this <>.", + "datatype": "string" + }, + "LinkedSecurityGroupID": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the <.SecurityGroupID>> of the <>> in which a matching <> is searched.", + "datatype": "string" + }, + "TopologyFlag": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The topology flag is used to specify a list of EasyMesh Agents for which this <> is considered by the Configuration Template Manager during the matching process. If an Agent does not match any value in the list, then no BSS matching this BSSTemplate is deployed on the EasyMesh Agent. These values refer to the network topology point of the EasyMesh Agent as determined by the EasyMesh Controller. This flag matches if any of the list items match (logical OR). <>Enumeration of: Root, Repeater, Wired_Repeater, Wireless_Repeater, ALID.", + "list": { + "datatype": "string", + "enumerations": [ + "Root", + "Repeater", + "Wired_Repeater", + "Wireless_Repeater", + "ALID" + ] + } + }, + "IEEE1905ALID": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> IEEE 1905 <> Abstraction-Layer ID (ALID). This flag matches if any of the list items match (logical OR). This should match an entry in <.ID>>.", + "list": { + "datatype": "MACAddress", + "range": [ + { + "max": 17 + } + ], + "pattern": [ + "", + "([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])" + ] + } + }, + "MaxWLANHopLimitFlag": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the maximum number of wireless hops (consecutive or not) allowed between the EasyMesh Controller and the EasyMesh Agent. In single-AP deployment, this flag is ignored.", + "datatype": "unsignedInt", + "range": [ + { + "max": 255 + } + ] + }, + "SecureEquipmentFlag": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the 1905 Security of the EasyMesh Agent <>. Enumeration of: true, false, null.", + "datatype": "string", + "enumerations": [ + "true", + "false", + "null" + ] + }, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Determines if this template is considered by the Configuration Template Manager in the template matching process.", + "datatype": "boolean" + }, + "SSID": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Service Set Identifier (SSID) used as an identifier by all deployed BSSs linked to this <>.", + "datatype": "string" + }, + "KeyPassphrase": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The KeyPassphrase to be used by all deployed BSSs linked to this <>.", + "datatype": "string" + }, + "AdvertisementEnable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates if the <> is advertised in beacons : <>: this <> is to be advertised in beacons. : <>: this <> is not to be advertised in beacons.", + "datatype": "boolean" + } + }, + "Device.WiFi.Templates.RadioTemplate.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Table of RadioTemplates for Wi-Fi configuration.", + "uniqueKeys": [ + "RadioTemplateID", + "Alias" + ], + "access": true, + "array": true, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "RadioTemplateID": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Static and persistent ID element. At most one <> instance can exist with a given value for <>. Note that <> is not the same as <.Radio..ID>>.", + "datatype": "string" + }, + "Priority": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This value indicates in which order the <> are to be matched for a radio under configuration. 255 is the highest priority, 0 is the lowest priority.", + "datatype": "unsignedInt", + "range": [ + { + "max": 255 + } + ] + }, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Determines if this <> is considered by the Configuration Template Manager (CTM) in the template matching process. This value is independent from the value of any <.Enable>>. This value is also independent from the value of any <.Radio..Enabled>>.", + "datatype": "boolean" + }, + "OpClassFlag": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> Each list item is a global valid operating class as defined in <>). Indicates the Operating Classes the Radio can operate on. Exactly one of <> or <> must be empty and exactly one must be filled in. A Radio must be able to operate on at least one channel of each Operating Class specified in this list to satisfy this condition.", + "list": { + "datatype": "unsignedInt", + "range": [ + { + "max": 255 + } + ] + } + }, + "BandFlag": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates frequency bands the Radio can operate on. All listed UNII bands are to be in the same 2.4, 5 or 6 GHz band. Exactly one of <> or <> must be empty. <>Enumeration of: 2.4, 5, 6, 5_UNII_1, 5_UNII_2, 5_UNII_3, 5_UNII_4, 6_UNII_5, 6_UNII_6, 6_UNII_7, 6_UNII_8, Sub_1GHz.", + "list": { + "datatype": "string", + "enumerations": [ + "2.4", + "5", + "6", + "5_UNII_1", + "5_UNII_2", + "5_UNII_3", + "5_UNII_4", + "6_UNII_5", + "6_UNII_6", + "6_UNII_7", + "6_UNII_8", + "Sub_1GHz" + ] + } + }, + "SupportedGenerationFlag": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> Each list item indicates a supported Wi-Fi Generation. Each list item indicates a Supported Generation of Generational Capabilities Indication attribute. For example <> could be 5,6,7.", + "list": { + "datatype": "unsignedInt", + "range": [ + { + "min": 1, + "max": 255 + } + ] + } + }, + "DFSSupportFlag": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates Dynamic Frequency Selection (DFS) support. Enumeration of: true, false, null.", + "datatype": "string", + "enumerations": [ + "true", + "false", + "null" + ] + }, + "AFCSupportFlag": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates Automated Frequency Coordination (AFC) support. Enumeration of: true, false, null.", + "datatype": "string", + "enumerations": [ + "true", + "false", + "null" + ] + }, + "TransmitPowerLimit": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This is the upper limit on nominal transmit Equivalent Isotropically Radiated Power (EIRP) that this radio is allowed to use for the current operating class. In units of decibels relative to 1 mW <>.", + "datatype": "int", + "range": [ + { + "min": -128, + "max": 127 + } + ], + "unit": "dBm" + }, + "OperatingGeneration": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> Each list item indicates a Wi-Fi Generation deployed on this EasyMesh Agent or this device. The last list item may be followed by a + to indicate the inclusion of any existing Wi-Fi Generation above it. If an EasyMesh agent or device supports a Wi-Fi Generation not in the list, then that Wi-Fi Generation is disabled on the EasyMesh agent or device. For example, 6,7+ means Wi-Fi 6, Wi-Fi 7 and any newer Wi-Fi Generation. Note: <> may include Wi-Fi Generations not supported by a radio to which this <> is deployed.", + "list": { + "datatype": "string" + } + } + }, + "Device.WiFi.Templates.SecurityTemplate.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Table of SecurityTemplates for Wi-Fi configuration <>.", + "uniqueKeys": [ + "SecurityTemplateID", + "Alias" + ], + "access": true, + "array": true, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "SecurityTemplateID": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Static and persistent ID element. At most one <> instance can exist with a given value for <>.", + "datatype": "string" + }, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Determines if this template is considered by the Configuration Template Manager in the template matching process.", + "datatype": "boolean" + }, + "Priority": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This value indicates in which order the <> are to be matched. 255 is the highest priority, 0 is the lowest priority.", + "datatype": "unsignedInt", + "range": [ + { + "max": 255 + } + ] + }, + "RSNOSupportFlag": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates support for Robust Security Network (RSN) Overriding (RSNO). RSN Overriding (RSNO) is also known as MRSNO and is used in WPA3-Personal Compatibility Mode. Enumeration of: true, false, null.", + "datatype": "string", + "enumerations": [ + "true", + "false", + "null" + ] + }, + "SupportedAKMSuiteFlag": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> Authentication and Key Management (AKM) suite selector. Only the listed enumeration values are allowed in this string. Enumeration of: psk, dpp, sae, sae-ext-key, SuiteSelector.", + "list": { + "datatype": "string", + "enumerations": [ + "psk", + "dpp", + "sae", + "sae-ext-key", + "SuiteSelector" + ] + } + }, + "SupportedAKMSuiteSelectorFlag": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> AKM suite selector, the AKM suite selector (OUI and type) is encoded as a 4-octet hex-encoded value without internal delimiters, e.g. 506F9A02 <>. <> applies if <> includes value SuiteSelector.", + "list": { + "datatype": "hexBinary", + "range": [ + { + "min": 4, + "max": 4 + } + ] + } + }, + "OperatingGenerationFlag": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> The AP advertises support in its beacon frames for each Wi-Fi generation in this list for this flag to match. For example <> could be 5,6,7.", + "list": { + "datatype": "unsignedInt", + "range": [ + { + "min": 1, + "max": 255 + } + ] + } + }, + "SecurityIEs": { + "type": "hexBinary", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Concatenation of all BSS Security related IEs with Element IDs, without delimiters as hex encoded octets <>. Note that this <> and the <>, <>, <>, <>, <> objects are independent and may be set separately. If this <> is not empty, the Configuration Template Manager (CTM) uses the value of this <> and ignores the content of the RSNE/RSNOE/RSNO2E/RSNXE/RSNXOE objects.", + "datatype": "hexBinary" + }, + "Device.WiFi.Templates.SecurityTemplate.{i}.RSNE.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the Robust Security Network Element (RSNE). This object is only used by the Configuration Template Manager if the <> is empty.", + "access": false, + "array": false, + "GroupDataCipherSuite": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Cipher suite selector used to protect group addressed data frames. This is the name of a cipher suite, as defined in <>. The following is an example value: CCMP-128.", + "datatype": "string" + }, + "PairwiseCipherSuite": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> Each list item is a cipher suite selector used to protect individually addressed Data frames, as defined in <>. The following is an example value: CCMP-128.", + "list": { + "datatype": "string" + } + }, + "AKMSuite": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Authentication and Key Management (AKM) suite <>. <>Enumeration of: psk, dpp, sae, sae-ext-key, SuiteSelector.", + "list": { + "datatype": "string", + "enumerations": [ + "psk", + "dpp", + "sae", + "sae-ext-key", + "SuiteSelector" + ] + } + }, + "AKMSuiteSelector": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> AKM suite selector, the AKM suite selector (OUI and type) is encoded as a 4-octet hex-encoded value without internal delimiters, e.g. 506F9A02 <>. <> applies if <> includes value SuiteSelector.", + "list": { + "datatype": "hexBinary", + "range": [ + { + "min": 4, + "max": 4 + } + ] + } + }, + "MFP": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the expected support for Management Frame Protection (MFP), aka Protected Management Frame (PMF). <> and see also the WPA3 and Wi-Fi Enhanced Open Deployment Guide v1.1.pdf, Table 3, row PMF.", + "datatype": "string", + "enumerations": [ + "Disabled", + "Capable", + "Required" + ] + }, + "GroupManagementCipherSuite": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Cipher suite selector used to protect group addressed robust Management frames. This is the name of a cipher suite, as defined in <>. The following is an example value: BIP-CMAC-128.", + "datatype": "string" + } + }, + "Device.WiFi.Templates.SecurityTemplate.{i}.RSNOE.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the RSNOE element. This object is only used by the Configuration Template Manager if the <> is empty.", + "access": false, + "array": false, + "GroupDataCipherSuite": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Cipher suite selector used to protect group addressed data frames. This is the name of a cipher suite, as defined in <>. The following is an example value: CCMP-128.", + "datatype": "string" + }, + "PairwiseCipherSuite": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> Each list item is a cipher suite selector used to protect individually addressed Data frames, as defined in <>. The following is an example value: CCMP-128.", + "list": { + "datatype": "string" + } + }, + "AKMSuite": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Authentication and Key Management (AKM) suite <>. <>Enumeration of: psk, dpp, sae, sae-ext-key, SuiteSelector.", + "list": { + "datatype": "string", + "enumerations": [ + "psk", + "dpp", + "sae", + "sae-ext-key", + "SuiteSelector" + ] + } + }, + "AKMSuiteSelector": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> AKM suite selector, the AKM suite selector (OUI and type) is encoded as a 4-octet hex-encoded value without internal delimiters, e.g. 506F9A02 <>. <> applies if <> includes value SuiteSelector.", + "list": { + "datatype": "hexBinary", + "range": [ + { + "min": 4, + "max": 4 + } + ] + } + }, + "MFP": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the expected support for Management Frame Protection (MFP), aka Protected Management Frame (PMF). <> and see also the WPA3 and Wi-Fi Enhanced Open Deployment Guide v1.1.pdf, Table 3, row PMF.", + "datatype": "string", + "enumerations": [ + "Disabled", + "Capable", + "Required" + ] + }, + "GroupManagementCipherSuite": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Cipher suite selector used to protect group addressed robust Management frames. This is the name of a cipher suite, as defined in <>. The following is an example value: BIP-CMAC-128.", + "datatype": "string" + } + }, + "Device.WiFi.Templates.SecurityTemplate.{i}.RSNO2E.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the RSNO2E element. This object is only used by the Configuration Template Manager if the <> is empty.", + "access": false, + "array": false, + "GroupDataCipherSuite": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Cipher suite selector used to protect group addressed data frames. This is the name of a cipher suite, as defined in <>. The following is an example value: CCMP-128.", + "datatype": "string" + }, + "PairwiseCipherSuite": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> Each list item is a cipher suite selector used to protect individually addressed Data frames, as defined in <>. The following is an example value: CCMP-128.", + "list": { + "datatype": "string" + } + }, + "AKMSuite": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Authentication and Key Management (AKM) suite <>. <>Enumeration of: psk, dpp, sae, sae-ext-key, SuiteSelector.", + "list": { + "datatype": "string", + "enumerations": [ + "psk", + "dpp", + "sae", + "sae-ext-key", + "SuiteSelector" + ] + } + }, + "AKMSuiteSelector": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> AKM suite selector, the AKM suite selector (OUI and type) is encoded as a 4-octet hex-encoded value without internal delimiters, e.g. 506F9A02 <>. <> applies if <> includes value SuiteSelector.", + "list": { + "datatype": "hexBinary", + "range": [ + { + "min": 4, + "max": 4 + } + ] + } + }, + "MFP": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the expected support for Management Frame Protection (MFP), aka Protected Management Frame (PMF). <> and see also the WPA3 and Wi-Fi Enhanced Open Deployment Guide v1.1.pdf, Table 3, row PMF.", + "datatype": "string", + "enumerations": [ + "Disabled", + "Capable", + "Required" + ] + }, + "GroupManagementCipherSuite": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Cipher suite selector used to protect group addressed robust Management frames. This is the name of a cipher suite, as defined in <>. The following is an example value: BIP-CMAC-128.", + "datatype": "string" + } + }, + "Device.WiFi.Templates.SecurityTemplate.{i}.RSNXE.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object indicates the value the BSS transmits in the RSNXE element. This object is only used by the Configuration Template Manager if the <> is empty.", + "access": false, + "array": false, + "SAEH2E": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates if the BSS will support Simultaneous Authentication of Equals (SAE) hash-to-element <>, or not <>. <>: BSS sets SAE hash-to-element to 1. <>: BSS sets SAE hash-to-element to 0.", + "datatype": "boolean" + } + }, + "Device.WiFi.Templates.SecurityTemplate.{i}.RSNXOE.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object indicates the value the BSS transmits in the RSNXOE element. This object is only used by the Configuration Template Manager if the <> is empty.", + "access": false, + "array": false, + "SAEH2E": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates if the BSS will support Simultaneous Authentication of Equals (SAE) hash-to-element <>, or not <>. <>: BSS sets SAE hash-to-element to 1. <>: BSS sets SAE hash-to-element to 0.", + "datatype": "boolean" + } + } + }, + "Device.WiFi.Templates.SecurityGroup.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Table of SecurityGroups for Wi-Fi configuration <>.", + "uniqueKeys": [ + "SecurityGroupID" + ], + "access": true, + "array": true, + "SecurityGroupID": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This is the friendly name of this <> which may be advertised to the end user in a graphical interface.", + "datatype": "string" + }, + "SecurityTemplateReferences": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the list of <> for this <>.", + "list": { + "datatype": "string" + } + }, + "LinkedSecurityTemplateID": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the <.SecurityTemplateID>> in this entry of this <>.", + "list": { + "datatype": "string" + } + } + }, + "Device.WiFi.Templates.APMLDTemplate.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Table of AP Multi-Link Device (MLD) templates (APMLDTemplate) for Wi-Fi configuration <>.", + "uniqueKeys": [ + "APMLDTemplateID", + "Alias" + ], + "access": true, + "array": true, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "APMLDTemplateID": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Static and persistent ID element. At most one <> instance can exist with a given value for <>.", + "datatype": "string" + }, + "MLOEnable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates whether or not Multi-Link Operation (MLO) is enabled. If set to <>, then MLO support is disabled and each deployment of a BSSTemplate related to this <> results in an AP MLD with a single affiliated AP. However, this does not disable the BSSs that are in the <>> linked to this <>.", + "datatype": "boolean" + }, + "STREnable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates whether or not Simultaneous Transmit and Receive (STR) mode is to be enabled on the AP MLD.", + "datatype": "boolean" + }, + "NSTREnable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates whether or not Non-Simultaneous Transmit and Receive (NSTR) mode is to be enabled on the AP MLD.", + "datatype": "boolean" + }, + "EMLSREnable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates whether or not Enhanced Multi-Link Single-Radio (EMLSR) mode is to be enabled on the AP MLD.", + "datatype": "boolean" + }, + "EMLMREnable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates whether or not Enhanced Multi-Link Multi-Radio (EMLMR) mode is to be enabled on the AP MLD.", + "datatype": "boolean" + }, + "TIDToLinkMapNegotiation": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates whether the TID-to-link Mapping Negotiation Support subfield in the MLD Capabilities and Operations field of the Basic Multi-Link element is (to be) enabled by any deployed AP MLD linked to this <>.", + "datatype": "boolean" + } + }, + "Device.WiFi.Templates.SSCTemplate.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Table of Service Set Collection (SSC) templates (SSCTemplate) for Wi-Fi configuration.", + "uniqueKeys": [ + "SSCTemplateID", + "Alias" + ], + "access": true, + "array": true, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "SSCTemplateID": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Static and persistent ID element. At most one <> instance can exist with a given value for <>.", + "datatype": "string" + }, + "SSCEnable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "If set to <>, then all BSSs that are linked with this <> are disabled, which means that these BSSs cease to offer service.", + "datatype": "boolean" + }, + "VID": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The VLAN ID (VID) for all BSSs that are part of this <>. A value of 0 indicates that no VLAN shall be configured on the BSSs belonging to this <>.", + "datatype": "unsignedInt", + "range": [ + { + "max": 4095 + } + ] + }, + "HaulType": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the use of the BSSs that are part of this <>. <>Enumeration of: Fronthaul, Backhaul.", + "list": { + "datatype": "string", + "enumerations": [ + "Fronthaul", + "Backhaul" + ] + } + } + } + }, "Device.WiFi.Radio.{i}.": { "type": "object", "protocols": [ @@ -63498,6 +65483,35 @@ "description": "Indicates whether the interface points towards the Internet (<>) or towards End Devices (<>). For example: * For an Internet Gateway Device, <> will be <> for all WAN interfaces and <> for all LAN interfaces. * For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, <> will be <> for the Ethernet interface and <> for the WiFi Radio interface. * For an End Device, <> will be <> for all interfaces. An interface might have some SSIDs pointing towards the Internet and other SSIDs pointing towards End Devices. This is indicated by the associated <.Upstream>> parameters. This interfaces <> parameter is set to <> if any of the associated SSID..Upstream parameters are <>, and is set to <> otherwise. This parameter was DEPRECATED in 2.12 (and then OBSOLETED in 2.14) because it couldnt describe all multi-SSID use cases. It has now been restored, and its multi-SSID behavior has been clarified.", "datatype": "boolean" }, + "PowerCapability": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Describes the possible power states of the <> regardless of its current administrative state.", + "list": { + "datatype": "string", + "enumerations": [ + "On", + "Off", + "LowPower" + ] + } + }, + "PowerStatus": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Reports the current power status of the <>. <> <>", + "datatype": "string" + }, "SupportedFrequencyBands": { "type": "string", "read": true, @@ -63949,7 +65963,7 @@ "cwmp", "usp" ], - "description": "The 802.11d Regulatory Domain. First two octets are <> two-character country code. The third octet is either (all environments), O (outside) or I (inside). If the instance of this <> is the same as <.>>, then this parameter is the same as <.CountryCode>>.", + "description": "The 802.11d Regulatory Domain. First two octets are <> two-character country code. The third octet is either (all environments), O (outside) or I (inside). If the instance of this <> is the same as <.>>, then the first two octets of this parameter are the same as <.CountryCode>>.", "datatype": "string", "range": [ { @@ -64194,6 +66208,132 @@ "datatype": "unsignedInt", "unit": "kbps" }, + "ConfiguredReceiveAntennas": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The bit pattern of the configured receive antennas that need to be activated. This parameter uses a bitmap to specify which receive antennas need to be enabled. Each bit in the unsigned integer corresponds to a specific antenna. If a bit is set to 1, the corresponding antenna is activated for reception. If a bit is set to 0, the antenna is deactivated. How the Bitmap Works: * Bit 0 (LSB): Corresponds to Antenna 0. If the value is odd (e.g., 1, 3, 5...), Antenna 0 is enabled. * Bit 1: Corresponds to Antenna 1. * Bit 2: Corresponds to Antenna 2. * And so on... * Bit N: Corresponds to Antenna N. Examples: * `0`: No receive antennas are activated. * `1`: Only Antenna 0 is activated for reception. * `2`: Only Antenna 1 is activated for reception. * `3`: Antenna 0 and Antenna 1 are activated for reception. * `255`: All 8 possible receive antennas (Antenna 0 through Antenna 7) are activated. The value MUST be within the range of <>, meaning you cannot attempt to activate an antenna that is not physically supported by the device. Valid values are: <>.", + "datatype": "int", + "range": [ + { + "min": -1, + "max": -1 + }, + { + "min": 0, + "max": 255 + } + ] + }, + "ConfiguredTransmitAntennas": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The bit pattern of the configured transmit antennas that need to be activated. This parameter uses a bitmap to specify which receive antennas need to be enabled. Each bit in the unsigned integer corresponds to a specific antenna. If a bit is set to 1, the corresponding antenna is activated for reception. If a bit is set to 0, the antenna is deactivated. How the Bitmap Works: * Bit 0 (LSB): Corresponds to Antenna 0. If the value is odd (e.g., 1, 3, 5...), Antenna 0 is enabled. * Bit 1: Corresponds to Antenna 1. * Bit 2: Corresponds to Antenna 2. * And so on... * Bit N: Corresponds to Antenna N. Examples: * `0`: No receive antennas are activated. * `1`: Only Antenna 0 is activated for reception. * `2`: Only Antenna 1 is activated for reception. * `3`: Antenna 0 and Antenna 1 are activated for reception. * `255`: All 8 possible receive antennas (Antenna 0 through Antenna 7) are activated. The value MUST be within the range of <>, meaning you cannot attempt to activate an antenna that is not physically supported by the device. Valid values are: <>.", + "datatype": "int", + "range": [ + { + "min": -1, + "max": -1 + }, + { + "min": 0, + "max": 255 + } + ] + }, + "SupportedReceiveAntennas": { + "type": "int", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the maximum number of antennas, used for receiving on this radio. Valid values are: <>.", + "datatype": "int", + "range": [ + { + "min": 0, + "max": 8 + }, + { + "min": -1, + "max": -1 + } + ] + }, + "SupportedTransmitAntennas": { + "type": "int", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the maximum number of antennas, used for receiving on this radio. Valid values are: <>.", + "datatype": "int", + "range": [ + { + "min": 0, + "max": 8 + }, + { + "min": -1, + "max": -1 + } + ] + }, + "ActiveReceiveAntennas": { + "type": "int", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The bit pattern of the receive antennas actively in use. This parameter uses a bitmap to specify which receive antennas are enabled. Each bit in the unsigned integer corresponds to a specific antenna. If a bit is set to 1, the corresponding antenna is activated for reception. If a bit is set to 0, the antenna is deactivated. Valid values are: <>.", + "datatype": "int", + "range": [ + { + "min": 0, + "max": 255 + }, + { + "min": -1, + "max": -1 + } + ] + }, + "ActiveTransmitAntennas": { + "type": "int", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The bit pattern of the transmit antennas actively in use. This parameter uses a bitmap to specify which transmit antennas are enabled. Each bit in the unsigned integer corresponds to a specific antenna. If a bit is set to 1, the corresponding antenna is activated for reception. If a bit is set to 0, the antenna is deactivated. Valid values are: <>.", + "datatype": "int", + "range": [ + { + "min": 0, + "max": 255 + }, + { + "min": -1, + "max": -1 + } + ] + }, "RemoteMeasurementRequest()": { "type": "command", "async": true, @@ -64547,6 +66687,26 @@ } } }, + "ChangePowerMode()": { + "type": "command", + "async": true, + "protocols": [ + "usp" + ], + "input": { + "PowerState": { + "type": "string", + "read": true, + "write": true, + "mandatory": true, + "protocols": [ + "usp" + ], + "description": "Targeted power state. <>", + "datatype": "string" + } + } + }, "Device.WiFi.Radio.{i}.Stats.": { "type": "object", "protocols": [ @@ -64893,6 +67053,522 @@ "usp" ] } + }, + "Device.WiFi.Radio.{i}.Capabilities.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object represents the capabilities of the radio which may be different from the current operational configuration.", + "access": false, + "array": false, + "Device.WiFi.Radio.{i}.Capabilities.WiFi7APRole.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the Wi-Fi 7 capabilities for the AP role. <> Source: Wi-Fi 7 Agent Capabilities TLV.", + "access": false, + "array": false, + "EMLMRSupport": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is supported.", + "datatype": "boolean" + }, + "EMLSRSupport": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is supported.", + "datatype": "boolean" + }, + "STRSupport": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates if Simultaneous Transmit and Receive (STR) operation is supported.", + "datatype": "boolean" + }, + "NSTRSupport": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is supported.", + "datatype": "boolean" + }, + "TIDLinkMapNegotiation": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is supported.", + "datatype": "boolean" + }, + "EMLMRFreqSeparationNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "EMLSRFreqSeparationNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "STRFreqSeparationNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "NSTRFreqSeparationNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "Device.WiFi.Radio.{i}.Capabilities.WiFi7APRole.EMLMRFreqSeparation.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the required frequency separation from the specified radio <> for MLO Enhanced Multi-Link Multi-Radio (EMLMR) operation. <> Source: Wi-Fi 7 Agent Capabilities TLV.", + "uniqueKeys": [ + "RUID" + ], + "access": false, + "array": true, + "RUID": { + "type": "base64", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies.", + "datatype": "base64" + }, + "FreqSeparation": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (<> - 1) x <>.", + "datatype": "unsignedInt", + "unit": "80 MHz" + } + }, + "Device.WiFi.Radio.{i}.Capabilities.WiFi7APRole.EMLSRFreqSeparation.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the required frequency separation from the specified radio <> for MLO Enhanced Multi-Link Single-Radio (EMLSR) operation. <> Source: Wi-Fi 7 Agent Capabilities TLV.", + "uniqueKeys": [ + "RUID" + ], + "access": false, + "array": true, + "RUID": { + "type": "base64", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies.", + "datatype": "base64" + }, + "FreqSeparation": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (<> - 1) x <>.", + "datatype": "unsignedInt", + "unit": "80 MHz" + } + }, + "Device.WiFi.Radio.{i}.Capabilities.WiFi7APRole.STRFreqSeparation.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the required frequency separation from the specified radio <> for MLO Simultaneous Transmit and Receive (STR) operation. <> Source: Wi-Fi 7 Agent Capabilities TLV.", + "uniqueKeys": [ + "RUID" + ], + "access": false, + "array": true, + "RUID": { + "type": "base64", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies.", + "datatype": "base64" + }, + "FreqSeparation": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (<> - 1) x <>.", + "datatype": "unsignedInt", + "unit": "80 MHz" + } + }, + "Device.WiFi.Radio.{i}.Capabilities.WiFi7APRole.NSTRFreqSeparation.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the required frequency separation from the specified radio <> for MLO Non-Simultaneous Transmit and Receive (NSTR) operation. <> Source: Wi-Fi 7 Agent Capabilities TLV.", + "uniqueKeys": [ + "RUID" + ], + "access": false, + "array": true, + "RUID": { + "type": "base64", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies.", + "datatype": "base64" + }, + "FreqSeparation": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (<> - 1) x <>.", + "datatype": "unsignedInt", + "unit": "80 MHz" + } + } + }, + "Device.WiFi.Radio.{i}.Capabilities.WiFi7STARole.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the Wi-Fi 7 capabilities for the backhaul Station (bSTA) role. <> Source: Wi-Fi 7 Agent Capabilities TLV.", + "access": false, + "array": false, + "EMLMRSupport": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates if the Enhanced Multi-Link Multi-Radio (EMLMR) operation is supported.", + "datatype": "boolean" + }, + "EMLSRSupport": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates if Enhanced Multi-Link Single-Radio (EMLSR) operation is supported.", + "datatype": "boolean" + }, + "STRSupport": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates if Simultaneous Transmit and Receive (STR) operation is supported.", + "datatype": "boolean" + }, + "NSTRSupport": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates if Non-Simultaneous Transmit and Receive (NSTR) operation is supported.", + "datatype": "boolean" + }, + "TIDLinkMapNegotiation": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates if Traffic Identifier (TID) to Link Mapping Negotiation is supported.", + "datatype": "boolean" + }, + "EMLMRFreqSeparationNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "EMLSRFreqSeparationNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "STRFreqSeparationNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "NSTRFreqSeparationNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "Device.WiFi.Radio.{i}.Capabilities.WiFi7STARole.EMLMRFreqSeparation.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the required frequency separation from the specified radio <> for MLO Enhanced Multi-Link Multi-Radio (EMLMR) operation. <> Source: Wi-Fi 7 Agent Capabilities TLV.", + "uniqueKeys": [ + "RUID" + ], + "access": false, + "array": true, + "RUID": { + "type": "base64", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies.", + "datatype": "base64" + }, + "FreqSeparation": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (<> - 1) x <>.", + "datatype": "unsignedInt", + "unit": "80 MHz" + } + }, + "Device.WiFi.Radio.{i}.Capabilities.WiFi7STARole.EMLSRFreqSeparation.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the required frequency separation from the specified radio <> for MLO Enhanced Multi-Link Single-Radio (EMLSR) operation. <> Source: Wi-Fi 7 Agent Capabilities TLV.", + "uniqueKeys": [ + "RUID" + ], + "access": false, + "array": true, + "RUID": { + "type": "base64", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies.", + "datatype": "base64" + }, + "FreqSeparation": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (<> - 1) x <>.", + "datatype": "unsignedInt", + "unit": "80 MHz" + } + }, + "Device.WiFi.Radio.{i}.Capabilities.WiFi7STARole.STRFreqSeparation.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the required frequency separation from the specified radio <> for MLO Simultaneous Transmit and Receive (STR) operation. <> Source: Wi-Fi 7 Agent Capabilities TLV.", + "uniqueKeys": [ + "RUID" + ], + "access": false, + "array": true, + "RUID": { + "type": "base64", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies.", + "datatype": "base64" + }, + "FreqSeparation": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (<> - 1) x <>.", + "datatype": "unsignedInt", + "unit": "80 MHz" + } + }, + "Device.WiFi.Radio.{i}.Capabilities.WiFi7STARole.NSTRFreqSeparation.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the required frequency separation from the specified radio <> for MLO Non-Simultaneous Transmit and Receive (NSTR) operation. <> Source: Wi-Fi 7 Agent Capabilities TLV.", + "uniqueKeys": [ + "RUID" + ], + "access": false, + "array": true, + "RUID": { + "type": "base64", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Radio unique identifier (RUID) of another radio to which the specified frequency separation gap applies.", + "datatype": "base64" + }, + "FreqSeparation": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Frequency separation to the specified radio for the particular MLO operation mode. A value of 0 indicates that no frequency separation information is provided. Set to a nonzero value to indicate the required frequency gap is (<> - 1) x <>.", + "datatype": "unsignedInt", + "unit": "80 MHz" + } + } + } } }, "Device.WiFi.CCAMeasurementDiagnostic.": { @@ -65229,7 +67905,7 @@ "protocols": [ "cwmp" ], - "description": "The type of encryption the neighboring WiFi SSID advertises. The <> value indicates either WEP-64 or WEP-128. The <> value is the same as WPA-Personal. The <> value is the same as WPA2-Personal. The <> value is the same as WPA-WPA2-Personal. The <> value is the same as WPA3-Personal. The <> value is the same as WPA3-Personal-Transition.", + "description": "The type of encryption the neighboring WiFi SSID advertises. The <> value indicates either WEP-64 or WEP-128. The <> value is the same as WPA-Personal. The <> value is the same as WPA2-Personal. The <> value is the same as WPA-WPA2-Personal. The <> value is the same as WPA3-Personal. The <> value is the same as WPA3-Personal-Transition. The <> value is the same as WPA3-Personal-Compatibility.", "datatype": "string", "enumerations": [ "None", @@ -65243,7 +67919,8 @@ "WPA3-SAE", "WPA2-PSK-WPA3-SAE", "WPA3-Enterprise", - "OWE" + "OWE", + "WPA2-PSK-WPA3-SAE-RSNO" ] }, "EncryptionMode": { @@ -65253,7 +67930,7 @@ "protocols": [ "cwmp" ], - "description": "The type of encryption the neighboring WiFi SSID advertises. When <> is one of <>, <>, or <>, <> is not valid, and should not be in the list.", + "description": "The type of encryption the neighboring WiFi SSID advertises. When <> is one of <>, <>, or <>, or <>, <> is not valid, and should not be in the list.", "list": { "datatype": "string", "enumerations": [ @@ -65548,6 +68225,18 @@ "([0-9A-Fa-f][0-9A-Fa-f]:){5}([0-9A-Fa-f][0-9A-Fa-f])" ] }, + "MTU": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Maximum Transmission Unit for this interface (expressed in <>).", + "datatype": "unsignedInt", + "unit": "bytes" + }, "SSID": { "type": "string", "read": true, @@ -66228,7 +68917,7 @@ "cwmp", "usp" ], - "description": "<> Indicates which security modes this <> instance is capable of supporting. The <> value is the same as WPA3-SAE. The <> value is the same as WPA2-PSK-WPA3-SAE.", + "description": "<> Indicates which security modes this <> instance is capable of supporting. The <> value is the same as WPA3-SAE. The <> value is the same as WPA2-PSK-WPA3-SAE. The <> value is the same as WPA2-PSK-WPA3-SAE-RSNO.", "list": { "datatype": "string", "enumerations": [ @@ -66244,7 +68933,8 @@ "WPA2-Enterprise", "WPA3-Enterprise", "WPA-WPA2-Enterprise", - "OWE" + "OWE", + "WPA3-Personal-Compatibility" ] } }, @@ -66449,6 +69139,23 @@ "Required" ] }, + "SAEGroupDependantHashEnable": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enable SAE with group dependant hash usage in WPA3 security modes. This flag enables or disables the use of SAE with group dependant hash instead of simple SAE applicable when <> is set to <>, <>, or <>. If <> is set to <>, then only AKM8 shall be used. If it is set to <>, then both AKM8 and AKM24 shall be used. Finally, if <> is set to <>, then only AKM24 shall be used. <> is invalid when <> is set to <>.", + "default": "Transition", + "datatype": "string", + "enumerations": [ + "Disabled", + "Transition", + "Enabled" + ] + }, "SPPAMSDU": { "type": "string", "read": true, @@ -67312,7 +70019,7 @@ "cwmp", "usp" ], - "description": "An indicator of radio noise on the uplink from the associated device to the access point, measured in <>, as an average of the last 100 packets received from the device (see ANPI definition in <>) If the instance of this <> is the same as <.Radio..BSS..STA..>>, then this parameter is the same as <.Radio..BSS..STA..MultiAPSTA.Noise|deprecated>>.", + "description": "An indicator of radio noise on the uplink from the associated device to the access point, measured in <>, as an average of the last 100 packets received from the device (see ANPI definition in <>) If the instance of this <> is the same as <.Radio..BSS..STA..>>, then this parameter is the same as <.Radio..BSS..STA..MultiAPSTA.Noise|obsoleted>>.", "datatype": "int", "range": [ { @@ -68113,7 +70820,8 @@ "WPA2-Enterprise", "WPA3-Enterprise", "WPA-WPA2-Enterprise", - "OWE" + "OWE", + "WPA3-Personal-Compatibility" ] } } @@ -68319,6 +71027,23 @@ "Optional", "Required" ] + }, + "SAEGroupDependantHashEnable": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enable SAE with group dependant hash usage in WPA3 security modes. This flag enables or disables the use of SAE with group dependant hash instead of simple SAE applicable when <> is set to <>, <>, or <>. If <> is set to <>, then only AKM8 shall be used. If it is set to <>, then both AKM8 and AKM24 shall be used. Finally, if <> is set to <>, then only AKM24 shall be used. <> is invalid when <> is set to <>.", + "default": "Transition", + "datatype": "string", + "enumerations": [ + "Disabled", + "Transition", + "Enabled" + ] } } }, @@ -68987,6 +71712,35 @@ "description": "Indicates whether the interface points towards the Internet (<>) or towards End Devices (<>). For example: * For an Internet Gateway Device, <> will be <> for all WAN interfaces and <> for all LAN interfaces. * For a standalone WiFi Access Point that is connected via Ethernet to an Internet Gateway Device, <> will be <> for the Ethernet interface and <> for the WiFi Radio interface. * For an End Device, <> will be <> for all interfaces.", "datatype": "boolean" }, + "PowerCapability": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Describes the possible power states of the <> regardless of its current administrative state.", + "list": { + "datatype": "string", + "enumerations": [ + "On", + "Off", + "LowPower" + ] + } + }, + "PowerStatus": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Reports the current power status of the <>. <> <>", + "datatype": "string" + }, "TransmitPowerSupported": { "type": "string", "read": true, @@ -69063,6 +71817,26 @@ ], "output": {} }, + "ChangePowerMode()": { + "type": "command", + "async": true, + "protocols": [ + "usp" + ], + "input": { + "PowerState": { + "type": "string", + "read": true, + "write": true, + "mandatory": true, + "protocols": [ + "usp" + ], + "description": "Targeted power state. <>", + "datatype": "string" + } + } + }, "Device.Thread.Radio.{i}.Stats.": { "type": "object", "protocols": [ @@ -77875,7 +80649,7 @@ "protocols": [ "usp" ], - "description": "The Fully Qualified Domain Name (FQDN) or IP address of the Test Endpoint to perform the UDP Capacity tests with. <> with multi-flow and server capability. Refer to <> for details>> <>", + "description": "The Fully Qualified Domain Name (FQDN) or IP address of the Test Endpoint to perform the UDP Capacity tests with. <> with multi-flow and server capability. Refer to <> for details>> <> <>", "datatype": "string", "range": [ { @@ -77912,7 +80686,7 @@ "protocols": [ "usp" ], - "description": "Port on the Test Endpoint host. <> with multi-flow and server capability. Refer to <> for details>> <>", + "description": "Port on the Test Endpoint host. <> with multi-flow and server capability. Refer to <> for details>> <> <>", "datatype": "unsignedInt", "range": [ { @@ -78002,7 +80776,7 @@ "protocols": [ "usp" ], - "description": "The number of connections to be used in the test. The default value SHOULD be 1. <> MUST NOT be set to a value greater than <>IPLayerMaxConnections>>. <> with multi-flow and server capability and related parameters. Refer to <> for details>> <>", + "description": "The number of connections to be used in the test. The default value SHOULD be 1. <> MUST NOT be set to a value greater than <>IPLayerMaxConnections>>. <> with multi-flow and server capability and related parameters. Refer to <> for details>> <> <>", "datatype": "unsignedInt", "range": [ { @@ -78972,6 +81746,104 @@ } } }, + "IPLayerCapacityIncrementalResult!": { + "type": "event", + "protocols": [ + "usp" + ], + "output": { + "IPLayerCapacity": { + "type": "decimal", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Results of measurements using the maximum IP-Layer Capacity metric calculation for a single interval from <> Equation 1, for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. Result is expressed in <> with 2 digits beyond the decimal. 10^6^ bits/second = 1 <>.", + "datatype": "decimal" + }, + "TimeOfSubInterval": { + "type": "dateTime", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Time in UTC of end of sub-interval when <> was measured. Value MUST be specified to <>TimestampResolution>> precision. For example: 2008-04-09T15:01:05.123456Z", + "datatype": "dateTime" + }, + "LossRatio": { + "type": "decimal", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Ratio of lost packets to total packets, for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. This value is expressed as a decimal to 9 decimal digits.", + "datatype": "decimal" + }, + "RTTRange": { + "type": "decimal", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "The range of Round Trip Time (RTT), for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. See <> for description of how value is calculated. This value is expressed in <>. This value is expressed as a decimal to 9 decimal digits.", + "datatype": "decimal" + }, + "PDVRange": { + "type": "decimal", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "The range of Packet Delay Variation (PDV), for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. See <> for description of how value is calculated. This value is expressed in <>. This value is expressed as a decimal to 9 decimal digits.", + "datatype": "decimal" + }, + "MinOnewayDelay": { + "type": "decimal", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "The minimum one-way delay, for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. The minimum one-way delay is calculated at the conclusion of the test and SHALL be calculated using the conditional distribution of all packets with a finite one-way delay value (undefined delays are excluded). This value is expressed in <>. This value is expressed as a decimal to 9 decimal digits.", + "datatype": "decimal" + }, + "ReorderedRatio": { + "type": "decimal", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Ratio of reordered packets to total packets, for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. This value is expressed as a decimal to 9 decimal digits.", + "datatype": "decimal" + }, + "ReplicatedRatio": { + "type": "decimal", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Ratio of replicated packets to total packets, for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. This value is expressed as a decimal to 9 decimal digits.", + "datatype": "decimal" + }, + "InterfaceEthMbps": { + "type": "decimal", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "The number of bits observed on the <>Interface>> during an IP-Layer Capacity test for time interval of duration <>TestSubInterval>> ending at <>, divided by the duration of <>TestSubInterval>>. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6^ bits/second = 1 <>. This is primarily a diagnostic measurement. Measurement direction follows the <>Role>>.", + "datatype": "decimal" + } + } + }, "ServerSelectionDiagnostics()": { "type": "command", "async": true, @@ -81366,7 +84238,7 @@ "protocols": [ "cwmp" ], - "description": "The Fully Qualified Domain Name (FQDN) or IP address of the Test Endpoint to perform the UDP Capacity tests with. <> with multi-flow and server capability. Refer to <> for details>> <>", + "description": "The Fully Qualified Domain Name (FQDN) or IP address of the Test Endpoint to perform the UDP Capacity tests with. <> with multi-flow and server capability. Refer to <> for details>> <> <>", "datatype": "string", "range": [ { @@ -81402,7 +84274,7 @@ "protocols": [ "cwmp" ], - "description": "Port on the Test Endpoint host. <> with multi-flow and server capability. Refer to <> for details>> <>", + "description": "Port on the Test Endpoint host. <> with multi-flow and server capability. Refer to <> for details>> <> <>", "datatype": "unsignedInt", "range": [ { @@ -81492,7 +84364,7 @@ "protocols": [ "cwmp" ], - "description": "The number of connections to be used in the test. The default value SHOULD be 1. <> MUST NOT be set to a value greater than <>IPLayerMaxConnections>>. <> with multi-flow and server capability and related parameters. Refer to <> for details>> <>", + "description": "The number of connections to be used in the test. The default value SHOULD be 1. <> MUST NOT be set to a value greater than <>IPLayerMaxConnections>>. <> with multi-flow and server capability and related parameters. Refer to <> for details>> <> <>", "datatype": "unsignedInt", "range": [ { @@ -82630,7 +85502,7 @@ "protocols": [ "cwmp" ], - "description": "Results of measurements using the maximum IP-Layer Capacity metric calculation for a single interval from <> Equation 1, for time interval of duration <> ending at <> across all connections for this test. Result is expressed in <> with 2 digits beyond the decimal. 10^6^ bits/second = 1 <>.", + "description": "Results of measurements using the maximum IP-Layer Capacity metric calculation for a single interval from <> Equation 1, for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. Result is expressed in <> with 2 digits beyond the decimal. 10^6^ bits/second = 1 <>.", "datatype": "decimal" }, "TimeOfSubInterval": { @@ -82640,7 +85512,7 @@ "protocols": [ "cwmp" ], - "description": "Time in UTC of end of sub-interval when <> was measured. Value MUST be specified to <> precision. For example: 2008-04-09T15:01:05.123456Z", + "description": "Time in UTC of end of sub-interval when <> was measured. Value MUST be specified to <>TimestampResolution>> precision. For example: 2008-04-09T15:01:05.123456Z", "datatype": "dateTime" }, "LossRatio": { @@ -82650,7 +85522,7 @@ "protocols": [ "cwmp" ], - "description": "Ratio of lost packets to total packets, for time interval of duration <> ending at <> across all connections for this test. This value is expressed as a decimal to 9 decimal digits.", + "description": "Ratio of lost packets to total packets, for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. This value is expressed as a decimal to 9 decimal digits.", "datatype": "decimal" }, "RTTRange": { @@ -82660,7 +85532,7 @@ "protocols": [ "cwmp" ], - "description": "The range of Round Trip Time (RTT), for time interval of duration <> ending at <> across all connections for this test. See <> for description of how value is calculated. This value is expressed in <>. This value is expressed as a decimal to 9 decimal digits.", + "description": "The range of Round Trip Time (RTT), for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. See <> for description of how value is calculated. This value is expressed in <>. This value is expressed as a decimal to 9 decimal digits.", "datatype": "decimal" }, "PDVRange": { @@ -82670,7 +85542,7 @@ "protocols": [ "cwmp" ], - "description": "The range of Packet Delay Variation (PDV), for time interval of duration <> ending at <> across all connections for this test. See <> for description of how value is calculated. This value is expressed in <>. This value is expressed as a decimal to 9 decimal digits.", + "description": "The range of Packet Delay Variation (PDV), for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. See <> for description of how value is calculated. This value is expressed in <>. This value is expressed as a decimal to 9 decimal digits.", "datatype": "decimal" }, "MinOnewayDelay": { @@ -82680,7 +85552,7 @@ "protocols": [ "cwmp" ], - "description": "The minimum one-way delay, for time interval of duration <> ending at <> across all connections for this test. The minimum one-way delay is calculated at the conclusion of the test and SHALL be calculated using the conditional distribution of all packets with a finite one-way delay value (undefined delays are excluded). This value is expressed in <>. This value is expressed as a decimal to 9 decimal digits.", + "description": "The minimum one-way delay, for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. The minimum one-way delay is calculated at the conclusion of the test and SHALL be calculated using the conditional distribution of all packets with a finite one-way delay value (undefined delays are excluded). This value is expressed in <>. This value is expressed as a decimal to 9 decimal digits.", "datatype": "decimal" }, "ReorderedRatio": { @@ -82690,7 +85562,7 @@ "protocols": [ "cwmp" ], - "description": "Ratio of reordered packets to total packets, for time interval of duration <> ending at <> across all connections for this test. This value is expressed as a decimal to 9 decimal digits.", + "description": "Ratio of reordered packets to total packets, for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. This value is expressed as a decimal to 9 decimal digits.", "datatype": "decimal" }, "ReplicatedRatio": { @@ -82700,7 +85572,7 @@ "protocols": [ "cwmp" ], - "description": "Ratio of replicated packets to total packets, for time interval of duration <> ending at <> across all connections for this test. This value is expressed as a decimal to 9 decimal digits.", + "description": "Ratio of replicated packets to total packets, for time interval of duration <>TestSubInterval>> ending at <> across all connections for this test. This value is expressed as a decimal to 9 decimal digits.", "datatype": "decimal" }, "InterfaceEthMbps": { @@ -82710,7 +85582,7 @@ "protocols": [ "cwmp" ], - "description": "The number of bits observed on the <> during an IP-Layer Capacity test for time interval of duration <> ending at <>, divided by the duration of <>. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6^ bits/second = 1 <>. This is primarily a diagnostic measurement. Measurement direction follows the <>.", + "description": "The number of bits observed on the <>Interface>> during an IP-Layer Capacity test for time interval of duration <>TestSubInterval>> ending at <>, divided by the duration of <>TestSubInterval>>. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6^ bits/second = 1 <>. This is primarily a diagnostic measurement. Measurement direction follows the <>Role>>.", "datatype": "decimal" } } @@ -83511,7 +86383,7 @@ "cwmp", "usp" ], - "description": "Supported integrity algorithms <>. Enumeration of: NONE, HMAC-MD5-96, HMAC-SHA1-96, DES-MAC, KPDK-MD5, AES-XCBC-96, HMAC-MD5-128, HMAC-SHA1-160, AES-CMAC-96, AES-128-GMAC, AES-192-GMAC, AES-256-GMAC, HMAC-SHA2-256-128, HMAC-SHA2-256-192, HMAC-SHA2-256-256. Note that these are the names from the above reference, transformed as follows: * Leading AUTH_ (when present) discarded because they all authentication (integrity) algorithms so its not needed. * Underscores changed to hyphens to preserve names used in existing data models. As additional algorithms are added to the above reference, this data model will be extended according to the above conventions.", + "description": "Supported integrity algorithms <>. Enumeration of: NONE, HMAC-MD5-96, HMAC-SHA1-96, DES-MAC, KPDK-MD5, AES-XCBC-96, HMAC-MD5-128, HMAC-SHA1-160, AES-CMAC-96, AES-128-GMAC, AES-192-GMAC, AES-256-GMAC, HMAC-SHA2-256-128, HMAC-SHA2-256-192, HMAC-SHA2-256-256, HMAC-SHA2-384-192, HMAC-SHA2-512-256. Note that these are the names from the above reference, transformed as follows: * Leading AUTH_ (when present) discarded because they all authentication (integrity) algorithms so its not needed. * Underscores changed to hyphens to preserve names used in existing data models. As additional algorithms are added to the above reference, this data model will be extended according to the above conventions.", "list": { "datatype": "string", "enumerations": [ @@ -83529,7 +86401,9 @@ "AES-256-GMAC", "HMAC-SHA2-256-128", "HMAC-SHA2-256-192", - "HMAC-SHA2-256-256" + "HMAC-SHA2-256-256", + "HMAC-SHA2-384-192", + "HMAC-SHA2-512-256" ] } }, @@ -84937,7 +87811,7 @@ "cwmp", "usp" ], - "description": "The total number of inbound <> to this IKEv2 SA discarded due to decryption errors. Note that this refers to IKEv2 protocol <>, and not to > carried by other SAs.", + "description": "The total number of inbound <> to this IKEv2 SA discarded due to decryption errors. Note that this refers to IKEv2 protocol <>, and not to <> carried by other SAs.", "datatype": "StatsCounter32" }, "IntegrityErrors": { @@ -88001,7 +90875,7 @@ "cwmp", "usp" ], - "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. <> already has an Alias parameter.>>", + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. <> already has an Alias parameter.>> <>", "datatype": "_AliasCWMP" }, "Name": { @@ -88531,6 +91405,17 @@ "description": "<>", "datatype": "unsignedInt" }, + "PolicyNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, "Device.Routing.Router.{i}.": { "type": "object", "protocols": [ @@ -88539,10 +91424,45 @@ ], "description": "This object allows the handling of the routing and forwarding configuration of the device.", "uniqueKeys": [ - "Alias" + "ID", + "Alias", + "Name" ], "access": true, "array": true, + "ID": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The identifier of the routing table, as defined by the system upon creation.", + "datatype": "unsignedInt", + "range": [ + { + "min": 0, + "max": 255 + } + ] + }, + "Name": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The name of the routing table.", + "datatype": "string", + "range": [ + { + "max": 256 + } + ] + }, "Enable": { "type": "boolean", "read": true, @@ -88616,6 +91536,8 @@ "Alias", "DestIPAddress", "DestSubnetMask", + "SourceIPAddress", + "SourceSubnetMask", "ForwardingPolicy", "GatewayIPAddress", "Interface", @@ -88735,6 +91657,46 @@ "((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])" ] }, + "SourceIPAddress": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Source IPv4 address is a filter to the packets for which the route applies. <> indicates no source address is specified.", + "datatype": "IPv4Address", + "range": [ + { + "max": 15 + } + ], + "pattern": [ + "", + "((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])" + ] + }, + "SourceSubnetMask": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Source subnet mask. <> indicates no source subnet mask is specified. If a source subnet mask is specified, the <> is ANDed with the source address before comparing with the <>. Otherwise, the full source address is used as is.", + "datatype": "IPv4Address", + "range": [ + { + "max": 15 + } + ], + "pattern": [ + "", + "((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])" + ] + }, "ForwardingPolicy": { "type": "int", "read": true, @@ -88824,6 +91786,27 @@ "min": -1 } ] + }, + "MTU": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Maximum Transmission Unit for this route (expressed in <>). Valid values are: <>.", + "datatype": "unsignedInt", + "range": [ + { + "min": -1, + "max": -1 + }, + { + "min": 576 + } + ], + "unit": "bytes" } }, "Device.Routing.Router.{i}.IPv6Forwarding.{i}.": { @@ -88914,6 +91897,38 @@ "description": "Destination IPv6 prefix. <> indicates that it matches all destination prefixes (i.e. equivalent to ::/0). All bits to the right of the prefix MUST be zero, e.g. 2001:edff:fe6a:f76::/64. Routes with a 128-bit prefix length (/128) are host routes for a specific IPv6 destination, e.g. 2001:db8:28:2:713e:a426:d167:37ab/128.", "datatype": "IPv6Prefix" }, + "SourceIPPrefix": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Source IPv6 prefix. <> indicates that it matches all source prefixes. All bits to the right of the prefix MUST be zero, e.g. 2001:edff:fe6a:f76::/64. Routes with a 128-bit prefix length (/128) are host routes for a specific IPv6 source, e.g. 2001:db8:28:2:713e:a426:d167:37ab/128.", + "datatype": "IPv6Prefix" + }, + "MTU": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Maximum Transmission Unit for this route (expressed in <>). Valid values are: <>.", + "datatype": "unsignedInt", + "range": [ + { + "min": -1, + "max": -1 + }, + { + "min": 1280 + } + ], + "unit": "bytes" + }, "ForwardingPolicy": { "type": "int", "read": true, @@ -89009,6 +92024,283 @@ } } }, + "Device.Routing.Policy.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Routing policy table.", + "uniqueKeys": [ + "Alias" + ], + "access": true, + "array": true, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enables or disables this <> table entry.", + "default": "false", + "datatype": "boolean" + }, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "Status": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The status of this <> table entry.", + "default": "Disabled", + "datatype": "string", + "enumerations": [ + "Disabled", + "Enabled", + "Error_Misconfigured" + ] + }, + "RouterRef": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> Specify the routing table to use for traffic matching criterion. Example: Device.Routing.Router.1.", + "datatype": "string", + "range": [ + { + "max": 256 + } + ] + }, + "Priority": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The priority of this <> table entry, determining the order in which rules are processed. A lower numerical value indicates higher precedence, meaning rules are evaluated in increasing order of priority. A value of 0 represents the highest precedence.", + "datatype": "unsignedInt" + }, + "IPVersion": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the IP protocol version, following the definitions in <>. Valid values are: <>.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": 4, + "max": 4 + }, + { + "min": 6, + "max": 6 + }, + { + "min": -1, + "max": -1 + } + ] + }, + "Protocol": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> criterion. Protocol number. A value of -1 indicates this criterion is not used for matching.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": -1, + "max": 255 + } + ] + }, + "SourceInterface": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> criterion. <> Specify the ingress interface the packet is coming from. Example: Device.IP.Interface.1.", + "datatype": "string", + "range": [ + { + "max": 256 + } + ] + }, + "DestInterface": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> criterion. <> Specify the egress interface the packet is sent to. Example: Device.IP.Interface.1.", + "datatype": "string", + "range": [ + { + "max": 256 + } + ] + }, + "SourceIPPrefix": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> criterion. Source IP address prefix, represented as an IP routing prefix using CIDR notation (defined in <>). The IP version of <> determines whether <> is interpreted as an IPv4 or IPv6 prefix. An <> indicates this criterion is not used for matching.", + "datatype": "IPPrefix", + "range": [ + { + "max": 49 + } + ] + }, + "DestIPPrefix": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> criterion. Destination IP address prefix, represented as an IP routing prefix using CIDR notation (defined in <>). The IP version of <> determines whether <> is interpreted as an IPv4 or IPv6 prefix. An <> indicates this criterion is not used for matching.", + "datatype": "IPPrefix", + "range": [ + { + "max": 49 + } + ] + }, + "SourcePort": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> criterion. Source port number. A value of -1 indicates this criterion is not used for matching.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": -1, + "max": 65535 + } + ] + }, + "SourcePortRangeMax": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> criterion. If specified, indicates the <> criterion is to include the port range from <> through <> (inclusive). If specified, <> MUST be greater than or equal to <>. A value of -1 indicates that no port range is specified.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": -1, + "max": 65535 + } + ] + }, + "DestPort": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> criterion. Destination port number. A value of -1 indicates this criterion is not used for matching.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": -1, + "max": 65535 + } + ] + }, + "DestPortRangeMax": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> criterion. If specified, indicates the <> criterion is to include the port range from <> through <> (inclusive). If specified, <> MUST be greater than or equal to <>. A value of -1 indicates that no port range is specified.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": -1, + "max": 65535 + } + ] + }, + "ForwardingPolicy": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Identifier of a set of classes or flows that have the corresponding <> value as defined in the <> object. A value of -1 indicates no <> is specified. If specified, this <> entry is to apply only to traffic associated with the specified classes and flows.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": -1 + } + ] + } + }, "Device.Routing.RIP.": { "type": "object", "protocols": [ @@ -94724,6 +98016,22 @@ "description": "<>", "datatype": "unsignedInt" }, + "CleanupHostsThreshold": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the threshold related to the number of Host entries that are retained in the <.>> table. If this threshold is exceeded, the device removes the inactive Host entry with the oldest <.ActiveLastChange>> timestamp that is, the Host entry for which <.Active>> is <> and the host entry for which has been inactive the longest. A value of -1 disables this mechanism.", + "datatype": "int", + "range": [ + { + "min": -1 + } + ] + }, "AccessControlNumberOfEntries": { "type": "unsignedInt", "read": true, @@ -94735,6 +98043,38 @@ "description": "<>", "datatype": "unsignedInt" }, + "RemoveInactiveHosts()": { + "type": "command", + "async": false, + "protocols": [ + "usp" + ], + "input": { + "MinimumInactiveTime": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Specifies the minimum duration, in <>, for which a Host must be inactive before being removed. When <> is not specified, all inactive Host entries are removed.", + "datatype": "unsignedInt", + "unit": "seconds" + } + }, + "output": { + "NumberOfRemovedHosts": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Indicates the total number of hosts successfully removed.", + "datatype": "unsignedInt" + } + } + }, "Device.Hosts.Host.{i}.": { "type": "object", "protocols": [ @@ -94987,7 +98327,7 @@ "cwmp", "usp" ], - "description": "Whether or not the host is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive hosts is OPTIONAL. If the CPE includes inactive hosts in this table, <> MUST be set to <> for each inactive host. The length of time an inactive host remains listed in this table is a local matter to the CPE. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are <> statistics collected for the entry in the past seven days.", + "description": "Whether or not the host is currently present on the LAN. The method of presence detection is a local matter to the CPE. The ability to list inactive hosts is OPTIONAL. If the CPE includes inactive hosts in this table, <> MUST be set to <> for each inactive host. The length of time an inactive host remains listed in this table is a local matter to the CPE. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are <> statistics collected for the entry in the past seven days, unless requested by a Controller or if the <> parameter value is reached.", "datatype": "boolean" }, "ActiveLastChange": { @@ -94998,7 +98338,7 @@ "cwmp", "usp" ], - "description": "The datetime when <> last changed from <> to <> or from <> to <>. The initial detection of a host SHOULD be treated as a transition from <> to <>, 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. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are <> statistics collected for the entry in the past seven days.", + "description": "The datetime when <> last changed from <> to <> or from <> to <>. The initial detection of a host SHOULD be treated as a transition from <> to <>, 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. Entries in Device.Hosts.Host SHOULD NOT be removed when they become inactive if there are <> statistics collected for the entry in the past seven days, unless requested by a Controller or if the <> parameter value is reached.", "datatype": "dateTime" }, "IPv4AddressNumberOfEntries": { @@ -95293,7 +98633,7 @@ "cwmp", "usp" ], - "description": "Each reference provides a schedule where time based access can be enabled. When <> is <> the <> is not scheduled, and the <> defines the operational state.", + "description": "Each reference provides a time schedule that controls when the associated feature or resource is active or inactive. When <> is <> the <> is not scheduled, and the <> defines the operational state.", "default": "[]", "list": { "datatype": "string" @@ -95308,7 +98648,7 @@ "cwmp", "usp" ], - "description": "<>>> <>", + "description": "<>>> <> <>", "datatype": "unsignedInt" }, "Device.Hosts.AccessControl.{i}.Schedule.{i}.": { @@ -95318,7 +98658,7 @@ "cwmp", "usp" ], - "description": "<>>> Each instance of this object provides a schedule where access is enabled.", + "description": "<>>> <> Each instance of this object provides a schedule where access is enabled.", "uniqueKeys": [ "Alias" ], @@ -96467,7 +99807,7 @@ "cwmp", "usp" ], - "description": "<> object instance from which DNS-SD services are advertised>> If this parameter is not supported by an implementation then DNS-SD services are advertised on all LAN interfaces. <.Interface>>>> <>", + "description": "<> object instance from which DNS-SD services are advertised>> If this parameter is not supported by an implementation then DNS-SD services are advertised on all LAN interfaces. <.Interface>>>> <> <>", "list": { "datatype": "string" } @@ -96931,6 +100271,58 @@ } } } + }, + "Device.DNS.RebindProtection.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "The DNS Rebind Protection object contains parameters to enable or disable protection against DNS rebind attacks. It prevents DNS-based malicious software that tries to bypass the browser\u2019s policies, by filtering or refusing DNS answers that point to private or local IP addresses, it stops external sites from reaching LAN devices.", + "access": false, + "array": false, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enables or Disables protection against DNS rebind attacks", + "datatype": "boolean" + }, + "IPExceptions": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Each item of the list represents an IP address or a CIDR notation that should not be protected against rebind attacks.", + "list": { + "datatype": "IPAddress", + "range": [ + { + "max": 45 + } + ] + } + }, + "DomainExceptions": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Each item of the list represents a domain name and its subdomain names that should not be protected against rebind attacks.", + "list": { + "datatype": "string" + } + } } }, "Device.NAT.": { @@ -97370,7 +100762,7 @@ "cwmp", "usp" ], - "description": "Each reference provides a schedule where time based access can be enabled. When <> is <> the <> is not scheduled, and the <> defines the operational state.", + "description": "Each reference provides a time schedule that controls when the associated feature or resource is active or inactive. When <> is <> the <> is not scheduled, and the <> defines the operational state.", "default": "[]", "list": { "datatype": "string" @@ -97589,7 +100981,7 @@ "cwmp", "usp" ], - "description": "Each reference provides a schedule where time based access can be enabled. When <> is <> the <> is not scheduled, and the <> defines the operational state.", + "description": "Each reference provides a time schedule that controls when the associated feature or resource is active or inactive. When <> is <> the <> is not scheduled, and the <> defines the operational state.", "default": "[]", "list": { "datatype": "string" @@ -99266,6 +102658,13 @@ "usp" ] }, + "Release()": { + "type": "command", + "async": false, + "protocols": [ + "usp" + ] + }, "Device.DHCPv4.Client.{i}.SentOption.{i}.": { "type": "object", "protocols": [ @@ -101301,6 +104700,13 @@ "usp" ] }, + "Release()": { + "type": "command", + "async": false, + "protocols": [ + "usp" + ] + }, "Device.DHCPv6.Client.{i}.Server.{i}.": { "type": "object", "protocols": [ @@ -104563,6 +107969,66 @@ "description": "Numeric value indicating the supported revision for UPnP-DM Software Management. A value of 0 indicates no support.", "datatype": "unsignedInt" } + }, + "Device.UPnP.Device.IGD.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "When <> is set to <>, this object defines the configuration parameters of the UPnP-IGD service embedded in the device.", + "access": false, + "array": false, + "MaxLeaseLifetime": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the maximum duration, in <>, for a UPnP-IGD port mapping lease that the UPnP-IGD service will grant. When a UPnP control point requests a lease duration exceeding this value, the UPnP-IGD service will still grant the port mapping request, but the actual lease lifetime will be capped at this value. Once this maximum lifetime expires, the port mapping will be automatically removed. A value of 0 indicates no <> is specified.", + "default": "86400", + "datatype": "unsignedInt", + "unit": "seconds" + }, + "CleanupInterval": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the interval, in <>, at which the Devices UPnP-IGD service automatically cleans up inactive UPnP port mappings. A port mapping is typically considered inactive if no network traffic has been observed traversing it for a predefined timeout period, which is an implementation-specific value within the UPnP-IGD service. During the cleanup process, mappings that meet this inactivity criteria are removed. A value of 0 disables this automatic cleanup mechanism, causing port mappings to persist until explicitly removed by the control point or the UPnP-IGD service restarts.", + "default": "0", + "datatype": "unsignedInt", + "unit": "seconds" + }, + "AllowReservedAddress": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates whether the Device allows port forwarding requests from UPnP control points even when the external (WAN) interface of the IGD has a private or reserved IPv4 address. When set to <>, the IGD service will process and attempt to establish port mappings despite having a non-public IP address on its WAN interface. When set to <>, the IGD will prevent the establishment of port mappings if it detects a private or reserved IP address on its WAN interface.", + "default": "false", + "datatype": "boolean" + }, + "EnableIPv6": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enables or disables IPv6 support for the UPnP IGD service.", + "default": "false", + "datatype": "boolean" + } } }, "Device.UPnP.Discovery.": { @@ -106843,6 +110309,42 @@ "description": "If <>, the rule matches only those packets that match the <> entry, if specified. If <>, the rule matches all packets except those that match the <> entry, if specified.", "default": "false", "datatype": "boolean" + }, + "FloodLimit": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the number of packets that can be processed per unit of time. A value of -1 indicates this criterion is not used for matching.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": -1, + "max": 65535 + } + ] + }, + "BurstLimit": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the maximum number of packets that can be processed in a short burst before the <> is enforced again. A value of -1 indicates this criterion is not used for matching.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": -1, + "max": 65535 + } + ] } } }, @@ -107153,7 +110655,7 @@ "cwmp", "usp" ], - "description": "Each reference provides a schedule where time based access can be enabled. When <> is <> the <> is not scheduled, and the <> defines the operational state.", + "description": "Each reference provides a time schedule that controls when the associated feature or resource is active or inactive. When <> is <> the <> is not scheduled, and the <> defines the operational state.", "default": "[]", "list": { "datatype": "string" @@ -108890,6 +112392,759 @@ } } }, + "Device.PeriodicFileTransfer.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object serves as the central control for managing file uploads to a remote server. It allows for periodic transfers of various file types, such as logs, crash dumps, and kernel oopses. Individual upload configurations are defined within instances of the <> object.", + "access": false, + "array": false, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Globally enables or disables the entire file transfer service managed by this object. When disabled, no file transfers will occur, regardless of individual profile or transfer configurations.", + "datatype": "boolean" + }, + "ProtocolsSupported": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the protocols that are supported.", + "list": { + "datatype": "string", + "enumerations": [ + "HTTP" + ] + } + }, + "TypesSupported": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the file types that are supported for upload.", + "list": { + "datatype": "string", + "enumerations": [ + "VendorLogFile", + "ProcessFaults", + "KernelFaults", + "LogRotate" + ] + } + }, + "HTTPCompressionsSupported": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the HTTP Compression mechanism(s) supported by this Device for the purposes of transferring the data.", + "list": { + "datatype": "string", + "enumerations": [ + "GZIP", + "Compress", + "Deflate" + ] + } + }, + "HTTPMethodsSupported": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the HTTP method(s) supported by this Device for the purposes of transferring data.", + "list": { + "datatype": "string", + "enumerations": [ + "POST", + "PUT" + ] + } + }, + "ProfileNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "TransferNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "Device.PeriodicFileTransfer.Profile.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object defines a reusable profile for configuring file uploads. Each profile specifies the common parameters for transferring files to a remote server, such as the protocol to be used. Multiple transfer tasks (<>) can reference the same profile.", + "uniqueKeys": [ + "Alias", + "Name" + ], + "access": true, + "array": true, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "Name": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The textual name of the profile as assigned by the Device.", + "datatype": "string", + "range": [ + { + "max": 64 + } + ] + }, + "Protocol": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Protocol being used.", + "datatype": "string" + }, + "Controller": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "<> instance that created <>|delete>> The value of this parameter is automatically populated by the USP Agent upon <> creation using the reference to the USP Controller that created the instance. Only the USP Controller referenced by <> parameter will receive a <.Push!>> Event (assuming it has an associated Subscription) when the Profile has <> configured to <>, even if another USP Controller has an associated Subscription.", + "datatype": "string" + }, + "Device.PeriodicFileTransfer.Profile.{i}.HTTP.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object defines the HTTP/HTTPS transport properties for a transfer file upload profile. This object is used when the <> parameter has a value of <>. For authentication purposes the Device MUST support HTTP Basic and Digest Access Authentication as defined in <> and <>.", + "access": false, + "array": false, + "URL": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The URL of the server receiving the periodic file uploads.", + "datatype": "URL" + }, + "Username": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Username used to authenticate the Device when making a connection to the file upload server. <> indicates that the username will not be used during the authentication process.", + "datatype": "string", + "range": [ + { + "max": 256 + } + ] + }, + "Password": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Password used to authenticate the Device when making a connection to the file upload server. <> indicates that the password will not be used during the authentication process.", + "datatype": "string", + "range": [ + { + "max": 256 + } + ] + }, + "Certificate": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the client certificate that must be presented to the remote server for mutual authentication. This certificate is used to authenticate the client by the remote server, ensuring that the remote server is communicating with a trusted client. The client certificate must be issued by a trusted Certificate Authority (CA) and should match the clients private key. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, + "CABundle": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the group of CA certificate(s) that the client must use to validate the certificate presented by the remote server. These CA certificates form a trust chain that the server certificate must match, ensuring that only servers with trusted certificates can establish a connection. This parameter supports multiple CA certificates to accommodate different server certificate issuers. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, + "IPVersion": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the IP protocol version, following the definitions in <>. Valid values are: <>.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": 4, + "max": 4 + }, + { + "min": 6, + "max": 6 + }, + { + "min": -1, + "max": -1 + } + ] + }, + "Compression": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The value of this parameter represents the HTTP Compression mechanism to be used by the Device when transferring data to the file upload server.", + "datatype": "string" + }, + "Method": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The value of this parameter represents the HTTP method to be used by the Device when transferring data to the file upload server.", + "datatype": "string" + }, + "RetryEnable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "When <>, the Device retries unsuccessful attempts to transfer the remaining files.", + "datatype": "boolean" + }, + "RetryMinimumWaitInterval": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Configures the data transfer retry wait interval, in <>. The device MUST use a random value between <> and (<> * <> / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.", + "datatype": "unsignedInt", + "range": [ + { + "min": 1, + "max": 65535 + } + ], + "unit": "seconds" + }, + "RetryMaximumWaitInterval": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Configures the data transfer retry maximum wait interval, in <>. If the calculated interval is higher than the specifed <> value then <> value should be used.", + "default": "4294967295", + "datatype": "unsignedInt", + "range": [ + { + "min": 1, + "max": 4294967295 + } + ], + "unit": "seconds" + }, + "RetryIntervalMultiplier": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Configures the retry interval multiplier. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. The device MUST use a random value between <> and (<> * <> / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point.", + "datatype": "unsignedInt", + "range": [ + { + "min": 1000, + "max": 65535 + } + ] + }, + "RequestURIParameterNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "RequestHeaderParameterNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "Device.PeriodicFileTransfer.Profile.{i}.HTTP.RequestURIParameter.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object represents an instance of a parameter to be used in the report header used as part of the HTTP Request-URI transmitted by the CPE to the collection server using the Request-URI in addition to the parameters required by <>.", + "access": true, + "array": true, + "Name": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Name of the Request-URI parameter. If <> is <>, the name of the Request-URI parameter is the value of <>.", + "datatype": "string", + "range": [ + { + "max": 64 + } + ] + }, + "Reference": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The value MUST be the path name of a parameter to be used as the Request-URI parameter. If the value of this parameter is <>, then this object is not encoded in the report header.", + "datatype": "string", + "range": [ + { + "max": 256 + } + ] + } + }, + "Device.PeriodicFileTransfer.Profile.{i}.HTTP.RequestHeaderParameter.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object allows defining custom HTTP request header fields to be included in the outbound HTTP requests to the remote server when using this profile. As defined in <>. Each instance can specify either a static value or dynamically reference a device parameter.", + "access": true, + "array": true, + "Name": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The name of the custom HTTP header field to be added to the request. Either <> or <> MUST be specified. If both are specified, the value of <> will be used. If both are <>, this object is not included in the HTTP request.", + "datatype": "string", + "range": [ + { + "max": 64 + } + ] + }, + "Value": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The static value of the HTTP header field. If this parameter is <>, the value of the header field will be the current value of the device parameter specified in <>.", + "datatype": "string", + "range": [ + { + "max": 64 + } + ] + }, + "Reference": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The path name of a device parameter whose current value will be used as the value of this HTTP header field.", + "datatype": "string", + "range": [ + { + "max": 256 + } + ] + } + } + } + }, + "Device.PeriodicFileTransfer.Transfer.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object specifies the parameters for an individual file transfer task. Each instance specifies a file to be transferred, the method of transfer (periodic or on-demand), and a reference to a <.>> object containing the server connection details. The <> parameter reflects the current state of the transfer process, which can transition through the following sequences: * Idle \u2192 Uploading \u2192 Success \u2192 Idle * Idle \u2192 Uploading \u2192 Error \u2192 Idle * Idle \u2192 Creating \u2192 Error \u2192 Idle * Idle \u2192 Creating \u2192 Uploading \u2192 Success \u2192 Idle * Idle \u2192 Creating \u2192 Uploading \u2192 Error \u2192 Idle", + "uniqueKeys": [ + "Alias" + ], + "access": true, + "array": true, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enables or disables this specific file transfer task. If this entry is disabled then the transfer is not performed.", + "default": "false", + "datatype": "boolean" + }, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "Status": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the current status of this file transfer task.", + "datatype": "string", + "enumerations": [ + "Idle", + "Creating", + "Uploading", + "Success", + "Error" + ] + }, + "Origin": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the Origin of the <> instance.", + "default": "Controller", + "datatype": "string", + "enumerations": [ + "User", + "System", + "Controller" + ] + }, + "Type": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the type of file to be uploaded. The actual file path and any pre- or post-processing scripts associated with this file type are implementation-specific on the Device.", + "datatype": "string" + }, + "FileReference": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The path reference to the object that contains the file(s) to be uploaded. Only applicable when <> matches values of <> or <>. For other <> values, this parameter is not applicable, because all files of the selected type will be uploaded, e.g. when <> equals <> all process faults will be uploaded. When <> is <>, depending on the <> all references will be uploaded.", + "datatype": "string" + }, + "ProfileReference": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Reference to profile instance to be used to perform the transfer.", + "datatype": "string" + }, + "UploadInterval": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The file upload interval in <>. Each file upload is tried based on this interval and <>. File upload intervals MUST begin every <> <>. If <> is changed while Periodic File Upload is enabled, the first file upload interval begins immediately. For example, if <> is 86400 (a day) and if <> is set to UTC midnight on some day (in the past, present, or future) then the Device will upload its file(s) at midnight every 24 hours.", + "default": "86400", + "datatype": "unsignedInt", + "range": [ + { + "min": 1 + } + ], + "unit": "seconds" + }, + "TimeReference": { + "type": "dateTime", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "An absolute time reference in UTC to determine when the file will be transmitted. Each file upload interval MUST complete at this reference time plus or minus an integer multiple of <>, unless unable to due to higher prioritized operations. <> is used only to set the phase of the file upload intervals. The actual value of <> can be arbitrarily far into the past or future. If <> is changed while periodic file upload is enabled, the first file upload interval begins immediately. The Unknown Time value as defined in <> indicates that no particular time reference is specified. That is, the Device MAY locally choose the time reference, and is required only to adhere to the specified file upload intervals. If absolute time is not available to the Device, its file upload interval behavior MUST be the same as if the <> parameter was set to the Unknown Time value. For example, if <> is 86400 (a day) and if <> is set to UTC midnight on some day (in the past, present, or future) then the Device will upload its file(s) at midnight every 24 hours. Note that, if <> is set to a time other than the Unknown Time, the first file upload interval (which has to begin immediately) will almost certainly be shorter than <>). This is why <> is defined in terms of when file upload intervals complete rather than start.", + "default": "0001-01-01T00:00:00Z", + "datatype": "dateTime" + }, + "NextTransferDate": { + "type": "dateTime", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The UTC date and time of the next scheduled file upload for this periodic transfer task.", + "default": "0001-01-01T00:00:00Z", + "datatype": "dateTime" + }, + "ForceTransfer()": { + "type": "command", + "async": true, + "protocols": [ + "usp" + ] + }, + "Push!": { + "type": "event", + "protocols": [ + "usp" + ], + "output": { + "Data": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "The contents of the periodic file transfer report.", + "datatype": "string" + } + } + }, + "Device.PeriodicFileTransfer.Transfer.{i}.Stats.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object provides statistical information about the success and failure of individual file transfer tasks.", + "access": false, + "array": false, + "LastSuccess": { + "type": "dateTime", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The date and time at which of the last successful transfer.", + "datatype": "dateTime" + }, + "LastFailed": { + "type": "dateTime", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The date and time at which of the last failed transfer.", + "datatype": "dateTime" + }, + "LastErrorCode": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Error code of the last failed transfer as described in https://tr369.org/tr-369-usp-error-code-details/.", + "datatype": "StatsCounter64" + }, + "SuccessCount": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Counter of successful transfer.", + "datatype": "StatsCounter64" + }, + "FailedCount": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Counter of failed transfer.", + "datatype": "StatsCounter64" + } + } + }, + "Device.PeriodicFileTransfer.Stats.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object provides aggregated statistical information about all file upload activities managed by the <> object.", + "access": false, + "array": false, + "UploadSuccessful": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A counter representing the total number of successful file uploads across all transfer tasks since the last system reset or counter reset.", + "datatype": "StatsCounter64" + }, + "UploadFailed": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A counter representing the total number of failed file uploads across all transfer tasks since the last system reset or counter reset.", + "datatype": "StatsCounter64" + } + } + }, "Device.FaultMgmt.": { "type": "object", "protocols": [ @@ -109915,6 +114170,35 @@ "max": 256 } ] + }, + "GetCertificateURI()": { + "type": "command", + "async": false, + "protocols": [ + "usp" + ], + "output": { + "CertificateURI": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "The absolute or relative path to the certificate file, specified as an <> (The file URI Scheme).", + "datatype": "string" + }, + "PrivateKeyURI": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "The URI for the private key associated with this certificate, formatted according to <>. This URI should point to the keys location on a hardware security module (HSM) or other cryptographic token. For security reasons, the URI MUST NOT include any PIN information (e.g.,`pin-value`). The service responsible for managing the token should inject the required PIN at runtime. This practice prevents unauthorized access and malicious reuse of the private key by other services.", + "datatype": "string" + } + } } }, "Device.Security.CABundle.{i}.": { @@ -112760,7 +117044,7 @@ "cwmp", "usp" ], - "description": "Top level object for dynamically managed software applications. Since Device:2.15, the Software Module data model has undergone significant enhancements, particularly in expanding support for new concepts, e.g. <.>>, <.ApplicationData..>>, <.AutoRestart.>>, <.NetworkConfig.>>, <.HostObject.>>, and <.EnvVariable..>>. However, the CWMP protocol lacks native capabilities to dynamically manage these new concepts. At best, CWMP can be used to view the available configurations. For more dynamic and interactive management of these concepts, the USP protocol should be utilized.", + "description": "Top level object for dynamically managed applications. Since Device:2.15, the Software Module data model has undergone significant enhancements, particularly in expanding support for new concepts, e.g. <.>>, <.ApplicationData..>>, <.AutoRestart.>>, <.NetworkConfig.>>, <.HostObject.>>, and <.EnvVariable..>>. However, the CWMP protocol lacks native capabilities to dynamically manage these new concepts. At best, CWMP can be used to view the available configurations. For more dynamic and interactive management of these concepts, the USP protocol should be utilized.", "access": false, "array": false, "ExecEnvClassNumberOfEntries": { @@ -112822,7 +117106,7 @@ "protocols": [ "usp" ], - "description": "The <> that specifies the location of the DU to be installed. The URL MUST NOT include the userinfo component, as defined in <>. The HTTPS transport MUST be supported, and the HTTP transport MAY be supported. Other optional transports MAY also be supported.", + "description": "The <> that specifies the location of the Deployment Unit to be installed. The URL MUST NOT include the userinfo component, as defined in <>. The HTTPS transport MUST be supported, and the HTTP transport MAY be supported. Other optional transports MAY also be supported.", "datatype": "URL", "range": [ { @@ -112837,7 +117121,7 @@ "protocols": [ "usp" ], - "description": "The UUID (see <>) of the DU to be installed. If this parameter is <> the device MUST generate the UUID based on the rules defined in <> and <>.", + "description": "The UUID (see <>) of the Deployment Unit to be installed. If this parameter is <> the device MUST generate the UUID based on the rules defined in <> and <>.", "datatype": "UUID", "range": [ { @@ -112886,7 +117170,7 @@ "protocols": [ "usp" ], - "description": "This parameter indicates whether the containerized application runs in privileged mode. <> - Unprivileged Container. <> - Privileged Container.", + "description": "This parameter indicates whether the application runs in privileged mode. <> - Unprivileged Container. <> - Privileged Container.", "default": "false", "datatype": "boolean" }, @@ -112898,7 +117182,7 @@ "protocols": [ "usp" ], - "description": "Number of UIDs (EU User Identifiers) that this container will need as part of its user namespace. UIDs are unique identifiers associated with each user and system process that is used to determine the allocation and isolation of system resources. <>", + "description": "Number of UIDs (Execution Unit User Identifiers) that this container will need as part of its user namespace. UIDs are unique identifiers associated with each user and system process that is used to determine the allocation and isolation of system resources. <>", "default": "1", "datatype": "unsignedInt" }, @@ -112909,7 +117193,7 @@ "protocols": [ "usp" ], - "description": "A reference to the Execution Environment upon which the DU is to be installed. If <> the device MUST choose the Execution Environment to use.", + "description": "A reference to the Execution Environment upon which the Deployment Unit is to be installed. If <> the device MUST choose the Execution Environment to use.", "datatype": "string", "range": [ { @@ -112924,7 +117208,7 @@ "protocols": [ "usp" ], - "description": "The <> which can be used to fetch the signature for this DU. The <> may use the data scheme defined in <> in order to incorporate the signature into the command directly. Several signature formats are in common use; the device may deduce the format used from the Content-Type of the retrieved object and/or by examining its content. The URL MUST NOT include the userinfo component, as defined in <>. HTTPS transport MUST be supported. Other optional transports MAY be supported. The absence of this parameter indicates that the DU is unsigned. If this is contrary to the security policy of the device then the command will be rejected.", + "description": "The <> which can be used to fetch the signature for this Deployment Unit. The <> may use the data scheme defined in <> in order to incorporate the signature into the command directly. Several signature formats are in common use; the device may deduce the format used from the Content-Type of the retrieved object and/or by examining its content. The URL MUST NOT include the userinfo component, as defined in <>. HTTPS transport MUST be supported. Other optional transports MAY be supported. The absence of this parameter indicates that the Deployment Unit is unsigned. If this is contrary to the security policy of the device then the command will be rejected.", "datatype": "URL", "range": [ { @@ -112951,7 +117235,7 @@ "protocols": [ "usp" ], - "description": "The roles which the application installed by this command will need to be assigned in order to be able to function at all. If any of these roles are not present in the <.AvailableRoles>> of the <> into which the DU is to be installed then the command will fail. Some Agents may apply further filtering for roles which are considered security- or privacy-sensitive. Each entry in the list is the Name of a row in <>. If there is no such row then the command will fail, as installation requires a role which is not available on the Device. If this argument is absent or empty then no roles are required in order for the application to function.", + "description": "The roles which the application installed by this command will need to be assigned in order to be able to function at all. If any of these roles are not present in the <.AvailableRoles>> of the <> into which the Deployment Unit is to be installed then the command will fail. Some Agents may apply further filtering for roles which are considered security- or privacy-sensitive. Each entry in the list is the Name of a row in <>. If there is no such row then the command will fail, as installation requires a role which is not available on the Device. If this argument is absent or empty then no roles are required in order for the application to function.", "list": { "datatype": "string", "range": [ @@ -112968,7 +117252,7 @@ "protocols": [ "usp" ], - "description": "The additional roles which the application installed by this command would need to be assigned in order to be able to provide its full functionality. Each entry in the list is the Name of a row in <>. If there is no such row, or the matching row is not present in the <.AvailableRoles>> of the Execution Environment into which the DU is to be installed, then the entry will be ignored. Some Agents may apply further filtering for roles which are considered security- or privacy-sensitive. If this argument is absent or empty then no additional roles are required in order for the application to be able to provide its full functionality.", + "description": "The additional roles which the application installed by this command would need to be assigned in order to be able to provide its full functionality. Each entry in the list is the Name of a row in <>. If there is no such row, or the matching row is not present in the <.AvailableRoles>> of the Execution Environment into which the Deployment Unit is to be installed, then the entry will be ignored. Some Agents may apply further filtering for roles which are considered security- or privacy-sensitive. If this argument is absent or empty then no additional roles are required in order for the application to be able to provide its full functionality.", "list": { "datatype": "string", "range": [ @@ -112985,7 +117269,7 @@ "protocols": [ "usp" ], - "description": "The User Roles which the application installed by this command will need to be assigned in order to be able to function at all. If any of these User Roles are not present in the <.AvailableUserRoles>> of the <> into which the DU is to be installed then the command will fail. Some Agents may apply further filtering for User Roles which are considered security- or privacy-sensitive. Each entry in the list is the Name of a row in <>. If there is no such row then the command will fail, as installation requires a User Role which is not available on the Device. If this argument is absent or empty then no User Roles are required in order for the application to function.", + "description": "The User Roles which the application installed by this command will need to be assigned in order to be able to function at all. If any of these User Roles are not present in the <.AvailableUserRoles>> of the <> into which the Deployment Unit is to be installed then the command will fail. Some Agents may apply further filtering for User Roles which are considered security- or privacy-sensitive. Each entry in the list is the Name of a row in <>. If there is no such row then the command will fail, as installation requires a User Role which is not available on the Device. The resulting capabilities list of the required User Roles is listed in <.AvailableUserRoleCapabilities>>. If this argument is absent or empty then no User Roles are required in order for the application to function.", "list": { "datatype": "string", "range": [ @@ -113002,7 +117286,7 @@ "protocols": [ "usp" ], - "description": "Each entry in the list is an Object Path, Command Path, Event Path, or Parameter Path that determines the element(s) of the data model that the the application installed by this command has permission to register. The information provided in this input arguement is placed in the <> table. If this argument is absent or empty then the application has no permission to register any data model paths.", + "description": "Each entry in the list is an Object Path, Command Path, Event Path, or Parameter Path that determines the element(s) of the data model that the application installed by this command has permission to register. The information provided in this input arguement is placed in the <> table. If this argument is absent or empty then the application has no permission to register any data model paths.", "list": { "datatype": "string", "range": [ @@ -113088,7 +117372,7 @@ "protocols": [ "usp" ], - "description": "The UUID as defined in <> of the DU that affected by the state change.", + "description": "The UUID as defined in <> of the Deployment Unit that affected by the state change.", "datatype": "UUID", "range": [ { @@ -113107,7 +117391,7 @@ "protocols": [ "usp" ], - "description": "A reference to the DU that was affected by the state change.", + "description": "A reference to the Deployment Unit that was affected by the state change.", "datatype": "string" }, "Version": { @@ -113117,7 +117401,7 @@ "protocols": [ "usp" ], - "description": "In the case of an Install, this will be the version of the DU created. In the case of an Update, it will be the updated version of the DU. In the case of an Uninstall, it will be the version of the uninstalled DU. This MUST match the <.Version>> Parameter contained within the instance of the DeploymentUnit that is contained within the <> argument.", + "description": "In the case of an Install, this will be the version of the Deployment Unit created. In the case of an Update, it will be the updated version of the Deployment Unit. In the case of an Uninstall, it will be the version of the uninstalled Deployment Unit. This MUST match the <.Version>> Parameter contained within the instance of the Deployment Unit that is contained within the <> argument.", "datatype": "string", "range": [ { @@ -113132,7 +117416,7 @@ "protocols": [ "usp" ], - "description": "The current state of the created DU.", + "description": "The current state of the created Deployment Unit.", "datatype": "string", "enumerations": [ "Installed", @@ -113148,7 +117432,7 @@ "protocols": [ "usp" ], - "description": "Whether or not the DU operation resolved all of its dependencies. In the case of a successful Uninstall, this value is meaningless and should be <>.", + "description": "Whether or not the Deployment Unit operation resolved all of its dependencies. In the case of a successful Uninstall, this value is meaningless and should be <>.", "datatype": "boolean" }, "ExecutionUnitRefList": { @@ -113158,7 +117442,7 @@ "protocols": [ "usp" ], - "description": "The Execution Units affected by this operation. In the case of an Install, this will be the list of EUs that were created as a result of the DU\u2019s installation. In the case of an Update, this will be the list of all EUs currently associated with the updated DU, including those that were created through the initial DU installation and any updates that had already occurred but not including any EUs that no longer exist on the device because of this or previous updates. In the case of an Uninstall, this will be the list of the EUs removed from the device due to the DU being removed.", + "description": "The Execution Units affected by this operation. In the case of an Install, this will be the list of Execution Units that were created as a result of the Deployment Unit\u2019s installation. In the case of an Update, this will be the list of all Execution Units currently associated with the updated Deployment Unit, including those that were created through the initial Deployment Unit installation and any updates that had already occurred but not including any Execution Units that no longer exist on the device because of this or previous updates. In the case of an Uninstall, this will be the list of the Execution Units removed from the device due to the Deployment Unit being removed.", "list": { "datatype": "string" } @@ -113190,7 +117474,7 @@ "protocols": [ "usp" ], - "description": "The operation that was performed against the DU causing the DU state change.", + "description": "The operation that was performed against the Deployment Unit causing the Deployment Unit state change.", "datatype": "string", "enumerations": [ "Install", @@ -113282,7 +117566,7 @@ "cwmp", "usp" ], - "description": "A reference to the DeploymentUnit (if any) by which this <> was created.", + "description": "A reference to the Deployment Unit (if any) by which this <> was created.", "datatype": "string" }, "CapabilityNumberOfEntries": { @@ -113356,7 +117640,7 @@ "protocols": [ "usp" ], - "description": "The roles which are available to Deployment Units installed into the new instance. Only the listed roles may be assigned to any DeploymentUnit installed into the instance. If this parameter is missing or <> then no roles may be assigned to any DeploymentUnit installed into the instance. Each entry in the list is the Name of a row in <>. If there is no such row then the entry will be ignored.", + "description": "The roles which are available to Deployment Units installed into the new instance. Only the listed roles may be assigned to any Deployment Unit installed into the instance. If this parameter is missing or <> then no roles may be assigned to any Deployment Unit installed into the instance. Each entry in the list is the Name of a row in <>. If there is no such row then the entry will be ignored.", "list": { "datatype": "string", "range": [ @@ -113373,7 +117657,7 @@ "protocols": [ "usp" ], - "description": "The User Roles which are available to Deployment Units installed into the new instance. Only the listed User Roles may be assigned to any DeploymentUnit installed into the instance. If this parameter is missing or <> then no User Roles may be assigned to any DeploymentUnit installed into the instance. Each entry in the list is the Name of a row in <>. If there is no such row then the entry will be ignored.", + "description": "The User Roles which are available to Deployment Units installed into the new instance. Only the listed User Roles may be assigned to any Deployment Unit installed into the instance. If this parameter is missing or <> then no User Roles may be assigned to any Deployment Unit installed into the instance. Each entry in the list is the Name of a row in <>. If there is no such row then the entry will be ignored.", "list": { "datatype": "string", "range": [ @@ -113856,7 +118140,7 @@ "cwmp", "usp" ], - "description": "Represents the processors that this <> has available to it. <>, is deprecated.>>", + "description": "Represents the processors that this <> has available to it. <>, is deprecated.>> <>", "list": { "datatype": "string" } @@ -113948,7 +118232,7 @@ "protocols": [ "usp" ], - "description": "The roles which are available to Deployment Units installed into this <>. Only the listed roles may be assigned to any DeploymentUnit. If this parameter is missing or <> then no roles will be assigned to any DeploymentUnit installed into this <>.", + "description": "The roles which are available to Deployment Units installed into this <>. Only the listed roles may be assigned to any DeploymentUnit. If this parameter is missing or <> then no roles will be assigned to any Deployment Unit installed into this <>.", "list": { "datatype": "string" } @@ -113960,7 +118244,7 @@ "protocols": [ "usp" ], - "description": "Represents the network interface through which the outgoing traffic from the ExecutionUnit running in this <> may be allowed. This value can be altered by executing the <>.", + "description": "Represents the network interface through which the outgoing traffic from the Execution Unit running in this <> may be allowed. This value can be altered by executing the <>.", "list": { "datatype": "string" } @@ -114135,7 +118419,7 @@ "protocols": [ "usp" ], - "description": "The new list of access interfaces which may be assigned to any DeploymentUnit installed into the <> this list replaces the previous value of <>. If this parameter is an empty string then no access interface may be assigned to any DeploymentUnit installed into the <>. Each entry in the list is the Name of a row in <>.", + "description": "The new list of access interfaces which may be assigned to any Deployment Unit installed into the <> this list replaces the previous value of <>. If this parameter is an empty string then no access interface may be assigned to any DeploymentUnit installed into the <>. Each entry in the list is the Name of a row in <>.", "list": { "datatype": "string", "range": [ @@ -114203,7 +118487,7 @@ "protocols": [ "usp" ], - "description": "If this parameter is present and is <>, the ExecEnv will be removed even if one or more DU is installed in it. A <> Event with <> set to <> will be issued for each DU which is removed as a result of the operation. Any Application Data associated with the DU will be lost. If this parameter is absent or <>, the operation will fail if any DU is installed in the EE; in the case of such a failure the EE will continue to exist and its Status will not change, nor will any Application Data be lost.", + "description": "If this parameter is present and is <>, the ExecEnv will be removed even if one or more Deployment Unit is installed in it. A <> Event with <> set to <> will be issued for each Deployment Unit which is removed as a result of the operation. Any Application Data associated with the Deployment Unit will be lost. If this parameter is absent or <>, the operation will fail if any Deployment Unit is installed in the EE; in the case of such a failure the EE will continue to exist and its Status will not change, nor will any Application Data be lost.", "default": "false", "datatype": "boolean" } @@ -114655,7 +118939,7 @@ "protocols": [ "usp" ], - "description": "The <> that specifies the location of the DU to be installed. The URL MUST NOT include the userinfo component, as defined in <>. The HTTPS transport MUST be supported, and the HTTP transport MAY be supported. Other optional transports MAY also be supported. If the device receives an Update command with the same source URL as a previous Update or Install command, the device MUST perform each Update as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time.", + "description": "The <> that specifies the location of the Deployment Unit to be installed. The URL MUST NOT include the userinfo component, as defined in <>. The HTTPS transport MUST be supported, and the HTTP transport MAY be supported. Other optional transports MAY also be supported. If the device receives an Update command with the same source URL as a previous Update or Install command, the device MUST perform each Update as requested, and MUST NOT assume that the content of the file to be downloaded is the same each time.", "datatype": "URL", "range": [ { @@ -114700,7 +118984,7 @@ "protocols": [ "usp" ], - "description": "This parameter determines whether the containerized application runs in privileged mode. <> - Unprivileged Container. <> - Privileged Container.", + "description": "This parameter determines whether the application runs in privileged mode. <> - Unprivileged Container. <> - Privileged Container.", "default": "false", "datatype": "boolean" }, @@ -114712,7 +118996,7 @@ "protocols": [ "usp" ], - "description": "Number of UIDs (EU User Identifiers) that this container will need as part of its user namespace. UIDs are unique identifiers associated with each user and system process that is used to determine the allocation and isolation of system resources. <>", + "description": "Number of UIDs (Execution Unit User Identifiers) that this container will need as part of its user namespace. UIDs are unique identifiers associated with each user and system process that is used to determine the allocation and isolation of system resources. <>", "default": "1", "datatype": "unsignedInt" }, @@ -114723,7 +119007,7 @@ "protocols": [ "usp" ], - "description": "The <> which can be used to fetch the signature for this DU. The <> may use the data scheme defined in <> in order to incorporate the signature into the command directly. Several signature formats are in common use; the device may deduce the format used from the Content-Type of the retrieved object and/or by examining its content. The URL MUST NOT include the userinfo component, as defined in <>. HTTPS transport MUST be supported. Other optional transports MAY be supported. The absence of this parameter indicates that the DU is unsigned. If this is contrary to the security policy of the device then the command will be rejected.", + "description": "The <> which can be used to fetch the signature for this Deployment Unit. The <> may use the data scheme defined in <> in order to incorporate the signature into the command directly. Several signature formats are in common use; the device may deduce the format used from the Content-Type of the retrieved object and/or by examining its content. The URL MUST NOT include the userinfo component, as defined in <>. HTTPS transport MUST be supported. Other optional transports MAY be supported. The absence of this parameter indicates that the Deployment Unit is unsigned. If this is contrary to the security policy of the device then the command will be rejected.", "datatype": "URL", "range": [ { @@ -114738,7 +119022,7 @@ "protocols": [ "usp" ], - "description": "If this argument is present, it lists the roles which the application will need to be assigned in order to be able to function at all after this update. If it is absent then the required roles are unchanged from the previous version. If any of these roles are not present in the <.AvailableRoles>> of the <> in which the DU is installed then the command will fail. Some Agents may apply further filtering for roles which are considered security- or privacy-sensitive. Each entry in the list is the Name of a row in <>. If there is no such row then the command will fail, as installation requires a role which is not available on the Device. If this argument is empty then no roles are required in order for the application to function.", + "description": "If this argument is present, it lists the roles which the application will need to be assigned in order to be able to function at all after this update. If it is absent then the required roles are unchanged from the previous version. If any of these roles are not present in the <.AvailableRoles>> of the <> in which the Deployment Unit is installed then the command will fail. Some Agents may apply further filtering for roles which are considered security- or privacy-sensitive. Each entry in the list is the Name of a row in <>. If there is no such row then the command will fail, as installation requires a role which is not available on the Device. If this argument is empty then no roles are required in order for the application to function.", "list": { "datatype": "string", "range": [ @@ -114755,7 +119039,7 @@ "protocols": [ "usp" ], - "description": "If this argument is present, it lists the additional roles which the application would need to be assigned in order to be able to provide its full functionality after this update. If it is absent then the required roles are unchanged from the previous version. Each entry in the list is the Name of a row in <>. If there is no such row, or the matching row is not present in the <.AvailableRoles>> of the Execution Environment into which the DU is to be installed, then the entry will be ignored. Some Agents may apply further filtering, for roles which are considered security- or privacy-sensitive. If this argument is empty then no additional roles are required in order for the application to be able to provide its full functionality.", + "description": "If this argument is present, it lists the additional roles which the application would need to be assigned in order to be able to provide its full functionality after this update. If it is absent then the required roles are unchanged from the previous version. Each entry in the list is the Name of a row in <>. If there is no such row, or the matching row is not present in the <.AvailableRoles>> of the Execution Environment into which the Deployment Unit is to be installed, then the entry will be ignored. Some Agents may apply further filtering, for roles which are considered security- or privacy-sensitive. If this argument is empty then no additional roles are required in order for the application to be able to provide its full functionality.", "list": { "datatype": "string", "range": [ @@ -114772,7 +119056,7 @@ "protocols": [ "usp" ], - "description": "If this argument is present, it lists the User Roles which the application will need to be assigned in order to be able to function at all after this update. If it is absent then the required User Roles are unchanged from the previous version. If any of these User Roles are not present in the <.AvailableUserRoles>> of the <> in which the DU is installed then the command will fail. Some Agents may apply further filtering for User Roles which are considered security- or privacy-sensitive. Each entry in the list is the Name of a row in <>. If there is no such row then the command will fail, as installation requires a User Role which is not available on the Device. If this argument is <> then no User Roles are required in order for the application to function.", + "description": "If this argument is present, it lists the User Roles which the application will need to be assigned in order to be able to function at all after this update. If it is absent then the required User Roles are unchanged from the previous version. If any of these User Roles are not present in the <.AvailableUserRoles>> of the <> in which the Deployment Unit is installed then the command will fail. Some Agents may apply further filtering for User Roles which are considered security- or privacy-sensitive. Each entry in the list is the Name of a row in <>. If there is no such row then the command will fail, as installation requires a User Role which is not available on the Device. The resulting capabilities list of the required User Roles is listed in <.AvailableUserRoleCapabilities>>. If this argument is <> then no User Roles are required in order for the application to function.", "list": { "datatype": "string", "range": [ @@ -115185,7 +119469,7 @@ "cwmp", "usp" ], - "description": "This parameter is allocated by the host system. This is the user identifier within the execution units environment. This UID is local to the execution unit and is used by the EUs internal processes to manage permissions. By default, processes within the EU execute as root (UID 0) unless otherwise specified.", + "description": "This parameter is allocated by the host system. This is the user identifier within the execution units environment. This UID is local to the execution unit and is used by the Execution Units internal processes to manage permissions. By default, processes within the Execution Unit execute as root (UID 0) unless otherwise specified.", "datatype": "unsignedInt" }, "AllocatedEUGID": { @@ -115196,7 +119480,7 @@ "cwmp", "usp" ], - "description": "This parameter is allocated by the host system. This is the group identifier within the execution units environment. This GID is local to the execution unit and is used by the EUs internal processes to manage permissions.", + "description": "This parameter is allocated by the host system. This is the group identifier within the execution units environment. This GID is local to the execution unit and is used by the Execution Units internal processes to manage permissions.", "datatype": "string" }, "AllocatedHostUID": { @@ -115207,7 +119491,7 @@ "cwmp", "usp" ], - "description": "This parameter is allocated by the host system. This is the user identifier on the host system where this EU is running. This UID is system wide and is managed by the kernel.", + "description": "This parameter is allocated by the host system. This is the user identifier on the host system where this Execution Unit is running. This UID is system wide and is managed by the kernel.", "datatype": "unsignedInt" }, "AllocatedHostGID": { @@ -115218,7 +119502,7 @@ "cwmp", "usp" ], - "description": "This parameter is allocated by the host system. This is the group identifier on the host system where this EU is running. This GID is system wide and is managed by the kernel.", + "description": "This parameter is allocated by the host system. This is the group identifier on the host system where this Execution Unit is running. This GID is system wide and is managed by the kernel.", "datatype": "string" }, "CreationTime": { @@ -115229,7 +119513,7 @@ "cwmp", "usp" ], - "description": "The date and time when the EU was created.", + "description": "The date and time when the Execution Unit was created.", "datatype": "dateTime" }, "Uptime": { @@ -115240,7 +119524,7 @@ "cwmp", "usp" ], - "description": "The amount of time in <> that this EU has been up and running since it was activated.", + "description": "The amount of time in <> that this Execution Unit has been up and running since it was activated.", "datatype": "unsignedInt", "unit": "seconds" }, @@ -115367,6 +119651,54 @@ "description": "<>", "datatype": "unsignedInt" }, + "RequiredRoles": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "Each item in the list represents a mandatory ControllerTrust Role that was required by <> or <.Update().RequiredRoles>> when the <> was created or updated. Note, the description of the <> table indicates that the device MAY reject deletion requests for specific instances of that object, which could cause instability for this <>.", + "list": { + "datatype": "string" + } + }, + "OptionalRoles": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "Each item in the list represents an optional ControllerTrust Role that was required by <> or <.Update().OptionalRoles>> when the <> was created or updated.", + "list": { + "datatype": "string" + } + }, + "RequiredUserRoles": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "Each item in the list represents a User Role that was required by <> or <.Update().RequiredUserRoles>> when the <> was created or updated. Note, the description of the <> table indicates that the device MAY reject deletion requests for specific instances of that object, which could cause instability for this <>.", + "list": { + "datatype": "string" + } + }, + "AvailableUserRoleCapabilities": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "This is the list of User Role instances that in turn yields a set of capabilities available to this <>. This list is evaluated only at the start of this <> based on the configuration of <> and <.RequiredCapabilities>>.", + "list": { + "datatype": "string" + } + }, "SetRequestedState()": { "type": "command", "async": false, @@ -115404,7 +119736,7 @@ "cwmp", "usp" ], - "description": "Configures the parameters of the auto-restart algorithm for this EU. An auto-restart may be triggered if the Agent determines that the EU has terminated abnormally. An exponential backoff algorithm is applied (increasing each time the delay before the EU is re-launched) in order to prevent continual re-starting of the EU. The retry interval range is controlled by two Parameters, <> and <>. Let m be the value of <>, k the value of <>, and n the current value of <>. Then on the next occasion that the Agent determines that the EU has terminated abnormally, the delay before re-starting the EU must lie between m * (k/1000)^n^ and m * (k/1000)^(n+1)^ seconds, so long as m * (k/1000)^n^ evaluates to a value less than <>. Once this point has been reached, on all subsequent occasion that the Agent determines that the EU has terminated abnormally the delay before re-starting the EU must lie between <> * (1000/k) and <> seconds.", + "description": "Configures the parameters of the auto-restart algorithm for this Execution Unit. An auto-restart may be triggered if the Agent determines that the Execution Unit has terminated abnormally. An exponential backoff algorithm is applied (increasing each time the delay before the Execution Unit is re-launched) in order to prevent continual re-starting of the Execution Unit. The retry interval range is controlled by two Parameters, <> and <>. Let m be the value of <>, k the value of <>, and n the current value of <>. Then on the next occasion that the Agent determines that the Execution Unit has terminated abnormally, the delay before re-starting the Execution Unit must lie between m * (k/1000)^n^ and m * (k/1000)^(n+1)^ seconds, so long as m * (k/1000)^n^ evaluates to a value less than <>. Once this point has been reached, on all subsequent occasion that the Agent determines that the Execution Unit has terminated abnormally the delay before re-starting the Execution Unit must lie between <> * (1000/k) and <> seconds.", "access": false, "array": false, "Enable": { @@ -115415,7 +119747,7 @@ "cwmp", "usp" ], - "description": "Enable the auto-restart feature for this EU.", + "description": "Enable the auto-restart feature for this Execution Unit.", "default": "false", "datatype": "boolean" }, @@ -115427,7 +119759,7 @@ "cwmp", "usp" ], - "description": "Configures the initial delay in <> between detecting that the EU has terminated abnormally and re-starting it.", + "description": "Configures the initial delay in <> between detecting that the Execution Unit has terminated abnormally and re-starting it.", "datatype": "unsignedInt", "unit": "seconds" }, @@ -115439,7 +119771,7 @@ "cwmp", "usp" ], - "description": "Configures the maximum delay in <> between detecting that the EU has terminated abnormally and re-starting it.", + "description": "Configures the maximum delay in <> between detecting that the Execution Unit has terminated abnormally and re-starting it.", "datatype": "unsignedInt", "unit": "seconds" }, @@ -115473,7 +119805,7 @@ "cwmp", "usp" ], - "description": "If the EU runs for this number of <> without terminating abnormally the Agent MAY reset the <> to zero, thereby resetting the exponential backoff algorithm. A value of zero disables this behavior.", + "description": "If the Execution Unit runs for this number of <> without terminating abnormally the Agent MAY reset the <> to zero, thereby resetting the exponential backoff algorithm. A value of zero disables this behavior.", "datatype": "unsignedInt", "unit": "seconds" }, @@ -115485,7 +119817,7 @@ "cwmp", "usp" ], - "description": "The number times the EU has terminated abnormally and a restart has been attempted. Resetting this parameter to zero has the effect of re-initialising the exponential back-off algorithm.", + "description": "The number times the Execution Unit has terminated abnormally and a restart has been attempted. Resetting this parameter to zero has the effect of re-initialising the exponential back-off algorithm.", "datatype": "unsignedInt" }, "LastRestarted": { @@ -115517,7 +119849,7 @@ "cwmp", "usp" ], - "description": "Parameters of the network configuration for this ExecutionUnit. When no network configuration is provided, the EU will not have any network access.", + "description": "Parameters of the network configuration for this ExecutionUnit. When no network configuration is provided, the Execution Unit will not have any network access.", "access": false, "array": false, "AccessInterfaceRefList": { @@ -115528,7 +119860,7 @@ "cwmp", "usp" ], - "description": "Represents the network interface through which the traffic from the EU will be allowed.", + "description": "Represents the network interface through which the traffic from the Execution Unit will be allowed.", "list": { "datatype": "string" } @@ -115541,7 +119873,7 @@ "cwmp", "usp" ], - "description": "Represents the list of Port mappings associated with this EU.", + "description": "Represents the list of Port mappings associated with this Execution Unit.", "list": { "datatype": "string" } @@ -115584,7 +119916,7 @@ "cwmp", "usp" ], - "description": "The object identifier by which the object may be accessed by the ExecutionUnit. This object identifier MUST be valid in the context of the Execution Environment in which the ExecutionUnit is installed.", + "description": "The object identifier by which the object may be accessed by the ExecutionUnit. This object identifier MUST be valid in the context of the Execution Environment in which the Execution Unit is installed.", "datatype": "string", "range": [ { @@ -118597,6 +122929,32 @@ "default": "true", "datatype": "boolean" }, + "IPVersion": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the IP protocol version, following the definitions in <>. Valid values are: <>.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": 4, + "max": 4 + }, + { + "min": 6, + "max": 6 + }, + { + "min": -1, + "max": -1 + } + ] + }, "BrokerAddress": { "type": "string", "read": true, @@ -118605,7 +122963,7 @@ "cwmp", "usp" ], - "description": "Host name or IP address of the MQTT Broker.", + "description": "Host name or IP address of the MQTT Broker. If the value of this parameter is an host name, the resolved IP address will be either IPv4 or IPv6, based on the value of the <> parameter.", "datatype": "string", "range": [ { @@ -118982,6 +123340,28 @@ } ] }, + "Certificate": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the client certificate that must be presented to the remote server for mutual authentication. This certificate is used to authenticate the client by the remote server, ensuring that the remote server is communicating with a trusted client. The client certificate must be issued by a trusted Certificate Authority (CA) and should match the clients private key. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, + "CABundle": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the group of CA certificate(s) that the client must use to validate the certificate presented by the remote server. These CA certificates form a trust chain that the server certificate must match, ensuring that only servers with trusted certificates can establish a connection. This parameter supports multiple CA certificates to accommodate different server certificate issuers. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, "PublishMessageExpiryInterval": { "type": "unsignedInt", "read": true, @@ -119492,6 +123872,44 @@ "Error" ] }, + "IPVersion": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the IP protocol version, following the definitions in <>. Valid values are: <>.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": 4, + "max": 4 + }, + { + "min": 6, + "max": 6 + }, + { + "min": -1, + "max": -1 + } + ] + }, + "TransportProtocol": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the transport protocol to be used for the MQTT broker connection.", + "default": "TLS", + "datatype": "string" + }, "Port": { "type": "unsignedInt", "read": true, @@ -119518,7 +123936,7 @@ "cwmp", "usp" ], - "description": "If <> is specified, the CPE MUST bind the MQTT broker to all available interfaces.", + "description": "If <> is specified, the CPE MUST bind the MQTT broker to all available interfaces, which depends on the value of the <> parameter. Meaning that the broker will bind to an IPv4 address, an IPv6 address, or both.", "datatype": "string", "range": [ { @@ -119558,6 +123976,28 @@ } ] }, + "Certificate": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the server certificate to be presented by the server during the TLS handshake. This certificate is used to authenticate the server to remote clients, ensuring that the clients are connecting to a legitimate server. The server certificate must be issued by a trusted Certificate Authority (CA) and should match the servers private key. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, + "CABundle": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the group of CA certificate(s) that the server must use to validate the certificate presented by the remote client. These CA certificates form a trust chain that the client certificate must match, ensuring that only clients with trusted certificates can establish a connection. This parameter supports multiple CA certificates to accommodate different client certificate issuers. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, "BridgeNumberOfEntries": { "type": "unsignedInt", "read": true, @@ -119764,6 +124204,28 @@ } ] }, + "Certificate": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the client certificate that must be presented to the remote server for mutual authentication. This certificate is used to authenticate the client by the remote server, ensuring that the remote server is communicating with a trusted client. The client certificate must be issued by a trusted Certificate Authority (CA) and should match the clients private key. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, + "CABundle": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the group of CA certificate(s) that the client must use to validate the certificate presented by the remote server. These CA certificates form a trust chain that the server certificate must match, ensuring that only servers with trusted certificates can establish a connection. This parameter supports multiple CA certificates to accommodate different server certificate issuers. This parameter is applicable only when a TLS session is being used.", + "datatype": "string" + }, "MessageRetryTime": { "type": "unsignedInt", "read": true, @@ -119927,6 +124389,32 @@ } ] }, + "IPVersion": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the IP protocol version, following the definitions in <>. Valid values are: <>.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": 4, + "max": 4 + }, + { + "min": 6, + "max": 6 + }, + { + "min": -1, + "max": -1 + } + ] + }, "Address": { "type": "string", "read": true, @@ -119935,7 +124423,7 @@ "cwmp", "usp" ], - "description": "Fully Qualified Domain Name (FQDN) or IP address of the MQTT broker server this <> 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 <> instance (based on rules defined over the selected <.ServerSelectionAlgorithm>>) SHOULD be used.", + "description": "Fully Qualified Domain Name (FQDN) or IP address of the MQTT broker server this <> 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 <> instance (based on rules defined over the selected <.ServerSelectionAlgorithm>>) SHOULD be used. If the value of this parameter is an host name, the resolved IP address will be either IPv4 or IPv6, based on the value of the <> parameter.", "datatype": "string", "range": [ { @@ -120658,6 +125146,24 @@ "description": "This object describes the LEDs on the device.", "access": false, "array": false, + "BrightnessLimiter": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The maximum allowed brightness level for all LEDs, expressed as a <>. This value is relative to the maximum allowed brightness value of each LED, which is specified in <.MaxBrightness>>. Valid values are: <>.", + "datatype": "unsignedInt", + "range": [ + { + "min": 0, + "max": 100 + } + ], + "unit": "percentage" + }, "LEDNumberOfEntries": { "type": "unsignedInt", "read": true, @@ -120922,7 +125428,7 @@ "cwmp", "usp" ], - "description": "The desired brightness level for this element of the cycle period, expressed as a <>, relative to the maximum allowed brightness value specified in <>.", + "description": "The desired brightness level for this element of the cycle period, expressed as a <>, relative to the maximum allowed brightness value specified in <>. The value should not exceed the maximum brightness level specified in <>.", "datatype": "unsignedInt", "range": [ { @@ -121351,7 +125857,7 @@ "cwmp", "usp" ], - "description": "Identifier of the measurement point indicating where the measurement agent is located on a path as defined in [bibref|RFC7398>>.", + "description": "Identifier of the measurement point indicating where the measurement agent is located on a path as defined in <>.", "datatype": "string", "range": [ { @@ -123903,7 +128409,7 @@ "cwmp", "usp" ], - "description": "This object describes the URSP Route Selection Descriptor table which provides a table of data networks and network slices used in PDU establishment. Table entries are used in precedence order until a successful PDU session is established. See ((bibref|3GPP-TS.23.503|Annex A>> for an example URSP rule traversal.", + "description": "This object describes the URSP Route Selection Descriptor table which provides a table of data networks and network slices used in PDU establishment. Table entries are used in precedence order until a successful PDU session is established. See <> for an example URSP rule traversal.", "uniqueKeys": [ "Alias", "Precedence" @@ -125440,6 +129946,35 @@ "description": "Enables or disables this ONU. If disabled, the ONU should prevent user traffic from flowing, suppress notifications, and power down as much as possible.", "datatype": "boolean" }, + "PowerCapability": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Describes the possible power states of the <> regardless of its current administrative state.", + "list": { + "datatype": "string", + "enumerations": [ + "On", + "Off", + "LowPower" + ] + } + }, + "PowerStatus": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Reports the current power status of the <>. <> <>", + "datatype": "string" + }, "Name": { "type": "string", "read": true, @@ -125521,6 +130056,26 @@ "description": "<>", "datatype": "unsignedInt" }, + "ChangePowerMode()": { + "type": "command", + "async": true, + "protocols": [ + "usp" + ], + "input": { + "PowerState": { + "type": "string", + "read": true, + "write": true, + "mandatory": true, + "protocols": [ + "usp" + ], + "description": "Targeted power state. <>", + "datatype": "string" + } + } + }, "Device.XPON.ONU.{i}.EthernetUNI.{i}.": { "type": "object", "protocols": [ @@ -127183,6 +131738,134 @@ "unit": "degrees celsius" } } + }, + "Device.XPON.ONU.{i}.PowerManagement.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object models the power reduction management capabilities of the ONU. It is based on <>. When <> is true then the ONU is allowed to enter a low power state. <>. <>.", + "access": false, + "array": false, + "PowerReductionManagementCapability": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This parameter indicates the sleep mode capability of the <>. This parameter is based on <>. An <> string indicates that no capabilities are supported.", + "list": { + "datatype": "string", + "enumerations": [ + "WatchfulSleepMode", + "DozeMode", + "CyclicSleepMode" + ] + } + }, + "OLTSleepAllow": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This parameter indicates that the ONU is allowed, by the OLT, to apply the power reduction mode.", + "datatype": "boolean" + }, + "PowerReductionManagementStatus": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This parameter indicates the current power reduction management status of the ONU. The ONU can be in one of the following states: Enumeration of: Active, WatchfulSleepMode, DozeMode, CyclicSleepMode..", + "datatype": "string", + "enumerations": [ + "Active", + "WatchfulSleepMode", + "DozeMode", + "CyclicSleepMode" + ] + }, + "ITransInit": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Optical Network Unit (ONU) vendors statement of the complete transceiver initialization time: the worst-case time required for the ONU to regain full functionality when leaving the asleep state (i.e., turning on both the receiver and the transmitter and acquiring synchronization to the downstream flow), measured in units of <>. The value zero indicates that the sleeping ONU can respond to a bandwidth grant without delay. Reference <>", + "datatype": "unsignedInt", + "unit": "125 microsecond PHY frames" + }, + "ITxInit": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This parameter is the Optical Network Unit (ONU) vendors statement of the transmitter initialization time: the time required for the ONU to regain full functionality when leaving the listen state (i.e., turning on the transmitter), measured in units of <>. The value zero indicates that the dozing ONU can respond to a bandwidth grant without delay. Reference <>", + "datatype": "unsignedInt", + "unit": "125 microsecond PHY frames" + }, + "MaxSleepInterval": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Isleep/Ilowpower attribute specifies the maximum time the ONU spends in its asleep, listen, or low-power states, as a count of <>. Local or remote events may truncate the ONUs sojourn in these states. The default value of this attribute is 0.", + "datatype": "unsignedInt", + "unit": "125 microsecond PHY frames" + }, + "MinAwareInterval": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Iaware attribute specifies the time the ONU spends in its aware state, as a count of <>, before it re-enters asleep or listen states. Local or remote events may independently cause the ONU to enter an active state rather than returning to a sleep state. The default value of this attribute is 0. Reference <>", + "datatype": "unsignedInt", + "unit": "125 microsecond PHY frames" + }, + "MinActiveHeldInterval": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Ihold attribute specifies the minimum time during which the ONU remains in the active held state, as a count of <>. Its initial value is zero. Reference <>", + "datatype": "unsignedInt", + "unit": "125 microsecond PHY frames" + }, + "MaxSleepIntervalExtension": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This parameter designates maximum sleep interval values for doze mode and cyclic sleep mode separately. When it supports this attribute, the ONU ignores the value of the maximum sleep interval attribute. Maximum sleep interval for doze mode and cyclic sleep mode are both 4 bytes. Maximum sleep interval for doze mode specifies the maximum time the ONU spends in its listen state, as a count of <>. Local or remote events may truncate the ONUs sojourn in these states. The default value is 0. Maximum sleep interval for cyclic sleep mode specifies the maximum time the ONU spends in its asleep state, as a count of <>. Local or remote events may truncate the ONUs sojourn in these states. The default value is 0. If watchful sleep is enabled, the ONU ignores this attribute. Reference <>", + "datatype": "unsignedLong", + "unit": "125 microsecond PHY frames" + } } } }, @@ -127403,6 +132086,19 @@ "default": "3", "datatype": "unsignedInt" }, + "BanTime": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The time, in <>, that an IP address is banned after exceeding the <>. A value of 0 disables this feature.", + "default": "900", + "datatype": "unsignedInt", + "unit": "seconds" + }, "AllowAllIPv4": { "type": "boolean", "read": true, @@ -127411,7 +132107,7 @@ "cwmp", "usp" ], - "description": "Allow access from any IPv4 address. The source prefixes defined in <> will be ignored.", + "description": "Allow incoming IP connections from any IPv4 address. The source prefixes defined in <> will be ignored.", "default": "false", "datatype": "boolean" }, @@ -127423,7 +132119,7 @@ "cwmp", "usp" ], - "description": "Allow only access from the provided list of IPv4 prefixes. When <> is set to <> and <> is set to false, no incoming connections are allowed. When <> is set true, <> is ignored.", + "description": "Allow only incoming IP connections from the provided list of IPv4 prefixes. When <> is set to <> and <> is set to false, no incoming IP connections are allowed. When <> is set true, <> is ignored.", "list": { "datatype": "string", "maxsize": 1024 @@ -127437,7 +132133,7 @@ "cwmp", "usp" ], - "description": "Allow access from any IPv6 address. The source prefixes defined in <> will be ignored.", + "description": "Allow incoming IP connections from any IPv6 address. The source prefixes defined in <> will be ignored.", "default": "false", "datatype": "boolean" }, @@ -127449,7 +132145,7 @@ "cwmp", "usp" ], - "description": "Allow only access from the provided list of IPv6 prefixes. When <> is set to <> and <> is set to false, no incoming connections are allowed. When <> is set true, <> is ignored.", + "description": "Allow only incoming IP connections from the provided list of IPv6 prefixes. When <> is set to <> and <> is set to false, no incoming IP connections are allowed. When <> is set true, <> is ignored.", "list": { "datatype": "string", "maxsize": 1024 @@ -127830,6 +132526,63 @@ "description": "<>", "datatype": "unsignedInt" }, + "AuthenticationNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "Device.UnixDomainSockets.Authentication.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object contains the authentication details for USP Endpoints connecting to Unix Domain Sockets requiring authentication. Endpoints not present in this table will be unable to authenticate successsfully on Unix Domain Sockets requiring authentication.", + "uniqueKeys": [ + "EndpointID" + ], + "access": true, + "array": true, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enable/Disable this <> instance.", + "datatype": "boolean" + }, + "EndpointID": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The unique USP identifier of the USP Endpoint.", + "datatype": "string" + }, + "Password": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Expected password to be used by the USP Endpoint to authenticate. If set to an empty string, the USP Endpoint will be unable to authenticate successsfully on Unix Domain Sockets requiring authentication.", + "datatype": "string" + } + }, "Device.UnixDomainSockets.UnixDomainSocket.{i}.": { "type": "object", "protocols": [ @@ -127884,6 +132637,28 @@ "max": 4096 } ] + }, + "AuthRequired": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "When <>, USP Endpoints connecting to this Unix Domain Socket MUST authenticate themselves.", + "datatype": "boolean" + }, + "RegistrationRestricted": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "When <>, USP Agents connecting to this Unix Domain Socket are only allowed to register data model paths permitted by the <> table. When <>, USP Agents connecting to this Unix Domain Socket may register any data model paths (subject to the rules affecting USP Services).", + "datatype": "boolean" } } }, @@ -128838,7 +133613,7 @@ "cwmp", "usp" ], - "description": "Each instance of this object provides a schedule where access is enabled.", + "description": "Represents a schedule that can be applied to a feature or resource.", "uniqueKeys": [ "Alias" ], @@ -128908,7 +133683,7 @@ "cwmp", "usp" ], - "description": "<> Enumeration of: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.", + "description": "<> Enumeration of: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.", "list": { "datatype": "string", "enumerations": [ @@ -128950,7 +133725,7 @@ "cwmp", "usp" ], - "description": "The duration, in <>, which the access is enabled. If the <> is not defined, duration is the total time access is allowed during a calendar day. If a <> is defined, access is allowed for the <> period starting from <>.", + "description": "The duration, in <>, for which the associated schedule is active. If <> is not defined, this duration represents the total time the schedule is active during a calendar day. If <> is defined, the schedule is active for the specified duration starting from <>.", "datatype": "unsignedInt", "range": [ { @@ -128967,7 +133742,7 @@ "cwmp", "usp" ], - "description": "When enabled, the Inverse Mode reverses the default behavior of the schedule, creating a dynamic where actions that are typically activated are now deactivated, and vice versa.", + "description": "When enabled, this parameter inverts the behavior of the associated schedule. Actions that would normally be active during the defined schedule are instead inactive, and actions that would normally be inactive are instead active. For example: If a schedule defines Internet access on Monday from 16:00 to 17:00: * With <> = <>, Internet access is permitted only between 16:00 and 17:00 on Monday. * With <> = <>, Internet access is permitted at all times except between 16:00 and 17:00 on Monday.", "default": "false", "datatype": "boolean" }, @@ -129722,6 +134497,37 @@ ], "access": false, "array": true, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enables or disables the interface. This parameter is based on ifAdminStatus from <>.", + "datatype": "boolean" + }, + "Status": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The current operational state of the interface (see <>). Enumeration of: Up, Down, Unknown, Dormant, NotPresent, LowerLayerDown, Error. When <> is <> then <> SHOULD normally be <> (or <> or <> if there is a fault condition on the interface). When <> is changed to <> then <> SHOULD change to <> if and only if the interface is able to transmit and receive network traffic; it SHOULD change to <> if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to <> if still operable when the expected actions have completed); it SHOULD change to <> if and only if the interface is prevented from entering the <> state because one or more of the interfaces beneath it is down; it SHOULD remain in the <> state if there is an error or other fault condition detected on the interface; it SHOULD remain in the <> state if the interface has missing (typically hardware) components; it SHOULD change to <> if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from <>.", + "datatype": "string", + "enumerations": [ + "Up", + "Down", + "Unknown", + "Dormant", + "NotPresent", + "LowerLayerDown", + "Error" + ] + }, "Alias": { "type": "string", "read": true, @@ -129733,6 +134539,48 @@ "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", "datatype": "_AliasCWMP" }, + "Name": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The textual name of the interface as assigned by the CPE.", + "datatype": "string", + "range": [ + { + "max": 64 + } + ] + }, + "LastChange": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The accumulated time in <> since the interface entered its current operational state.", + "datatype": "unsignedInt", + "unit": "seconds" + }, + "LowerLayers": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> <> See <>.", + "list": { + "datatype": "string", + "maxsize": 1024 + } + }, "Interface": { "type": "string", "read": true, @@ -129774,13 +134622,14 @@ "cwmp", "usp" ], - "description": "The data session type indicating the protocol the session is capable of carrying. See <>. Enumeration of: IPv4, IPv6, IPv4v6, Unstructured.", + "description": "The data session type indicating the protocol the session is capable of carrying. See <>. Enumeration of: IPv4, IPv6, IPv4v6, Unstructured, Ethernet.", "datatype": "string", "enumerations": [ "IPv4", "IPv6", "IPv4v6", - "Unstructured" + "Unstructured", + "Ethernet" ] }, "APN": { @@ -129815,6 +134664,206 @@ } ] }, + "IPv4AddressNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "IPv6AddressNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "Device.SessionManagement.Session.{i}.IPv4Address.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object models IPv4 network information that the Cellular modem received from the network.", + "uniqueKeys": [ + "Alias", + "IPAddress", + "SubnetMask" + ], + "access": false, + "array": true, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "IPAddress": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "IPv4 address.", + "datatype": "IPv4Address", + "range": [ + { + "max": 15 + } + ], + "pattern": [ + "", + "((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])" + ] + }, + "SubnetMask": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Subnet mask.", + "datatype": "IPv4Address", + "range": [ + { + "max": 15 + } + ], + "pattern": [ + "", + "((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])" + ] + }, + "GatewayIPAddress": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "IPv4 address of the gateway.", + "datatype": "IPv4Address", + "range": [ + { + "max": 15 + } + ], + "pattern": [ + "", + "((25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9]?[0-9])" + ] + }, + "MTU": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Maximum Transmission Unit for this link (expressed in <>). <>", + "datatype": "unsignedInt", + "range": [ + { + "min": 576 + } + ], + "unit": "bytes" + } + }, + "Device.SessionManagement.Session.{i}.IPv6Address.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object models IPv6 network information that the Cellular modem received from the network.", + "uniqueKeys": [ + "Alias", + "IPAddress" + ], + "access": false, + "array": true, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "IPAddress": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "IPv6 address.", + "datatype": "IPv6Address" + }, + "IPPrefix": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "IPv6 prefix. <> indicates that it matches all destination prefixes (i.e. equivalent to ::/0). All bits to the right of the prefix MUST be zero, e.g. 2001:edff:fe6a:f76::/64. Routes with a 128-bit prefix length (/128) are host routes for a specific IPv6 destination, e.g. 2001:db8:28:2:713e:a426:d167:37ab/128.", + "datatype": "IPv6Prefix" + }, + "NextHop": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "IPv6 address of the next hop.", + "datatype": "IPv6Address" + }, + "MTU": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Maximum Transmission Unit for this link (expressed in <>). <>", + "datatype": "unsignedInt", + "range": [ + { + "min": 1280 + } + ], + "unit": "bytes" + } + }, "Device.SessionManagement.Session.{i}.PCO.": { "type": "object", "protocols": [ @@ -130656,6 +135705,1400 @@ } } }, + "Device.Hardware.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Represents the hardware configuration of the device, including details about the CPU, memory, and other hardware components.", + "access": false, + "array": false, + "Device.Hardware.CPUs.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Represents the systems CPU configuration, providing details about each individual processor core, its capabilities, and its current operating state.", + "access": false, + "array": false, + "CPUNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "Device.Hardware.CPUs.CPU.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Represents a single CPU instance with configurable parameters related to its operational settings.", + "uniqueKeys": [ + "Alias" + ], + "access": false, + "array": true, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "Device.Hardware.CPUs.CPU.{i}.DVFS.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Represents the CPUs Dynamic Voltage and Frequency Scaling (DVFS) configuration. DVFS allows the operating voltage and frequency of the CPU to be dynamically adjusted to optimize power consumption and performance based on workload demands.", + "access": false, + "array": false, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enables or disables Dynamic Voltage and Frequency Scaling (DVFS) for this CPU. This parameter is only applicable if <> is <>. If <> is <> and this parameter is <> the <> will be set to <>. When this parameter is set to <>, the <> will be set to <>.", + "datatype": "boolean" + }, + "Status": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the status of Dynamic Voltage and Frequency Scaling (DVFS) for this CPU.", + "datatype": "string", + "enumerations": [ + "Disabled", + "Enabled", + "Unsupported" + ] + }, + "Supported": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates whether this CPU supports DVFS.", + "datatype": "boolean" + }, + "CurrentFrequency": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The current operating frequency of the CPU in <>.", + "datatype": "unsignedInt", + "unit": "kHz" + }, + "MinFrequency": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The minimum frequency that the CPU hardware is capable of operating at, in <>.", + "datatype": "unsignedInt", + "unit": "kHz" + }, + "MaxFrequency": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The maximum frequency that the CPU hardware is capable of operating at, in <>.", + "datatype": "unsignedInt", + "unit": "kHz" + }, + "ScalingMinFrequency": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The minimum operating frequency allowed for the CPU in <>. This value must be between <> and <>, and part of the <> list. This value must be less than <>.", + "datatype": "unsignedInt", + "unit": "kHz" + }, + "ScalingMaxFrequency": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The maximum operating frequency allowed for the CPU in <>. This value must be between <> and <>, and part of the <> list. This value must be greater than <>.", + "datatype": "unsignedInt", + "unit": "kHz" + }, + "ScalingAvailableFrequencies": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The available frequencies for CPU scaling in <>.", + "list": { + "datatype": "unsignedInt", + "unit": "kHz" + } + }, + "ScalingGovernor": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the CPU frequency governor to be used.", + "datatype": "string" + }, + "ScalingAvailableGovernors": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A list of available CPU frequency governors for this CPU.", + "list": { + "datatype": "string", + "enumerations": [ + "conservative", + "userspace", + "powersave", + "ondemand", + "performance", + "schedutil" + ] + } + } + } + } + }, + "Device.Hardware.PowerManagement.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object describes the overall power management capabilities and status of the device, typically referring to the main gateways power states and features.", + "access": false, + "array": false, + "Device.Hardware.PowerManagement.Standby.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object provides the capability for the Device to enter and exit standby. This functionality allows the Device to operate in a low-power condition.", + "access": false, + "array": false, + "Capability": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Describes the possible standby states of the Device.", + "datatype": "string", + "enumerations": [ + "DeepSleep" + ] + }, + "Status": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the current operational status of the standby feature.", + "datatype": "string", + "enumerations": [ + "Disabled", + "Scheduled", + "Error", + "Error_Misconfigured" + ] + }, + "ScheduleRef": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Each reference provides a specific schedule entry that triggers the device to enter and exit standby mode. The referenced schedule defines when the standby transition should occur and when the device should wake up. Overlapping schedules are not allowed.", + "list": { + "datatype": "string" + } + }, + "StandbyOccurred": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates that the current boot cycle was a result of exiting standby mode. The parameter value is only set during the device boot process.", + "datatype": "boolean" + }, + "NetworkAware": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates that the device is capable of maintaining a network connection and responding to communications via the network connection while in a standby state.", + "datatype": "boolean" + }, + "TimerAware": { + "type": "boolean", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates that the device is capable of maintaining and responding to timers while in a standby state.", + "datatype": "boolean" + }, + "EnterStandbyMode()": { + "type": "command", + "async": false, + "protocols": [ + "usp" + ], + "input": { + "Mode": { + "type": "string", + "read": true, + "write": true, + "mandatory": true, + "protocols": [ + "usp" + ], + "description": "The targeted standby mode to enter. <> <>", + "datatype": "string" + } + } + } + } + } + }, + "Device.ConnectionMonitoring.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object contains parameters for monitoring the connection status of interfaces. It allows the Device to monitor interfaces using ARP (Address Resolution Protocol) or ND (Neighbor Discovery) packets, depending on the IP version used by the interface. The CPE can enable or disable the connection monitor and configure individual entries for each interface. Each entry can be enabled or disabled independently, allowing for flexible monitoring configurations.", + "access": false, + "array": false, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enables or disables the connection monitor.", + "datatype": "boolean" + }, + "Status": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The current operational state of the monitor.", + "datatype": "string", + "enumerations": [ + "Disabled", + "Enabled", + "Error" + ] + }, + "ConnectionNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "Device.ConnectionMonitoring.Connection.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object contains parameters for monitoring the connection. The device can enable or disable the connection monitor and configure individual entries for different interfaces. Depending on <>, the device can use different methods to test connectivity, such as ARP, ND, Ping, BFDEcho or DNS. During normal operation, a connectivity check is performed every <>. If a check fails, due to no response within <>, then the device enters a failure state. In this failure state, it performs subsequent checks more frequently, every <>. The <> counter is incremented for each failed check and the value of the parameter <> status is set to <>. If this counter equals the <.AttemptCount>> threshold, the configured <.Action>> is triggered. If a check succeeds at any point, the <> counter is reset, the monitor interval reverts to the normal <> and the <> status is set to <>.", + "uniqueKeys": [ + "Alias" + ], + "access": true, + "array": true, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enables or disables the entry.", + "datatype": "boolean" + }, + "Status": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The current operational state of the entry.", + "datatype": "string", + "enumerations": [ + "Disabled", + "Enabled", + "Error", + "Error_Misconfigured" + ] + }, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "Interface": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This parameter specifies the interface to be monitored. Typically this is the WAN interface.", + "datatype": "string", + "range": [ + { + "max": 256 + } + ] + }, + "MonitorInterval": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The interval at which the Device monitors the connection status of the interface, in <>.", + "default": "60", + "datatype": "unsignedInt", + "range": [ + { + "min": 1, + "max": 60 + } + ], + "unit": "second" + }, + "FailInterval": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The interval at which the Device checks for connection failures after the initial monitor interval, in <>.", + "default": "15", + "datatype": "unsignedInt", + "range": [ + { + "min": 1, + "max": 60 + } + ], + "unit": "second" + }, + "MaxResponseTimeout": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The maximum time the Device waits for a response after sending a connectivity test packet, in <>.", + "default": "1", + "datatype": "unsignedInt", + "range": [ + { + "min": 1, + "max": 60 + } + ], + "unit": "second" + }, + "NumberOfAttempts": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The current number of failed attempts when no reply is obtained. This parameter is reset to zero when the last <> has been executed or when a connectivity test succeeds.", + "datatype": "unsignedInt" + }, + "Method": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The connectivity test method to be performed on the <>.", + "datatype": "string", + "enumerations": [ + "ARP", + "ND", + "Ping", + "BFDEcho", + "DNS" + ] + }, + "IPVersion": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Specifies the IP protocol version, following the definitions in <>. Valid values are: <>.", + "default": "-1", + "datatype": "int", + "range": [ + { + "min": 4, + "max": 4 + }, + { + "min": 6, + "max": 6 + }, + { + "min": -1, + "max": -1 + } + ] + }, + "DestAddress": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The destination address (IP address or FQDN) to which connectivity test packets are sent. When <> is set to -1,the implementation will chose and use only one IP version for testing the connectivity. It will try to use IPv6 first, and if that fails, it will fall back to IPv4. When <> is set to <> or <> this parameter specifies the IP address of the network device under test. The Device will send ARP requests (for IPv4) or Neighbor Solicitation messages (for IPv6) to this address to check connectivity. When <> the Device will use the default gateway IP address from the Interface specified in the <> parameter. When <> is set to <> this parameter specifies the IP address to which ICMP Echo Request packets are sent. The Device will send ICMP Echo Requests to this address to check connectivity. When <> the Device will use the default gateway IP address from the Interface specified in the <> parameter. When <> is set to <> this parameter specifies the IP address to which BFD echo packets are sent. The Device will send BFD Echo packets to this address to check connectivity. When <> the Device will use the default gateway IP address from the Interface specified in the <> parameter. When <> is set to <> this parameter specifies the DNS server (IP address or FQDN) to which DNS queries are sent. When <> the Device will use the default DNS server configured on the Interface specified in the <> parameter.", + "datatype": "string" + }, + "DSCPMark": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Diffserv code point to be used for outgoing connection monitoring traffic.", + "default": "48", + "datatype": "unsignedInt", + "range": [ + { + "min": 0, + "max": 63 + } + ] + }, + "EthernetPriority": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The Ethernet Priority for this <> entry, also known as 802.1p Priority, is a 3-bit field used to indicate the priority of network traffic. A value of -1 indicates that the Ethernet priority should not be changed for this <>.", + "datatype": "int", + "range": [ + { + "min": -1, + "max": 7 + } + ] + }, + "MonitoringStatus": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The current monitoring status of the connection.", + "datatype": "string", + "enumerations": [ + "Up", + "Unresponsive" + ] + }, + "ActionNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "Device.ConnectionMonitoring.Connection.{i}.Action.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object contains parameters for actions to be taken when a connection failure is detected. Each action can be configured independently and can be enabled or disabled. The Device will perform the specified action when the value of <> equals the value of <> parameter. Multiple actions can be defined for a connection. As failures persist, the <> will continue to increment, which can trigger subsequent actions with higher <> values. The <> counter is reset to zero only after the last action has been executed or when a connectivity test succeeds.", + "uniqueKeys": [ + "Alias", + "AttemptCount" + ], + "access": true, + "array": true, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enables or disables the <> entry.", + "datatype": "boolean" + }, + "AttemptCount": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Indicates the action to be taken when the connections <> is equal to the value of this parameter.", + "default": "5", + "datatype": "unsignedInt", + "range": [ + { + "min": 1, + "max": 100 + } + ] + }, + "Action": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This parameter indicates the action taken by the Device when a connection failure is detected. It can be used to trigger specific actions such as restarting the DHCP client or Interface.", + "datatype": "string", + "enumerations": [ + "None", + "RestartDHCP", + "RestartInterface", + "Reboot" + ] + }, + "Reference": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "This parameter specifies the object path to which the <> applies. When <> is set to <>, this parameter specifies the path to the DHCPv4 Client instance (e.g., `Device.DHCPv4.Client.1`) that should be restarted. If this parameter is <>, the Device will attempt to restart the DHCP client associated with the <> of the parent <> object. When <> is set to <>, this parameter specifies the path to the Interface instance (e.g., `Device.IP.Interface.2` or `Device.Logical.Interface.3`) that should be restarted. If this parameter is <>, the Device will restart the <> of the parent <> object. When <> is set to <> or <>, this parameter is not applicable and its value will be ignored.", + "datatype": "string" + } + }, + "Device.ConnectionMonitoring.Connection.{i}.Stats.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object contains statistics for the connection monitoring entry. It provides counters for connection test failures, total triggered actions.", + "access": false, + "array": false, + "TotalNumberOfAttempts": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of failed attempts when no reply is obtained, since the last boot.", + "datatype": "StatsCounter64" + }, + "TotalTriggeredActions": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Total amount of triggered actions since last boot.", + "datatype": "StatsCounter64" + } + } + } + }, + "Device.WireGuard.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "This object contains configuration and status for the WireGuard subsystem. The WireGuard subsystem is used to create secure tunnels between devices using the WireGuard protocol.", + "access": false, + "array": false, + "TunnelNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "PeerNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "Device.WireGuard.Tunnel.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "WireGuard Tunnel table, models the WireGuard Tunnel instance and represents the entry point and exit point of the tunnel in relation to the WAN interface. A <> object has one or more <> objects that further define the sessions or flows within the tunnel.", + "uniqueKeys": [ + "Alias", + "PrivateKey" + ], + "access": true, + "array": true, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enables or disables the tunnel.", + "datatype": "boolean" + }, + "Status": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The current operational state of the tunnel.", + "datatype": "string", + "enumerations": [ + "Disabled", + "Enabled", + "Error" + ] + }, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "PrivateKey": { + "type": "base64", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The private key for this WireGuard tunnel.", + "datatype": "base64" + }, + "PublicKey": { + "type": "base64", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The public key for this WireGuard tunnel, corresponding to the <>.", + "datatype": "base64" + }, + "ListenPort": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The port on which this WireGuard tunnel will listen for incoming connections. If set to 0, a random port will be chosen by the device.", + "datatype": "unsignedInt", + "range": [ + { + "min": 0, + "max": 65535 + } + ] + }, + "PeerReferences": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Each element represents a reference to the peers associated with this <> entry.", + "list": { + "datatype": "string" + } + }, + "InterfaceNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, + "Device.WireGuard.Tunnel.{i}.Interface.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "WireGuard Interface table (a stackable interface object as described in <>). The <> object provides a way to discriminate how sessions or flows are encapsulated within the WireGuard Tunnel. In addition the <> object represents the entry point and exit point of the tunnel in relation to the LAN interface. Compared to other tunnel protocols, WireGuard does not have a concept of multiple interfaces within a tunnel. Therefore, a WireGuard Tunnel will only have one <> instance.", + "uniqueKeys": [ + "Alias", + "Name" + ], + "access": true, + "array": true, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enables or disables the interface. This parameter is based on ifAdminStatus from <>.", + "default": "false", + "datatype": "boolean" + }, + "Status": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The current operational state of the interface (see <>). Enumeration of: Up, Down, Unknown, Dormant, NotPresent, LowerLayerDown, Error. When <> is <> then <> SHOULD normally be <> (or <> or <> if there is a fault condition on the interface). When <> is changed to <> then <> SHOULD change to <> if and only if the interface is able to transmit and receive network traffic; it SHOULD change to <> if and only if the interface is operable but is waiting for external actions before it can transmit and receive network traffic (and subsequently change to <> if still operable when the expected actions have completed); it SHOULD change to <> if and only if the interface is prevented from entering the <> state because one or more of the interfaces beneath it is down; it SHOULD remain in the <> state if there is an error or other fault condition detected on the interface; it SHOULD remain in the <> state if the interface has missing (typically hardware) components; it SHOULD change to <> if the state of the interface can not be determined for some reason. This parameter is based on ifOperStatus from <>.", + "default": "Down", + "datatype": "string", + "enumerations": [ + "Up", + "Down", + "Unknown", + "Dormant", + "NotPresent", + "LowerLayerDown", + "Error" + ] + }, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "Name": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The textual name of the interface as assigned by the CPE.", + "datatype": "string", + "range": [ + { + "max": 64 + } + ] + }, + "LastChange": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The accumulated time in <> since the interface entered its current operational state.", + "datatype": "unsignedInt", + "unit": "seconds" + }, + "LowerLayers": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "<> <> See <>.", + "default": "[]", + "list": { + "datatype": "string", + "maxsize": 1024 + } + }, + "Device.WireGuard.Tunnel.{i}.Interface.{i}.Stats.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Throughput statistics for this interface. The CPE MUST reset the interfaces Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the interface becomes operationally down due to a previous administrative down (i.e. the interfaces <> parameter transitions to a down state after the interface is disabled) or when the interface becomes administratively up (i.e. the interfaces <> parameter transitions from <> to <>). Administrative and operational interface status is discussed in <>.", + "access": true, + "array": false, + "Reset": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp" + ], + "description": "Set this to <> to reset all this objects statistics counters to zero.", + "datatype": "boolean" + }, + "BytesSent": { + "type": "unsignedLong", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> transmitted out of the interface, including framing characters.", + "datatype": "StatsCounter64" + }, + "BytesReceived": { + "type": "unsignedLong", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> received on the interface, including framing characters.", + "datatype": "StatsCounter64" + }, + "PacketsSent": { + "type": "unsignedLong", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> transmitted out of the interface.", + "datatype": "StatsCounter64" + }, + "PacketsReceived": { + "type": "unsignedLong", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> received on the interface.", + "datatype": "StatsCounter64" + }, + "ErrorsSent": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of outbound <> that could not be transmitted because of errors.", + "datatype": "StatsCounter32" + }, + "ErrorsReceived": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of inbound <> that contained errors preventing them from being delivered to a higher-layer protocol.", + "datatype": "StatsCounter32" + }, + "UnicastPacketsSent": { + "type": "unsignedLong", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> requested for transmission which were not addressed to a multicast or broadcast address at this layer, including those that were discarded or not sent.", + "datatype": "StatsCounter64" + }, + "DiscardPacketsSent": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of outbound <> which were chosen to be discarded even though no errors had been detected to prevent their being transmitted. One possible reason for discarding such a packet could be to free up buffer space.", + "datatype": "StatsCounter32" + }, + "DiscardPacketsReceived": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of inbound <> which were chosen to be discarded even though no errors had been detected to prevent their being delivered. One possible reason for discarding such a packet could be to free up buffer space.", + "datatype": "StatsCounter32" + }, + "MulticastPacketsSent": { + "type": "unsignedLong", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> that higher-level protocols requested for transmission and which were addressed to a multicast address at this layer, including those that were discarded or not sent.", + "datatype": "StatsCounter64" + }, + "UnicastPacketsReceived": { + "type": "unsignedLong", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of received <>, delivered by this layer to a higher layer, which were not addressed to a multicast or broadcast address at this layer.", + "datatype": "StatsCounter64" + }, + "MulticastPacketsReceived": { + "type": "unsignedLong", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of received <>, delivered by this layer to a higher layer, which were addressed to a multicast address at this layer.", + "datatype": "StatsCounter64" + }, + "BroadcastPacketsSent": { + "type": "unsignedLong", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> that higher-level protocols requested for transmission and which were addressed to a broadcast address at this layer, including those that were discarded or not sent. Note that IPv6 does not define broadcast addresses, so IPv6 <> will never cause this counter to increment.", + "datatype": "StatsCounter64" + }, + "BroadcastPacketsReceived": { + "type": "unsignedLong", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of received <>, delivered by this layer to a higher layer, which were addressed to a broadcast address at this layer. Note that IPv6 does not define broadcast addresses, so IPv6 <> will never cause this counter to increment.", + "datatype": "StatsCounter64" + }, + "UnknownProtoPacketsReceived": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> received via the interface which were discarded because of an unknown or unsupported protocol.", + "datatype": "StatsCounter32" + }, + "Reset()": { + "type": "command", + "async": false, + "protocols": [ + "usp" + ] + } + } + }, + "Device.WireGuard.Tunnel.{i}.Stats.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "Statistics for this WireGuard tunnel, i.e. all traffic that has passed through the tunnel. The device MUST reset the tunnels Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the tunnel becomes operationally down due to a previous administrative down (i.e., Status parameter transitions to a disabled state after the tunnel has been disabled) or when the tunnel becomes administratively up (i.e. the Enable parameter transitioned from <> to <>).", + "access": false, + "array": false, + "BytesSent": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> sent by the tunnel.", + "datatype": "StatsCounter64" + }, + "BytesReceived": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> received by the tunnel.", + "datatype": "StatsCounter64" + }, + "PacketsSent": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> sent by the tunnel.", + "datatype": "StatsCounter64" + }, + "PacketsReceived": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> received by the tunnel.", + "datatype": "StatsCounter64" + }, + "ErrorsSent": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> discarded by the tunnel due to any error. This can include packets dropped due to a lack of transmit buffers.", + "datatype": "StatsCounter64" + }, + "ErrorsReceived": { + "type": "unsignedLong", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The total number of <> received by the tunnel that contained errors preventing them from being delivered to a higher-layer protocol.", + "datatype": "StatsCounter64" + } + } + }, + "Device.WireGuard.Peer.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "description": "WireGuard Peer table, an entry in this table represents a WireGuard peer.", + "uniqueKeys": [ + "Alias", + "PublicKey" + ], + "access": true, + "array": true, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Enables or disables this Peer configuration.", + "datatype": "boolean" + }, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value. | A non-volatile handle used to reference this instance. Alias provides a mechanism for an ACS to label this instance for future reference. If the CPE supports the Alias-based Addressing feature as defined in <> and described in <>, the following mandatory constraints MUST be enforced: * Its value MUST NOT be empty. * Its value MUST start with a letter. * If its value is not assigned by the ACS, it MUST start with a cpe- prefix. * The CPE MUST NOT change the parameter value.", + "datatype": "_AliasCWMP" + }, + "PublicKey": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Public key of the peer.", + "datatype": "string" + }, + "PresharedKey": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The pre-shared key for this WireGuard Peer. When <> is provided, no pre-shared key is used.", + "datatype": "string" + }, + "AllowedIPs": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "Each item represents an IPv4/v6 subnets in CIDR notation from which incoming traffic is allowed and to which outgoing traffic is directed for this peer. 0.0.0.0/0 maybe specified for matching all IPv4 addresses and ::/0 for matching all IPv6 addresses. When <> is provided, no traffic is routed to this peer.", + "list": { + "datatype": "IPAddress", + "range": [ + { + "max": 45 + } + ] + } + }, + "EndpointAddress": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The remote network address (IP or hostname) of the peer. <> indicates that the endpoint address is not used.", + "datatype": "string" + }, + "EndpointPort": { + "type": "int", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The UDP port of the remote peer. A value of `-1` indicates that the endpoint port is not used.", + "datatype": "int", + "range": [ + { + "min": -1, + "max": -1 + }, + { + "min": 1, + "max": 65535 + } + ] + }, + "PersistentKeepalive": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "cwmp", + "usp" + ], + "description": "An interval in <> to send an authenticated empty packet to the peer. This is useful for keeping NAT mappings alive. A value of `0` disables this feature.", + "datatype": "unsignedInt", + "range": [ + { + "min": 0, + "max": 65535 + } + ], + "unit": "seconds" + }, + "LastHandshakeTime": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "cwmp", + "usp" + ], + "description": "The amount of time in <> since the last handshake was sent with this peer.", + "datatype": "unsignedInt", + "unit": "seconds" + } + } + }, "Device.GatewayInfo.": { "type": "object", "protocols": [ @@ -132200,7 +138643,7 @@ "protocols": [ "cwmp" ], - "description": "A reference to the Unix Domain Socket used by this Agent when communicating via the UDS MTP.", + "description": "A reference to the Unix Domain Socket used by the Controller when communicating via the UDS MTP.", "datatype": "string" }, "USPServiceRef": { @@ -132527,7 +138970,7 @@ "protocols": [ "cwmp" ], - "description": "The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (`r` for Read, `w` for Write, `x` for Execute, and `n` for Notify). The string is always in the same order (`rwxn`) and the lack of a permission is signified by a `-` character (e.g., `r--n`). The following describes the meaning of the permissions for Instantiated Object type of Targets: # Read: Grants the capability to read the instance numbers and unique keys of the Instantiated Object via GetInstances. # Write: Grants the capability to remove an existing instance of an Instantiated Object via Delete (e.g. Device.LocalAgent.Controller.1.). # Execute: Grants no capabilities; Object Instances are not executable and Commands are controlled by the CommandEventPermissions. # Notify: Grants the capability to receive Notify Messages of type ObjectDeletion for this Instantiated Object.", + "description": "The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (`r` for Read, `w` for Write, `x` for Execute, and `n` for Notify). The string is always in the same order (`rwxn`) and the lack of a permission is signified by a `-` character (e.g., `r--n`). The following describes the meaning of the permissions for Instantiated Object type of Targets: # Read: Grants the capability to read the instance numbers and unique keys of the Instantiated Object via GetInstances, and to read the meta-information of the Object via GetSupportedDM when an Instantiated Data Model Object Path is being used. # Write: Grants the capability to remove an existing instance of an Instantiated Object via Delete (e.g. Device.LocalAgent.Controller.1.). # Execute: Grants no capabilities; Object Instances are not executable and Commands are controlled by the CommandEventPermissions. # Notify: Grants the capability to receive Notify Messages of type ObjectDeletion for this Instantiated Object.", "default": "----", "datatype": "string", "range": [ @@ -134953,7 +141396,7 @@ "protocols": [ "usp" ], - "description": "Each <> instance of this table represents a Threshold Event. <> is monitored to determine if it has met the <> condition against <>, when it meets the condition a <> Event is sent. <> may only reference integer parameters and <> only uses integer values. For example: <>: Device.Ethernet.Interface.[Enable==1].Stats. <>: BytesSent <>: Rise <>: 100000 This would trigger a <> Event whenever a value of a parameter matching Device.Ethernet.Interface.[Enable==1].Stats.BytesSent rises from below to above 100000. When creating a <>, if the <>, <> or <> are invalid (not in the supported Data Model), the object will not be created. If the concatenation of <> and <> reference a parameter that isnt in the instantiated data model, then there will be no <> Event.", + "description": "Each <> instance of this table represents a Threshold Event. <> is monitored to determine if it has met the <> condition against <>, when it meets the condition a <> Event is sent. <> may only reference integer parameters and <> only uses integer values. For example: * <>: Device.Ethernet.Interface.[Enable==1].Stats. * <>: BytesSent * <>: Rise * <>: 100000 This would trigger a <> Event whenever a value of a parameter matching Device.Ethernet.Interface.[Enable==1].Stats.BytesSent rises from below to above 100000. When creating a <>, if the <>, <> or <> are invalid (not in the supported Data Model), the object will not be created. If the concatenation of <> and <> reference a parameter that isnt in the instantiated data model, then there will be no <> Event.", "uniqueKeys": [ "Alias" ], @@ -136015,7 +142458,7 @@ "protocols": [ "usp" ], - "description": "A reference to the Unix Domain Socket used by this Agent when communicating via the UDS MTP.", + "description": "A reference to the Unix Domain Socket used by the Controller when communicating via the UDS MTP.", "datatype": "string" }, "USPServiceRef": { @@ -136624,7 +143067,7 @@ "protocols": [ "usp" ], - "description": "Each instance of this table represents a Role that can be assigned to or inherited by a Controller via the Controller Trust mechanism. The Role contains a set of permissions that determine how the Controller can interact with the data model. If multiple permission entries associated with this table contain a Target that evaluates to the same instantiated Object/Parameter for multiple Roles, then the permissions to be used are a union of the identified permissions.", + "description": "Each instance of this table represents a Role that can be assigned to or inherited by a Controller via the Controller Trust mechanism. The Role contains a set of permissions that determine how the Controller can interact with the data model. If multiple permission entries associated with this table contain a Target that evaluates to the same instantiated Object/Parameter for multiple Roles, then the permissions to be used are a union of the identified permissions. If this object is referenced in <.RequiredRoles>>, then the device MAY reject deletion requests, as it could cause instability to the <.>> referencing the Role.", "uniqueKeys": [ "Name", "Alias" @@ -136770,7 +143213,7 @@ "protocols": [ "usp" ], - "description": "The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (`r` for Read, `w` for Write, `x` for Execute, and `n` for Notify). The string is always in the same order (`rwxn`) and the lack of a permission is signified by a `-` character (e.g., `r--n`). The following describes the meaning of the permissions for Instantiated Object type of Targets: # Read: Grants the capability to read the instance numbers and unique keys of the Instantiated Object via GetInstances. # Write: Grants the capability to remove an existing instance of an Instantiated Object via Delete (e.g. Device.LocalAgent.Controller.1.). # Execute: Grants no capabilities; Object Instances are not executable and Commands are controlled by the CommandEventPermissions. # Notify: Grants the capability to receive Notify Messages of type ObjectDeletion for this Instantiated Object.", + "description": "The permissions of a Role for the specified Targets. A string of 4 characters where each character represents a permission (`r` for Read, `w` for Write, `x` for Execute, and `n` for Notify). The string is always in the same order (`rwxn`) and the lack of a permission is signified by a `-` character (e.g., `r--n`). The following describes the meaning of the permissions for Instantiated Object type of Targets: # Read: Grants the capability to read the instance numbers and unique keys of the Instantiated Object via GetInstances, and to read the meta-information of the Object via GetSupportedDM when an Instantiated Data Model Object Path is being used. # Write: Grants the capability to remove an existing instance of an Instantiated Object via Delete (e.g. Device.LocalAgent.Controller.1.). # Execute: Grants no capabilities; Object Instances are not executable and Commands are controlled by the CommandEventPermissions. # Notify: Grants the capability to receive Notify Messages of type ObjectDeletion for this Instantiated Object.", "default": "----", "datatype": "string", "range": [ @@ -137082,7 +143525,7 @@ "protocols": [ "usp" ], - "description": "Each entry is a name-value pair representing the name of the data model parameter to configure and the value to configure it with. Each entry in the comma-separated list will use the following format: = The Parameter Value will be formatted per the value type, which means that string values will be quoted while unsignedInt values will be unquoted numeric values, etc.. When the monitored event occurs, then the <> will be executed if the <> is set to <> or <>.", + "description": "Each entry is a name-value pair representing the name of the data model parameter to configure and the value to configure it with. Each entry in the comma-separated list will use the following format: <*Parameter Name*>=<*Parameter Value*> The Parameter Value will be formatted per the value type, which means that string values will be quoted while unsignedInt values will be unquoted numeric values, etc.. When the monitored event occurs, then the <> will be executed if the <> is set to <> or <>.", "list": { "datatype": "string", "item": { @@ -137280,16 +143723,18 @@ }, "Device.Standby.": { "type": "object", + "obsolete": true, "protocols": [ "usp" ], - "description": "Capabilities of a Device as it pertains to entering a standby state.", + "description": "Capabilities of a Device as it pertains to entering a standby state. <>>>", "access": false, "array": false, "NetworkAware": { "type": "boolean", "read": true, "write": false, + "obsolete": true, "protocols": [ "usp" ], @@ -137300,6 +143745,7 @@ "type": "boolean", "read": true, "write": false, + "obsolete": true, "protocols": [ "usp" ], @@ -137581,13 +144027,25 @@ "BinaryControl", "LevelControl", "EnumControl", + "PulseControl", "BinarySensor", "LevelSensor", "MultiLevelSensor", "EnumSensor", - "BlobSensor" + "BlobSensor", + "PulseSensor" ] }, + "BindingNumberOfEntries": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "<>", + "datatype": "unsignedInt" + }, "Device.IoTCapability.{i}.BinaryControl.": { "type": "object", "protocols": [ @@ -137720,7 +144178,7 @@ "protocols": [ "usp" ], - "description": "Units in which <>, <>, <>, <> and <> are expressed. Possible Unit types used for decimal values. Enumeration of: -, %, deg, degC, degF, K, km, m, cm, mm, h, min, s, ms, sq-km, sq-m, sq-cm, cu-m, l, cl, ml, kg, g, mg, Wh, kWh, W, A, Hz, V, N, Pa, C, F, ohm, S, Wb, T, H, lm, lx, mps, cd, mol, UV, RGB, ppm, Sv, J, rpm, pps, cu-m/s, liter/s, dB, dBm, eV. | Possible Unit types used for decimal values. Enumeration of: -, %, deg, degC, degF, K, km, m, cm, mm, h, min, s, ms, sq-km, sq-m, sq-cm, cu-m, l, cl, ml, kg, g, mg, Wh, kWh, W, A, Hz, V, N, Pa, C, F, ohm, S, Wb, T, H, lm, lx, mps, cd, mol, UV, RGB, ppm, Sv, J, rpm, pps, cu-m/s, liter/s, dB, dBm, eV. .", + "description": "Units in which <>, <>, <>, <> and <> are expressed. Possible Unit types used for decimal values. | Possible Unit types used for decimal values. .", "datatype": "IoTUnitType", "enumerations": [ "-", @@ -137764,6 +144222,7 @@ "H", "lm", "lx", + "byte", "mps", "cd", "mol", @@ -137778,7 +144237,12 @@ "liter/s", "dB", "dBm", - "eV" + "eV", + "var", + "VA", + "PF", + "dateTime", + "bps" ] }, "MinValue": { @@ -137860,7 +144324,7 @@ "protocols": [ "usp" ], - "description": "Human-readable description of the <>. e.g. a more detailed description of <>.", + "description": "Human-readable description of the <>. For example, a more detailed description of <>.", "datatype": "string", "range": [ { @@ -137910,6 +144374,128 @@ ] } }, + "Device.IoTCapability.{i}.PulseControl.": { + "type": "object", + "protocols": [ + "usp" + ], + "description": "<> provides information to an actuator that sensor changed from one state to another state. In addition to the state change, the <> can provide additional information about the type of transition via <> and the pulse duration via <>.", + "access": false, + "array": false, + "Type": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "Describes the type of pulse that the <> instance is representing. Enumeration of: PushButton, MagneticContact, ElectronicLock, MotionTrigger. | Describes the type of pulse that the <> instance is representing. Enumeration of: PushButton, MagneticContact, ElectronicLock, MotionTrigger.", + "datatype": "IoTPulseType", + "enumerations": [ + "PushButton", + "MagneticContact", + "ElectronicLock", + "MotionTrigger" + ] + }, + "Description": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "Human-readable description of the <>. For example, a more detailed description of <>.", + "datatype": "string", + "range": [ + { + "max": 256 + } + ] + }, + "Duration": { + "type": "unsignedInt", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Some <> instances can provide a duration together with the latest state change. The duration is an indication of the time, measured in <>, between the start of the state change and the end of the state change: i.e., returning to its orignal state. The original state can be a low state or high state.", + "datatype": "unsignedInt", + "range": [ + { + "min": 1 + } + ], + "unit": "milliseconds" + }, + "Transition": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Indicates the moment a pulse is generated. This can be a <> transition: in case the sensor changes from low to high state. <> transition: in case the sensor changes from high to low state.", + "datatype": "string", + "enumerations": [ + "RisingEdge", + "FallingEdge" + ] + }, + "TransitionHigh()": { + "type": "command", + "async": false, + "protocols": [ + "usp" + ], + "input": { + "Duration": { + "type": "unsignedInt", + "read": true, + "write": true, + "mandatory": true, + "protocols": [ + "usp" + ], + "description": "Time between the start of the state change and the return to its original state. <> is measured in <>.", + "datatype": "unsignedInt", + "range": [ + { + "min": 1 + } + ], + "unit": "milliseconds" + } + } + }, + "TransitionLow()": { + "type": "command", + "async": false, + "protocols": [ + "usp" + ], + "input": { + "Duration": { + "type": "unsignedInt", + "read": true, + "write": true, + "mandatory": true, + "protocols": [ + "usp" + ], + "description": "Time between the start of the state change and the return to its original state. <> is measured in <>.", + "datatype": "unsignedInt", + "range": [ + { + "min": 1 + } + ], + "unit": "milliseconds" + } + } + } + }, "Device.IoTCapability.{i}.BinarySensor.": { "type": "object", "protocols": [ @@ -138117,7 +144703,7 @@ "protocols": [ "usp" ], - "description": "Possible Unit types used for decimal values. Enumeration of: -, %, deg, degC, degF, K, km, m, cm, mm, h, min, s, ms, sq-km, sq-m, sq-cm, cu-m, l, cl, ml, kg, g, mg, Wh, kWh, W, A, Hz, V, N, Pa, C, F, ohm, S, Wb, T, H, lm, lx, mps, cd, mol, UV, RGB, ppm, Sv, J, rpm, pps, cu-m/s, liter/s, dB, dBm, eV. | Possible Unit types used for decimal values. Enumeration of: -, %, deg, degC, degF, K, km, m, cm, mm, h, min, s, ms, sq-km, sq-m, sq-cm, cu-m, l, cl, ml, kg, g, mg, Wh, kWh, W, A, Hz, V, N, Pa, C, F, ohm, S, Wb, T, H, lm, lx, mps, cd, mol, UV, RGB, ppm, Sv, J, rpm, pps, cu-m/s, liter/s, dB, dBm, eV. Unit in which <> is expressed.", + "description": "Possible Unit types used for decimal values. | Possible Unit types used for decimal values. Unit in which <> is expressed.", "datatype": "IoTUnitType", "enumerations": [ "-", @@ -138161,6 +144747,7 @@ "H", "lm", "lx", + "byte", "mps", "cd", "mol", @@ -138175,7 +144762,12 @@ "liter/s", "dB", "dBm", - "eV" + "eV", + "var", + "VA", + "PF", + "dateTime", + "bps" ] }, "LowLevel": { @@ -138313,7 +144905,7 @@ "protocols": [ "usp" ], - "description": "Possible Unit types used for decimal values. Enumeration of: -, %, deg, degC, degF, K, km, m, cm, mm, h, min, s, ms, sq-km, sq-m, sq-cm, cu-m, l, cl, ml, kg, g, mg, Wh, kWh, W, A, Hz, V, N, Pa, C, F, ohm, S, Wb, T, H, lm, lx, mps, cd, mol, UV, RGB, ppm, Sv, J, rpm, pps, cu-m/s, liter/s, dB, dBm, eV. | Possible Unit types used for decimal values. Enumeration of: -, %, deg, degC, degF, K, km, m, cm, mm, h, min, s, ms, sq-km, sq-m, sq-cm, cu-m, l, cl, ml, kg, g, mg, Wh, kWh, W, A, Hz, V, N, Pa, C, F, ohm, S, Wb, T, H, lm, lx, mps, cd, mol, UV, RGB, ppm, Sv, J, rpm, pps, cu-m/s, liter/s, dB, dBm, eV. Unit in which <> are expressed.", + "description": "Possible Unit types used for decimal values. | Possible Unit types used for decimal values. Unit in which <> are expressed.", "datatype": "IoTUnitType", "enumerations": [ "-", @@ -138357,6 +144949,7 @@ "H", "lm", "lx", + "byte", "mps", "cd", "mol", @@ -138371,7 +144964,12 @@ "liter/s", "dB", "dBm", - "eV" + "eV", + "var", + "VA", + "PF", + "dateTime", + "bps" ] } }, @@ -138390,7 +144988,7 @@ "protocols": [ "usp" ], - "description": "Describes the type of IoT Enum Sensor that the <> instance is representing. Enumeration of: AlarmState, DoorState, FanState, LockState, OperatingState, TemperatureState, ThermostatFanState. | Describes the type of IoT Enum Sensor that the <> instance is representing. Enumeration of: AlarmState, DoorState, FanState, LockState, OperatingState, TemperatureState, ThermostatFanState.", + "description": "Describes the type of IoT Enum Sensor type the <> instance is representing. | Describes the type of IoT Enum Sensor type the <> instance is representing.", "datatype": "IoTEnumSensorType", "enumerations": [ "AlarmState", @@ -138546,6 +145144,174 @@ "description": "The Value is typically a string of bytes and its meaning is described by <>. A string of bytes will use the base64 type. The current value reading of this <>.", "datatype": "base64" } + }, + "Device.IoTCapability.{i}.Binding.{i}.": { + "type": "object", + "protocols": [ + "usp" + ], + "description": "This <> only exists in a Sensor IoTCapability. Adding a <> instance to a Control IoTCapability MUST fail. Each entry in this table describes the link between this Sensor IoTCapability and a specific Control IoTCapability. When a Sensor IoT Capability is bound to a Control IoT Capability, then for each Value parameter updates of the Sensor IoTCapability, the Agent evaluates the needs to update the Value parameter of the bound Control IoTCapability.", + "uniqueKeys": [ + "Alias" + ], + "access": true, + "array": true, + "Alias": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced: * The value MUST NOT be empty. * The value MUST start with a letter. * If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an cpe- prefix. | A non-volatile unique key used to reference this instance. Alias provides a mechanism for a Controller to label this instance for future reference. The following mandatory constraints MUST be enforced: * The value MUST NOT be empty. * The value MUST start with a letter. * If the value is not assigned by the Controller at creation time, the Agent MUST assign a value with an cpe- prefix.", + "datatype": "_AliasUSP" + }, + "FriendlyName": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Friendly name for this binding.", + "datatype": "string", + "range": [ + { + "max": 64 + } + ] + }, + "Description": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "Description of the bindings intent and function.", + "datatype": "string", + "range": [ + { + "max": 256 + } + ] + }, + "Enable": { + "type": "boolean", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "When <>, the binding is active; otherwise, no data flow occurs and the Value parameter of <> is not updated.", + "datatype": "boolean" + }, + "ControlIoTCapability": { + "type": "string", + "read": true, + "write": true, + "protocols": [ + "usp" + ], + "description": "A valid <> is a reference to a Control IoTCapability in the <> table. Setting <> to a Sensor IoTCapability MUST fail. It references the Control IoTCapability to use as the binding destination on which the Agent updates the Value parameter. As a mountable object <> may also be mounted on one of the following mountpoints: * <.>>, * <.>>, * <.Node..>>", + "datatype": "string" + } + }, + "Device.IoTCapability.{i}.PulseSensor.": { + "type": "object", + "protocols": [ + "usp" + ], + "description": "A <> is used to reflect the functionality of a sensor that changed state from low to high or high to low. A <> provides a trigger on the rising edge of this state change, which is identified by <>. Some <> instances have the possibility to provide a pulse duration <> together with the latest state change.", + "access": false, + "array": false, + "Type": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "Describes the type of pulse that the <> instance is representing. Enumeration of: PushButton, MagneticContact, ElectronicLock, MotionTrigger. | Describes the type of pulse that the <> instance is representing. Enumeration of: PushButton, MagneticContact, ElectronicLock, MotionTrigger.", + "datatype": "IoTPulseType", + "enumerations": [ + "PushButton", + "MagneticContact", + "ElectronicLock", + "MotionTrigger" + ] + }, + "Description": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "Human-readable description of the <>. For example, a more detailed description of <>.", + "datatype": "string", + "range": [ + { + "max": 256 + } + ] + }, + "LastChange": { + "type": "dateTime", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "The date and time in UTC when <> or <>has been changed to the current value.", + "datatype": "dateTime" + }, + "LastContactTime": { + "type": "dateTime", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "The date and time in UTC when the <> has received data.", + "datatype": "dateTime" + }, + "Duration": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "Some <> instances can provide a duration together with the latest state change. The duration is an indication of the time, measured in <>, between the start of the state change and the end of the state change: i.e., returning to its orignal state. The original state can be a low state or high state.", + "datatype": "unsignedInt", + "unit": "milliseconds" + }, + "Unit": { + "type": "unsignedInt", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "Unit in which <> is expressed in <>.", + "datatype": "unsignedInt", + "unit": "milliseconds" + }, + "Transition": { + "type": "string", + "read": true, + "write": false, + "protocols": [ + "usp" + ], + "description": "Indicates the moment a pulse is generated. This can be a <> transition: in case the sensor changes from low to high state. <> transition: in case the sensor changes from high to low state.", + "datatype": "string", + "enumerations": [ + "RisingEdge", + "FallingEdge" + ] + } } }, "Device.Node.{i}.": {