From e6f6d8aa4a2d27b274031d4852853360d94ef381 Mon Sep 17 00:00:00 2001 From: Amin Ben Ramdhane Date: Thu, 24 Oct 2019 11:46:26 +0100 Subject: [PATCH] upgrade the data models used to version 2.13 --- dmtree/tr181/datamodelversion.c | 2 +- json/convertor_json_to_c.py | 4 +- json/tr181.json | 3993 +++++- tools/generate_xml_bbf.sh | 8 +- tools/generator_c.py | 10 +- tools/generator_json.py | 10 +- tools/generator_json_with_backend.py | 4 +- ...p-full.xml => tr-181-2-13-0-cwmp-full.xml} | 4974 +++++-- ...sp-full.xml => tr-181-2-13-0-usp-full.xml} | 11220 +++++++++++----- 9 files changed, 15788 insertions(+), 4437 deletions(-) rename tools/{tr-181-2-12-0-cwmp-full.xml => tr-181-2-13-0-cwmp-full.xml} (93%) rename tools/{tr-181-2-12-0-usp-full.xml => tr-181-2-13-0-usp-full.xml} (91%) diff --git a/dmtree/tr181/datamodelversion.c b/dmtree/tr181/datamodelversion.c index 3b17bc1f..69d7aa90 100644 --- a/dmtree/tr181/datamodelversion.c +++ b/dmtree/tr181/datamodelversion.c @@ -12,6 +12,6 @@ int get_Device_RootDataModelVersion(char *refparam, struct dmctx *ctx, void *data, char *instance, char **value) { - *value= "2.12"; + *value= "2.13"; return 0; } diff --git a/json/convertor_json_to_c.py b/json/convertor_json_to_c.py index 92753d8c..49b71e9a 100755 --- a/json/convertor_json_to_c.py +++ b/json/convertor_json_to_c.py @@ -174,7 +174,7 @@ def printheaderObjCommon( objname ): def cprintheaderOBJS( objname ): fp = open('./.objparamarray.c', 'a') print >> fp, "DMOBJ %s[] = {" % ("t" + getname(objname) + "Obj") - print >> fp, "/* OBJ, permission, addobj, delobj, checkobj, browseinstobj, forced_inform, notification, nextobj, leaf, linker, bbfdm_type*/" + print >> fp, "/* OBJ, permission, addobj, delobj, checkobj, browseinstobj, forced_inform, notification, nextjsonobj, nextobj, leaf, linker, bbfdm_type*/" fp.close() def hprintheaderOBJS( objname ): @@ -578,7 +578,7 @@ def printOBJline( dmobject, value ): paramarray = "NULL" fp = open('./.objparamarray.c', 'a') - print >> fp, "{\"%s\", %s, %s, %s, NULL, %s, NULL, NULL, %s, %s, NULL, %s}," % (getlastname(dmobject), access, faddobj, fdelobj, fbrowse, objchildarray, paramarray, bbfdm) + print >> fp, "{\"%s\", %s, %s, %s, NULL, %s, NULL, NULL, NULL, %s, %s, NULL, %s}," % (getlastname(dmobject), access, faddobj, fdelobj, fbrowse, objchildarray, paramarray, bbfdm) fp.close() def printusage(): diff --git a/json/tr181.json b/json/tr181.json index c7b19f24..9f77d45f 100644 --- a/json/tr181.json +++ b/json/tr181.json @@ -33,6 +33,22 @@ "read": true, "write": false }, + "IoTCapabilityNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "NodeNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, "Device.Services.": { "type": "object", "protocols": [ @@ -958,6 +974,7 @@ "values": [ "", "CWMP", + "USP", "OMA-DM", "SNMP", "UPnP", @@ -9250,6 +9267,413 @@ "read": true, "write": false } + }, + "Device.DSL.Diagnostics.SELTUER.": { + "type": "object", + "protocols": [ + "cwmp" + ], + "access": false, + "array": false, + "DiagnosticsState": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "Interface": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "UERMaxMeasurementDuration": { + "type": "unsignedInt", + "protocols": [ + "cwmp" + ], + "range": { + "min": "5", + "max": "240" + }, + "unit": "seconds", + "read": true, + "write": true + }, + "ExtendedBandwidthOperation": { + "type": "boolean", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + }, + "UER": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + }, + "UERScaleFactor": { + "type": "unsignedInt", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + }, + "UERGroupSize": { + "type": "unsignedInt", + "protocols": [ + "cwmp" + ], + "range": { + "min": "1", + "max": "2" + }, + "unit": "subcarriers", + "read": true, + "write": false + }, + "UERVar": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + } + }, + "Device.DSL.Diagnostics.SELTQLN.": { + "type": "object", + "protocols": [ + "cwmp" + ], + "access": false, + "array": false, + "DiagnosticsState": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "Interface": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "QLNMaxMeasurementDuration": { + "type": "unsignedInt", + "protocols": [ + "cwmp" + ], + "range": { + "min": "1", + "max": "240" + }, + "unit": "seconds", + "read": true, + "write": true + }, + "ExtendedBandwidthOperation": { + "type": "boolean", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + }, + "QLN": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + }, + "QLNGroupSize": { + "type": "unsignedInt", + "protocols": [ + "cwmp" + ], + "range": { + "min": "1", + "max": "2" + }, + "unit": "subcarriers", + "read": true, + "write": false + } + }, + "Device.DSL.Diagnostics.SELTP.": { + "type": "object", + "protocols": [ + "cwmp" + ], + "access": false, + "array": false, + "DiagnosticsState": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "Interface": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "CapacityEstimateEnabling": { + "type": "boolean", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "CapacitySignalPSD": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "CapacityNoisePSD": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "CapacityTargetMargin": { + "type": "unsignedInt", + "protocols": [ + "cwmp" + ], + "range": { + "min": "0", + "max": "310" + }, + "unit": "0.1 dB", + "read": true, + "write": true + }, + "LoopTermination": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + }, + "LoopLength": { + "type": "unsignedInt", + "protocols": [ + "cwmp" + ], + "range": { + "min": "0", + "max": "16383" + }, + "unit": "meters", + "read": true, + "write": false + }, + "LoopTopology": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + }, + "AttenuationCharacteristics": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + }, + "MissingFilter": { + "type": "boolean", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + }, + "CapacityEstimate": { + "type": "unsignedInt", + "protocols": [ + "cwmp" + ], + "unit": "kbit/s", + "read": true, + "write": false + } + } + } + }, + "Device.PacketCaptureDiagnostics.": { + "type": "object", + "protocols": [ + "cwmp" + ], + "access": false, + "array": false, + "DiagnosticsState": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "PacketCaptureResultNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + }, + "Interface": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "Format": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false, + "values": [ + "libpcap", + "pcapng" + ] + }, + "Duration": { + "type": "unsignedInt", + "protocols": [ + "cwmp" + ], + "range": { + "min": "1" + }, + "unit": "seconds", + "read": true, + "write": true + }, + "PacketCount": { + "type": "unsignedInt", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "ByteCount": { + "type": "unsignedInt", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "FileTarget": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "FilterExpression": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "Username": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "Password": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "Device.PacketCaptureDiagnostics.PacketCaptureResult.{i}.": { + "type": "object", + "protocols": [ + "cwmp" + ], + "access": false, + "array": true, + "FileLocation": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + }, + "StartTime": { + "type": "dateTime", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + }, + "EndTime": { + "type": "dateTime", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false + }, + "Count": { + "type": "unsignedInt", + "protocols": [ + "cwmp" + ], + "read": true, + "write": false } } }, @@ -12271,6 +12695,15 @@ ], "access": false, "array": false, + "WoLSupported": { + "type": "boolean", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, "InterfaceNumberOfEntries": { "type": "unsignedInt", "protocols": [ @@ -13720,6 +14153,39 @@ "write": false } }, + "Device.Ethernet.WoL.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": false, + "SendMagicPacket": { + "type": "boolean", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "MACAddress": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "Password": { + "type": "string", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + } + }, "Device.Ethernet.LAG.{i}.": { "type": "object", "protocols": [ @@ -17703,76 +18169,6 @@ ], "read": true, "write": true - }, - "Interface": { - "type": "string", - "protocols": [ - "cwmp" - ], - "read": true, - "write": true - }, - "DiagnoseMACAddress": { - "type": "string", - "protocols": [ - "cwmp" - ], - "read": true, - "write": true - }, - "PHYThroughputResultNumberOfEntries": { - "type": "unsignedInt", - "protocols": [ - "cwmp" - ], - "read": true, - "write": false - }, - "Device.Ghn.Diagnostics.PHYThroughput.Result.{i}.": { - "type": "object", - "protocols": [ - "cwmp" - ], - "access": false, - "array": true, - "DestinationMACAddress": { - "type": "string", - "protocols": [ - "cwmp" - ], - "read": true, - "write": false - }, - "LinkState": { - "type": "string", - "protocols": [ - "cwmp" - ], - "read": true, - "write": false, - "values": [ - "Direct", - "NonDirect" - ] - }, - "TxPhyRate": { - "type": "unsignedInt", - "protocols": [ - "cwmp" - ], - "unit": "Mbps", - "read": true, - "write": false - }, - "RxPhyRate": { - "type": "unsignedInt", - "protocols": [ - "cwmp" - ], - "unit": "Mbps", - "read": true, - "write": false - } } }, "Device.Ghn.Diagnostics.PerformanceMonitoring.": { @@ -19339,6 +19735,2038 @@ "read": true, "write": true }, + "Device.WiFi.MultiAP.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": false, + "APDeviceNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.MultiAP.SteeringSummaryStats.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": false, + "NoCandidateAPFailures": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BlacklistAttempts": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BlacklistSuccesses": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BlacklistFailures": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BTMAttempts": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BTMSuccesses": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BTMFailures": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BTMQueryResponses": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + } + }, + "Device.WiFi.MultiAP.APDevice.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "MACAddress": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Manufacturer": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "ManufacturerOUI": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "ProductClass": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "SerialNumber": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "SoftwareVersion": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "LastContactTime": { + "type": "dateTime", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "AssocIEEE1905DeviceRef": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BackhaulLinkType": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false, + "values": [ + "None", + "Wi-Fi", + "MoCA", + "Ethernet", + "G.hn", + "HPNA", + "HomePlug", + "UPA" + ] + }, + "BackhaulMACAddress": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BackhaulBytesSent": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BackhaulBytesReceived": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BackhaulLinkUtilization": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "100" + }, + "unit": "%", + "read": true, + "write": false + }, + "BackhaulSignalStrength": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "unit": "dBm", + "read": true, + "write": false + }, + "RadioNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "MACAddress": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "OperatingFrequencyBand": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false, + "values": [ + "2.4GHz", + "5GHz" + ] + }, + "OperatingStandards": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false, + "values": [ + "a", + "b", + "g", + "n", + "ac", + "ax" + ] + }, + "Channel": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "1", + "max": "255" + }, + "read": true, + "write": false + }, + "ExtensionChannel": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false, + "values": [ + "None", + "AboveControlChannel", + "BelowControlChannel" + ] + }, + "CurrentOperatingChannelBandwidth": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false, + "values": [ + "20MHz", + "40MHz", + "80MHz", + "160MHz" + ] + }, + "MCS": { + "type": "int", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "0", + "max": "15" + }, + "read": true, + "write": false + }, + "TransmitPower": { + "type": "int", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "-1", + "max": "100" + }, + "unit": "percentage", + "read": true, + "write": false + }, + "APNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "BSSID": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "SSID": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BlacklistAttempts": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BTMAttempts": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BTMQueryResponses": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "AssociatedDeviceNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "MACAddress": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "OperatingStandard": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false, + "values": [ + "a", + "b", + "g", + "n", + "ac", + "ax" + ] + }, + "Active": { + "type": "boolean", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "AssociationTime": { + "type": "dateTime", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "LastDataDownlinkRate": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "kbps", + "read": true, + "write": false + }, + "LastDataUplinkRate": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "kbps", + "read": true, + "write": false + }, + "SignalStrength": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "unit": "dBm", + "read": true, + "write": false + }, + "Noise": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "read": true, + "write": false + }, + "SteeringHistoryNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.Stats.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": false, + "BytesSent": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BytesReceived": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "PacketsSent": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "PacketsReceived": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "ErrorsSent": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "ErrorsReceived": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "RetransCount": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + } + }, + "Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.SteeringSummaryStats.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": false, + "NoCandidateAPFailures": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BlacklistAttempts": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BlacklistSuccesses": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BlacklistFailures": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BTMAttempts": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BTMSuccesses": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BTMFailures": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BTMQueryResponses": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "LastSteerTime": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "seconds", + "read": true, + "write": false + } + }, + "Device.WiFi.MultiAP.APDevice.{i}.Radio.{i}.AP.{i}.AssociatedDevice.{i}.SteeringHistory.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "Time": { + "type": "dateTime", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "APOrigin": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "TriggerEvent": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false, + "values": [ + "Unknown", + "Wi-Fi Channel Utilization", + "Wi-Fi Link Quality", + "Backhaul Link Utilization" + ] + }, + "SteeringApproach": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false, + "values": [ + "Blacklist", + "BTM Request", + "Async BTM Query" + ] + }, + "APDestination": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "SteeringDuration": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "seconds", + "read": true, + "write": false + } + } + } + } + } + } + }, + "Device.WiFi.DataElements.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": false, + "Device.WiFi.DataElements.Network.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": false, + "ID": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "TimeStamp": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "ControllerID": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "DeviceNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.DataElements.Network.Device.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "ID": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "MultiAPCapabilities": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "CollectionInterval": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "milliseconds", + "read": true, + "write": false + }, + "RadioNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "ID": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Enabled": { + "type": "boolean", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Noise": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "read": true, + "write": false + }, + "Utilization": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "0", + "max": "255" + }, + "read": true, + "write": false + }, + "Transmit": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "0", + "max": "255" + }, + "read": true, + "write": false + }, + "ReceiveSelf": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "read": true, + "write": false + }, + "ReceiveOther": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "0", + "max": "255" + }, + "read": true, + "write": false + }, + "CurrentOperatingClassProfileNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "UnassociatedSTANumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BSSNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "ScanResultNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BackhaulSta.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": false, + "MACAddress": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + } + }, + "Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": false, + "HTCapabilities": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "VHTCapabilities": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "HECapabilities": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "CapableOperatingClassProfileNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.Capabilities.CapableOperatingClassProfile.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "Class": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "read": true, + "write": false + }, + "MaxTxPower": { + "type": "int", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "-127", + "max": "127" + }, + "unit": "dBm", + "read": true, + "write": false + }, + "NonOperable": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "read": true, + "write": false + }, + "NumberOfNonOperChan": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + } + } + }, + "Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.CurrentOperatingClassProfile.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "Class": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "read": true, + "write": false + }, + "Channel": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "read": true, + "write": false + }, + "TxPower": { + "type": "int", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "-127", + "max": "127" + }, + "unit": "dBm", + "read": true, + "write": false + }, + "TimeStamp": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + } + }, + "Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "BSSID": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "SSID": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Enabled": { + "type": "boolean", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "LastChange": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "seconds", + "read": true, + "write": false + }, + "TimeStamp": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "UnicastBytesSent": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "UnicastBytesReceived": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "MulticastBytesSent": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "MulticastBytesReceived": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BroadcastBytesSent": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BroadcastBytesReceived": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "EstServiceParametersBE": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "EstServiceParametersBK": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "EstServiceParametersVI": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "EstServiceParametersVO": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "STANumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.STA.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "MACAddress": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "TimeStamp": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "HTCapabilities": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "VHTCapabilities": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "HECapabilities": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "LastDataDownlinkRate": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "kbps", + "read": true, + "write": false + }, + "LastDataUplinkRate": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "kbps", + "read": true, + "write": false + }, + "UtilizationReceive": { + "type": "unsignedLong", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "milliseconds", + "read": true, + "write": false + }, + "UtilizationTransmit": { + "type": "unsignedLong", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "milliseconds", + "read": true, + "write": false + }, + "EstMACDataRateDownlink": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "Mbps", + "read": true, + "write": false + }, + "EstMACDataRateUplink": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "Mbps", + "read": true, + "write": false + }, + "SignalStrength": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "unit": "dBm", + "read": true, + "write": false + }, + "LastConnectTime": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "seconds", + "read": true, + "write": false + }, + "BytesSent": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BytesReceived": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "PacketsSent": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "PacketsReceived": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "ErrorsSent": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "ErrorsReceived": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "RetransCount": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "MeasurementReport": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "NumberOfMeasureReports": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "IPV4Address": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "IPV6Address": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Hostname": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + } + } + }, + "Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "TimeStamp": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "OpClassScanNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "OperatingClass": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "read": true, + "write": false + }, + "ChannelScanNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "Channel": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "read": true, + "write": false + }, + "TimeStamp": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Utilization": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "read": true, + "write": false + }, + "Noise": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "read": true, + "write": false + }, + "NeighborBSSNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.{i}.OpClassScan.{i}.ChannelScan.{i}.NeighborBSS.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "BSSID": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "SSID": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "SignalStrength": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "unit": "dBm", + "read": true, + "write": false + }, + "ChannelBandwidth": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "ChannelUtilization": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "read": true, + "write": false + }, + "StationCount": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + } + } + } + } + }, + "Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.UnassociatedSTA.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "MACAddress": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "SignalStrength": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "255" + }, + "unit": "dBm", + "read": true, + "write": false + } + } + } + } + }, + "Device.WiFi.DataElements.AssociationEvent.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": false, + "AssociationEventDataNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.DataElements.AssociationEvent.AssociationEventData.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "BSSID": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "MACAddress": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "StatusCode": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "HTCapabilities": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "VHTCapabilities": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "HECapabilities": { + "type": "base64", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "TimeStamp": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + } + } + }, + "Device.WiFi.DataElements.DisassociationEvent.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": false, + "DisassociationEventDataNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "Device.WiFi.DataElements.DisassociationEvent.DisassociationEventData.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": false, + "array": true, + "BSSID": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "MACAddress": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "ReasonCode": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BytesSent": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "BytesReceived": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "PacketsSent": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "PacketsReceived": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "ErrorsSent": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "ErrorsReceived": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "RetransCount": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, + "TimeStamp": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + } + } + } + }, "Device.WiFi.Radio.{i}.": { "type": "object", "protocols": [ @@ -19529,7 +21957,8 @@ "b", "g", "n", - "ac" + "ac", + "ax" ], "mapping": [ { @@ -19782,6 +22211,7 @@ "40MHz", "80MHz", "160MHz", + "80+80MHz", "Auto" ], "mapping": [ @@ -19843,7 +22273,8 @@ "20MHz", "40MHz", "80MHz", - "160MHz" + "160MHz", + "80+80MHz" ], "mapping": [ { @@ -19882,9 +22313,29 @@ "values": [ "400nsec", "800nsec", + "1600nsec", + "3200nsec", "Auto" ] }, + "CenterFrequencySegement0": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "CenterFrequencySegement1": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, "MCS": { "type": "int", "protocols": [ @@ -20621,7 +23072,10 @@ "WPA-WPA2", "WPA-Enterprise", "WPA2-Enterprise", - "WPA-WPA2-Enterprise" + "WPA-WPA2-Enterprise", + "WPA3-SAE", + "WPA2-PSK-WPA3-SAE", + "WPA3-Enterprise" ] }, "EncryptionMode": { @@ -20660,7 +23114,8 @@ "b", "g", "n", - "ac" + "ac", + "ax" ] }, "OperatingStandards": { @@ -21511,9 +23966,12 @@ "WEP-128", "WPA-Personal", "WPA2-Personal", + "WPA3-Personal", "WPA-WPA2-Personal", + "WPA3-Personal-Transition", "WPA-Enterprise", "WPA2-Enterprise", + "WPA3-Enterprise", "WPA-WPA2-Enterprise" ] }, @@ -21578,6 +24036,15 @@ } ] }, + "SAEPassphrase": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, "RadiusServerIPAddr": { "type": "string", "protocols": [ @@ -21860,7 +24327,8 @@ "b", "g", "n", - "ac" + "ac", + "ax" ] }, "AuthenticationState": { @@ -22600,9 +25068,12 @@ "WEP-128", "WPA-Personal", "WPA2-Personal", + "WPA3-Personal", "WPA-WPA2-Personal", + "WPA3-Personal-Transition", "WPA-Enterprise", "WPA2-Enterprise", + "WPA3-Enterprise", "WPA-WPA2-Enterprise" ] } @@ -22737,6 +25208,15 @@ "read": true, "write": true }, + "SAEPassphrase": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, "MFPConfig": { "type": "string", "protocols": [ @@ -34527,12 +37007,24 @@ "read": true, "write": true }, + "DADTransmits": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, "RetransTimer": { "type": "unsignedInt", "protocols": [ "cwmp", "usp" ], + "range": { + "min": "1" + }, "unit": "milliseconds", "read": true, "write": true @@ -34543,6 +37035,9 @@ "cwmp", "usp" ], + "range": { + "min": "4000" + }, "unit": "milliseconds", "read": true, "write": true @@ -37379,6 +39874,25 @@ "read": true, "write": false }, + "InterfaceType": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false, + "values": [ + "Ethernet", + "G.hn", + "HPNA", + "HomePlug", + "MoCA", + "UPA", + "Wi-Fi", + "Other" + ] + }, "VendorClassID": { "type": "string", "protocols": [ @@ -38327,6 +40841,32 @@ ], "read": true, "write": true + }, + "TCPTranslationTimeout": { + "type": "int", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "-1" + }, + "unit": "seconds", + "read": true, + "write": true + }, + "UDPTranslationTimeout": { + "type": "int", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "-1" + }, + "unit": "seconds", + "read": true, + "write": true } }, "Device.NAT.PortMapping.{i}.": { @@ -40159,6 +42699,20 @@ "read": true, "write": true }, + "AllowedDevices": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true, + "values": [ + "All", + "Known", + "Unknown" + ] + }, "MinAddress": { "type": "string", "protocols": [ @@ -49316,6 +51870,15 @@ "read": true, "write": false }, + "AssocWiFiNetworkDeviceRef": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, "VendorPropertiesNumberOfEntries": { "type": "unsignedInt", "protocols": [ @@ -50012,7 +52575,8 @@ "write": false, "values": [ "3.1", - "3.1.1" + "3.1.1", + "5.0" ] }, "TransportProtocolSupported": { @@ -50109,42 +52673,6 @@ "Error" ] }, - "ClientID": { - "type": "string", - "protocols": [ - "cwmp", - "usp" - ], - "read": true, - "write": true - }, - "Username": { - "type": "string", - "protocols": [ - "cwmp", - "usp" - ], - "read": true, - "write": true - }, - "Password": { - "type": "string", - "protocols": [ - "cwmp", - "usp" - ], - "read": true, - "write": true - }, - "TransportProtocol": { - "type": "string", - "protocols": [ - "cwmp", - "usp" - ], - "read": true, - "write": true - }, "ProtocolVersion": { "type": "string", "protocols": [ @@ -50154,62 +52682,6 @@ "read": true, "write": true }, - "CleanSession": { - "type": "boolean", - "protocols": [ - "cwmp", - "usp" - ], - "read": true, - "write": true - }, - "MessageRetryTime": { - "type": "unsignedInt", - "protocols": [ - "cwmp", - "usp" - ], - "range": { - "min": "1" - }, - "unit": "seconds", - "read": true, - "write": true - }, - "ConnectRetryTime": { - "type": "unsignedInt", - "protocols": [ - "cwmp", - "usp" - ], - "range": { - "min": "1" - }, - "unit": "seconds", - "read": true, - "write": true - }, - "KeepAliveTime": { - "type": "unsignedInt", - "protocols": [ - "cwmp", - "usp" - ], - "range": { - "max": "65535" - }, - "unit": "seconds", - "read": true, - "write": true - }, - "ForceReconnect": { - "type": "boolean", - "protocols": [ - "cwmp" - ], - "read": true, - "write": true - }, "BrokerAddress": { "type": "string", "protocols": [ @@ -50232,7 +52704,16 @@ "read": true, "write": true }, - "WillEnable": { + "TransportProtocol": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "CleanSession": { "type": "boolean", "protocols": [ "cwmp", @@ -50241,8 +52722,8 @@ "read": true, "write": true }, - "WillTopic": { - "type": "string", + "CleanStart": { + "type": "boolean", "protocols": [ "cwmp", "usp" @@ -50250,8 +52731,8 @@ "read": true, "write": true }, - "WillValue": { - "type": "string", + "WillEnable": { + "type": "boolean", "protocols": [ "cwmp", "usp" @@ -50281,6 +52762,249 @@ "read": true, "write": true }, + "KeepAliveTime": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "65535" + }, + "unit": "seconds", + "read": true, + "write": true + }, + "ForceReconnect": { + "type": "boolean", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, + "SessionExpiryInterval": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "seconds", + "read": true, + "write": true + }, + "ReceiveMaximum": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "MaximumPacketSize": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "byte", + "read": true, + "write": true + }, + "TopicAliasMaximum": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "65535" + }, + "read": true, + "write": true + }, + "RequestResponseInfo": { + "type": "boolean", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "RequestProblemInfo": { + "type": "boolean", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "AuthenticationMethod": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "ClientID": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "WillDelayInterval": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "seconds", + "read": true, + "write": true + }, + "WillMessageExpiryInterval": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "seconds", + "read": true, + "write": true + }, + "WillContentType": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "WillResponseTopic": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "WillTopic": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "WillValue": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "Username": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "Password": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "PublishMessageExpiryInterval": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "unit": "seconds", + "read": true, + "write": true + }, + "MessageRetryTime": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "1" + }, + "unit": "seconds", + "read": true, + "write": true + }, + "ConnectRetryTime": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "1" + }, + "unit": "seconds", + "read": true, + "write": true + }, + "ConnectRetryIntervalMultiplier": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "1000", + "max": "65535" + }, + "read": true, + "write": true + }, + "ConnectRetryMaxInterval": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "min": "1" + }, + "unit": "seconds", + "read": true, + "write": true + }, + "ResponseInformation": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, "SubscriptionNumberOfEntries": { "type": "unsignedInt", "protocols": [ @@ -50290,6 +53014,15 @@ "read": true, "write": false }, + "UserPropertyNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": false + }, "Device.MQTT.Client.{i}.Subscription.{i}.": { "type": "object", "protocols": [ @@ -50355,6 +53088,73 @@ "write": true } }, + "Device.MQTT.Client.{i}.UserProperty.{i}.": { + "type": "object", + "protocols": [ + "cwmp", + "usp" + ], + "access": true, + "array": true, + "Alias": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "Enable": { + "type": "boolean", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "Name": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "Value": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "PacketType": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true, + "values": [ + "AUTH", + "CONNECT", + "DISCONNECT", + "PUBLISH", + "PUBACK", + "PUBREC", + "PUBREL", + "PUBCOMP", + "SUBSCRIBE", + "UNSUBSCRIBE", + "WILL" + ] + } + }, "Device.MQTT.Client.{i}.Stats.": { "type": "object", "protocols": [ @@ -50616,6 +53416,63 @@ "Error" ] }, + "ProtocolVersion": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "TransportProtocol": { + "type": "string", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "CleanSession": { + "type": "boolean", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "CleanStart": { + "type": "boolean", + "protocols": [ + "cwmp", + "usp" + ], + "read": true, + "write": true + }, + "KeepAliveTime": { + "type": "unsignedInt", + "protocols": [ + "cwmp", + "usp" + ], + "range": { + "max": "65535" + }, + "unit": "seconds", + "read": true, + "write": true + }, + "ForceReconnect": { + "type": "boolean", + "protocols": [ + "cwmp" + ], + "read": true, + "write": true + }, "ClientID": { "type": "string", "protocols": [ @@ -50643,33 +53500,6 @@ "read": true, "write": true }, - "TransportProtocol": { - "type": "string", - "protocols": [ - "cwmp", - "usp" - ], - "read": true, - "write": true - }, - "ProtocolVersion": { - "type": "string", - "protocols": [ - "cwmp", - "usp" - ], - "read": true, - "write": true - }, - "CleanSession": { - "type": "boolean", - "protocols": [ - "cwmp", - "usp" - ], - "read": true, - "write": true - }, "MessageRetryTime": { "type": "unsignedInt", "protocols": [ @@ -50696,27 +53526,6 @@ "read": true, "write": true }, - "KeepAliveTime": { - "type": "unsignedInt", - "protocols": [ - "cwmp", - "usp" - ], - "range": { - "max": "65535" - }, - "unit": "seconds", - "read": true, - "write": true - }, - "ForceReconnect": { - "type": "boolean", - "protocols": [ - "cwmp" - ], - "read": true, - "write": true - }, "ServerSelectionAlgorithm": { "type": "string", "protocols": [ @@ -53511,7 +56320,8 @@ "values": [ "CoAP", "WebSocket", - "STOMP" + "STOMP", + "MQTT" ] }, "SupportedFingerprintAlgorithms": { @@ -53529,6 +56339,21 @@ "SHA-512" ] }, + "SupportedThresholdOperator": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false, + "values": [ + "Rise", + "Fall", + "Cross", + "Eq", + "NotEq" + ] + }, "AdvertisedDeviceSubtypes": { "type": "string", "protocols": [ @@ -53557,6 +56382,14 @@ "read": true, "write": false }, + "ThresholdNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, "ControllerNumberOfEntries": { "type": "unsignedInt", "protocols": [ @@ -53760,6 +56593,118 @@ "read": true, "write": true } + }, + "Device.LocalAgent.MTP.{i}.MQTT.": { + "type": "object", + "protocols": [ + "usp" + ], + "access": false, + "array": false, + "Reference": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "ResponseTopicConfigured": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "ResponseTopicDiscovered": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "PublishQoS ": { + "type": "unsignedInt", + "protocols": [ + "usp" + ], + "range": { + "min": "0", + "max": "2" + }, + "read": true, + "write": true + } + } + }, + "Device.LocalAgent.Threshold.{i}.": { + "type": "object", + "protocols": [ + "usp" + ], + "access": true, + "array": true, + "Alias": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "Enable": { + "type": "boolean", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "OperatingMode": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true, + "values": [ + "Normal", + "Single" + ] + }, + "ReferencePath": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "ThresholdParam": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "ThresholdOperator": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "ThresholdValue": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true } }, "Device.LocalAgent.Controller.{i}.": { @@ -54081,6 +57026,30 @@ "read": true, "write": true } + }, + "Device.LocalAgent.Controller.{i}.MTP.{i}.MQTT.": { + "type": "object", + "protocols": [ + "usp" + ], + "access": false, + "array": false, + "Reference": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "Topic": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + } } }, "Device.LocalAgent.Controller.{i}.TransferCompletePolicy.": { @@ -55011,6 +57980,586 @@ ], "read": true, "write": true + }, + "Type": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Description": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Name": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "Online": { + "type": "boolean", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "LastTimeContacted": { + "type": "dateTime", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "InterfaceReference": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "ProxyProtocol": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false, + "values": [ + "Z-Wave", + "ZigBee", + "UPnP-DM" + ] + }, + "NodeNumberOfEntries": { + "type": "unsignedInt", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Device.ProxiedDevice.{i}.Node.{i}.": { + "type": "object", + "protocols": [ + "usp" + ], + "access": false, + "array": true, + "Alias": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "Type": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Description": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + } + } + }, + "Device.IoTCapability.{i}.": { + "type": "object", + "protocols": [ + "usp" + ], + "access": false, + "array": true, + "Alias": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "Name": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "Class": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false, + "values": [ + "BinaryControl", + "LevelControl", + "EnumControl", + "BinarySensor", + "LevelSensor", + "MultiLevelSensor", + "EnumSensor" + ] + }, + "Device.IoTCapability.{i}.BinaryControl.": { + "type": "object", + "protocols": [ + "usp" + ], + "access": false, + "array": false, + "Type": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false, + "values": [ + "Switch", + "Locked" + ] + }, + "Description": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Value": { + "type": "boolean", + "protocols": [ + "usp" + ], + "read": true, + "write": true + } + }, + "Device.IoTCapability.{i}.LevelControl.": { + "type": "object", + "protocols": [ + "usp" + ], + "access": false, + "array": false, + "Type": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Description": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Value": { + "type": "decimal", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "Unit": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "MinValue": { + "type": "decimal", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "MaxValue": { + "type": "decimal", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "StepValue": { + "type": "decimal", + "protocols": [ + "usp" + ], + "read": true, + "write": true + } + }, + "Device.IoTCapability.{i}.EnumControl.": { + "type": "object", + "protocols": [ + "usp" + ], + "access": false, + "array": false, + "Type": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Description": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Value": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "ValidValues": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + } + }, + "Device.IoTCapability.{i}.BinarySensor.": { + "type": "object", + "protocols": [ + "usp" + ], + "access": false, + "array": false, + "Type": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false, + "values": [ + "CarbonDioxideDetected", + "CarbonMonoxideDetected", + "DoorOpen", + "MotionDetected", + "SmokeDetected", + "WindowOpen", + "WaterDetected" + ] + }, + "Description": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Value": { + "type": "boolean", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "LastChange": { + "type": "dateTime", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Sensitivity": { + "type": "unsignedInt", + "protocols": [ + "usp" + ], + "range": { + "max": "100" + }, + "read": true, + "write": true + }, + "HoldTime": { + "type": "unsignedInt", + "protocols": [ + "usp" + ], + "unit": "milliseconds", + "read": true, + "write": true + }, + "RestTime": { + "type": "unsignedInt", + "protocols": [ + "usp" + ], + "unit": "milliseconds", + "read": true, + "write": true + } + }, + "Device.IoTCapability.{i}.LevelSensor.": { + "type": "object", + "protocols": [ + "usp" + ], + "access": false, + "array": false, + "Type": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Description": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Value": { + "type": "decimal", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "LastChange": { + "type": "dateTime", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Unit": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "LowLevel": { + "type": "boolean", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "LowLevelThreshold": { + "type": "decimal", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "HighLevel": { + "type": "boolean", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "HighLevelThreshold": { + "type": "decimal", + "protocols": [ + "usp" + ], + "read": true, + "write": true + } + }, + "Device.IoTCapability.{i}.MultiLevelSensor.": { + "type": "object", + "protocols": [ + "usp" + ], + "access": false, + "array": false, + "Type": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false, + "values": [ + "RGB", + "Location" + ] + }, + "Description": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Values": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "ValueNames": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "LastChange": { + "type": "dateTime", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Unit": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + } + }, + "Device.IoTCapability.{i}.EnumSensor.": { + "type": "object", + "protocols": [ + "usp" + ], + "access": false, + "array": false, + "Type": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Description": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Value": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "LastChange": { + "type": "dateTime", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "ValidValues": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + } + } + }, + "Device.Node.{i}.": { + "type": "object", + "protocols": [ + "usp" + ], + "access": false, + "array": true, + "Alias": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": true + }, + "Type": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false + }, + "Description": { + "type": "string", + "protocols": [ + "usp" + ], + "read": true, + "write": false } } } diff --git a/tools/generate_xml_bbf.sh b/tools/generate_xml_bbf.sh index fabe2c6b..0791f1cd 100755 --- a/tools/generate_xml_bbf.sh +++ b/tools/generate_xml_bbf.sh @@ -355,10 +355,10 @@ SCRIPTS_PATH_TR143=${DM_PATH}/${DM_TR143} SCRIPTS_PATH_TR157=${DM_PATH}/${DM_TR157} DIR_LIST="$SCRIPTS_PATH_TR181 $SCRIPTS_PATH_TR104 $SCRIPTS_PATH_TR143 $SCRIPTS_PATH_TR157" ROOT_PATH="Device" -DM_HEAD="$ROOT_PATH-2.12" -DM_FILE="tr-181-2-12-0-cwmp-full.xml" -DM_VERSION="tr-181-2-12-0-cwmp" -model_name="$ROOT_PATH:2.12" +DM_HEAD="$ROOT_PATH-2.13" +DM_FILE="tr-181-2-13-0-cwmp-full.xml" +DM_VERSION="tr-181-2-13-0-cwmp" +model_name="$ROOT_PATH:2.13" XML_OUT_STREAM_BBF="iopsys_bbf.xml" ############## GEN BBF Data Models TREE ############## echo "Start Generation of BBF Data Models..." diff --git a/tools/generator_c.py b/tools/generator_c.py index c447688f..e536b223 100755 --- a/tools/generator_c.py +++ b/tools/generator_c.py @@ -325,15 +325,15 @@ def printincluderoot( objname ): def printusage(): print "Usage: " + sys.argv[0] + " [Object path]...[Object path]" print "Examples:" - print " - " + sys.argv[0] + " tr-181-2-12-0-cwmp-full.xml Device.WiFi." + print " - " + sys.argv[0] + " tr-181-2-13-0-cwmp-full.xml Device.WiFi." print " ==> Generate the C code of the sub tree Device.WiFi. in wifi.c/.h" - print " - " + sys.argv[0] + " tr-181-2-12-0-cwmp-full.xml Device.IP.Diagnostics." + print " - " + sys.argv[0] + " tr-181-2-13-0-cwmp-full.xml Device.IP.Diagnostics." print " ==> Generate the C code of the sub tree Device.IP.Diagnostics. in ipdiagnostics.c/.h" - print " - " + sys.argv[0] + " tr-181-2-12-0-cwmp-full.xml Device.WiFi. Device.Time." + print " - " + sys.argv[0] + " tr-181-2-13-0-cwmp-full.xml Device.WiFi. Device.Time." print " ==> Generate the C code of the sub tree Device.IP. and Device.WiFi. in time.c/.h and wifi.c/.h" - print " - " + sys.argv[0] + " tr-181-2-12-0-cwmp-full.xml Device." + print " - " + sys.argv[0] + " tr-181-2-13-0-cwmp-full.xml Device." print " ==> Generate the C code of all data model in rootdevice.c/.h" - print "Example of xml data model file: https://www.broadband-forum.org/cwmp/tr-181-2-12-0-cwmp-full.xml" + print "Example of xml data model file: https://www.broadband-forum.org/cwmp/tr-181-2-13-0-cwmp-full.xml" def getobjectpointer( objname ): obj = None diff --git a/tools/generator_json.py b/tools/generator_json.py index 55b5cdb1..a865b651 100755 --- a/tools/generator_json.py +++ b/tools/generator_json.py @@ -240,15 +240,15 @@ def printPARAM( dmparam ): def printusage(): print "Usage: " + sys.argv[0] + " [Object path]...[Object path]" print "Examples:" - print " - " + sys.argv[0] + " tr-181-2-12-0-cwmp-full.xml Device.WiFi." + print " - " + sys.argv[0] + " tr-181-2-13-0-cwmp-full.xml Device.WiFi." print " ==> Generate the json file of the sub tree Device.WiFi. in wifi.json" - print " - " + sys.argv[0] + " tr-181-2-12-0-cwmp-full.xml Device.IP.Diagnostics." + print " - " + sys.argv[0] + " tr-181-2-13-0-cwmp-full.xml Device.IP.Diagnostics." print " ==> Generate the json file of the sub tree Device.IP.Diagnostics. in ipdiagnostics.json" - print " - " + sys.argv[0] + " tr-181-2-12-0-cwmp-full.xml Device.WiFi. Device.Time." + print " - " + sys.argv[0] + " tr-181-2-13-0-cwmp-full.xml Device.WiFi. Device.Time." print " ==> Generate the json file of the sub tree Device.IP. and Device.WiFi. in time.json and wifi.json" - print " - " + sys.argv[0] + " tr-181-2-12-0-cwmp-full.xml Device." + print " - " + sys.argv[0] + " tr-181-2-13-0-cwmp-full.xml Device." print " ==> Generate the json file of all data model in rootdevice.json" - print "Example of xml data model file: https://www.broadband-forum.org/cwmp/tr-181-2-12-0-cwmp-full.xml" + print "Example of xml data model file: https://www.broadband-forum.org/cwmp/tr-181-2-13-0-cwmp-full.xml" def getobjectpointer( objname ): obj = None diff --git a/tools/generator_json_with_backend.py b/tools/generator_json_with_backend.py index 31fa2f20..1531767e 100755 --- a/tools/generator_json_with_backend.py +++ b/tools/generator_json_with_backend.py @@ -394,7 +394,7 @@ def printusage(): if "tr-181" in sys.argv[1]: print "Usage: " + sys.argv[0] + " [Object path]" print "Examples:" - print " - " + sys.argv[0] + " tr-181-2-12-0-cwmp-full.xml tr-181-2-12-0-usp-full.xml Device." + print " - " + sys.argv[0] + " tr-181-2-13-0-cwmp-full.xml tr-181-2-13-0-usp-full.xml Device." print " ==> Generate the json file of the sub tree Device. in tr181.json" else: print "Usage: " + sys.argv[0] + " [Object path]" @@ -405,7 +405,7 @@ def printusage(): print " ==> Generate the json file of the sub tree Device. in tr106.json" print "" - print "Example of xml data model file: https://www.broadband-forum.org/cwmp/tr-181-2-12-0-cwmp-full.xml" + print "Example of xml data model file: https://www.broadband-forum.org/cwmp/tr-181-2-13-0-cwmp-full.xml" def getobjectpointer( objname ): obj = None diff --git a/tools/tr-181-2-12-0-cwmp-full.xml b/tools/tr-181-2-13-0-cwmp-full.xml similarity index 93% rename from tools/tr-181-2-12-0-cwmp-full.xml rename to tools/tr-181-2-13-0-cwmp-full.xml index cfefc0fd..bb3befd8 100644 --- a/tools/tr-181-2-12-0-cwmp-full.xml +++ b/tools/tr-181-2-13-0-cwmp-full.xml @@ -1,15 +1,15 @@ - - + xsi:schemaLocation="urn:broadband-forum-org:cwmp:datamodel-1-7 https://www.broadband-forum.org/cwmp/cwmp-datamodel-1-7.xsd urn:broadband-forum-org:cwmp:datamodel-report-0-1 https://www.broadband-forum.org/cwmp/cwmp-datamodel-report.xsd" + spec="urn:broadband-forum-org:tr-181-2-13-0-cwmp" file="tr-181-2-13-0-cwmp-full.xml"> {{docname|Device:2 Root Data Model for CWMP (TR-069)}} - {{appdate|March 2018}} - {{trname|TR-181i2a12}} - * Added TR-069a6 support - * Added Firmware Image support - * Added Ethernet Link Aggregation Group - * Added additional Wi-Fi and WAN statistics - * Added support for Two-Way Active Measurement Protocol (TWAMP) reflector - * Added support for Layer Two Tunneling Protocol version 3 (L2TPv3) - * Added support for Virtual eXtensible Local Area Network (VXLAN) tunnels - * Added support for Broadband Access Service Attributes and Performance Metrics measurement test framework (BASAPM) - * Added support for Large-Scale Measurement of Broadband Performance (LMAP) + {{appdate|September 2019}} + {{trname|TR-181i2a13}} + * Added support for WFA Data Elements + * Added support for Multi AP + * Added support for WPA3 and 802.11ax + * Added support for MQTT 5.0 + * Added support for Package capture diagnostics + + + A non-volatile handle used to reference this instance. + '''This is intended only for use in protocol-independent "common" definitions, and MUST NOT be used in protocol-specific definitions.''' + + + + + + + + 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 {{bibref|TR-069|3.6.1}} and described in {{bibref|TR-069|Appendix II}}, 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 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. + The value MUST NOT change once it's been assigned. + + + + + + The value is measured in ''dBm/1000'', i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm. + + + + + + + Indicates the availability of diagnostics data. Enumeration of: + {{enum}} + If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are {{enum|Requested}} and {{enum|Canceled}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to {{enum|Requested}}. + When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. + When the test is completed, the value of this parameter MUST be either {{enum|Complete}} (if the test completed successfully), or one of the ''Error'' values listed above. + If the value of this parameter is anything other than {{enum|Complete}}, the values of the results parameters for this test are indeterminate. + When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the Inform message. + After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}. + Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}. + While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}. + While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. + While the test is in progress, setting this parameter to {{enum|Canceled}} MUST result in the test being canceled and the value of this parameter being set to {{enum|None}}. If the CPE does not support the {{enum|Canceled}} value, it MUST return a SPV error with "Invalid Parameter value" (9007) to the ACS instead. + + + + + + + + + + + + The IEEE EUI 64-bit identifier as defined in {{bibref|EUI64}}. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of: + * The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the IEEE Registration Authority (IEEE-RA), and + * The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36) assigned by the organization with that company_id assignment. + + + + + + + IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address. @@ -135,6 +220,8 @@ Can be any IPv4 address that is permitted by the ''IPAddress'' data type. + + @@ -145,7 +232,7 @@ - IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation {{bibref|RFC4632}}. This is specified as an IP address followed by an appended "/n" suffix, where ''n'' (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix. + IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation {{bibref|RFC4632}}. This is specified as an IP address followed by an appended "/n" suffix, where ''n'' (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix. * IPv4 example: 192.168.1.0/24 * IPv6 example: 2001:edff:fe6a:f76::/64 If the IP address part is unspecified or inapplicable, it MUST be {{empty}} unless otherwise specified by the parameter definition. In this case the IP prefix will be of the form "/n". @@ -157,10 +244,13 @@ - IPv4 address prefix. + IPv4 address prefix. Can be any IPv4 prefix that is permitted by the ''IPPrefix'' data type. + + + @@ -169,6 +259,13 @@ + + + A JSON Object as defined in {{bibref|RFC7159|Section 4}}. + + + + All MAC addresses are represented as strings of 12 hexadecimal digits (digits 0-9, letters A-F or a-f) displayed as six pairs of digits separated by colons. Unspecified or inapplicable MAC addresses MUST be represented as empty strings unless otherwise specified by the parameter definition. @@ -200,26 +297,6 @@ - - - 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 {{bibref|TR-069a4|3.6.1}} and described in {{bibref|TR-069a4|Appendix II}}, 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. - - - - - - - - The value is measured in ''dBm/1000'', i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm. - - - - Universally Unique Identifier. See {{bibref|RFC4122}}. @@ -229,18 +306,27 @@ - + - The IEEE EUI 64-bit identifier as defined in {{bibref|EUI64}}. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of: - * The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the IEEE Registration Authority (IEEE-RA), and - * The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36) assigned by the organization with that company_id assignment. + Uniform Resource Identifier. See {{bibref|RFC3986}}. - - - + + + + Uniform Resource Name. See {{bibref|RFC3986}} (URI) and {{bibref|RFC8141}} (''urn'' URI scheme). + + + + + + + Uniform Resource Locator. See {{bibref|RFC3986}} (URI), {{bibref|IANA-uri-schemes}}, and individual URI scheme RFCs such as {{bibref|RFC7252}} (''coap'', ''coaps'') and {{bibref|RFC7230}} (''http'', ''https''). + + + The ZigBee 16-bit network address (NWK) as defined in {{bibref|ZigBee2007}}. The address is assigned to a device by the network layer and used by the network layer for routing messages between devices. @@ -251,28 +337,38 @@ - + - Indicates the availability of diagnostics data. Enumeration of: - {{enum}} - If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are {{enum|Requested}} and {{enum|Canceled}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to {{enum|Requested}}. - When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. - When the test is completed, the value of this parameter MUST be either {{enum|Complete}} (if the test completed successfully), or one of the ''Error'' values listed above. - If the value of this parameter is anything other than {{enum|Complete}}, the values of the results parameters for this test are indeterminate. - When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the Inform message. - After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}. - Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}. - While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}. - While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. - While the test is in progress, setting this parameter to {{enum|Canceled}} MUST result in the test being canceled and the value of this parameter being set to {{enum|None}}. If the CPE does not support the {{enum|Canceled}} value, it MUST return a SPV error with "Invalid Parameter value" (9007) to the ACS instead. + 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 {{bibref|TR-069|3.6.1}} and described in {{bibref|TR-069|Appendix II}}, 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. - - - - - - - + + + + + Pair of 32-bit signed integers a(i),b(i) with each pair representing a complex component of the uncalibrated echo response (UER); + # Real UER component, a(i) + # Imaginary UER component, b(i) + for values of i starting at i=0. Both values are represented as signed integers. + The interpretation of the UER value is as defined in {{bibref|G.996.2|Clause A.2.2.1}}. + + + + + + + + # the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:8191] with Df = 4.3125 kHz frequency spacing, and + # the value of the level of the PSD at this sub-carrier expressed in ''0.1 dBm/Hz'' with an offset of -200 dBm/Hz. The range of valid values for PSD is -30 to -200 dBm/Hz. + Both values are represented as unsignedInt. + + + + @@ -289,142 +385,168 @@ High Speed Packet data Access (HSPA) 3GPP - http://www.3gpp.org/technologies/keywords-acronyms/99-hspa + https://www.3gpp.org/technologies/keywords-acronyms/99-hspa 3GPP TS 25.171 Requirements for support of Assisted Global Positioning System (A-GPS) 3GPP RAN WG4 - http://www.3gpp.org/ftp/Specs/html-info/25171.htm + https://www.3gpp.org/ftp/Specs/html-info/25171.htm IEEE Std 802.11-2007 Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications IEEE 2007 - http://standards.ieee.org/getieee802/download/802.11-2007.pdf + https://standards.ieee.org/getieee802/download/802.11-2007.pdf IEEE Std 802.11-2012 Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications IEEE March 2012 - http://standards.ieee.org/getieee802/download/802.11-2012.pdf + https://standards.ieee.org/getieee802/download/802.11-2012.pdf + + + IEEE Std 802.11-2016 + Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications + IEEE + December 2016 + https://ieeexplore.ieee.org/document/7786995 IEEE Std 802.11a-1999 High-speed Physical Layer in the 5 GHz band IEEE 1999 - http://standards.ieee.org/getieee802/download/802.11a-1999.pdf + https://standards.ieee.org/getieee802/download/802.11a-1999.pdf IEEE Std 802.11ac-2013 + Enhancements for Very High Throughput for Operation in Bands below 6 GHz + IEEE + December 2013 + https://www.ieee802.org/11/Reports/tgac_update.htm + + + IEEE Std 802.11ax IEEE - http://www.ieee802.org/11/Reports/tgac_update.htm IEEE Std 802.11b-1999 Higher Speed Physical Layer Extension in the 2.4 GHz band IEEE 1999 - http://standards.ieee.org/getieee802/download/802.11b-1999.pdf + https://standards.ieee.org/getieee802/download/802.11b-1999.pdf IEEE Std 802.11g-2003 Further Higher Data Rate Extension in the 2.4 GHz Band IEEE 2003 - http://standards.ieee.org/getieee802/download/802.11g-2003.pdf + https://standards.ieee.org/getieee802/download/802.11g-2003.pdf IEEE Std 802.11h-2003 Spectrum and Transmit Power Management Extensions IEEE 2003 - http://standards.ieee.org/getieee802/download/802.11h-2003.pdf + https://standards.ieee.org/getieee802/download/802.11h-2003.pdf IEEE Std 802.11n-2009 Amendment 5: Enhancements for Higher Throughput IEEE 2009 - http://ieeexplore.ieee.org/xpl/freeabs_all.jsp?reload=true&arnumber=5307322 + https://ieeexplore.ieee.org/xpl/freeabs_all.jsp?reload=true&arnumber=5307322 IEEE Std 802.1AB-2009 Station and Media Access Control Connectivity Discovery IEEE 2009 - http://standards.ieee.org/getieee802/download/802.1AB-2009.pdf + https://standards.ieee.org/getieee802/download/802.1AB-2009.pdf IEEE Std 802.1ad-2005 Virtual Bridged Local Area Networks Amendment 4: Provider Bridges IEEE May 2005 - http://standards.ieee.org/getieee802/download/802.1ad-2005.pdf + https://standards.ieee.org/getieee802/download/802.1ad-2005.pdf IEEE Std 802.1AX-2014 IEEE Standard for Local and metropolitan area networks -- Link Aggregation IEEE 2014 - http://ieeexplore.ieee.org/servlet/opac?punumber=6997981 + https://ieeexplore.ieee.org/servlet/opac?punumber=6997981 IEEE Std 802.1D-2004 Media Access Control (MAC) Bridges IEEE 2004 - http://standards.ieee.org/getieee802/download/802.1D-2004.pdf + https://standards.ieee.org/getieee802/download/802.1D-2004.pdf IEEE Std 802.1Q-2005 Virtual Bridged Local Area Networks IEEE 2006 - http://standards.ieee.org/getieee802/download/802.1Q-2005.pdf + https://standards.ieee.org/getieee802/download/802.1Q-2005.pdf IEEE Std 802.1Q-2011 MAC Bridges and Virtual Bridge Local Area Networks IEEE 2011 - http://standards.ieee.org/getieee802/download/802.1Q-2011.pdf + https://standards.ieee.org/getieee802/download/802.1Q-2011.pdf IEEE Std 802.1x-2004 Standards for Local and Metropolitan Area Networks: Port based Network Access Control IEEE 2004 - http://standards.ieee.org/getieee802/download/802.1X-2004.pdf + https://standards.ieee.org/getieee802/download/802.1X-2004.pdf IEEE Std 802.3-2015 IEEE Standard for Ethernet IEEE 2015 - http://ieeexplore.ieee.org/servlet/opac?punumber=7428774 + https://ieeexplore.ieee.org/servlet/opac?punumber=7428774 IEEE 802.3-2012 - Section Six IEEE Standard for Ethernet - Section Six IEEE December 2012 - http://standards.ieee.org/getieee802/download/802.3-2012_section6.pdf + https://standards.ieee.org/getieee802/download/802.3-2012_section6.pdf Blue A New Class of Active Queue Management Algorithms - http://www.thefengs.com/wuchang/work/blue + https://www.thefengs.com/wuchang/work/blue + + + BPF + Berkeley Packet Filter Syntax + FreeBSD.org + October 2016 + https://www.freebsd.org/cgi/man.cgi?query=bpf + + + Data Elements Specification + Data Elements Specification Version 1.0 + January 2019 + https://www.wi-fi.org/discover-wi-fi/specifications DLNA Networked Device Interoperability Guidelines DLNA Networked Device Interoperability Guidelines, Volume 2: Media Format Profiles. DLNA October 2006 - http://www.dlna.org/industry/certification/guidelines/ + https://www.dlna.org/industry/certification/guidelines/ RFC 6763 @@ -432,7 +554,7 @@ IETF RFC 2013 - http://tools.ietf.org/html/rfc6763 + https://tools.ietf.org/html/rfc6763 RFC 6333 @@ -440,7 +562,7 @@ IETF RFC 2011 - http://tools.ietf.org/html/rfc6333 + https://tools.ietf.org/html/rfc6333 RFC 6334 @@ -448,233 +570,239 @@ IETF RFC 2011 - http://tools.ietf.org/html/rfc6334 + https://tools.ietf.org/html/rfc6334 TS 102 824 Digital Video Broadcasting (DVB);Remote Management and Firmware Update System for DVB IP Services ETSI July 2008 - http://webapp.etsi.org/workprogram/Report_WorkItem.asp?WKI_ID=27769 + https://webapp.etsi.org/workprogram/Report_WorkItem.asp?WKI_ID=27769 ETSI EN 301 893 Broadband Radio Access Networks (BRAN); 5 GHz high performance RLAN; Harmonized EN covering the essential requirements of article 3.2 of the RTTE Directive ETSI - http://www.etsi.org/deliver/etsi_en/301800_301899/301893/01.08.01_60/en_301893v010801p.pdf + https://www.etsi.org/deliver/etsi_en/301800_301899/301893/01.08.01_60/en_301893v010801p.pdf ETSI TS 102 690 v1.1.6 Machine-to-Machine Communications (M2M Functional Architecture) ETSI June 2012 - http://docbox.etsi.org/M2M/Open/Latest_Drafts/00002ed121v116.pdf + https://docbox.etsi.org/M2M/Open/Latest_Drafts/00002ed121v116.pdf ETSI TS 102 921 v1.1.6 M2M mIa, dIa and mId Interfaces ETSI August 2012 - http://docbox.etsi.org/M2M/Open/Latest_Drafts/00010ed121v116.pdf + https://docbox.etsi.org/M2M/Open/Latest_Drafts/00010ed121v116.pdf G.988 ONU management and control interface (OMCI) specification ITU-T 2010 - http://www.itu.int/rec/T-REC-G.988-201010-P/en + https://www.itu.int/rec/T-REC-G.988-201010-P/en G.9701 Fast access to subscriber terminals (G.fast)- Physical layer specification ITU-T 2014 - http://www.itu.int/rec/T-REC-G.9701-201412-P + https://www.itu.int/rec/T-REC-G.9701-201412-P G.9954 Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1) ITU-T 2007 - http://www.itu.int/rec/T-REC-G.9954/en + https://www.itu.int/rec/T-REC-G.9954/en G.9960 Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification ITU-T G.hn series - http://www.itu.int/rec/T-REC-G.9960-201006-P + https://www.itu.int/rec/T-REC-G.9960-201006-P G.9961 Unified high-speed wire-line based home networking transceivers - Data link layer specification ITU-T G.hn series - http://www.itu.int/rec/T-REC-G.9961-201006-P + https://www.itu.int/rec/T-REC-G.9961-201006-P G.9962 Unified high-speed wire-line based home networking transceivers - Management specification ITU-T G.hn series - http://www.itu.int/rec/T-REC-G.9962-201308-P + https://www.itu.int/rec/T-REC-G.9962-201308-P G.9964 Unified high-speed wire-line based home networking transceivers - Power spectral density specification ITU-T G.hn series - http://www.itu.int/rec/T-REC-G.9962-201308-P + https://www.itu.int/rec/T-REC-G.9962-201308-P G.9973 Protocol for identifying home network topology ITU-T 2011 - http://www.itu.int/rec/T-REC-G.9973-201110-I/en + https://www.itu.int/rec/T-REC-G.9973-201110-I/en G.993.1 Very high speed digital subscriber line transceivers ITU-T - http://www.itu.int/rec/T-REC-G.993.1 + https://www.itu.int/rec/T-REC-G.993.1 G.993.2 Very high speed digital subscriber line transceivers 2 (VDSL2) ITU-T - http://www.itu.int/rec/T-REC-G.993.2 + https://www.itu.int/rec/T-REC-G.993.2 + + + G.996.2 + Single-ended line testing for digital subscriber lines (DSL) + ITU-T + https://www.itu.int/rec/T-REC-G.996.2 G.997.1 Physical layer management for digital subscriber line (DSL) transceivers ITU-T - http://www.itu.int/rec/T-REC-G.997.1 + https://www.itu.int/rec/T-REC-G.997.1 G.997.2 Physical layer management for FAST transceivers ITU-T 2015 - http://www.itu.int/rec/T-REC-G.997.2-201505-I + https://www.itu.int/rec/T-REC-G.997.2-201505-I G.998.1 ATM-based Multi-Pair Bonding ITU-T 2005 - http://www.itu.int/rec/T-REC-G.998.1 + https://www.itu.int/rec/T-REC-G.998.1 G.998.2 Ethernet-based Multi-Pair Bonding ITU-T 2005 - http://www.itu.int/rec/T-REC-G.998.2 + https://www.itu.int/rec/T-REC-G.998.2 G.998.3 Multi-Pair Bonding Using Time-Division Inverse Multiplexing ITU-T 2005 - http://www.itu.int/rec/T-REC-G.998.2 + https://www.itu.int/rec/T-REC-G.998.2 HomePlug AV Specification Version 1.1 HomePlug 2007 - http://www.homeplug.org + https://www.homeplug.org HTML 4.01 Specification W3C - http://www.w3.org/TR/html4 + https://www.w3.org/TR/html4 IANA Protocol Numbers Protocol Numbers IANA - http://www.iana.org/assignments/protocol-numbers + https://www.iana.org/assignments/protocol-numbers IANAifType IANAifType-MIB DEFINITIONS IANA 2009 - http://www.iana.org/assignments/ianaiftype-mib/ianaiftype-mib + https://www.iana.org/assignments/ianaiftype-mib/ianaiftype-mib ICSA Baseline Modular Firewall Certification Criteria Baseline module - version 4.1 ICSA Labs 2008 - http://www.icsalabs.com/sites/default/files/baseline.pdf + https://www.icsalabs.com/sites/default/files/baseline.pdf ICSA Residential Modular Firewall Certification Criteria Required Services Security Policy - Residential Category module - version 4.1 ICSA Labs 2008 - http://www.icsalabs.com/sites/default/files/residential.pdf + https://www.icsalabs.com/sites/default/files/residential.pdf IEEE 1905.1a IEEE Std 1905.1a, Convergent Digital Home Network for Heterogeneous Technologies Amendment 1: Support of new MAC/PHYs and enhancements, IEEE, December 2014. IEEE December 2014 - http://www.IEEE.org + https://www.IEEE.org IKEv2 Parameters Internet Key Exchange Version 2 (IKEv2) Parameters - IETF - http://www.iana.org/assignments/ikev2-parameters/ikev2-parameters.xml + IANA + https://www.iana.org/assignments/ikev2-parameters/ikev2-parameters.xml IPDR File Transfer Protocol IPDR/File Transfer Protocol TM Forum - http://www.ipdr.org/public/ + https://www.ipdr.org/public/ IPDR Streaming Protocol IPDR Streaming Protocol (IPDR/SP) Specification TM Forum - http://www.ipdr.org/public/ + https://www.ipdr.org/public/ IPDR XDR Encoding Format IPDR/XDR Encoding Format TM Forum - http://www.ipdr.org/public/ + https://www.ipdr.org/public/ IPDR XML File Encoding Format IPDR/XML File Encoding Format TM Forum - http://www.ipdr.org/public/ + https://www.ipdr.org/public/ ISO/IEC 13818-6:1998 Information Technology - Generic coding of moving pictures and associated audio information - Part 6: Extensions for DSM-CC ISO 1998 - http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=25039 + https://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=25039 ISO 3166-1 Codes for the representation of names of countries and their subdivisions - Part 1: Country codes ISO 2006 - http://www.iso.org/iso/country_codes.htm + https://www.iso.org/iso/country_codes.htm ISO 639-1 Codes for the representation of names of Languages - Part 1: Alpha-2 code ISO 2002 - http://www.iso.org/iso/language_codes + https://www.iso.org/iso/language_codes ISO/IEC 646-1991 @@ -684,38 +812,45 @@ ITU E.118 - Overall Network Operation, Telephone Service, Service Operation and Human Factors + The international telecommunication charge card International Telecommunication Union May 2006 - http://www.itu.int/rec/T-REC-E.118/en + https://www.itu.int/rec/T-REC-E.118-200605-I/en ITU E.164 The international public telecommunication numbering plan International Telecommunication Union October 2010 - http://www.itu.int/rec/T-REC-E.164-201011-I/en + https://www.itu.int/rec/T-REC-E.164-201011-I/en ITU X.733 Information technology - Open Systems Interconnection - Systems Management: Alarm reporting function International Telecommunication Union February 1992 - http://www.itu.int/rec/T-REC-X.733/en + https://www.itu.int/rec/T-REC-X.733/en JJ-300.00 Home-network Topology Identifying Protocol TTC 2011 - http://www.ttc.or.jp/jp/document_list/pdf/e/STD/JJ-300.00(E)v1.1.pdf + https://www.ttc.or.jp/jp/document_list/pdf/e/STD/JJ-300.00(E)v1.1.pdf JJ-300.01 The List of Device Categories TTC 2011 - http://www.ttc.or.jp/jp/document_list/pdf/e/STD/JJ-300.01(E)v1.1.pdf + https://www.ttc.or.jp/jp/document_list/pdf/e/STD/JJ-300.01(E)v1.1.pdf + + + Libpcap + Libpcap File Format + Wireshark + 2015 + https://wiki.wireshark.org/Development/LibpcapFileFormat RFC 8193 @@ -723,7 +858,7 @@ IETF Informational RFC August 2017 - http://tools.ietf.org/html/rfc8193 + https://tools.ietf.org/html/rfc8193 draft-ietf-ippm-metric-registry-12 @@ -733,61 +868,68 @@ June 30, 2017 https://datatracker.ietf.org/doc/draft-ietf-ippm-metric-registry/ + + Multi-AP Specification + Multi-AP Specification Version 1.0 + June 2018 + https://www.wi-fi.org/discover-wi-fi/specifications + MOCA11-MIB Remote Management of MoCA Interfaces using SNMP MIB MoCA Alliance 2009 - http://www.mocalliance.org + https://www.mocalliance.org MoCA v1.0 MoCA MAC/PHY Specification v1.0 MoCA Alliance 2009 - http://www.mocalliance.org + https://www.mocalliance.org MoCA v1.1 MoCA MAC/PHY Specification v1.1 Extensions MoCA Alliance 2009 - http://www.mocalliance.org + https://www.mocalliance.org MQTT v3.1 MQ Telemetry Transport (MQTT) V3.1 Protocol Specification 2010 - http://www.ibm.com/developerworks/webservices/library/ws-mqtt/index.html + https://www.ibm.com/developerworks/webservices/library/ws-mqtt/index.html - - MQTT Version 3.1.1 - MQTT v3.1.1 + + MQTT Version 5.0 + MQTT Version 5.0, Candidate OASIS Standard 02. OASIS Message Queuing Telemetry Transport (MQTT) TC - October 2014 - https://www.oasis-open.org/standards#mqttv3.1.1 + February 2019 + https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html Organizationally Unique Identifiers (OUIs) - http://standards.ieee.org/faqs/OUI.html + https://standards.ieee.org/faqs/OUI.html PCP Proxy Function Port Control Protocol (PCP) Proxy Function IETF - January 2014 - http://tools.ietf.org/html/draft-ietf-pcp-proxy + RFC + September 2015 + https://tools.ietf.org/html/pcpproxyfunction ISO/IEC/IEEE 9945 Information technology - Portable Operating System Interface (POSIX) Base Specifications, Issue 7 ISO/IEC/IEEE September 2009 - http://ieeexplore.ieee.org/xpl/mostRecentIssue.jsp?punumber=4694974 + https://ieeexplore.ieee.org/xpl/mostRecentIssue.jsp?punumber=4694974 References on RED (Random Early Detection) Queue Management - http://www.icir.org/floyd/red.html + https://www.icir.org/floyd/red.html RFC 793 @@ -795,7 +937,7 @@ IETF RFC September 1981 - http://tools.ietf.org/html/rfc793 + https://tools.ietf.org/html/rfc793 RFC 862 @@ -803,7 +945,7 @@ IETF RFC 1983 - http://tools.ietf.org/html/rfc862 + https://tools.ietf.org/html/rfc862 RFC 959 @@ -811,7 +953,7 @@ IETF RFC 1985 - http://tools.ietf.org/html/rfc959 + https://tools.ietf.org/html/rfc959 RFC 1035 @@ -819,7 +961,7 @@ IETF RFC 1987 - http://tools.ietf.org/html/rfc1035 + https://tools.ietf.org/html/rfc1035 RFC 1323 @@ -827,7 +969,7 @@ IETF RFC May 1992 - http://tools.ietf.org/html/rfc1323 + https://tools.ietf.org/html/rfc1323 RFC 1332 @@ -835,7 +977,7 @@ IETF RFC 1992 - http://tools.ietf.org/html/rfc1332 + https://tools.ietf.org/html/rfc1332 RFC 1378 @@ -843,7 +985,7 @@ IETF RFC 1992 - http://tools.ietf.org/html/rfc1378 + https://tools.ietf.org/html/rfc1378 RFC 1552 @@ -851,7 +993,7 @@ IETF RFC 1993 - http://tools.ietf.org/html/rfc1552 + https://tools.ietf.org/html/rfc1552 RFC 1661 @@ -859,7 +1001,7 @@ IETF RFC 1994 - http://tools.ietf.org/html/rfc1661 + https://tools.ietf.org/html/rfc1661 RFC 1877 @@ -867,7 +1009,7 @@ IETF RFC 1995 - http://tools.ietf.org/html/rfc1877 + https://tools.ietf.org/html/rfc1877 RFC 1974 @@ -875,7 +1017,7 @@ IETF RFC 1996 - http://tools.ietf.org/html/rfc1974 + https://tools.ietf.org/html/rfc1974 RFC 2080 @@ -883,7 +1025,7 @@ IETF RFC 1997 - http://tools.ietf.org/html/rfc2080 + https://tools.ietf.org/html/rfc2080 RFC 2097 @@ -891,28 +1033,28 @@ IETF RFC 1997 - http://tools.ietf.org/html/rfc2097 + https://tools.ietf.org/html/rfc2097 RFC 2131 Dynamic Host Configuration Protocol IETF RFC - http://tools.ietf.org/html/rfc2131 + https://tools.ietf.org/html/rfc2131 RFC 2132 DHCP Options and BOOTP Vendor Extensions IETF RFC - http://tools.ietf.org/html/rfc2132 + https://tools.ietf.org/html/rfc2132 RFC 2225 Classical IP and ARP over ATM IETF RFC - http://tools.ietf.org/html/rfc2225 + https://tools.ietf.org/html/rfc2225 RFC 2364 @@ -920,14 +1062,14 @@ IETF RFC 1998 - http://tools.ietf.org/html/rfc2364 + https://tools.ietf.org/html/rfc2364 RFC 2474 Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers IETF RFC - http://tools.ietf.org/html/rfc2474 + https://tools.ietf.org/html/rfc2474 RFC 2581 @@ -935,7 +1077,7 @@ IETF RFC April 1999 - http://tools.ietf.org/html/rfc2581 + https://tools.ietf.org/html/rfc2581 RFC 2582 @@ -943,7 +1085,7 @@ IETF RFC April 1999 - http://tools.ietf.org/html/rfc2582 + https://tools.ietf.org/html/rfc2582 RFC 2616 @@ -951,28 +1093,28 @@ IETF RFC 1999 - http://tools.ietf.org/html/rfc2616 + https://tools.ietf.org/html/rfc2616 RFC 2684 Multiprotocol Encapsulation over ATM Adaptation Layer 5 IETF RFC - http://tools.ietf.org/html/rfc2684 + https://tools.ietf.org/html/rfc2684 RFC 2697 A Single Rate Three Color Marker IETF RFC - http://tools.ietf.org/html/rfc2697 + https://tools.ietf.org/html/rfc2697 RFC 2698 A Two Rate Three Color Marker IETF RFC - http://tools.ietf.org/html/rfc2698 + https://tools.ietf.org/html/rfc2698 RFC 2782 @@ -980,7 +1122,7 @@ IETF RFC 2000 - http://tools.ietf.org/html/rfc2782 + https://tools.ietf.org/html/rfc2782 RFC 2784 @@ -988,7 +1130,7 @@ IETF RFC November 2000 - http://tools.ietf.org/html/rfc2784 + https://tools.ietf.org/html/rfc2784 RFC 2818 @@ -996,7 +1138,7 @@ IETF RFC May 2000 - http://tools.ietf.org/html/rfc2818 + https://tools.ietf.org/html/rfc2818 RFC 2819 @@ -1004,7 +1146,7 @@ IETF RFC 2000 - http://tools.ietf.org/html/rfc2819 + https://tools.ietf.org/html/rfc2819 RFC 2863 @@ -1012,7 +1154,7 @@ IETF RFC 2000 - http://tools.ietf.org/html/rfc2863 + https://tools.ietf.org/html/rfc2863 RFC 2865 @@ -1020,7 +1162,7 @@ IETF RFC 2000 - http://tools.ietf.org/html/rfc2865 + https://tools.ietf.org/html/rfc2865 RFC 2866 @@ -1028,7 +1170,7 @@ IETF RFC 2000 - http://tools.ietf.org/html/rfc2866 + https://tools.ietf.org/html/rfc2866 RFC 2869 @@ -1036,7 +1178,7 @@ IETF RFC 2000 - http://tools.ietf.org/html/rfc2869 + https://tools.ietf.org/html/rfc2869 RFC 2890 @@ -1044,14 +1186,14 @@ IETF RFC November 2000 - http://tools.ietf.org/html/rfc2890 + https://tools.ietf.org/html/rfc2890 RFC 2898 PKCS #5: Password-Based Cryptography Specification Version 2.0 IETF RFC - http://tools.ietf.org/html/rfc2898 + https://tools.ietf.org/html/rfc2898 RFC 2974 @@ -1059,21 +1201,21 @@ IETF RFC October 2000 - http://tools.ietf.org/html/rfc2974 + https://tools.ietf.org/html/rfc2974 RFC 3004 The User Class Option for DHCP IETF RFC - http://tools.ietf.org/html/rfc3004 + https://tools.ietf.org/html/rfc3004 RFC 3066 Tags for the Identification of Languages IETF RFC - http://tools.ietf.org/html/rfc3066 + https://tools.ietf.org/html/rfc3066 RFC 3232 @@ -1081,7 +1223,7 @@ IETF RFC 2002 - http://tools.ietf.org/html/rfc3232 + https://tools.ietf.org/html/rfc3232 RFC 3315 @@ -1089,7 +1231,7 @@ IETF RFC 2003 - http://tools.ietf.org/html/rfc3315 + https://tools.ietf.org/html/rfc3315 RFC 3339 @@ -1097,14 +1239,14 @@ IETF Draft Standard July, 2002 - http://tools.ietf.org/html/rfc3339 + https://tools.ietf.org/html/rfc3339 RFC 3489 STUN - Simple Traversal of User Datagram Protocol (UDP) Through Network Address Translators (NATs) IETF RFC - http://tools.ietf.org/html/rfc3489 + https://tools.ietf.org/html/rfc3489 RFC 3596 @@ -1112,7 +1254,7 @@ IETF RFC 2003 - http://tools.ietf.org/html/rfc3596 + https://tools.ietf.org/html/rfc3596 RFC 3633 @@ -1120,7 +1262,7 @@ IETF RFC 2003 - http://tools.ietf.org/html/rfc3633 + https://tools.ietf.org/html/rfc3633 RFC 3646 @@ -1128,7 +1270,7 @@ IETF RFC 2003 - http://tools.ietf.org/html/rfc3646 + https://tools.ietf.org/html/rfc3646 RFC 3775 @@ -1136,14 +1278,14 @@ IETF RFC 2004 - http://tools.ietf.org/html/rfc3775 + https://tools.ietf.org/html/rfc3775 RFC 3925 Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4 (DHCPv4) IETF RFC - http://tools.ietf.org/html/rfc3925 + https://tools.ietf.org/html/rfc3925 RFC 3926 @@ -1151,7 +1293,7 @@ IETF RFC October 2004 - http://tools.ietf.org/html/rfc3926 + https://tools.ietf.org/html/rfc3926 RFC 3927 @@ -1159,7 +1301,7 @@ IETF RFC 2005 - http://tools.ietf.org/html/rfc3927 + https://tools.ietf.org/html/rfc3927 RFC 3931 @@ -1167,7 +1309,7 @@ IETF RFC March 2005 - http://tools.ietf.org/html/rfc3931 + https://tools.ietf.org/html/rfc3931 RFC 3948 @@ -1175,14 +1317,14 @@ IETF RFC January 2005 - http://tools.ietf.org/html/rfc3948 + https://tools.ietf.org/html/rfc3948 RFC 3986 Uniform Resource Identifier (URI): Generic Syntax IETF RFC - http://tools.ietf.org/html/rfc3986 + https://tools.ietf.org/html/rfc3986 RFC 4122 @@ -1190,7 +1332,7 @@ IETF RFC 2005 - http://tools.ietf.org/html/rfc4122 + https://tools.ietf.org/html/rfc4122 RFC4180 @@ -1198,7 +1340,7 @@ IETF RFC October 2005 - http://tools.ietf.org/html/rfc4180 + https://tools.ietf.org/html/rfc4180 RFC 4191 @@ -1206,7 +1348,7 @@ IETF RFC 2005 - http://tools.ietf.org/html/rfc4191 + https://tools.ietf.org/html/rfc4191 RFC 4193 @@ -1214,7 +1356,7 @@ IETF RFC 2005 - http://tools.ietf.org/html/rfc4193 + https://tools.ietf.org/html/rfc4193 RFC 4242 @@ -1222,7 +1364,7 @@ IETF RFC 2005 - http://tools.ietf.org/html/rfc4242 + https://tools.ietf.org/html/rfc4242 RFC 4291 @@ -1230,7 +1372,7 @@ IETF RFC 2006 - http://tools.ietf.org/html/rfc4291 + https://tools.ietf.org/html/rfc4291 RFC 4292 @@ -1238,7 +1380,7 @@ IETF RFC 2006 - http://tools.ietf.org/html/rfc4292 + https://tools.ietf.org/html/rfc4292 RFC 4293 @@ -1246,7 +1388,7 @@ IETF RFC 2006 - http://tools.ietf.org/html/rfc4293 + https://tools.ietf.org/html/rfc4293 RFC 4301 @@ -1254,7 +1396,7 @@ IETF RFC December 2005 - http://tools.ietf.org/html/rfc4301 + https://tools.ietf.org/html/rfc4301 RFC 4302 @@ -1262,7 +1404,7 @@ IETF RFC December 2005 - http://tools.ietf.org/html/rfc4302 + https://tools.ietf.org/html/rfc4302 RFC 4303 @@ -1270,7 +1412,7 @@ IETF RFC December 2005 - http://tools.ietf.org/html/rfc4303 + https://tools.ietf.org/html/rfc4303 RFC 4389 @@ -1278,7 +1420,7 @@ IETF RFC 2006 - http://tools.ietf.org/html/rfc4389 + https://tools.ietf.org/html/rfc4389 RFC 4632 @@ -1286,7 +1428,7 @@ IETF RFC 2006 - http://tools.ietf.org/html/rfc4632 + https://tools.ietf.org/html/rfc4632 RFC 4719 @@ -1294,7 +1436,7 @@ IETF RFC November 2006 - http://tools.ietf.org/html/rfc4719 + https://tools.ietf.org/html/rfc4719 RFC 4835 @@ -1302,7 +1444,7 @@ IETF RFC 2007 - http://tools.ietf.org/html/rfc4835 + https://tools.ietf.org/html/rfc4835 RFC 4861 @@ -1310,7 +1452,7 @@ IETF RFC 2007 - http://tools.ietf.org/html/rfc4861 + https://tools.ietf.org/html/rfc4861 RFC 4862 @@ -1318,7 +1460,7 @@ IETF RFC 2007 - http://tools.ietf.org/html/rfc4862 + https://tools.ietf.org/html/rfc4862 RFC 5072 @@ -1326,7 +1468,7 @@ IETF RFC 2007 - http://tools.ietf.org/html/rfc5072 + https://tools.ietf.org/html/rfc5072 RFC 5139 @@ -1334,7 +1476,7 @@ IETF RFC February 2008 - http://tools.ietf.org/html/rfc5139 + https://tools.ietf.org/html/rfc5139 RFC 5280 @@ -1342,7 +1484,7 @@ IETF RFC May 2008 - http://tools.ietf.org/html/rfc5280 + https://tools.ietf.org/html/rfc5280 RFC 5491 @@ -1350,7 +1492,7 @@ IETF RFC March 2009 - http://tools.ietf.org/html/rfc5491 + https://tools.ietf.org/html/rfc5491 RFC 5625 @@ -1358,7 +1500,7 @@ IETF RFC 2009 - http://tools.ietf.org/html/rfc5625 + https://tools.ietf.org/html/rfc5625 RFC 5969 @@ -1366,7 +1508,7 @@ IETF RFC 2010 - http://tools.ietf.org/html/rfc5969 + https://tools.ietf.org/html/rfc5969 RFC 5996 @@ -1374,7 +1516,7 @@ IETF RFC September 2010 - http://tools.ietf.org/html/rfc5996 + https://tools.ietf.org/html/rfc5996 RFC 6106 @@ -1382,7 +1524,7 @@ IETF RFC 2010 - http://tools.ietf.org/html/rfc6106 + https://tools.ietf.org/html/rfc6106 RFC 6120 @@ -1390,7 +1532,7 @@ IETF RFC 2011 - http://tools.ietf.org/html/rfc6120 + https://tools.ietf.org/html/rfc6120 RFC 6887 @@ -1398,7 +1540,7 @@ IETF RFC 2013 - http://tools.ietf.org/html/rfc6887 + https://tools.ietf.org/html/rfc6887 RFC 6970 @@ -1406,7 +1548,7 @@ IETF RFC 2013 - http://tools.ietf.org/html/rfc6970 + https://tools.ietf.org/html/rfc6970 RFC7159 @@ -1414,7 +1556,7 @@ IETF RFC March 2014 - http://tools.ietf.org/html/rfc7159 + https://tools.ietf.org/html/rfc7159 RFC 7291 @@ -1422,7 +1564,7 @@ IETF RFC 2014 - http://tools.ietf.org/html/rfc7291 + https://tools.ietf.org/html/rfc7291 RFC 7348 @@ -1430,7 +1572,7 @@ IETF RFC August 2014 - http://tools.ietf.org/html/rfc7348 + https://tools.ietf.org/html/rfc7348 RFC 7395 @@ -1438,7 +1580,7 @@ IETF Standards Track October 2014 - http://tools.ietf.org/html/rfc7395 + https://tools.ietf.org/html/rfc7395 RFC 7398 @@ -1446,7 +1588,7 @@ IETF Informational RFC February 2015 - http://tools.ietf.org/html/rfc7398 + https://tools.ietf.org/html/rfc7398 RFC 7594 @@ -1454,7 +1596,7 @@ IETF Informational RFC September 2015 - http://tools.ietf.org/html/rfc7594 + https://tools.ietf.org/html/rfc7594 RFC 7597 @@ -1462,7 +1604,7 @@ IETF RFC July 2015 - http://tools.ietf.org/html/rfc7597 + https://tools.ietf.org/html/rfc7597 RFC 7598 @@ -1470,7 +1612,7 @@ IETF RFC July 2015 - http://tools.ietf.org/html/rfc7598 + https://tools.ietf.org/html/rfc7598 RFC 7599 @@ -1478,188 +1620,68 @@ IETF RFC July 2015 - http://tools.ietf.org/html/rfc7599 + https://tools.ietf.org/html/rfc7599 Simple Object Access Protocol (SOAP) 1.1 W3C - http://www.w3.org/TR/2000/NOTE-SOAP-20000508 + https://www.w3.org/TR/2000/NOTE-SOAP-20000508 - TR-064 + TR-064 Corrigendum 1 LAN-Side DSL CPE Configuration Specification Broadband Forum Technical Report - 2004 - http://www.broadband-forum.org/technical/download/TR-064.pdf + August 2015 + https://www.broadband-forum.org/technical/download/TR-064.pdf - TR-069 + TR-069 Amendment 6 CPE WAN Management Protocol Broadband Forum Technical Report - 2004 - http://www.broadband-forum.org/technical/download/TR-069.pdf - - - TR-069 Amendment 2 - CPE WAN Management Protocol - Broadband Forum - Technical Report - 2007 - http://www.broadband-forum.org/technical/download/TR-069_Amendment-2.pdf - - - TR-069 Amendment 3 - CPE WAN Management Protocol - Broadband Forum - Technical Report - 2010 - http://www.broadband-forum.org/technical/download/TR-069_Amendment-3.pdf - - - TR-069 Amendment 4 - CPE WAN Management Protocol - Broadband Forum - Technical Report - 2011 - http://www.broadband-forum.org/technical/download/TR-069_Amendment-4.pdf - - - TR-069 Amendment 5 - CPE WAN Management Protocol - Broadband Forum - Technical Report - December 2013 - http://www.broadband-forum.org/technical/download/TR-069_Amendment-5.pdf - - - TR-098 - Internet Gateway Device Data Model for TR-069 - Broadband Forum - Technical Report - 2005 - http://www.broadband-forum.org/technical/download/TR-098.pdf + April 2018 + https://www.broadband-forum.org/technical/download/TR-069.pdf - TR-106 - Data Model Template for TR-069-Enabled Devices + TR-106 Amendment 8 + Data Model Template for CWMP Endpoints and USP Agents Broadband Forum Technical Report - 2005 - http://www.broadband-forum.org/technical/download/TR-106.pdf + May 2018 + https://www.broadband-forum.org/technical/download/TR-106.pdf - - TR-106 Amendment 2 - Data Model Template for TR-069-Enabled Devices + + TR-106 Amendment 8 + Data Model Template for CWMP Endpoints and USP Agents Broadband Forum Technical Report - 2008 - http://www.broadband-forum.org/technical/download/TR-106_Amendment-2.pdf - - - TR-106 Amendment 3 - Data Model Template for TR-069-Enabled Devices - Broadband Forum - Technical Report - 2009 - http://www.broadband-forum.org/technical/download/TR-106_Amendment-3.pdf - - - TR-106 Amendment 4 - Data Model Template for TR-069-Enabled Devices - Broadband Forum - Technical Report - 2010 - http://www.broadband-forum.org/technical/download/TR-106_Amendment-4.pdf - - - TR-106 Amendment 5 - Data Model Template for TR-069-Enabled Devices - Broadband Forum - Technical Report - 2010 - http://www.broadband-forum.org/technical/download/TR-106_Amendment-5.pdf - - - TR-106 Amendment 6 - Data Model Template for TR-069-Enabled Devices - Broadband Forum - Technical Report - 2011 - http://www.broadband-forum.org/technical/download/TR-106_Amendment-6.pdf - - - TR-106 Amendment 7 - Data Model Template for TR-069-Enabled Devices - Broadband Forum - Technical Report - 2013 - http://www.broadband-forum.org/technical/download/TR-106_Amendment-7.pdf + May 2018 + https://www.broadband-forum.org/technical/download/TR-106_Amendment-8.pdf - TR-143 + TR-143 Amendment 3 Enabling Network Throughput Performance Tests and Statistical Monitoring Broadband Forum Technical Report - 2008 - http://www.broadband-forum.org/technical/download/TR-143.pdf - - - TR-143 Amendment 1 - Enabling Network Throughput Performance Tests and Statistical Monitoring - Broadband Forum - Technical Report - December 2014 - http://www.broadband-forum.org/technical/download/TR-143_Amendment-1.pdf - - - TR-157 - Component Object for CWMP - Broadband Forum - Technical Report - March 2009 - http://www.broadband-forum.org/technical/download/TR-157.pdf - - - TR-157 Amendment 10 - Component Objects for CWMP - Broadband Forum - Technical Report - 2015 - http://www.broadband-forum.org/technical/download/TR-157_Amendment-10.pdf - - - TR-157 Amendment 3 - Component Objects for CWMP - Broadband Forum - Technical Report - 2010 - http://www.broadband-forum.org/technical/download/TR-157_Amendment-3.pdf + May 2017 + https://www.broadband-forum.org/technical/download/TR-143.pdf TR-159 Management Framework for xDSL Bonding Broadband Forum Technical Report - 2008 - http://www.broadband-forum.org/technical/download/TR-159.pdf - - - TR-181 Issue 1 - Device Data Model for TR-069 - Broadband Forum - Technical Report - 2010 - http://www.broadband-forum.org/technical/download/TR-181_Issue-1.pdf + December 2008 + https://www.broadband-forum.org/technical/download/TR-159.pdf - TR-181 Issue 2 - Device Data Model for TR-069 + TR-181 Issue 2 Amendment 13 + Device Data Model Broadband Forum Technical Report - 2010 - http://www.broadband-forum.org/technical/download/TR-181_Issue-2.pdf + September 2019 + https://www.broadband-forum.org/technical/download/TR-181_Issue-2.pdf TR-232 @@ -1667,79 +1689,55 @@ Broadband Forum Technical Report May 2012 - http://www.broadband-forum.org/technical/download/TR-232.pdf + https://www.broadband-forum.org/technical/download/TR-232.pdf TR-262 Femto Component Objects Broadband Forum Technical Report - 2011 - http://www.broadband-forum.org/technical/download/TR-262.pdf + November 2011 + https://www.broadband-forum.org/technical/download/TR-262.pdf TR-304 Broadband Access Service Attributes and Performance Metrics Broadband Forum Technical Report - March 2015 - http://www.broadband-forum.org/technical/download/TR-304.pdf + February 2015 + https://www.broadband-forum.org/technical/download/TR-304.pdf - WT-390 + TR-390 Performance Measurement from Customer Equipment to IP Edge Broadband Forum Technical Report - November 2016 - http://www.broadband-forum.org/technical/download/TR-390.pdf - - - TR-181 Issue 2 Amendment 2 - Device Data Model for TR-069 - Broadband Forum - Technical Report - 2011 - http://www.broadband-forum.org/technical/download/TR-181_Issue-2_Amendment-2.pdf - - - TR-181 Issue 2 Amendment 5 - Device Data Model for TR-069 - Broadband Forum - Technical Report - 2012 - http://www.broadband-forum.org/technical/download/TR-181_Issue-2_Amendment-5.pdf - - - TR-181 Issue 2 Amendment 8 - Device Data Model for TR-069 - Broadband Forum - Technical Report - September 2014 - http://www.broadband-forum.org/technical/download/TR-181_Issue-2_Amendment-8.pdf + May 2017 + https://www.broadband-forum.org/technical/download/TR-390.pdf Universal Powerline Association UPA - http://www.upaplc.org + https://www.upaplc.org UPnP Device Architecture UPnP Device Architecture 1.0 UPnP Forum April 2008 - http://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0-20080424.pdf + https://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0-20080424.pdf UPnP Device Architecture 1.1 UPnP Device Architecture 1.1 UPnP Forum October, 2008 - http://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf + https://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf UPnP Device Management:1 UPnP Device Management v1 - http://upnp.org/specs/dm/dm1/ + https://upnp.org/specs/dm/dm1/ UPnP InternetGatewayDevice:1 @@ -1747,7 +1745,7 @@ UPnP SDCP 2001 - http://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v1-Device.pdf + https://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v1-Device.pdf UPnP InternetGatewayDevice:2 @@ -1755,60 +1753,87 @@ UPnP SDCP 2010 - http://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v2-Device.pdf + https://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v2-Device.pdf USB 1.0 USB 1.0 Specification USB-IF January 1996 - http://www.usb.org/developers/docs/ + https://www.usb.org/developers/docs/ USB 2.0 USB 2.0 Specification USB-IF April 2000 - http://www.usb.org/developers/docs/usb_20_122208.zip + https://www.usb.org/developers/docs/usb_20_122208.zip USB 3.0 USB 3.0 Specification USB-IF November 2008 - http://www.usb.org/developers/docs/usb_30_spec.zip + https://www.usb.org/developers/docs/usb_30_spec.zip WSC 2.0 Wi-Fi Simple Configuration Technical Specification Version 2.0.x Wi-Fi Alliance - http://www.wi-fi.org/discover-wi-fi/wi-fi-protected-setup + https://www.wi-fi.org/discover-wi-fi/wi-fi-protected-setup Wi-Fi Protected Setup Specification Version 1.0h Wi-Fi Alliance 2006 - http://www.wi-fi.org + https://www.wi-fi.org Z-Wave Z-Wave website - http://www.z-wave.com + https://www.z-wave.com ZigBee ZigBee Alliance website - http://www.zigbee.org + https://www.zigbee.org ZigBee 2007 Specification ZigBee 2007 Specification ZigBee Alliance October 2007 - http://www.zigbee.org/Specifications/ZigBee/download.aspx + https://www.zigbee.org/Specifications/ZigBee/download.aspx - + + + + + + + + + + The top-level object for a Device. @@ -2006,7 +2031,7 @@ - Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters. + Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters. @@ -2084,8 +2109,8 @@ - Every instance of this object is a Vendor Configuration File, and contains parameters associated with the Vendor Configuration File. - This table of Vendor Configuration Files is for information only and does not allow the ACS to operate on these files in any way. + Every instance of this object is a Vendor Configuration File, and contains parameters associated with the Vendor Configuration File. + This table of Vendor Configuration Files is for information only and does not allow the Controller to operate on these files in any way. Whenever the CPE successfully downloads a configuration file as a result of the Download RPC with the FileType argument of ''3 Vendor Configuration File'', the CPE MUST update this table. @@ -2198,7 +2223,7 @@ {{numentries}} - Since a Process can come and go very quickly, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of value changes, as described in {{bibref|TR-069a2|Section 3.2.1}}. + Since a Process can come and go very quickly, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of value changes, as described in {{bibref|TR-069|Section 3.2.1}}. @@ -2354,7 +2379,7 @@ * {{param|Status}} transition from {{enum|Disabled|Status}} to {{enum|Enabled|Status}} * {{param|Reset}} set to {{true}}. * An internal reset of the temperature sensor (including a reboot of the device). - The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates that this temperature sensor has never been reset, which can only happen if it has never been enabled. + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates that this temperature sensor has never been reset, which can only happen if it has never been enabled. @@ -2385,7 +2410,7 @@ The time at which this temperature sensor's last good reading was obtained. - The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates a good reading has not been obtained since last reset. + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates a good reading has not been obtained since last reset. @@ -2406,7 +2431,7 @@ The time at which this temperature sensor's lowest value was read. - The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates a good reading has not been obtained since last reset. + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates a good reading has not been obtained since last reset. @@ -2427,7 +2452,7 @@ The time at which this temperature sensor's highest value was read. - The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates a good reading has not been obtained since last reset. + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates a good reading has not been obtained since last reset. @@ -2450,7 +2475,7 @@ Initial time at which this temperature sensor's {{param|LowAlarmValue}} was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. - The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates that an alarm has not been encountered since the last reset. + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates that an alarm has not been encountered since the last reset. @@ -2485,7 +2510,7 @@ Initial time at which this temperature sensor's {{param|HighAlarmValue}} was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. - The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates that an alarm has not been encountered since the last reset. + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates that an alarm has not been encountered since the last reset. @@ -2556,7 +2581,7 @@ The architecture of the processor on the underlying hardware. {{enum}} - For processor architectures not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref|TR-106a4|Section 3.3}}. + For processor architectures not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref|TR-106|Section 3.3}}. @@ -2593,12 +2618,12 @@ Each table entry represents a Vendor Log File. - This table of log files is informational only and does not allow the ACS to operate on these files in any way. + This table of log files is informational only and does not allow the Controller to operate on these files in any way. - + @@ -2674,7 +2699,7 @@ URL, MAC address, or other identifier that identifies an "External" source of this location. Meaningful only if {{param|Source}} has a value of {{enum|External|Source}}, otherwise it MUST be {{empty}}. - If {{param|ExternalProtocol}} has a value of {{enum|CWMP|ExternalProtocol}}, this is the URL or IP address of the ACS. + If {{param|ExternalProtocol}} has a value of {{enum|CWMP|ExternalProtocol}}, this is the URL or IP address of the Controller. @@ -2693,6 +2718,7 @@ + @@ -2709,13 +2735,13 @@ The currently valid location information. - Writable only when {{param|ExternalProtocol}} has a value of {{enum|CWMP|ExternalProtocol}}. + Writable only when {{param|ExternalProtocol}} has a value of {{enum|CWMP|ExternalProtocol}} or {{enum|USP|ExternalProtocol}}. If obtained through the local GPS/AGPS then the location information is formatted according to {{bibref|RFC5491}}. If manually configured then location information will be XML-formatted according to {{bibref|RFC5491}} (geographical information) and {{bibref|RFC5139}} (civic addresses). If obtained by an external source this is the location information as received. If it's an XML document (e.g. CWMP, OMA-DM, UPnP, HELD, MLP) the location information will be represented as-is, otherwise it will be converted to base64. - CWMP configured location information will be XML-formatted according to {{bibref|RFC5491}} (geographical information) and {{bibref|RFC5139}} (civic addresses). - Only zero or one Location object instance with value {{enum|CWMP|ExternalProtocol}} MUST exist at any given time. + CWMP or USP configured location information will be XML-formatted according to {{bibref|RFC5491}} (geographical information) and {{bibref|RFC5139}} (civic addresses). + Only zero or one Location object instance with value {{enum|CWMP|ExternalProtocol}} or {{enum|USP|ExternalProtocol}} MUST exist at any given time. @@ -2905,7 +2931,7 @@ URL ({{bibref|RFC3986}}) that describes some or all of the device's Current Supported Data Model. The URL MUST reference an XML file which describes the appropriate part of the Supported Data Model. - The referenced XML file MUST be compliant with the DT (Device Type) Schema that is described in {{bibref|TR-106a3|Annex B}}, including any additional normative requirements referenced within the Schema. + The referenced XML file MUST be compliant with the DT (Device Type) Schema that is described in {{bibref|TR-106|Annex B}}, including any additional normative requirements referenced within the Schema. The XML file referenced by this URL MUST NOT change while the CPE is running, and SHOULD NOT change across a CPE reboot. Note that {{param|UUID}} is a unique key, so the XML file referenced by this URL will never change. The XML file MAY be located within the CPE. In this scenario the CPE MAY use the value of "localhost" as URL host portion, When the "localhost" value is used, the ACS has the responsibility to substitute the "localhost" value with the host portion of the connection request URL. Behavior in the event of an invalid URL, failure to access the referenced XML file, or an invalid XML file, is implementation-dependent. @@ -2927,7 +2953,7 @@ URN ({{bibref|RFC3986}}) that is the value of the spec attribute in the DM (data model) Instance that defines the Root Object or Service Object referenced by this table entry. - For example, if this table entry references a DT Instance that refers to the ''Device:1.3'' Root Object, the value of this parameter would be ''urn:broadband-forum-org:tr-157-1-0-0'', because TR-157 defines ''Device:1.3''. If the DT Instance instead referred to a vendor-specific Root Object, e.g. ''X_EXAMPLE_Device:1.0'' (derived from ''Device:1.3''), the value of this parameter would be something like ''urn:example-com:device-1-0-0''. + For example, if this table entry references a DT Instance that refers to the ''Device:2.13'' Root Object, the value of this parameter would be ''urn:broadband-forum-org:tr-181-2-13-0''. If the DT Instance instead referred to a vendor-specific Root Object, e.g. ''X_EXAMPLE_Device:1.0'' (derived from ''Device:1.3''), the value of this parameter would be something like ''urn:example-com:device-1-0-0''. @@ -2942,7 +2968,7 @@ :<feature name="DNSServer"/> :<feature name="Router"/> :<feature name="X_MyDeviceFeature"/> - then the value of this parameter might be ''DNSServer,Router,X_MyDeviceFeature''. The order in which the features are listed is not significant. + then the value of this parameter might be ''DNSServer,Router,X_MyDeviceFeature''. The order in which the features are listed is not significant. @@ -2952,7 +2978,7 @@ - Represents the associated CPE Proxier for a Proxied Device that utilizes the Virtual CWMP Device Mechanism {{bibref|TR-069a4|Annex J.1.1}}. + Represents the associated CPE Proxier for a Proxied Device that utilizes the Virtual CWMP Device Mechanism {{bibref|TR-069|Annex J.1.1}}. @@ -2990,7 +3016,7 @@ The protocol being used to communicate between the CPE Proxier and this Proxied Device. {{enum}} - Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a6|3.3}} MUST be adhered to. + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|3.3}} MUST be adhered to. @@ -3117,7 +3143,7 @@ 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 {{param|PeriodicInformInterval}}. {{param}} is used only to set the ''phase'' of the periodic Informs. The actual value of {{param}} can be arbitrarily far into the past or future. For example, if {{param|PeriodicInformInterval}} is 86400 (a day) and if {{param}} 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 {{param}} refers to a day in the future. - The Unknown Time value defined in {{bibref|TR-106a2|section 3.2}} 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 {{param|PeriodicInformInterval}}. + The Unknown Time value defined in {{bibref|TR-106|section 3.2}} 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 {{param|PeriodicInformInterval}}. If absolute time is not available to the CPE, its periodic Inform behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. @@ -3216,8 +3242,8 @@ - Configures the first session retry wait interval, in {{units}}, as specified in {{bibref|TR-069a2|section 3.2.1.1}}. - A value of 5 corresponds to the default behavior that is described in {{bibref|TR-069a2}}. + Configures the first session retry wait interval, in {{units}}, as specified in {{bibref|TR-069|section 3.2.1.1}}. + A value of 5 corresponds to the default behavior that is described in {{bibref|TR-069}}. The device MUST use a random value between {{param}} and ({{param}} * {{param|CWMPRetryIntervalMultiplier}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. @@ -3229,9 +3255,9 @@ - Configures the retry interval multiplier as specified in {{bibref|TR-069a2|section 3.2.1.1}}. + Configures the retry interval multiplier as specified in {{bibref|TR-069|section 3.2.1.1}}. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. - A value of 2000 corresponds to the default behavior that is described in {{bibref|TR-069a2}}. + A value of 2000 corresponds to the default behavior that is described in {{bibref|TR-069}}. The device MUST use a random value between {{param|CWMPRetryMinimumWaitInterval}} and ({{param|CWMPRetryMinimumWaitInterval}} * {{param}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. @@ -3252,7 +3278,7 @@ - Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see {{bibref|TR-069a2|Annex G}}). + Address and port to which an ACS MAY send a UDP Connection Request to the CPE (see {{bibref|TR-069|Annex G}}). This parameter is represented in the form of an Authority element as defined in {{bibref|RFC3986}}. The value MUST be in one of the following two forms: : host:port : host @@ -3353,7 +3379,7 @@ Indicates whether or not the Alias-Based Addressing Mechanism is supported. - A {{true}} value indicates that the CPE supports the Alias-Based Addressing Mechanism, as defined in {{bibref|TR-069a4|3.6.1}} and described in {{bibref|TR-069a4|Appendix II}}. + A {{true}} value indicates that the CPE supports the Alias-Based Addressing Mechanism, as defined in {{bibref|TR-069|3.6.1}} and described in {{bibref|TR-069|Appendix II}}. @@ -3361,7 +3387,7 @@ - Instance identification mode as defined in {{bibref|TR-069a4|3.6.1}}. When {{param|AliasBasedAddressing}} is {{true}}, {{param}} is used by the ACS to control whether the CPE will use Instance Numbers or Instance Aliases in returned Path Names. {{enum}} + Instance identification mode as defined in {{bibref|TR-069|3.6.1}}. When {{param|AliasBasedAddressing}} is {{true}}, {{param}} is used by the ACS to control whether the CPE will use Instance Numbers or Instance Aliases in returned Path Names. {{enum}} This parameter is REQUIRED for any CPE supporting Alias-Based Addressing. @@ -3374,7 +3400,7 @@ - Enable or disable the Auto-Create Instance Mechanism. When {{param|AliasBasedAddressing}} is {{true}}, {{param}} indicates whether or not the CPE will automatically create instances while processing a SetParameterValues RPC (as defined in {{bibref|TR-069a4|A.3.2.1}}). + Enable or disable the Auto-Create Instance Mechanism. When {{param|AliasBasedAddressing}} is {{true}}, {{param}} indicates whether or not the CPE will automatically create instances while processing a SetParameterValues RPC (as defined in {{bibref|TR-069|A.3.2.1}}). *A {{true}} value indicates that the CPE will perform auto-creation of instances when the Alias-Based Addressing Mechanism is used in SetParameterValues RPC. *A {{false}} value indicates that the CPE will not create new object instances. Instead, it will reject the setting of parameters in unrecognized instances and respond with a fault code. This parameter is REQUIRED for any CPE supporting Alias-Based Addressing. @@ -3435,7 +3461,7 @@ - The connection request method as specified in {{bibref|TR-069a5|Annex K XMPP Connection Request}} + The connection request method as specified in {{bibref|TR-069|Annex K XMPP Connection Request}} @@ -3484,8 +3510,8 @@ - Indicates the HTTP Compression mechanism(s) supported by this CPE. Requirements for the use of HTTP Compression for CWMP can be found in {{bibref|TR-069a5|Section 3.4.7}}. {{enum}} - Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a7|Section 3.3}} MUST be adhered to. + Indicates the HTTP Compression mechanism(s) supported by this CPE. Requirements for the use of HTTP Compression for CWMP can be found in {{bibref|TR-069|Section 3.4.7}}. {{enum}} + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to. @@ -3522,14 +3548,14 @@ Indicates the Lightweight Notification Protocol(s) supported by this CPE. {{enum}} - Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a7|Section 3.3}} MUST be adhered to. + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to. - As defined in {{bibref|TR-069a5|Annex M}} + As defined in {{bibref|TR-069|Annex M}} @@ -3562,7 +3588,7 @@ An absolute time reference in UTC to determine when the CPE will initiate the Lightweight Notification (in the case that there are pending Passive Lightweight Notifications that need to be delivered). Each Passive Lightweight Notification (that is waiting for the Lightweight Notification Trigger mechanism for delivery) MUST occur at this reference time plus or minus an integer multiple of the {{param|LightweightNotificationTriggerInterval}}. {{param}} is used only to set the ''phase'' of the Passive Lightweight Notification. The actual value of {{param}} can be arbitrarily far into the past or future. - For example, if {{param|LightweightNotificationTriggerInterval}} is 86400 (a day) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then Lightweight Notifications for pending Passive Lightweight Notifications will occur every day at UTC midnight. These MUST begin on the very next midnight, even if {{param}} refers to a day in the future. The Unknown Time value defined in {{bibref|TR-106a2|section 3.2}} 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 {{param|LightweightNotificationTriggerInterval}}. If absolute time is not available to the CPE, its Lightweight Notifications behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. + For example, if {{param|LightweightNotificationTriggerInterval}} is 86400 (a day) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then Lightweight Notifications for pending Passive Lightweight Notifications will occur every day at UTC midnight. These MUST begin on the very next midnight, even if {{param}} refers to a day in the future. The Unknown Time value defined in {{bibref|TR-106|section 3.2}} 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 {{param|LightweightNotificationTriggerInterval}}. If absolute time is not available to the CPE, its Lightweight Notifications behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. @@ -3593,7 +3619,7 @@ Indicates whether or not instance wildcards are supported. - A {{true}} value indicates that the CPE supports instance wildcards for GPV, GPN and GPA RPC calls, as defined in [TR-069a6]. + A {{true}} value indicates that the CPE supports instance wildcards for GPV, GPN and GPA RPC calls, as defined in [TR-069]. @@ -3610,7 +3636,7 @@ - Each entry in this table corresponds to a distinct LAN Device that supports Device-Gateway Association according to {{bibref|TR-069a2|Annex F}} as indicated by the presence of the DHCP option specified in that Annex. + Each entry in this table corresponds to a distinct LAN Device that supports Device-Gateway Association according to {{bibref|TR-069|Annex F}} as indicated by the presence of the DHCP option specified in that Annex. @@ -3681,7 +3707,7 @@ - This object allows configuration of CPE policy for notification of AUTONOMOUS TRANSFER COMPLETE events, defined in {{bibref|TR-069a2}}. + This object allows configuration of CPE policy for notification of AUTONOMOUS TRANSFER COMPLETE events, defined in {{bibref|TR-069}}. The CPE policy determines the conditions under which the CPE notifies the ACS of the completion of file transfers that were not specifically requested by the ACS. @@ -3920,7 +3946,7 @@ - This object allows configuration of CPE policy for notification of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events defined in {{bibref|TR-069a3}}. + This object allows configuration of CPE policy for notification of "12 AUTONOMOUS DU STATE CHANGE COMPLETE" events defined in {{bibref|TR-069}}. The CPE policy determines the conditions under which the CPE notifies the ACS of the completion of Deployment Unit state changes that were not specifically requested via CWMP. @@ -4002,7 +4028,7 @@ - Each entry in this table represents a distinct Proxied Device that utilizes the Embedded Object Mechanism {{bibref|TR-069a4|Annex J.1.2}} for proxying devices. + Each entry in this table represents a distinct Proxied Device that utilizes the Embedded Object Mechanism {{bibref|TR-069|Annex J.1.2}} for proxying devices. @@ -4034,7 +4060,7 @@ - {{noreference}}The value MUST be the path name of a table row. If the referenced object is deleted, this {{object}} instance MUST also be removed. Represents the instance of a multi-instanced object that is directly controlled by, and has come into existence because of, this Proxied Device that utilizes the Embedded Object Mechanism {{bibref|TR-069a4|Annex J.1.2}}. + {{noreference}}The value MUST be the path name of a table row. If the referenced object is deleted, this {{object}} instance MUST also be removed. Represents the instance of a multi-instanced object that is directly controlled by, and has come into existence because of, this Proxied Device that utilizes the Embedded Object Mechanism {{bibref|TR-069|Annex J.1.2}}. @@ -4067,7 +4093,7 @@ The protocol being used to communicate between the CPE Proxier and this Proxied Device. {{enum}} - Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a6|3.3}} MUST be adhered to. + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|3.3}} MUST be adhered to. @@ -4108,7 +4134,7 @@ {{list|that represents the discovery protocol(s) for this proxied device}} {{enum}} - Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a3|Section 3.3}} MUST be adhered to. + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to. @@ -4178,7 +4204,7 @@ The last time that the CPE Proxier synchronized the state of the Proxied Device. This parameter MUST be updated when a proxy command is executed successfully on the Proxied Device. - The Unknown Time value, as defined in {{bibref|TR-106a6}}, indicates that the Proxied Device's state has not been synchronized since the CPE Proxier was last rebooted. + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates that the Proxied Device's state has not been synchronized since the CPE Proxier was last rebooted. @@ -4187,7 +4213,7 @@ - Each entry in this table represents a distinct Proxied Device that utilizes the Virtual CWMP Device Mechanism {{bibref|TR-069a4|Annex I.1.1}} for proxying devices. + Each entry in this table represents a distinct Proxied Device that utilizes the Virtual CWMP Device Mechanism {{bibref|TR-069|Annex I.1.1}} for proxying devices. @@ -4240,7 +4266,7 @@ The protocol being used to communicate between the CPE Proxier and this Proxied Device. {{enum}} - Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a6|3.3}} MUST be adhered to. + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|3.3}} MUST be adhered to. @@ -4281,7 +4307,7 @@ {{list|that represents the discovery protocol(s) for this proxied device}} {{enum}} - Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a3|Section 3.3}} MUST be adhered to. + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to. @@ -4328,7 +4354,7 @@ - Parameters related to CPE behavior when waking up from standby. If this object is supported then the CPE MUST support the requirements of {{bibref|TR-069a5|Annex L}}. + Parameters related to CPE behavior when waking up from standby. If this object is supported then the CPE MUST support the requirements of {{bibref|TR-069|Annex L}}. NOTE: "CR", as used in the names and descriptions of the parameters defined in this object, refers to the Connection Request concept defined in TR-069. @@ -4493,7 +4519,7 @@ An absolute time reference in UTC to determine when the CPE will initiate the Heartbeat event Inform method calls. Each Inform call MUST occur at this reference time plus or minus an integer multiple of the {{param|ReportingInterval}}. {{param}} is used only to set the ''phase'' of the Heartbeat event Informs. The actual value of {{param}} can be arbitrarily far into the past or future. For example, if {{param|ReportingInterval}} is 60 (one minute) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then Heartbeat Informs will occur every minute at the next UTC midnight. These MUST begin on the very next midnight, even if {{param}} refers to a day in the future. - The Unknown Time value defined in {{bibref|TR-106a2|section 3.2}} indicates that no particular time reference is specified. The CPE MUST locally choose a random time reference. + The Unknown Time value defined in {{bibref|TR-106|section 3.2}} indicates that no particular time reference is specified. The CPE MUST locally choose a random time reference. If absolute time is not available to the CPE, its Heartbeat Inform behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. @@ -4768,7 +4794,7 @@ - A Universally Unique Identifier either provided by the ACS, or generated by the CPE, at the time of Deployment Unit Installation. The format of this value is defined by {{bibref|RFC4122}} Version 3 (Name-Based) and {{bibref|TR-069a3|Annex H}}. + A Universally Unique Identifier either provided by the ACS, or generated by the CPE, at the time of Deployment Unit Installation. The format of this value is defined by {{bibref|RFC4122}} Version 3 (Name-Based) and {{bibref|TR-181i2|Annex C}}. This value MUST NOT be altered when the {{object}} is updated. @@ -4798,7 +4824,7 @@ Indicates the Name of this {{object}}, which is chosen by the author of the Deployment Unit. - The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-069a3|Annex H}}. + The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-181i2|Annex C}}. @@ -4871,7 +4897,7 @@ The author of this {{object}} formatted as a domain name. - The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-069a3|Annex H}}. + The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-181i2|Annex C}}. @@ -5043,7 +5069,7 @@ If while running or transitioning between states this {{object}} identifies a fault this parameter embodies the problem. The value of {{enum|NoFault}} MUST be used when everything is working as intended. {{enum}} - For fault codes not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref|TR-106a4|Section 3.3}}. + For fault codes not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref|TR-106|Section 3.3}}. @@ -5101,7 +5127,7 @@ - Version of the {{object}}. The format of this value is Execution Environment specific. + Version of the {{object}}. The format of this value is Execution Environment specific. @@ -5143,7 +5169,7 @@ - Represents the instances of multi-instanced objects that are directly controlled by, and have come into existence because of, this {{object}}. See {{bibref|TR-157a3|Appendix II.3.2}} for more description and some examples. + Represents the instances of multi-instanced objects that are directly controlled by, and have come into existence because of, this {{object}}. See {{bibref|TR-069|Appendix VI.3.2}} for more description and some examples. NOTE: All other objects and parameters (i.e. not multi-instanced objects) that this {{object}} has caused to come into existence can be discovered via the {{object|.DeviceInfo.SupportedDataModel.{i}.}} table. @@ -5217,7 +5243,7 @@ This object proposes a general location for vendor extensions specific to this Execution Unit, which allows multiple Execution Units to expose parameters without the concern of conflicting parameter names. These vendor extensions are related to displaying status and maintaining configuration for this Execution Unit. It is also possible for the Execution Unit to expose status and configuration parameters within Service objects or as embedded objects and parameters directly within the root data model, in which case the combination of {{param|#.References}} and {{param|#.SupportedDataModelList}} will be used to determine their locations. - See {{bibref|TR-157a3|Appendix II.3.2}} for more description and some examples. + See {{bibref|TR-069|Appendix VI.3.2}} for more description and some examples. @@ -5644,7 +5670,7 @@ A schedule string is formatted according to the date and time fields defined CRONTAB input file definition in {{bibref|POSIXBase}}. The {{param}} parameter is used to set the recurrence of the schedule. The timezone used for this parameter is dependent upon the existence of instances of {{object|AbsTimeSpan}} for this {{object}}. If instances of {{object|AbsTimeSpan}} exist, then the timezone of the {{object|AbsTimeSpan}} is used otherwise the UTC timezone is used for this {{param}} parameter. - Note the command field is not used in this definition and any whitespace or comma characters within a Schedule string MUST be escaped using percent as defined in {{bibref|TR-106a5|section 3.2.3}} + Note the command field is not used in this definition and any whitespace or comma characters within a Schedule string MUST be escaped using percent as defined in {{bibref|TR-106|section 3.2.3}} Example of CRONTAB string: *"* 0-6 * * 1-5" would mean every minute for the period from 0:00h to 6:00h (inclusive) on any week day (Monday through Friday) and would be represented as "*%200-6%20*%20*%201-5" *"*/15 22-23,0-4 * * 1-5" would mean every 15 minutes for the period from 22:00h to 04:00h on any week day (Monday through Friday) and would be represented as "*/15%2022-23%2C0-4%20*%20*%201-5" @@ -8751,7 +8777,7 @@ DSL bonding group table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). Each instance is a bonding group, and is expected to be stacked above a {{object|.DSL.Channel}} instance or a {{object|.FAST.Line}} instance for each bonded channel in the group. - Many of the parameters within this object, including {{param|LowerLayers}}, are read-only because bonding is not expected to be configured via {{bibref|TR-069}}. + Many of the parameters within this object, including {{param|LowerLayers}}, are read-only because bonding is not expected to be configured by a Controller. The DSL bonding data model is closely aligned with {{bibref|TR-159}}. Corresponds to {{bibref|TR-159}} ''oBondingGroup''. @@ -8822,7 +8848,7 @@ {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. - {{param}} is read-only for this object because bonding is expected to be configured by the CPE, not by the ACS. + {{param}} is read-only for this object because bonding is expected to be configured by the CPE, not by the Controller. @@ -9021,7 +9047,7 @@ {{reference}}This is the channel that is being bonded. - This is read-only because bonding is expected to be configured by the CPE, not by the ACS. + This is read-only because bonding is expected to be configured by the CPE, not by the Controller. @@ -10197,6 +10223,502 @@ + + + This object contains DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Uncalibrated Echo Response (UER) diagnostics parameters. + This object is for the CPE, aka the Transmission Unit - Remote end (TU-R). + Reference: ITU-T Recommendation {{bibref|G.996.2|Clause A.2, SELT-PMD management entity}}. + + + + {{datatype|expand}} + + + + + + + + + + + + + + {{reference}} This is the interface over which the test is to be performed. + + + + + + + + + + + This parameter is the SELT UER maximum measurement duration (MMD) measured in {{units}}. + This parameter is defined as SELT_UER_MMD_R in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.1.1}}. + + + + + + + + + + + This parameter indicates if the option for extended bandwidth SELT is applied ({{true}}) or not applied ({{false}}). + If the option for extended bandwidth SELT is applied to UER, then {{param|UERGroupSize}} has three valid values: 1, 2 and 12. + If the option for extended bandwidth SELT is not applied to UER, then {{param|UERGroupSize}} has two valid values: 1 and 2. + {{param|UERGroupSize}} is reported if the option for extended bandwidth UER SELT is supported; otherwise, reporting of the group size is optional. + + + + + + + + The Uncalibrated Echo Response (UER) [a(0),b(0)], [a(1),b(1)], ... + {{list|with each list item consisting of:}} + {{datatype|expand}} + The value of UER at frequency i*{{param|UERGroupSize}}*Df = ({{param|UERScaleFactor}}/(2^31))*(a(i)+j*b(i))/(2^31) where Df = 4.3125 kHz. + This parameter is defined as CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.2.1}}. + + + + + + + + + The Uncalibrated Echo Response (UER) scale factor. + This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.2.1}}. + + + + + + + + The Uncalibrated Echo Response (UER) group size, UER_G. In units of {{units}}. + This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.2.1}}. + + + + + + + + + + + + This parameter represents the variance of the {{param|UER}}. List items represent v(i), for values of i starting at i=0. The variance of the uncalibrated echo response for frequency i*{{param|UERGroupSize}}*Df is VAR(i*{{param|UERGroupSize}}*Df) = 3 - v(i)/2 dB where Df = 4.3125 kHz. + This parameter is defined as SELT variance of uncalibrated echo response R (SELT UER-VAR-R) in {{bibref|G.996.2|Clause A.2.2.2}}. + + + + + + + + + + This object contains DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Quiet Line Noise (QLN) diagnostics parameters. + This object is for the CPE, aka the Transmission Unit - Remote end (TU-R). + Reference: ITU-T Recommendation {{bibref|G.996.2|Clause A.2, SELT-PMD management entity}}. + + + + {{datatype|expand}} + + + + + + + + + + + + + + {{reference}} This is the interface over which the test is to be performed. + + + + + + + + + + + This parameter is the SELT QLN maximum measurement duration (MMD) measured in {{units}}. + This parameter is defined as SELT_QLN_MMD_R in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.1.2}}. + + + + + + + + + + + This parameter indicates if the option for extended bandwidth SELT is applied ({{true}}) or not applied ({{false}}). + If the option for extended bandwidth SELT is applied to QLN, then {{param|QLNGroupSize}} has three valid values: 1, 2 and 12. + If the option for extended bandwidth SELT is not applied to QLN, then {{param|QLNGroupSize}} has two valid values: 1 and 2. + {{param|QLNGroupSize}} is reported if the option for extended bandwidth QLN SELT is supported; otherwise, reporting of the group size is optional. + + + + + + + + {{list}} List items represent SELT quiet line noise (QLN) per subcarrier group. + Each list element is n(i), with i starting at 0. The value of QLN at frequency i*{{param|QLNGroupSize}}*Df with Df=4.3125 kHz is defined as QLN(i*{{param|QLNGroupSize}}*Df) = -23 - (n(i)/2) dBm/Hz. This data format supports a QLN granularity of 0.5 dB and an dynamic range of -150 to -23 dBm/Hz. + Interpretation of the SELT_QLN_R value is defined in {{bibref|G.996.2|Clause A.2.2.3}}. + + + + + + + + + + + This parameter represents the Quiet Line Noise (QLN) group size. In units of {{units}}. + This parameter is defined as part of the SELT_QLN_R in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.2.3}}. + + + + + + + + + + + + + This object contains DSL Single-Ended Line Test - Processed (SELT-P) diagnostics parameters. + This object is for the CPE, aka the Transmission Unit - Remote end (TU-R). + Reference: ITU-T Recommendation {{bibref|G.996.2}}. + + + + {{datatype|expand}} + + + + + + + + + + + + + + {{reference}} This is the interface over which the test is to be performed. + + + + + + + + + + + Capacity estimate calculation enabling: This parameter is expressed as a boolean and takes the value {{false}} if xDSL performance estimation is not required, {{true}} otherwise. + The capacity estimate calculation enabling parameter is defined in {{bibref|G.996.2|Clause B.2.1.1}}. + + + + + + + + The capacity estimate signal Power Spectral Density (PSD): + {{list|with each list item consisting of:}} + {{datatype|expand}} + This capacity estimate signal PSD parameter is defined in ITU-T Recommendation {{bibref|G.996.2|Clause B.2.1.2}}. + + + + + + + + + The capacity estimate noise Power Spectral Density (PSD): + {{list|with each list item consisting of:}} + {{datatype|expand}} + This capacity estimate noise PSD parameter is defined in ITU-T Recommendation {{bibref|G.996.2|Clause B.2.1.3}}. + + + + + + + + + The capacity estimate target noise margin. The range of valid values is 0 to 31 dB, in steps of {{units}}. + This capacity estimate target noise margin parameter is defined in ITU-T Recommendation {{bibref|G.996.2|Clause B.2.1.4}}. + + + + + + + + + + + Loop termination indicator, one of the following state indications: + 'Open' + 'Short' + 'Powered on DSLAM/DPU' + 'Unknown' + This parameter is defined as LOOP-TERM in ITU-T Recommendation {{bibref|G.996.2|Clause B.1.1.1}}. + + + + + + + + + + This parameter is the loop length with units of {{units}}. + This parameter is defined as the loop length parameter LOOP_LEN in ITU-T Recommendation {{bibref|G.996.2|Clause B.1.1.2}}. + + + + + + + + + + + {{list}} List items represent paired parameters [LOOP_SEG_LEN, LOOP_SEG_BTAP] representing a concatenation of loop segment types, where LOOP_SEG_LEN represents the length of the segment in meters; and LOOP_SEG_BTAP is a string that identifies the segment type as either "in series" or "bridged tap". + The first loop segment in the list shall be the segment connected to the SELT-PMD block, subsequent loop segments in the list shall describe the loop in the direction toward the far-end loop termination. + This Loop Topology parameter is defined in ITU-T Recommendation {{bibref|G.996.2|Clause B.1.1.3}}. + + + + + + + + + + + {{list}} List items represent paired frequency spacing index i and transfer function log value, i.e. [i,TFlog(i * Df)], where the reference frequency spacing Df = 4.3125 kHz, the index i valid range is 0 to 8191, and TFlog(i * Df) spans a range from +6.0 dB down to -96.2 dB with units of 0.1 dB. + The Attenuation characteristics TFlog(f) parameter is defined in ITU-T Recommendation {{bibref|G.996.2|Clause B.1.1.6}}. + + + + + + + + + + + Missing micro-filter or splitter: This parameter is a binary indication of a missing or incorrectly installed splitter or micro-filter at the U-R reference point. A value of true represents a missing splitter. + The missing micro-filter or splitter parameter is defined in {{bibref|G.996.2|Clause B.1.1.4}}. + + + + + + + + Capacity Estimate: This parameter is an unsigned integer representing the capacity estimate in kbit/s, with units of {{units}}. + The capacity estimate parameter is defined in {{bibref|G.996.2|Clause B.1.1.7}}. + + + + + + + + + + + The PacketCaptureDiagnostics object. This diagnostic is used to record packet capture data on a valid (layer 2 or above) interface in libpcap or pcapng format. + + + + {{datatype|expand}} + + + + + + + + + + + + + + + + + {{numentries}} + + + + + + + + A reference to a (layer 2 or above) interface object that will be the target of this packet capture diagnostic. + + + + + + + + + + + This indicates whether the network trace will be recorded in libpcap {{bibref|LIBPCAP}} or pcapng format, and is dependent on the underlying method of performing a network trace. + + + + + + The packet data is recorded in libpcap {{bibref|LIBPCAP}} format. + + + + + The packet data is recorded in pcapng format. + + + + + + + + The duration in {{units}} to copy packets to the file target. The diagnostic completes when either the {{param}}, {{param|PacketCount}}, or {{param|ByteCount}} conditions are met. + + + + + + + + + + + The maximum number of packets to record to the file target. A value of zero (0) indicates no limit. The diagnostic completes when the {{param|Duration}}, {{param|ByteCount}}, or {{param}} conditions are met. + + + + + + + + The maximum number of bytes to record to the file target. A value of zero (0) indicates no limit. The diagnostic completes when {{param|Duration}}, {{param|PacketCount}} or {{param}} conditions are met. + + + + + + + + URL, as defined in {{bibref|RFC3986}}, specifying the destination file location. HTTP and HTTPS transports MUST be supported. Other transports MAY be supported. + + + + + + + + + + A ({{bibref|BPF}}) formatted expression used to restrict the types of network packets that are recorded to {{param|FileTarget}}. + + + + + + + + + + Username to be used by the Agent to authenticate with the file location. This string is set to {{empty}} if no authentication is required. + + + + + + + + + + Password to be used by the Agent to authenticate with the file location. This string is set to {{empty}} if no authentication is required. When read, this parameter returns an empty string, regardless of the actual value. + + + + + + + Results for individual packet capture diagnostics. Packet capture files whose FileLocation is local to the system SHOULD be deleted when the next diagnostic is run, or upon a system reboot. + + + + URL, as defined in {{bibref|RFC3986}}, specifying the resulting file location of the packet capture record that triggered this result. This MAY be different than the location specified in FileTarget. + + + + + + + + + + The local system time at which the capture was started. + + + + + + + + The local system time at which the capture was completed. + + + + + + + + The number of packets recorded to the file target. + + + + + + This object models FAST (defined in ITU Recommendation {{bibref|G.9701}}) lines. Each {{object|Line}} models a layer 1 FAST Line interface. @@ -12028,7 +12550,7 @@ - Allows the ACS to change the USIM PIN used for SIM card activation. + Allows the Controller to change the USIM PIN used for SIM card activation. + + + This object provides access to the WoL (Wake on LAN) funtionality. + + + + When set to {{true}}, the CPE must send a magic packet over its active Ethernet interfaces. + + + + + + + + MAC address target of the magic packet. + + + + + + + + The SecureOn password. The parameter value can be empty or, if present, can contain either 4 bytes or 6 bytes. + + + + + + Ethernet Link Aggregation Group (LAG) table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). Table entries model the Link Aggregation Sub-Layer as defined in {{bibref|802.3-2015}} and {{bibref|802.1AX-2014}}. It is expected that a {{object}} interface can only be stacked above {{object|.Ethernet.Interface}} interfaces. The CPE can reject creation of additional LAG instances if this would exceed its capabilities. @@ -14084,7 +14643,7 @@ 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 {{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}}. @@ -14658,7 +15217,7 @@ This object models the CPE's USB Host controllers. - See {{bibref|TR-157|Appendix I}} for Theory of Operation. + See {{bibref|TR-181i2|Appendix XVII}} for Theory of Operation. @@ -18120,88 +18679,6 @@ - - - The interface over which the test is to be performed. - - - - - - - - - - The MAC address of the originating G.hn interface of the link that is being diagnosed. - Note: This MAC address might belong to another node of the domain. - - - - - - - - {{numentries}} - - - - - - - - - PHY throughput diagnostics results. - - - - - - - MAC address of the destination node of the link being measured. - - - - - - - - Indicates the state of the link between the G.hn Interface with MAC address {{param|#.DiagnoseMACAddress}} and the G.hn Interface with MAC address {{param|DestinationMACAddress}}. - - - - - - There is a direct link between G.hn Interface with MAC address {{param|#.DiagnoseMACAddress}} and G.hn Interface with MAC address {{param|DestinationMACAddress}} - - - - - There is no direct link between G.hn Interface with MAC address {{param|#.DiagnoseMACAddress}} and G.hn Interface with MAC address {{param|DestinationMACAddress}} - - - - - - - - PHY data rate in transmit direction in the link between the G.hn Interface with MAC address {{param|#.DiagnoseMACAddress}} and the G.hn Interface with MAC address {{param|DestinationMACAddress}}. It is represented in {{units}} as defined in Note 1 to {{bibref|G.9961|Table 8-48}}. To convert from the value in the table, divide by 32K (32768) and round down. - - - - - - - - - - PHY data rate in receive direction in the link between the G.hn Interface with MAC address {{param|#.DiagnoseMACAddress}} and the G.hn Interface with MAC address {{param|DestinationMACAddress}}. It is represented in {{units}} as defined in Note 1 to {{bibref|G.9961|Table 8-48}}. To convert from the value in the table, divide by 32K (32768) and round down. - - - - - - - @@ -19722,6 +20199,1892 @@ + + + This object describes a Wi-Fi network containing 1 or more Access Point devices. + This object is related to a Wi-Fi network that contains multiple Access Points (Multi-AP) and utilizes software logic to optimize that Wi-Fi network (typically via steering STAs, also known as Associated Devices, to the best Access Point). This object exposes the view of the Wi-Fi netwtork from the perspective of the Multi-AP Controller. The Wi-Fi Alliance EasyMesh solution is one example of managing a Multi-AP network. + + + + {{numentries}} + + + + + + + + + The summary of statistics related to Multi-AP Steering for the Wi-Fi network. + The counters contained in {{object}} are all reset on reboot. + + + + Number of times Associated Devices should have been steered but weren't because a better candidate AP couldn't be found. + + + + + + + + Number of times a Blacklist steer was attempted. + + + + + + + + Number of times an attempted Blacklist steer succeeded. + + + + + + + + Number of times an attempted Blacklist steer failed. + + + + + + + + Number of times a BTM (BSS Transition Management; 802.11k) steer was attempted. + + + + + + + + Number of times an attempted BTM (BSS Transition Management; 802.11k) steer succeeded. + + + + + + + + Number of times an attempted BTM (BSS Transition Management; 802.11k) steer failed. + + + + + + + + Number of asynchronous BTM (BSS Transition Management; 802.11k) Queries for which a BTM Request was issued. + + + + + + + + + Each instance of this object represents an individual Access Point device in the Wi-Fi network. + + + + + + + A unique identifier for this particular device within the Wi-Fi network. + + + + + + + + The manufacturer of the Access Point device (human readable string). + + + + + + + + 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. {{pattern}} + The value MUST be a valid OUI as defined in {{bibref|OUI}}. + This value MUST remain fixed over the lifetime of the device, including across firmware updates. + + + + + + + + + + + Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the {{param|SerialNumber}} parameter is unique. + This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform. + + + + + + + + + + Identifier of the particular Access Point device that is unique for the indicated class of product and manufacturer. + This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform. + + + + + + + + + + A string identifying the software version currently installed in the Access Point device (i.e. version of the overall firmware). + To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, ''3.0.21'' where the components mean: ''Major.Minor.Build''. + + + + + + + + + + The last time that the Access Point device was contacted via the Multi-AP control protocol. + + + + + + + + {{param}} is a reference to the IEEE 1905.1 Network Topology Device. Since IEEE 1905.1 is a common protocol used by Multi-AP Controllers for communications, this parameter allows the MultiAP portion of the data model to reference the associated IEEE 1905.1 portion of the data model. + + + + + + + + + + The medium being used to backhaul this Access Point Device to the Multi-AP Controller. The {{enum|None}} value is reserved for the {{object}} instance that represents the Multi-AP Controller. {{enum}} + + + + + + + + + + + + + + + + + The MAC Address of the Device on the network that is providing a Backhaul Link for this Access Point Device. + The {{empty}} value is reserved for the {{object}} instance that represents the Multi-AP Controller. + + + + + + + + The total number of bytes transmitted across the backhaul medium (as identified by the value of the {{param|BackhaulLinkType}} parameter), including framing characters. + + + + + + + + The total number of bytes received across the backhaul medium (as identified by the value of the {{param|BackhaulLinkType}} parameter), including framing characters. + + + + + + + + Current utilization (expressed in {{units}}) of the medium (as identified by the value of the {{param|BackhaulLinkType}} parameter) being used to backhaul this Access Point device to the Multi-AP Controller. A value of 0 is used for the {{object}} instance that represents the Access Point on the Multi-AP Controller. + + + + + + + + + + + An indicator of radio signal strength of the backhaul link of the Access Point (AP) to the Multi-AP Controller, measured in {{units}}. RCPI threshold is encoded per Table 9-154 of {{bibref|802.11-2016}}. The value of this parameter is indeterminate if the value of the {{param|BackhaulLinkType}} parameter is anything other than {{enum|Wi-Fi|BackhaulLinkType}}. + + + + + + + + + + + {{numentries}} + + + + + + + + + This object represents all of the individual Radios contained within the identified Access Point device known to the controller. + + + + + + + A unique identifier for this particular Radio within the identified Access Point. + + + + + + + + Indicates the frequency band at which the radio is operating. {{enum}} + + + + + + + + + + + {{list}} List items indicate which IEEE 802.11 standard this {{object}} instance is configured for. {{enum}} + Each value indicates support for the indicated standard. + If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}} are applicable. + If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}}, {{enum|ax}} are applicable. + For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard {{bibref|802.11g-2003}} is used with a backwards-compatible mode for 802.11b {{bibref|802.11b-1999}}. A value of "g" means that only the 802.11g standard is in use. + + + + + + + {{bibref|802.11a-1999}} + + + + + {{bibref|802.11b-1999}} + + + + + {{bibref|802.11g-2003}} + + + + + {{bibref|802.11n-2009}} + + + + + {{bibref|802.11ac-2013}} + + + + + {{bibref|802.11ax}} + + + + + + + + The current radio channel used by the connection. + + + + + + + + + + The secondary extension channel position, applicable when operating in wide channel mode (i.e. when {{param|CurrentOperatingChannelBandwidth}} is {{enum|40MHz|CurrentOperatingChannelBandwidth}} + If not operating in wide channel mode (i.e. when {{param|CurrentOperatingChannelBandwidth}} is something other than {{enum|40MHz|CurrentOperatingChannelBandwidth}}, then the value of {{param}} is {{enum|None}}. {{enum}} + + + + + + + + + + + + The channel bandwidth currently in use. {{enum}} + + + + + + + + + + + + + The Modulation Coding Scheme index (applicable to 802.11n and 802.11ac specifications only). Values from 0 to 15 MUST be supported ({{bibref|802.11n-2009}}). Values from 0 to 9 MUST be supported for {{bibref|802.11ac-2013}}. + + + + + + + + + + + Indicates the current transmit power level as a {{units}} of full power. + + + + + + + + + + + {{numentries}} + + + + + + + + + A single logical Access Point operating on this radio. + + + + + + + The MAC Address of the logical BSS (BSSID). + + + + + + + + The SSID in use for this BSS. + + + + + + + + Number of times a Blacklist steer was attempted for this Access Point. + + + + + + + + Number of times a BTM (BSS Transition Management; 802.11k) steer was attempted for this Access Point. + + + + + + + + Number of asynchronous BTM (BSS Transition Management; 802.11k) Queries for which a BTM Request was issued by this Access Point. + + + + + + + + {{numentries}} + + + + + + + + + Object describing a single Associated Device (STA). + + + + + + + The MAC address of an associated device. + + + + + + + + The operating standard that this associated device is connected with. {{enum}} + + + + + + {{bibref|802.11a-1999}} + + + + + {{bibref|802.11b-1999}} + + + + + {{bibref|802.11g-2003}} + + + + + {{bibref|802.11n-2009}} + + + + + {{bibref|802.11ac-2013}} + + + + + {{bibref|802.11ax}} + + + + + + + + Whether or not this associated device is currently present on the Wi-Fi Access Point device. + The ability to list inactive nodes is OPTIONAL. If the Access Point devices includes inactive nodes in this table, {{param}} MUST be set to {{false}} for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. + + + + + + + + Date and time in UTC when the device was associated. + + + + + + + + The data transmit rate in {{units}} that was most recently used for transmission of data from the access point to the associated device. + + + + + + + + + + The data transmit rate in {{units}} that was most recently used for transmission of data from the associated device to the access point. + + + + + + + + + + An indicator of radio signal strength of the uplink from the Associated Device (STA) to the Access Point (AP) measured in {{units}}. RCPI threshold is encoded per Table 9-154 of {{bibref|802.11-2016}}. + + + + + + + + + + + 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 {{bibref|802.11-2016|Section 10.11.9.4}}. + + + + + + + + + + {{numentries}} + + + + + + + + + Object describing the Statistics for a single Associated Device (STA). + + + + The total number of bytes transmitted to the Associated Device. + + + + + + + + The total number of bytes received from the Associated Device. + + + + + + + + The total number of packets transmitted to the Associated Device. + + + + + + + + The total number of packets received from the Associated Device. + + + + + + + + The total number of outbound packets that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes. + + + + + + + + The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. + + + + + + + + The total number of transmitted packets which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. + + + + + + + + + The summary of statistics related to Multi-AP Steering for an individual STA on the Wi-Fi network. + The counters contained in {{object}} are all reset on reboot. + + + + Number of times this Associated Device should have been steered but wasn't because a better candidate AP couldn't be found. + + + + + + + + Number of times a Blacklist steer was attempted on this Associated Device. + + + + + + + + Number of times an attempted Blacklist steer succeeded for this Associated Device. + + + + + + + + Number of times an attempted Blacklist steer failed for this Associated Device. + + + + + + + + Number of times a BTM (BSS Transition Management; 802.11k) steer was attempted on this Associated Device. + + + + + + + + Number of times an attempted BTM (BSS Transition Management; 802.11k) steer succeeded for this Associated Device. + + + + + + + + Number of times an attempted BTM (BSS Transition Management; 802.11k) steer failed for this Associated Device. + + + + + + + + Number of asynchronous BTM (BSS Transition Management; 802.11k) Queries for which a BTM Request was issued to this Associated Device. + + + + + + + + The number of {{units}} since this Associated Device was last attempted to be steered. + + + + + + + + + + + The history of Multi-AP Steering for an individual STA on the Wi-Fi network. + The contents of this multi-instance object are reset on reboot. + + + + + + + + + The date/time when steering was initiated for the Associated Device. + + + + + + + + The BSSID of the Access Point that initiated the steering. + + + + + + + + The type of event that caused the steering to be initiaited. {{enum}} + NOTE: This might be Unknown for BTM Query Response steers. + + + + + + + + + + + + + The type of steering that was attempted. {{enum}} + + + + + + + + + + + + The BSSID of the destination Access Point of a successful steer. + A failed steering attempt will leave this parameter {{empty}}. + + + + + + + + The amount of time in {{units}} required for the steer to complete successfully. + A failed steering attempt will leave this parameter 0. + + + + + + + + + + + This object represents the Wi-Fi Alliance Data Elements as defined in {{bibref|DataElements-v1.0}}. + + + + + This object describes a Wi-Fi network containing 1 or more Access Point devices. + + + + A unique identifier for this particular Wi-Fi network. + + + + + + + + The time this group was collected. + + + + + + + + A unique identifier for a Multi-AP controller. + + + + + + + + {{numentries}} + + + + + + + + + Each instance of this object represents an individual Access Point device in the Wi-Fi network. + + + + + + + A unique identifier for this particular device within the Wi-Fi network as defined in {{bibref|DataElements-v1.0|Section 3.1}}. + + + + + + + + The Multi-AP capabilities supported by this device as defined by the APCapability TLV in {{bibref|MAPv1.0|Section 17.2.6}}. + + + + + + + + + + The interval between the collection of consecutive measurements of the most frequently updated Data Element from this device in {{units}}. + + + + + + + + + + {{numentries}} + + + + + + + + + This object represents all of the individual Radios contained within the identified Access Point device known to the controller. + + + + + + + A unique identifier for this particular Radio within the identified Access Point as defined in {{bibref|DataElements-v1.0|Section 3.1}}. + + + + + + + + + + Indicates whether this radio is enabled or disabled. + + + + + + + + An indicator of the average radio noise plus interference power measured for the primary operating channel. + Encoded as defined for ANPI in {{bibref|802.11-2016|Section 11.11.9.4}}. + + + + + + + + + + (Total Channel Utililzation) The percentage of time (linearly scaled with 255 representing 100%) that the Access Point device sensed the medium was busy, as indicated by either the physical or virtual carier sense (CS) mechanism. This is essentially the amount of time spent transmiting (both successful and failed transmissions), receiving (both local and non-local transmissions), and processing noise. + When more than one channel is in use for the BSS operating on the radio, the {{param}} value is calculated only for the primary channel. + + + + + + + + + + (Transmit Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on sending individually or group addressed transmissions (successful and failed). + When more than one channel is in use for the BSS operating on the radio, the {{param}} value is calculated only for the primary channel. + + + + + + + + + + (Receive Local Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on receiving individually or group addressed local transmissions (i.e. transmissions from any STA associated with any BSS operating on this radio). + When more than one channel is in use for the BSS operating on the radio, the {{param}} value is calculated only for the primary channel. + + + + + + + + + + (Receive Non-Local Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on receiving individually or group addressed non-local transmissions (i.e. valid IEEE 802.11 PPDUs that are not associated with any BSS operatin gon this radio). + When more than one channel is in use for the BSS operating on the radio, the {{param}} value is calculated only for the primary channel. + + + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + + Contains the MACAddress of the STA on this radio providing Wi-Fi backhaul to this device. + + + + The MAC address of the logical STA sharing the radio for Wi-Fi backhaul. + + + + + + + + + This object represents the capabilities of the radio which may be different from the current operational configuration. + + + + Describes the HT capabilities of the radio as defined by the HTCapabilities TLV {{bibref|MAPv1.0|Section 17.2.8}}. + + + + + + + + + + Describes the VHT capabilities of the radio as defined by the VHTCapabilities TLV {{bibref|MAPv1.0|Section 17.2.9}}. + + + + + + + + + + Describes the HE capabilities of the radio as defined by the HECapabilities TLV {{bibref|MAPv1.0|Section 17.2.10}}. + + + + + + + + + + {{numentries}} + + + + + + + + + Describes one of the possible Operating Classes supported by this Radio. + + + + + + + The Operating Class per Table E-4 in {{bibref|802.11-2016}} that this radio is capable of operating on. + + + + + + + + + + Maximum Transmit Power EIRP that this radio is capable of transmitting in the current regulatory domain for the Operating Class. + Represented as 2's complement signed integer in units of decibels relative to 1 mW ({{units}}). + + + + + + + + + + + {{list}} The channel numbers which are statically non-operable in the Operating Class (i.e. the Radio is never able to operate on these channels). + Other channels from this Operating Class which are not listed here are supported for the Radio. + + + + + + + + + + + The number of non-operable channels contained in {{param|NonOperable}}. + + + + + + + + + Describes one of the current Operating Classes in use by this Radio. One Opeating Class is indicated for each current Operating Channel Bandwidth. + The Channel indicated for the 20 MHz Operating Class is equal to the current primary channel. + + + + + + + The Operating Class per Table E-4 in {{bibref|802.11-2016}} that this radio is currently operating on. + + + + + + + + + + This Channel number in the Operating Class that this Radio is currently operating on. + + + + + + + + + + Nominal Transmit Power EIRP that this radio is currently using for the current Channel in the Opeating Class. + Represented as 2's complement signed integer in units of decibels relative to 1 mW ({{units}}). + + + + + + + + + + + The time this group was collected. + + + + + + + + + A single logical BSS operating on this radio. + + + + + + + The MAC Address of the logical BSS (BSSID). + + + + + + + + The SSID in use for this BSS. + + + + + + + + Whether the BSSID is currently enabled (beaconing frames are being sent) or disabled. + + + + + + + + Time in {{units}} since the last change to the {{param|Enabled}} value. + + + + + + + + + + The time this group was collected. + + + + + + + + Access Point (BSS) wide statistics for total unicast bytes transmitted. + + + + + + + + Access Point (BSS) wide statistics for total unicast bytes received. + + + + + + + + Access Point (BSS) wide statistics for total multicast bytes transmitted. + + + + + + + + Access Point (BSS) wide statistics for total multicast bytes received. + + + + + + + + Access Point (BSS) wide statistics for total broadcast bytes transmitted. + + + + + + + + Access Point (BSS) wide statistics for total broadcast bytes received. + + + + + + + + Estimated Service Parameters information field for AC=BE, defined per Figure 9-588 in {{bibref|802.11-2016}} and referenced in {{bibref|MAPv1.0|Section 17.2.22}}. + + + + + + + + + + Estimated Service Parameters information field for AC=BK, defined per Figure 9-588 in {{bibref|802.11-2016}} and referenced in {{bibref|MAPv1.0|Section 17.2.22}}. + + + + + + + + + + Estimated Service Parameters information field for AC=VI, defined per Figure 9-588 in {{bibref|802.11-2016}} and referenced in {{bibref|MAPv1.0|Section 17.2.22}}. + + + + + + + + + + Estimated Service Parameters information field for AC=VO, defined per Figure 9-588 in {{bibref|802.11-2016}} and referenced in {{bibref|MAPv1.0|Section 17.2.22}}. + + + + + + + + + + {{numentries}} + + + + + + + + + Object describing a single Associated Device (STA). + + + + + + + The MAC address of an associated device. + + + + + + + + The time this group was collected. + + + + + + + + Describes the HT capabilities of the Associated Device (STA). + + + + + + + + + + Describes the VHT capabilities of the Associated Device (STA). + + + + + + + + + + Describes the HE capabilities of the Associated Device (STA). + + + + + + + + + + The data transmit rate in {{units}} that was most recently used for transmission of data from the access point to the associated device. + + + + + + + + + + The data transmit rate in {{units}} that was most recently used for transmission of data from the associated device to the access point. + + + + + + + + + + The amount of time in {{units}} that the Radio has spent on the Channel receiving data from this Associated Device (STA). + + + + + + + + + + The amount of time in {{units}} that the Radio has spent on the Channel transmitting data to this Associated Device (STA). + + + + + + + + + + Estimate of the MAC layer throughput in {{units}} achievable in the downlink direction if 100% of channel airtime and BSS operating bandwidth were available, as defined in {{bibref|MAPv1.0|Section 10.3.1}}. + + + + + + + + + + Estimate of the MAC layer throughput in {{units}} achievable in the uplink direction if 100% of channel airtime and BSS operating bandwidth were available, as defined in {{bibref|MAPv1.0|Section 10.3.1}}. + + + + + + + + + + An indicator of radio signal strength of the uplink from the associated STA to the access point - measured in {{units}}. RCPI threshold (encoded per Table 9-154 of {{bibref|802.11-2016}}, and described in 10.3.1 of {{bibref|MAPv1.0}}). Reserved: 221 - 255. + NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. + + + + + + + + + + + The time in {{units}} since this Assocated Device (STA) was associated. + + + + + + + + + + The total number of bytes transmitted to the Associated Device. + + + + + + + + The total number of bytes received from the Associated Device. + + + + + + + + The total number of packets transmitted to the Associated Device. + + + + + + + + The total number of packets received from the Associated Device. + + + + + + + + The total number of outbound packets that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes. + + + + + + + + The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. + + + + + + + + The total number of transmitted packets which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. + + + + + + + + {{list}} Measurement Report element(s) received from the Associated Device (STA) that constitute the latest Beacon report as defined in Figure 9-199 of {{bibref|802.11-2016}}. + + + + + + + + + The number of measurement report elements contained in {{param|MeasurementReport}}. + + + + + + + + IPV4 Address assigned to the client. + + + + + + + + IPV6Address assigned to the client. + + + + + + + + Hostname assigned to the client. + + + + + + + + + The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple. + + + + The timestamp of the last scan. + + + + + + + + {{numentries}} + + + + + + + + + The Operating Class of neighboring Access Points discovered by a Radio during a channel scan. + + + + + + + The Operating Class per Table E-4 in {{bibref|802.11-2016}} of the OpClass and Channel tuple scanned by the Radio. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. + Note that the Operating Class identifies the band and channel width. + + + + + + + + + + {{numentries}} + + + + + + + + + The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan. + + + + + + + The channel number of the Channel scanned by the Radio given the Operating Class. + + + + + + + + + + The timestamp of the last scan of the channel. + + + + + + + + The current Channel Utilization measured by the Radio on the scanned 20MHz channel, as defined by {{bibref|802.11-2016|Section 9.4.2.28}}. + + + + + + + + + + An indicator of the average radio noise plus interference power measured for the primary operating channel. + Encoded as defined for ANPI in {{bibref|802.11-2016|Section 11.11.9.4}}. + + + + + + + + + + {{numentries}} + + + + + + + + + The neighboring BSS discovered by a Radio during a channel scan. + + + + + + + The BSSID indicated by the neighboring BSS. + + + + + + + + The SSID indicated by the neighboring BSS. + + + + + + + + An indicator of radio signal strength (RSSI) of the Beacon or Probe Response frames of the neighboring BSS as received by the radio measured in {{units}}. (RSSI is encoded per Table 9-154 of {{bibref|802.11-2016}}). Reserved: 221 - 255. + NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. + + + + + + + + + + + Indicates the maximum bandwidth at which the neighboring BSS is operating. e.g. "20" or "40" or "80" or "80+80" or "160" MHz. + + + + + + + + The channel utilization reported by the neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames, as defined by Section 9.4.2.28 in {{bibref|802.11-2016}}. + + + + + + + + + + The number of Associated Devices (STA) reported by this neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames as defined by {{bibref|802.11-2016|Section 9.4.2.28}}. + + + + + + + + + Each instance represents a Non-AP STA that has been discovered by the Radio but is not associated to any of the BSS operating on the Radio. + + + + + + + The MAC address of the Non-AP STA. + + + + + + + + An indicator of radio signal strength (RCPI) of the uplink from the Non-AP STA - measured in {{units}}. (RCPI threshold is encoded per Table 9-154 of {{bibref|802.11-2016}}, and described in 103.2 of {{bibref|MAPv1.0}}). Reserved: 221 - 255. + NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. + + + + + + + + + + + + This object contains the events generated when a STA associates to a BSS. + + + + {{numentries}} + + + + + + + + + The events generated when an Associated Device (STA) associates to a BSS. + + + + The MAC Address of the logical BSS ( BSSID) which is reporting the Association Event. + + + + + + + + The MAC Address of the Associated Device (STA). + + + + + + + + The status code sent to the Associated Device (STA) in the Association Response frame as defined by Table 9-46 in {{bibref|802.11-2016}}. + + + + + + + + Describes the HT capabilities of the Associated Device (STA). + + + + + + + + + + Describes the VHT capabilities of the Associated Device (STA). + + + + + + + + + + Describes the HE capabilities of the Associated Device (STA). + + + + + + + + + + The time this event was collected. + + + + + + + + + This object contains the events generated when an Associated Device (STA) disassociates from a BSS. + + + + {{numentries}} + + + + + + + + + The events generated when an Associated Device (STA) disassociates from a BSS. + + + + The MAC Address of the logical BSS ( BSSID) which is reporting the Disassociation Event. + + + + + + + + The MAC address of the Associated Device (STA). + + + + + + + + The Reason Code received by the AP from the Associated Device (STA) in the most recent Disassociation or Deauthentication frame or sent by the AP to the Associated Device (STA) in the most recent Disassociation or Deauthenticaiton frame as defined in Table 9-45 in {{bibref|802.11-2016}}. + + + + + + + + The total number of bytes transmitted to the Associated Device (STA). + + + + + + + + The total number of bytes received from the Associated Device (STA). + + + + + + + + The total number of packets transmitted to the Associated Device (STA). + + + + + + + + The total number of packets received from the Associated Device (STA). + + + + + + + + The total number of outbound packets that could not be transmitted to the Associated Device (STA) because of errors. These might be due to the number of retransmissions exceeding the retry limit or from other causes. + + + + + + + + The total number of inbound packets from the Associated Device (STA) that contained errors preventing them from being delivered to a higher-layer protocol. + + + + + + + + The total number of transmitted packets to the Associated Device (STA) which were retransmissions. + N retransmissions of the same packet results in this counter incrementing by N. + + + + + + + + The time this event was collected. + + + + + + This object models an 802.11 wireless radio on a device (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). @@ -19854,8 +22217,8 @@ {{list}} List items indicate which IEEE 802.11 standards this {{object}} instance can support simultaneously, in the frequency band specified by {{param|OperatingFrequencyBand}}. {{enum}} Each value indicates support for the indicated standard. - If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}} are allowed. - If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}}, {{enum|ax}} are allowed. @@ -19885,6 +22248,11 @@ {{bibref|802.11ac-2013}} + + + {{bibref|802.11ax}} + + @@ -19892,8 +22260,8 @@ {{list}} List items indicate which IEEE 802.11 standard this {{object}} instance is configured for. Each value indicates support for the indicated standard. - If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}} are allowed. - If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}}, {{enum|ax}} are allowed. For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard {{bibref|802.11g-2003}} is used with a backwards-compatible mode for 802.11b {{bibref|802.11b-1999}}. A value of "g" means that only the 802.11g standard can be used. @@ -19932,6 +22300,7 @@ The current radio channel used by the connection. To request automatic channel selection, set {{param|AutoChannelEnable}} to {{true}}. Whenever {{param|AutoChannelEnable}} is {{true}}, the value of the {{param}} parameter MUST be the channel selected by the automatic channel selection procedure. + For channels in "wide mode" (802.11n where a 40MHz channel bandwidth is used), this parameter is used for Primary Channel only. The secondary or extension channel information is available through {{param|ExtensionChannel}}. Note: Valid {{param}} values depend on the {{param|OperatingFrequencyBand}} and {{param|RegulatoryDomain}} values specified. @@ -20066,12 +22435,17 @@ - 802.11ac only + 802.11ac and 802.11ax only - 802.11ac only + 802.11ac and 802.11ax only + + + + + 802.11ac and 802.11ax only @@ -20080,7 +22454,7 @@ - The preferred channel bandwidth to be used (applicable to 802.11n and 802.11ac specifications only). + The preferred channel bandwidth to be used (applicable to 802.11n, 802.11ac, and 802.11ax specifications only). @@ -20098,12 +22472,13 @@ + - The secondary extension channel position, applicable when operating in wide channel mode (i.e. when {{param|OperatingChannelBandwidth}} is set to {{enum|40MHz|OperatingChannelBandwidth}} or {{enum|Auto|OperatingChannelBandwidth}}). + The secondary extension channel position (applicable to the 802.11n specification only), applicable when operating in wide channel mode (i.e. when {{param|OperatingChannelBandwidth}} is set to {{enum|40MHz|OperatingChannelBandwidth}} or {{enum|Auto|OperatingChannelBandwidth}}). @@ -20115,16 +22490,50 @@ - The guard interval value between OFDM symbols (applicable to 802.11n and 802.11ac specifications only). + The guard interval value between OFDM symbols. - - + + + applicable to 802.11n and 802.11ac specifications only + + + + + applicable to 802.11n, 802.11ac, and 802.11ax specifications only + + + + + applicable to 802.11ax specifications only + + + + + applicable to 802.11ax specifications only + + + + + When operating in {{enum|80+80MHz|CurrentOperatingChannelBandwidth}}, this parameter determines the Center Frequency Segment 0 for the first 80 MHz channel. See {{bibref|802.11-2016|Section 9.4.2.161}} and Table 9-252. + + + + + + + + When operating in {{enum|80+80MHz|CurrentOperatingChannelBandwidth}}, this parameter determines the Center Frequency Segment 1 for the second 80 MHz channel. See {{bibref|802.11-2016|Section 9.4.2.161}} and Table 9-252. + + + + + The Modulation Coding Scheme index (applicable to 802.11n and 802.11ac specifications only). Values from 0 to 15 MUST be supported ({{bibref|802.11n-2009}}). Values from 0 to 9 MUST be supported for {{bibref|802.11ac-2013}}. A value of -1 indicates automatic selection of the MCS index. @@ -20337,7 +22746,7 @@ - Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See {{bibref|TR-181i2a5|Appendix III}} for further details. 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-181i2a5|Section 4.2.2}}. + Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See {{bibref|TR-181i2|Appendix III}} for further details. 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}}. @@ -20611,12 +23020,16 @@ + + + The type of encryption the neighboring WiFi SSID advertises. + When {{param|SecurityModeEnabled}} is one of {{enum|WPA3-SAE|SecurityModeEnabled}}, {{enum|WPA2-PSK-WPA3-SAE|SecurityModeEnabled}}, or {{enum|WPA3-Enterprise|SecurityModeEnabled}}, {{enum|TKIP}} is not valid, and should not be in the list. @@ -20641,8 +23054,8 @@ {{list}} List items indicate which IEEE 802.11 standards this {{object}} instance can support simultaneously, in the frequency band specified by {{param|OperatingFrequencyBand}}. {{enum}} Each value indicates support for the indicated standard. - If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}} are allowed. - If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}}, {{enum|ax}} are allowed. @@ -20672,6 +23085,11 @@ {{bibref|802.11ac-2013}} + + + {{bibref|802.11ax}} + + @@ -20679,8 +23097,8 @@ {{list}} List items indicate which IEEE 802.11 standard that is detected for this {{object}}. Each value indicates support for the indicated standard. - If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|##.Radio.{i}.SupportedFrequencyBands}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}} are allowed. - If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|##.Radio.{i}.SupportedFrequencyBands}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|##.Radio.{i}.SupportedFrequencyBands}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|##.Radio.{i}.SupportedFrequencyBands}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}}, {{enum|ax}} are allowed. For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard {{bibref|802.11g-2003}} is used with a backwards-compatible mode for 802.11b {{bibref|802.11b-1999}}. A value of "g" means that only the 802.11g standard can be used. @@ -20889,7 +23307,7 @@ - Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See {{bibref|TR-181i2a5|Appendix III}} for further details. 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-181i2a5|Section 4.2.2}}. + Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See {{bibref|TR-181i2|Appendix III}} for further details. 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}}. @@ -21178,10 +23596,11 @@ - + The maximum number of devices that can simultaneously be connected to the access point. A value of 0 means that there is no specific limit. + This parameter has been DEPRECATED in favor of {{param|MaxAllowedAssociations}}. @@ -21241,9 +23660,12 @@ + + + @@ -21275,7 +23697,7 @@ A literal PreSharedKey (PSK) expressed as a hexadecimal string. {{param}} is only used if {{param|ModeEnabled}} is set to {{enum|WPA-Personal|ModeEnabled}} or {{enum|WPA2-Personal|ModeEnabled}} or {{enum|WPA-WPA2-Personal|ModeEnabled}}. - If {{param|KeyPassphrase}} is written, then {{param}} is immediately generated. The ACS SHOULD NOT set both the {{param|KeyPassphrase}} and the {{param}} directly (the result of doing this is undefined). + If {{param|KeyPassphrase}} is written, then {{param}} is immediately generated. The Controller SHOULD NOT set both the {{param|KeyPassphrase}} and the {{param}} directly (the result of doing this is undefined). @@ -22226,7 +24665,7 @@ A literal PreSharedKey (PSK) expressed as a hexadecimal string. {{param}} is only used if {{param|ModeEnabled}} is set to {{enum|WPA-Personal|ModeEnabled}} or {{enum|WPA2-Personal|ModeEnabled}} or {{enum|WPA-WPA2-Personal|ModeEnabled}}. - If {{param|KeyPassphrase}} is written, then {{param}} is immediately generated. The ACS SHOULD NOT set both the {{param|KeyPassphrase}} and the {{param}} directly (the result of doing this is undefined). + If {{param|KeyPassphrase}} is written, then {{param}} is immediately generated. The Controller SHOULD NOT set both the {{param|KeyPassphrase}} and the {{param}} directly (the result of doing this is undefined). - IPv4 address table. Entries are auto-created and auto-deleted as IP addresses are added and deleted via DHCP, auto-IP, or IPCP. Static entries are created and configured by the ACS. + IPv4 address table. Entries are auto-created and auto-deleted as IP addresses are added and deleted via DHCP, auto-IP, or IPCP. Static entries are created and configured by the Controller. @@ -26478,7 +28924,7 @@ * Automatically via DHCPv6 {{bibref|RFC3315}}, which covers generation of any type of address (subject to the configured DHCP server policy). * Manually via a GUI or some other local management interface. * Manually via factory default configuration. - * By the ACS. + * By the Controller. This table MUST NOT include entries for the Subnet-Router anycast address {{bibref|RFC4291|Section 2.6.1}}. Such entries would be identical to others but with a zero interface identifier, and would add no value. A loopback interface will always have address ''::1'' {{bibref|RFC4291|Section 2.5.3}} and MAY also have link-local address ''fe80::1''. This object is based on ''ipAddressTable'' from {{bibref|RFC4293}}. @@ -26619,7 +29065,7 @@ - For example, present in the factory default configuration (but not {{enum|WellKnown}}), created by the ACS, or created by some other management entity (e.g. via a GUI). + For example, present in the factory default configuration (but not {{enum|WellKnown}}), created by the Controller, or created by some other management entity (e.g. via a GUI). @@ -26681,7 +29127,7 @@ * Automatically via internal CPE logic, e.g. creation of child prefixes derived from a parent prefix. * Manually via a GUI or some other local management interface. * Manually via factory default configuration. - * By the ACS. + * By the Controller. The CPE MAY choose not to create {{object}} entries for {{enum|WellKnown|Origin}} prefixes or for the ULA /48 prefix {{bibref|RFC4193}}. If an {{object}} entry exists for the ULA /48 prefix, it MUST be on a downstream interface (i.e. an interface for which the physical layer interface object has ''Upstream'' = {{false}}). This object is based on ''ipAddressPrefixTable'' from {{bibref|RFC4293}}. @@ -26804,7 +29250,7 @@ - Created by the ACS, by some other management entity (e.g. via a GUI), or present in the factory default configuration (but not {{enum|WellKnown}}). Unrelated to any shorter length prefix that might exist on the CPE. Also see {{param|StaticType}}. Can be used for RA (Prefix Information), DHCPv6 address assignment (IA_NA) or DHCPv6 prefix delegation (IA_PD). + Created by the Controller, by some other management entity (e.g. via a GUI), or present in the factory default configuration (but not {{enum|WellKnown}}). Unrelated to any shorter length prefix that might exist on the CPE. Also see {{param|StaticType}}. Can be used for RA (Prefix Information), DHCPv6 address assignment (IA_NA) or DHCPv6 prefix delegation (IA_PD). @@ -26818,7 +29264,7 @@ - Static prefix sub-type. For a {{enum|Static|Origin}} prefix, this can be set to {{enum|PrefixDelegation}} or {{enum|Child}}, thereby creating an unconfigured prefix of the specified type that will be populated in preference to creating a new instance. This allows the ACS to pre-create "prefix slots" with known path names that can be referenced from elsewhere in the data model before they have been populated. {{enum}} + Static prefix sub-type. For a {{enum|Static|Origin}} prefix, this can be set to {{enum|PrefixDelegation}} or {{enum|Child}}, thereby creating an unconfigured prefix of the specified type that will be populated in preference to creating a new instance. This allows the Controller to pre-create "prefix slots" with known path names that can be referenced from elsewhere in the data model before they have been populated. {{enum}} This mechanism works as follows: * When this parameter is set to {{enum|PrefixDelegation}} or {{enum|Child}}, the instance becomes a "prefix slot" of the specified type. * Such an instance can be administratively enabled ({{param|Enable}} = {{true}}) but will remain operationally disabled ({{param|Status}} = {{enum|Disabled|Status}}) until it has been populated. @@ -26845,7 +29291,7 @@ - Prefix will be populated when a {{enum|Child|Origin}} prefix needs to be created. In this case, the ACS needs also to set {{param|ParentPrefix}} and might want to set {{param|ChildPrefixBits}} (if parent prefix is not set, or goes away, then the child prefix will become operationally disabled). + Prefix will be populated when a {{enum|Child|Origin}} prefix needs to be created. In this case, the Controller needs also to set {{param|ParentPrefix}} and might want to set {{param|ChildPrefixBits}} (if parent prefix is not set, or goes away, then the child prefix will become operationally disabled). @@ -27113,7 +29559,7 @@ - + @@ -27313,7 +29759,7 @@ - + @@ -27483,22 +29929,14 @@ - Indicate the availability of diagnostic data. {{enum}} - If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the {{param}} to {{enum|Requested}}. - When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. - When the test is completed, the value of this parameter MUST be either {{enum|Completed}} (if the test completed successfully), or one of the ''Error'' values listed above. - If the value of this parameter is anything other than {{enum|Completed}}, the values of the results parameters for this test are indeterminate. - When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the Inform message. - After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}} and remove all object instances from {{object|PerConnectionResult}} and {{object|IncrementalResult}}. - Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}} and remove all object instances from {{object|PerConnectionResult}} and {{object|IncrementalResult}}. - While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}} and remove all object instances from {{object|PerConnectionResult}} and {{object|IncrementalResult}}. - While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. + {{datatype|expand}} - + - + + @@ -27512,7 +29950,7 @@ - + @@ -27533,7 +29971,7 @@ * When using FTP transport, FTP binary transfer MUST be used. * When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used. * When using HTTP transport the HTTP Authentication MUST NOT be used. - Note: For time based tests ({{param|TimeBasedTestDuration}} > 0) the ACS MAY add a hint to duration of the test to the URL. See {{bibref|TR-143a1|Section 4.3}} for more details. + Note: For time based tests ({{param|TimeBasedTestDuration}} > 0) the Controller MAY add a hint to duration of the test to the URL. See {{bibref|TR-143|Section 4.3}} for more details. @@ -27597,7 +30035,7 @@ - Controls time based testing {{bibref|TR-143a1|Section 4.3}}. When {{param}} > 0, {{param}} is the duration in {{units}} of a time based test. If {{param}} is 0, the test is not based on time, but on the size of the file to be downloaded. The default value SHOULD be 0. + Controls time based testing {{bibref|TR-143|Section 4.3}}. When {{param}} > 0, {{param}} is the duration in {{units}} of a time based test. If {{param}} is 0, the test is not based on time, but on the size of the file to be downloaded. The default value SHOULD be 0. @@ -27979,22 +30417,14 @@ - Indicate the availability of diagnostic data. {{enum}} - If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the {{param}} to {{enum|Requested}}. - When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. - When the test is completed, the value of this parameter MUST be either {{enum|Completed}} (if the test completed successfully), or one of the ''Error'' values listed above. - If the value of this parameter is anything other than {{enum|Completed}}, the values of the results parameters for this test are indeterminate. - When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the Inform message. - After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}} and remove all object instances from {{object||PerConnectionResult}} and {{object|IncrementalResult}}. - Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}} and remove all object instances from {{object|PerConnectionResult}} and {{object|IncrementalResult}}. - While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}} and remove all object instances from {{object|PerConnectionResult}} and {{object|IncrementalResult}}. - While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. + {{datatype|expand}} - + - + + @@ -28009,7 +30439,7 @@ - + @@ -28102,7 +30532,7 @@ - Controls time based testing {{bibref|TR-143a1|Section 4.3}}. When {{param}} > 0, {{param}} is the duration in {{units}} of a time based test. If {{param}} is 0, the test is not based on time, but on the size of the file to be uploaded. The default value SHOULD be 0. + Controls time based testing {{bibref|TR-143|Section 4.3}}. When {{param}} > 0, {{param}} is the duration in {{units}} of a time based test. If {{param}} is 0, the test is not based on time, but on the size of the file to be uploaded. The default value SHOULD be 0. @@ -28590,29 +31020,22 @@ - This object defines the diagnostics configuration for a UDP Echo test {{bibref|TR-143a1|Appendix A.1}} defined in {{bibref|RFC862}} or a UDP Echo Plus test defined in {{bibref|TR-143a1|Appendix A.1}}. + This object defines the diagnostics configuration for a UDP Echo test {{bibref|TR-143|Appendix A.1}} defined in {{bibref|RFC862}} or a UDP Echo Plus test defined in {{bibref|TR-143|Appendix A.1}}. - Indicate the availability of diagnostic data. {{enum}} - If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the {{param}} to {{enum|Requested}}. - When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. When the test is completed, the value of this parameter MUST be either {{enum|Completed}} (if the test completed successfully), or one of the ''Error'' values listed above. - If the value of this parameter is anything other than {{enum|Completed}}, the values of the results parameters for this test are indeterminate. - When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the Inform message. - After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}} and remove all object instances from {{object|IndividualPacketResult}}. - Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}} and remove all object instances from {{object|IndividualPacketResult}}. - While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}} and remove all object instances from {{object|IndividualPacketResult}}. - While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. + {{datatype|expand}} - + - + + - + @@ -28830,7 +31253,7 @@ Time the client receives the response packet in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z - If this response is never received, {{param}} SHOULD be set to the Unknown Time value as specified in {{bibref|TR-106a7|Section 3.2.2}}. + If this response is never received, {{param}} SHOULD be set to the Unknown Time value as specified in {{bibref|TR-106|Section 3.2.2}}. @@ -28838,7 +31261,7 @@ - The TestGenSN field in the UDPEcho Plus packet {{bibref|TR-143a1|Section A.1.4}} sent by the CPE client. + The TestGenSN field in the UDPEcho Plus packet {{bibref|TR-143|Section A.1.4}} sent by the CPE client. @@ -28846,7 +31269,7 @@ - The TestRespSN field in the response packet {{bibref|TR-143a1|Section A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) for this Echo Plus packet sent by the CPE client. If {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. + The TestRespSN field in the response packet {{bibref|TR-143|Section A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) for this Echo Plus packet sent by the CPE client. If {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. @@ -28854,7 +31277,7 @@ - The TestRespRcvTimeStamp field in the response packet {{bibref|TR-143a1|Section A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) to record the reception time of this UDP Echo Plus packet sent from the CPE client. If {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. + The TestRespRcvTimeStamp field in the response packet {{bibref|TR-143|Section A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) to record the reception time of this UDP Echo Plus packet sent from the CPE client. If {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. @@ -28864,7 +31287,7 @@ - The TestRespReplyTimeStamp field in the response packet {{bibref|TR-143a1|Section A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) to record the server reply time of this UDP Echo Plus packet sent from the CPE client. + The TestRespReplyTimeStamp field in the response packet {{bibref|TR-143|Section A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) to record the server reply time of this UDP Echo Plus packet sent from the CPE client. That is, the time that the server returned the UDP Echo Plus packet. If {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. @@ -28888,26 +31311,18 @@ - Indicates availability of diagnostic data. {{enum}} - If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the {{param}} to {{enum|Requested}}. - When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. - When the test is completed, the value of this parameter MUST be either {{enum|Completed}} (if the test completed successfully), or one of the ''Error'' values listed above. - If the value of this parameter is anything other than {{enum|Completed}}, the values of the results parameters for this test are indeterminate. - When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the Inform message. - After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}. - Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}. - While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}. - While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. + {{datatype|expand}} - + - + + - + @@ -29347,7 +31762,7 @@ IPsec {{bibref|RFC4301}} object that supports the configuration of Encapsulating Security Payload (ESP) {{bibref|RFC4303}} and Authentication Header (AH) {{bibref|RFC4302}} in tunnel mode {{bibref|RFC4301|Section 3.2}}. Use of IKEv2 {{bibref|RFC5996}} is assumed. The IPsec object does not currently support static configuration of tunnels and child Security Associations (SAs). - See the IPsec Theory of Operation {{bibref|TR-181i2a5|Appendix IX}} for a description of the working of this IPsec data model. + See the IPsec Theory of Operation {{bibref|TR-181i2|Appendix IX}} for a description of the working of this IPsec data model. @@ -32575,7 +34990,7 @@ The Mapping of Address and Port (MAP) object {{bibref|RFC7597}} {{bibref|RFC7599}} {{bibref|RFC7598}}. This object applies only to gateway devices that support IPv4 on the LAN side, include a {{object|#.NAT}}, and typically have only IPv6 connectivity on the WAN side. - See the MAP Theory of Operation {{bibref|TR-181i2a8|Appendix XV}} for a description of the working of this MAP data model. + See the MAP Theory of Operation {{bibref|TR-181i2|Appendix XV}} for a description of the working of this MAP data model. @@ -32677,7 +35092,7 @@ The MAP domain's ''End-user IPv6 prefix''. This MUST reference one of {{param|WANInterface}}'s prefixes. - If the ACS configures this prefix directly, the CPE MUST use the ACS-configured prefix. Otherwise, the CPE MUST select one of {{param|WANInterface}}'s prefixes; the selected prefix will typically have {{param|##.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} = {{enum|PrefixDelegation|##.IP.Interface.{i}.IPv6Prefix.{i}.Origin}}. + If the Controller configures this prefix directly, the CPE MUST use the Controller-configured prefix. Otherwise, the CPE MUST select one of {{param|WANInterface}}'s prefixes; the selected prefix will typically have {{param|##.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} = {{enum|PrefixDelegation|##.IP.Interface.{i}.IPv6Prefix.{i}.Origin}}. @@ -32829,7 +35244,7 @@ - Present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI) + Present in the factory default configuration, created by the Controller, or created by some other management entity (e.g. via a GUI) @@ -33392,7 +35807,7 @@ - For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI). + For example, present in the factory default configuration, created by the Controller, or created by some other management entity (e.g. via a GUI). @@ -33533,7 +35948,7 @@ - For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI). + For example, present in the factory default configuration, created by the Controller, or created by some other management entity (e.g. via a GUI). @@ -33840,12 +36255,25 @@ + + + The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address (see{{bibref|RFC4862|5.1}}). + A value of zero indicates that Duplicate Address Detection is not performed on tentative addresses. + A value of one indicates a single transmission with no follow-up retransmissions. + If the value is greater than 1, {{param|RetransTimer}} defines the delay between consecutive messages. + + + + + + Retransmission interval in {{units}}, as defined in {{bibref|RFC4861}}. For auto-configuration purposes, {{param}} specifies the delay between consecutive Neighbor Solicitation transmissions performed during Duplicate Address Detection (DAD) {{bibref|RFC4862|Section 5.4}}, as well as the time a node waits after sending the last Neighbor Solicitation before ending the DAD process. + @@ -33853,13 +36281,14 @@ - Retransmission interval in {{units}}, as defined in {{bibref|RFC4861}}. For auto-configuration purposes, {{param}} specifies the delay between consecutive Router Solicitation transmissions. + Retransmission interval in {{units}}, as defined in {{bibref|RFC4861|6.3.7}}. For auto-configuration purposes, {{param}} specifies the delay between consecutive Router Solicitation transmissions. + - + @@ -34194,7 +36623,7 @@ Settings allowing a CPE to derive and route IPv6 Rapid Deployment (6rd) delegated prefixes as specified in {{bibref|RFC5969}}. The 6rd mechanism is intended to be implemented only on what {{bibref|RFC5969}} refers to as ''Customer Edge Routers'', i.e. on gateway devices, that support IPv6 on the LAN side and only have IPv4 connectivity on the WAN side. - See the 6rd Theory of Operation {{bibref|TR-181i2a2|Appendix VI}} for a description of the working of this 6rd data model. + See the 6rd Theory of Operation {{bibref|TR-181i2|Appendix VI}} for a description of the working of this 6rd data model. @@ -34264,7 +36693,7 @@ - If {{true}}, the destination address for all 6rd traffic will be set (IPv4 destination address) to one of the {{param|BorderRelayIPv4Addresses}}. If {{false}}, traffic whose destination address begins with the same prefix as {{param|SPIPv6Prefix}} will be sent directly to the destination IPv4 address of the endpoint, which is in the same 6rd domain. See 6rd Theory of Operation for further explanation {{bibref|TR-181i2a2|Appendix VI}}. + If {{true}}, the destination address for all 6rd traffic will be set (IPv4 destination address) to one of the {{param|BorderRelayIPv4Addresses}}. If {{false}}, traffic whose destination address begins with the same prefix as {{param|SPIPv6Prefix}} will be sent directly to the destination IPv4 address of the endpoint, which is in the same 6rd domain. See 6rd Theory of Operation for further explanation {{bibref|TR-181i2|Appendix VI}}. @@ -34333,7 +36762,7 @@ Settings allowing a CPE to configure and route IPv6 Dual-Stack Lite (DSLite) as specified in {{bibref|DSLite}}. The DS-Lite mechanism is intended to be implemented only on gateway devices that support IPv4 on the LAN side and only have IPv6 connectivity on the WAN side. - See the Dual-Stack Lite Theory of Operation {{bibref|TR-181i2a2|Appendix VII}} for a description of the working of this DS-Lite data model. + See the Dual-Stack Lite Theory of Operation {{bibref|TR-181i2|Appendix VII}} for a description of the working of this DS-Lite data model. @@ -34431,7 +36860,7 @@ The Fully Qualified Domain Name (FQDN) of the tunnel concentrator (remote endpoint). - This parameter is based on ''OPTION_DS_LITE_NAME'' from {{bibref|DSLite-options|Section 4}} and can be assigned statically (e.g. present in the factory default configuration or set by the ACS) or can be updated dynamically (via DHCPv6). If both statically and dynamically assigned, then {{param|EndpointAssignmentPrecedence}} indicates whether it is the static configuration or the DHCPv6 configuration that is actually applied to {{param}}. + This parameter is based on ''OPTION_DS_LITE_NAME'' from {{bibref|DSLite-options|Section 4}} and can be assigned statically (e.g. present in the factory default configuration or set by the Controller) or can be updated dynamically (via DHCPv6). If both statically and dynamically assigned, then {{param|EndpointAssignmentPrecedence}} indicates whether it is the static configuration or the DHCPv6 configuration that is actually applied to {{param}}. Note: {{param}} is only writable when {{param|EndpointAssignmentPrecedence}} is {{enum|Static|EndpointAssignmentPrecedence}}; otherwise, {{param}} is automatically configured via the DHCPv6 received option. @@ -34443,7 +36872,7 @@ The address of the tunnel concentrator (remote endpoint). - This parameter can only be assigned statically (e.g. present in the factory default configuration or set by the ACS). + This parameter can only be assigned statically (e.g. present in the factory default configuration or set by the Controller). @@ -34462,7 +36891,7 @@ - For example, present in the factory default configuration, set by the ACS, or set by some other management entity (e.g. via a GUI). + For example, present in the factory default configuration, set by the Controller, or set by some other management entity (e.g. via a GUI). @@ -34658,7 +37087,7 @@ Ethernet priority code (as defined in {{bibref|802.1Q-2011}}) to mark traffic not associated with any specified classifier. A value of -1 indicates no change from the incoming packet. - A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref|TR-181i2a5|Annex A}}. + A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref|TR-181i2|Annex A}}. @@ -35783,7 +38212,7 @@ Ethernet priority code (as defined in {{bibref|802.1Q-2011}}) to mark traffic associated with this App table entry, but not associated with any specified flow. A value of -1 indicates no change from the incoming packet. - A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref|TR-181i2a5|Annex A}}. + A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref|TR-181i2|Annex A}}. @@ -35936,7 +38365,7 @@ Ethernet priority code (as defined in {{bibref|802.1Q-2011}}) to mark traffic with that falls into this flow. A value of -1 indicates no change from the incoming packet. - A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref|TR-181i2a5|Annex A}}. + A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref|TR-181i2|Annex A}}. @@ -36051,7 +38480,7 @@ - Identifies the method of traffic measurement to be used for this policer. {{enum}} + Identifies the method of traffic measurement to be used for this policer. {{enum|SimpleTokenBucket}} makes use of {{param|CommittedRate}} and {{param|CommittedBurstSize}}. {{enum|SingleRateThreeColor}} makes use of {{param|CommittedRate}}, {{param|CommittedBurstSize}}, and {{param|ExcessBurstSize}} as defined in {{bibref|RFC2697}}. {{enum|TwoRateThreeColor}} makes use of {{param|CommittedRate}}, {{param|CommittedBurstSize}}, {{param|PeakRate}}, and {{param|PeakBurstSize}} as defined in {{bibref|RFC2698}}. @@ -36468,7 +38897,7 @@ - Queue statistics table. This table is managed by the ACS, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected. + Queue statistics table. This table is managed by the Controller, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected. Note: The {{object}} table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to {{empty}}. However, doing so under these circumstances might cause the updated {{object}} row to then violate the table's unique key constraint; if this occurs, the CPE MUST disable the offending {{object}} row. @@ -36787,7 +39216,7 @@ - {{noreference}}The value MUST the path name of the ''AssociatedDevice'' (or equivalent) table row that models the host, or {{null}} if there is no such table. + {{noreference}}The value MUST the path name of the ''AssociatedDevice'' (or equivalent) table row that models the host, or {{null}} if either there is no such table or the host isn't directly connected to this device (e.g. the host is connected to a Wi-Fi Access Point). For example: ''Device.WiFi.AccessPoint.1.AssociatedDevice.2'' @@ -36799,7 +39228,7 @@ - {{noreference}}The value MUST be the path name of a row in a layer 1 interface table. If the layer 1 device isn’t known, then {{param}} will be {{null}}. + {{noreference}}The value MUST be the path name of a row in a layer 1 interface table. If either the layer 1 interface isn't known or the host isn't directly connected to this device (e.g. the host is connected to a Wi-Fi Access Point), then {{param}} will be {{null}}. For example: ''Device.Ethernet.Interface.2'' @@ -36811,7 +39240,7 @@ - {{reference}} If the entry represents a non-IP device, then {{param}} will be {{empty}}. + {{reference}} If either the layer 3 interface isn't known or the host isn't directly connected to this device (e.g. the host is connected to a Wi-Fi Access Point), then {{param}} will be {{null}}. @@ -36820,6 +39249,23 @@ + + + Type of physical interface through which this host is connected. + + + + + + + + + + + + + + Vendor Class Identifier DHCP option (Option 60) of the host. @@ -37071,7 +39517,7 @@ - This table contains the DNS Server IP address to be used by the DHCP Client (it does ''not'' model a DNS Server). Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the ACS. + This table contains the DNS Server IP address to be used by the DHCP Client (it does ''not'' model a DNS Server). Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the Controller. @@ -37191,7 +39637,7 @@ - DNS Server forwarding policy to be used by the DNS Relay. Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the ACS. + DNS Server forwarding policy to be used by the DNS Relay. Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the Controller. Note: Management of re-directing queries to the device embedded DNS server is not defined in this version of the specification. @@ -37290,19 +39736,10 @@ - Indicates availability of diagnostic data. {{enum}} - If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to {{enum|Requested}}. - When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. - When the test is completed, the value of this parameter MUST be either {{enum|Complete}} (if the test completed successfully), or one of the Error values listed above. - If the value of this parameter is anything other than {{enum|Complete}}, the values of the results parameters for this test are indeterminate. - When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code "8 DIAGNOSTICS COMPLETE" in the Inform message. - After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}. - Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}. - While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}. - While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. + {{datatype|expand}} - + @@ -37313,13 +39750,13 @@ - + - {{reference}} This parameter specifies the IP-layer interface over which the test is to be performed (i.e. the source IP address to use when performing the test). - If {{empty}} is specified, the CPE MUST use its routing policy (Forwarding table entries), if necessary, to determine the appropriate interface. + {{reference}} The layer 2 or layer 3 interface over which the test is to be performed. Example: ''Device.IP.Interface.1'', ''Device.Bridge.1.Port.2'' + If {{empty}} is specified, the CPE MUST use the interface as directed by its bridging or routing policy (''Forwarding'' table entries) to determine the appropriate interface. @@ -37778,6 +40215,30 @@ + + + Determines the timeout, in {{units}}, of NAT translations for TCP sessions. It is the time after which a NAT entry is removed from the NAT table if there is no activity. A value of -1 represents an infinite duration. + + + + + + + + + + + + Determines the timeout, in {{units}}, of NAT translations for UDP bindings. It is the time after which a NAT entry is removed from the NAT table if there is no activity. A value of -1 represents an infinite duration. + + + + + + + + + @@ -37937,8 +40398,8 @@ The IP address or DNS host name of an internal client (on the LAN). Support for an IP address is mandatory. If {{param}} is specified as an IP address and the LAN device's IP address subsequently changes, the port mapping MUST remain associated with the original IP address. - Support for DNS host names is OPTIONAL. If {{param}} is specified as a DNS host name and the LAN device's IP address subsequently changes, the port mapping MUST remain associated with this LAN device. In this case, it is the responsibility of the CPE to maintain the name-to-address mapping in the event of IP address changes. This can be accomplished, for example, by assigning the DNS host name via use of DHCP option 12 (Host Name) or option 81 (FQDN). Note that the ACS can learn the host name associated with a given LAN device via the {{object|.Hosts.Host.}} table. - Read access to this parameter MUST always return the exact value that was last set by the ACS. For example, if the internal client is set to a DNS host name, it MUST read back as a DNS host name and not as an IP address. + Support for DNS host names is OPTIONAL. If {{param}} is specified as a DNS host name and the LAN device's IP address subsequently changes, the port mapping MUST remain associated with this LAN device. In this case, it is the responsibility of the CPE to maintain the name-to-address mapping in the event of IP address changes. This can be accomplished, for example, by assigning the DNS host name via use of DHCP option 12 (Host Name) or option 81 (FQDN). Note that the Controller can learn the host name associated with a given LAN device via the {{object|.Hosts.Host.}} table. + Read access to this parameter MUST always return the exact value that was last set by the Controller. For example, if the internal client is set to a DNS host name, it MUST read back as a DNS host name and not as an IP address. It MUST be possible to set the {{param}} to the broadcast IP address 255.255.255.255 for UDP mappings. This is to enable multiple NAT clients to use the same well-known port simultaneously. @@ -37963,7 +40424,7 @@ Properties for Port Control Protocol (PCP) {{bibref|RFC6887}}. - See the PCP Theory of Operation {{bibref|TR-181i2a8|Appendix XIV}} for a description of the working of this PCP data model. + See the PCP Theory of Operation {{bibref|TR-181i2|Appendix XIV}} for a description of the working of this PCP data model. @@ -38250,7 +40711,7 @@ - {{param|ServerNameOrAddress}} is an FQDN, IPv4 address or IPv6 address that was created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration + {{param|ServerNameOrAddress}} is an FQDN, IPv4 address or IPv6 address that was created by the Controller, by some other management entity (e.g. via a GUI), or is present in the factory default configuration @@ -38377,7 +40838,7 @@ Inbound Mapping table. This table contains all Inbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode MAP, as described in {{bibref|RFC6887|Section 11}}. These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The {{param|Origin}} parameter indicates which mechanism requested the mapping. - For non-{{enum|Static|Origin}} mappings (here ''Static'' refers to the mechanism that created the mapping, not to the {{param|Lifetime}}), the ACS MAY modify the {{param||Enable}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. + For non-{{enum|Static|Origin}} mappings (here ''Static'' refers to the mechanism that created the mapping, not to the {{param|Lifetime}}), the Controller MAY modify the {{param||Enable}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. @@ -38453,7 +40914,7 @@ - Requested via static configuration, i.e. created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration + Requested via static configuration, i.e. created by the Controller, by some other management entity (e.g. via a GUI), or is present in the factory default configuration @@ -38656,7 +41117,7 @@ Outbound Mapping table. This table contains all Outbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode PEER, as described in {{bibref|RFC6887|Section 12}}. These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The {{param|Origin}} parameter indicates which mechanism requested the mapping. - For non-{{enum|Static|Origin}} mappings (here ''Static'' refers to the mechanism that created the mapping, not to the {{param|Lifetime}}), the ACS MAY modify the {{param||Enable}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. + For non-{{enum|Static|Origin}} mappings (here ''Static'' refers to the mechanism that created the mapping, not to the {{param|Lifetime}}), the Controller MAY modify the {{param||Enable}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. @@ -38734,7 +41195,7 @@ - Requested via static configuration, i.e. created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration + Requested via static configuration, i.e. created by the Controller, by some other management entity (e.g. via a GUI), or is present in the factory default configuration @@ -39368,6 +41829,31 @@ + + + Pool association criterion. Determines which devices are allowed, {{enum}} + + + + + + All clients are served. + + + + + Only clients, whose MAC address is listed in the {{object|Client.{i}.}} table (parameter {{param|Client.{i}.Chaddr}}) or in the {{object|StaticAddress.{i}.}} table (parameter {{param|StaticAddress.{i}.Chaddr}}) are served. + The parameter {{param|#.Chaddr}} is not used, if this value is set. + + + + + Only clients, whose MAC address is '''not''' listed in the {{object|Client.{i}.}} table (parameter {{param|Client.{i}.Chaddr}}) or in the {{object|StaticAddress.{i}.}} table (parameter {{param|StaticAddress.{i}.Chaddr}}) are served. + + + + + Specifies first IPv4 address in the pool to be assigned by the DHCP server on the LAN interface. @@ -39453,7 +41939,6 @@ - @@ -39462,7 +41947,6 @@ - @@ -40497,7 +42981,6 @@ - @@ -40506,7 +42989,6 @@ - @@ -41298,7 +43780,7 @@ Smart Card Type. {{enum}} - Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a2|Section 3.3}} MUST be adhered to. + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to. @@ -41311,7 +43793,7 @@ {{list}} Indicates Smart Card Application(s). {{param}} is only relevant when {{param|Type}} has a value of UICC, otherwise it is {{empty}}. {{enum}} - Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a2|Section 3.3}} MUST be adhered to. + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to. @@ -42353,25 +44835,16 @@ - Indicates availability of diagnostic data. {{enum}} - If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed value is {{enum|Requested}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set either prior to or at the same time as (in the same SetParameterValues) setting the DiagnosticsState to Requested. - When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic. - When the test is completed, the value of this parameter MUST be either {{enum|Complete}} (if the test completed successfully), or one of the Error values listed above. - If the value of this parameter is anything other than {{enum|Complete}}, the values of the results parameters for this test are indeterminate. - When the diagnostic initiated by the ACS is completed (successfully or not), the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code "8 DIAGNOSTICS COMPLETE" in the Inform message. - After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}. - Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}. - While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}. - While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. + {{datatype|expand}} - + - + @@ -42390,7 +44863,7 @@ Firewall configuration object. The {{param|Config}} parameter enables and disables the Firewall, and can select either a predefined configuration ({{enum|High|Config}} or {{enum|Low|Config}}) or an explicitly-defined {{enum|Advanced|Config}} configuration. For an {{enum|Advanced|Config}} configuration, {{param|AdvancedLevel}} controls the currently active Firewall Level, and the Firewall Levels are defined in the {{object|Level}}, {{object|Chain}} and {{object|Chain.{i}.Rule}} tables. The Firewall rules modeled by this object operate only on the forwarding path. This means that they affect only routed traffic, and do not affect traffic that is destined for or generated by the CPE. Note that any {{object|#.NAT}} processing on the ingress packet occurs before Firewall rules are applied so, for example, the Firewall rules will see the translated destination IP address and port in a downstream packet that has passed through the NAT. - See {{bibref|TR-181i2a2|Appendix VIII}} for an example {{enum|Advanced|Config}} configuration. + See {{bibref|TR-181i2|Appendix VIII}} for an example {{enum|Advanced|Config}} configuration. @@ -42404,7 +44877,7 @@ How this firewall is configured. {{enum}} - Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a2|Section 3.3}} MUST be adhered to. + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to. @@ -43116,7 +45589,7 @@ This object configures collection of periodic statistics for the device. - Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the ACS as a comma-separated list of the most recent <n> samples. + Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the Controller as a comma-separated list of the most recent <n> samples. This object provides a single set of global settings that affect the entire device unless overridden locally. @@ -43179,7 +45652,7 @@ Indicates availability of Sample statistics. {{enum}} - The {{enum|Trigger}} value is only used for triggering the ACS to fetch the collected data and can only be used when {{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}]. + The {{enum|Trigger}} value is only used for triggering the Controller to fetch the collected data and can only be used when {{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}]. The transition from {{enum|Enabled}} to {{enum|Trigger}} to {{enum|Enabled}} MUST be instantaneous and so will result in only a single value change for notification purposes. @@ -43196,7 +45669,7 @@ - Collection is enabled and the ACS SHOULD now fetch the collected data. + Collection is enabled and the Controller SHOULD now fetch the collected data. @@ -43250,7 +45723,7 @@ {{param}} is used only to set the "phase" of the sample and fetch intervals. The actual value of {{param}} can be arbitrarily far into the past or future. This time reference also determines when the {{param|Status}} {{enum|Enabled|Status}} to {{enum|Trigger|Status}} to {{enum|Enabled|Status}} transitions that are controlled by {{param|FetchSamples}} will occur. If collection of periodic statistics is enabled and {{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}] then each such {{param|Status}} transition MUST occur at this reference time plus or minus an integer multiple of {{param|FetchSamples}} * {{param|SampleInterval}} (the fetch interval). If {{param}} is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. - The Unknown Time value defined in {{bibref|TR-106a2}} indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals. + The Unknown Time value defined in {{bibref|TR-106}} indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals. If absolute time is not available to the CPE, its sample and fetch interval behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. For example, if {{param|SampleInterval}} is 3600 (an hour) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then sample intervals will complete on each UTC hour (00:00, 01:00, 02:00 etc). If, in addition, {{param|FetchSamples}} is 24, then the fetch interval is 86400 (a day) and {{param|Status}} {{enum|Enabled|Status}} to {{enum|Trigger|Status}} to {{enum|Enabled|Status}} transitions will occur every day at UTC midnight. @@ -43265,7 +45738,7 @@ The number of sample intervals to be collected before transitioning {{param|Status}} from {{enum|Enabled|Status}} to {{enum|Trigger|Status}} to {{enum|Enabled|Status}}. If this SampleSet is enabled and {{param}} is in the range [1:{{param|ReportSamples}}] then {{param|Status}} MUST transition from {{enum|Enabled|Status}} to {{enum|Trigger|Status}} to {{enum|Enabled|Status}} on completion of every {{param}} sample intervals. Otherwise, the transition MUST NOT occur. - For example, if {{param|ReportSamples}} is 25 and {{param}} is 24, then the CPE will store 25 values for each monitored parameter and the above {{param|Status}} transition will occur as the CPE stores each 24th of 25 sample intervals, which means that the ACS could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also {{param|ForceSample}}). + For example, if {{param|ReportSamples}} is 25 and {{param}} is 24, then the CPE will store 25 values for each monitored parameter and the above {{param|Status}} transition will occur as the CPE stores each 24th of 25 sample intervals, which means that the Controller could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also {{param|ForceSample}}). To disable this trigger mechanism and still collect sampled statistics, {{param}} can be set to either 0 or a value greater than {{param|ReportSamples}}. @@ -43326,7 +45799,6 @@ - @@ -43493,7 +45965,7 @@ * "out of range (low)" : current value is less than or equal to {{param|LowThreshold}}. * "out of range (high)" : current value is greater than or equal to {{param|HighThreshold}}. Note that, if {{param|LowThreshold}} and {{param|HighThreshold}} are both the same, the threshold/failure mechanism is disabled, so the value of this parameter will not increment. - This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. For this reason, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of such changes, as described in {{bibref|TR-069a2|Section 3.2.1}}. + This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. For this reason, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the Controller of such changes. Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters. @@ -43656,7 +46128,7 @@ Contains all currently active alarms (whose {{param|.FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity}} is not {{enum|Cleared|.FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity}}). Newly raised alarms result in a new entry in this table being added, any changes to the alarm as a result of an update event are updated in the existing table entry, and a clear event raised against an alarm results in the alarm being removed from this table. If maximum entries as indicated by {{param|.FaultMgmt.MaxCurrentAlarmEntries}} is reached, the next event overrides the object with the oldest {{param|AlarmChangedTime}}. - When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm). + When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the Controller (even if their new values are identical to those of the prior alarm). @@ -43892,9 +46364,9 @@ Alarm events added or updated in {{object|.FaultMgmt.CurrentAlarm.{i}.}} are simultaneously entered into the this table if their corresponding entry in {{object|.FaultMgmt.SupportedAlarm.{i}.}} has {{param|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}} set to {{enum|0 Expedited|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}}. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to {{param|.FaultMgmt.ExpeditedEventNumberOfEntries}}. - Initially the table starts with all instances having {{param|EventTime}} set to the Unknown Time value, as defined in {{bibref|TR-106a4}}. + Initially the table starts with all instances having {{param|EventTime}} set to the Unknown Time value, as defined in {{bibref|TR-106}}. If maximum instance number {{param|.FaultMgmt.ExpeditedEventNumberOfEntries}} is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records. - When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm). + When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the Controller (even if their new values are identical to those of the prior alarm). @@ -43902,7 +46374,7 @@ Indicates the date and time when the alarm event occurs. - For an unpopulated entry, the value is the Unknown Time as defined in {{bibref|TR-106a4}}. + For an unpopulated entry, the value is the Unknown Time as defined in {{bibref|TR-106}}. @@ -44013,9 +46485,9 @@ Alarm events added or updated in {{object|.FaultMgmt.CurrentAlarm.{i}.}} are simultaneously entered into the this table if their corresponding entry in {{object|.FaultMgmt.SupportedAlarm.{i}.}} has {{param|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}} set to {{enum|1 Queued|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}}. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to {{param|.FaultMgmt.QueuedEventNumberOfEntries}}. - Initially the table starts with all instances having {{param|EventTime}} set to the Unknown Time value, as defined in {{bibref|TR-106a4}}. + Initially the table starts with all instances having {{param|EventTime}} set to the Unknown Time value, as defined in {{bibref|TR-106}}. If maximum instance number {{param|.FaultMgmt.QueuedEventNumberOfEntries}} is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records. - When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm). + When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the Controller (even if their new values are identical to those of the prior alarm). @@ -44023,7 +46495,7 @@ Indicates the date and time when the alarm event occurs. - For an unpopulated entry, the value is the Unknown Time as defined in {{bibref|TR-106a4}}. + For an unpopulated entry, the value is the Unknown Time as defined in {{bibref|TR-106}}. @@ -44278,7 +46750,7 @@ An absolute time reference in UTC to determine when the CPE will initiate the periodic GPS scan. Each GPS scan MUST occur at (or as soon as possible after) this reference time plus or minus an integer multiple of the {{param|PeriodicInterval}}. {{param}} is used only to set the "phase" of the GPS scan. The actual value of {{param}} can be arbitrarily far into the past or future. For example, if {{param|PeriodicInterval}} is 86400 (a day) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then periodic GPS scans will occur every day at UTC midnight. These MUST begin on the very next midnight, even if {{param}} refers to a day in the future. - The Unknown Time value defined in {{bibref|TR-106a4|Section 3.2}} 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 PeriodicInformInterval. + The Unknown Time value defined in {{bibref|TR-106|Section 3.2}} 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 PeriodicInformInterval. If absolute time is not available to the CPE, its periodic GPS scan behavior MUST be the same as if {{param}} parameter was set to the Unknown Time value. @@ -44343,7 +46815,7 @@ Specifies the date and time, when the GPS scan last completed successfully. This value is retained across reboot and is only reset after another scan completes successfully or {{param|GPSReset}} is set to {{true}}. - The values for {{param|LockedLatitude}}, {{param|LockedLongitude}} and {{param|NumberOfSatellites}} correspond to this time. If a scan has never succeeded before, the value will be the Unknown Time value, as defined in {{bibref|TR-106a4|Section 3.2}}. + The values for {{param|LockedLatitude}}, {{param|LockedLongitude}} and {{param|NumberOfSatellites}} correspond to this time. If a scan has never succeeded before, the value will be the Unknown Time value, as defined in {{bibref|TR-106|Section 3.2}}. @@ -44468,7 +46940,7 @@ Represents the date and time when the last GPS Fix was acquired. - The Unknown Time value defined in {{bibref|TR-106a4|Section 3.2}} is used when {{param|GotFix}} is {{false}}. This applies too after a reboot of the device until a valid location is determined and {{param|GotFix}} transsitions to {{true}}. + The Unknown Time value defined in {{bibref|TR-106|Section 3.2}} is used when {{param|GotFix}} is {{false}}. This applies too after a reboot of the device until a valid location is determined and {{param|GotFix}} transsitions to {{true}}. @@ -44722,7 +47194,7 @@ An absolute time reference in UTC to determine when the device will initiate the periodic file upload. Each file upload MUST occur at this reference time plus or minus an integer multiple of the {{param|PeriodicUploadInterval}}. {{param}} is used only to set the "phase" of the periodic uploads. The actual value of {{param}} can be arbitrarily far into the past or future. For example, if {{param|PeriodicUploadInterval}} is 86400 (a day) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then periodic file uploads will occur every day at UTC midnight. These MUST begin on the very next midnight, even if {{param}} refers to a day in the future. - The Unknown Time value as defined in {{bibref|TR-106a4|Section 3.2}} 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 {{param|PeriodicUploadInterval}}. + The Unknown Time value as defined in {{bibref|TR-106|Section 3.2}} 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 {{param|PeriodicUploadInterval}}. If absolute time is not available to the device, its periodic file upload behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. @@ -44954,8 +47426,7 @@ This is the reference to the IPsec tunnel instance to be used by the Application Platform traffic. - If InternetGatewayDevice:1 {{bibref|TR-098}} or Device:1 {{bibref|TR-181i1}}) is used as root data model the {{param}} MUST point to a row in the ''.FAP.Tunnel.IKESA.{i}.'' table. - If the root data model used is Device:2 {{bibref|TR-181i2}} than the {{param}} MUST point to an tunnel instance defined in this data model. + The {{param}} MUST point to a tunnel instance defined in the data model. If the referenced object is deleted, the parameter value MUST be set to an empty string. @@ -45547,7 +48018,7 @@ This object provides bulk data collection capabilities and global collection settings that affect the entire device. Bulk Data utilizes various solutions (e.g., IPDR, HTTP) to collect data from devices and transfer the data to a collection server. The IPDR solution is based on a service specification described in {{bibref|TR-232}}. - The HTTP solution is based on transfer mechanisms described in {{bibref|TR-157a10|Annex A}}. + The HTTP solution is based on transfer mechanisms described in {{templ|BULK-DATA-HTTP-REF}}. The Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server. @@ -45659,7 +48130,7 @@ - The maximum number of profiles that can exist at any given time. Specifically, the maximum number of {{object|Profile.{i}.}} instances that the ACS can create. + The maximum number of profiles that can exist at any given time. Specifically, the maximum number of {{object|Profile.{i}.}} instances that the Controller can create. If the value of this parameter is -1, then it means that the CPE doesn't have a limit to the number of profiles that can exist. @@ -45691,7 +48162,7 @@ A set of Bulk Data Collection profiles. - Each profile represents a bulk data report, including its own timing configuration, communications configuration, and set of parameters. This allows the ACS to configure multiple reports to be generated at different times for different sets of data. + Each profile represents a bulk data report, including its own timing configuration, communications configuration, and set of parameters. This allows the Controller to configure multiple reports to be generated at different times for different sets of data. @@ -45780,7 +48251,7 @@ An absolute time reference in UTC to determine when will be transmitted. Each reporting interval MUST complete at this reference time plus or minus an integer multiple of {{param|ReportingInterval}}, unless unable to due to higher prioritized operations. {{param}} is used only to set the "phase" of the reporting intervals. The actual value of {{param}} can be arbitrarily far into the past or future. If {{param}} is changed while collection of bulk data is enabled, the first reporting interval begins immediately. - The Unknown Time value as defined in {{bibref|TR-106a2}} indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified reporting intervals. + The Unknown Time value as defined in {{bibref|TR-106}} indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified reporting intervals. If absolute time is not available to the CPE, its reporting interval behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. For example, if {{param|ReportingInterval}} is 86400 (a day) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then the CPE will generate (and transmit, if in a "ITPush" mode) its report at midnight every 24 hours. Note that, if {{param}} is set to a time other than the Unknown Time, the first reporting interval (which has to begin immediately) will almost certainly be shorter than {{param|ReportingInterval}}). This is why {{param}} is defined in terms of when reporting intervals complete rather than start. @@ -45814,7 +48285,7 @@ This is the unique identification of an IPDR Session to be used when this collection profile is configured for the IPDR Streaming Protocol {{bibref|IPDR-SP}} (the {{param|Protocol}} parameter has a value of {{enum|Streaming|#.Protocols}}). - An ACS MUST NOT configure multiple IPDR Streaming Protocol collection profiles with the same {{param}}. Doing so MUST cause the CPE to fail the SetParameterValues. + A Controller MUST NOT configure multiple IPDR Streaming Protocol collection profiles with the same {{param}}. Doing so MUST cause the CPE to fail the SetParameterValues. Within the IPDR Streaming Protocol specification the Session ID has a type of a single 'char', but we are restricting the range even further (ASCII values of '0' - '9' and 'A' - 'Z'. @@ -45890,7 +48361,7 @@ Name of the parameter in the report body. If the value of this parameter is {{empty}}, then the value of the {{param|Reference}} parameter is used as the name. - When the value {{param|Reference}} parameter contains wildcards and/or partial parameter names, the rules for determining the value of this parameter are specified in {{bibref|TR-157a10|Annex A.3.2.1}}. + When the value {{param|Reference}} parameter contains wildcards and/or partial parameter names, the rules for determining the value of this parameter are specified in {{templ|BULK-DATA-HTTP-REF}} @@ -45946,7 +48417,7 @@ - This parameter describes the formatting used for reports defined by this profile as described in {{bibref|TR-157a10|Annex A.3.4}}. + This parameter describes the formatting used for reports defined by this profile as described in {{templ|BULK-DATA-CSV-ENC}}. Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in {{bibref|RFC2616}}. @@ -45978,7 +48449,7 @@ - Timestamp is inserted using the ISO-8601 timestamp format. If the CPE is unable to acquire a time, then the processing described by the dateTime type in {{bibref|TR-069|Table 12}} is followed. + Timestamp is inserted using the ISO-8601 timestamp format{{templ|BULK-DATA-TIMESTAMP}} @@ -45997,7 +48468,7 @@ - This parameter describes the formatting used for the report as described in {{bibref|TR-157a10|Annex A.3.5}}. + This parameter describes the formatting used for the report as described in {{bibref|TR-069|Annex N.3.5}}. Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in {{bibref|RFC2616}}. @@ -46018,7 +48489,7 @@ - The format of timestamp to use for the JSON Object named "CollectionTime" as described in {{bibref|TR-157a10}}. + The format of timestamp to use for the JSON Object named "CollectionTime" as described in {{bibref|TR-069|Annex N.3.5.1}}. @@ -46029,7 +48500,7 @@ - Timestamp is inserted using the ISO-8601 timestamp format. If the CPE is unable to acquire a time, then the processing described by the dateTime type in {{bibref|TR-069|Table 12}} is followed. + Timestamp is inserted using the ISO-8601 timestamp format. {{templ|BULK-DATA-TIMESTAMP}} @@ -46163,8 +48634,8 @@ - Configures the data transfer retry wait interval, in seconds, as specified in {{bibref|TR-157a10|Annex A.2.2.1}}. - 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 wait interval, in seconds, as specified in {{bibref|TR-069|Annex N.2.2.1}}. + 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. @@ -46175,9 +48646,9 @@ - Configures the retry interval multiplier as specified in {{bibref|TR-157a10|Annex A.2.2.1}}. - 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. + Configures the retry interval multiplier as specified in {{bibref|TR-069|Annex N.2.2.1}}. + 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. @@ -46208,7 +48679,7 @@ - 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 {{bibref|TR-157a10|Annex A.2.1}}. + 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 {{bibref|TR-069|Annex N.2.1}}. @@ -46236,7 +48707,7 @@ - The {{object}} represents the XMPP capabilities of the device as described in {{bibref|TR-069a5|Appendix III}}. + The {{object}} represents the XMPP capabilities of the device{{templ|XMPP-REF-APP}} @@ -46320,7 +48791,7 @@ Password used to authenticate this {{object}} when making a connection to the {{object|Server}} using the procedure outlined in {{bibref|RFC6120|Section 6}}. - Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset. + Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If a Controller modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset. - The maximum first reconnection wait interval, in {{units}}, as specified in {{bibref|TR-069a5|Annex K XMPP Connection Request}}. + The maximum first reconnection wait interval, in {{units}}{{templ|XMPP-REF}} The Device MUST use a random value between ''0'' and {{param}} as the first reconnection wait interval. NOTE: If the value of the {{param|ServerConnectAttempts}} parameter is 0, the value of this parameter is ignored. @@ -46437,7 +48908,7 @@ - The reconnection interval multiplier as specified in {{bibref|TR-069a5|Annex K XMPP Connection Request}}. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. + The reconnection interval multiplier{{templ|XMPP-REF}} This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. For the ''n''th reconnection wait interval, the Device MUST use a random value, in ''seconds'', between ''0'' and {{param|ServerRetryInitialInterval}} * ({{param}} / 1000) ** (''n'' - ''1''). NOTE: If the value of the {{param|ServerConnectAttempts}} parameter is 0, the value of this parameter is ignored. @@ -46464,7 +48935,7 @@ - This parameter allows an ACS to configure whether or not this XMPP Connection is required to use TLS independent of whether or not the XMPP Server that is being connected to is configured for TLS "mandatory-to-negotiate". + This parameter allows a Controller to configure whether or not this XMPP Connection is required to use TLS independent of whether or not the XMPP Server that is being connected to is configured for TLS "mandatory-to-negotiate". If the value of {{param}} is {{true}} then the CPE will initiate TLS negotiation if not required to by the XMPP Server. If the value of {{param}} is {{false}} then the CPE will not initiate TLS negotiation if not required to by the XMPP Server. @@ -47335,7 +49806,7 @@ - Enables or disables the 1905 Network Topology reporting (via TR-069). When {{true}}, the device clears and (re)populates the {{object|IEEE1905Device}} and {{object|ChangeLog}} tables. When {{false}}, the contents of the {{object|IEEE1905Device}} and {{object|ChangeLog}} tables have no meaning. + Enables or disables the 1905 Network Topology reporting (via a Controller). When {{true}}, the device clears and (re)populates the {{object|IEEE1905Device}} and {{object|ChangeLog}} tables. When {{false}}, the contents of the {{object|IEEE1905Device}} and {{object|ChangeLog}} tables have no meaning. @@ -47553,6 +50024,16 @@ + + + {{param}} is a reference to the Wi-Fi Network "APDevice". Since IEEE 1905.1 is the protocol used by the Wi-Fi Alliance's EasyMesh specification for communications, this parameter allows the IEEE 1905.1 portion of the data model to reference the associated EasyMesh portion of the data model. + + + + + + + {{numentries}} @@ -48240,7 +50721,7 @@ - MQTT Base object describing all MQTT related parameters and objects {{bibref|MQTT31}}, + MQTT Base object describing all MQTT related parameters and objects. @@ -48277,7 +50758,12 @@ - Protocol according to {{bibref|MQTT311}} + Protocol according to {{bibref|MQTT31}} + + + + + Protocol according to {{bibref|MQTT50}} @@ -48352,8 +50838,10 @@ Allows to enable or disable the MQTT client. - If a MQTT client gets enabled then the MQTT client has first to establish a MQTT broker session and then subscribe for all enabled topics in the {{object|Subscription.}} table. In case the {{param|CleanSession}} is set to {{false}} a subscription MUST only be sent for topics which haven't been subscribed before (see {{bibref|MQTT311|3.1.2.4}}). - If a connected MQTT client gets disabled ({{param|Status}} is either {{enum|Connecting|Status}} or {{enum|Connected|Status}}) then the MQTT client has to send a MQTT DISCONNECT message to disconnect from the MQTT broker ({{bibref|MQTT31|3.14}} or {{bibref|MQTT311|3.14}}), before setting the {{param|Status}} to {{enum|Disabled|Status}}. + If a MQTT client gets enabled then the MQTT client has first to establish a MQTT broker session and then subscribe for all enabled topics in the {{object|Subscription.}} table. + If the {{param|ProtocolVersion}} is set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|#.Capabilities.ProtocolVersionsSupported}} and {{param|CleanSession}} is set to {{false}} a subscription MUST only be sent for topics which haven't been subscribed before (see {{bibref|MQTT31|section 3.1.2.4}}). + If the {{param|ProtocolVersion}} is set to {{enum|5.0|#.Capabilities.ProtocolVersionsSupported}} and {{param|CleanStart}} is set to {{false}} a subscription MUST only be sent for topics which haven't been subscribed before (see {{bibref|MQTT50|section 3.1.2.4}}). + If a connected MQTT client gets disabled ({{param|Status}} is either {{enum|Connecting|Status}} or {{enum|Connected|Status}}) then the MQTT client has to send a MQTT DISCONNECT packet to disconnect from the MQTT broker ({{bibref|MQTT31|section 3.14}},{{bibref|MQTT31|section 3.14}}) or {{bibref|MQTT50|section 3.14}}), before setting the {{param|Status}} to {{enum|Disabled|Status}}. @@ -48377,50 +50865,6 @@ - - - The MQTT client identifier used in the CONNECT message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.1}}). This parameter MUST NOT be {{empty}}, the CPE has to provide a default value for the parameter, which can be changed by the ACS. - A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. - - - - - - - - - - Username used to authenticate the CPE when making a connection to the MQTT broker. {{bibref|MQTT31|3.1}} recommends that the username has 12 characters or fewer, but this is not required. - If this parameter is {{empty}} no authentication parameters are sent in the MQTT CONNECT message. - - - - - - - - - - Password used to authenticate the CPE when making a connection to the MQTT broker (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.4}}). - This password is only sent in the MQTT CONNECT message if {{param|Username}} is not {{empty}}. - - - - - - Indicates the transport protocol to be used for the MQTT broker connection. - - - - - - - - Specifies the MQTT protocol version used in the communication with the MQTT broker. @@ -48431,65 +50875,6 @@ - - - The value of the MQTT clean session flag in the MQTT CONNECT message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.4}}). If this flag is set to {{true}} (default), the MQTT broker will delete all subscription information after a Disconnect. - A change of this parameter is only effective after the next MQTT CONNECT message to the MQTT broker. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. - - - - - - - - - Message retry time in {{units}} defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see {{bibref|MQTT31|4.2}} and {{bibref|MQTT311|4.4}}). - - - - - - - - - - - - Connect retry time in {{units}} defines the wait time before a failed MQTT broker connection is retried. - A failure can either be on the connection level (the TCP/IP or TLS can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK message on a MQTT CONNECT message sent. - - - - - - - - - - - - Keep Alive Time in {{units}} defines the maximum wait time after which a message has to be sent to the MQTT broker (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.10}}). If no regular messages can be sent a MQTT PINGREQ is sent. - A value of zero (0) means no keep alive message are sent and the MQTT client is not disconnected by the server. - A change of this parameter is only effective after the next MQTT CONNECT message to the MQTT broker. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. - - - - - - - - - - - - Disconnects the MQTT client from the MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT client is currently connected to the MQTT broker (Parameter {{param|Status|}} is {{enum|Connected|Status}}). - If the MQTT client is in a different state, the parameter has no effect. - This action parameter may be used to immediately apply changes in the MQTT connection settings. - - - - - Host name or IP address of the MQTT Broker. @@ -48511,40 +50896,53 @@ + + + Indicates the transport protocol to be used for the MQTT broker connection. + + + + + + + + + + + The value of the MQTT clean session flag in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}} and {{bibref|MQTT31|section 3.1.2.4}}). If this flag is set to {{true}} (default), the MQTT broker will delete all subscription information after a Disconnect. + {{templ|MQTTReconnect}} + This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|#.Capabilities.ProtocolVersionsSupported}}. + + + + + + + + + The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see {{bibref|MQTT50|section 3.1.2.4}}. If this flag is set to {{true}} (default), the MQTT broker will delete all subscription information after a Disconnect. + {{templ|MQTTReconnect}}. + {{templ|MQTT50ONLY}} + + + + + + - Enables or disables the will handling (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.5}}).. Changing this parameter while the MQTT client is connected will cause the client to disconnect and reconnect. - If the connection gets enabled and this parameter is set to {{true}} and either the parameter {{param|WillTopic}} or {{param|WillValue}} are {{empty}}, the CPE MUST set the {{param|Status}} to {{enum|Error_Misconfigured|Status}} (see {{bibref|MQTT311|3.1.2.5}}). + Enables or disables the will handling (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.5}}) or {{bibref|MQTT50|section 3.1.2.5}}). + If the connection gets enabled and this parameter is set to {{true}} and either the parameter {{param|WillTopic}} or {{param|WillValue}} are {{empty}}, the CPE MUST set the {{param|Status}} to {{enum|Error_Misconfigured|Status}}. + {{templ|MQTTReconnect}}. - - - The Topic sent in the Will Message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.5}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. - A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. - If the will handling is enabled (Paramter {{param|WillEnable}} is set to {{true}}) and the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. - - - - - - - - The value sent in the Will Message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.5}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. - A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. - If the will handling is enabled (Paramter {{param|WillEnable}} is set to {{true}}) and the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. - - - - - - The MQTT QoS level assigned with the will message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.6}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. - A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. - If the will handling is enabled (Paramter {{param|WillEnable}} is set to {{true}}) and the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. + The MQTT QoS level assigned with the will message (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.6}}) or {{bibref|MQTT50|section 3.1.2.6}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. + {{templ|MQTTWillChange}} @@ -48554,14 +50952,296 @@ - Indicate to the MQTT broker to retain the Will over a Disconnect (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.7}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. - A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. - If the will handling is enabled (Paramter {{param|WillEnable}} is set to {{true}}) and the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. + Indicate to the MQTT broker to retain the Will over a Disconnect (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.7}}) or {{bibref|MQTT50|section 3.1.2.7}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. + {{templ|MQTTWillChange}} + + + Keep Alive Time in {{units}} defines the maximum wait time after which a packet has to be sent to the MQTT broker (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.10}}) or {{bibref|MQTT50|section 3.1.2.10}}). If no regular packet can be sent a MQTT PINGREQ packet is sent. + A value of zero (0) means no keep alive packets are sent and the MQTT client is not disconnected by the server. + {{templ|MQTTReconnect}} + + + + + + + + + + + + Disconnects the MQTT client from the MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT client is currently connected to the MQTT broker (Parameter {{param|Status|}} is {{enum|Connected|Status}}). + If the MQTT client is in a different state, the parameter has no effect. + This action parameter may be used to immediately apply changes in the MQTT connection settings. + + + + + + + + Session expiry interval in {{units}} defines the wait time before a session expires after the connection has been closed by the MQTT client {{bibref|MQTT50|section 3.1.2.11.2}}). + {{templ|MQTT50ONLY}} + + + + + + + + + + The MQTT client uses this value to limit the number of QoS 1 and QoS 2 publications that it is willing to process concurrently (see {{bibref|MQTT50|section 3.1.2.11.3}}). + {{templ|MQTTReconnect}} + {{templ|MQTT50ONLY}} + + + + + + + + The maximum packet size in {{units}} the MQTT client can and will accept from the MQTT broker. A value of 0 means no limit. If the value is set to another value, the MQTT client will inform the broker in the next CONNECT packet {{bibref|MQTT50|section 3.1.2.11.4}}). + {{templ|MQTTReconnect}} + {{templ|MQTT50ONLY}} + + + + + + + + + + This value indicates the highest value that the MQTT client will accept as a Topic Alias sent by the Server (see {{bibref|MQTT50|section 3.1.2.11.5}}). The MQTT client uses this value to limit the number of Topic Aliases that it is willing to hold on this connection. + A value of 0 indicates that Topic Alias is not supported. + {{templ|MQTTReconnect}} + {{templ|MQTT50ONLY}} + + + + + + + + + + The MQTT client uses this value in a MQTT CONNECT packet to request the Server to return Response Information in the MQTT CONNACK (see {{bibref|MQTT50|section 3.1.2.11.6}}). + {{templ|MQTTReconnect}} + {{templ|MQTT50ONLY}} + + + + + + + + This value indicates whether the Reason String or User Properties are sent in the case of failures.(see {{bibref|MQTT50|section 3.1.2.11.7}}). + {{templ|MQTTReconnect}} + {{templ|MQTT50ONLY}} + + + + + + + + This value defines the extended authentication method to be used (see {{bibref|MQTT50|section 3.1.2.11.9}}). + If the parameter is empty, no extended authentication is performed. + {{templ|MQTTReconnect}} + {{templ|MQTT50ONLY}} + + + + + + + + + + The MQTT client identifier used in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.1}}) or {{bibref|MQTT50|section 3.1.3.1}}). + If {{param|ProtocolVersion}} is set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|#.Capabilities.ProtocolVersionsSupported}}, this parameter MUST NOT be an empty string. + If {{param|ProtocolVersion}} is set to {{enum|5.0|#.Capabilities.ProtocolVersionsSupported}}, an empty string is allowed. + {{templ|MQTTReconnect}} + + + + + + + + + + The delay in {{units}} after the session is disconnected, before sending the Will message {{bibref|MQTT50|section 3.1.3.2.2}}). A value of 0 indicates that there is no delay. + {{templ|MQTTWillChange}} + {{templ|MQTT50ONLY}} + + + + + + + + + + + The lifetime in {{units}} of a Will Message (see {{bibref|MQTT50|section 3.1.3.2.4}}). A value of 0 indicates that no message expiry interval value is specified for in the will message properties of a CONNECT packet. + {{templ|MQTT50ONLY}} + + + + + + + + + + Describes the type of the {{param|WillValue}} {{bibref|MQTT50|section 3.1.3.2.5}}). + {{templ|MQTTWillChange}} + {{templ|MQTT50ONLY}} + + + + + + + + + + Topic Name for a will response message. The presence of a Response Topic identifies the Will Message as a Request {{bibref|MQTT50|section 3.1.3.2.6}}). + If the {{param}} is an empty string the will response topic will not be sent in a MQTT CONNECT packet. + {{templ|MQTTWillChange}} + {{templ|MQTT50ONLY}} + + + + + + + + + + The Topic sent in the Will Message (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.3}}) or {{bibref|MQTT50|section 3.1.3.3}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. + {{templ|MQTTWillChange}} + + + + + + + + + + The value sent in the Will Message (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.5}}) or {{bibref|MQTT50|section 3.1.3.4}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. + {{templ|MQTTWillChange}} + + + + + + + + + + Username used to authenticate the MQTT client when making a connection to the MQTT broker. The value is sent in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.4}} or {{bibref|MQTT50|section 3.1.3.5}}). + For MQTT 3.1 {{bibref|MQTT31|section 3.1}} recommends that the user name has 12 characters or fewer, but this is not required. + If this parameter is {{empty}} no authentication parameters are sent in the MQTT CONNECT packet. + + + + + + + + + + Password used to authenticate the MQTT client when making a connection to the MQTT broker. The value is sent in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.5}} or {{bibref|MQTT50|section 3.1.3.6}}). + This password is only sent in the MQTT CONNECT packet if {{param|Username}} is not {{empty}}. + + + + + + The lifetime in {{units}} of a PUBLISH Message (see {{bibref|MQTT50|section 3.3.2.3.3}}). A value of 0 indicates that no message expiry interval value is included in the PUBLISH packet. + {{templ|MQTT50ONLY}} + + + + + + + + + + Message retry time in {{units}} defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see {{bibref|MQTT31|section 4.2}}). + This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}}. + + + + + + + + + + + + Connect retry time in {{units}} defines the wait time before a failed MQTT broker connection is retried. + A failure can either be on the connection level (the TCP/IP or TLS can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK packet on a MQTT CONNECT packet sent. + If the parameter {{param|ConnectRetryIntervalMultiplier}} is defined, the MQTT client MUST use a random value between {{param}}*({{param|ConnectRetryIntervalMultiplier}}/1000)^(n-1) and {{param}}*({{param|ConnectRetryIntervalMultiplier}}/1000)^n for the connect retry time, with n equals the current retry number. The max number of n is 10, starting with the 11th retry always the value n = 10 is used. + If the parameters {{param|ConnectRetryIntervalMultiplier}} and {{param|ConnectRetryMaxInterval}} are defined, the MQTT client MUST use the value of {{param|ConnectRetryMaxInterval}} if the calculated random value exceeds the value of {{param|ConnectRetryMaxInterval}}. + + + + + + + + + + + + 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 maximum reconnection wait interval, in {{units}}. + + + + + + + + + + + + The value of the CONNACK Response Information property supplied by a MQTT 5.0 server. This value is used by a MQTT 5.0 client as the basis for the PUBLISH Response Topic property for all PUBLISH packets that expect a response. If the value of {{param}} is not a subset (wildcarded or precise match) of any of the {{param|Subscription.{i}.Topic}} values the MQTT client MUST subscribe to this Topic. + + + + + + + {{numentries}} @@ -48570,6 +51250,14 @@ + + + {{numentries}} + + + + + @@ -48592,7 +51280,7 @@ - Setting Enable to {{true}} means the topic is subscribed at the MQTT broker with a MQTT SUBSCRIBE message, setting it to {{false}} will unsubscribe the topic from the MQTT broker with a MQTT UNSUBSCRIBE message. If the MQTT client is already connected with the Broker ({{param|#.Status}} is {{enum|Connected|#.Status}}), the MQTT SUBSCRIBE or UNSUBSCRIBE message is sent directly, otherwise it is sent after the next successful connect. + When a MQTT client connects to a MQTT server, it MUST send a SUBSCRIBE message including all instances with {{param}} set to {{true}}. If the MQTT client is already connected with the MQTT server ({{param|#.Status}} is {{enum|Connected|#.Status}}), a MQTT SUBSCRIBE or UNSUBSCRIBE message MUST be sent directly when {{param}} is changed to {{true}} or {{false}}, respectively. The actual status of the subscription is indicated with {{param|Status}}. @@ -48604,7 +51292,7 @@ Indicates the status of this subscription. {{enum}} The {{enum|Subscribed}} value indicates that the topic was successfully subscribed with the MQTT broker, the MQTT client received the SUBACK message for this topic from the server. The {{enum|Subscribing}} value MAY be used by the CPE to indicate that the a SUBSCRIBE message for this topic was sent, and the CPE is waiting for a SUBACK message. - The {{enum|Unsubscribed}} value indicates that the topic is not reqistered with the MQTT broker. + The {{enum|Unsubscribed}} value indicates that the topic is not registered with the MQTT broker. The {{enum|Unsubscribing}} value MAY be used by the CPE to indicate that the an UNSUBSCRIBE message for this topic was sent, and the CPE is waiting for an UNSUBACK message. If the {{param|Enable}} is set to {{false}} the status MUST be either {{enum|Unsubscribed}} or if the unsubscription failed {{enum|Error}}. @@ -48620,7 +51308,7 @@ - Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in {{bibref|MQTT31|Appendix A}} and {{bibref|MQTT311|4.7}}. + Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in {{bibref|MQTT31|section Appendix A}}, {{bibref|MQTT31|section 4.7}} or {{bibref|MQTT50|4.7}}. @@ -48630,7 +51318,7 @@ - The MQTT QoS level assigned with the subscription (see {{bibref|MQTT31|4.1}} and {{bibref|MQTT311|4.3}}). + The MQTT QoS level assigned with the subscription (see {{bibref|MQTT31|section 4.1}}, {{bibref|MQTT31|section 4.3}}) or {{bibref|MQTT50|4.3}}. @@ -48639,6 +51327,119 @@ + + + List of user properties used by the MQTT client. + This table only applies if {{param|#.ProtocolVersion}} is set to {{enum|5.0|##.Capabilities.ProtocolVersionsSupported}}. + + + + + + + + + + {{datatype|expand}} + + + + + + + + Setting Enable to {{true}} means the user property is used in the indicated control packet(s). The user property will be applied to all control packets of the same control packet type (e.g PUBLISH). + + + + + + + + Name of the user property + + + + + + + + + + Value of the user property + + + + + + + + + + {{list}} Each entry defines the control packet type(s) in which the user property is included. + + + + + + + User property will be added in the AUTH control packet (see {{bibref|MQTT50|section 3.15.2.2.5}}) + + + + + User property will be added in the CONNECT packet (see {{bibref|MQTT50|section 3.1.3.2.8}}) + + + + + User property will be added in the DISCONNECT packet (see {{bibref|MQTT50|section 3.14.2.2.4}}) + + + + + User property will be added in the PUBLISH packet (see {{bibref|MQTT50|section 3.3.2.3.7}}) + + + + + User property will be added in the PUBACK packet (see {{bibref|MQTT50|section 3.4.2.2.3}}) + + + + + User property will be added in the PUBREC packet (see {{bibref|MQTT50|section 3.5.2.2.3}}) + + + + + User property will be added in the PUBREL packet (see {{bibref|MQTT50|section 3.6.2.2.3}}) + + + + + User property will be added in the PUBCOMP packet (see {{bibref|MQTT50|section 3.7.2.2.3}}) + + + + + User property will be added in the SUBSCRIBE packet (see {{bibref|MQTT50|section 3.8.2.1.3}}) + + + + + User property will be added in the UNSUBSCRIBE packet (see {{bibref|MQTT50|section 3.10.2.1.2}}) + + + + + User property will be added in the WILL properties (see {{bibref|MQTT50|section 3.1.3.2}}) + + + + + + Contains the MQTT client statistics and usage information. @@ -48771,7 +51572,7 @@ - Indicates the status of the MQTT broker. {{enum}} + Indicates the status of the MQTT broker. {{enum}} The "{{enum|Error_Misconfigured}}" value indicates that a necessary configuration value is undefined or invalid. The "{{enum|Error}}" value MAY be used by the CPE to indicate a locally defined error condition. @@ -48808,7 +51609,7 @@ - Username used to authenticate the MQTT clients, which connect to the MQTT broker. + User name used to authenticate the MQTT clients, which connect to the MQTT broker. If this parameter is {{empty}} no authentication is used. @@ -48895,36 +51696,13 @@ - + - The MQTT client identifier used in the CONNECT message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.1}}). This parameter MUST NOT be {{empty}}, the CPE has to provide a default value for the parameter, which may be changed by the ACS. - A change of this parameter is only communicated to the remote MQTT broker with the next MQTT CONNECT message. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. + Specifies the MQTT protocol version used in the MQTT bridge connection. - - - - - - - Username used to authenticate the MQTT broker when making a connection over the MQTT bridge (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.4}}). {{bibref|MQTT31|3.1}} recommends that the username has 12 characters or fewer, but this is not required. - If this parameter is {{empty}} no authentication parameters are sent in the MQTT CONNECT message. - - - - - - - - - - Password used to authenticate the MQTT broker when making a connection over the MQTT bridge (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.4}}). - The password is only sent if {{param|Username}} is not {{empty}}. - - @@ -48939,56 +51717,33 @@ - - - Specifies the MQTT protocol version used in the MQTT bridge connection. - - - - - - - - The value of the MQTT clean session flag in the MQTT bridge connection (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.4}}). If this flag is set to {{true}} (default), the remote MQTT broker will delete all subscription information after a Disconnect. - A change of this parameter is only effective after the next MQTT CONNECT message to the remote MQTT broker. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. + The value of the MQTT clean session flag in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}} and {{bibref|MQTT31|section 3.1.2.4}}) to establish a MQTT bridge connection. If this flag is set to {{true}} (default), the remote MQTT broker will delete all subscription information after a Disconnect. + {{templ|MQTTReconnect}} + This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|3.1|##.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|##.Capabilities.ProtocolVersionsSupported}}. - + - Message retry time in {{units}} defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see {{bibref|MQTT31|4.2}} and {{bibref|MQTT311|4.4}}). + The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see {{bibref|MQTT50|section 3.1.2.4}} to establish a MQTT bridge connection. If this flag is set to {{true}} (default), the remote MQTT broker will delete all subscription information after a Disconnect. + {{templ|MQTTReconnect}}. + This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|5.0|##.Capabilities.ProtocolVersionsSupported}}. - - - - - - - - - - Connect retry time in {{units}} defines the wait time before a failed bridge connection is retried. - A failure can either be on the connection level (e.g. the TCP/IP or TLS conection can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK message on a MQTT CONNECT message sent. - - - - - - - + + - Keep Alive Time in {{units}} defines the maximum wait time after which a message has to be sent to the remote MQTT broker (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.10}}). If no regular messages can be sent a MQTT PINGREQ is sent. - A value of zero (0) means no keep alive message are sent and the bridge is not disconnected by the server. - A change of this parameter is only effective after the next MQTT CONNECT message to the remote MQTT broker. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. + Keep Alive Time in {{units}} defines the maximum wait time after which a packet has to be sent to the remote MQTT broker (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.10}}) or {{bibref|MQTT50|section 3.1.2.10}}). If no regular packet can be sent a MQTT PINGREQ packet is sent. + A value of zero (0) means no keep alive packets are sent and the bridge is not disconnected by the server. + {{templ|MQTTReconnect}} @@ -49008,6 +51763,68 @@ + + + The MQTT client identifier used in the CONNECT packet (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.1}}) or {{bibref|MQTT50|section 3.1.3.1}}). + If {{param|ProtocolVersion}} is set to {{enum|3.1|##.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|##.Capabilities.ProtocolVersionsSupported}}, this parameter MUST NOT be an empty string. + If {{param|ProtocolVersion}} is set to {{enum|5.0|##.Capabilities.ProtocolVersionsSupported}}, an empty string is allowed. + {{templ|MQTTReconnect}} + + + + + + + + + + User name used to authenticate the MQTT broker when making a connection over the MQTT bridge. The value is sent in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.4}} or {{bibref|MQTT50|section 3.1.3.5}}). + For MQTT 3.1 {{bibref|MQTT31|section 3.1}} recommends that the user name has 12 characters or fewer, but this is not required. + If this parameter is {{empty}} no authentication parameters are sent in the MQTT CONNECT packet. + + + + + + + + + + Password used to authenticate the MQTT broker when making a connection over the MQTT bridge. The value is sent in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.5}} or {{bibref|MQTT50|section 3.1.3.6}}). + This password is only sent in the MQTT CONNECT packet if {{param|Username}} is not {{empty}}. + + + + + + Message retry time in {{units}} defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see {{bibref|MQTT31|section 4.2}}. + This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|3.1|##.Capabilities.ProtocolVersionsSupported}}. + + + + + + + + + + + + Connect retry time in {{units}} defines the wait time before a failed bridge connection is retried. + A failure can either be on the connection level (e.g. the TCP/IP or TLS connection can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK packet on a MQTT CONNECT packet sent. + + + + + + + + + The algorithm used to select a server entry from the {{object|Server}} table @@ -49167,7 +51984,7 @@ Indicates the status of this subscription. {{enum}} The {{enum|Enabled}} value indicates that the this subscription is active. In case of incoming directions ({{param|Direction}} is either {{enum|in|Direction}} or {{enum|both|Direction}}) the topic was successfully subscribed with the remote MQTT broker. The {{enum|Disabled}} value indicates that this subscription is not used. - The {{enum|Error}} value indicates that an error occured (e.g. an subscription could not be made with the remote MQTT broker) and the subscription is not in use. + The {{enum|Error}} value indicates that an error occurred (e.g. an subscription could not be made with the remote MQTT broker) and the subscription is not in use. @@ -49179,7 +51996,7 @@ - Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in {{bibref|MQTT31|Appendix A}} and {{bibref|MQTT311|4.7}}. + Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in {{bibref|MQTT31|section Appendix A}}, {{bibref|MQTT31|section 4.7}} or {{bibref|MQTT50|4.7}}. @@ -49213,7 +52030,7 @@ - The MQTT QoS level assigned with the subscription (see {{bibref|MQTT31|4.1}} and {{bibref|MQTT311|4.3}}). + The MQTT QoS level assigned with the subscription (see {{bibref|MQTT31|section 4.1}}, {{bibref|MQTT31|section 4.3}}) or {{bibref|MQTT50|4.3}}. @@ -49238,7 +52055,9 @@ :: MQTT broker receives message with topic "/local/bus/tr181" from a MQTT client => MQTT broker sends topic "/bus/tr181" to remote MQTT broker - + + + @@ -49263,7 +52082,9 @@ :: MQTT broker receives message with topic "/local/bus/tr181" from a MQTT client => MQTT broker sends topic "/remote/bus/tr181" to remote MQTT broker - + + + @@ -50423,7 +53244,7 @@ This objects represents the measurement controller that is assigned to a measurement agent. - + The timer, in {{units}}, that is started after each successful contact with a measurement controller. When the timer reaches the timeout en event is raised indicating that connectivity to the controller has been lost. @@ -50636,7 +53457,7 @@ This object represents the statistics associated with this object. - + Number of invocations of this schedule. This counter does not include suppressed invocations or invocations that were prevented due to an overlap with a previous invocation of this schedule. @@ -51758,7 +54579,7 @@ This object defines a periodic timer instance. The periodic timer instance has attributes for when the timer is to begin ({{param|StartTime}}) and end ({{param|EndTime}}) as well as the interval to use. - + Date and time, based on {{bibref|RFC3339}}, that the {{object}} instance is to begin operation. @@ -51942,6 +54763,17 @@ + + + + + + + + + + + @@ -53792,7 +56624,7 @@ - + @@ -53889,7 +56721,7 @@ - + @@ -54465,6 +57297,22 @@ + + + + + + + + + + + + + + + + @@ -55323,6 +58171,33 @@ + + + Provides MQTT client control + + + + + + + + + + + + + + + + + + + + + + + + Provides basic MQTT client control and statistics @@ -55333,11 +58208,11 @@ + - @@ -55350,6 +58225,9 @@ Adds client subscription control and access to received topics + + + @@ -56146,7 +59024,37 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -56161,8 +59069,20 @@ - - + + + + + + + + + + + + + + This profile implies support for all of the Gateway requirements defined in {{bibref|TR-069|Annex F}}. @@ -56195,7 +59115,7 @@ - Note that support for this profile implies support for the requirements of {{bibref|TR-069a5|Annex L}}. + Note that support for this profile implies support for the requirements of {{bibref|TR-069|Annex L}}. diff --git a/tools/tr-181-2-12-0-usp-full.xml b/tools/tr-181-2-13-0-usp-full.xml similarity index 91% rename from tools/tr-181-2-12-0-usp-full.xml rename to tools/tr-181-2-13-0-usp-full.xml index 08e0d1bc..189f8369 100644 --- a/tools/tr-181-2-12-0-usp-full.xml +++ b/tools/tr-181-2-13-0-usp-full.xml @@ -1,15 +1,15 @@ - - + xsi:schemaLocation="urn:broadband-forum-org:cwmp:datamodel-1-7 https://www.broadband-forum.org/cwmp/cwmp-datamodel-1-7.xsd urn:broadband-forum-org:cwmp:datamodel-report-0-1 https://www.broadband-forum.org/cwmp/cwmp-datamodel-report.xsd" + spec="urn:broadband-forum-org:tr-181-2-13-0-usp" file="tr-181-2-13-0-usp-full.xml"> {{docname|Device:2 Root Data Model for USP (TR-369)}} - {{appdate|March 2018}} - {{trname|TR-181i2a12}} - * Added USP Local agent support (TR-369) - * Added Firmware Image support - * Added Ethernet Link Aggregation Group - * Added additional Wi-Fi and WAN statistics - * Added support for Two-Way Active Measurement Protocol (TWAMP) reflector - * Added support for Layer Two Tunneling Protocol version 3 (L2TPv3) - * Added support for Virtual eXtensible Local Area Network (VXLAN) tunnels - * Added support for Broadband Access Service Attributes and Performance Metrics measurement test framework (BASAPM) - * Added support for Large-Scale Measurement of Broadband Performance (LMAP) + {{appdate|September 2019}} + {{trname|TR-181i2a13}} + * Added support for WFA Data Elements + * Added support for Multi AP + * Added support for WPA3 and 802.11ax + * Added support for MQTT 5.0 + * Added support for Package capture diagnostics + * Updates for TR-369 MQTT support + * Added support for IoT Data model + + + A non-volatile handle used to reference this instance. + '''This is intended only for use in protocol-independent "common" definitions, and MUST NOT be used in protocol-specific definitions.''' + + + + + + + + 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 {{bibref|TR-069|3.6.1}} and described in {{bibref|TR-069|Appendix II}}, 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 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. + The value MUST NOT change once it's been assigned. + + + + + + The value is measured in ''dBm/1000'', i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm. + + + + + + + Indicates the availability of diagnostics data. Enumeration of: + {{enum}} + If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are {{enum|Requested}} and {{enum|Canceled}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to {{enum|Requested}}. + When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. + When the test is completed, the value of this parameter MUST be either {{enum|Complete}} (if the test completed successfully), or one of the ''Error'' values listed above. + If the value of this parameter is anything other than {{enum|Complete}}, the values of the results parameters for this test are indeterminate. + When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the Inform message. + After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}. + Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}. + While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}. + While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. + While the test is in progress, setting this parameter to {{enum|Canceled}} MUST result in the test being canceled and the value of this parameter being set to {{enum|None}}. If the CPE does not support the {{enum|Canceled}} value, it MUST return a SPV error with "Invalid Parameter value" (9007) to the ACS instead. + + + + + + + + + + + + The IEEE EUI 64-bit identifier as defined in {{bibref|EUI64}}. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of: + * The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the IEEE Registration Authority (IEEE-RA), and + * The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36) assigned by the organization with that company_id assignment. + + + + + + + IP address, i.e. IPv4 address (or IPv4 subnet mask) or IPv6 address. @@ -135,6 +224,8 @@ Can be any IPv4 address that is permitted by the ''IPAddress'' data type. + + @@ -145,7 +236,7 @@ - IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation {{bibref|RFC4632}}. This is specified as an IP address followed by an appended "/n" suffix, where ''n'' (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix. + IPv4 or IPv6 routing prefix in Classless Inter-Domain Routing (CIDR) notation {{bibref|RFC4632}}. This is specified as an IP address followed by an appended "/n" suffix, where ''n'' (the prefix size) is an integer in the range 0-32 (for IPv4) or 0-128 (for IPv6) that indicates the number of (leftmost) '1' bits of the routing prefix. * IPv4 example: 192.168.1.0/24 * IPv6 example: 2001:edff:fe6a:f76::/64 If the IP address part is unspecified or inapplicable, it MUST be {{empty}} unless otherwise specified by the parameter definition. In this case the IP prefix will be of the form "/n". @@ -157,10 +248,13 @@ - IPv4 address prefix. + IPv4 address prefix. Can be any IPv4 prefix that is permitted by the ''IPPrefix'' data type. + + + @@ -169,6 +263,13 @@ + + + A JSON Object as defined in {{bibref|RFC7159|Section 4}}. + + + + All MAC addresses are represented as strings of 12 hexadecimal digits (digits 0-9, letters A-F or a-f) displayed as six pairs of digits separated by colons. Unspecified or inapplicable MAC addresses MUST be represented as empty strings unless otherwise specified by the parameter definition. @@ -200,26 +301,6 @@ - - - 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. - The value MUST NOT change once it's been assigned. - - - - - - - - The value is measured in ''dBm/1000'', i.e. the value divided by 1000 is dB relative to 1 mW. For example, -12345 means -12.345 dBm, 0 means 0 dBm (1 mW) and 12345 means 12.345 dBm. - - - - Universally Unique Identifier. See {{bibref|RFC4122}}. @@ -229,18 +310,27 @@ - + - The IEEE EUI 64-bit identifier as defined in {{bibref|EUI64}}. The IEEE defined 64-bit extended unique identifier (EUI-64) is a concatenation of: - * The 24-bit (OUI-24) or 36-bit (OUI-36) company_id value assigned by the IEEE Registration Authority (IEEE-RA), and - * The extension identifier (40 bits for OUI-24 or 28 bits for OUI-36) assigned by the organization with that company_id assignment. + Uniform Resource Identifier. See {{bibref|RFC3986}}. - - - + + + + Uniform Resource Name. See {{bibref|RFC3986}} (URI) and {{bibref|RFC8141}} (''urn'' URI scheme). + + + + + + + Uniform Resource Locator. See {{bibref|RFC3986}} (URI), {{bibref|IANA-uri-schemes}}, and individual URI scheme RFCs such as {{bibref|RFC7252}} (''coap'', ''coaps'') and {{bibref|RFC7230}} (''http'', ''https''). + + + The ZigBee 16-bit network address (NWK) as defined in {{bibref|ZigBee2007}}. The address is assigned to a device by the network layer and used by the network layer for routing messages between devices. @@ -251,36 +341,377 @@ - + - Indicates the availability of diagnostics data. Enumeration of: - {{enum}} - If the ACS sets the value of this parameter to {{enum|Requested}}, the CPE MUST initiate the corresponding diagnostic test. When writing, the only allowed values are {{enum|Requested}} and {{enum|Canceled}}. To ensure the use of the proper test parameters (the writable parameters in this object), the test parameters MUST be set, and any errors or inconsistencies in the test parameters MUST be detected, either prior to or at the same time as (in the same SetParameterValues) setting this parameter to {{enum|Requested}}. - When requested, the CPE SHOULD wait until after completion of the communication session with the ACS before starting the diagnostic test. - When the test is completed, the value of this parameter MUST be either {{enum|Complete}} (if the test completed successfully), or one of the ''Error'' values listed above. - If the value of this parameter is anything other than {{enum|Complete}}, the values of the results parameters for this test are indeterminate. - When the diagnostic initiated by the ACS is completed (successfully or not), but not if it is canceled for any reason, the CPE MUST establish a new connection to the ACS to allow the ACS to view the results, indicating the Event code ''8 DIAGNOSTICS COMPLETE'' in the Inform message. - After the diagnostic is complete, the value of all result parameters (all read-only parameters in this object) MUST be retained by the CPE until either this diagnostic is run again, or the CPE reboots. After a reboot, if the CPE has not retained the result parameters from the most recent test, it MUST set the value of this parameter to {{enum|None}}. - Modifying any of the writable parameters in this object except for this one MUST result in the value of this parameter being set to {{enum|None}}. - While the test is in progress, modifying any of the writable parameters in this object except for this one MUST result in the test being terminated and the value of this parameter being set to {{enum|None}}. - While the test is in progress, setting this parameter to {{enum|Requested}} (and possibly modifying other writable parameters in this object) MUST result in the test being terminated and then restarted using the current values of the test parameters. - While the test is in progress, setting this parameter to {{enum|Canceled}} MUST result in the test being canceled and the value of this parameter being set to {{enum|None}}. If the CPE does not support the {{enum|Canceled}} value, it MUST return a SPV error with "Invalid Parameter value" (9007) to the ACS instead. + 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. + The value MUST NOT change once it's been assigned. + + + + + + Possible Unit types used for decimal values. {{enum}} - - - - - + + + Dimensionless quantity + + + + + Percent + + + + + Decimal degrees + + + + + Celsius + + + + + Fahrenheit + + + + + Kelvin [SI] + + + + + Kilometer [SI] + + + + + Meter [SI] + + + + + Centimeter [SI] + + + + + Millimeter [SI] + + + + + Hour + + + + + Minute + + + + + Second [SI] + + + + + Millisecond + + + + + Square kilometer + + + + + Square meter + + + + + Square cm + + + + + Cubic meter + + + + + Liter [SI] + + + + + Centiliter [SI] + + + + + Milliliter [SI] + + + + + Kilogram [SI] + + + + + Gram [SI] + + + + + Milligram [SI] + + + + + Watt hour + + + + + Kilowatt hour + + + + + Watt [SI] + + + + + Ampere [SI] + + + + + Hertz [SI] + + + + + Volt [SI] + + + + + Newton [SI] + + + + + Pascal [SI] + + + + + Coulomb [SI] + + + + + Farad [SI] + + + + + Ohm [SI] + + + + + Siemens [SI] + + + + + Weber [SI] + + + + + Tesla [SI] + + + + + Henry [SI] + + + + + Lumen [SI] + + + + + Lux [SI] + + + + + Meter per second + + + + + Candela [SI] + + + + + Mole [SI] + + + + + Ultraviolet index + + + + + RGB color, encoded as integer value between 0 (usually represented as 0x000000) and 16777215 (usually represented as 0xFFFFFF), e.g. Blue would be 255 (usually represented as 0x0000FF) + + + + + Parts per million (Alternative use percent: 1ppm = 0.0001%) + + + + + Sievert (J/kg) [SI] + + + + + Joule [SI] + + - + - A JSON Object as defined in {{bibref|RFC7159|Section 4}}. + Describes the type of Device that the {{object}} instance is representing. {{enum}} + + + + + + + + + + + + + + + + + + + + + Describes the type of IoT Level Controller or Sensor that the {{object}} instance is representing. {{enum}} + + + + + + + + + + + + + + + + + + + + + + + + + Amount of space that an object or substance occupies + + + + + + + + Describes the type of IoT Enum Controller that the {{object}} instance is representing. {{enum}} + + + + + + + + + + + + + + Describes the type of IoT Enum Sensor that the {{object}} instance is representing. {{enum}} + + + + + + + + + + + + + + Pair of 32-bit signed integers a(i),b(i) with each pair representing a complex component of the uncalibrated echo response (UER); + # Real UER component, a(i) + # Imaginary UER component, b(i) + for values of i starting at i=0. Both values are represented as signed integers. + The interpretation of the UER value is as defined in {{bibref|G.996.2|Clause A.2.2.1}}. + + + + + + + + # the Power Spectral Density (PSD) breakpoint sub-carrier index in the range [0:8191] with Df = 4.3125 kHz frequency spacing, and + # the value of the level of the PSD at this sub-carrier expressed in ''0.1 dBm/Hz'' with an offset of -200 dBm/Hz. The range of valid values for PSD is -30 to -200 dBm/Hz. + Both values are represented as unsignedInt. + + + + + # The PSM breakpoint sub-carrier index in the range [0:4095], and @@ -296,142 +727,168 @@ High Speed Packet data Access (HSPA) 3GPP - http://www.3gpp.org/technologies/keywords-acronyms/99-hspa + https://www.3gpp.org/technologies/keywords-acronyms/99-hspa 3GPP TS 25.171 Requirements for support of Assisted Global Positioning System (A-GPS) 3GPP RAN WG4 - http://www.3gpp.org/ftp/Specs/html-info/25171.htm + https://www.3gpp.org/ftp/Specs/html-info/25171.htm IEEE Std 802.11-2007 Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications IEEE 2007 - http://standards.ieee.org/getieee802/download/802.11-2007.pdf + https://standards.ieee.org/getieee802/download/802.11-2007.pdf IEEE Std 802.11-2012 Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications IEEE March 2012 - http://standards.ieee.org/getieee802/download/802.11-2012.pdf + https://standards.ieee.org/getieee802/download/802.11-2012.pdf + + + IEEE Std 802.11-2016 + Wireless LAN Medium Access Control (MAC) and Physical Layer (PHY) Specifications + IEEE + December 2016 + https://ieeexplore.ieee.org/document/7786995 IEEE Std 802.11a-1999 High-speed Physical Layer in the 5 GHz band IEEE 1999 - http://standards.ieee.org/getieee802/download/802.11a-1999.pdf + https://standards.ieee.org/getieee802/download/802.11a-1999.pdf IEEE Std 802.11ac-2013 + Enhancements for Very High Throughput for Operation in Bands below 6 GHz + IEEE + December 2013 + https://www.ieee802.org/11/Reports/tgac_update.htm + + + IEEE Std 802.11ax IEEE - http://www.ieee802.org/11/Reports/tgac_update.htm IEEE Std 802.11b-1999 Higher Speed Physical Layer Extension in the 2.4 GHz band IEEE 1999 - http://standards.ieee.org/getieee802/download/802.11b-1999.pdf + https://standards.ieee.org/getieee802/download/802.11b-1999.pdf IEEE Std 802.11g-2003 Further Higher Data Rate Extension in the 2.4 GHz Band IEEE 2003 - http://standards.ieee.org/getieee802/download/802.11g-2003.pdf + https://standards.ieee.org/getieee802/download/802.11g-2003.pdf IEEE Std 802.11h-2003 Spectrum and Transmit Power Management Extensions IEEE 2003 - http://standards.ieee.org/getieee802/download/802.11h-2003.pdf + https://standards.ieee.org/getieee802/download/802.11h-2003.pdf IEEE Std 802.11n-2009 Amendment 5: Enhancements for Higher Throughput IEEE 2009 - http://ieeexplore.ieee.org/xpl/freeabs_all.jsp?reload=true&arnumber=5307322 + https://ieeexplore.ieee.org/xpl/freeabs_all.jsp?reload=true&arnumber=5307322 IEEE Std 802.1AB-2009 Station and Media Access Control Connectivity Discovery IEEE 2009 - http://standards.ieee.org/getieee802/download/802.1AB-2009.pdf + https://standards.ieee.org/getieee802/download/802.1AB-2009.pdf IEEE Std 802.1ad-2005 Virtual Bridged Local Area Networks Amendment 4: Provider Bridges IEEE May 2005 - http://standards.ieee.org/getieee802/download/802.1ad-2005.pdf + https://standards.ieee.org/getieee802/download/802.1ad-2005.pdf IEEE Std 802.1AX-2014 IEEE Standard for Local and metropolitan area networks -- Link Aggregation IEEE 2014 - http://ieeexplore.ieee.org/servlet/opac?punumber=6997981 + https://ieeexplore.ieee.org/servlet/opac?punumber=6997981 IEEE Std 802.1D-2004 Media Access Control (MAC) Bridges IEEE 2004 - http://standards.ieee.org/getieee802/download/802.1D-2004.pdf + https://standards.ieee.org/getieee802/download/802.1D-2004.pdf IEEE Std 802.1Q-2005 Virtual Bridged Local Area Networks IEEE 2006 - http://standards.ieee.org/getieee802/download/802.1Q-2005.pdf + https://standards.ieee.org/getieee802/download/802.1Q-2005.pdf IEEE Std 802.1Q-2011 MAC Bridges and Virtual Bridge Local Area Networks IEEE 2011 - http://standards.ieee.org/getieee802/download/802.1Q-2011.pdf + https://standards.ieee.org/getieee802/download/802.1Q-2011.pdf IEEE Std 802.1x-2004 Standards for Local and Metropolitan Area Networks: Port based Network Access Control IEEE 2004 - http://standards.ieee.org/getieee802/download/802.1X-2004.pdf + https://standards.ieee.org/getieee802/download/802.1X-2004.pdf IEEE Std 802.3-2015 IEEE Standard for Ethernet IEEE 2015 - http://ieeexplore.ieee.org/servlet/opac?punumber=7428774 + https://ieeexplore.ieee.org/servlet/opac?punumber=7428774 IEEE 802.3-2012 - Section Six IEEE Standard for Ethernet - Section Six IEEE December 2012 - http://standards.ieee.org/getieee802/download/802.3-2012_section6.pdf + https://standards.ieee.org/getieee802/download/802.3-2012_section6.pdf Blue A New Class of Active Queue Management Algorithms - http://www.thefengs.com/wuchang/work/blue + https://www.thefengs.com/wuchang/work/blue + + + BPF + Berkeley Packet Filter Syntax + FreeBSD.org + October 2016 + https://www.freebsd.org/cgi/man.cgi?query=bpf + + + Data Elements Specification + Data Elements Specification Version 1.0 + January 2019 + https://www.wi-fi.org/discover-wi-fi/specifications DLNA Networked Device Interoperability Guidelines DLNA Networked Device Interoperability Guidelines, Volume 2: Media Format Profiles. DLNA October 2006 - http://www.dlna.org/industry/certification/guidelines/ + https://www.dlna.org/industry/certification/guidelines/ RFC 6763 @@ -439,7 +896,7 @@ IETF RFC 2013 - http://tools.ietf.org/html/rfc6763 + https://tools.ietf.org/html/rfc6763 RFC 6333 @@ -447,7 +904,7 @@ IETF RFC 2011 - http://tools.ietf.org/html/rfc6333 + https://tools.ietf.org/html/rfc6333 RFC 6334 @@ -455,205 +912,211 @@ IETF RFC 2011 - http://tools.ietf.org/html/rfc6334 + https://tools.ietf.org/html/rfc6334 ETSI EN 301 893 Broadband Radio Access Networks (BRAN); 5 GHz high performance RLAN; Harmonized EN covering the essential requirements of article 3.2 of the RTTE Directive ETSI - http://www.etsi.org/deliver/etsi_en/301800_301899/301893/01.08.01_60/en_301893v010801p.pdf + https://www.etsi.org/deliver/etsi_en/301800_301899/301893/01.08.01_60/en_301893v010801p.pdf G.988 ONU management and control interface (OMCI) specification ITU-T 2010 - http://www.itu.int/rec/T-REC-G.988-201010-P/en + https://www.itu.int/rec/T-REC-G.988-201010-P/en G.9701 Fast access to subscriber terminals (G.fast)- Physical layer specification ITU-T 2014 - http://www.itu.int/rec/T-REC-G.9701-201412-P + https://www.itu.int/rec/T-REC-G.9701-201412-P G.9954 Phoneline networking transceivers - Enhanced physical, media access, and link layer specifications (HPNA 3.0 and 3.1) ITU-T 2007 - http://www.itu.int/rec/T-REC-G.9954/en + https://www.itu.int/rec/T-REC-G.9954/en G.9960 Unified high-speed wire-line based home networking transceivers - System architecture and physical layer specification ITU-T G.hn series - http://www.itu.int/rec/T-REC-G.9960-201006-P + https://www.itu.int/rec/T-REC-G.9960-201006-P G.9961 Unified high-speed wire-line based home networking transceivers - Data link layer specification ITU-T G.hn series - http://www.itu.int/rec/T-REC-G.9961-201006-P + https://www.itu.int/rec/T-REC-G.9961-201006-P G.9962 Unified high-speed wire-line based home networking transceivers - Management specification ITU-T G.hn series - http://www.itu.int/rec/T-REC-G.9962-201308-P + https://www.itu.int/rec/T-REC-G.9962-201308-P G.9964 Unified high-speed wire-line based home networking transceivers - Power spectral density specification ITU-T G.hn series - http://www.itu.int/rec/T-REC-G.9962-201308-P + https://www.itu.int/rec/T-REC-G.9962-201308-P G.9973 Protocol for identifying home network topology ITU-T 2011 - http://www.itu.int/rec/T-REC-G.9973-201110-I/en + https://www.itu.int/rec/T-REC-G.9973-201110-I/en G.993.1 Very high speed digital subscriber line transceivers ITU-T - http://www.itu.int/rec/T-REC-G.993.1 + https://www.itu.int/rec/T-REC-G.993.1 G.993.2 Very high speed digital subscriber line transceivers 2 (VDSL2) ITU-T - http://www.itu.int/rec/T-REC-G.993.2 + https://www.itu.int/rec/T-REC-G.993.2 + + + G.996.2 + Single-ended line testing for digital subscriber lines (DSL) + ITU-T + https://www.itu.int/rec/T-REC-G.996.2 G.997.1 Physical layer management for digital subscriber line (DSL) transceivers ITU-T - http://www.itu.int/rec/T-REC-G.997.1 + https://www.itu.int/rec/T-REC-G.997.1 G.997.2 Physical layer management for FAST transceivers ITU-T 2015 - http://www.itu.int/rec/T-REC-G.997.2-201505-I + https://www.itu.int/rec/T-REC-G.997.2-201505-I G.998.1 ATM-based Multi-Pair Bonding ITU-T 2005 - http://www.itu.int/rec/T-REC-G.998.1 + https://www.itu.int/rec/T-REC-G.998.1 G.998.2 Ethernet-based Multi-Pair Bonding ITU-T 2005 - http://www.itu.int/rec/T-REC-G.998.2 + https://www.itu.int/rec/T-REC-G.998.2 G.998.3 Multi-Pair Bonding Using Time-Division Inverse Multiplexing ITU-T 2005 - http://www.itu.int/rec/T-REC-G.998.2 + https://www.itu.int/rec/T-REC-G.998.2 HomePlug AV Specification Version 1.1 HomePlug 2007 - http://www.homeplug.org + https://www.homeplug.org HTML 4.01 Specification W3C - http://www.w3.org/TR/html4 + https://www.w3.org/TR/html4 IANA Protocol Numbers Protocol Numbers IANA - http://www.iana.org/assignments/protocol-numbers + https://www.iana.org/assignments/protocol-numbers IANAifType IANAifType-MIB DEFINITIONS IANA 2009 - http://www.iana.org/assignments/ianaiftype-mib/ianaiftype-mib + https://www.iana.org/assignments/ianaiftype-mib/ianaiftype-mib ICSA Baseline Modular Firewall Certification Criteria Baseline module - version 4.1 ICSA Labs 2008 - http://www.icsalabs.com/sites/default/files/baseline.pdf + https://www.icsalabs.com/sites/default/files/baseline.pdf ICSA Residential Modular Firewall Certification Criteria Required Services Security Policy - Residential Category module - version 4.1 ICSA Labs 2008 - http://www.icsalabs.com/sites/default/files/residential.pdf + https://www.icsalabs.com/sites/default/files/residential.pdf IEEE 1905.1a IEEE Std 1905.1a, Convergent Digital Home Network for Heterogeneous Technologies Amendment 1: Support of new MAC/PHYs and enhancements, IEEE, December 2014. IEEE December 2014 - http://www.IEEE.org + https://www.IEEE.org IKEv2 Parameters Internet Key Exchange Version 2 (IKEv2) Parameters - IETF - http://www.iana.org/assignments/ikev2-parameters/ikev2-parameters.xml + IANA + https://www.iana.org/assignments/ikev2-parameters/ikev2-parameters.xml IPDR File Transfer Protocol IPDR/File Transfer Protocol TM Forum - http://www.ipdr.org/public/ + https://www.ipdr.org/public/ IPDR Streaming Protocol IPDR Streaming Protocol (IPDR/SP) Specification TM Forum - http://www.ipdr.org/public/ + https://www.ipdr.org/public/ IPDR XDR Encoding Format IPDR/XDR Encoding Format TM Forum - http://www.ipdr.org/public/ + https://www.ipdr.org/public/ IPDR XML File Encoding Format IPDR/XML File Encoding Format TM Forum - http://www.ipdr.org/public/ + https://www.ipdr.org/public/ ISO 3166-1 Codes for the representation of names of countries and their subdivisions - Part 1: Country codes ISO 2006 - http://www.iso.org/iso/country_codes.htm + https://www.iso.org/iso/country_codes.htm ISO 639-1 Codes for the representation of names of Languages - Part 1: Alpha-2 code ISO 2002 - http://www.iso.org/iso/language_codes + https://www.iso.org/iso/language_codes ISO/IEC 646-1991 @@ -663,38 +1126,45 @@ ITU E.118 - Overall Network Operation, Telephone Service, Service Operation and Human Factors + The international telecommunication charge card International Telecommunication Union May 2006 - http://www.itu.int/rec/T-REC-E.118/en + https://www.itu.int/rec/T-REC-E.118-200605-I/en ITU E.164 The international public telecommunication numbering plan International Telecommunication Union October 2010 - http://www.itu.int/rec/T-REC-E.164-201011-I/en + https://www.itu.int/rec/T-REC-E.164-201011-I/en ITU X.733 Information technology - Open Systems Interconnection - Systems Management: Alarm reporting function International Telecommunication Union February 1992 - http://www.itu.int/rec/T-REC-X.733/en + https://www.itu.int/rec/T-REC-X.733/en JJ-300.00 Home-network Topology Identifying Protocol TTC 2011 - http://www.ttc.or.jp/jp/document_list/pdf/e/STD/JJ-300.00(E)v1.1.pdf + https://www.ttc.or.jp/jp/document_list/pdf/e/STD/JJ-300.00(E)v1.1.pdf JJ-300.01 The List of Device Categories TTC 2011 - http://www.ttc.or.jp/jp/document_list/pdf/e/STD/JJ-300.01(E)v1.1.pdf + https://www.ttc.or.jp/jp/document_list/pdf/e/STD/JJ-300.01(E)v1.1.pdf + + + Libpcap + Libpcap File Format + Wireshark + 2015 + https://wiki.wireshark.org/Development/LibpcapFileFormat RFC 8193 @@ -702,7 +1172,7 @@ IETF Informational RFC August 2017 - http://tools.ietf.org/html/rfc8193 + https://tools.ietf.org/html/rfc8193 draft-ietf-ippm-metric-registry-12 @@ -712,32 +1182,45 @@ June 30, 2017 https://datatracker.ietf.org/doc/draft-ietf-ippm-metric-registry/ + + Multi-AP Specification + Multi-AP Specification Version 1.0 + June 2018 + https://www.wi-fi.org/discover-wi-fi/specifications + MOCA11-MIB Remote Management of MoCA Interfaces using SNMP MIB MoCA Alliance 2009 - http://www.mocalliance.org + https://www.mocalliance.org MoCA v1.0 MoCA MAC/PHY Specification v1.0 MoCA Alliance 2009 - http://www.mocalliance.org + https://www.mocalliance.org MoCA v1.1 MoCA MAC/PHY Specification v1.1 Extensions MoCA Alliance 2009 - http://www.mocalliance.org + https://www.mocalliance.org MQTT v3.1 MQ Telemetry Transport (MQTT) V3.1 Protocol Specification 2010 - http://www.ibm.com/developerworks/webservices/library/ws-mqtt/index.html + https://www.ibm.com/developerworks/webservices/library/ws-mqtt/index.html + + + MQTT Version 5.0 + MQTT Version 5.0, Candidate OASIS Standard 02. + OASIS Message Queuing Telemetry Transport (MQTT) TC + February 2019 + https://docs.oasis-open.org/mqtt/mqtt/v5.0/mqtt-v5.0.html MQTT Version 3.1.1 @@ -748,18 +1231,19 @@ Organizationally Unique Identifiers (OUIs) - http://standards.ieee.org/faqs/OUI.html + https://standards.ieee.org/faqs/OUI.html PCP Proxy Function Port Control Protocol (PCP) Proxy Function IETF - January 2014 - http://tools.ietf.org/html/draft-ietf-pcp-proxy + RFC + September 2015 + https://tools.ietf.org/html/pcpproxyfunction References on RED (Random Early Detection) Queue Management - http://www.icir.org/floyd/red.html + https://www.icir.org/floyd/red.html RFC 793 @@ -767,7 +1251,7 @@ IETF RFC September 1981 - http://tools.ietf.org/html/rfc793 + https://tools.ietf.org/html/rfc793 RFC 862 @@ -775,7 +1259,7 @@ IETF RFC 1983 - http://tools.ietf.org/html/rfc862 + https://tools.ietf.org/html/rfc862 RFC 959 @@ -783,7 +1267,7 @@ IETF RFC 1985 - http://tools.ietf.org/html/rfc959 + https://tools.ietf.org/html/rfc959 RFC 1035 @@ -791,7 +1275,7 @@ IETF RFC 1987 - http://tools.ietf.org/html/rfc1035 + https://tools.ietf.org/html/rfc1035 RFC 1323 @@ -799,7 +1283,7 @@ IETF RFC May 1992 - http://tools.ietf.org/html/rfc1323 + https://tools.ietf.org/html/rfc1323 RFC 1332 @@ -807,7 +1291,7 @@ IETF RFC 1992 - http://tools.ietf.org/html/rfc1332 + https://tools.ietf.org/html/rfc1332 RFC 1378 @@ -815,7 +1299,7 @@ IETF RFC 1992 - http://tools.ietf.org/html/rfc1378 + https://tools.ietf.org/html/rfc1378 RFC 1552 @@ -823,7 +1307,7 @@ IETF RFC 1993 - http://tools.ietf.org/html/rfc1552 + https://tools.ietf.org/html/rfc1552 RFC 1661 @@ -831,7 +1315,7 @@ IETF RFC 1994 - http://tools.ietf.org/html/rfc1661 + https://tools.ietf.org/html/rfc1661 RFC 1877 @@ -839,7 +1323,7 @@ IETF RFC 1995 - http://tools.ietf.org/html/rfc1877 + https://tools.ietf.org/html/rfc1877 RFC 1974 @@ -847,7 +1331,7 @@ IETF RFC 1996 - http://tools.ietf.org/html/rfc1974 + https://tools.ietf.org/html/rfc1974 RFC 2080 @@ -855,7 +1339,7 @@ IETF RFC 1997 - http://tools.ietf.org/html/rfc2080 + https://tools.ietf.org/html/rfc2080 RFC 2097 @@ -863,28 +1347,28 @@ IETF RFC 1997 - http://tools.ietf.org/html/rfc2097 + https://tools.ietf.org/html/rfc2097 RFC 2131 Dynamic Host Configuration Protocol IETF RFC - http://tools.ietf.org/html/rfc2131 + https://tools.ietf.org/html/rfc2131 RFC 2132 DHCP Options and BOOTP Vendor Extensions IETF RFC - http://tools.ietf.org/html/rfc2132 + https://tools.ietf.org/html/rfc2132 RFC 2225 Classical IP and ARP over ATM IETF RFC - http://tools.ietf.org/html/rfc2225 + https://tools.ietf.org/html/rfc2225 RFC 2364 @@ -892,14 +1376,14 @@ IETF RFC 1998 - http://tools.ietf.org/html/rfc2364 + https://tools.ietf.org/html/rfc2364 RFC 2474 Definition of the Differentiated Services Field (DS Field) in the IPv4 and IPv6 Headers IETF RFC - http://tools.ietf.org/html/rfc2474 + https://tools.ietf.org/html/rfc2474 RFC 2581 @@ -907,7 +1391,7 @@ IETF RFC April 1999 - http://tools.ietf.org/html/rfc2581 + https://tools.ietf.org/html/rfc2581 RFC 2582 @@ -915,7 +1399,7 @@ IETF RFC April 1999 - http://tools.ietf.org/html/rfc2582 + https://tools.ietf.org/html/rfc2582 RFC 2616 @@ -923,28 +1407,28 @@ IETF RFC 1999 - http://tools.ietf.org/html/rfc2616 + https://tools.ietf.org/html/rfc2616 RFC 2684 Multiprotocol Encapsulation over ATM Adaptation Layer 5 IETF RFC - http://tools.ietf.org/html/rfc2684 + https://tools.ietf.org/html/rfc2684 RFC 2697 A Single Rate Three Color Marker IETF RFC - http://tools.ietf.org/html/rfc2697 + https://tools.ietf.org/html/rfc2697 RFC 2698 A Two Rate Three Color Marker IETF RFC - http://tools.ietf.org/html/rfc2698 + https://tools.ietf.org/html/rfc2698 RFC 2782 @@ -952,7 +1436,7 @@ IETF RFC 2000 - http://tools.ietf.org/html/rfc2782 + https://tools.ietf.org/html/rfc2782 RFC 2784 @@ -960,7 +1444,7 @@ IETF RFC November 2000 - http://tools.ietf.org/html/rfc2784 + https://tools.ietf.org/html/rfc2784 RFC 2818 @@ -968,7 +1452,7 @@ IETF RFC May 2000 - http://tools.ietf.org/html/rfc2818 + https://tools.ietf.org/html/rfc2818 RFC 2819 @@ -976,7 +1460,7 @@ IETF RFC 2000 - http://tools.ietf.org/html/rfc2819 + https://tools.ietf.org/html/rfc2819 RFC 2863 @@ -984,7 +1468,7 @@ IETF RFC 2000 - http://tools.ietf.org/html/rfc2863 + https://tools.ietf.org/html/rfc2863 RFC 2865 @@ -992,7 +1476,7 @@ IETF RFC 2000 - http://tools.ietf.org/html/rfc2865 + https://tools.ietf.org/html/rfc2865 RFC 2866 @@ -1000,7 +1484,7 @@ IETF RFC 2000 - http://tools.ietf.org/html/rfc2866 + https://tools.ietf.org/html/rfc2866 RFC 2869 @@ -1008,7 +1492,7 @@ IETF RFC 2000 - http://tools.ietf.org/html/rfc2869 + https://tools.ietf.org/html/rfc2869 RFC 2890 @@ -1016,28 +1500,28 @@ IETF RFC November 2000 - http://tools.ietf.org/html/rfc2890 + https://tools.ietf.org/html/rfc2890 RFC 2898 PKCS #5: Password-Based Cryptography Specification Version 2.0 IETF RFC - http://tools.ietf.org/html/rfc2898 + https://tools.ietf.org/html/rfc2898 RFC 3004 The User Class Option for DHCP IETF RFC - http://tools.ietf.org/html/rfc3004 + https://tools.ietf.org/html/rfc3004 RFC 3066 Tags for the Identification of Languages IETF RFC - http://tools.ietf.org/html/rfc3066 + https://tools.ietf.org/html/rfc3066 RFC 3174 @@ -1045,7 +1529,7 @@ IETF Draft Standard September, 2001 - http://tools.ietf.org/html/rfc3174 + https://tools.ietf.org/html/rfc3174 RFC 3232 @@ -1053,7 +1537,7 @@ IETF RFC 2002 - http://tools.ietf.org/html/rfc3232 + https://tools.ietf.org/html/rfc3232 RFC 3315 @@ -1061,7 +1545,7 @@ IETF RFC 2003 - http://tools.ietf.org/html/rfc3315 + https://tools.ietf.org/html/rfc3315 RFC 3339 @@ -1069,7 +1553,7 @@ IETF Draft Standard July, 2002 - http://tools.ietf.org/html/rfc3339 + https://tools.ietf.org/html/rfc3339 RFC 3596 @@ -1077,7 +1561,7 @@ IETF RFC 2003 - http://tools.ietf.org/html/rfc3596 + https://tools.ietf.org/html/rfc3596 RFC 3633 @@ -1085,7 +1569,7 @@ IETF RFC 2003 - http://tools.ietf.org/html/rfc3633 + https://tools.ietf.org/html/rfc3633 RFC 3646 @@ -1093,7 +1577,7 @@ IETF RFC 2003 - http://tools.ietf.org/html/rfc3646 + https://tools.ietf.org/html/rfc3646 RFC 3775 @@ -1101,14 +1585,14 @@ IETF RFC 2004 - http://tools.ietf.org/html/rfc3775 + https://tools.ietf.org/html/rfc3775 RFC 3925 Vendor-Identifying Vendor Options for Dynamic Host Configuration Protocol version 4 (DHCPv4) IETF RFC - http://tools.ietf.org/html/rfc3925 + https://tools.ietf.org/html/rfc3925 RFC 3927 @@ -1116,7 +1600,7 @@ IETF RFC 2005 - http://tools.ietf.org/html/rfc3927 + https://tools.ietf.org/html/rfc3927 RFC 3931 @@ -1124,7 +1608,7 @@ IETF RFC March 2005 - http://tools.ietf.org/html/rfc3931 + https://tools.ietf.org/html/rfc3931 RFC 3948 @@ -1132,14 +1616,14 @@ IETF RFC January 2005 - http://tools.ietf.org/html/rfc3948 + https://tools.ietf.org/html/rfc3948 RFC 3986 Uniform Resource Identifier (URI): Generic Syntax IETF RFC - http://tools.ietf.org/html/rfc3986 + https://tools.ietf.org/html/rfc3986 RFC 4122 @@ -1147,7 +1631,7 @@ IETF RFC 2005 - http://tools.ietf.org/html/rfc4122 + https://tools.ietf.org/html/rfc4122 RFC4180 @@ -1155,7 +1639,7 @@ IETF RFC October 2005 - http://tools.ietf.org/html/rfc4180 + https://tools.ietf.org/html/rfc4180 RFC 4191 @@ -1163,7 +1647,7 @@ IETF RFC 2005 - http://tools.ietf.org/html/rfc4191 + https://tools.ietf.org/html/rfc4191 RFC 4193 @@ -1171,7 +1655,7 @@ IETF RFC 2005 - http://tools.ietf.org/html/rfc4193 + https://tools.ietf.org/html/rfc4193 RFC 4242 @@ -1179,7 +1663,7 @@ IETF RFC 2005 - http://tools.ietf.org/html/rfc4242 + https://tools.ietf.org/html/rfc4242 RFC 4291 @@ -1187,7 +1671,7 @@ IETF RFC 2006 - http://tools.ietf.org/html/rfc4291 + https://tools.ietf.org/html/rfc4291 RFC 4292 @@ -1195,7 +1679,7 @@ IETF RFC 2006 - http://tools.ietf.org/html/rfc4292 + https://tools.ietf.org/html/rfc4292 RFC 4293 @@ -1203,7 +1687,7 @@ IETF RFC 2006 - http://tools.ietf.org/html/rfc4293 + https://tools.ietf.org/html/rfc4293 RFC 4301 @@ -1211,7 +1695,7 @@ IETF RFC December 2005 - http://tools.ietf.org/html/rfc4301 + https://tools.ietf.org/html/rfc4301 RFC 4302 @@ -1219,7 +1703,7 @@ IETF RFC December 2005 - http://tools.ietf.org/html/rfc4302 + https://tools.ietf.org/html/rfc4302 RFC 4303 @@ -1227,7 +1711,7 @@ IETF RFC December 2005 - http://tools.ietf.org/html/rfc4303 + https://tools.ietf.org/html/rfc4303 RFC 4389 @@ -1235,7 +1719,7 @@ IETF RFC 2006 - http://tools.ietf.org/html/rfc4389 + https://tools.ietf.org/html/rfc4389 RFC 4632 @@ -1243,7 +1727,7 @@ IETF RFC 2006 - http://tools.ietf.org/html/rfc4632 + https://tools.ietf.org/html/rfc4632 RFC 4719 @@ -1251,7 +1735,7 @@ IETF RFC November 2006 - http://tools.ietf.org/html/rfc4719 + https://tools.ietf.org/html/rfc4719 RFC 4835 @@ -1259,7 +1743,7 @@ IETF RFC 2007 - http://tools.ietf.org/html/rfc4835 + https://tools.ietf.org/html/rfc4835 RFC 4861 @@ -1267,7 +1751,7 @@ IETF RFC 2007 - http://tools.ietf.org/html/rfc4861 + https://tools.ietf.org/html/rfc4861 RFC 4862 @@ -1275,7 +1759,7 @@ IETF RFC 2007 - http://tools.ietf.org/html/rfc4862 + https://tools.ietf.org/html/rfc4862 RFC 5072 @@ -1283,7 +1767,7 @@ IETF RFC 2007 - http://tools.ietf.org/html/rfc5072 + https://tools.ietf.org/html/rfc5072 RFC 5139 @@ -1291,7 +1775,7 @@ IETF RFC February 2008 - http://tools.ietf.org/html/rfc5139 + https://tools.ietf.org/html/rfc5139 RFC 5280 @@ -1299,7 +1783,7 @@ IETF RFC May 2008 - http://tools.ietf.org/html/rfc5280 + https://tools.ietf.org/html/rfc5280 RFC 5491 @@ -1307,7 +1791,7 @@ IETF RFC March 2009 - http://tools.ietf.org/html/rfc5491 + https://tools.ietf.org/html/rfc5491 RFC 5625 @@ -1315,7 +1799,7 @@ IETF RFC 2009 - http://tools.ietf.org/html/rfc5625 + https://tools.ietf.org/html/rfc5625 RFC 5969 @@ -1323,7 +1807,7 @@ IETF RFC 2010 - http://tools.ietf.org/html/rfc5969 + https://tools.ietf.org/html/rfc5969 RFC 5996 @@ -1331,7 +1815,7 @@ IETF RFC September 2010 - http://tools.ietf.org/html/rfc5996 + https://tools.ietf.org/html/rfc5996 RFC 6106 @@ -1339,7 +1823,7 @@ IETF RFC 2010 - http://tools.ietf.org/html/rfc6106 + https://tools.ietf.org/html/rfc6106 RFC 6120 @@ -1347,7 +1831,7 @@ IETF RFC 2011 - http://tools.ietf.org/html/rfc6120 + https://tools.ietf.org/html/rfc6120 RFC 6234 @@ -1355,7 +1839,7 @@ IETF Draft Standard May, 2011 - http://tools.ietf.org/html/rfc6234 + https://tools.ietf.org/html/rfc6234 RFC 6455 @@ -1363,7 +1847,7 @@ IETF RFC December 2011 - http://tools.ietf.org/html/rfc6455 + https://tools.ietf.org/html/rfc6455 RFC 6762 @@ -1371,7 +1855,7 @@ IETF RFC February 2013 - http://tools.ietf.org/html/rfc6762 + https://tools.ietf.org/html/rfc6762 RFC 6838 @@ -1379,7 +1863,7 @@ IETF Best Current Practice January 2013 - http://tools.ietf.org/html/rfc6838 + https://tools.ietf.org/html/rfc6838 RFC 6887 @@ -1387,7 +1871,7 @@ IETF RFC 2013 - http://tools.ietf.org/html/rfc6887 + https://tools.ietf.org/html/rfc6887 RFC 6970 @@ -1395,7 +1879,7 @@ IETF RFC 2013 - http://tools.ietf.org/html/rfc6970 + https://tools.ietf.org/html/rfc6970 RFC7159 @@ -1403,7 +1887,7 @@ IETF RFC March 2014 - http://tools.ietf.org/html/rfc7159 + https://tools.ietf.org/html/rfc7159 RFC 7252 @@ -1411,7 +1895,7 @@ IETF RFC June 2014 - http://tools.ietf.org/html/rfc7252 + https://tools.ietf.org/html/rfc7252 RFC 7291 @@ -1419,7 +1903,7 @@ IETF RFC 2014 - http://tools.ietf.org/html/rfc7291 + https://tools.ietf.org/html/rfc7291 RFC 7348 @@ -1427,7 +1911,7 @@ IETF RFC August 2014 - http://tools.ietf.org/html/rfc7348 + https://tools.ietf.org/html/rfc7348 RFC 7395 @@ -1435,7 +1919,7 @@ IETF Standards Track October 2014 - http://tools.ietf.org/html/rfc7395 + https://tools.ietf.org/html/rfc7395 RFC 7398 @@ -1443,7 +1927,15 @@ IETF Informational RFC February 2015 - http://tools.ietf.org/html/rfc7398 + https://tools.ietf.org/html/rfc7398 + + + RFC 7468 + Textual Encoding of PKIX, PKCS, and CMS Structures + IETF + Standards Track + April 2015 + http://tools.ietf.org/html/rfc7468 RFC 7594 @@ -1451,7 +1943,7 @@ IETF Informational RFC September 2015 - http://tools.ietf.org/html/rfc7594 + https://tools.ietf.org/html/rfc7594 RFC 7597 @@ -1459,7 +1951,7 @@ IETF RFC July 2015 - http://tools.ietf.org/html/rfc7597 + https://tools.ietf.org/html/rfc7597 RFC 7598 @@ -1467,7 +1959,7 @@ IETF RFC July 2015 - http://tools.ietf.org/html/rfc7598 + https://tools.ietf.org/html/rfc7598 RFC 7599 @@ -1475,12 +1967,12 @@ IETF RFC July 2015 - http://tools.ietf.org/html/rfc7599 + https://tools.ietf.org/html/rfc7599 Simple Object Access Protocol (SOAP) 1.1 W3C - http://www.w3.org/TR/2000/NOTE-SOAP-20000508 + https://www.w3.org/TR/2000/NOTE-SOAP-20000508 STOMP Protocol Specification @@ -1488,148 +1980,68 @@ https://stomp.github.io/stomp-specification-1.2.html - TR-064 + TR-064 Corrigendum 1 LAN-Side DSL CPE Configuration Specification Broadband Forum Technical Report - 2004 - http://www.broadband-forum.org/technical/download/TR-064.pdf + August 2015 + https://www.broadband-forum.org/technical/download/TR-064.pdf - TR-069 + TR-069 Amendment 6 CPE WAN Management Protocol Broadband Forum Technical Report - 2004 - http://www.broadband-forum.org/technical/download/TR-069.pdf - - - TR-069 Amendment 2 - CPE WAN Management Protocol - Broadband Forum - Technical Report - 2007 - http://www.broadband-forum.org/technical/download/TR-069_Amendment-2.pdf - - - TR-069 Amendment 3 - CPE WAN Management Protocol - Broadband Forum - Technical Report - 2010 - http://www.broadband-forum.org/technical/download/TR-069_Amendment-3.pdf - - - TR-069 Amendment 4 - CPE WAN Management Protocol - Broadband Forum - Technical Report - 2011 - http://www.broadband-forum.org/technical/download/TR-069_Amendment-4.pdf - - - TR-069 Amendment 5 - CPE WAN Management Protocol - Broadband Forum - Technical Report - December 2013 - http://www.broadband-forum.org/technical/download/TR-069_Amendment-5.pdf - - - TR-098 - Internet Gateway Device Data Model for TR-069 - Broadband Forum - Technical Report - 2005 - http://www.broadband-forum.org/technical/download/TR-098.pdf + April 2018 + https://www.broadband-forum.org/technical/download/TR-069.pdf - TR-106 - Data Model Template for TR-069-Enabled Devices + TR-106 Amendment 8 + Data Model Template for CWMP Endpoints and USP Agents Broadband Forum Technical Report - 2005 - http://www.broadband-forum.org/technical/download/TR-106.pdf + May 2018 + https://www.broadband-forum.org/technical/download/TR-106.pdf - - TR-106 Amendment 2 + + TR-106 Amendment 6 Data Model Template for TR-069-Enabled Devices Broadband Forum Technical Report - 2008 - http://www.broadband-forum.org/technical/download/TR-106_Amendment-2.pdf + July 2011 + https://www.broadband-forum.org/technical/download/TR-106_Amendment-6.pdf - - TR-106 Amendment 4 - Data Model Template for TR-069-Enabled Devices + + TR-106 Amendment 8 + Data Model Template for CWMP Endpoints and USP Agents Broadband Forum Technical Report - 2010 - http://www.broadband-forum.org/technical/download/TR-106_Amendment-4.pdf - - - TR-106 Amendment 7 - Data Model Template for TR-069-Enabled Devices - Broadband Forum - Technical Report - 2013 - http://www.broadband-forum.org/technical/download/TR-106_Amendment-7.pdf + May 2018 + https://www.broadband-forum.org/technical/download/TR-106_Amendment-8.pdf - TR-143 + TR-143 Amendment 3 Enabling Network Throughput Performance Tests and Statistical Monitoring Broadband Forum Technical Report - 2008 - http://www.broadband-forum.org/technical/download/TR-143.pdf - - - TR-143 Amendment 1 - Enabling Network Throughput Performance Tests and Statistical Monitoring - Broadband Forum - Technical Report - December 2014 - http://www.broadband-forum.org/technical/download/TR-143_Amendment-1.pdf - - - TR-157 - Component Object for CWMP - Broadband Forum - Technical Report - March 2009 - http://www.broadband-forum.org/technical/download/TR-157.pdf - - - TR-157 Amendment 10 - Component Objects for CWMP - Broadband Forum - Technical Report - 2015 - http://www.broadband-forum.org/technical/download/TR-157_Amendment-10.pdf + May 2017 + https://www.broadband-forum.org/technical/download/TR-143.pdf TR-159 Management Framework for xDSL Bonding Broadband Forum Technical Report - 2008 - http://www.broadband-forum.org/technical/download/TR-159.pdf - - - TR-181 Issue 1 - Device Data Model for TR-069 - Broadband Forum - Technical Report - 2010 - http://www.broadband-forum.org/technical/download/TR-181_Issue-1.pdf + December 2008 + https://www.broadband-forum.org/technical/download/TR-159.pdf - TR-181 Issue 2 - Device Data Model for TR-069 + TR-181 Issue 2 Amendment 13 + Device Data Model Broadband Forum Technical Report - 2010 - http://www.broadband-forum.org/technical/download/TR-181_Issue-2.pdf + September 2019 + https://www.broadband-forum.org/technical/download/TR-181_Issue-2.pdf TR-232 @@ -1637,90 +2049,63 @@ Broadband Forum Technical Report May 2012 - http://www.broadband-forum.org/technical/download/TR-232.pdf + https://www.broadband-forum.org/technical/download/TR-232.pdf TR-262 Femto Component Objects Broadband Forum Technical Report - 2011 - http://www.broadband-forum.org/technical/download/TR-262.pdf + November 2011 + https://www.broadband-forum.org/technical/download/TR-262.pdf TR-304 Broadband Access Service Attributes and Performance Metrics Broadband Forum Technical Report - March 2015 - http://www.broadband-forum.org/technical/download/TR-304.pdf + February 2015 + https://www.broadband-forum.org/technical/download/TR-304.pdf - WT-369 + TR-369 Issue 1 Corrigendum 2 User Services Platform Broadband Forum Technical Report - December 2016 - http://www.broadband-forum.org/technical/download/TR-369.pdf + November 2018 + https://usp.technology/specification - WT-390 + TR-390 Performance Measurement from Customer Equipment to IP Edge Broadband Forum Technical Report - November 2016 - http://www.broadband-forum.org/technical/download/TR-390.pdf - - - TR-181 Issue 2 Amendment 12 - Device Data Model - Broadband Forum - Technical Report - April 2018 - http://www.broadband-forum.org/technical/download/TR-181_Issue-2_Amendment-12.pdf - - - TR-181 Issue 2 Amendment 2 - Device Data Model for TR-069 - Broadband Forum - Technical Report - 2011 - http://www.broadband-forum.org/technical/download/TR-181_Issue-2_Amendment-2.pdf - - - TR-181 Issue 2 Amendment 5 - Device Data Model for TR-069 - Broadband Forum - Technical Report - 2012 - http://www.broadband-forum.org/technical/download/TR-181_Issue-2_Amendment-5.pdf - - - TR-181 Issue 2 Amendment 8 - Device Data Model for TR-069 - Broadband Forum - Technical Report - September 2014 - http://www.broadband-forum.org/technical/download/TR-181_Issue-2_Amendment-8.pdf + May 2017 + https://www.broadband-forum.org/technical/download/TR-390.pdf Universal Powerline Association UPA - http://www.upaplc.org + https://www.upaplc.org UPnP Device Architecture UPnP Device Architecture 1.0 UPnP Forum April 2008 - http://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0-20080424.pdf + https://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.0-20080424.pdf UPnP Device Architecture 1.1 UPnP Device Architecture 1.1 UPnP Forum October, 2008 - http://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf + https://www.upnp.org/specs/arch/UPnP-arch-DeviceArchitecture-v1.1.pdf + + + UPnP Device Management:1 + UPnP Device Management v1 + https://upnp.org/specs/dm/dm1/ UPnP InternetGatewayDevice:1 @@ -1728,7 +2113,7 @@ UPnP SDCP 2001 - http://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v1-Device.pdf + https://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v1-Device.pdf UPnP InternetGatewayDevice:2 @@ -1736,50 +2121,88 @@ UPnP SDCP 2010 - http://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v2-Device.pdf + https://upnp.org/specs/gw/UPnP-gw-InternetGatewayDevice-v2-Device.pdf USB 1.0 USB 1.0 Specification USB-IF January 1996 - http://www.usb.org/developers/docs/ + https://www.usb.org/developers/docs/ USB 2.0 USB 2.0 Specification USB-IF April 2000 - http://www.usb.org/developers/docs/usb_20_122208.zip + https://www.usb.org/developers/docs/usb_20_122208.zip USB 3.0 USB 3.0 Specification USB-IF November 2008 - http://www.usb.org/developers/docs/usb_30_spec.zip + https://www.usb.org/developers/docs/usb_30_spec.zip WSC 2.0 Wi-Fi Simple Configuration Technical Specification Version 2.0.x Wi-Fi Alliance - http://www.wi-fi.org/discover-wi-fi/wi-fi-protected-setup + https://www.wi-fi.org/discover-wi-fi/wi-fi-protected-setup Wi-Fi Protected Setup Specification Version 1.0h Wi-Fi Alliance 2006 - http://www.wi-fi.org + https://www.wi-fi.org + + + Z-Wave + Z-Wave website + https://www.z-wave.com + + + ZigBee + ZigBee Alliance website + https://www.zigbee.org ZigBee 2007 Specification ZigBee 2007 Specification ZigBee Alliance October 2007 - http://www.zigbee.org/Specifications/ZigBee/download.aspx + https://www.zigbee.org/Specifications/ZigBee/download.aspx - + + + + + + + + + + The top-level object for a Device. @@ -1834,10 +2257,26 @@ - - - - + + + A {{object}} Event that was the result of a reboot triggered locally on the Device (NOT as a result of a {{command|#.Reboot()}} Command) + + + + + A {{object}} Event that was the result of a reboot triggered via the {{command|#.Reboot()}} Command + + + + + A {{object}} Event that was the result of a factory reset triggered locally on the Device (NOT as a result of a {{command|#.FactoryReset()}} Command) + + + + + A {{object}} Event that was the result of a factory reset triggered via the {{command|#.FactoryReset()}} Command + + @@ -1859,7 +2298,7 @@ - + Factory reset the entity associated with the containing {{object}}. @@ -1868,10 +2307,23 @@ This diagnostics test is vendor-specific and MAY include testing hardware, software, and/or firmware. - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + Results of self-test (vendor specific). @@ -1884,6 +2336,188 @@ + + + This diagnostic command is used to record packet capture data on a valid (layer 2 or above) interface in libpcap or pcapng format. + + + + Input arguments. + + + + A reference to a (layer 2 or above) interface object that will be the target of this packet capture diagnostic. + + + + + + + + + + + This indicates whether the network trace will be recorded in libpcap {{bibref|LIBPCAP}} or pcapng format, and is dependent on the underlying method of performing a network trace. + + + + + + The packet data is recorded in libpcap {{bibref|LIBPCAP}} format. + + + + + The packet data is recorded in pcapng format. + + + + + + + + The duration in {{units}} to copy packets to the file target. The diagnostic completes when either the {{param}}, {{param|PacketCount}}, or {{param|ByteCount}} conditions are met. + + + + + + + + + + + The maximum number of packets to record to the file target. A value of zero (0) indicates no limit. The diagnostic completes when the {{param|Duration}}, {{param|ByteCount}}, or {{param}} conditions are met. + + + + + + + + The maximum number of bytes to record to the file target. A value of zero (0) indicates no limit. The diagnostic completes when {{param|Duration}}, {{param|PacketCount}} or {{param}} conditions are met. + + + + + + + + URL, as defined in {{bibref|RFC3986}}, specifying the destination file location. HTTP and HTTPS transports MUST be supported. Other transports MAY be supported. + + + + + + + + + + A ({{bibref|BPF}}) formatted expression used to restrict the types of network packets that are recorded to {{param|FileTarget}}. + + + + + + + + + + Username to be used by the Agent to authenticate with the file location. This string is set to {{empty}} if no authentication is required. + + + + + + + + + + Password to be used by the Agent to authenticate with the file location. This string is set to {{empty}} if no authentication is required. When read, this parameter returns an empty string, regardless of the actual value. + + + + + + + Output arguments. + + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + + + + + Results for individual packet capture diagnostics. Packet capture files whose FileLocation is local to the system SHOULD be deleted when the next diagnostic is run, or upon a system reboot. + + + + URL, as defined in {{bibref|RFC3986}}, specifying the resulting file location of the packet capture record that triggered this result. This MAY be different than the location specified in FileTarget. + + + + + + + + + + The local system time at which the capture was started. + + + + + + + + The local system time at which the capture was completed. + + + + + + + + The number of packets recorded to the file target. + + + + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + @@ -2084,7 +2718,7 @@ - Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters. + Identifier of the primary service provider and other provisioning information, which MAY be used by the ACS to determine service provider-specific customization and provisioning parameters. @@ -2162,8 +2796,8 @@ - Every instance of this object is a Vendor Configuration File, and contains parameters associated with the Vendor Configuration File. - This table of Vendor Configuration Files is for information only and does not allow the ACS to operate on these files in any way. + Every instance of this object is a Vendor Configuration File, and contains parameters associated with the Vendor Configuration File. + This table of Vendor Configuration Files is for information only and does not allow the Controller to operate on these files in any way. Whenever the CPE successfully downloads a configuration file as a result of the Download RPC with the FileType argument of ''3 Vendor Configuration File'', the CPE MUST update this table. @@ -2237,7 +2871,7 @@ This command is issued to upload the configuration file specified by this {{object}} instance. All results of the actual upload will be contained within the {{event|Device.LocalAgent.TransferComplete!}} event. - + Input arguments. @@ -2281,7 +2915,7 @@ This command is issued to download a configuration file into this {{object}} instance. All results of the actual download will be contained within the {{event|Device.LocalAgent.TransferComplete!}} event. - + Input arguments. @@ -2434,7 +3068,6 @@ {{numentries}} - Since a Process can come and go very quickly, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of value changes, as described in {{bibref|TR-069a2|Section 3.2.1}}. @@ -2582,7 +3215,7 @@ * {{param|Status}} transition from {{enum|Disabled|Status}} to {{enum|Enabled|Status}} * {{param|Reset}} set to {{true}}. * An internal reset of the temperature sensor (including a reboot of the device). - The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates that this temperature sensor has never been reset, which can only happen if it has never been enabled. + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates that this temperature sensor has never been reset, which can only happen if it has never been enabled. @@ -2613,7 +3246,7 @@ The time at which this temperature sensor's last good reading was obtained. - The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates a good reading has not been obtained since last reset. + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates a good reading has not been obtained since last reset. @@ -2634,7 +3267,7 @@ The time at which this temperature sensor's lowest value was read. - The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates a good reading has not been obtained since last reset. + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates a good reading has not been obtained since last reset. @@ -2655,7 +3288,7 @@ The time at which this temperature sensor's highest value was read. - The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates a good reading has not been obtained since last reset. + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates a good reading has not been obtained since last reset. @@ -2678,7 +3311,7 @@ Initial time at which this temperature sensor's {{param|LowAlarmValue}} was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. - The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates that an alarm has not been encountered since the last reset. + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates that an alarm has not been encountered since the last reset. @@ -2713,7 +3346,7 @@ Initial time at which this temperature sensor's {{param|HighAlarmValue}} was encountered. This value is only set the first time the alarm is seen and not changed until the next reset. - The Unknown Time value, as defined in {{bibref|TR-106a2}}, indicates that an alarm has not been encountered since the last reset. + The Unknown Time value, as defined in {{bibref|TR-106}}, indicates that an alarm has not been encountered since the last reset. @@ -2789,7 +3422,7 @@ The architecture of the processor on the underlying hardware. {{enum}} - For processor architectures not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref|TR-106a4|Section 3.3}}. + For processor architectures not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref|TR-106|Section 3.3}}. @@ -2826,12 +3459,12 @@ Each table entry represents a Vendor Log File. - This table of log files is informational only and does not allow the ACS to operate on these files in any way. + This table of log files is informational only and does not allow the Controller to operate on these files in any way. - + @@ -2877,7 +3510,7 @@ This command is issued to upload the log file specified by this Vendor Log File instance. All results of the actual upload will be contained within the {{event|Device.LocalAgent.TransferComplete!}} event. - + Input arguments. @@ -2951,7 +3584,7 @@ URL, MAC address, or other identifier that identifies an "External" source of this location. Meaningful only if {{param|Source}} has a value of {{enum|External|Source}}, otherwise it MUST be {{empty}}. - If {{param|ExternalProtocol}} has a value of {{enum|CWMP|ExternalProtocol}}, this is the URL or IP address of the ACS. + If {{param|ExternalProtocol}} has a value of {{enum|CWMP|ExternalProtocol}}, this is the URL or IP address of the Controller. @@ -2970,6 +3603,7 @@ + @@ -2986,13 +3620,13 @@ The currently valid location information. - Writable only when {{param|ExternalProtocol}} has a value of {{enum|CWMP|ExternalProtocol}}. + Writable only when {{param|ExternalProtocol}} has a value of {{enum|CWMP|ExternalProtocol}} or {{enum|USP|ExternalProtocol}}. If obtained through the local GPS/AGPS then the location information is formatted according to {{bibref|RFC5491}}. If manually configured then location information will be XML-formatted according to {{bibref|RFC5491}} (geographical information) and {{bibref|RFC5139}} (civic addresses). If obtained by an external source this is the location information as received. If it's an XML document (e.g. CWMP, OMA-DM, UPnP, HELD, MLP) the location information will be represented as-is, otherwise it will be converted to base64. - CWMP configured location information will be XML-formatted according to {{bibref|RFC5491}} (geographical information) and {{bibref|RFC5139}} (civic addresses). - Only zero or one Location object instance with value {{enum|CWMP|ExternalProtocol}} MUST exist at any given time. + CWMP or USP configured location information will be XML-formatted according to {{bibref|RFC5491}} (geographical information) and {{bibref|RFC5139}} (civic addresses). + Only zero or one Location object instance with value {{enum|CWMP|ExternalProtocol}} or {{enum|USP|ExternalProtocol}} MUST exist at any given time. @@ -3158,7 +3792,7 @@ This command is issued to download a firmware into this Firmware Image instance. All results of the actual download will be contained within the {{event|Device.LocalAgent.TransferComplete!}} event. - + Input arguments. @@ -3269,7 +3903,7 @@ A successful activation will result in a reboot of the device with this {{object}} as the currently running firmware image. Furthermore, this {{object}} will be referenced by the {{param|Device.DeviceInfo.ActiveFirmwareImage}} parameter. A failed activation will result in this {{object}} instance's {{param|BootFailureLog}} being updated. - + Input arguments. @@ -6035,7 +6669,7 @@ DSL bonding group table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). Each instance is a bonding group, and is expected to be stacked above a {{object|.DSL.Channel}} instance or a {{object|.FAST.Line}} instance for each bonded channel in the group. - Many of the parameters within this object, including {{param|LowerLayers}}, are read-only because bonding is not expected to be configured via {{bibref|TR-069}}. + Many of the parameters within this object, including {{param|LowerLayers}}, are read-only because bonding is not expected to be configured by a Controller. The DSL bonding data model is closely aligned with {{bibref|TR-159}}. Corresponds to {{bibref|TR-159}} ''oBondingGroup''. @@ -6106,7 +6740,7 @@ {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. - {{param}} is read-only for this object because bonding is expected to be configured by the CPE, not by the ACS. + {{param}} is read-only for this object because bonding is expected to be configured by the CPE, not by the Controller. @@ -6305,7 +6939,7 @@ {{reference}}This is the channel that is being bonded. - This is read-only because bonding is expected to be configured by the CPE, not by the ACS. + This is read-only because bonding is expected to be configured by the CPE, not by the Controller. @@ -7098,7 +7732,7 @@ This command is to provide diagnostic information for a CPE with an ADSL2 or ADSL2+ modem WAN interface, but MAY also be used for ADSL. - + Input arguments. @@ -7114,10 +7748,25 @@ - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + + Downstream actual power spectral density. Interpretation of the value is as defined in ITU-T Rec. G.997.1. @@ -7474,6 +8123,363 @@ + + + This command performs a DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Uncalibrated Echo Response (UER). + This command is for the CPE, aka the Transmission Unit - Remote end (TU-R). + Reference: ITU-T Recommendation {{bibref|G.996.2|Clause A.2, SELT-PMD management entity}}. + + + + Input arguments. + + + + {{reference}} This is the interface over which the test is to be performed. + + + + + + + + + + + This parameter is the SELT UER maximum measurement duration (MMD) measured in {{units}}. + This parameter is defined as SELT_UER_MMD_R in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.1.1}}. + + + + + + + + + + + + Output arguments. + + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + + + This parameter indicates if the option for extended bandwidth SELT is applied ({{true}}) or not applied ({{false}}). + If the option for extended bandwidth SELT is applied to UER, then {{param|UERGroupSize}} has three valid values: 1, 2 and 12. + If the option for extended bandwidth SELT is not applied to UER, then {{param|UERGroupSize}} has two valid values: 1 and 2. + {{param|UERGroupSize}} is reported if the option for extended bandwidth UER SELT is supported; otherwise, reporting of the group size is optional. + + + + + + + + The Uncalibrated Echo Response (UER) [a(0),b(0)], [a(1),b(1)], ... + {{list|with each list item consisting of:}} + {{datatype|expand}} + The value of UER at frequency i*{{param|UERGroupSize}}*Df = ({{param|UERScaleFactor}}/(2^31))*(a(i)+j*b(i))/(2^31) where Df = 4.3125 kHz. + This parameter is defined as CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.2.1}}. + + + + + + + + + The Uncalibrated Echo Response (UER) scale factor. + This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.2.1}}. + + + + + + + + The Uncalibrated Echo Response (UER) group size, UER_G. In units of {{units}}. + This parameter is defined as part of the CPE SELT uncalibrated echo response (SELT-UER-R) in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.2.1}}. + + + + + + + + + + + + This parameter represents the variance of the {{param|UER}}. List items represent v(i), for values of i starting at i=0. The variance of the uncalibrated echo response for frequency i*{{param|UERGroupSize}}*Df is VAR(i*{{param|UERGroupSize}}*Df) = 3 - v(i)/2 dB where Df = 4.3125 kHz. + This parameter is defined as SELT variance of uncalibrated echo response R (SELT UER-VAR-R) in {{bibref|G.996.2|Clause A.2.2.2}}. + + + + + + + + + + + This command performs a DSL Single Ended Line Test - Physical Medium Dependent (SELT-PMD) Quiet Line Noise (QLN). + This command is for the CPE, aka the Transmission Unit - Remote end (TU-R). + Reference: ITU-T Recommendation {{bibref|G.996.2|Clause A.2, SELT-PMD management entity}}. + + + + Input arguments. + + + + {{reference}} This is the interface over which the test is to be performed. + + + + + + + + + + + This parameter is the SELT QLN maximum measurement duration (MMD) measured in {{units}}. + This parameter is defined as SELT_QLN_MMD_R in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.1.2}}. + + + + + + + + + + + + Output arguments. + + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + + + This parameter indicates if the option for extended bandwidth SELT is applied ({{true}}) or not applied ({{false}}). + If the option for extended bandwidth SELT is applied to QLN, then {{param|QLNGroupSize}} has three valid values: 1, 2 and 12. + If the option for extended bandwidth SELT is not applied to QLN, then {{param|QLNGroupSize}} has two valid values: 1 and 2. + {{param|QLNGroupSize}} is reported if the option for extended bandwidth QLN SELT is supported; otherwise, reporting of the group size is optional. + + + + + + + + {{list}} List items represent SELT quiet line noise (QLN) per subcarrier group. + Each list element is n(i), with i starting at 0. The value of QLN at frequency i*{{param|QLNGroupSize}}*Df with Df=4.3125 kHz is defined as QLN(i*{{param|QLNGroupSize}}*Df) = -23 - (n(i)/2) dBm/Hz. This data format supports a QLN granularity of 0.5 dB and an dynamic range of -150 to -23 dBm/Hz. + Interpretation of the SELT_QLN_R value is defined in {{bibref|G.996.2|Clause A.2.2.3}}. + + + + + + + + + + + This parameter represents the Quiet Line Noise (QLN) group size. In units of {{units}}. + This parameter is defined as part of the SELT_QLN_R in ITU-T Recommendation {{bibref|G.996.2|Clause A.2.2.3}}. + + + + + + + + + + + + + + This command performs a DSL Single-Ended Line Test - Processed (SELT-P). + This command is for the CPE, aka the Transmission Unit - Remote end (TU-R). + Reference: ITU-T Recommendation {{bibref|G.996.2}}. + + + + Input arguments. + + + + {{reference}} This is the interface over which the test is to be performed. + + + + + + + + + + + Capacity estimate calculation enabling: This parameter is expressed as a boolean and takes the value {{false}} if xDSL performance estimation is not required, {{true}} otherwise. + The capacity estimate calculation enabling parameter is defined in {{bibref|G.996.2|Clause B.2.1.1}}. + + + + + + + + The capacity estimate signal Power Spectral Density (PSD): + {{list|with each list item consisting of:}} + {{datatype|expand}} + This capacity estimate signal PSD parameter is defined in ITU-T Recommendation {{bibref|G.996.2|Clause B.2.1.2}}. + + + + + + + + + The capacity estimate noise Power Spectral Density (PSD): + {{list|with each list item consisting of:}} + {{datatype|expand}} + This capacity estimate noise PSD parameter is defined in ITU-T Recommendation {{bibref|G.996.2|Clause B.2.1.3}}. + + + + + + + + + The capacity estimate target noise margin. The range of valid values is 0 to 31 dB, in steps of {{units}}. + This capacity estimate target noise margin parameter is defined in ITU-T Recommendation {{bibref|G.996.2|Clause B.2.1.4}}. + + + + + + + + + + + + Output arguments. + + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + + + Loop termination indicator, one of the following state indications: + 'Open' + 'Short' + 'Powered on DSLAM/DPU' + 'Unknown' + This parameter is defined as LOOP-TERM in ITU-T Recommendation {{bibref|G.996.2|Clause B.1.1.1}}. + + + + + + + + + + This parameter is the loop length with units of {{units}}. + This parameter is defined as the loop length parameter LOOP_LEN in ITU-T Recommendation {{bibref|G.996.2|Clause B.1.1.2}}. + + + + + + + + + + + {{list}} List items represent paired parameters [LOOP_SEG_LEN, LOOP_SEG_BTAP] representing a concatenation of loop segment types, where LOOP_SEG_LEN represents the length of the segment in meters; and LOOP_SEG_BTAP is a string that identifies the segment type as either "in series" or "bridged tap". + The first loop segment in the list shall be the segment connected to the SELT-PMD block, subsequent loop segments in the list shall describe the loop in the direction toward the far-end loop termination. + This Loop Topology parameter is defined in ITU-T Recommendation {{bibref|G.996.2|Clause B.1.1.3}}. + + + + + + + + + + + {{list}} List items represent paired frequency spacing index i and transfer function log value, i.e. [i,TFlog(i * Df)], where the reference frequency spacing Df = 4.3125 kHz, the index i valid range is 0 to 8191, and TFlog(i * Df) spans a range from +6.0 dB down to -96.2 dB with units of 0.1 dB. + The Attenuation characteristics TFlog(f) parameter is defined in ITU-T Recommendation {{bibref|G.996.2|Clause B.1.1.6}}. + + + + + + + + + + + Missing micro-filter or splitter: This parameter is a binary indication of a missing or incorrectly installed splitter or micro-filter at the U-R reference point. A value of true represents a missing splitter. + The missing micro-filter or splitter parameter is defined in {{bibref|G.996.2|Clause B.1.1.4}}. + + + + + + + + Capacity Estimate: This parameter is an unsigned integer representing the capacity estimate in kbit/s, with units of {{units}}. + The capacity estimate parameter is defined in {{bibref|G.996.2|Clause B.1.1.7}}. + + + + + + + + + @@ -9306,7 +10312,7 @@ - Allows the ACS to change the USIM PIN used for SIM card activation. + Allows the Controller to change the USIM PIN used for SIM card activation. - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + + Result parameter indicating the number of successful pings (those in which a successful response was received prior to the timeout) in the most recent ping test. @@ -10267,6 +11288,14 @@ Ethernet object. This object models several Ethernet interface objects, each representing a different stack layer, including: {{object|Interface}}, {{object|Link}}, and {{object|VLANTermination}}. {{object|Interface}} is media-specific and models a port, the PHY layer, and the MAC layer. {{object|Link}} is media-independent and models the Logical Link Control (LLC) layer. An "outer" {{object|VLANTermination}}, when present, is expected to be stacked on top of {{object|Link}} objects to receive and send frames with a configured VLANID. + + + Indicates that WoL (Wake on LAN) over Ethernet is supported. + + + + + {{numentries}} @@ -11331,6 +12360,37 @@ + + + This object provides access to the WoL (Wake on LAN) funtionality. + + + + This command sends a magic packet over the CPE active Ethernet interfaces. + + + + Input arguments. + + + + MAC address target of the magic packet. + + + + + + + + The SecureOn password. The parameter value can be empty or, if present, can contain either 4 bytes or 6 bytes. + + + + + + + + Ethernet Link Aggregation Group (LAG) table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). Table entries model the Link Aggregation Sub-Layer as defined in {{bibref|802.3-2015}} and {{bibref|802.1AX-2014}}. It is expected that a {{object}} interface can only be stacked above {{object|.Ethernet.Interface}} interfaces. The CPE can reject creation of additional LAG instances if this would exceed its capabilities. @@ -11356,7 +12416,7 @@ 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 {{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}}. @@ -11930,7 +12990,7 @@ This object models the CPE's USB Host controllers. - See {{bibref|TR-157|Appendix I}} for Theory of Operation. + See {{bibref|TR-181i2|Appendix XVII}} for Theory of Operation. @@ -13068,7 +14128,7 @@ HPNA PHY throughput diagnostics configuration and results. When diagnostics are requested, all HPNA nodes for which the {{param|#.Interface.{i}.AssociatedDevice.{i}.PHYDiagnosticsEnable}} parameter is set enter PHY diagnostics mode. - + Input arguments. @@ -13151,10 +14211,33 @@ - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + + + + + + + + + + PHY throughput diagnostics results. @@ -13236,7 +14319,7 @@ HPNA performance monitoring configuration and results. Performance monitoring results are sampled from all nodes in the HPNA network. All packet related counters are sampled synchronized at all nodes in the HPNA network in order to derive packet loss calculations in the HPNA network. - + Input arguments. @@ -13264,10 +14347,24 @@ - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + Per-node HPNA performance monitoring results. @@ -15346,7 +16443,7 @@ G.hn PHY throughput diagnostics configuration and results. When diagnostics are requested, all G.hn nodes for which the {{param|#.Interface.{i}.PHYThroughputDiagnosticsEnable}} parameter is set enter PHY diagnostics mode. - + Input arguments. @@ -15370,10 +16467,23 @@ - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + PHY throughput diagnostics results. @@ -15436,7 +16546,7 @@ G.hn Performance Monitoring diagnostics configuration and results. When diagnostics are requested, all G.hn nodes for which the {{param|#.Interface.{i}.PerformanceMonitoringDiagnosticsEnable}} parameter is set enter PHY diagnostics mode. - + Input arguments. @@ -15490,10 +16600,23 @@ - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + Per-node G.hn performance monitoring results. @@ -16815,7 +17938,7 @@ This command provides access to either a Signal-to-Noise-Ratio (SNR) Port Measurement test or a Channel Frequency Response (CFR) Port Measurement test. The {{param|Type}} parameter is used to select which type of test to perform. CFR and SNR measurements are done between a two UPA devices (a local interface and a remote device belonging to the same network). - + Input arguments. @@ -16860,10 +17983,24 @@ - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + {{list}} Result of Signal-to-Noise-Ratio measurement (if {{param|Type}} is {{enum|SNR|Type}}) or Channel Frequency Response measurement (if {{param|Type}} is {{enum|CFR|Type}}). @@ -16937,10 +18074,23 @@ This command defines access to other WiFi SSIDs that this device is able to receive. - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + Neighboring SSID table. This table models the other WiFi SSIDs that this device is able to receive. @@ -17022,12 +18172,16 @@ + + + The type of encryption the neighboring WiFi SSID advertises. + When {{param|SecurityModeEnabled}} is one of {{enum|WPA3-SAE|SecurityModeEnabled}}, {{enum|WPA2-PSK-WPA3-SAE|SecurityModeEnabled}}, or {{enum|WPA3-Enterprise|SecurityModeEnabled}}, {{enum|TKIP}} is not valid, and should not be in the list. @@ -17052,8 +18206,8 @@ {{list}} List items indicate which IEEE 802.11 standards this {{object}} instance can support simultaneously, in the frequency band specified by {{param|OperatingFrequencyBand}}. {{enum}} Each value indicates support for the indicated standard. - If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}} are allowed. - If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}}, {{enum|ax}} are allowed. @@ -17083,6 +18237,11 @@ {{bibref|802.11ac-2013}} + + + {{bibref|802.11ax}} + + @@ -17090,8 +18249,8 @@ {{list}} List items indicate which IEEE 802.11 standard that is detected for this {{object}}. Each value indicates support for the indicated standard. - If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|##.Radio.{i}.SupportedFrequencyBands}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}} are allowed. - If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|##.Radio.{i}.SupportedFrequencyBands}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|##.Radio.{i}.SupportedFrequencyBands}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|##.Radio.{i}.SupportedFrequencyBands}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}}, {{enum|ax}} are allowed. For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard {{bibref|802.11g-2003}} is used with a backwards-compatible mode for 802.11b {{bibref|802.11b-1999}}. A value of "g" means that only the 802.11g standard can be used. @@ -17177,6 +18336,1892 @@ + + + This object describes a Wi-Fi network containing 1 or more Access Point devices. + This object is related to a Wi-Fi network that contains multiple Access Points (Multi-AP) and utilizes software logic to optimize that Wi-Fi network (typically via steering STAs, also known as Associated Devices, to the best Access Point). This object exposes the view of the Wi-Fi netwtork from the perspective of the Multi-AP Controller. The Wi-Fi Alliance EasyMesh solution is one example of managing a Multi-AP network. + + + + {{numentries}} + + + + + + + + + The summary of statistics related to Multi-AP Steering for the Wi-Fi network. + The counters contained in {{object}} are all reset on reboot. + + + + Number of times Associated Devices should have been steered but weren't because a better candidate AP couldn't be found. + + + + + + + + Number of times a Blacklist steer was attempted. + + + + + + + + Number of times an attempted Blacklist steer succeeded. + + + + + + + + Number of times an attempted Blacklist steer failed. + + + + + + + + Number of times a BTM (BSS Transition Management; 802.11k) steer was attempted. + + + + + + + + Number of times an attempted BTM (BSS Transition Management; 802.11k) steer succeeded. + + + + + + + + Number of times an attempted BTM (BSS Transition Management; 802.11k) steer failed. + + + + + + + + Number of asynchronous BTM (BSS Transition Management; 802.11k) Queries for which a BTM Request was issued. + + + + + + + + + Each instance of this object represents an individual Access Point device in the Wi-Fi network. + + + + + + + A unique identifier for this particular device within the Wi-Fi network. + + + + + + + + The manufacturer of the Access Point device (human readable string). + + + + + + + + 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. {{pattern}} + The value MUST be a valid OUI as defined in {{bibref|OUI}}. + This value MUST remain fixed over the lifetime of the device, including across firmware updates. + + + + + + + + + + + Identifier of the class of product for which the serial number applies. That is, for a given manufacturer, this parameter is used to identify the product or class of product over which the {{param|SerialNumber}} parameter is unique. + This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform. + + + + + + + + + + Identifier of the particular Access Point device that is unique for the indicated class of product and manufacturer. + This value MUST remain fixed over the lifetime of the device, including across firmware updates. Any change would indicate that it's a new device and would therefore require a BOOTSTRAP Inform. + + + + + + + + + + A string identifying the software version currently installed in the Access Point device (i.e. version of the overall firmware). + To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, ''3.0.21'' where the components mean: ''Major.Minor.Build''. + + + + + + + + + + The last time that the Access Point device was contacted via the Multi-AP control protocol. + + + + + + + + {{param}} is a reference to the IEEE 1905.1 Network Topology Device. Since IEEE 1905.1 is a common protocol used by Multi-AP Controllers for communications, this parameter allows the MultiAP portion of the data model to reference the associated IEEE 1905.1 portion of the data model. + + + + + + + + + + The medium being used to backhaul this Access Point Device to the Multi-AP Controller. The {{enum|None}} value is reserved for the {{object}} instance that represents the Multi-AP Controller. {{enum}} + + + + + + + + + + + + + + + + + The MAC Address of the Device on the network that is providing a Backhaul Link for this Access Point Device. + The {{empty}} value is reserved for the {{object}} instance that represents the Multi-AP Controller. + + + + + + + + The total number of bytes transmitted across the backhaul medium (as identified by the value of the {{param|BackhaulLinkType}} parameter), including framing characters. + + + + + + + + The total number of bytes received across the backhaul medium (as identified by the value of the {{param|BackhaulLinkType}} parameter), including framing characters. + + + + + + + + Current utilization (expressed in {{units}}) of the medium (as identified by the value of the {{param|BackhaulLinkType}} parameter) being used to backhaul this Access Point device to the Multi-AP Controller. A value of 0 is used for the {{object}} instance that represents the Access Point on the Multi-AP Controller. + + + + + + + + + + + An indicator of radio signal strength of the backhaul link of the Access Point (AP) to the Multi-AP Controller, measured in {{units}}. RCPI threshold is encoded per Table 9-154 of {{bibref|802.11-2016}}. The value of this parameter is indeterminate if the value of the {{param|BackhaulLinkType}} parameter is anything other than {{enum|Wi-Fi|BackhaulLinkType}}. + + + + + + + + + + + {{numentries}} + + + + + + + + + This object represents all of the individual Radios contained within the identified Access Point device known to the controller. + + + + + + + A unique identifier for this particular Radio within the identified Access Point. + + + + + + + + Indicates the frequency band at which the radio is operating. {{enum}} + + + + + + + + + + + {{list}} List items indicate which IEEE 802.11 standard this {{object}} instance is configured for. {{enum}} + Each value indicates support for the indicated standard. + If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}} are applicable. + If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}}, {{enum|ax}} are applicable. + For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard {{bibref|802.11g-2003}} is used with a backwards-compatible mode for 802.11b {{bibref|802.11b-1999}}. A value of "g" means that only the 802.11g standard is in use. + + + + + + + {{bibref|802.11a-1999}} + + + + + {{bibref|802.11b-1999}} + + + + + {{bibref|802.11g-2003}} + + + + + {{bibref|802.11n-2009}} + + + + + {{bibref|802.11ac-2013}} + + + + + {{bibref|802.11ax}} + + + + + + + + The current radio channel used by the connection. + + + + + + + + + + The secondary extension channel position, applicable when operating in wide channel mode (i.e. when {{param|CurrentOperatingChannelBandwidth}} is {{enum|40MHz|CurrentOperatingChannelBandwidth}} + If not operating in wide channel mode (i.e. when {{param|CurrentOperatingChannelBandwidth}} is something other than {{enum|40MHz|CurrentOperatingChannelBandwidth}}, then the value of {{param}} is {{enum|None}}. {{enum}} + + + + + + + + + + + + The channel bandwidth currently in use. {{enum}} + + + + + + + + + + + + + The Modulation Coding Scheme index (applicable to 802.11n and 802.11ac specifications only). Values from 0 to 15 MUST be supported ({{bibref|802.11n-2009}}). Values from 0 to 9 MUST be supported for {{bibref|802.11ac-2013}}. + + + + + + + + + + + Indicates the current transmit power level as a {{units}} of full power. + + + + + + + + + + + {{numentries}} + + + + + + + + + A single logical Access Point operating on this radio. + + + + + + + The MAC Address of the logical BSS (BSSID). + + + + + + + + The SSID in use for this BSS. + + + + + + + + Number of times a Blacklist steer was attempted for this Access Point. + + + + + + + + Number of times a BTM (BSS Transition Management; 802.11k) steer was attempted for this Access Point. + + + + + + + + Number of asynchronous BTM (BSS Transition Management; 802.11k) Queries for which a BTM Request was issued by this Access Point. + + + + + + + + {{numentries}} + + + + + + + + + Object describing a single Associated Device (STA). + + + + + + + The MAC address of an associated device. + + + + + + + + The operating standard that this associated device is connected with. {{enum}} + + + + + + {{bibref|802.11a-1999}} + + + + + {{bibref|802.11b-1999}} + + + + + {{bibref|802.11g-2003}} + + + + + {{bibref|802.11n-2009}} + + + + + {{bibref|802.11ac-2013}} + + + + + {{bibref|802.11ax}} + + + + + + + + Whether or not this associated device is currently present on the Wi-Fi Access Point device. + The ability to list inactive nodes is OPTIONAL. If the Access Point devices includes inactive nodes in this table, {{param}} MUST be set to {{false}} for each inactive node. The length of time an inactive node remains listed in this table is a local matter to the CPE. + + + + + + + + Date and time in UTC when the device was associated. + + + + + + + + The data transmit rate in {{units}} that was most recently used for transmission of data from the access point to the associated device. + + + + + + + + + + The data transmit rate in {{units}} that was most recently used for transmission of data from the associated device to the access point. + + + + + + + + + + An indicator of radio signal strength of the uplink from the Associated Device (STA) to the Access Point (AP) measured in {{units}}. RCPI threshold is encoded per Table 9-154 of {{bibref|802.11-2016}}. + + + + + + + + + + + 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 {{bibref|802.11-2016|Section 10.11.9.4}}. + + + + + + + + + + {{numentries}} + + + + + + + + + Object describing the Statistics for a single Associated Device (STA). + + + + The total number of bytes transmitted to the Associated Device. + + + + + + + + The total number of bytes received from the Associated Device. + + + + + + + + The total number of packets transmitted to the Associated Device. + + + + + + + + The total number of packets received from the Associated Device. + + + + + + + + The total number of outbound packets that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes. + + + + + + + + The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. + + + + + + + + The total number of transmitted packets which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. + + + + + + + + + The summary of statistics related to Multi-AP Steering for an individual STA on the Wi-Fi network. + The counters contained in {{object}} are all reset on reboot. + + + + Number of times this Associated Device should have been steered but wasn't because a better candidate AP couldn't be found. + + + + + + + + Number of times a Blacklist steer was attempted on this Associated Device. + + + + + + + + Number of times an attempted Blacklist steer succeeded for this Associated Device. + + + + + + + + Number of times an attempted Blacklist steer failed for this Associated Device. + + + + + + + + Number of times a BTM (BSS Transition Management; 802.11k) steer was attempted on this Associated Device. + + + + + + + + Number of times an attempted BTM (BSS Transition Management; 802.11k) steer succeeded for this Associated Device. + + + + + + + + Number of times an attempted BTM (BSS Transition Management; 802.11k) steer failed for this Associated Device. + + + + + + + + Number of asynchronous BTM (BSS Transition Management; 802.11k) Queries for which a BTM Request was issued to this Associated Device. + + + + + + + + The number of {{units}} since this Associated Device was last attempted to be steered. + + + + + + + + + + + The history of Multi-AP Steering for an individual STA on the Wi-Fi network. + The contents of this multi-instance object are reset on reboot. + + + + + + + + + The date/time when steering was initiated for the Associated Device. + + + + + + + + The BSSID of the Access Point that initiated the steering. + + + + + + + + The type of event that caused the steering to be initiaited. {{enum}} + NOTE: This might be Unknown for BTM Query Response steers. + + + + + + + + + + + + + The type of steering that was attempted. {{enum}} + + + + + + + + + + + + The BSSID of the destination Access Point of a successful steer. + A failed steering attempt will leave this parameter {{empty}}. + + + + + + + + The amount of time in {{units}} required for the steer to complete successfully. + A failed steering attempt will leave this parameter 0. + + + + + + + + + + + This object represents the Wi-Fi Alliance Data Elements as defined in {{bibref|DataElements-v1.0}}. + + + + + This object describes a Wi-Fi network containing 1 or more Access Point devices. + + + + A unique identifier for this particular Wi-Fi network. + + + + + + + + The time this group was collected. + + + + + + + + A unique identifier for a Multi-AP controller. + + + + + + + + {{numentries}} + + + + + + + + + Each instance of this object represents an individual Access Point device in the Wi-Fi network. + + + + + + + A unique identifier for this particular device within the Wi-Fi network as defined in {{bibref|DataElements-v1.0|Section 3.1}}. + + + + + + + + The Multi-AP capabilities supported by this device as defined by the APCapability TLV in {{bibref|MAPv1.0|Section 17.2.6}}. + + + + + + + + + + The interval between the collection of consecutive measurements of the most frequently updated Data Element from this device in {{units}}. + + + + + + + + + + {{numentries}} + + + + + + + + + This object represents all of the individual Radios contained within the identified Access Point device known to the controller. + + + + + + + A unique identifier for this particular Radio within the identified Access Point as defined in {{bibref|DataElements-v1.0|Section 3.1}}. + + + + + + + + + + Indicates whether this radio is enabled or disabled. + + + + + + + + An indicator of the average radio noise plus interference power measured for the primary operating channel. + Encoded as defined for ANPI in {{bibref|802.11-2016|Section 11.11.9.4}}. + + + + + + + + + + (Total Channel Utililzation) The percentage of time (linearly scaled with 255 representing 100%) that the Access Point device sensed the medium was busy, as indicated by either the physical or virtual carier sense (CS) mechanism. This is essentially the amount of time spent transmiting (both successful and failed transmissions), receiving (both local and non-local transmissions), and processing noise. + When more than one channel is in use for the BSS operating on the radio, the {{param}} value is calculated only for the primary channel. + + + + + + + + + + (Transmit Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on sending individually or group addressed transmissions (successful and failed). + When more than one channel is in use for the BSS operating on the radio, the {{param}} value is calculated only for the primary channel. + + + + + + + + + + (Receive Local Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on receiving individually or group addressed local transmissions (i.e. transmissions from any STA associated with any BSS operating on this radio). + When more than one channel is in use for the BSS operating on the radio, the {{param}} value is calculated only for the primary channel. + + + + + + + + + + (Receive Non-Local Channel Utilization) The percentage of time (linearly scaled with 255 representing 100%) that the radio has spent on receiving individually or group addressed non-local transmissions (i.e. valid IEEE 802.11 PPDUs that are not associated with any BSS operatin gon this radio). + When more than one channel is in use for the BSS operating on the radio, the {{param}} value is calculated only for the primary channel. + + + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + + Contains the MACAddress of the STA on this radio providing Wi-Fi backhaul to this device. + + + + The MAC address of the logical STA sharing the radio for Wi-Fi backhaul. + + + + + + + + + This object represents the capabilities of the radio which may be different from the current operational configuration. + + + + Describes the HT capabilities of the radio as defined by the HTCapabilities TLV {{bibref|MAPv1.0|Section 17.2.8}}. + + + + + + + + + + Describes the VHT capabilities of the radio as defined by the VHTCapabilities TLV {{bibref|MAPv1.0|Section 17.2.9}}. + + + + + + + + + + Describes the HE capabilities of the radio as defined by the HECapabilities TLV {{bibref|MAPv1.0|Section 17.2.10}}. + + + + + + + + + + {{numentries}} + + + + + + + + + Describes one of the possible Operating Classes supported by this Radio. + + + + + + + The Operating Class per Table E-4 in {{bibref|802.11-2016}} that this radio is capable of operating on. + + + + + + + + + + Maximum Transmit Power EIRP that this radio is capable of transmitting in the current regulatory domain for the Operating Class. + Represented as 2's complement signed integer in units of decibels relative to 1 mW ({{units}}). + + + + + + + + + + + {{list}} The channel numbers which are statically non-operable in the Operating Class (i.e. the Radio is never able to operate on these channels). + Other channels from this Operating Class which are not listed here are supported for the Radio. + + + + + + + + + + + The number of non-operable channels contained in {{param|NonOperable}}. + + + + + + + + + Describes one of the current Operating Classes in use by this Radio. One Opeating Class is indicated for each current Operating Channel Bandwidth. + The Channel indicated for the 20 MHz Operating Class is equal to the current primary channel. + + + + + + + The Operating Class per Table E-4 in {{bibref|802.11-2016}} that this radio is currently operating on. + + + + + + + + + + This Channel number in the Operating Class that this Radio is currently operating on. + + + + + + + + + + Nominal Transmit Power EIRP that this radio is currently using for the current Channel in the Opeating Class. + Represented as 2's complement signed integer in units of decibels relative to 1 mW ({{units}}). + + + + + + + + + + + The time this group was collected. + + + + + + + + + A single logical BSS operating on this radio. + + + + + + + The MAC Address of the logical BSS (BSSID). + + + + + + + + The SSID in use for this BSS. + + + + + + + + Whether the BSSID is currently enabled (beaconing frames are being sent) or disabled. + + + + + + + + Time in {{units}} since the last change to the {{param|Enabled}} value. + + + + + + + + + + The time this group was collected. + + + + + + + + Access Point (BSS) wide statistics for total unicast bytes transmitted. + + + + + + + + Access Point (BSS) wide statistics for total unicast bytes received. + + + + + + + + Access Point (BSS) wide statistics for total multicast bytes transmitted. + + + + + + + + Access Point (BSS) wide statistics for total multicast bytes received. + + + + + + + + Access Point (BSS) wide statistics for total broadcast bytes transmitted. + + + + + + + + Access Point (BSS) wide statistics for total broadcast bytes received. + + + + + + + + Estimated Service Parameters information field for AC=BE, defined per Figure 9-588 in {{bibref|802.11-2016}} and referenced in {{bibref|MAPv1.0|Section 17.2.22}}. + + + + + + + + + + Estimated Service Parameters information field for AC=BK, defined per Figure 9-588 in {{bibref|802.11-2016}} and referenced in {{bibref|MAPv1.0|Section 17.2.22}}. + + + + + + + + + + Estimated Service Parameters information field for AC=VI, defined per Figure 9-588 in {{bibref|802.11-2016}} and referenced in {{bibref|MAPv1.0|Section 17.2.22}}. + + + + + + + + + + Estimated Service Parameters information field for AC=VO, defined per Figure 9-588 in {{bibref|802.11-2016}} and referenced in {{bibref|MAPv1.0|Section 17.2.22}}. + + + + + + + + + + {{numentries}} + + + + + + + + + Object describing a single Associated Device (STA). + + + + + + + The MAC address of an associated device. + + + + + + + + The time this group was collected. + + + + + + + + Describes the HT capabilities of the Associated Device (STA). + + + + + + + + + + Describes the VHT capabilities of the Associated Device (STA). + + + + + + + + + + Describes the HE capabilities of the Associated Device (STA). + + + + + + + + + + The data transmit rate in {{units}} that was most recently used for transmission of data from the access point to the associated device. + + + + + + + + + + The data transmit rate in {{units}} that was most recently used for transmission of data from the associated device to the access point. + + + + + + + + + + The amount of time in {{units}} that the Radio has spent on the Channel receiving data from this Associated Device (STA). + + + + + + + + + + The amount of time in {{units}} that the Radio has spent on the Channel transmitting data to this Associated Device (STA). + + + + + + + + + + Estimate of the MAC layer throughput in {{units}} achievable in the downlink direction if 100% of channel airtime and BSS operating bandwidth were available, as defined in {{bibref|MAPv1.0|Section 10.3.1}}. + + + + + + + + + + Estimate of the MAC layer throughput in {{units}} achievable in the uplink direction if 100% of channel airtime and BSS operating bandwidth were available, as defined in {{bibref|MAPv1.0|Section 10.3.1}}. + + + + + + + + + + An indicator of radio signal strength of the uplink from the associated STA to the access point - measured in {{units}}. RCPI threshold (encoded per Table 9-154 of {{bibref|802.11-2016}}, and described in 10.3.1 of {{bibref|MAPv1.0}}). Reserved: 221 - 255. + NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. + + + + + + + + + + + The time in {{units}} since this Assocated Device (STA) was associated. + + + + + + + + + + The total number of bytes transmitted to the Associated Device. + + + + + + + + The total number of bytes received from the Associated Device. + + + + + + + + The total number of packets transmitted to the Associated Device. + + + + + + + + The total number of packets received from the Associated Device. + + + + + + + + The total number of outbound packets that could not be transmitted because of errors. These might be due to the number of retransmissions exceeding the retry limit, or from other causes. + + + + + + + + The total number of inbound packets that contained errors preventing them from being delivered to a higher-layer protocol. + + + + + + + + The total number of transmitted packets which were retransmissions. Two retransmissions of the same packet results in this counter incrementing by two. + + + + + + + + {{list}} Measurement Report element(s) received from the Associated Device (STA) that constitute the latest Beacon report as defined in Figure 9-199 of {{bibref|802.11-2016}}. + + + + + + + + + The number of measurement report elements contained in {{param|MeasurementReport}}. + + + + + + + + IPV4 Address assigned to the client. + + + + + + + + IPV6Address assigned to the client. + + + + + + + + Hostname assigned to the client. + + + + + + + + + The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple. + + + + The timestamp of the last scan. + + + + + + + + {{numentries}} + + + + + + + + + The Operating Class of neighboring Access Points discovered by a Radio during a channel scan. + + + + + + + The Operating Class per Table E-4 in {{bibref|802.11-2016}} of the OpClass and Channel tuple scanned by the Radio. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. + Note that the Operating Class identifies the band and channel width. + + + + + + + + + + {{numentries}} + + + + + + + + + The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan. + + + + + + + The channel number of the Channel scanned by the Radio given the Operating Class. + + + + + + + + + + The timestamp of the last scan of the channel. + + + + + + + + The current Channel Utilization measured by the Radio on the scanned 20MHz channel, as defined by {{bibref|802.11-2016|Section 9.4.2.28}}. + + + + + + + + + + An indicator of the average radio noise plus interference power measured for the primary operating channel. + Encoded as defined for ANPI in {{bibref|802.11-2016|Section 11.11.9.4}}. + + + + + + + + + + {{numentries}} + + + + + + + + + The neighboring BSS discovered by a Radio during a channel scan. + + + + + + + The BSSID indicated by the neighboring BSS. + + + + + + + + The SSID indicated by the neighboring BSS. + + + + + + + + An indicator of radio signal strength (RSSI) of the Beacon or Probe Response frames of the neighboring BSS as received by the radio measured in {{units}}. (RSSI is encoded per Table 9-154 of {{bibref|802.11-2016}}). Reserved: 221 - 255. + NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. + + + + + + + + + + + Indicates the maximum bandwidth at which the neighboring BSS is operating. e.g. "20" or "40" or "80" or "80+80" or "160" MHz. + + + + + + + + The channel utilization reported by the neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames, as defined by Section 9.4.2.28 in {{bibref|802.11-2016}}. + + + + + + + + + + The number of Associated Devices (STA) reported by this neighboring BSS per the BSS Load element if present in Beacon or Probe Response frames as defined by {{bibref|802.11-2016|Section 9.4.2.28}}. + + + + + + + + + Each instance represents a Non-AP STA that has been discovered by the Radio but is not associated to any of the BSS operating on the Radio. + + + + + + + The MAC address of the Non-AP STA. + + + + + + + + An indicator of radio signal strength (RCPI) of the uplink from the Non-AP STA - measured in {{units}}. (RCPI threshold is encoded per Table 9-154 of {{bibref|802.11-2016}}, and described in 103.2 of {{bibref|MAPv1.0}}). Reserved: 221 - 255. + NOTE: The underlying WFA specification is in the process of being reviewed for possible clarification. Please refer to that specification for more details. + + + + + + + + + + + + This object contains the events generated when a STA associates to a BSS. + + + + {{numentries}} + + + + + + + + + The events generated when an Associated Device (STA) associates to a BSS. + + + + The MAC Address of the logical BSS ( BSSID) which is reporting the Association Event. + + + + + + + + The MAC Address of the Associated Device (STA). + + + + + + + + The status code sent to the Associated Device (STA) in the Association Response frame as defined by Table 9-46 in {{bibref|802.11-2016}}. + + + + + + + + Describes the HT capabilities of the Associated Device (STA). + + + + + + + + + + Describes the VHT capabilities of the Associated Device (STA). + + + + + + + + + + Describes the HE capabilities of the Associated Device (STA). + + + + + + + + + + The time this event was collected. + + + + + + + + + This object contains the events generated when an Associated Device (STA) disassociates from a BSS. + + + + {{numentries}} + + + + + + + + + The events generated when an Associated Device (STA) disassociates from a BSS. + + + + The MAC Address of the logical BSS ( BSSID) which is reporting the Disassociation Event. + + + + + + + + The MAC address of the Associated Device (STA). + + + + + + + + The Reason Code received by the AP from the Associated Device (STA) in the most recent Disassociation or Deauthentication frame or sent by the AP to the Associated Device (STA) in the most recent Disassociation or Deauthenticaiton frame as defined in Table 9-45 in {{bibref|802.11-2016}}. + + + + + + + + The total number of bytes transmitted to the Associated Device (STA). + + + + + + + + The total number of bytes received from the Associated Device (STA). + + + + + + + + The total number of packets transmitted to the Associated Device (STA). + + + + + + + + The total number of packets received from the Associated Device (STA). + + + + + + + + The total number of outbound packets that could not be transmitted to the Associated Device (STA) because of errors. These might be due to the number of retransmissions exceeding the retry limit or from other causes. + + + + + + + + The total number of inbound packets from the Associated Device (STA) that contained errors preventing them from being delivered to a higher-layer protocol. + + + + + + + + The total number of transmitted packets to the Associated Device (STA) which were retransmissions. + N retransmissions of the same packet results in this counter incrementing by N. + + + + + + + + The time this event was collected. + + + + + + This object models an 802.11 wireless radio on a device (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). @@ -17309,8 +20354,8 @@ {{list}} List items indicate which IEEE 802.11 standards this {{object}} instance can support simultaneously, in the frequency band specified by {{param|OperatingFrequencyBand}}. {{enum}} Each value indicates support for the indicated standard. - If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}} are allowed. - If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}}, {{enum|ax}} are allowed. @@ -17340,6 +20385,11 @@ {{bibref|802.11ac-2013}} + + + {{bibref|802.11ax}} + + @@ -17347,8 +20397,8 @@ {{list}} List items indicate which IEEE 802.11 standard this {{object}} instance is configured for. Each value indicates support for the indicated standard. - If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}} are allowed. - If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|2.4GHz|OperatingFrequencyBand}}, only values {{enum|b}}, {{enum|g}}, {{enum|n}}, {{enum|ax}} are allowed. + If {{param|OperatingFrequencyBand}} is set to {{enum|5GHz|OperatingFrequencyBand}}, only values {{enum|a}}, {{enum|n}}, {{enum|ac}}, {{enum|ax}} are allowed. For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard {{bibref|802.11g-2003}} is used with a backwards-compatible mode for 802.11b {{bibref|802.11b-1999}}. A value of "g" means that only the 802.11g standard can be used. @@ -17387,6 +20437,7 @@ The current radio channel used by the connection. To request automatic channel selection, set {{param|AutoChannelEnable}} to {{true}}. Whenever {{param|AutoChannelEnable}} is {{true}}, the value of the {{param}} parameter MUST be the channel selected by the automatic channel selection procedure. + For channels in "wide mode" (802.11n where a 40MHz channel bandwidth is used), this parameter is used for Primary Channel only. The secondary or extension channel information is available through {{param|ExtensionChannel}}. Note: Valid {{param}} values depend on the {{param|OperatingFrequencyBand}} and {{param|RegulatoryDomain}} values specified. @@ -17521,12 +20572,17 @@ - 802.11ac only + 802.11ac and 802.11ax only - 802.11ac only + 802.11ac and 802.11ax only + + + + + 802.11ac and 802.11ax only @@ -17535,7 +20591,7 @@ - The preferred channel bandwidth to be used (applicable to 802.11n and 802.11ac specifications only). + The preferred channel bandwidth to be used (applicable to 802.11n, 802.11ac, and 802.11ax specifications only). @@ -17553,12 +20609,13 @@ + - The secondary extension channel position, applicable when operating in wide channel mode (i.e. when {{param|OperatingChannelBandwidth}} is set to {{enum|40MHz|OperatingChannelBandwidth}} or {{enum|Auto|OperatingChannelBandwidth}}). + The secondary extension channel position (applicable to the 802.11n specification only), applicable when operating in wide channel mode (i.e. when {{param|OperatingChannelBandwidth}} is set to {{enum|40MHz|OperatingChannelBandwidth}} or {{enum|Auto|OperatingChannelBandwidth}}). @@ -17570,16 +20627,50 @@ - The guard interval value between OFDM symbols (applicable to 802.11n and 802.11ac specifications only). + The guard interval value between OFDM symbols. - - + + + applicable to 802.11n and 802.11ac specifications only + + + + + applicable to 802.11n, 802.11ac, and 802.11ax specifications only + + + + + applicable to 802.11ax specifications only + + + + + applicable to 802.11ax specifications only + + + + + When operating in {{enum|80+80MHz|CurrentOperatingChannelBandwidth}}, this parameter determines the Center Frequency Segment 0 for the first 80 MHz channel. See {{bibref|802.11-2016|Section 9.4.2.161}} and Table 9-252. + + + + + + + + When operating in {{enum|80+80MHz|CurrentOperatingChannelBandwidth}}, this parameter determines the Center Frequency Segment 1 for the second 80 MHz channel. See {{bibref|802.11-2016|Section 9.4.2.161}} and Table 9-252. + + + + + The Modulation Coding Scheme index (applicable to 802.11n and 802.11ac specifications only). Values from 0 to 15 MUST be supported ({{bibref|802.11n-2009}}). Values from 0 to 9 MUST be supported for {{bibref|802.11ac-2013}}. A value of -1 indicates automatic selection of the MCS index. @@ -17792,7 +20883,7 @@ - Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See {{bibref|TR-181i2a5|Appendix III}} for further details. 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-181i2a5|Section 4.2.2}}. + Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See {{bibref|TR-181i2|Appendix III}} for further details. 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}}. @@ -18088,7 +21179,7 @@ - Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See {{bibref|TR-181i2a5|Appendix III}} for further details. 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-181i2a5|Section 4.2.2}}. + Throughput statistics for this interface. Packet counters here count 802.11 WiFi frames. See {{bibref|TR-181i2|Appendix III}} for further details. 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}}. @@ -18377,10 +21468,11 @@ - + The maximum number of devices that can simultaneously be connected to the access point. A value of 0 means that there is no specific limit. + This parameter has been DEPRECATED in favor of {{param|MaxAllowedAssociations}}. @@ -18440,9 +21532,12 @@ + + + @@ -18474,7 +21569,7 @@ A literal PreSharedKey (PSK) expressed as a hexadecimal string. {{param}} is only used if {{param|ModeEnabled}} is set to {{enum|WPA-Personal|ModeEnabled}} or {{enum|WPA2-Personal|ModeEnabled}} or {{enum|WPA-WPA2-Personal|ModeEnabled}}. - If {{param|KeyPassphrase}} is written, then {{param}} is immediately generated. The ACS SHOULD NOT set both the {{param|KeyPassphrase}} and the {{param}} directly (the result of doing this is undefined). + If {{param|KeyPassphrase}} is written, then {{param}} is immediately generated. The Controller SHOULD NOT set both the {{param|KeyPassphrase}} and the {{param}} directly (the result of doing this is undefined). @@ -18709,6 +21813,11 @@ {{bibref|802.11ac-2013}} + + + {{bibref|802.11ax}} + + @@ -18979,7 +22088,7 @@ This object contains statistics for different 802.11e access categories (priorities). Packet counters here count 802.11 WiFi frames. If there are not separate stats for each access category, (e.g., 802.11e is not used and there is only one queue), then only access category 0 = BE applies (e.g., the statistics for the single queue are in access category 0 = BE). - The CPE MUST reset the Access Point's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the Access Point becomes operationally down due to a previous administrative down (i.e. the Access Point's Status parameter transitions to a Diasbled state) or when the Access Point becomes administratively up (i.e. the Access Point's Enable parameter transitions from false to true). Administrative and operational status is discussed in [Section 4.2.2/TR-181i2]. + The CPE MUST reset the Access Point's Stats parameters (unless otherwise stated in individual object or parameter descriptions) either when the Access Point becomes operationally down due to a previous administrative down (i.e. the Access Point's Status parameter transitions to a Disabled state) or when the Access Point becomes administratively up (i.e. the Access Point's Enable parameter transitions from false to true). Administrative and operational status is discussed in {{bibref|TR-181i2|Section 4.2.2}}. @@ -19306,9 +22415,12 @@ + + + @@ -19422,7 +22534,7 @@ A literal PreSharedKey (PSK) expressed as a hexadecimal string. {{param}} is only used if {{param|ModeEnabled}} is set to {{enum|WPA-Personal|ModeEnabled}} or {{enum|WPA2-Personal|ModeEnabled}} or {{enum|WPA-WPA2-Personal|ModeEnabled}}. - If {{param|KeyPassphrase}} is written, then {{param}} is immediately generated. The ACS SHOULD NOT set both the {{param|KeyPassphrase}} and the {{param}} directly (the result of doing this is undefined). + If {{param|KeyPassphrase}} is written, then {{param}} is immediately generated. The Controller SHOULD NOT set both the {{param|KeyPassphrase}} and the {{param}} directly (the result of doing this is undefined). @@ -21026,7 +24147,7 @@ - The Fully Qualified Domain Name (FQDN) or IP address of the ZigBee Coordinator. The coordinator MAY be located within the CPE. In this scenario the ACS or CPE MAY use the value of "localhost". + The Fully Qualified Domain Name (FQDN) or IP address of the ZigBee Coordinator. The coordinator MAY be located within the CPE. In this scenario the Controller or CPE MAY use the value of "localhost". @@ -21301,7 +24422,7 @@ {{list}} {{reference|an interface object that is stacked immediately below this interface object}} See {{bibref|TR-181i2|Section 4.2.1}}. - When {{param|ManagementPort}} is set to {{true}} the CPE MUST set {{param}} to reference all non-management bridge ports that are within the same {{object|##.Bridge}} instance (and update {{param}} when subsequent non-management bridge ports are added or deleted on that ''Bridge''). The ACS SHOULD NOT set {{param}} in this case. + When {{param|ManagementPort}} is set to {{true}} the CPE MUST set {{param}} to reference all non-management bridge ports that are within the same {{object|##.Bridge}} instance (and update {{param}} when subsequent non-management bridge ports are added or deleted on that ''Bridge''). The Controller SHOULD NOT set {{param}} in this case. @@ -22380,12 +25501,10 @@ - A non-volatile handle used to reference this instance. This parameter provides a mechanism for an ACS to label this instance for future reference. An initial unique value MUST be assigned when the CPE creates an instance of this object. + {{datatype|expand}} - - - + @@ -23133,8 +26252,8 @@ IP interface table (a stackable interface object as described in {{bibref|TR-181i2|Section 4.2}}). This table models the layer 3 IP interface. Each IP interface can be attached to the IPv4 and/or IPv6 stack. The interface's IP addresses and prefixes are listed in the {{object|IPv4Address}}, {{object|IPv6Address}} and {{object|IPv6Prefix}} tables. - Note that support for manipulating {{param|Loopback}} interfaces is OPTIONAL, so the implementation MAY choose not to create (or allow the ACS to create) {{object}} instances of type {{enum|Loopback|Type}}. - When the ACS administratively disables the interface, i.e. sets {{param|Enable}} to {{false}}, the interface's automatically-assigned IP addresses and prefixes MAY be retained. When the ACS administratively enables the interface, i.e. sets {{param|Enable}} to {{true}}, these IP addresses and prefixes MUST be refreshed. It's up to the implementation to decide exactly what this means: it SHOULD take all reasonable steps to refresh everything but if it is unable, for example, to refresh a prefix that still has a significant lifetime, it might well choose to retain rather than discard it. + Note that support for manipulating {{param|Loopback}} interfaces is OPTIONAL, so the implementation MAY choose not to create (or allow the Controller to create) {{object}} instances of type {{enum|Loopback|Type}}. + When the Controller administratively disables the interface, i.e. sets {{param|Enable}} to {{false}}, the interface's automatically-assigned IP addresses and prefixes MAY be retained. When the Controller administratively enables the interface, i.e. sets {{param|Enable}} to {{true}}, these IP addresses and prefixes MUST be refreshed. It's up to the implementation to decide exactly what this means: it SHOULD take all reasonable steps to refresh everything but if it is unable, for example, to refresh a prefix that still has a significant lifetime, it might well choose to retain rather than discard it. Any {{enum|Tunneled|Type}} IP interface instances instantiated by the CPE MUST NOT have any statistics, writable parameters, IP addresses or IPv6 prefixes. Any read-only parameters, e.g. {{param|Status}}, MUST return the same information as for the corresponding {{enum|Tunnel|Type}} interface. The reason for these rules is that {{enum|Tunneled|Type}} IP interfaces exist only in order to be the targets of references (within the data model) and do not model any concepts over and above those already modeled by the {{enum|Tunnel|Type}} IP interfaces. Note that {{enum|Tunnel|Type}} and {{enum|Tunneled|Type}} IP interfaces are part of a legacy mechanism that is only used for {{object|##.IPv6rd}}, {{object|##.DSLite}} and {{object|##.IPsec}} tunnels and MUST NOT be used in any other context. For all other tunneling mechanisms {{enum|Normal|Type}} IP interfaces are stacked above technology-specific Tunnel Interfaces, e.g. above {{object|##.GRE.Tunnel.{i}.Interface}} or {{object|##.MAP.Domain.{i}.Interface}} objects. @@ -23355,7 +26474,7 @@ - IPv4 address table. Entries are auto-created and auto-deleted as IP addresses are added and deleted via DHCP, auto-IP, or IPCP. Static entries are created and configured by the ACS. + IPv4 address table. Entries are auto-created and auto-deleted as IP addresses are added and deleted via DHCP, auto-IP, or IPCP. Static entries are created and configured by the Controller. @@ -23666,7 +26785,7 @@ * Automatically via DHCPv6 {{bibref|RFC3315}}, which covers generation of any type of address (subject to the configured DHCP server policy). * Manually via a GUI or some other local management interface. * Manually via factory default configuration. - * By the ACS. + * By the Controller. This table MUST NOT include entries for the Subnet-Router anycast address {{bibref|RFC4291|Section 2.6.1}}. Such entries would be identical to others but with a zero interface identifier, and would add no value. A loopback interface will always have address ''::1'' {{bibref|RFC4291|Section 2.5.3}} and MAY also have link-local address ''fe80::1''. This object is based on ''ipAddressTable'' from {{bibref|RFC4293}}. @@ -23807,7 +26926,7 @@ - For example, present in the factory default configuration (but not {{enum|WellKnown}}), created by the ACS, or created by some other management entity (e.g. via a GUI). + For example, present in the factory default configuration (but not {{enum|WellKnown}}), created by the Controller, or created by some other management entity (e.g. via a GUI). @@ -23869,7 +26988,7 @@ * Automatically via internal CPE logic, e.g. creation of child prefixes derived from a parent prefix. * Manually via a GUI or some other local management interface. * Manually via factory default configuration. - * By the ACS. + * By the Controller. The CPE MAY choose not to create {{object}} entries for {{enum|WellKnown|Origin}} prefixes or for the ULA /48 prefix {{bibref|RFC4193}}. If an {{object}} entry exists for the ULA /48 prefix, it MUST be on a downstream interface (i.e. an interface for which the physical layer interface object has ''Upstream'' = {{false}}). This object is based on ''ipAddressPrefixTable'' from {{bibref|RFC4293}}. @@ -23992,7 +27111,7 @@ - Created by the ACS, by some other management entity (e.g. via a GUI), or present in the factory default configuration (but not {{enum|WellKnown}}). Unrelated to any shorter length prefix that might exist on the CPE. Also see {{param|StaticType}}. Can be used for RA (Prefix Information), DHCPv6 address assignment (IA_NA) or DHCPv6 prefix delegation (IA_PD). + Created by the Controller, by some other management entity (e.g. via a GUI), or present in the factory default configuration (but not {{enum|WellKnown}}). Unrelated to any shorter length prefix that might exist on the CPE. Also see {{param|StaticType}}. Can be used for RA (Prefix Information), DHCPv6 address assignment (IA_NA) or DHCPv6 prefix delegation (IA_PD). @@ -24006,7 +27125,7 @@ - Static prefix sub-type. For a {{enum|Static|Origin}} prefix, this can be set to {{enum|PrefixDelegation}} or {{enum|Child}}, thereby creating an unconfigured prefix of the specified type that will be populated in preference to creating a new instance. This allows the ACS to pre-create "prefix slots" with known path names that can be referenced from elsewhere in the data model before they have been populated. {{enum}} + Static prefix sub-type. For a {{enum|Static|Origin}} prefix, this can be set to {{enum|PrefixDelegation}} or {{enum|Child}}, thereby creating an unconfigured prefix of the specified type that will be populated in preference to creating a new instance. This allows the Controller to pre-create "prefix slots" with known path names that can be referenced from elsewhere in the data model before they have been populated. {{enum}} This mechanism works as follows: * When this parameter is set to {{enum|PrefixDelegation}} or {{enum|Child}}, the instance becomes a "prefix slot" of the specified type. * Such an instance can be administratively enabled ({{param|Enable}} = {{true}}) but will remain operationally disabled ({{param|Status}} = {{enum|Disabled|Status}}) until it has been populated. @@ -24033,7 +27152,7 @@ - Prefix will be populated when a {{enum|Child|Origin}} prefix needs to be created. In this case, the ACS needs also to set {{param|ParentPrefix}} and might want to set {{param|ChildPrefixBits}} (if parent prefix is not set, or goes away, then the child prefix will become operationally disabled). + Prefix will be populated when a {{enum|Child|Origin}} prefix needs to be created. In this case, the Controller needs also to set {{param|ParentPrefix}} and might want to set {{param|ChildPrefixBits}} (if parent prefix is not set, or goes away, then the child prefix will become operationally disabled). @@ -24270,7 +27389,7 @@ This command provides access to an IP-layer ping test. - + Input arguments. @@ -24282,7 +27401,7 @@ - + @@ -24363,10 +27482,31 @@ - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + The CPE can not reach the requested Ping host address + + + + + + + Indicates which IP address was used to send the Ping request. @@ -24453,11 +27593,11 @@ - + This command defines access to an IP-layer trace-route test for the specified IP interface. - + Input arguments. @@ -24469,7 +27609,7 @@ - + @@ -24560,10 +27700,32 @@ - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + The CPE can not reach the requested TraceRoute host address + + + + + + + + Indicates which IP address was used for TraceRoute. @@ -24667,7 +27829,7 @@ This command defines the diagnostics configuration for a HTTP and FTP DownloadDiagnostics Test. Files received in the DownloadDiagnostics do not require file storage on the CPE device. - + Input arguments. @@ -24689,7 +27851,7 @@ * When using FTP transport, FTP binary transfer MUST be used. * When using HTTP transport, persistent connections MUST be used and pipelining MUST NOT be used. * When using HTTP transport the HTTP Authentication MUST NOT be used. - Note: For time based tests ({{param|TimeBasedTestDuration}} > 0) the ACS MAY add a hint to duration of the test to the URL. See {{bibref|TR-143a1|Section 4.3}} for more details. + Note: For time based tests ({{param|TimeBasedTestDuration}} > 0) the Controller MAY add a hint to duration of the test to the URL. See {{bibref|TR-143|Section 4.3}} for more details. @@ -24721,7 +27883,7 @@ - Controls time based testing {{bibref|TR-143a1|Section 4.3}}. When {{param}} > 0, {{param}} is the duration in {{units}} of a time based test. If {{param}} is 0, the test is not based on time, but on the size of the file to be downloaded. The default value SHOULD be 0. + Controls time based testing {{bibref|TR-143|Section 4.3}}. When {{param}} > 0, {{param}} is the duration in {{units}} of a time based test. If {{param}} is 0, the test is not based on time, but on the size of the file to be downloaded. The default value SHOULD be 0. @@ -24797,10 +27959,34 @@ - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + + + + + + + + + + + Indicates which IP address was used to send the request. @@ -25123,7 +28309,7 @@ This command defines the diagnostics configuration for a HTTP or FTP UploadDiagnostics test. Files sent by the UploadDiagnostics do not require file storage on the CPE device, and MAY be an arbitrary stream of bytes. - + Input arguments. @@ -25185,7 +28371,7 @@ - Controls time based testing {{bibref|TR-143a1|Section 4.3}}. When {{param}} > 0, {{param}} is the duration in {{units}} of a time based test. If {{param}} is 0, the test is not based on time, but on the size of the file to be uploaded. The default value SHOULD be 0. + Controls time based testing {{bibref|TR-143|Section 4.3}}. When {{param}} > 0, {{param}} is the duration in {{units}} of a time based test. If {{param}} is 0, the test is not based on time, but on the size of the file to be uploaded. The default value SHOULD be 0. @@ -25261,10 +28447,35 @@ - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + + + + + + + + + + + + Indicates which IP address was used to send the request. @@ -25562,9 +28773,9 @@ - This command defines the diagnostics configuration for a UDP Echo test {{bibref|TR-143a1|Appendix A.1}} defined in {{bibref|RFC862}} or a UDP Echo Plus test defined in {{bibref|TR-143a1|Appendix A.1}}. + This command defines the diagnostics configuration for a UDP Echo test {{bibref|TR-143|Appendix A.1}} defined in {{bibref|RFC862}} or a UDP Echo Plus test defined in {{bibref|TR-143|Appendix A.1}}. - + Input arguments. @@ -25686,10 +28897,24 @@ - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + Indicates which IP address was used to send the request. @@ -25769,7 +28994,7 @@ Time the client receives the response packet in UTC, which MUST be specified to microsecond precision. For example: 2008-04-09T15:01:05.123456Z - If this response is never received, {{param}} SHOULD be set to the Unknown Time value as specified in {{bibref|TR-106a7|Section 3.2.2}}. + If this response is never received, {{param}} SHOULD be set to the Unknown Time value as specified in {{bibref|TR-106|Section 3.2.2}}. @@ -25777,7 +29002,7 @@ - The TestGenSN field in the UDPEcho Plus packet {{bibref|TR-143a1|Section A.1.4}} sent by the CPE client. + The TestGenSN field in the UDPEcho Plus packet {{bibref|TR-143|Section A.1.4}} sent by the CPE client. @@ -25785,7 +29010,7 @@ - The TestRespSN field in the response packet {{bibref|TR-143a1|Section A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) for this Echo Plus packet sent by the CPE client. If {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. + The TestRespSN field in the response packet {{bibref|TR-143|Section A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) for this Echo Plus packet sent by the CPE client. If {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. @@ -25793,7 +29018,7 @@ - The TestRespRcvTimeStamp field in the response packet {{bibref|TR-143a1|Section A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) to record the reception time of this UDP Echo Plus packet sent from the CPE client. If {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. + The TestRespRcvTimeStamp field in the response packet {{bibref|TR-143|Section A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) to record the reception time of this UDP Echo Plus packet sent from the CPE client. If {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. @@ -25803,7 +29028,7 @@ - The TestRespReplyTimeStamp field in the response packet {{bibref|TR-143a1|Section A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) to record the server reply time of this UDP Echo Plus packet sent from the CPE client. + The TestRespReplyTimeStamp field in the response packet {{bibref|TR-143|Section A.1.4}} from the UDP Echo Plus server (i.e. {{param|#.Host}}) to record the server reply time of this UDP Echo Plus packet sent from the CPE client. That is, the time that the server returned the UDP Echo Plus packet. If {{param|PacketSuccess}} is {{false}}, {{param}} SHOULD be 0. @@ -25827,7 +29052,7 @@ This command provides access to a diagnostics test that performs either an ICMP Ping or UDP Echo ping against multiple hosts determining which one has the smallest average response time. There MUST be a ping response to the transmitted ping, or timeout, before the next ping is sent out. - + Input arguments. @@ -25865,7 +29090,7 @@ - + @@ -25912,10 +29137,24 @@ - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + + + + Result parameter indicating the Host (one of the items within the {{param|HostList}} Parameter) with the smallest average response time. @@ -26386,7 +29625,7 @@ IPsec {{bibref|RFC4301}} object that supports the configuration of Encapsulating Security Payload (ESP) {{bibref|RFC4303}} and Authentication Header (AH) {{bibref|RFC4302}} in tunnel mode {{bibref|RFC4301|Section 3.2}}. Use of IKEv2 {{bibref|RFC5996}} is assumed. The IPsec object does not currently support static configuration of tunnels and child Security Associations (SAs). - See the IPsec Theory of Operation {{bibref|TR-181i2a5|Appendix IX}} for a description of the working of this IPsec data model. + See the IPsec Theory of Operation {{bibref|TR-181i2|Appendix IX}} for a description of the working of this IPsec data model. @@ -29614,7 +32853,7 @@ The Mapping of Address and Port (MAP) object {{bibref|RFC7597}} {{bibref|RFC7599}} {{bibref|RFC7598}}. This object applies only to gateway devices that support IPv4 on the LAN side, include a {{object|#.NAT}}, and typically have only IPv6 connectivity on the WAN side. - See the MAP Theory of Operation {{bibref|TR-181i2a8|Appendix XV}} for a description of the working of this MAP data model. + See the MAP Theory of Operation {{bibref|TR-181i2|Appendix XV}} for a description of the working of this MAP data model. @@ -29716,7 +32955,7 @@ The MAP domain's ''End-user IPv6 prefix''. This MUST reference one of {{param|WANInterface}}'s prefixes. - If the ACS configures this prefix directly, the CPE MUST use the ACS-configured prefix. Otherwise, the CPE MUST select one of {{param|WANInterface}}'s prefixes; the selected prefix will typically have {{param|##.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} = {{enum|PrefixDelegation|##.IP.Interface.{i}.IPv6Prefix.{i}.Origin}}. + If the Controller configures this prefix directly, the CPE MUST use the Controller-configured prefix. Otherwise, the CPE MUST select one of {{param|WANInterface}}'s prefixes; the selected prefix will typically have {{param|##.IP.Interface.{i}.IPv6Prefix.{i}.Origin}} = {{enum|PrefixDelegation|##.IP.Interface.{i}.IPv6Prefix.{i}.Origin}}. @@ -29868,7 +33107,7 @@ - Present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI) + Present in the factory default configuration, created by the Controller, or created by some other management entity (e.g. via a GUI) @@ -30431,7 +33670,7 @@ - For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI). + For example, present in the factory default configuration, created by the Controller, or created by some other management entity (e.g. via a GUI). @@ -30572,7 +33811,7 @@ - For example, present in the factory default configuration, created by the ACS, or created by some other management entity (e.g. via a GUI). + For example, present in the factory default configuration, created by the Controller, or created by some other management entity (e.g. via a GUI). @@ -30879,12 +34118,25 @@ + + + The number of consecutive Neighbor Solicitation messages sent while performing Duplicate Address Detection on a tentative address (see{{bibref|RFC4862|5.1}}). + A value of zero indicates that Duplicate Address Detection is not performed on tentative addresses. + A value of one indicates a single transmission with no follow-up retransmissions. + If the value is greater than 1, {{param|RetransTimer}} defines the delay between consecutive messages. + + + + + + Retransmission interval in {{units}}, as defined in {{bibref|RFC4861}}. For auto-configuration purposes, {{param}} specifies the delay between consecutive Neighbor Solicitation transmissions performed during Duplicate Address Detection (DAD) {{bibref|RFC4862|Section 5.4}}, as well as the time a node waits after sending the last Neighbor Solicitation before ending the DAD process. + @@ -30892,13 +34144,14 @@ - Retransmission interval in {{units}}, as defined in {{bibref|RFC4861}}. For auto-configuration purposes, {{param}} specifies the delay between consecutive Router Solicitation transmissions. + Retransmission interval in {{units}}, as defined in {{bibref|RFC4861|6.3.7}}. For auto-configuration purposes, {{param}} specifies the delay between consecutive Router Solicitation transmissions. + - + @@ -31233,7 +34486,7 @@ Settings allowing a CPE to derive and route IPv6 Rapid Deployment (6rd) delegated prefixes as specified in {{bibref|RFC5969}}. The 6rd mechanism is intended to be implemented only on what {{bibref|RFC5969}} refers to as ''Customer Edge Routers'', i.e. on gateway devices, that support IPv6 on the LAN side and only have IPv4 connectivity on the WAN side. - See the 6rd Theory of Operation {{bibref|TR-181i2a2|Appendix VI}} for a description of the working of this 6rd data model. + See the 6rd Theory of Operation {{bibref|TR-181i2|Appendix VI}} for a description of the working of this 6rd data model. @@ -31303,7 +34556,7 @@ - If {{true}}, the destination address for all 6rd traffic will be set (IPv4 destination address) to one of the {{param|BorderRelayIPv4Addresses}}. If {{false}}, traffic whose destination address begins with the same prefix as {{param|SPIPv6Prefix}} will be sent directly to the destination IPv4 address of the endpoint, which is in the same 6rd domain. See 6rd Theory of Operation for further explanation {{bibref|TR-181i2a2|Appendix VI}}. + If {{true}}, the destination address for all 6rd traffic will be set (IPv4 destination address) to one of the {{param|BorderRelayIPv4Addresses}}. If {{false}}, traffic whose destination address begins with the same prefix as {{param|SPIPv6Prefix}} will be sent directly to the destination IPv4 address of the endpoint, which is in the same 6rd domain. See 6rd Theory of Operation for further explanation {{bibref|TR-181i2|Appendix VI}}. @@ -31372,7 +34625,7 @@ Settings allowing a CPE to configure and route IPv6 Dual-Stack Lite (DSLite) as specified in {{bibref|DSLite}}. The DS-Lite mechanism is intended to be implemented only on gateway devices that support IPv4 on the LAN side and only have IPv6 connectivity on the WAN side. - See the Dual-Stack Lite Theory of Operation {{bibref|TR-181i2a2|Appendix VII}} for a description of the working of this DS-Lite data model. + See the Dual-Stack Lite Theory of Operation {{bibref|TR-181i2|Appendix VII}} for a description of the working of this DS-Lite data model. @@ -31470,7 +34723,7 @@ The Fully Qualified Domain Name (FQDN) of the tunnel concentrator (remote endpoint). - This parameter is based on ''OPTION_DS_LITE_NAME'' from {{bibref|DSLite-options|Section 4}} and can be assigned statically (e.g. present in the factory default configuration or set by the ACS) or can be updated dynamically (via DHCPv6). If both statically and dynamically assigned, then {{param|EndpointAssignmentPrecedence}} indicates whether it is the static configuration or the DHCPv6 configuration that is actually applied to {{param}}. + This parameter is based on ''OPTION_DS_LITE_NAME'' from {{bibref|DSLite-options|Section 4}} and can be assigned statically (e.g. present in the factory default configuration or set by the Controller) or can be updated dynamically (via DHCPv6). If both statically and dynamically assigned, then {{param|EndpointAssignmentPrecedence}} indicates whether it is the static configuration or the DHCPv6 configuration that is actually applied to {{param}}. Note: {{param}} is only writable when {{param|EndpointAssignmentPrecedence}} is {{enum|Static|EndpointAssignmentPrecedence}}; otherwise, {{param}} is automatically configured via the DHCPv6 received option. @@ -31482,7 +34735,7 @@ The address of the tunnel concentrator (remote endpoint). - This parameter can only be assigned statically (e.g. present in the factory default configuration or set by the ACS). + This parameter can only be assigned statically (e.g. present in the factory default configuration or set by the Controller). @@ -31501,7 +34754,7 @@ - For example, present in the factory default configuration, set by the ACS, or set by some other management entity (e.g. via a GUI). + For example, present in the factory default configuration, set by the Controller, or set by some other management entity (e.g. via a GUI). @@ -31697,7 +34950,7 @@ Ethernet priority code (as defined in {{bibref|802.1Q-2011}}) to mark traffic not associated with any specified classifier. A value of -1 indicates no change from the incoming packet. - A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref|TR-181i2a5|Annex A}}. + A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref|TR-181i2|Annex A}}. @@ -32822,7 +36075,7 @@ Ethernet priority code (as defined in {{bibref|802.1Q-2011}}) to mark traffic associated with this App table entry, but not associated with any specified flow. A value of -1 indicates no change from the incoming packet. - A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref|TR-181i2a5|Annex A}}. + A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref|TR-181i2|Annex A}}. @@ -32975,7 +36228,7 @@ Ethernet priority code (as defined in {{bibref|802.1Q-2011}}) to mark traffic with that falls into this flow. A value of -1 indicates no change from the incoming packet. - A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref|TR-181i2a5|Annex A}}. + A value of -2 indicates automatic marking of EthernetPriority based upon the DSCP value of the incoming packet as defined in {{bibref|TR-181i2|Annex A}}. @@ -33090,7 +36343,7 @@ - Identifies the method of traffic measurement to be used for this policer. {{enum}} + Identifies the method of traffic measurement to be used for this policer. {{enum|SimpleTokenBucket}} makes use of {{param|CommittedRate}} and {{param|CommittedBurstSize}}. {{enum|SingleRateThreeColor}} makes use of {{param|CommittedRate}}, {{param|CommittedBurstSize}}, and {{param|ExcessBurstSize}} as defined in {{bibref|RFC2697}}. {{enum|TwoRateThreeColor}} makes use of {{param|CommittedRate}}, {{param|CommittedBurstSize}}, {{param|PeakRate}}, and {{param|PeakBurstSize}} as defined in {{bibref|RFC2698}}. @@ -33507,7 +36760,7 @@ - Queue statistics table. This table is managed by the ACS, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected. + Queue statistics table. This table is managed by the Controller, which will create entries only for those {Queue, Interface} combinations for which statistics are to be collected. Note: The {{object}} table includes unique key parameters that are strong references. If a strongly referenced object is deleted, the CPE will set the referencing parameter to {{empty}}. However, doing so under these circumstances might cause the updated {{object}} row to then violate the table's unique key constraint; if this occurs, the CPE MUST disable the offending {{object}} row. @@ -33826,7 +37079,7 @@ - {{noreference}}The value MUST the path name of the ''AssociatedDevice'' (or equivalent) table row that models the host, or {{null}} if there is no such table. + {{noreference}}The value MUST the path name of the ''AssociatedDevice'' (or equivalent) table row that models the host, or {{null}} if either there is no such table or the host isn't directly connected to this device (e.g. the host is connected to a Wi-Fi Access Point). For example: ''Device.WiFi.AccessPoint.1.AssociatedDevice.2'' @@ -33838,7 +37091,7 @@ - {{noreference}}The value MUST be the path name of a row in a layer 1 interface table. If the layer 1 device isn’t known, then {{param}} will be {{null}}. + {{noreference}}The value MUST be the path name of a row in a layer 1 interface table. If either the layer 1 interface isn't known or the host isn't directly connected to this device (e.g. the host is connected to a Wi-Fi Access Point), then {{param}} will be {{null}}. For example: ''Device.Ethernet.Interface.2'' @@ -33850,7 +37103,7 @@ - {{reference}} If the entry represents a non-IP device, then {{param}} will be {{empty}}. + {{reference}} If either the layer 3 interface isn't known or the host isn't directly connected to this device (e.g. the host is connected to a Wi-Fi Access Point), then {{param}} will be {{null}}. @@ -33859,6 +37112,23 @@ + + + Type of physical interface through which this host is connected. + + + + + + + + + + + + + + Vendor Class Identifier DHCP option (Option 60) of the host. @@ -34110,7 +37380,7 @@ - This table contains the DNS Server IP address to be used by the DHCP Client (it does ''not'' model a DNS Server). Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the ACS. + This table contains the DNS Server IP address to be used by the DHCP Client (it does ''not'' model a DNS Server). Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the Controller. @@ -34230,7 +37500,7 @@ - DNS Server forwarding policy to be used by the DNS Relay. Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the ACS. + DNS Server forwarding policy to be used by the DNS Relay. Entries are either automatically created as result of DHCP (v4 or v6), IPCP, or RA received DNS server information, or are statically configured by the Controller. Note: Management of re-directing queries to the device embedded DNS server is not defined in this version of the specification. @@ -34326,14 +37596,14 @@ There will be a {{object|Result}} instance for each time the device performs a DNS lookup, which is determined by the value of {{param|NumberOfRepetitions}}. Any previous {{object|Result}} instances are removed when a new test is initiated. - + Input arguments. - {{reference}} This parameter specifies the IP-layer interface over which the test is to be performed (i.e. the source IP address to use when performing the test). - If {{empty}} is specified, the CPE MUST use its routing policy (Forwarding table entries), if necessary, to determine the appropriate interface. + {{reference}} The layer 2 or layer 3 interface over which the test is to be performed. Example: ''Device.IP.Interface.1'', ''Device.Bridge.1.Port.2'' + If {{empty}} is specified, the CPE MUST use the interface as directed by its bridging or routing policy (''Forwarding'' table entries) to determine the appropriate interface. @@ -34383,10 +37653,28 @@ - + Output arguments. + + + Indicates the availability of diagnostics data. {{enum}} + If the value of this parameter is anything other than {{enum|Complete}}, the values of the other results parameters for this test are indeterminate. + + + + + + + Unable to resolve DNSServer Name + + + + + + + Number of successfully executed repetitions. @@ -34788,6 +38076,30 @@ + + + Determines the timeout, in {{units}}, of NAT translations for TCP sessions. It is the time after which a NAT entry is removed from the NAT table if there is no activity. A value of -1 represents an infinite duration. + + + + + + + + + + + + Determines the timeout, in {{units}}, of NAT translations for UDP bindings. It is the time after which a NAT entry is removed from the NAT table if there is no activity. A value of -1 represents an infinite duration. + + + + + + + + + @@ -34947,8 +38259,8 @@ The IP address or DNS host name of an internal client (on the LAN). Support for an IP address is mandatory. If {{param}} is specified as an IP address and the LAN device's IP address subsequently changes, the port mapping MUST remain associated with the original IP address. - Support for DNS host names is OPTIONAL. If {{param}} is specified as a DNS host name and the LAN device's IP address subsequently changes, the port mapping MUST remain associated with this LAN device. In this case, it is the responsibility of the CPE to maintain the name-to-address mapping in the event of IP address changes. This can be accomplished, for example, by assigning the DNS host name via use of DHCP option 12 (Host Name) or option 81 (FQDN). Note that the ACS can learn the host name associated with a given LAN device via the {{object|.Hosts.Host.}} table. - Read access to this parameter MUST always return the exact value that was last set by the ACS. For example, if the internal client is set to a DNS host name, it MUST read back as a DNS host name and not as an IP address. + Support for DNS host names is OPTIONAL. If {{param}} is specified as a DNS host name and the LAN device's IP address subsequently changes, the port mapping MUST remain associated with this LAN device. In this case, it is the responsibility of the CPE to maintain the name-to-address mapping in the event of IP address changes. This can be accomplished, for example, by assigning the DNS host name via use of DHCP option 12 (Host Name) or option 81 (FQDN). Note that the Controller can learn the host name associated with a given LAN device via the {{object|.Hosts.Host.}} table. + Read access to this parameter MUST always return the exact value that was last set by the Controller. For example, if the internal client is set to a DNS host name, it MUST read back as a DNS host name and not as an IP address. It MUST be possible to set the {{param}} to the broadcast IP address 255.255.255.255 for UDP mappings. This is to enable multiple NAT clients to use the same well-known port simultaneously. @@ -34973,7 +38285,7 @@ Properties for Port Control Protocol (PCP) {{bibref|RFC6887}}. - See the PCP Theory of Operation {{bibref|TR-181i2a8|Appendix XIV}} for a description of the working of this PCP data model. + See the PCP Theory of Operation {{bibref|TR-181i2|Appendix XIV}} for a description of the working of this PCP data model. @@ -35260,7 +38572,7 @@ - {{param|ServerNameOrAddress}} is an FQDN, IPv4 address or IPv6 address that was created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration + {{param|ServerNameOrAddress}} is an FQDN, IPv4 address or IPv6 address that was created by the Controller, by some other management entity (e.g. via a GUI), or is present in the factory default configuration @@ -35387,7 +38699,7 @@ Inbound Mapping table. This table contains all Inbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode MAP, as described in {{bibref|RFC6887|Section 11}}. These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The {{param|Origin}} parameter indicates which mechanism requested the mapping. - For non-{{enum|Static|Origin}} mappings (here ''Static'' refers to the mechanism that created the mapping, not to the {{param|Lifetime}}), the ACS MAY modify the {{param||Enable}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. + For non-{{enum|Static|Origin}} mappings (here ''Static'' refers to the mechanism that created the mapping, not to the {{param|Lifetime}}), the Controller MAY modify the {{param||Enable}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. @@ -35463,7 +38775,7 @@ - Requested via static configuration, i.e. created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration + Requested via static configuration, i.e. created by the Controller, by some other management entity (e.g. via a GUI), or is present in the factory default configuration @@ -35666,7 +38978,7 @@ Outbound Mapping table. This table contains all Outbound Mappings requested by this PCP Client on this PCP Server. Such a mapping is created by a PCP request with OpCode PEER, as described in {{bibref|RFC6887|Section 12}}. These requests can be issued from internal device applications, from static configuration or from other LAN device applications via interworking functions such as UPnP IGD or PCP proxies. The {{param|Origin}} parameter indicates which mechanism requested the mapping. - For non-{{enum|Static|Origin}} mappings (here ''Static'' refers to the mechanism that created the mapping, not to the {{param|Lifetime}}), the ACS MAY modify the {{param||Enable}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. + For non-{{enum|Static|Origin}} mappings (here ''Static'' refers to the mechanism that created the mapping, not to the {{param|Lifetime}}), the Controller MAY modify the {{param||Enable}} parameter but MUST NOT modify any other parameters in the mapping or its sub-objects. @@ -35744,7 +39056,7 @@ - Requested via static configuration, i.e. created by the ACS, by some other management entity (e.g. via a GUI), or is present in the factory default configuration + Requested via static configuration, i.e. created by the Controller, by some other management entity (e.g. via a GUI), or is present in the factory default configuration @@ -36374,6 +39686,31 @@ + + + Pool association criterion. Determines which devices are allowed, {{enum}} + + + + + + All clients are served. + + + + + Only clients, whose MAC address is listed in the {{object|Client.{i}.}} table (parameter {{param|Client.{i}.Chaddr}}) or in the {{object|StaticAddress.{i}.}} table (parameter {{param|StaticAddress.{i}.Chaddr}}) are served. + The parameter {{param|#.Chaddr}} is not used, if this value is set. + + + + + Only clients, whose MAC address is '''not''' listed in the {{object|Client.{i}.}} table (parameter {{param|Client.{i}.Chaddr}}) or in the {{object|StaticAddress.{i}.}} table (parameter {{param|StaticAddress.{i}.Chaddr}}) are served. + + + + + Specifies first IPv4 address in the pool to be assigned by the DHCP server on the LAN interface. @@ -36459,7 +39796,6 @@ - @@ -36468,7 +39804,6 @@ - @@ -37499,7 +40834,6 @@ - @@ -37508,7 +40842,6 @@ - @@ -38291,7 +41624,7 @@ Smart Card Type. {{enum}} - Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a2|Section 3.3}} MUST be adhered to. + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to. @@ -38304,7 +41637,7 @@ {{list}} Indicates Smart Card Application(s). {{param}} is only relevant when {{param|Type}} has a value of UICC, otherwise it is {{empty}}. {{enum}} - Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a2|Section 3.3}} MUST be adhered to. + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to. @@ -39345,7 +42678,7 @@ Firewall configuration object. The {{param|Config}} parameter enables and disables the Firewall, and can select either a predefined configuration ({{enum|High|Config}} or {{enum|Low|Config}}) or an explicitly-defined {{enum|Advanced|Config}} configuration. For an {{enum|Advanced|Config}} configuration, {{param|AdvancedLevel}} controls the currently active Firewall Level, and the Firewall Levels are defined in the {{object|Level}}, {{object|Chain}} and {{object|Chain.{i}.Rule}} tables. The Firewall rules modeled by this object operate only on the forwarding path. This means that they affect only routed traffic, and do not affect traffic that is destined for or generated by the CPE. Note that any {{object|#.NAT}} processing on the ingress packet occurs before Firewall rules are applied so, for example, the Firewall rules will see the translated destination IP address and port in a downstream packet that has passed through the NAT. - See {{bibref|TR-181i2a2|Appendix VIII}} for an example {{enum|Advanced|Config}} configuration. + See {{bibref|TR-181i2|Appendix VIII}} for an example {{enum|Advanced|Config}} configuration. @@ -39359,7 +42692,7 @@ How this firewall is configured. {{enum}} - Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a2|Section 3.3}} MUST be adhered to. + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106|Section 3.3}} MUST be adhered to. @@ -40071,7 +43404,7 @@ This object configures collection of periodic statistics for the device. - Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the ACS as a comma-separated list of the most recent <n> samples. + Periodic statistics are measured over a sample interval (which can be aligned with absolute time) and are made available to the Controller as a comma-separated list of the most recent <n> samples. This object provides a single set of global settings that affect the entire device unless overridden locally. @@ -40134,7 +43467,7 @@ Indicates availability of Sample statistics. {{enum}} - The {{enum|Trigger}} value is only used for triggering the ACS to fetch the collected data and can only be used when {{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}]. + The {{enum|Trigger}} value is only used for triggering the Controller to fetch the collected data and can only be used when {{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}]. The transition from {{enum|Enabled}} to {{enum|Trigger}} to {{enum|Enabled}} MUST be instantaneous and so will result in only a single value change for notification purposes. @@ -40151,7 +43484,7 @@ - Collection is enabled and the ACS SHOULD now fetch the collected data. + Collection is enabled and the Controller SHOULD now fetch the collected data. @@ -40205,7 +43538,7 @@ {{param}} is used only to set the "phase" of the sample and fetch intervals. The actual value of {{param}} can be arbitrarily far into the past or future. This time reference also determines when the {{param|Status}} {{enum|Enabled|Status}} to {{enum|Trigger|Status}} to {{enum|Enabled|Status}} transitions that are controlled by {{param|FetchSamples}} will occur. If collection of periodic statistics is enabled and {{param|FetchSamples}} is in the range [1:{{param|ReportSamples}}] then each such {{param|Status}} transition MUST occur at this reference time plus or minus an integer multiple of {{param|FetchSamples}} * {{param|SampleInterval}} (the fetch interval). If {{param}} is changed while collection of periodic statistics is enabled, any stored samples are discarded, and the first sample interval begins immediately. - The Unknown Time value defined in {{bibref|TR-106a2}} indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals. + The Unknown Time value defined in {{bibref|TR-106}} indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified sample and fetch intervals. If absolute time is not available to the CPE, its sample and fetch interval behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. For example, if {{param|SampleInterval}} is 3600 (an hour) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then sample intervals will complete on each UTC hour (00:00, 01:00, 02:00 etc). If, in addition, {{param|FetchSamples}} is 24, then the fetch interval is 86400 (a day) and {{param|Status}} {{enum|Enabled|Status}} to {{enum|Trigger|Status}} to {{enum|Enabled|Status}} transitions will occur every day at UTC midnight. @@ -40220,7 +43553,7 @@ The number of sample intervals to be collected before transitioning {{param|Status}} from {{enum|Enabled|Status}} to {{enum|Trigger|Status}} to {{enum|Enabled|Status}}. If this SampleSet is enabled and {{param}} is in the range [1:{{param|ReportSamples}}] then {{param|Status}} MUST transition from {{enum|Enabled|Status}} to {{enum|Trigger|Status}} to {{enum|Enabled|Status}} on completion of every {{param}} sample intervals. Otherwise, the transition MUST NOT occur. - For example, if {{param|ReportSamples}} is 25 and {{param}} is 24, then the CPE will store 25 values for each monitored parameter and the above {{param|Status}} transition will occur as the CPE stores each 24th of 25 sample intervals, which means that the ACS could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also {{param|ForceSample}}). + For example, if {{param|ReportSamples}} is 25 and {{param}} is 24, then the CPE will store 25 values for each monitored parameter and the above {{param|Status}} transition will occur as the CPE stores each 24th of 25 sample intervals, which means that the Controller could delay for up to two sample intervals before reading the stored values and would still not miss any samples (see also {{param|ForceSample}}). To disable this trigger mechanism and still collect sampled statistics, {{param}} can be set to either 0 or a value greater than {{param|ReportSamples}}. @@ -40268,7 +43601,6 @@ - @@ -40444,7 +43776,7 @@ * "out of range (low)" : current value is less than or equal to {{param|LowThreshold}}. * "out of range (high)" : current value is greater than or equal to {{param|HighThreshold}}. Note that, if {{param|LowThreshold}} and {{param|HighThreshold}} are both the same, the threshold/failure mechanism is disabled, so the value of this parameter will not increment. - This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. For this reason, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the ACS of such changes, as described in {{bibref|TR-069a2|Section 3.2.1}}. + This parameter can be incremented at any time during a sample interval, and might be incremented more than once during a single sample interval. For this reason, the CPE SHOULD place a locally specified limit on the frequency at which it will notify the Controller of such changes. Parameters of non-numeric types cannot support the threshold/failure mechanism. The value of this parameter MUST be ignored for such parameters. @@ -40607,7 +43939,7 @@ Contains all currently active alarms (whose {{param|.FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity}} is not {{enum|Cleared|.FaultMgmt.SupportedAlarm.{i}.PerceivedSeverity}}). Newly raised alarms result in a new entry in this table being added, any changes to the alarm as a result of an update event are updated in the existing table entry, and a clear event raised against an alarm results in the alarm being removed from this table. If maximum entries as indicated by {{param|.FaultMgmt.MaxCurrentAlarmEntries}} is reached, the next event overrides the object with the oldest {{param|AlarmChangedTime}}. - When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm). + When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the Controller (even if their new values are identical to those of the prior alarm). @@ -40843,9 +44175,9 @@ Alarm events added or updated in {{object|.FaultMgmt.CurrentAlarm.{i}.}} are simultaneously entered into the this table if their corresponding entry in {{object|.FaultMgmt.SupportedAlarm.{i}.}} has {{param|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}} set to {{enum|0 Expedited|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}}. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to {{param|.FaultMgmt.ExpeditedEventNumberOfEntries}}. - Initially the table starts with all instances having {{param|EventTime}} set to the Unknown Time value, as defined in {{bibref|TR-106a4}}. + Initially the table starts with all instances having {{param|EventTime}} set to the Unknown Time value, as defined in {{bibref|TR-106}}. If maximum instance number {{param|.FaultMgmt.ExpeditedEventNumberOfEntries}} is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records. - When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm). + When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the Controller (even if their new values are identical to those of the prior alarm). @@ -40853,7 +44185,7 @@ Indicates the date and time when the alarm event occurs. - For an unpopulated entry, the value is the Unknown Time as defined in {{bibref|TR-106a4}}. + For an unpopulated entry, the value is the Unknown Time as defined in {{bibref|TR-106}}. @@ -40964,9 +44296,9 @@ Alarm events added or updated in {{object|.FaultMgmt.CurrentAlarm.{i}.}} are simultaneously entered into the this table if their corresponding entry in {{object|.FaultMgmt.SupportedAlarm.{i}.}} has {{param|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}} set to {{enum|1 Queued|.FaultMgmt.SupportedAlarm.{i}.ReportingMechanism}}. This table also contains alarm clearing events. This object has a fixed number of entries with instance numbers from 1 to {{param|.FaultMgmt.QueuedEventNumberOfEntries}}. - Initially the table starts with all instances having {{param|EventTime}} set to the Unknown Time value, as defined in {{bibref|TR-106a4}}. + Initially the table starts with all instances having {{param|EventTime}} set to the Unknown Time value, as defined in {{bibref|TR-106}}. If maximum instance number {{param|.FaultMgmt.QueuedEventNumberOfEntries}} is reached, the next event overrides the object with instance number 1. Subsequent entries override objects at sequentially increasing instance numbers. This logic provides for automatic "rolling" of records. - When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the ACS (even if their new values are identical to those of the prior alarm). + When a new alarm replaces an existing alarm, then all parameter values for that instance are considered as changed for the purposes of value change notifications to the Controller (even if their new values are identical to those of the prior alarm). @@ -40974,7 +44306,7 @@ Indicates the date and time when the alarm event occurs. - For an unpopulated entry, the value is the Unknown Time as defined in {{bibref|TR-106a4}}. + For an unpopulated entry, the value is the Unknown Time as defined in {{bibref|TR-106}}. @@ -41229,7 +44561,7 @@ An absolute time reference in UTC to determine when the CPE will initiate the periodic GPS scan. Each GPS scan MUST occur at (or as soon as possible after) this reference time plus or minus an integer multiple of the {{param|PeriodicInterval}}. {{param}} is used only to set the "phase" of the GPS scan. The actual value of {{param}} can be arbitrarily far into the past or future. For example, if {{param|PeriodicInterval}} is 86400 (a day) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then periodic GPS scans will occur every day at UTC midnight. These MUST begin on the very next midnight, even if {{param}} refers to a day in the future. - The Unknown Time value defined in {{bibref|TR-106a4|Section 3.2}} 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 PeriodicInformInterval. + The Unknown Time value defined in {{bibref|TR-106|Section 3.2}} 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 PeriodicInformInterval. If absolute time is not available to the CPE, its periodic GPS scan behavior MUST be the same as if {{param}} parameter was set to the Unknown Time value. @@ -41294,7 +44626,7 @@ Specifies the date and time, when the GPS scan last completed successfully. This value is retained across reboot and is only reset after another scan completes successfully or {{param|GPSReset}} is set to {{true}}. - The values for {{param|LockedLatitude}}, {{param|LockedLongitude}} and {{param|NumberOfSatellites}} correspond to this time. If a scan has never succeeded before, the value will be the Unknown Time value, as defined in {{bibref|TR-106a4|Section 3.2}}. + The values for {{param|LockedLatitude}}, {{param|LockedLongitude}} and {{param|NumberOfSatellites}} correspond to this time. If a scan has never succeeded before, the value will be the Unknown Time value, as defined in {{bibref|TR-106|Section 3.2}}. @@ -41416,7 +44748,7 @@ Represents the date and time when the last GPS Fix was acquired. - The Unknown Time value defined in {{bibref|TR-106a4|Section 3.2}} is used when {{param|GotFix}} is {{false}}. This applies too after a reboot of the device until a valid location is determined and {{param|GotFix}} transsitions to {{true}}. + The Unknown Time value defined in {{bibref|TR-106|Section 3.2}} is used when {{param|GotFix}} is {{false}}. This applies too after a reboot of the device until a valid location is determined and {{param|GotFix}} transsitions to {{true}}. @@ -41670,7 +45002,7 @@ An absolute time reference in UTC to determine when the device will initiate the periodic file upload. Each file upload MUST occur at this reference time plus or minus an integer multiple of the {{param|PeriodicUploadInterval}}. {{param}} is used only to set the "phase" of the periodic uploads. The actual value of {{param}} can be arbitrarily far into the past or future. For example, if {{param|PeriodicUploadInterval}} is 86400 (a day) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then periodic file uploads will occur every day at UTC midnight. These MUST begin on the very next midnight, even if {{param}} refers to a day in the future. - The Unknown Time value as defined in {{bibref|TR-106a4|Section 3.2}} 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 {{param|PeriodicUploadInterval}}. + The Unknown Time value as defined in {{bibref|TR-106|Section 3.2}} 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 {{param|PeriodicUploadInterval}}. If absolute time is not available to the device, its periodic file upload behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. @@ -41902,8 +45234,7 @@ This is the reference to the IPsec tunnel instance to be used by the Application Platform traffic. - If InternetGatewayDevice:1 {{bibref|TR-098}} or Device:1 {{bibref|TR-181i1}}) is used as root data model the {{param}} MUST point to a row in the ''.FAP.Tunnel.IKESA.{i}.'' table. - If the root data model used is Device:2 {{bibref|TR-181i2}} than the {{param}} MUST point to an tunnel instance defined in this data model. + The {{param}} MUST point to a tunnel instance defined in the data model. If the referenced object is deleted, the parameter value MUST be set to an empty string. @@ -42495,7 +45826,8 @@ This object provides bulk data collection capabilities and global collection settings that affect the entire device. Bulk Data utilizes various solutions (e.g., IPDR, HTTP) to collect data from devices and transfer the data to a collection server. The IPDR solution is based on a service specification described in {{bibref|TR-232}}. - The HTTP solution is based on transfer mechanisms described in {{bibref|TR-157a10|Annex A}}. + The HTTP solution is based on transfer mechanisms described in {{bibref|TR-369|Annex A}}. + The USPEventNotif solution is based on sending a Device.BulkData.Profile.{i}.Push! Event Notification via USP {{bibref|TR-369}}. The Bulk Data Collection Profiles are measured over a reporting interval (which can be aligned with absolute time) and are made available to the collection server. @@ -42564,6 +45896,11 @@ Hypertext Transfer Protocol {{bibref|RFC2616}} + + + User Services Platform (USP - {{bibref|TR-369|Annex A}}) Event Notiification + + @@ -42586,12 +45923,12 @@ - Comma Separated Values. Used with the HTTP Protocol. {{bibref|RFC4180}} + Comma Separated Values. Used with the HTTP and USPEventNotif Protocols. {{bibref|RFC4180}} - JavaScript Object Notation. Used with the HTTP Protocol {{bibref|RFC7159}} + JavaScript Object Notation. Used with the HTTP and USPEventNotif Protocols. {{bibref|RFC7159}} @@ -42607,7 +45944,7 @@ - The maximum number of profiles that can exist at any given time. Specifically, the maximum number of {{object|Profile.{i}.}} instances that the ACS can create. + The maximum number of profiles that can exist at any given time. Specifically, the maximum number of {{object|Profile.{i}.}} instances that the Controller can create. If the value of this parameter is -1, then it means that the CPE doesn't have a limit to the number of profiles that can exist. @@ -42639,7 +45976,7 @@ A set of Bulk Data Collection profiles. - Each profile represents a bulk data report, including its own timing configuration, communications configuration, and set of parameters. This allows the ACS to configure multiple reports to be generated at different times for different sets of data. + Each profile represents a bulk data report, including its own timing configuration, communications configuration, and set of parameters. This allows the Controller to configure multiple reports to be generated at different times for different sets of data. @@ -42740,7 +46077,7 @@ An absolute time reference in UTC to determine when will be transmitted. Each reporting interval MUST complete at this reference time plus or minus an integer multiple of {{param|ReportingInterval}}, unless unable to due to higher prioritized operations. {{param}} is used only to set the "phase" of the reporting intervals. The actual value of {{param}} can be arbitrarily far into the past or future. If {{param}} is changed while collection of bulk data is enabled, the first reporting interval begins immediately. - The Unknown Time value as defined in {{bibref|TR-106a2}} indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified reporting intervals. + The Unknown Time value as defined in {{bibref|TR-106}} indicates that no particular time reference is specified. That is, the CPE MAY locally choose the time reference, and is required only to adhere to the specified reporting intervals. If absolute time is not available to the CPE, its reporting interval behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. For example, if {{param|ReportingInterval}} is 86400 (a day) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then the CPE will generate (and transmit, if in a "ITPush" mode) its report at midnight every 24 hours. Note that, if {{param}} is set to a time other than the Unknown Time, the first reporting interval (which has to begin immediately) will almost certainly be shorter than {{param|ReportingInterval}}). This is why {{param}} is defined in terms of when reporting intervals complete rather than start. @@ -42774,7 +46111,7 @@ This is the unique identification of an IPDR Session to be used when this collection profile is configured for the IPDR Streaming Protocol {{bibref|IPDR-SP}} (the {{param|Protocol}} parameter has a value of {{enum|Streaming|#.Protocols}}). - An ACS MUST NOT configure multiple IPDR Streaming Protocol collection profiles with the same {{param}}. Doing so MUST cause the CPE to fail the SetParameterValues. + A Controller MUST NOT configure multiple IPDR Streaming Protocol collection profiles with the same {{param}}. Doing so MUST cause the CPE to fail the SetParameterValues. Within the IPDR Streaming Protocol specification the Session ID has a type of a single 'char', but we are restricting the range even further (ASCII values of '0' - '9' and 'A' - 'Z'. @@ -42840,6 +46177,19 @@ + + + Bulk Data Push event for delivering a bulk data report within a USP Notification message. + + + + The contents of the bulk data report in the configured CSV or JSON Encoding Type. + + + + + + @@ -42850,7 +46200,7 @@ Name of the parameter in the report body. If the value of this parameter is {{empty}}, then the value of the {{param|Reference}} parameter is used as the name. - When the value {{param|Reference}} parameter contains wildcards and/or partial parameter names, the rules for determining the value of this parameter are specified in {{bibref|TR-157a10|Annex A.3.2.1}}. + When the value {{param|Reference}} parameter contains wildcards and/or partial parameter names, the rules for determining the value of this parameter are specified in {{bibref|TR-369|Annex A.2.3}}. @@ -42906,7 +46256,7 @@ - This parameter describes the formatting used for reports defined by this profile as described in {{bibref|TR-157a10|Annex A.3.4}}. + This parameter describes the formatting used for reports defined by this profile as described in {{bibref|TR-369|Annex A.2.5}}. Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in {{bibref|RFC2616}}. @@ -42938,7 +46288,7 @@ - Timestamp is inserted using the ISO-8601 timestamp format. If the CPE is unable to acquire a time, then the processing described by the dateTime type in {{bibref|TR-069|Table 12}} is followed. + Timestamp is inserted using the ISO-8601 timestamp format{{templ|BULK-DATA-TIMESTAMP}} @@ -42957,7 +46307,7 @@ - This parameter describes the formatting used for the report as described in {{bibref|TR-157a10|Annex A.3.5}}. + This parameter describes the formatting used for the report as described in {{bibref|TR-369|Annex A.2.6}}. Note: This parameter is encoded as a token in the BBF-Report-Format header field and MUST NOT include spaces or other characters excluded from token characters defined in {{bibref|RFC2616}}. @@ -42978,7 +46328,7 @@ - The format of timestamp to use for the JSON Object named "CollectionTime" as described in {{bibref|TR-157a10}}. + The format of timestamp to use for the JSON Object named "CollectionTime" as described in {{bibref|TR-369|Annex A.2.6.1}}. @@ -42989,7 +46339,7 @@ - Timestamp is inserted using the ISO-8601 timestamp format. If the CPE is unable to acquire a time, then the processing described by the dateTime type in {{bibref|TR-069|Table 12}} is followed. + Timestamp is inserted using the ISO-8601 timestamp format. {{templ|BULK-DATA-TIMESTAMP}} @@ -43123,8 +46473,8 @@ - Configures the data transfer retry wait interval, in seconds, as specified in {{bibref|TR-157a10|Annex A.2.2.1}}. - 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 wait interval, in seconds, as specified in {{bibref|TR-369|Annex A.1.2.1}}. + 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. @@ -43135,9 +46485,9 @@ - Configures the retry interval multiplier as specified in {{bibref|TR-157a10|Annex A.2.2.1}}. - 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. + Configures the retry interval multiplier as specified in {{bibref|TR-369|Annex A.1.2.1}}. + 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. @@ -43168,7 +46518,7 @@ - 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 {{bibref|TR-157a10|Annex A.2.1}}. + 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 {{bibref|TR-369|Annex A.1.1}}. @@ -43194,9 +46544,2496 @@ + + + This object contains general information about the USP Agent itself. For information related to the Device that hosts the Agent, please reference the {{object|.DeviceInfo}} object. + NOTE: The Vendor Log File table ({{object|.DeviceInfo.VendorLogFile}}) details are located on the {{object|.DeviceInfo}} object. + + + + The unique USP identifier for this USP Agent. + + + + + + + + The current USP Agent software version; not the version of the overall device firmware, which is located in {{param|.DeviceInfo.SoftwareVersion}}. + To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, ''3.0.21'' where the components mean: ''Major.Minor.Build''. + + + + + + + + + + Time in {{units}} since the USP Agent was last restarted (either via a reset of the software or reboot of the underlying device). + + + + + + + + + + Periodic event configured via the recipient Controller's {{param|Controller.{i}.PeriodicNotifInterval}} and {{param|Controller.{i}.PeriodicNotifTime}} parameters. + + + + + Wake-up event. + + + + + Indicates that a file has been transferred to or from the Device. The event is sent when the transfer has either completed successfully (in which case {{param|FaultCode}} will be zero), or else has failed (in which case {{param|FaultCode}} will be non-zero and {{param|FaultString}} will give further details). + The file transfer can be requested via a USP operation or via some other mechanism. If it's requested via a USP operation {{param|Command}}, {{param|CommandKey}} and {{param|Requestor}} give further details. + + + + The Path Name of the command that requested the transfer, or {{empty}} if the transfer was not requested via a USP operation. + + + + + + + + The ''command_key'' supplied when requesting the transfer, or {{empty}} if the transfer was not requested via a USP operation. + + + + + + + + + The Endpoint ID of the Controller that requested the transfer, or {{empty}} if no Controller requested it. + + + + + + + + + The type (direction) of the transfer. + + + + + + Downstream transfer; to the Agent. + + + + + Upstream transfer; from the Agent. + + + + + + + + + The Path Name of the Object or Object Instance that was affected by the transfer, or {{empty}} if no data model object was affected by the transfer. + + + + + + + + + The URL from or to which this transfer was performed, or {{empty}} if no such URL is available. + + + + + + + + + + + The date and time in UTC at which the transfer was started. The Device SHOULD record this information and report it in this argument, but if this information is not available, the value of this argument MUST be set to the ''Unknown Time'' value. + + + + + + + + + The date and time in UTC at which the transfer was fully completed. This need only be filled in if the transfer has been fully completed. The Device SHOULD record this information and report it in this argument, but if this information is not available or the transfer has not completed, the value of this argument MUST be set to the ''Unknown Time'' value. + + + + + + + + + The numerical fault code as defined in {{bibref|TR-369}}. A value of 0 (zero) indicates no fault. + + + + + + + + + A human-readable text description of the fault. This field SHOULD be {{empty}} if the {{param|FaultCode}} equals 0 (zero). + + + + + + + + + + + + This command is issued to allow a Controller (with the proper permissions) to add a new certificate to {{object|#.Certificate.{i}}}. This does not automatically produce a trust relationship with the host identified by the Certificate. To produce a trust relationship, an entry is required to exist in {{param|#.Controller.{i}.Credential}} or {{param|#.ControllerTrust.Credential.{i}.Credential}} that references the new {{object|#.Certificate.{i}}} entry. The Agent will use the Serial Number and Issuer fields from the input {{param|Certificate}} to populate the {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters. If {{object|#.Certificate}} already has an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters, this command will fail. To replace an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}}, the existing instance must first be deleted. + + + + Input arguments. + + + + An optional input the Controller can use to specify the {{param|##.Certificate.{i}.Alias}} value for the added entry. If provided as an input and the value already exists in {{object|##.Certificate.{i}}}, this commmand will fail. + + + + + + + + The X.509 certificate in Privacy-enhanced Electronic Mail (PEM) {{bibref|RFC7468}} format. + + + + + + + + + + + + USP Message Transfer Protocols supported by this USP Agent. The USP Agent MUST support at least one Protocol. + + + + + + + See {{bibref|RFC7252}} + + + + + See {{bibref|RFC6455}} + + + + + See {{bibref|STOMP1.2}} + + + + + See {{bibref|MQTT311}} and {{bibref|MQTT50}} + + + + + + + + {{list|each entry is an algorithm for calculating firgerprints that is supported by the Agent}} + + + + + + + As specified in {{bibref|RFC3174}}. + + + + + As specified in {{bibref|RFC6234}}. + + + + + As specified in {{bibref|RFC6234}}. + + + + + As specified in {{bibref|RFC6234}}. + + + + + As specified in {{bibref|RFC6234}}. + + + + + + + + {{list|each entry is a threshold operation for {{param|Threshold.{i}.ThresholdOperator}} supported by the Agent}} + + + + + + + Parameter value changes from below the {{param|Threshold.{i}.ThresholdValue}} to a value above + + + + + Parameter value changes from above the {{param|Threshold.{i}.ThresholdValue}} to a value below + + + + + Parameter value either changes from above the {{param|Threshold.{i}.ThresholdValue}} to a value below or vice versa + + + + + Parameter value changes from any value to the {{param|Threshold.{i}.ThresholdValue}} + + + + + Parameter value changes from the {{param|Threshold.{i}.ThresholdValue}} to any other value + + + + + + + + {{list|each entry is a subtype component of the service type that is advertised for the device using mDNS as defined in {{bibref|RFC6762}}}} + + + + + + + + + The acceptable amount of time in {{units}} between the alteration of the Agent's Subscriptions (e.g. updated subscription, new subscription, removed subscription, etc.) and the notifications related to those subscriptions being delivered. + For example, if this parameter is set to 30 {{units}}, then once a Subscription has been updated, the Agent has 30 {{units}} before it needs to start delivering notifications based on the updated version of the Subscription (instead of the old version of the Subscription). + + + + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + + Each instance of this table represents a MTP used by the local Agent. + + + + + + + {{datatype|expand}} + + + + + + + + Enable/Disable this {{object}} instance. + If this {{object}} instance is to be disabled and currently used for communication with the requesting controller, the agent has to send the request response first, before disabling it. + + + + + + + + + The current operational state of the {{object}} instance. + + + + + + + Value when this {{object}} instance cannot establish communication. + + + + + Value when this {{object}} instance is misconfigured. + + + + + + + + The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint. + + + + + + + + + + + This parameter, when {{true}}, enables the advertisement of DNS-SD services defined for this {{object}} instance using mDNS as defined in {{bibref|RFC6762}}. + This parameter cannot be set to {{true}} if there are multiple {{object}} instances with the same value of the {{param|Protocol}} parameter. + When {{true}}, the hostname advertised in the SRV record MUST be a Fully Qualified Domain Name (FQDN). + The interfaces that advertise these DNS-SD services are restriced to the set of interfaces associated with this {{object}} instance and the interfaces defined by the {{param|##.DNS.SD.AdvertisedInterfaces}} parameter. + + + + + + + + + + If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters. + + + + {{reference|the {{object|###.IP.Interface}} object instance that this server will use as its host address to receive USP messages}} + {{empty}} will bind this server to all interfaces for this device. + + + + + + + + + + + The port number used by the CoAP Server to receive USP messages. + + + + + + + + + + + The path that is used by the CoAP Server in order to receive USP messages. + + + + + + + + This parameter represents whether or not communications that utilize this {{object}} object instance are encrypted. + + + + + + + + When {{true}}, encryption is used for this MTP instance. + + + + + + + + + + If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how the Agent communicates with the STOMP Server. + + + + A reference to the STOMP Connection used by this Agent when communicating via the STOMP MTP. + + + + + + + + + + + The STOMP destination where the Agent will be listening to incoming USP messages. + + + + + + + + + The STOMP destination contained in the subscribe-dest header of the CONNECTED STOMP Frame. + If the Agent doesn't receive a subscribe-dest header in the CONNECTED STOMP Frame, then the value of this Parameter is {{empty}}. + If this parameter's value is not empty then this is the STOMP destination address for this Agent, but if the value is empty the {{param|Destination}} Parameter contains the STOMP destination address for this Agent. + + + + + + + + + + If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket server, then this object contains WebSocket specific configuration parameters. + + + + {{reference|the {{object|###.IP.Interface}} object instance that this server will use as its host address to receive USP messages}} + {{empty}} will bind this server to all interfaces for this device. + + + + + + + + + + + The port number used by the WebSocket Server to receive USP messages. + + + + + + + + + + + The path that is used by the WebSocket Server in order to receive USP messages. + + + + + + + + + If the USP Endpoint uses the MQTT Message Transport Protocol (MTP), then this object contains MQTT Client specific configuration parameters related to how the Agent communicates with the MQTT broker. + + + + A reference to the MQTT Client used by this Agent when communicating via the MQTT MTP. + + + + + + + + + + + The Agent's configured "reply to" topic. When MQTT 5.0 is being used, this value is put in the PUBLISH Response Topic property for all PUBLISH packets with a USP Record, if no Response Information (value recorded in {{param|ResponseTopicDiscovered}}) is included in the CONNACK. When MQTT 3.1.1 is being used, this value is put at the end of the PUBLISH Topic Name property (as specified in {{bibref|TR-369|Section "MQTT Binding"}}. If the value of {{param}} is not a subset (wildcarded or precise match) of any of the {{param|Reference}} {{param|.MQTT.Client.{i}.Subscription.{i}.Topic}} values the Agent MUST subscribe to this Topic. The value MUST NOT contain any wild card characters (“+”, “#”). + + + + + + + + + + Duplicate of {{param|Reference}} {{param|.MQTT.Client.{i}.ResponseInformation}}. This is the value of the CONNACK Response Information property supplied by a MQTT 5.0 server and is used by a MQTT 5.0 client as the basis for the PUBLISH Response Topic property for all PUBLISH packets that expect a response. If a value is received from the MQTT 5.0 server, it will be used instead of any value configured in {{param|ResponseTopicConfigured}}. + + + + + + + + + + The Agent MUST use this QoS value when sending a USP Record on this MTP. + If the referenced MQTT Client uses MQTT 5.0 and the MQTT server only indicates support for a QoS value in the CONNACK Maximum QoS property lower than this QoS value, the Agent MUST use the highest QoS value that is supported by the server. + + + + + + + + + + + Each instance of this table represents a Threshold Event that is triggered by a threshold test. + For example: + ReferencePath: Device.Ethernet.[Enable==1].Stats. + ThresholdParam: BytesSent + ThresholdOperator: Rise + ThresholdValue: 100000 + Would trigger a {{event|Triggered!}} Event whenever a value of a parameter matching Device.Ethernet.[Enable==1].Stats.BytesSent rises from below to above 100000. + + + + + + + {{datatype|expand}} + + + + + + + + Enable/Disable this {{object}} instance. + If the {{object}} instance is disabled, the {{event|Triggered!}} Event will not be invoked, even if there is a {{object|.LocalAgent.Subscription.{i}.}} instance that references it + + + + + + + + + Determines whether to disable this {{object}} instance after the {{event|Triggered!}} Event has been invoked. + + + + + + The {{object}} will generate events as long as the {{param|Enable}} is {{true}} + + + + + After invoking the {{event|Triggered!}} Event, the {{param|Enable}} parameter will be automatically set to {{false}} + + + + + + + + + The combination of {{param}} and {{param|ThresholdParam}} create the reference to the parameter being checked for the threshold test. + {{param}} can be either an Object Path or a Search Path. + + + + + + + + The combination of {{param|ReferencePath}} and {{param}} create the reference to the parameter being checked for the threshold test. + {{param}} is the name of the Parameter in the context of {{param|ReferencePath}}. + + + + + + + + The operator used for the threshold test. + + + + + + + + + + + The Value used for the threshold test. + + + + + + + + Triggered event requested via a {{object}} object. + When any of the {{param|##.Threshold.{i}.ThresholdParam}}s that are in the {{param|##.Threshold.{i}.ReferencePath}} change and the threshold test conditation changes from {{false}} to {{true}}, the Triggered Event will be invoked. The Triggered Event will only be eligible for retriggering if the test condition is fulfilled again. + + + + The parameter ({{param|.LocalAgent.Threshold.{i}.ReferencePath}} and {{param|.LocalAgent.Threshold.{i}.ThresholdParam}}) for which the threshold has been triggered. + + + + + + + + The new ({{param|.LocalAgent.Threshold.{i}.ReferencePath}} and {{param|.LocalAgent.Threshold.{i}.ThresholdParam}}) Value. + + + + + + + + + + Each instance of this table represents a USP Controller that has access to this USP Agent. + + + + + + + + + + {{datatype|expand}} + + + + + + + + The unique USP identifier for this USP Controller. + + + + + + + + + Information about the configuration state of an Agent as it pertains to the {{object}} instance. This is not information related to an operator's installation or usage of the protocol, that information is maintained in {{param|ProvisioningCode}}. + This parameter could be used in scenarios where the Controller needs to perform some kind of initialization or periodic configuration monitoring. For example, a Controller might perform some initial configuration of an Agent on first contact (perhaps to configure the Subscriptions). The Controller could inspect this parameter to determine the current state of the Agent's configuration, allowing the Controller to streamline the configuration process. + + + + + + + + + + + Identifying information which MAY be used by the {{object}} instance to determine {{object}} instance specific customization and provisioning parameters. + + + + + + + + + + + Enable/Disable this {{object}} instance. + If the Controller instance is to be disabled, the USP Endpoint MUST terminate the MTP connection. When {{false}}, messages (notifications) are not sent to the remote endpoint represented by this {{object}} instance, and any MTP session establishment are refused. + + + + + + + + + {{list|each entry is a Role that has been assigned to this {{object}} instance by means other than the {{param|.LocalAgent.ControllerTrust.Credential.{i}.Role}} parameter}} + + + + + + + + + + + {{list|each entry is a Role that has been assigned to this {{object}} instance from the {{param|.LocalAgent.ControllerTrust.Credential.{i}.Role}} parameter associated with the CA credential ({{param|.LocalAgent.ControllerTrust.Credential.{i}.Credential}}) used to validate the Controller certificate}} + + + + + + + + + + + {{nolist}} + Comma-separated list of strings, the set of certificates from {{object|#.Certificate.{i}}} that a Controller can present for use in authenticating the identity of this {{object}} instance. + + + + + + + + + + If a Periodic Event Notification {{object|#.Subscription}} instance is associated with this USP Controller, then this is the duration in {{units}} of the interval for which the USP Agent MUST attempt to issue a Periodic Notification to the USP Controller. + + + + + + + + + + + If a Periodic Event Notification {{object|#.Subscription}} instance is associated with this USP Controller, then this is an absolute time reference in UTC to determine when the USP Agent will issue a Periodic Notification. Each Periodic Notification MUST occur at this reference time plus or minus an integer multiple of the {{param|PeriodicNotifInterval}}. + {{param}} is used only to set the ''phase'' of the Periodic Event Notifications. The actual value of {{param}} can be arbitrarily far into the past or future. + For example, if {{param|PeriodicNotifInterval}} is 86400 (a day) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then Periodic Notifications will be sent every day at UTC midnight. These MUST begin on the very next midnight, even if {{param}} refers to a day in the future. + The Unknown Time value defined in {{bibref|TR-106|section 3.2}} indicates that no particular time reference is specified. That is, the USP Agent MAY locally choose the time reference, and needs only to adhere to the specified {{param|PeriodicNotifInterval}}. + If absolute time is not available to the USP Agent, its Periodic Notification behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. + + + + + + + + This parameter is related to the retry mechanism for Notifications. + Configures the first retry wait interval, in {{units}}, as specified in {{bibref|TR-369|Section "Responses to Notifications and Notification Retry"}}. + A value of 5 corresponds to the default behavior. + The USP Agent MUST use a random value between {{param}} and ({{param}} * {{param|USPNotifRetryIntervalMultiplier}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. + + + + + + + + + + + + This parameter is related to the retry mechanism for Notifications. + Configures the retry interval multiplier as specified in {{bibref|TR-369|Section "Responses to Notifications and Notification Retry"}}. + This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. + A value of 2000 corresponds to the default behavior. + The USP Agent MUST use a random value between {{param|USPNotifRetryMinimumWaitInterval}} and ({{param|USPNotifRetryMinimumWaitInterval}} * {{param}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. + + + + + + + + + + + Schedule a ''Timer!'' event on the associated {{object}}. + + + + Input arguments. + + + + The number of seconds from the time this command is invoked until the Agent initiates a Timer! Event notification (based on the associated subscriptions). + + + + + + + + + + + + + + Timer event requested via a ScheduleTimer() command invoked on the same Controller instance via an Operate USP message. + + + + The ''command_key'' supplied when requesting the timer event. + + + + + + + + + This command is issued to allow a Controller to add a new certificate for itself. This can be useful when the current certificate is expiring or has become compromised. This command creates a new entry in {{object|#.Certificate}} and adds a reference to the new entry to the Controller's {{param|#.Controller.{i}.Credential}}. The Agent will use the Serial Number and Issuer fields from the input {{param|Certificate}} to populate the {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters. If {{object|#.Certificate}} already has an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters, this command will fail. To replace an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}}, the existing instance must first be deleted. + + + + Input arguments. + + + + An optional input the Controller can use to specify the {{param|###.Certificate.{i}.Alias}} value for the added entry. If provided as an input and the value already exists in {{object|###.Certificate.{i}}}, this commmand will fail. + + + + + + + + The X.509 certificate in Privacy-enhanced Electronic Mail (PEM) {{bibref|RFC7468}} format. + + + + + + + + + + + + Requests the Agent to send an ''OnBoardRequest'' notification to this Controller. + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + + Each instance of this table represents a MTP used by this Controller. + + + + + + + + + + {{datatype|expand}} + + + + + + + + Enable/Disable this {{object}} instance. + If this {{object}} instance is to be disabled and currently used for communication with the requesting controller, the agent has to send the request response first, before disabling it. + + + + + + + + + The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint. + + + + + + + + + + + + If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters. + + + + The hostname or IP Address of the Controller's CoAP server. + + + + + + + + + + The port number used by the Controller's CoAP Server to receive USP messages. + + + + + + + + + + The path that is used by the Controller's CoAP Server in order to receive USP messages. + + + + + + + + When {{true}}, encryption is used as specified in {{bibref|TR-369|Section "MTP Message Encryption"}}. + + + + + + + + + + If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how this Controller communicates with the STOMP Server. + + + + A reference to the STOMP Connection used by this Controller when communicating via the STOMP MTP. + + + + + + + + + + + The STOMP destination where the Controller will be listening to incoming USP messages. + + + + + + + + + + If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket client, then this object contains WebSocket specific configuration parameters. + + + + The hostname or IP Address of the Controller's WebSocket server. + + + + + + + + + + The port number used by the Controller's WebSocket server to receive USP messages. + + + + + + + + + + The path that is used by the Controller's WebSocket server in order to receive USP messages. + + + + + + + + This parameter represents whether or not communications that utilize this {{object}} object instance are encrypted. + + + + + + + + The the duration in {{units}} between when WebSocket ping control frames are transmitted by the Agent to the WebSocket server for the USP Controller. + + + + + + + + + + + The current retry count of the session. When zero (0), the session is not in a retry state. + + + + + + + + Configures the first retry wait interval, in {{units}}, as specified in {{bibref|TR-369|Section "WebSocket Session Retry"}}. + The USP Agent MUST use a random value between {{param}} and ({{param}} * {{param|SessionRetryIntervalMultiplier}} / 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 retry interval multiplier as specified in {{bibref|TR-369|Section "WebSocket Session Retry"}}. + This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. + The USP Agent MUST use a random value between {{param|SessionRetryMinimumWaitInterval}} and ({{param|SessionRetryMinimumWaitInterval}} * {{param}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. + + + + + + + + + + + If enabled, this command will either request to start or restart an WebSocket session with the Controller. + + + + + + If the USP Endpoint uses the MQTT Message Transport Protocol (MTP), then this object contains MQTT Client specific configuration parameters related to how this Controller communicates with the MQTT broker. + + + + A reference to the MQTT Client used by this Controller when communicating via the MQTT MTP. + + + + + + + + + + + The topic name the USP Controller has subscribed to, to be used for Notify messages send by the USP Agent. + + + + + + + + + + + The policy defined in this object determines the conditions under which the USP Agent notifies a USP Controller, that has an appropriate Subscription, of the completion of file transfers. + + + + Indicates the transfer results that MUST be included when the USP Agent notifies a USP Controller of file transfers. Transfer results omitted from this list MUST NOT be included when the USP Agent notifies a USP Controller. + + + + + + The autonomous file transfer completed successfully; i.e., the {{event|##.TransferComplete!}} event's {{param|##.TransferComplete!.FaultCode}} was zero + + + + + The autonomous file transfer did not complete successfully; i.e., the the {{event|##.TransferComplete!}} event's {{param|##.TransferComplete!.FaultCode}} was non-zero + + + + + Success and Failure + + + + + + + + + This table provides the Controller with the ability to dictate the Parameters that are delivered via ''Boot!'' events. + Any Parameter (identified by {{param|ParameterName}}) contained in this table MUST be included within the ''param_map'' element of the ''Boot!'' event. + + + + + + + + + + {{datatype|expand}} + + + + + + + + Enables or disables this {{object}}. + + + + + + + + + A pattern that describes the Parameter(s) to be included in the ''param_map'' element of a ''Boot!'' event. Specifically, patterns with wildcards (an "*" character) in place of Instance Identifiers are allowed. + If the pattern does not match any existing Parameters at the time that the Agent is creating the ''Boot!'' event, then this {{object|#.BootParameter}} instance is not included in the ''param_map'' of the ''Boot!'' event. + + + + + + + + + + + + The {{object}} object represents the End to End (E2E) Session Context functionality for this {{object|##.Controller.{i}}} object instance. + + + + Enable/Disable this {{object}} instance. + When {{true}}, Session Context is used when exchanging USP Records with the remote endpoint represented by this {{object|##.Controller.{i}}} object instance. + When {{false}}, Session Context is not used when exchanging USP Records with the remote endpoint represented by this {{object|##.Controller.{i}}} object instance. + + + + + + + + + The current status of the Session Context. + + + + + + + A new Session Context is being negotiated (i.e., a USP Record with sequence_id of 0 and session_id not previously used with this remote endpoint was sent and response has not yet been received). + + + + + + + + + The duration in {{units}} in which the current Session Context will expire since the last session-related activity (e.g., Message sent or received, Session Context start or restart). + A value of 0 means session expiration is disabled. + + + + + + + + + + + + Configures the first retry wait interval, in {{units}}, as specified in {{bibref|TR-369|Section "Failure Handling in the Session Context"}}. + A value of 5 corresponds to the default behavior that is described in {{bibref|TR-369}}. + The USP Agent MUST use a random value between {{param}} and ({{param}} * {{param|SessionRetryIntervalMultiplier}} / 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 retry interval multiplier as specified in {{bibref|TR-369|Section "Failure Handling in the Session Context"}}. + This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. + A value of 2000 corresponds to the default behavior that is described in {{bibref|TR-369}}. + The USP Agent MUST use a random value between {{param|SessionRetryMinimumWaitInterval}} and ({{param|SessionRetryMinimumWaitInterval}} * {{param}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. + + + + + + + + + + + The current retry count of the Session Context. When zero (0), the Session Context is not in a retry state. + + + + + + + + The maximum size, in {{units}}, of the Record (payload(s) and headers) that can be transmitted to the remote endpoint. The smallest size, which can be configured is 512 bytes. + A value of 0 means that the segmentation function is effectively disabled. + + + + + + + + + + + + + The maximum times that a USP Endpoint attempts to retransmit the requested USP Record to the remote endpoint. + If the maximum tries is met for any requested USP Record, the USP Endpoint will restart the E2E Session. + A value of -1 means that the USP Endpoint will always attempt to retransmit the requested USP Record. + A value of 0 means that the USP Endpoint will not attempt to retransmit the requested USP Record and will restart the E2E Session. + + + + + + + + + + + The security mechanism to use when exchanging the payload of the Record with the remote endpoint. + + + + + + + The payload is encrypted at the originating endpoint and decrypted at the receiving endpoint using TLS. + The procedures for using TLS in a Session Context is defined in {{bibref|TR-369}}. + + + + + + + + + If the {{object}} is enabled then this command will either request to start or restart a Session Context with the remote endpoint. + If the {{object}} is not enabled and there is an active Session Context then this command will terminate that Session Context with the remote endpoint. + If the {{object}} is not enabled and there is no active Session Context then this command does nothing. + + + + + + A Subscription dictates how a USP Agent issues USP Notification Messages to a USP Controller. + + + + + + + + + + + {{datatype|expand}} + + + + + + + + Enables/disables this {{object}}. A disabled entry MUST NOT be processed by the USP Agent. + + + + + + + + + {{reference|the {{object|#.Controller}} instance that will receive the Notification associated with this {{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. + + + + + + + + + + Unique identifier of the {{object}} itself, which is specific to the USP Controller that creates the instance of the {{object}}. + This value is also populated in the ''subscription_id'' element of every Notification message sent from a USP Agent to a USP Controller. + + + + + + + + + + + The date and time when this instance of {{object}} was created. This is internally used by the {{param|TimeToLive}} parameter to determine the expiration of this {{object}} instance. + The value of this parameter is automatically populated by the USP Agent upon {{object}} creation. + + + + + + + + Type of Notification message that will be sent to the USP Controller specified by {{param|Recipient}} when this {{object}} is triggered. + + + + + + + + + + + + + + Each entry in the list is a Path Name, Search Path, Command reference, or Event reference that determines the element(s) of the data model that the {{object}} is applicable to. + Different values of the {{param|NotifType}} parameter will cause the {{object}} to interact with {{param}} differently. For example, an instance of {{object}} with {{enum|ValueChange|NotifType}} will utilize the value of this parameter differently than an instance with {{enum|Event|NotifType}}. + Once the value of the {{param}} is written, the value cannot be changed as the {{object}} instance is considered to be immutable. If the value of a non-empty {{param}} parameter needs to change, the {{object}} instance MUST be deleted and a new {{object}} instance created. + The following bullet points describe what is allowed as a value of {{param}} based on the different values of the {{param|NotifType}} parameter: + * ValueChange: may be either a Path Name or Search Path; if an Object Path (one type of Path Name) then it is treated like a filter match such that all supported parameters in all objects below this point will be relevant for the subscription. + * ObjectCreation: may be either a Path Name or Search Path as long as it only refers to a Multi-Instance Object; only the referenced Multi-Instance Objects will be relevant for the subscription. + * ObjectDeletion: may be either a Path Name or Search Path as long as it only refers to instances of a Multi-Instance Object; only the referenced instances (wildcard references all instances over time) of the Multi-Instance Objects will be relevant for the subscription. + * OperationComplete: may be either a Path Name, Search Path, or Command reference; if an Object Path (one type of Path Name) then it is treated like a filter match such that all supported data model commands in all objects below this point will be relevant for the subscription. + * Event: may be either a Path Name, Search Path, or Event reference; if an Object Path (one type of Path Name) then it is treated like a filter match such that all supported Events in all objects below this point will be relevant for the subscription. + + + + + + + + + + + Determines whether or not this {{object}} remains after the USP Agent is restarted (either via a reset of the software or reboot of the underlying device). + If {{true}}, this {{object}} stays in existence until either a Delete message removes it or the {{param|TimeToLive}} parameter expires. + If {{false}}, this {{object}} is automatically removed by the USP Agent whenever it is restarted. + + + + + + + + + Specifies the duration of time (in {{units}}) that this {{object}} remains in existence. After {{param}} has expired, this {{object}} instance is automatically removed by the USP Agent. + If the value of {{param}} is 0, then this parameter is ignored and this {{object}} stays in existence until either a Delete message removes it or the {{param|Persistent}} parameter determines that it needs to be removed. + If the value of {{param}} is greater than 0, then this parameter determines the length of time (from {{object}} creation) until it will be automatically removed by the USP Agent (unless the {{param|Persistent}} parameter is {{false}} and the USP Agent is restarted, in which case it will be removed before the {{param}} expiration). NOTE: This paramater does not count down as time moves forward; it will always read back with the same value that it was last set to. + If the USP Agent is incapable of maintaining absolute time then {{param}} will automatically expire if the USP Agent is restarted (either via a reset of the software or reboot of the underlying device) before {{param}} expiration. + + + + + + + + + + + Specifies whether or not the USP Agent attempts to re-deliver the Notification in the event that it could not be delivered to the USP Controller. + When {{param}} is {{true}}, the USP Agent MUST retry the delivery of the Notification. This implies that the Notification MUST be generated with the "send_resp" flag set to {{true}} such that the USP Agent knows when the Notification has been successfully delivered. The retry attempt(s) are performed using the retry algorithm defined in {{bibref|TR-369|Section "Responses to Notifications and Notification Retry"}}. + When {{param}} is {{false}}, the USP Agent MUST NOT retry the delivery of the Notification, and SHOULD generate the notification with "send_resp" flag set to {{false}}. + + + + + + + + + Specifies the duration of time (in {{units}}) that the Notification associated with this {{object}} will continue to be retried. After {{param}} has expired, if the Notification has still not been successfully delivered then the USP Agent MUST stop attempting to re-deliver the Notification. + If {{param|NotifRetry}} is set to {{false}} then this parameter is ignored. + If {{param|NotifRetry}} is set to {{true}} and the value of {{param}} is 0, then the USP Agent will attempt to re-deliver the Notification until it has been successfully delivered or until the USP Agent is restarted (either via a reset of the software or reboot of the underlying device). + If {{param|NotifRetry}} is set to {{true}} and the value of {{param}} is greater than 0, then the USP Agent will attempt to re-deliver the Notification until either it has been successfully delivered, until the length of time (from the time tha the Notification was initially attempted to be delivered) specified in this parameter expires, or until the USP Agent is restarted (either via a reset of the software or reboot of the underlying device). + NOTE: This paramater does not count down as time moves forward; it will always read back with the same value that it was last set to. + + + + + + + + + + + + {{object}} instances are created using USP ''Operate'' messages. Only ''Operate'' messages with ''async''=''true'' will create a {{object}} instance in the data model. + When the command of the ''Operate'' completes, then this {{object}} instance is removed from this table. + + + + + + + + + + + + {{datatype|expand}} + + + + + + + + The USP Endpoint Identifier that originated the command. + + + + + + + + The command to be executed. This parameter is a Path Name that addresses a Command in an Object or Object Instance. + The command is a result of the evaluation of the ''command'' argument of an ''Operate'' message. + + + + + + + + The ''command_key'' from the USP ''Operate'' message. + + + + + + + + The operational status of the request to execute the command. + + + + + + The command has been requested but is currently not executing. + + + + + The command is currently executing. + + + + + The command has been requested to be canceled. + + + + + The command has successfully been canceled. + + + + + The command has successfully been completed its execution. + + + + + The command has unsuccessfully completed its execution or has unsuccessfully been canceled. + + + + + + + + Request cancelation of this {{object}}'s command. + This command completes immediately. If successful, {{param|Status}} will immediately change to {{enum|Canceling|Status}} and will change to {{enum|Canceled|Status}} when the cancelation is complete. + + + + + + Each instance of this table represents information related to a X.509 certificate (see {{bibref|RFC5280}}) of a Controller or Certificate Authority. Instances are referenced from {{param|##.LocalAgent.Controller.{i}.Credential}} and {{param|##.LocalAgent.ControllerTrust.Credential.{i}.Credential}}. + + + + + + + + + + + {{datatype|expand}} + + + + + + + + Enable/Disable this {{object}} instance. + + + + + + + + The Serial Number field in an X.509 certificate, see {{bibref|RFC5280}}. + + + + + + + + + + The Issuer field in an X.509 certificate, see {{bibref|RFC5280}}; i.e. the Distinguished Name (DN) of the entity who has signed the certificate. + + + + + + + + + + This command is issued to allow a Controller (with the proper permissions) to delete an entry from the {{object|##.Certificate.{i}}}. It also removes references to the Certificate in {{param|##.LocalAgent.Controller.{i}.Credential}} or {{param|##.LocalAgent.ControllerTrust.Credential.{i}.Credential}} and removes any X.509 certificate data the Agent had stored related to the entry. + + + + + This command is issued to allow a Controller to request the value of a fingerprint calculated for the specified table entry using the input {{param|FingerprintAlgorithm}}. + + + + Input arguments. + + + + The algorithm to be used to calculate the requested fingerprint. The value MUST be one the Agent supports, as noted in {{param|###.SupportedFingerprintAlgorithms}}. + + + + + + As specified in {{bibref|RFC3174}}. + + + + + As specified in {{bibref|RFC6234}}. + + + + + As specified in {{bibref|RFC6234}}. + + + + + As specified in {{bibref|RFC6234}}. + + + + + As specified in {{bibref|RFC6234}}. + + + + + + + + + Output arguments. + + + + The value of the fingerprint. + + + + + + + + + + + + + This object contains information that an Agent applies when establishing a trust relationship with a Controller. + + + + {{list|each entry is a Role that is associated with Controllers whose identity cannot be authenticated. The value of the {{param}} parameter is appended to the {{param|##.LocalAgent.Controller.{i}.AssignedRole}} parameter}} + In some instances, this policy is set by the Agent and cannot be modified by Controllers. If the Agent does not allow modification of this parameter, the Agent MUST respond with an error to the request to set this parameter. + + + + + + + + + + + The Role that is associated with Controllers indicate banned access. + When assigned to a Controller or associated with an entry in the {{object|Credential}} table, this MUST be the only value of the {{param}} parameter of the {{param|##.LocalAgent.Controller.{i}.AssignedRole}} parameter. + The Agent SHOULD refuse to accept USP messages from, or send USP messages to, any Controller that has this Role. + + + + + + + + + + When {{true}}, Agent has active policy that allows for self-signed certificates and certificates from unknown Certificate Authorities (CAs) to be trusted on first use (TOFU). + + + + + + + + Inactivity timer in {{units}}. + This timer is started when trust on first use (TOFU) policy is used to accept a Controller certificate. If no USP Message is received before this timer elapses, the Agent MUST tear down the MTP connection and underlying (D)TLS session. + A value of 0 means that the TOFU inactivity timer is effectively disabled. + + + + + + + + + + This command is issued to retrieve the instruction for the referenced challenge. + There is at most one (1) outstanding RequestChallenge for a requesting Controller. + As such, any new challenges with a different value of the {{param|ChallengeRef}} parameter are denied until a successful response to the outstanding challenge is received by the Agent or the current RequestChallenge expires. + When the value of the {{param|ChallengeRef}} parameter defined in the RequestChallenge does not exist, the Agent returns an "Invalid Value" error. + + + + Input arguments. + + + + {{reference|the {{object|#.Challenge}} object instance for this request}} + + + + + + + + + + The expiration period, in {{units}}, where the Controller request that this challenge request expire (times-out). + A value of zero indicates that the challenge request will never expire. The default is 900 {{units}}. + + + + + + + + + + + + Output arguments. + + + + The value of the {{param|##.Challenge.{i}.Instruction}} parameter associated with the requested challenge in the {{param|#.Input.ChallengeRef}} parameter. + + + + + + + + The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|Instruction}} parameter. + The allowable values of the media type are defined by the {{param|##.Challenge.{i}.InstructionType}} parameter. + + + + + + + + The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|##.Challenge.{i}.Value}} parameter. + The allowable values of the media type are defined by the {{param|##.Challenge.{i}.ValueType}} parameter. + + + + + + + + The challenge identifier the Controller uses in the ChallengeResponse command to correlate this request with a response. + + + + + + + + + + This command is issued to return the response of challenge. + + + + Input arguments. + + + + The challenge identifier the Controller uses to correlate the challenge request with a response. + + + + + + + + The value of the challenge that is specific to the type of challenge. The challenge value is provided by the external party to the Controller. + + + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + {{numentries}} + + + + + + + + + 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. + + + + + + + + + + {{datatype|expand}} + + + + + + + + Enable/Disable this {{object}} instance. + + + + + + + + + The Role assigned to this {{object}} instance. + + + + + + + + {{numentries}} + + + + + + + + + Each instance of this table represents the permissions that are extended to a set of Targets for a specified Role. + If there are multiple entries in this table for a specific Role where the Targets overlap, the permissions for the entry with the highest value takes priority over all others. + + + + + + + + + + {{datatype|expand}} + + + + + + + + Enable/Disable this {{object}} instance. + + + + + + + + + The order (relative priority) to use when determining the permissions for overlapping Targets that are contained within the same {{object|#.}}. + The larger value of this parameter takes priority over a permission with a smaller value (i.e., 0 has the lowest priority). + + + + + + + + + {{list|each entry is a target to which the value of the permissions parameters are assigned}} + When an entry is a value of a Partial Path, the permissions are associated to that Object and any child Object/Parameter. + When the value of an entry is an Object instance then the permissions are associated to all Parameters of the Object instance. + When an entry is a value of a Search Path as defined in {{bibref|TR-369}} that resolves to zero or more Parameter Paths, then all Parameter Paths that result from the evaluation of the Search Path are subject to the permissions assigned by this {{object}} instance. + + + + + + + + + + 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 Parameter type of Targets: + # Read: Grants the capability to read the value of the Parameter via Get and read the meta-information of the Parameter via GetSupportedDM. + # Write: Grants the capability to update the value of the Parameter via Add or Set. + # Execute: Grants no capabilities; Parameters can not be executed. + # Notify: Grants the capability to use this Parameter in the ReferenceList of a ValueChange Subscription. + + + + + + + + + + + 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 Object type of Targets: + # Read: Grants the capability to read the meta-information of the Object via GetSupportedDM. + # Write: Grants no capabilities for Static Objects. Grants the capability to create a new instance of a Multi-Instanced Object via Add (e.g. Device.LocalAgent.Controller.). + # Execute: Grants no capabilities; Objects are not executable and Commands are controlled by the CommandEventPermissions. + # Notify: Grants the capability to use this Object in the ReferenceList of an ObjectCreation (for multi-instance objects only) Subscription. + + + + + + + + + + + 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 read the value of Parameters related to the Instantiated Object via a Get containing a search expression or wildcard in place of the instance identifier. + # 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 use this Instantiated Object in the ReferenceList of an ObjectDeletion Subscription. + + + + + + + + + + + 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 Command and Event type of Targets: + # Read: Grants the capability to read the meta-information of the Command (including input and output arguments) and Event (including arguments) via GetSupportedDM. + # Write: Grants no capabilities; Commands are executed instead of written to and Events are read only. + # Execute: Grants the capability to execute the Command via Operate, but grants no capabilities to an Event. + # Notify: Grants the capability to use this Event or Command in the ReferenceList of an Event or OperationComplete Subscription. + + + + + + + + + + + + Each instance of this table represents a trusted credential. The credential can be that of a certificate authority (CA) for a Controller whose EndpointID is unknown. + When a credential is supplied to the Agent by a Controller during authentication, the credentials in this table are used to determine if any of the supplied certificates (including those in the chain of trust) are considered "trusted". + If the Controller authenticated via an entry in this table is not previously known to the Agent, the associated Role entry is automatically applied to the Controller. + + + + + + + + + + {{datatype|expand}} + + + + + + + + Enable/Disable this {{object}} instance. + + + + + + + + + {{nolist}} + Comma-separated list of strings, the (set of) Role(s) applied to a Controller authenticated through this {{object}} instance. + The roles are added to the Controller's current list of Roles by replacing the value of the {{param|###.LocalAgent.Controller.{i}.InheritedRole}} parameter. + If the Controller is already known to the Agent, with an associated Role, this parameter has no impact. + + + + + + + + + + + A reference to the {{object|##.Certificate.{i}}} instance for use in the authentication of certificates provided by a Controller and authorization of Controllers, and for authentication of certificates used for MTP encryption. + + + + + + + + + + Identifies what usages the Certificate Authority (CA) authenticated by the associated credential is trusted to authorize. + + + + + + The CA can only authorize MTP (domain) connectivity, and cannot authenticate Controllers. + + + + + The CA can authorize MTP (domain) connectivity and authenticate Controllers. + + + + + The CA can authorize MTP (domain) connectivity and the presenter of this certificate is trusted to have authenticated the identity of Endpoints whose Records it transmits such that the from_id can be trusted without additional authentication. See {{bibref|TR-369|"Authentication and Authorization"}} for additional description of the Trusted Broker function. + + + + + + + + + Each instance of this table represents information that is used to challenge a Controller in order to assign a Role to the Controller or to determine the authenticity of a Certificate. + The Controller requests a type of challenge from an Agent using the RequestChallenge command. + The Agent returns the value of the {{param|Instruction}} for that type of challenge to the Controller which the Controller then provides a third-party. + The third-party responds to the Instruction which the Controller then sends to the Agent using the ChallengeResponse command. + The Agent verifies the response to the Challenges and executes an implementation specific Agent logic in order to establish trust with the Controller. + This could include (but is not limited to): + *Assignment of roles to the Controller is done by appending the non-duplicate roles of the {{param|Role}} parameter to the value of the {{param|###.LocalAgent.Controller.{i}.AssignedRole}} parameter. + *Use the Controller's certificate to which the challenge response was received in order to authenticate the identity of the Controller. + + + + + + + {{datatype|expand}} + + + + + + + + The description of this {{object}} instance. + + + + + + + + {{nolist}} + Comma-separated list of strings, the (set of) role(s) appended (non-duplicate values only) to the value of the {{param|###.LocalAgent.Controller.{i}.AssignedRole}} parameter. + + + + + + + + + + + Enable/Disable this {{object}} instance. + + + + + + + + + The type of challenge that will be verified from the challenge response provided by the third-party through the Controller. + + + + + + The challenge uses a passphrase the third-party is expected to match. + + + + + + + + The value of the challenge that is specific to the type of challenge. + + + + + + The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|Value}} parameter. + + + + + + + + + + + The instruction that is provided to the external party by the Controller requesting the challenge. + + + + + + + + The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|Instruction}} parameter. + + + + + + + + + + + + The number of times a challenge is retried before the challenge procedure is terminated. + + + + + + + + The time, in {{units}} that a Controller that has failed the challenge is locked out (based on the value of the {{param|Retries}} parameter) prior to being provided the challenge again. + A value of zero means that a LockoutPeriod doesn't apply and the challenge can be provided indefinitely. + + + + + + + + + + + + + The {{object}} represents the STOMP capabilities of the device as described in {{bibref|TR-369}}. + + + + {{numentries}} + + + + + + + + + The {{object}} represents a STOMP connection between the Agent and a STOMP server. + + + + + + + + + + + + {{datatype|expand}} + + + + + + + + Enables or disables this {{object}}. + This parameter is based on ''ifAdminStatus'' from {{bibref|RFC2863}}. + + + + + + + + + The current operational state of this {{object}} (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} + When {{param|Enable}} is {{false}} then {{param}} SHOULD normally be {{enum|Disabled}} 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|Enabled}} if and only if the interface is able to transmit and receive PDUs; it SHOULD change to {{enum|Unknown}} if the state of the interface can not be determined for some reason. + + + + + + + + + + + + + + + + + The date and time at which this {{object}} entered into its current operational state. + + + + + + + + The hostname or IP Address of the STOMP Server. + + + + + + + + + + The port number of the STOMP Server. + + + + + + + + + + + The username part of the credentials to be used when authenticating this {{object}} during connection establishment with the STOMP Server. + + + + + + + + + + The password part of the credentials to be used when authenticating this {{object}} during connection establishment with the STOMP Server. + + + + + + The Virtual Host to use when establishing the connection. + Some STOMP Server implementations utilize virtual hosts to place a context around credentials, permissions, and internal resources. + + + + + + + + + + + Enable or disable the STOMP Heart-beating mechanism as described in STOMP (for this {{object}}). + When the STOMP Heart-beat mechanism is enabled, {{param|OutgoingHeartbeat}} and {{param|IncomingHeartbeat}} determine how the heart-beat header within the CONNECT frame is formatted. + When the STOMP Heart-beat mechanism is disabled, {{param|OutgoingHeartbeat}} and {{param|IncomingHeartbeat}} are ignored and the CONNECT frame MUST NOT contain a heart-beat header element. + Any changes to this parameter will not take effect until the next connection. + + + + + + + + + Represents the Outgoing heart-beat timing of the STOMP Heart-beating mechanism as described in STOMP (for this {{object}}). + The Outgoing heart-beat represents what the sender of the frame can do. A value of 0 means that it cannot send heart-beats. + Any changes to this parameter will not take effect until the next connection. + + + + + + + + + + + Represents the Incoming heart-beat timing of the STOMP Heart-beating mechanism as described in STOMP (for this {{object}}). + The Incoming heart-beat represents what the sender of the frame would like to get. A value of 0 means that it does not want to receive heart-beats. + Any changes to this parameter will not take effect until the next connection. + + + + + + + + + + + The maximum first reconnection wait interval, in {{units}}, as specified in {{bibref|TR-369}}. + The Device MUST use a random value between ''0'' and {{param}} as the first reconnection wait interval. + + + + + + + + + + + + The reconnection interval multiplier as specified in {{bibref|TR-369}}. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. + For the ''n''th reconnection wait interval, the Device MUST use a random value, in ''seconds'', between ''0'' and {{param|ServerRetryInitialInterval}} * ({{param}} / 1000) ** (''n'' - ''1''). + The server retry mechanism reaches its upper limit at 10 reconnection attempts. Meaning, that if the number of reconnection attempts exceeds 10, then the Device MUST use a random value, in seconds, between 0 and ServerRetryInitialInterval * (ServerRetryIntervalMultiplier / 1000) ** (10 - 1). + + + + + + + + + + + The maximum reconnection wait interval, in {{units}}. + If the ''n''th reconnection wait interval calculated from {{param|ServerRetryInitialInterval}} and {{param|ServerRetryIntervalMultiplier}} exceeds the value of this parameter, then the Agent MUST use the value of this parameter as the next reconnection wait interval. + + + + + + + + + + + + This parameter represents whether or not communications that utilize this {{object}} object instance are encrypted. + + + + + + + + + Capabilities of a Device as it pertains to entering a standby state. + + + + 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. + + + + + + - The {{object}} represents the XMPP capabilities of the device as described in {{bibref|TR-069a5|Appendix III}}. + The {{object}} represents the XMPP capabilities of the device{{templ|XMPP-REF-APP}} @@ -43280,7 +49117,7 @@ Password used to authenticate this {{object}} when making a connection to the {{object|Server}} using the procedure outlined in {{bibref|RFC6120|Section 6}}. - Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If an ACS modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset. + Note that on a factory reset of the CPE, the value of this parameter might be reset to its factory value. If a Controller modifies the value of this parameter, it SHOULD be prepared to accommodate the situation that the original value is restored as the result of a factory reset. - The maximum first reconnection wait interval, in {{units}}, as specified in {{bibref|TR-069a5|Annex K XMPP Connection Request}}. + The maximum first reconnection wait interval, in {{units}}{{templ|XMPP-REF}} The Device MUST use a random value between ''0'' and {{param}} as the first reconnection wait interval. NOTE: If the value of the {{param|ServerConnectAttempts}} parameter is 0, the value of this parameter is ignored. @@ -43397,7 +49234,7 @@ - The reconnection interval multiplier as specified in {{bibref|TR-069a5|Annex K XMPP Connection Request}}. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. + The reconnection interval multiplier{{templ|XMPP-REF}} This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. For the ''n''th reconnection wait interval, the Device MUST use a random value, in ''seconds'', between ''0'' and {{param|ServerRetryInitialInterval}} * ({{param}} / 1000) ** (''n'' - ''1''). NOTE: If the value of the {{param|ServerConnectAttempts}} parameter is 0, the value of this parameter is ignored. @@ -43424,7 +49261,7 @@ - This parameter allows an ACS to configure whether or not this XMPP Connection is required to use TLS independent of whether or not the XMPP Server that is being connected to is configured for TLS "mandatory-to-negotiate". + This parameter allows a Controller to configure whether or not this XMPP Connection is required to use TLS independent of whether or not the XMPP Server that is being connected to is configured for TLS "mandatory-to-negotiate". If the value of {{param}} is {{true}} then the CPE will initiate TLS negotiation if not required to by the XMPP Server. If the value of {{param}} is {{false}} then the CPE will not initiate TLS negotiation if not required to by the XMPP Server. @@ -44295,7 +50132,7 @@ - Enables or disables the 1905 Network Topology reporting (via TR-069). When {{true}}, the device clears and (re)populates the {{object|IEEE1905Device}} and {{object|ChangeLog}} tables. When {{false}}, the contents of the {{object|IEEE1905Device}} and {{object|ChangeLog}} tables have no meaning. + Enables or disables the 1905 Network Topology reporting (via a Controller). When {{true}}, the device clears and (re)populates the {{object|IEEE1905Device}} and {{object|ChangeLog}} tables. When {{false}}, the contents of the {{object|IEEE1905Device}} and {{object|ChangeLog}} tables have no meaning. @@ -44513,6 +50350,16 @@ + + + {{param}} is a reference to the Wi-Fi Network "APDevice". Since IEEE 1905.1 is the protocol used by the Wi-Fi Alliance's EasyMesh specification for communications, this parameter allows the IEEE 1905.1 portion of the data model to reference the associated EasyMesh portion of the data model. + + + + + + + {{numentries}} @@ -45200,7 +51047,7 @@ - MQTT Base object describing all MQTT related parameters and objects {{bibref|MQTT31}}, + MQTT Base object describing all MQTT related parameters and objects. @@ -45237,7 +51084,12 @@ - Protocol according to {{bibref|MQTT311}} + Protocol according to {{bibref|MQTT31}} + + + + + Protocol according to {{bibref|MQTT50}} @@ -45312,8 +51164,10 @@ Allows to enable or disable the MQTT client. - If a MQTT client gets enabled then the MQTT client has first to establish a MQTT broker session and then subscribe for all enabled topics in the {{object|Subscription.}} table. In case the {{param|CleanSession}} is set to {{false}} a subscription MUST only be sent for topics which haven't been subscribed before (see {{bibref|MQTT311|3.1.2.4}}). - If a connected MQTT client gets disabled ({{param|Status}} is either {{enum|Connecting|Status}} or {{enum|Connected|Status}}) then the MQTT client has to send a MQTT DISCONNECT message to disconnect from the MQTT broker ({{bibref|MQTT31|3.14}} or {{bibref|MQTT311|3.14}}), before setting the {{param|Status}} to {{enum|Disabled|Status}}. + If a MQTT client gets enabled then the MQTT client has first to establish a MQTT broker session and then subscribe for all enabled topics in the {{object|Subscription.}} table. + If the {{param|ProtocolVersion}} is set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|#.Capabilities.ProtocolVersionsSupported}} and {{param|CleanSession}} is set to {{false}} a subscription MUST only be sent for topics which haven't been subscribed before (see {{bibref|MQTT31|section 3.1.2.4}}). + If the {{param|ProtocolVersion}} is set to {{enum|5.0|#.Capabilities.ProtocolVersionsSupported}} and {{param|CleanStart}} is set to {{false}} a subscription MUST only be sent for topics which haven't been subscribed before (see {{bibref|MQTT50|section 3.1.2.4}}). + If a connected MQTT client gets disabled ({{param|Status}} is either {{enum|Connecting|Status}} or {{enum|Connected|Status}}) then the MQTT client has to send a MQTT DISCONNECT packet to disconnect from the MQTT broker ({{bibref|MQTT31|section 3.14}},{{bibref|MQTT31|section 3.14}}) or {{bibref|MQTT50|section 3.14}}), before setting the {{param|Status}} to {{enum|Disabled|Status}}. @@ -45337,50 +51191,6 @@ - - - The MQTT client identifier used in the CONNECT message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.1}}). This parameter MUST NOT be {{empty}}, the CPE has to provide a default value for the parameter, which can be changed by the ACS. - A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. - - - - - - - - - - Username used to authenticate the CPE when making a connection to the MQTT broker. {{bibref|MQTT31|3.1}} recommends that the username has 12 characters or fewer, but this is not required. - If this parameter is {{empty}} no authentication parameters are sent in the MQTT CONNECT message. - - - - - - - - - - Password used to authenticate the CPE when making a connection to the MQTT broker (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.4}}). - This password is only sent in the MQTT CONNECT message if {{param|Username}} is not {{empty}}. - - - - - - Indicates the transport protocol to be used for the MQTT broker connection. - - - - - - - - Specifies the MQTT protocol version used in the communication with the MQTT broker. @@ -45391,55 +51201,6 @@ - - - The value of the MQTT clean session flag in the MQTT CONNECT message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.4}}). If this flag is set to {{true}} (default), the MQTT broker will delete all subscription information after a Disconnect. - A change of this parameter is only effective after the next MQTT CONNECT message to the MQTT broker. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. - - - - - - - - - Message retry time in {{units}} defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see {{bibref|MQTT31|4.2}} and {{bibref|MQTT311|4.4}}). - - - - - - - - - - - - Connect retry time in {{units}} defines the wait time before a failed MQTT broker connection is retried. - A failure can either be on the connection level (the TCP/IP or TLS can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK message on a MQTT CONNECT message sent. - - - - - - - - - - - - Keep Alive Time in {{units}} defines the maximum wait time after which a message has to be sent to the MQTT broker (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.10}}). If no regular messages can be sent a MQTT PINGREQ is sent. - A value of zero (0) means no keep alive message are sent and the MQTT client is not disconnected by the server. - A change of this parameter is only effective after the next MQTT CONNECT message to the MQTT broker. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. - - - - - - - - - Host name or IP address of the MQTT Broker. @@ -45461,40 +51222,53 @@ + + + Indicates the transport protocol to be used for the MQTT broker connection. + + + + + + + + + + + The value of the MQTT clean session flag in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}} and {{bibref|MQTT31|section 3.1.2.4}}). If this flag is set to {{true}} (default), the MQTT broker will delete all subscription information after a Disconnect. + {{templ|MQTTReconnect}} + This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|#.Capabilities.ProtocolVersionsSupported}}. + + + + + + + + + The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see {{bibref|MQTT50|section 3.1.2.4}}. If this flag is set to {{true}} (default), the MQTT broker will delete all subscription information after a Disconnect. + {{templ|MQTTReconnect}}. + {{templ|MQTT50ONLY}} + + + + + + - Enables or disables the will handling (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.5}}).. Changing this parameter while the MQTT client is connected will cause the client to disconnect and reconnect. - If the connection gets enabled and this parameter is set to {{true}} and either the parameter {{param|WillTopic}} or {{param|WillValue}} are {{empty}}, the CPE MUST set the {{param|Status}} to {{enum|Error_Misconfigured|Status}} (see {{bibref|MQTT311|3.1.2.5}}). + Enables or disables the will handling (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.5}}) or {{bibref|MQTT50|section 3.1.2.5}}). + If the connection gets enabled and this parameter is set to {{true}} and either the parameter {{param|WillTopic}} or {{param|WillValue}} are {{empty}}, the CPE MUST set the {{param|Status}} to {{enum|Error_Misconfigured|Status}}. + {{templ|MQTTReconnect}}. - - - The Topic sent in the Will Message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.5}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. - A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. - If the will handling is enabled (Paramter {{param|WillEnable}} is set to {{true}}) and the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. - - - - - - - - The value sent in the Will Message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.5}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. - A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. - If the will handling is enabled (Paramter {{param|WillEnable}} is set to {{true}}) and the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. - - - - - - The MQTT QoS level assigned with the will message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.6}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. - A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. - If the will handling is enabled (Paramter {{param|WillEnable}} is set to {{true}}) and the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. + The MQTT QoS level assigned with the will message (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.6}}) or {{bibref|MQTT50|section 3.1.2.6}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. + {{templ|MQTTWillChange}} @@ -45504,14 +51278,286 @@ - Indicate to the MQTT broker to retain the Will over a Disconnect (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.7}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. - A change of this parameter is only communicated to the MQTT broker with the next MQTT CONNECT message. - If the will handling is enabled (Paramter {{param|WillEnable}} is set to {{true}}) and the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. + Indicate to the MQTT broker to retain the Will over a Disconnect (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.7}}) or {{bibref|MQTT50|section 3.1.2.7}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. + {{templ|MQTTWillChange}} + + + Keep Alive Time in {{units}} defines the maximum wait time after which a packet has to be sent to the MQTT broker (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.10}}) or {{bibref|MQTT50|section 3.1.2.10}}). If no regular packet can be sent a MQTT PINGREQ packet is sent. + A value of zero (0) means no keep alive packets are sent and the MQTT client is not disconnected by the server. + {{templ|MQTTReconnect}} + + + + + + + + + + + + Session expiry interval in {{units}} defines the wait time before a session expires after the connection has been closed by the MQTT client {{bibref|MQTT50|section 3.1.2.11.2}}). + {{templ|MQTT50ONLY}} + + + + + + + + + + The MQTT client uses this value to limit the number of QoS 1 and QoS 2 publications that it is willing to process concurrently (see {{bibref|MQTT50|section 3.1.2.11.3}}). + {{templ|MQTTReconnect}} + {{templ|MQTT50ONLY}} + + + + + + + + The maximum packet size in {{units}} the MQTT client can and will accept from the MQTT broker. A value of 0 means no limit. If the value is set to another value, the MQTT client will inform the broker in the next CONNECT packet {{bibref|MQTT50|section 3.1.2.11.4}}). + {{templ|MQTTReconnect}} + {{templ|MQTT50ONLY}} + + + + + + + + + + This value indicates the highest value that the MQTT client will accept as a Topic Alias sent by the Server (see {{bibref|MQTT50|section 3.1.2.11.5}}). The MQTT client uses this value to limit the number of Topic Aliases that it is willing to hold on this connection. + A value of 0 indicates that Topic Alias is not supported. + {{templ|MQTTReconnect}} + {{templ|MQTT50ONLY}} + + + + + + + + + + The MQTT client uses this value in a MQTT CONNECT packet to request the Server to return Response Information in the MQTT CONNACK (see {{bibref|MQTT50|section 3.1.2.11.6}}). + {{templ|MQTTReconnect}} + {{templ|MQTT50ONLY}} + + + + + + + + This value indicates whether the Reason String or User Properties are sent in the case of failures.(see {{bibref|MQTT50|section 3.1.2.11.7}}). + {{templ|MQTTReconnect}} + {{templ|MQTT50ONLY}} + + + + + + + + This value defines the extended authentication method to be used (see {{bibref|MQTT50|section 3.1.2.11.9}}). + If the parameter is empty, no extended authentication is performed. + {{templ|MQTTReconnect}} + {{templ|MQTT50ONLY}} + + + + + + + + + + The MQTT client identifier used in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.1}}) or {{bibref|MQTT50|section 3.1.3.1}}). + If {{param|ProtocolVersion}} is set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|#.Capabilities.ProtocolVersionsSupported}}, this parameter MUST NOT be an empty string. + If {{param|ProtocolVersion}} is set to {{enum|5.0|#.Capabilities.ProtocolVersionsSupported}}, an empty string is allowed. + {{templ|MQTTReconnect}} + + + + + + + + + + The delay in {{units}} after the session is disconnected, before sending the Will message {{bibref|MQTT50|section 3.1.3.2.2}}). A value of 0 indicates that there is no delay. + {{templ|MQTTWillChange}} + {{templ|MQTT50ONLY}} + + + + + + + + + + + The lifetime in {{units}} of a Will Message (see {{bibref|MQTT50|section 3.1.3.2.4}}). A value of 0 indicates that no message expiry interval value is specified for in the will message properties of a CONNECT packet. + {{templ|MQTT50ONLY}} + + + + + + + + + + Describes the type of the {{param|WillValue}} {{bibref|MQTT50|section 3.1.3.2.5}}). + {{templ|MQTTWillChange}} + {{templ|MQTT50ONLY}} + + + + + + + + + + Topic Name for a will response message. The presence of a Response Topic identifies the Will Message as a Request {{bibref|MQTT50|section 3.1.3.2.6}}). + If the {{param}} is an empty string the will response topic will not be sent in a MQTT CONNECT packet. + {{templ|MQTTWillChange}} + {{templ|MQTT50ONLY}} + + + + + + + + + + The Topic sent in the Will Message (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.3}}) or {{bibref|MQTT50|section 3.1.3.3}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. + {{templ|MQTTWillChange}} + + + + + + + + + + The value sent in the Will Message (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.5}}) or {{bibref|MQTT50|section 3.1.3.4}}). This parameter is only used if {{param|WillEnable}} is set to {{true}}. + {{templ|MQTTWillChange}} + + + + + + + + + + Username used to authenticate the MQTT client when making a connection to the MQTT broker. The value is sent in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.4}} or {{bibref|MQTT50|section 3.1.3.5}}). + For MQTT 3.1 {{bibref|MQTT31|section 3.1}} recommends that the user name has 12 characters or fewer, but this is not required. + If this parameter is {{empty}} no authentication parameters are sent in the MQTT CONNECT packet. + + + + + + + + + + Password used to authenticate the MQTT client when making a connection to the MQTT broker. The value is sent in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.5}} or {{bibref|MQTT50|section 3.1.3.6}}). + This password is only sent in the MQTT CONNECT packet if {{param|Username}} is not {{empty}}. + + + + + + The lifetime in {{units}} of a PUBLISH Message (see {{bibref|MQTT50|section 3.3.2.3.3}}). A value of 0 indicates that no message expiry interval value is included in the PUBLISH packet. + {{templ|MQTT50ONLY}} + + + + + + + + + + Message retry time in {{units}} defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see {{bibref|MQTT31|section 4.2}}). + This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|3.1|#.Capabilities.ProtocolVersionsSupported}}. + + + + + + + + + + + + Connect retry time in {{units}} defines the wait time before a failed MQTT broker connection is retried. + A failure can either be on the connection level (the TCP/IP or TLS can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK packet on a MQTT CONNECT packet sent. + If the parameter {{param|ConnectRetryIntervalMultiplier}} is defined, the MQTT client MUST use a random value between {{param}}*({{param|ConnectRetryIntervalMultiplier}}/1000)^(n-1) and {{param}}*({{param|ConnectRetryIntervalMultiplier}}/1000)^n for the connect retry time, with n equals the current retry number. The max number of n is 10, starting with the 11th retry always the value n = 10 is used. + If the parameters {{param|ConnectRetryIntervalMultiplier}} and {{param|ConnectRetryMaxInterval}} are defined, the MQTT client MUST use the value of {{param|ConnectRetryMaxInterval}} if the calculated random value exceeds the value of {{param|ConnectRetryMaxInterval}}. + + + + + + + + + + + + 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 maximum reconnection wait interval, in {{units}}. + + + + + + + + + + + + The value of the CONNACK Response Information property supplied by a MQTT 5.0 server. This value is used by a MQTT 5.0 client as the basis for the PUBLISH Response Topic property for all PUBLISH packets that expect a response. If the value of {{param}} is not a subset (wildcarded or precise match) of any of the {{param|Subscription.{i}.Topic}} values the MQTT client MUST subscribe to this Topic. + + + + + + + {{numentries}} @@ -45520,6 +51566,14 @@ + + + {{numentries}} + + + + + Disconnects the MQTT client from the MQTT broker and reconnects it again (toggle connection). It is only effective if the MQTT client is currently connected to the MQTT broker (Parameter {{param|Status|}} is {{enum|Connected|Status}}). @@ -45549,7 +51603,7 @@ - Setting Enable to {{true}} means the topic is subscribed at the MQTT broker with a MQTT SUBSCRIBE message, setting it to {{false}} will unsubscribe the topic from the MQTT broker with a MQTT UNSUBSCRIBE message. If the MQTT client is already connected with the Broker ({{param|#.Status}} is {{enum|Connected|#.Status}}), the MQTT SUBSCRIBE or UNSUBSCRIBE message is sent directly, otherwise it is sent after the next successful connect. + When a MQTT client connects to a MQTT server, it MUST send a SUBSCRIBE message including all instances with {{param}} set to {{true}}. If the MQTT client is already connected with the MQTT server ({{param|#.Status}} is {{enum|Connected|#.Status}}), a MQTT SUBSCRIBE or UNSUBSCRIBE message MUST be sent directly when {{param}} is changed to {{true}} or {{false}}, respectively. The actual status of the subscription is indicated with {{param|Status}}. @@ -45561,7 +51615,7 @@ Indicates the status of this subscription. {{enum}} The {{enum|Subscribed}} value indicates that the topic was successfully subscribed with the MQTT broker, the MQTT client received the SUBACK message for this topic from the server. The {{enum|Subscribing}} value MAY be used by the CPE to indicate that the a SUBSCRIBE message for this topic was sent, and the CPE is waiting for a SUBACK message. - The {{enum|Unsubscribed}} value indicates that the topic is not reqistered with the MQTT broker. + The {{enum|Unsubscribed}} value indicates that the topic is not registered with the MQTT broker. The {{enum|Unsubscribing}} value MAY be used by the CPE to indicate that the an UNSUBSCRIBE message for this topic was sent, and the CPE is waiting for an UNSUBACK message. If the {{param|Enable}} is set to {{false}} the status MUST be either {{enum|Unsubscribed}} or if the unsubscription failed {{enum|Error}}. @@ -45577,7 +51631,7 @@ - Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in {{bibref|MQTT31|Appendix A}} and {{bibref|MQTT311|4.7}}. + Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in {{bibref|MQTT31|section Appendix A}}, {{bibref|MQTT31|section 4.7}} or {{bibref|MQTT50|4.7}}. @@ -45587,7 +51641,7 @@ - The MQTT QoS level assigned with the subscription (see {{bibref|MQTT31|4.1}} and {{bibref|MQTT311|4.3}}). + The MQTT QoS level assigned with the subscription (see {{bibref|MQTT31|section 4.1}}, {{bibref|MQTT31|section 4.3}}) or {{bibref|MQTT50|4.3}}. @@ -45596,6 +51650,119 @@ + + + List of user properties used by the MQTT client. + This table only applies if {{param|#.ProtocolVersion}} is set to {{enum|5.0|##.Capabilities.ProtocolVersionsSupported}}. + + + + + + + + + + {{datatype|expand}} + + + + + + + + Setting Enable to {{true}} means the user property is used in the indicated control packet(s). The user property will be applied to all control packets of the same control packet type (e.g PUBLISH). + + + + + + + + Name of the user property + + + + + + + + + + Value of the user property + + + + + + + + + + {{list}} Each entry defines the control packet type(s) in which the user property is included. + + + + + + + User property will be added in the AUTH control packet (see {{bibref|MQTT50|section 3.15.2.2.5}}) + + + + + User property will be added in the CONNECT packet (see {{bibref|MQTT50|section 3.1.3.2.8}}) + + + + + User property will be added in the DISCONNECT packet (see {{bibref|MQTT50|section 3.14.2.2.4}}) + + + + + User property will be added in the PUBLISH packet (see {{bibref|MQTT50|section 3.3.2.3.7}}) + + + + + User property will be added in the PUBACK packet (see {{bibref|MQTT50|section 3.4.2.2.3}}) + + + + + User property will be added in the PUBREC packet (see {{bibref|MQTT50|section 3.5.2.2.3}}) + + + + + User property will be added in the PUBREL packet (see {{bibref|MQTT50|section 3.6.2.2.3}}) + + + + + User property will be added in the PUBCOMP packet (see {{bibref|MQTT50|section 3.7.2.2.3}}) + + + + + User property will be added in the SUBSCRIBE packet (see {{bibref|MQTT50|section 3.8.2.1.3}}) + + + + + User property will be added in the UNSUBSCRIBE packet (see {{bibref|MQTT50|section 3.10.2.1.2}}) + + + + + User property will be added in the WILL properties (see {{bibref|MQTT50|section 3.1.3.2}}) + + + + + + Contains the MQTT client statistics and usage information. @@ -45728,7 +51895,7 @@ - Indicates the status of the MQTT broker. {{enum}} + Indicates the status of the MQTT broker. {{enum}} The "{{enum|Error_Misconfigured}}" value indicates that a necessary configuration value is undefined or invalid. The "{{enum|Error}}" value MAY be used by the CPE to indicate a locally defined error condition. @@ -45765,7 +51932,7 @@ - Username used to authenticate the MQTT clients, which connect to the MQTT broker. + User name used to authenticate the MQTT clients, which connect to the MQTT broker. If this parameter is {{empty}} no authentication is used. @@ -45852,36 +52019,13 @@ - + - The MQTT client identifier used in the CONNECT message (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.1}}). This parameter MUST NOT be {{empty}}, the CPE has to provide a default value for the parameter, which may be changed by the ACS. - A change of this parameter is only communicated to the remote MQTT broker with the next MQTT CONNECT message. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. + Specifies the MQTT protocol version used in the MQTT bridge connection. - - - - - - - Username used to authenticate the MQTT broker when making a connection over the MQTT bridge (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.4}}). {{bibref|MQTT31|3.1}} recommends that the username has 12 characters or fewer, but this is not required. - If this parameter is {{empty}} no authentication parameters are sent in the MQTT CONNECT message. - - - - - - - - - - Password used to authenticate the MQTT broker when making a connection over the MQTT bridge (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.3.4}}). - The password is only sent if {{param|Username}} is not {{empty}}. - - @@ -45896,29 +52040,82 @@ - - - Specifies the MQTT protocol version used in the MQTT bridge connection. - - - - - - - - The value of the MQTT clean session flag in the MQTT bridge connection (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.4}}). If this flag is set to {{true}} (default), the remote MQTT broker will delete all subscription information after a Disconnect. - A change of this parameter is only effective after the next MQTT CONNECT message to the remote MQTT broker. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. + The value of the MQTT clean session flag in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}} and {{bibref|MQTT31|section 3.1.2.4}}) to establish a MQTT bridge connection. If this flag is set to {{true}} (default), the remote MQTT broker will delete all subscription information after a Disconnect. + {{templ|MQTTReconnect}} + This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|3.1|##.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|##.Capabilities.ProtocolVersionsSupported}}. + + + The value of the MQTT Clean Start flag in the MQTT CONNECT packet (see {{bibref|MQTT50|section 3.1.2.4}} to establish a MQTT bridge connection. If this flag is set to {{true}} (default), the remote MQTT broker will delete all subscription information after a Disconnect. + {{templ|MQTTReconnect}}. + This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|5.0|##.Capabilities.ProtocolVersionsSupported}}. + + + + + + + + + Keep Alive Time in {{units}} defines the maximum wait time after which a packet has to be sent to the remote MQTT broker (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.2.10}}) or {{bibref|MQTT50|section 3.1.2.10}}). If no regular packet can be sent a MQTT PINGREQ packet is sent. + A value of zero (0) means no keep alive packets are sent and the bridge is not disconnected by the server. + {{templ|MQTTReconnect}} + + + + + + + + + + + + The MQTT client identifier used in the CONNECT packet (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.1}}) or {{bibref|MQTT50|section 3.1.3.1}}). + If {{param|ProtocolVersion}} is set to {{enum|3.1|##.Capabilities.ProtocolVersionsSupported}} or {{enum|3.1.1|##.Capabilities.ProtocolVersionsSupported}}, this parameter MUST NOT be an empty string. + If {{param|ProtocolVersion}} is set to {{enum|5.0|##.Capabilities.ProtocolVersionsSupported}}, an empty string is allowed. + {{templ|MQTTReconnect}} + + + + + + + + + + User name used to authenticate the MQTT broker when making a connection over the MQTT bridge. The value is sent in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.4}} or {{bibref|MQTT50|section 3.1.3.5}}). + For MQTT 3.1 {{bibref|MQTT31|section 3.1}} recommends that the user name has 12 characters or fewer, but this is not required. + If this parameter is {{empty}} no authentication parameters are sent in the MQTT CONNECT packet. + + + + + + + + + + Password used to authenticate the MQTT broker when making a connection over the MQTT bridge. The value is sent in the MQTT CONNECT packet (see {{bibref|MQTT31|section 3.1}}, {{bibref|MQTT31|section 3.1.3.5}} or {{bibref|MQTT50|section 3.1.3.6}}). + This password is only sent in the MQTT CONNECT packet if {{param|Username}} is not {{empty}}. + + + - Message retry time in {{units}} defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see {{bibref|MQTT31|4.2}} and {{bibref|MQTT311|4.4}}). + Message retry time in {{units}} defines the wait time before a MQTT message that expects a response (QoS value of message is > 0, or PUBLISH, PUBREL, SUBSCRIBE, UNSUBSCRIBE message) is resent, because the response is not received (see {{bibref|MQTT31|section 4.2}}. + This parameter only applies if {{param|ProtocolVersion}} is set to {{enum|3.1|##.Capabilities.ProtocolVersionsSupported}}. @@ -45931,7 +52128,7 @@ Connect retry time in {{units}} defines the wait time before a failed bridge connection is retried. - A failure can either be on the connection level (e.g. the TCP/IP or TLS conection can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK message on a MQTT CONNECT message sent. + A failure can either be on the connection level (e.g. the TCP/IP or TLS connection can not be established) or on the Protocol level, the MQTT client does not receive a MQTT CONNACK packet on a MQTT CONNECT packet sent. @@ -45941,20 +52138,6 @@ - - - Keep Alive Time in {{units}} defines the maximum wait time after which a message has to be sent to the remote MQTT broker (see {{bibref|MQTT31|3.1}} and {{bibref|MQTT311|3.1.2.10}}). If no regular messages can be sent a MQTT PINGREQ is sent. - A value of zero (0) means no keep alive message are sent and the bridge is not disconnected by the server. - A change of this parameter is only effective after the next MQTT CONNECT message to the remote MQTT broker. If the change needs to be applied immediately, the parameter {{param|ForceReconnect}} has to be set as well. - - - - - - - - - The algorithm used to select a server entry from the {{object|Server}} table @@ -46121,7 +52304,7 @@ Indicates the status of this subscription. {{enum}} The {{enum|Enabled}} value indicates that the this subscription is active. In case of incoming directions ({{param|Direction}} is either {{enum|in|Direction}} or {{enum|both|Direction}}) the topic was successfully subscribed with the remote MQTT broker. The {{enum|Disabled}} value indicates that this subscription is not used. - The {{enum|Error}} value indicates that an error occured (e.g. an subscription could not be made with the remote MQTT broker) and the subscription is not in use. + The {{enum|Error}} value indicates that an error occurred (e.g. an subscription could not be made with the remote MQTT broker) and the subscription is not in use. @@ -46133,7 +52316,7 @@ - Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in {{bibref|MQTT31|Appendix A}} and {{bibref|MQTT311|4.7}}. + Name of the subscribed topic. Topic names may contain wildcards according to the rules specified in {{bibref|MQTT31|section Appendix A}}, {{bibref|MQTT31|section 4.7}} or {{bibref|MQTT50|4.7}}. @@ -46167,7 +52350,7 @@ - The MQTT QoS level assigned with the subscription (see {{bibref|MQTT31|4.1}} and {{bibref|MQTT311|4.3}}). + The MQTT QoS level assigned with the subscription (see {{bibref|MQTT31|section 4.1}}, {{bibref|MQTT31|section 4.3}}) or {{bibref|MQTT50|4.3}}. @@ -46192,7 +52375,9 @@ :: MQTT broker receives message with topic "/local/bus/tr181" from a MQTT client => MQTT broker sends topic "/bus/tr181" to remote MQTT broker - + + + @@ -46217,7 +52402,9 @@ :: MQTT broker receives message with topic "/local/bus/tr181" from a MQTT client => MQTT broker sends topic "/remote/bus/tr181" to remote MQTT broker - + + + @@ -47377,7 +53564,7 @@ This objects represents the measurement controller that is assigned to a measurement agent. - + The timer, in {{units}}, that is started after each successful contact with a measurement controller. When the timer reaches the timeout en event is raised indicating that connectivity to the controller has been lost. @@ -47590,7 +53777,7 @@ This object represents the statistics associated with this object. - + Number of invocations of this schedule. This counter does not include suppressed invocations or invocations that were prevented due to an overlap with a previous invocation of this schedule. @@ -48712,7 +54899,7 @@ This object defines a periodic timer instance. The periodic timer instance has attributes for when the timer is to begin ({{param|StartTime}}) and end ({{param|EndTime}}) as well as the interval to use. - + Date and time, based on {{bibref|RFC3339}}, that the {{object}} instance is to begin operation. @@ -48846,2256 +55033,7 @@ - - - This object contains general information about the USP Agent itself. For information related to the Device that hosts the Agent, please reference the {{object|.DeviceInfo}} object. - NOTE: The Vendor Log File table ({{object|.DeviceInfo.VendorLogFile}}) details are located on the {{object|.DeviceInfo}} object. - - - - The unique USP identifier for this USP Agent. - - - - - - - - The current USP Agent software version; not the version of the overall device firmware, which is located in {{param|.DeviceInfo.SoftwareVersion}}. - To allow version comparisons, this element SHOULD be in the form of dot-delimited integers, where each successive integer represents a more minor category of variation. For example, ''3.0.21'' where the components mean: ''Major.Minor.Build''. - - - - - - - - - - Time in {{units}} since the USP Agent was last restarted (either via a reset of the software or reboot of the underlying device). - - - - - - - - - - Periodic event configured via the recipient Controller's {{param|Controller.{i}.PeriodicNotifInterval}} and {{param|Controller.{i}.PeriodicNotifTime}} parameters. - - - - - Wake-up event. - - - - - Indicates that a file has been transferred to or from the Device. The event is sent when the transfer has either completed successfully (in which case {{param|FaultCode}} will be zero), or else has failed (in which case {{param|FaultCode}} will be non-zero and {{param|FaultString}} will give further details). - The file transfer can be requested via a USP operation or via some other mechanism. If it's requested via a USP operation {{param|Command}}, {{param|CommandKey}} and {{param|Requestor}} give further details. - - - - The Path Name of the command that requested the transfer, or {{empty}} if the transfer was not requested via a USP operation. - - - - - - - - The ''command_key'' supplied when requesting the transfer, or {{empty}} if the transfer was not requested via a USP operation. - - - - - - - - - The Endpoint ID of the Controller that requested the transfer, or {{empty}} if no Controller requested it. - - - - - - - - - The type (direction) of the transfer. - - - - - - Downstream transfer; to the Agent. - - - - - Upstream transfer; from the Agent. - - - - - - - - - The Path Name of the Object or Object Instance that was affected by the transfer, or {{empty}} if no data model object was affected by the transfer. - - - - - - - - - The URL from or to which this transfer was performed, or {{empty}} if no such URL is available. - - - - - - - - - - - The date and time in UTC at which the transfer was started. The Device SHOULD record this information and report it in this argument, but if this information is not available, the value of this argument MUST be set to the ''Unknown Time'' value. - - - - - - - - - The date and time in UTC at which the transfer was fully completed. This need only be filled in if the transfer has been fully completed. The Device SHOULD record this information and report it in this argument, but if this information is not available or the transfer has not completed, the value of this argument MUST be set to the ''Unknown Time'' value. - - - - - - - - - The numerical fault code as defined in {{bibref|TR-369}}. A value of 0 (zero) indicates no fault. - - - - - - - - - A human-readable text description of the fault. This field SHOULD be {{empty}} if the {{param|FaultCode}} equals 0 (zero). - - - - - - - - - - - - This command is issued to allow a Controller (with the proper permissions) to add a new certificate to {{object|#.Certificate.{i}}}. This does not automatically produce a trust relationship with the host identified by the Certificate. To produce a trust relationship, an entry is required to exist in {{param|#.Controller.{i}.Credential}} or {{param|#.ControllerTrust.Credential.{i}.Credential}} that references the new {{object|#.Certificate.{i}}} entry. The Agent will use the Serial Number and Issuer fields from the input {{param|Certificate}} to populate the {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters. If {{object|#.Certificate}} already has an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters, this command will fail. To replace an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}}, the existing instance must first be deleted. - - - - Input arguments. - - - - An optional input the Controller can use to specify the {{param|##.Certificate.{i}.Alias}} value for the added entry. If provided as an input and the value already exists in {{object|##.Certificate.{i}}}, this commmand will fail. - - - - - - - - The X.509 certificate in Privacy-enhanced Electronic Mail (PEM) format. - - - - - - - - - - - - USP Message Transfer Protocols supported by this USP Agent. The USP Agent MUST support at least one Protocol. - - - - - - - See {{bibref|RFC7252}} - - - - - See {{bibref|RFC6455}} - - - - - See {{bibref|STOMP1.2}} - - - - - - - - {{list|each entry is an algorithm for calculating firgerprints that is supported by the Agent}} - - - - - - - As specified in {{bibref|RFC3174}}. - - - - - As specified in {{bibref|RFC6234}}. - - - - - As specified in {{bibref|RFC6234}}. - - - - - As specified in {{bibref|RFC6234}}. - - - - - As specified in {{bibref|RFC6234}}. - - - - - - - - {{list|each entry is a subtype component of the service type that is advertised for the device using mDNS as defined in {{bibref|RFC6762}}}} - - - - - - - - - The acceptable amount of time in {{units}} between the alteration of the Agent's Subscriptions (e.g. updated subscription, new subscription, removed subscription, etc.) and the notifications related to those subscriptions being delivered. - For example, if this parameter is set to 30 {{units}}, then once a Subscription has been updated, the Agent has 30 {{units}} before it needs to start delivering notifications based on the updated version of the Subscription (instead of the old version of the Subscription). - - - - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - - Each instance of this table represents a MTP used by the local Agent. - - - - - - - {{datatype|expand}} - - - - - - - - Enable/Disable this {{object}} instance. - If this {{object}} instance is to be disabled and currently used for communication with the requesting controller, the agent has to send the request response first, before disabling it. - - - - - - - - - The current operational state of the {{object}} instance. - - - - - - - Value when this {{object}} instance cannot establish communication. - - - - - Value when this {{object}} instance is misconfigured. - - - - - - - - The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint. - - - - - - - - - - - This parameter, when {{true}}, enables the advertisement of DNS-SD services defined for this {{object}} instance using mDNS as defined in {{bibref|RFC6762}}. - This parameter cannot be set to {{true}} if there are multiple {{object}} instances with the same value of the {{param|Protocol}} parameter. - When {{true}}, the hostname advertised in the SRV record MUST be a Fully Qualified Domain Name (FQDN). - The interfaces that advertise these DNS-SD services are restriced to the set of interfaces associated with this {{object}} instance and the interfaces defined by the {{param|##.DNS.SD.AdvertisedInterfaces}} parameter. - - - - - - - - - - If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters. - - - - {{reference|the {{object|###.IP.Interface}} object instance that this server will use as its host address to receive USP messages}} - {{empty}} will bind this server to all interfaces for this device. - - - - - - - - - - - The port number used by the CoAP Server to receive USP messages. - - - - - - - - - - - The path that is used by the CoAP Server in order to receive USP messages. - - - - - - - - This parameter represents whether or not communications that utilize this {{object}} object instance are encrypted. - - - - - - - - When {{true}}, encryption is used for this MTP instance. - - - - - - - - - - If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how the Agent communicates with the STOMP Server. - - - - A reference to the STOMP Connection used by this Agent when communicating via the STOMP MTP. - - - - - - - - - - - The STOMP destination where the Agent will be listening to incoming USP messages. - - - - - - - - - The STOMP destination contained in the subscribe-dest header of the CONNECTED STOMP Frame. - If the Agent doesn't receive a subscribe-dest header in the CONNECTED STOMP Frame, then the value of this Parameter is {{empty}}. - If this parameter's value is not empty then this is the STOMP destination address for this Agent, but if the value is empty the {{param|Destination}} Parameter contains the STOMP destination address for this Agent. - - - - - - - - - - If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket server, then this object contains WebSocket specific configuration parameters. - - - - {{reference|the {{object|###.IP.Interface}} object instance that this server will use as its host address to receive USP messages}} - {{empty}} will bind this server to all interfaces for this device. - - - - - - - - - - - The port number used by the WebSocket Server to receive USP messages. - - - - - - - - - - - The path that is used by the WebSocket Server in order to receive USP messages. - - - - - - - - - Each instance of this table represents a USP Controller that has access to this USP Agent. - - - - - - - - - - {{datatype|expand}} - - - - - - - - The unique USP identifier for this USP Controller. - - - - - - - - - Information about the configuration state of an Agent as it pertains to the {{object}} instance. This is not information related to an operator's installation or usage of the protocol, that information is maintained in {{param|ProvisioningCode}}. - This parameter could be used in scenarios where the Controller needs to perform some kind of initialization or periodic configuration monitoring. For example, a Controller might perform some initial configuration of an Agent on first contact (perhaps to configure the Subscriptions). The Controller could inspect this parameter to determine the current state of the Agent's configuration, allowing the Controller to streamline the configuration process. - - - - - - - - - - - Identifying information which MAY be used by the {{object}} instance to determine {{object}} instance specific customization and provisioning parameters. - - - - - - - - - - - Enable/Disable this {{object}} instance. - When {{false}}, messages (notifications) are not sent to the remote endpoint represented by this {{object}} instance. - - - - - - - - - {{list|each entry is a Role that has been assigned to this {{object}} instance by means other than the {{param|.LocalAgent.ControllerTrust.Credential.{i}.Role}} parameter}} - - - - - - - - - - - {{list|each entry is a Role that has been assigned to this {{object}} instance from the {{param|.LocalAgent.ControllerTrust.Credential.{i}.Role}} parameter associated with the CA credential ({{param|.LocalAgent.ControllerTrust.Credential.{i}.Credential}}) used to validate the Controller certificate}} - - - - - - - - - - - {{nolist}} - Comma-separated list of strings, the set of certificates from {{object|#.Certificate.{i}}} that a Controller can present for use in authenticating the identity of this {{object}} instance. - - - - - - - - - - If a Periodic Event Notification {{object|#.Subscription}} instance is associated with this USP Controller, then this is the duration in {{units}} of the interval for which the USP Agent MUST attempt to issue a Periodic Notification to the USP Controller. - - - - - - - - - - - If a Periodic Event Notification {{object|#.Subscription}} instance is associated with this USP Controller, then this is an absolute time reference in UTC to determine when the USP Agent will issue a Periodic Notification. Each Periodic Notification MUST occur at this reference time plus or minus an integer multiple of the {{param|PeriodicNotifInterval}}. - {{param}} is used only to set the ''phase'' of the Periodic Event Notifications. The actual value of {{param}} can be arbitrarily far into the past or future. - For example, if {{param|PeriodicNotifInterval}} is 86400 (a day) and if {{param}} is set to UTC midnight on some day (in the past, present, or future) then Periodic Notifications will be sent every day at UTC midnight. These MUST begin on the very next midnight, even if {{param}} refers to a day in the future. - The Unknown Time value defined in {{bibref|TR-106a2|section 3.2}} indicates that no particular time reference is specified. That is, the USP Agent MAY locally choose the time reference, and needs only to adhere to the specified {{param|PeriodicNotifInterval}}. - If absolute time is not available to the USP Agent, its Periodic Notification behavior MUST be the same as if the {{param}} parameter was set to the Unknown Time value. - - - - - - - - This parameter is related to the retry mechanism for Notifications. - Configures the first retry wait interval, in {{units}}, as specified in {{bibref|TR-369|Section "Responses to Notifications and Notification Retry"}}. - A value of 5 corresponds to the default behavior. - The USP Agent MUST use a random value between {{param}} and ({{param}} * {{param|USPNotifRetryIntervalMultiplier}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. - - - - - - - - - - - - This parameter is related to the retry mechanism for Notifications. - Configures the retry interval multiplier as specified in {{bibref|TR-369|Section "Responses to Notifications and Notification Retry"}}. - This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. - A value of 2000 corresponds to the default behavior. - The USP Agent MUST use a random value between {{param|USPNotifRetryMinimumWaitInterval}} and ({{param|USPNotifRetryMinimumWaitInterval}} * {{param}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. - - - - - - - - - - - Schedule a ''Timer!'' event on the associated {{object}}. - - - - Input arguments. - - - - The number of seconds from the time this command is invoked until the Agent initiates a Timer! Event notification (based on the associated subscriptions). - - - - - - - - - - - - - - Timer event requested via a ScheduleTimer() command invoked on the same Controller instance via an Operate USP message. - - - - The ''command_key'' supplied when requesting the timer event. - - - - - - - - - This command is issued to allow a Controller to add a new certificate for itself. This can be useful when the current certificate is expiring or has become compromised. This command creates a new entry in {{object|#.Certificate}} and adds a reference to the new entry to the Controller's {{param|#.Controller.{i}.Credential}}. The Agent will use the Serial Number and Issuer fields from the input {{param|Certificate}} to populate the {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters. If {{object|#.Certificate}} already has an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}} parameters, this command will fail. To replace an instance with the same {{param|#.Certificate.{i}.SerialNumber}} and {{param|#.Certificate.{i}.Issuer}}, the existing instance must first be deleted. - - - - Input arguments. - - - - An optional input the Controller can use to specify the {{param|###.Certificate.{i}.Alias}} value for the added entry. If provided as an input and the value already exists in {{object|###.Certificate.{i}}}, this commmand will fail. - - - - - - - - The X.509 certificate in Privacy-enhanced Electronic Mail (PEM) format. - - - - - - - - - - - - Requests the Agent to send an ''OnBoardRequest'' notification to this Controller. - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - - Each instance of this table represents a MTP used by this Controller. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Enable/Disable this {{object}} instance. - If this {{object}} instance is to be disabled and currently used for communication with the requesting controller, the agent has to send the request response first, before disabling it. - - - - - - - - - The Message Transport Protocol (MTP) to be used for communications by a USP Endpoint. - - - - - - - - - - - - If the USP Endpoint uses the CoAP Message Transport Protocol (MTP), then this object contains CoAP specific configuration parameters. - - - - The hostname or IP Address of the Controller's CoAP server. - - - - - - - - - - The port number used by the Controller's CoAP Server to receive USP messages. - - - - - - - - - - The path that is used by the Controller's CoAP Server in order to receive USP messages. - - - - - - - - When {{true}}, encryption is used as specified in {{bibref|TR-369|Section "MTP Message Encryption"}}. - - - - - - - - - - If the USP Endpoint uses the STOMP Message Transport Protocol (MTP), then this object contains STOMP Client specific configuration parameters related to how this Controller communicates with the STOMP Server. - - - - A reference to the STOMP Connection used by this Controller when communicating via the STOMP MTP. - - - - - - - - - - - The STOMP destination where the Controller will be listening to incoming USP messages. - - - - - - - - - - If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket client, then this object contains WebSocket specific configuration parameters. - - - - The hostname or IP Address of the Controller's WebSocket server. - - - - - - - - - - The port number used by the Controller's WebSocket server to receive USP messages. - - - - - - - - - - The path that is used by the Controller's WebSocket server in order to receive USP messages. - - - - - - - - This parameter represents whether or not communications that utilize this {{object}} object instance are encrypted. - - - - - - - - The the duration in {{units}} between when WebSocket ping control frames are transmitted by the Agent to the WebSocket server for the USP Controller. - - - - - - - - - - - The current retry count of the session. When zero (0), the session is not in a retry state. - - - - - - - - Configures the first retry wait interval, in {{units}}, as specified in {{bibref|TR-369|Section "WebSocket Session Retry"}}. - The USP Agent MUST use a random value between {{param}} and ({{param}} * {{param|SessionRetryIntervalMultiplier}} / 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 retry interval multiplier as specified in {{bibref|TR-369|Section "WebSocket Session Retry"}}. - This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. - The USP Agent MUST use a random value between {{param|SessionRetryMinimumWaitInterval}} and ({{param|SessionRetryMinimumWaitInterval}} * {{param}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. - - - - - - - - - - - If enabled, this command will either request to start or restart an WebSocket session with the Controller. - - - - - - The policy defined in this object determines the conditions under which the USP Agent notifies a USP Controller, that has an appropriate Subscription, of the completion of file transfers. - - - - Indicates the transfer results that MUST be included when the USP Agent notifies a USP Controller of file transfers. Transfer results omitted from this list MUST NOT be included when the USP Agent notifies a USP Controller. - - - - - - The autonomous file transfer completed successfully; i.e., the {{event|##.TransferComplete!}} event's {{param|##.TransferComplete!.FaultCode}} was zero - - - - - The autonomous file transfer did not complete successfully; i.e., the the {{event|##.TransferComplete!}} event's {{param|##.TransferComplete!.FaultCode}} was non-zero - - - - - Success and Failure - - - - - - - - - This table provides the Controller with the ability to dictate the Parameters that are delivered via ''Boot!'' events. - Any Parameter (identified by {{param|ParameterName}}) contained in this table MUST be included within the ''param_map'' element of the ''Boot!'' event. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Enables or disables this {{object}}. - - - - - - - - - A pattern that describes the Parameter(s) to be included in the ''param_map'' element of a ''Boot!'' event. Specifically, patterns with wildcards (an "*" character) in place of Instance Identifiers are allowed. - If the pattern does not match any existing Parameters at the time that the Agent is creating the ''Boot!'' event, then this {{object|#.BootParameter}} instance is not included in the ''param_map'' of the ''Boot!'' event. - - - - - - - - - - - - The {{object}} object represents the End to End (E2E) Session Context functionality for this {{object|##.Controller.{i}}} object instance. - - - - Enable/Disable this {{object}} instance. - When {{true}}, Session Context is used when exchanging USP Records with the remote endpoint represented by this {{object|##.Controller.{i}}} object instance. - When {{false}}, Session Context is not used when exchanging USP Records with the remote endpoint represented by this {{object|##.Controller.{i}}} object instance. - - - - - - - - - The current status of the Session Context. - - - - - - - A new Session Context is being negotiated (i.e., a USP Record with sequence_id of 0 and session_id not previously used with this remote endpoint was sent and response has not yet been received). - - - - - - - - - The duration in {{units}} in which the current Session Context will expire since the last session-related activity (e.g., Message sent or received, Session Context start or restart). - A value of 0 means session expiration is disabled. - - - - - - - - - - - - Configures the first retry wait interval, in {{units}}, as specified in {{bibref|TR-369|Section "Failure Handling in the Session Context"}}. - A value of 5 corresponds to the default behavior that is described in {{bibref|TR-369}}. - The USP Agent MUST use a random value between {{param}} and ({{param}} * {{param|SessionRetryIntervalMultiplier}} / 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 retry interval multiplier as specified in {{bibref|TR-369|Section "Failure Handling in the Session Context"}}. - This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. - A value of 2000 corresponds to the default behavior that is described in {{bibref|TR-369}}. - The USP Agent MUST use a random value between {{param|SessionRetryMinimumWaitInterval}} and ({{param|SessionRetryMinimumWaitInterval}} * {{param}} / 1000) as the first retry wait interval. Other values in the retry pattern MUST be calculated using this value as a starting point. - - - - - - - - - - - The current retry count of the Session Context. When zero (0), the Session Context is not in a retry state. - - - - - - - - The maximum size, in {{units}}, of the Record (payload(s) and headers) that can be transmitted to the remote endpoint. The smallest size, which can be configured is 512 bytes. - A value of 0 means that the segmentation function is effectively disabled. - - - - - - - - - - - - - The maximum times that a USP Endpoint attempts to retransmit the requested USP Record to the remote endpoint. - If the maximum tries is met for any requested USP Record, the USP Endpoint will restart the E2E Session. - A value of -1 means that the USP Endpoint will always attempt to retransmit the requested USP Record. - A value of 0 means that the USP Endpoint will not attempt to retransmit the requested USP Record and will restart the E2E Session. - - - - - - - - - - - The security mechanism to use when exchanging the payload of the Record with the remote endpoint. - - - - - - - The payload is encrypted at the originating endpoint and decrypted at the receiving endpoint using TLS. - The procedures for using TLS in a Session Context is defined in {{bibref|TR-369}}. - - - - - - - - - If the {{object}} is enabled then this command will either request to start or restart a Session Context with the remote endpoint. - If the {{object}} is not enabled and there is an active Session Context then this command will terminate that Session Context with the remote endpoint. - If the {{object}} is not enabled and there is no active Session Context then this command does nothing. - - - - - - A Subscription dictates how a USP Agent issues USP Notification Messages to a USP Controller. - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Enables/disables this {{object}}. A disabled entry MUST NOT be processed by the USP Agent. - - - - - - - - - {{reference|the {{object|#.Controller}} instance that will receive the Notification associated with this {{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. - - - - - - - - - - Unique identifier of the {{object}} itself, which is specific to the USP Controller that creates the instance of the {{object}}. - This value is also populated in the ''subscription_id'' element of every Notification message sent from a USP Agent to a USP Controller. - - - - - - - - - - - The date and time when this instance of {{object}} was created. This is internally used by the {{param|TimeToLive}} parameter to determine the expiration of this {{object}} instance. - The value of this parameter is automatically populated by the USP Agent upon {{object}} creation. - - - - - - - - Type of Notification message that will be sent to the USP Controller specified by {{param|Recipient}} when this {{object}} is triggered. - - - - - - - - - - - - - - Each entry in the list is a parameter path that determines the element of the data model that the {{object}} is applicable to. - Different values of the {{param|NotifType}} parameter will cause the {{object}} to interact with {{param}} differently. For example, an instance of {{object}} with {{enum|ValueChange|NotifType}} will utilize the value of this parameter differently than an instance with {{enum|Event|NotifType}}. - Expressions are allowed in the list items, but in some cases could cause a dynamic set of instances to be monitored in order to fulfill the Subscription's requirements. - Once the value of the {{param}} is written, the value cannot be changed as the {{object}} instance is considered to be immutable. If the value of a non-empty {{param}} parameter needs to change, the {{object}} instance MUST be deleted and a new {{object}} instance created. - - - - - - - - - - - Determines whether or not this {{object}} remains after the USP Agent is restarted (either via a reset of the software or reboot of the underlying device). - If {{true}}, this {{object}} stays in existence until either a Delete message removes it or the {{param|TimeToLive}} parameter expires. - If {{false}}, this {{object}} is automatically removed by the USP Agent whenever it is restarted. - - - - - - - - - Specifies the duration of time (in {{units}}) that this {{object}} remains in existence. After {{param}} has expired, this {{object}} instance is automatically removed by the USP Agent. - If the value of {{param}} is 0, then this parameter is ignored and this {{object}} stays in existence until either a Delete message removes it or the {{param|Persistent}} parameter determines that it needs to be removed. - If the value of {{param}} is greater than 0, then this parameter determines the length of time (from {{object}} creation) until it will be automatically removed by the USP Agent (unless the {{param|Persistent}} parameter is {{false}} and the USP Agent is restarted, in which case it will be removed before the {{param}} expiration). NOTE: This paramater does not count down as time moves forward; it will always read back with the same value that it was last set to. - If the USP Agent is incapable of maintaining absolute time then {{param}} will automatically expire if the USP Agent is restarted (either via a reset of the software or reboot of the underlying device) before {{param}} expiration. - - - - - - - - - - - Specifies whether or not the USP Agent attempts to re-deliver the Notification in the event that it could not be delivered to the USP Controller. - When {{param}} is {{true}}, the USP Agent MUST retry the delivery of the Notification. This implies that the Notification MUST be generated with the "send_resp" flag set to {{true}} such that the USP Agent knows when the Notification has been successfully delivered. The retry attempt(s) are performed using the retry algorithm defined in {{bibref|TR-369|Section "Responses to Notifications and Notification Retry"}}. - When {{param}} is {{false}}, the USP Agent MUST NOT retry the delivery of the Notification, and SHOULD generate the notification with "send_resp" flag set to {{false}}. - - - - - - - - - Specifies the duration of time (in {{units}}) that the Notification associated with this {{object}} will continue to be retried. After {{param}} has expired, if the Notification has still not been successfully delivered then the USP Agent MUST stop attempting to re-deliver the Notification. - If {{param|NotifRetry}} is set to {{false}} then this parameter is ignored. - If {{param|NotifRetry}} is set to {{true}} and the value of {{param}} is 0, then the USP Agent will attempt to re-deliver the Notification until it has been successfully delivered or until the USP Agent is restarted (either via a reset of the software or reboot of the underlying device). - If {{param|NotifRetry}} is set to {{true}} and the value of {{param}} is greater than 0, then the USP Agent will attempt to re-deliver the Notification until either it has been successfully delivered, until the length of time (from the time tha the Notification was initially attempted to be delivered) specified in this parameter expires, or until the USP Agent is restarted (either via a reset of the software or reboot of the underlying device). - NOTE: This paramater does not count down as time moves forward; it will always read back with the same value that it was last set to. - - - - - - - - - - - - {{object}} instances are created using USP ''Operate'' messages. Only ''Operate'' messages with ''async''=''true'' will create a {{object}} instance in the data model. - When the command of the ''Operate'' completes, then this {{object}} instance is removed from this table. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - The USP Endpoint Identifier that originated the command. - - - - - - - - The command to be executed. This parameter is a Path Name that addresses a Command in an Object or Object Instance. - The command is a result of the evaluation of the ''command'' argument of an ''Operate'' message. - - - - - - - - The ''command_key'' from the USP ''Operate'' message. - - - - - - - - The operational status of the request to execute the command. - - - - - - The command has been requested but is currently not executing. - - - - - The command is currently executing. - - - - - The command has been requested to be canceled. - - - - - The command has successfully been canceled. - - - - - The command has successfully been completed its execution. - - - - - The command has unsuccessfully completed its execution or has unsuccessfully been canceled. - - - - - - - - Request cancelation of this {{object}}'s command. - This command completes immediately. If successful, {{param|Status}} will immediately change to {{enum|Canceling|Status}} and will change to {{enum|Canceled|Status}} when the cancelation is complete. - - - - - - Each instance of this table represents information related to a X.509 certificate (see {{bibref|RFC5280}}) of a Controller or Certificate Authority. Instances are referenced from {{param|##.LocalAgent.Controller.{i}.Credential}} and {{param|##.LocalAgent.ControllerTrust.Credential.{i}.Credential}}. - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Enable/Disable this {{object}} instance. - - - - - - - - The Serial Number field in an X.509 certificate, see {{bibref|RFC5280}}. - - - - - - - - - - The Issuer field in an X.509 certificate, see {{bibref|RFC5280}}; i.e. the Distinguished Name (DN) of the entity who has signed the certificate. - - - - - - - - - - This command is issued to allow a Controller (with the proper permissions) to delete an entry from the {{object|##.Certificate.{i}}}. It also removes references to the Certificate in {{param|##.LocalAgent.Controller.{i}.Credential}} or {{param|##.LocalAgent.ControllerTrust.Credential.{i}.Credential}} and removes any X.509 certificate data the Agent had stored related to the entry. - - - - - This command is issued to allow a Controller to request the value of a fingerprint calculated for the specified table entry using the input {{param|FingerprintAlgorithm}}. - - - - Input arguments. - - - - The algorithm to be used to calculate the requested fingerprint. The value MUST be one the Agent supports, as noted in {{param|###.SupportedFingerprintAlgorithms}}. - - - - - - As specified in {{bibref|RFC3174}}. - - - - - As specified in {{bibref|RFC6234}}. - - - - - As specified in {{bibref|RFC6234}}. - - - - - As specified in {{bibref|RFC6234}}. - - - - - As specified in {{bibref|RFC6234}}. - - - - - - - - - Output arguments. - - - - The value of the fingerprint. - - - - - - - - - - - - - This object contains information that an Agent applies when establishing a trust relationship with a Controller. - - - - {{list|each entry is a Role that is associated with Controllers whose identity cannot be authenticated. The value of the {{param}} parameter is appended to the {{param|##.LocalAgent.Controller.{i}.AssignedRole}} parameter}} - In some instances, this policy is set by the Agent and cannot be modified by Controllers. If the Agent does not allow modification of this parameter, the Agent MUST respond with an error to the request to set this parameter. - - - - - - - - - - - The Role that is associated with Controllers indicate banned access. - When assigned to a Controller or associated with an entry in the {{object|Credential}} table, this MUST be the only value of the {{param}} parameter of the {{param|##.LocalAgent.Controller.{i}.AssignedRole}} parameter. - The Agent SHOULD refuse to accept USP messages from, or send USP messages to, any Controller that has this Role. - - - - - - - - - - When {{true}}, Agent has active policy that allows for self-signed certificates and certificates from unknown Certificate Authorities (CAs) to be trusted on first use (TOFU). - - - - - - - - Inactivity timer in {{units}}. - This timer is started when trust on first use (TOFU) policy is used to accept a Controller certificate. If no USP Message is received before this timer elapses, the Agent MUST tear down the MTP connection and underlying (D)TLS session. - A value of 0 means that the TOFU inactivity timer is effectively disabled. - - - - - - - - - - This command is issued to retrieve the instruction for the referenced challenge. - There is at most one (1) outstanding RequestChallenge for a requesting Controller. - As such, any new challenges with a different value of the {{param|ChallengeRef}} parameter are denied until a successful response to the outstanding challenge is received by the Agent or the current RequestChallenge expires. - When the value of the {{param|ChallengeRef}} parameter defined in the RequestChallenge does not exist, the Agent returns an "Invalid Value" error. - - - - Input arguments. - - - - {{reference|the {{object|#.Challenge}} object instance for this request}} - - - - - - - - - - The expiration period, in {{units}}, where the Controller request that this challenge request expire (times-out). - A value of zero indicates that the challenge request will never expire. The default is 900 {{units}}. - - - - - - - - - - - - Output arguments. - - - - The value of the {{param|##.Challenge.{i}.Instruction}} parameter associated with the requested challenge in the {{param|#.Input.ChallengeRef}} parameter. - - - - - - - - The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|Instruction}} parameter. - The allowable values of the media type are defined by the {{param|##.Challenge.{i}.InstructionType}} parameter. - - - - - - - - The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|##.Challenge.{i}.Value}} parameter. - The allowable values of the media type are defined by the {{param|##.Challenge.{i}.ValueType}} parameter. - - - - - - - - The challenge identifier the Controller uses in the ChallengeResponse command to correlate this request with a response. - - - - - - - - - - This command is issued to return the response of challenge. - - - - Input arguments. - - - - The challenge identifier the Controller uses to correlate the challenge request with a response. - - - - - - - - The value of the challenge that is specific to the type of challenge. The challenge value is provided by the external party to the Controller. - - - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - {{numentries}} - - - - - - - - - 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. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Enable/Disable this {{object}} instance. - - - - - - - - - The Role assigned to this {{object}} instance. - - - - - - - - {{numentries}} - - - - - - - - - Each instance of this table represents the permissions that are extended to a set of Targets for a specified Role. - If there are multiple entries in this table for a specific Role where the Targets overlap, the permissions for the entry with the highest value takes priority over all others. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Enable/Disable this {{object}} instance. - - - - - - - - - The order (relative priority) to use when determining the permissions for overlapping Targets that are contained within the same {{object|#.}}. - The larger value of this parameter takes priority over a permission with a smaller value (i.e., 0 has the lowest priority). - - - - - - - - - {{list|each entry is a target to which the value of the permissions parameters are assigned}} - When an entry is a value of a Partial Path, the permissions are associated to that Object and any child Object/Parameter. - When the value of an entry is an Object instance then the permissions are associated to all Parameters of the Object instance. - When an entry is a value of a Search Path as defined in {{bibref|TR-369}} that resolves to zero or more Parameter Paths, then all Parameter Paths that result from the evaluation of the Search Path are subject to the permissions assigned by this {{object}} instance. - - - - - - - - - - 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 Parameter type of Targets: - # Read: Grants the capability to read the value of the Parameter via Get and read the meta-information of the Parameter via GetSupportedDM. - # Write: Grants the capability to update the value of the Parameter via Add or Set. - # Execute: Grants no capabilities; Parameters can not be executed. - # Notify: Grants the capability to use this Parameter in the ReferenceList of a ValueChange Subscription. - - - - - - - - - - - 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 Object type of Targets: - # Read: Grants the capability to read the meta-information of the Object via GetSupportedDM. - # Write: Grants no capabilities for Static Objects. Grants the capability to create a new instance of a Multi-Instanced Object via Add (e.g. Device.LocalAgent.Controller.). - # Execute: Grants no capabilities; Objects are not executable and Commands are controlled by the CommandEventPermissions. - # Notify: Grants the capability to use this Object in the ReferenceList of an ObjectCreation (for multi-instance objects only) Subscription. - - - - - - - - - - - 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 use this Instantiated Object in the ReferenceList of an ObjectDeletion Subscription. - - - - - - - - - - - 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 Command and Event type of Targets: - # Read: Grants the capability to read the meta-information of the Command (including input and output arguments) and Event (including arguments) via GetSupportedDM. - # Write: Grants no capabilities; Commands are executed instead of written to and Events are read only. - # Execute: Grants the capability to execute the Command via Operate, but grants no capabilities to an Event. - # Notify: Grants the capability to use this Event or Command in the ReferenceList of an Event or OperationComplete Subscription. - - - - - - - - - - - - Each instance of this table represents a trusted credential. The credential can be that of a certificate authority (CA) for a Controller whose EndpointID is unknown. - When a credential is supplied to the Agent by a Controller during authentication, the credentials in this table are used to determine if any of the supplied certificates (including those in the chain of trust) are considered "trusted". - If the Controller authenticated via an entry in this table is not previously known to the Agent, the associated Role entry is automatically applied to the Controller. - - - - - - - - - - {{datatype|expand}} - - - - - - - - Enable/Disable this {{object}} instance. - - - - - - - - - {{nolist}} - Comma-separated list of strings, the (set of) Role(s) applied to a Controller authenticated through this {{object}} instance. - The roles are added to the Controller's current list of Roles by replacing the value of the {{param|###.LocalAgent.Controller.{i}.InheritedRole}} parameter. - If the Controller is already known to the Agent, with an associated Role, this parameter has no impact. - - - - - - - - - - - A reference to the {{object|##.Certificate.{i}}} instance for use in the authentication of certificates provided by a Controller and authorization of Controllers, and for authentication of certificates used for MTP encryption. - - - - - - - - - - Identifies what usages the Certificate Authority (CA) authenticated by the associated credential is trusted to authorize. - - - - - - The CA can only authorize MTP (domain) connectivity, and cannot authenticate Controllers. - - - - - The CA can authorize MTP (domain) connectivity and authenticate Controllers. - - - - - The CA can authorize MTP (domain) connectivity and the presenter of this certificate is trusted to have authenticated the identity of Endpoints whose Records it transmits such that the from_id can be trusted without additional authentication. See {{bibref|TR-369|"Authentication and Authorization"}} for additional description of the Trusted Broker function. - - - - - - - - - Each instance of this table represents information that is used to challenge a Controller in order to assign a Role to the Controller or to determine the authenticity of a Certificate. - The Controller requests a type of challenge from an Agent using the RequestChallenge command. - The Agent returns the value of the {{param|Instruction}} for that type of challenge to the Controller which the Controller then provides a third-party. - The third-party responds to the Instruction which the Controller then sends to the Agent using the ChallengeResponse command. - The Agent verifies the response to the Challenges and executes an implementation specific Agent logic in order to establish trust with the Controller. - This could include (but is not limited to): - *Assignment of roles to the Controller is done by appending the non-duplicate roles of the {{param|Role}} parameter to the value of the {{param|###.LocalAgent.Controller.{i}.AssignedRole}} parameter. - *Use the Controller's certificate to which the challenge response was received in order to authenticate the identity of the Controller. - - - - - - - {{datatype|expand}} - - - - - - - - The description of this {{object}} instance. - - - - - - - - {{nolist}} - Comma-separated list of strings, the (set of) role(s) appended (non-duplicate values only) to the value of the {{param|###.LocalAgent.Controller.{i}.AssignedRole}} parameter. - - - - - - - - - - - Enable/Disable this {{object}} instance. - - - - - - - - - The type of challenge that will be verified from the challenge response provided by the third-party through the Controller. - - - - - - The challenge uses a passphrase the third-party is expected to match. - - - - - - - - The value of the challenge that is specific to the type of challenge. - - - - - - The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|Value}} parameter. - - - - - - - - - - - The instruction that is provided to the external party by the Controller requesting the challenge. - - - - - - - - The media type with a format as defined by {{bibref|RFC6838}} of the content of the {{param|Instruction}} parameter. - - - - - - - - - - - - The number of times a challenge is retried before the challenge procedure is terminated. - - - - - - - - The time, in {{units}} that a Controller that has failed the challenge is locked out (based on the value of the {{param|Retries}} parameter) prior to being provided the challenge again. - A value of zero means that a LockoutPeriod doesn't apply and the challenge can be provided indefinitely. - - - - - - - - - - - - - The {{object}} represents the STOMP capabilities of the device as described in {{bibref|TR-369}}. - - - - {{numentries}} - - - - - - - - - The {{object}} represents a STOMP connection between the Agent and a STOMP server. - - - - - - - - - - - - {{datatype|expand}} - - - - - - - - Enables or disables this {{object}}. - This parameter is based on ''ifAdminStatus'' from {{bibref|RFC2863}}. - - - - - - - - - The current operational state of this {{object}} (see {{bibref|TR-181i2|Section 4.2.2}}). {{enum}} - When {{param|Enable}} is {{false}} then {{param}} SHOULD normally be {{enum|Disabled}} 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|Enabled}} if and only if the interface is able to transmit and receive PDUs; it SHOULD change to {{enum|Unknown}} if the state of the interface can not be determined for some reason. - - - - - - - - - - - - - - - - - The date and time at which this {{object}} entered into its current operational state. - - - - - - - - The hostname or IP Address of the STOMP Server. - - - - - - - - - - The port number of the STOMP Server. - - - - - - - - - - - The username part of the credentials to be used when authenticating this {{object}} during connection establishment with the STOMP Server. - - - - - - - - - - The password part of the credentials to be used when authenticating this {{object}} during connection establishment with the STOMP Server. - - - - - - The Virtual Host to use when establishing the connection. - Some STOMP Server implementations utilize virtual hosts to place a context around credentials, permissions, and internal resources. - - - - - - - - - - - Enable or disable the STOMP Heart-beating mechanism as described in STOMP (for this {{object}}). - When the STOMP Heart-beat mechanism is enabled, {{param|OutgoingHeartbeat}} and {{param|IncomingHeartbeat}} determine how the heart-beat header within the CONNECT frame is formatted. - When the STOMP Heart-beat mechanism is disabled, {{param|OutgoingHeartbeat}} and {{param|IncomingHeartbeat}} are ignored and the CONNECT frame MUST NOT contain a heart-beat header element. - Any changes to this parameter will not take effect until the next connection. - - - - - - - - - Represents the Outgoing heart-beat timing of the STOMP Heart-beating mechanism as described in STOMP (for this {{object}}). - The Outgoing heart-beat represents what the sender of the frame can do. A value of 0 means that it cannot send heart-beats. - Any changes to this parameter will not take effect until the next connection. - - - - - - - - - - - Represents the Incoming heart-beat timing of the STOMP Heart-beating mechanism as described in STOMP (for this {{object}}). - The Incoming heart-beat represents what the sender of the frame would like to get. A value of 0 means that it does not want to receive heart-beats. - Any changes to this parameter will not take effect until the next connection. - - - - - - - - - - - The maximum first reconnection wait interval, in {{units}}, as specified in {{bibref|TR-369}}. - The Device MUST use a random value between ''0'' and {{param}} as the first reconnection wait interval. - - - - - - - - - - - - The reconnection interval multiplier as specified in {{bibref|TR-369}}. This value is expressed in units of 0.001. Hence the values of the multiplier range between 1.000 and 65.535. - For the ''n''th reconnection wait interval, the Device MUST use a random value, in ''seconds'', between ''0'' and {{param|ServerRetryInitialInterval}} * ({{param}} / 1000) ** (''n'' - ''1''). - - - - - - - - - - - The maximum reconnection wait interval, in {{units}}. - If the ''n''th reconnection wait interval calculated from {{param|ServerRetryInitialInterval}} and {{param|ServerRetryIntervalMultiplier}} exceeds the value of this parameter, then the Agent MUST use the value of this parameter as the next reconnection wait interval. - - - - - - - - - - - - This parameter represents whether or not communications that utilize this {{object}} object instance are encrypted. - - - - - - - - - Capabilities of a Device as it pertains to entering a standby state. - - - - 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. - - - - - - - + Top level object for dynamically managed software applications. @@ -51103,7 +55041,7 @@ Install one or more Deployment Units (DUs) to the associated {{object}}. - + Input arguments. @@ -51122,7 +55060,7 @@ The UUID (see {{bibref|RFC4122}}) of the DU to be installed. - If this parameter is {{empty}} the device MUST generate the UUID based on the rules defined in {{bibref|RFC4122}} and {{bibref|TR-069|Annex H}}. + If this parameter is {{empty}} the device MUST generate the UUID based on the rules defined in {{bibref|RFC4122}} and {{bibref|TR-181i2|Annex C}}. @@ -51320,7 +55258,7 @@ - + {{numentries}} @@ -51328,7 +55266,7 @@ - + {{numentries}} @@ -51336,7 +55274,7 @@ - + {{numentries}} @@ -51345,7 +55283,7 @@ - + The Execution Environments that are available on the device, along with their properties and configurable settings. @@ -51355,7 +55293,7 @@ - + Indicates whether or not this {{object}} is enabled. Disabling an enabled Execution Environment stops it, while enabling a disabled Execution Environment starts it. @@ -51367,7 +55305,7 @@ - + Indicates the status of this {{object}}. @@ -51379,7 +55317,7 @@ - + {{datatype|expand}} @@ -51387,7 +55325,7 @@ - + A Name provided by the device that adequately distinguishes this {{object}} from all other {{object}} instances. @@ -51397,7 +55335,7 @@ - + Indicates the complete type and specification version of this {{object}}. @@ -51407,7 +55345,7 @@ - + The run level that this {{object}} will be in upon startup (whether that is caused by a device Boot or the Execution Environment starting). Run levels dictate which Execution Units will be started. Execution Units will be started if {{param|CurrentRunLevel}} is greater than or equal to {{param|#.ExecutionUnit.{i}.RunLevel}} and {{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}. @@ -51419,7 +55357,7 @@ - + The run level that this {{object}} is currently operating in. This value is altered by executing the {{command|SetRunLevel()}} command. Upon startup (whether that is caused by a device Boot or the Execution Environment starting) {{param}} will be equal to {{param|InitialRunLevel}}, unless Run Levels are not supported by this {{object}} in which case {{param}} will be -1. @@ -51432,7 +55370,7 @@ - + Indicates the initial value on creation for {{param|#.ExecutionUnit.{i}.RunLevel}} for all Execution Unit instances associated with this {{object}}. If the value of {{param|CurrentRunLevel}} is -1, then the value of this parameter is irrelevant when read and setting its value has no impact on the Run Level of any Execution Unit. @@ -51443,7 +55381,7 @@ - + The vendor that produced this {{object}}. @@ -51453,7 +55391,7 @@ - + The Version of this {{object}} as specified by the Vendor that implemented this {{object}}, not the version of the specification. @@ -51463,7 +55401,7 @@ - + Represents the parent {{object}} of this {{object}}. If this value is {{empty}} then this is the Primary Execution Environment. @@ -51474,7 +55412,7 @@ - + The amount of disk space measured in {{units}} allocated to this {{object}}. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable. @@ -51485,7 +55423,7 @@ - + The amount of disk space measured in {{units}} currently available to this {{object}}. This value changes as the {{object|#.ExecutionUnit}} instances associated with this {{object}} consumes disk space. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable. @@ -51496,7 +55434,7 @@ - + The amount of physical RAM measured in {{units}} allocated to this {{object}}. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable. @@ -51507,7 +55445,7 @@ - + The amount of physical RAM measured in {{units}} currently available to this {{object}}. This value changes as the {{object|#.ExecutionUnit}} instances associated with this {{object}} are started/stopped and consume the physical RAM. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable. @@ -51518,7 +55456,7 @@ - + Represents the {{object|#.ExecutionUnit}} instances currently running on this {{object}}. This parameter only contains {{object|#.ExecutionUnit}} instances that currently have a {{param|#.ExecutionUnit.{i}.Status}} of {{enum|Active|#.ExecutionUnit.{i}.Status}}. @@ -51529,7 +55467,7 @@ - + Represents the processors that this {{object}} has available to it. @@ -51545,7 +55483,7 @@ Provides a mechanism to remotely manipulate the run level of this {{object}}, meaning that altering this comand will change the value of the {{param|#.CurrentRunLevel}}. Run levels dictate which Execution Units will be started. Execution Units will be started if {{param|CurrentRunLevel}} is greater than or equal to {{param|#.ExecutionUnit.{i}.RunLevel}} and {{param|#.ExecutionUnit.{i}.AutoStart}} is {{true}}. - + Input arguments. @@ -51575,7 +55513,7 @@ - + This table serves as the Deployment Unit inventory and contains status information about each Deployment Unit. A new instance of this table gets created during the installation of a Software Module. @@ -51588,10 +55526,10 @@ - + A Universally Unique Identifier either provided by the Controller, or generated by the device, at the time of Deployment Unit Installation. - The format of this value is defined by {{bibref|RFC4122}} Version 5 (Name-Based) and {{bibref|TR-181i2a12|Appendix TBD}}. + The format of this value is defined by {{bibref|RFC4122}} Version 5 (Name-Based) and {{bibref|TR-181i2|Annex C}}. This value MUST NOT be altered when the {{object}} is updated. @@ -51600,7 +55538,7 @@ - + Deployment Unit Identifier chosen by the targeted {{object|#.ExecEnv}}. The format of this value is Execution Environment specific. @@ -51610,7 +55548,7 @@ - + {{datatype|expand}} @@ -51618,10 +55556,10 @@ - + Indicates the Name of this {{object}}, which is chosen by the author of the Deployment Unit. - The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-069|Annex H}}. + The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-181i2|Annex C}}. @@ -51629,7 +55567,7 @@ - + Indicates the status of this {{object}}. @@ -51663,7 +55601,7 @@ - + Indicates whether or not this {{object}} has resolved all of its dependencies. @@ -51671,7 +55609,7 @@ - + Contains the URL used by the most recent ChangeDUState RPC to either Install or Update this {{object}}. @@ -51681,7 +55619,7 @@ - + Textual description of this {{object}}. The format of this value is Execution Environment specific. @@ -51691,10 +55629,10 @@ - + The author of this {{object}} formatted as a domain name. - The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-069a3|Annex H}}. + The value of this parameter is used in the generation of the {{param|UUID}} based on the rules defined in {{bibref|TR-181i2|Annex C}}. @@ -51702,7 +55640,7 @@ - + Version of this {{object}}. The format of this value is Execution Environment specific. @@ -51712,7 +55650,7 @@ - + Represents the vendor log files that have come into existence because of this {{object}}. This does not include any vendor log files that have come into existence because of {{object|#.ExecutionUnit}} instances that are contained within this {{object}}. @@ -51726,7 +55664,7 @@ - + Represents the vendor config files that have come into existence because of this {{object}}. This does not include any vendor config files that have come into existence because of {{object|#.ExecutionUnit}} instances that are contained within this {{object}}. @@ -51740,7 +55678,7 @@ - + Represents the {{object|#.ExecutionUnit}} instances that are associated with this {{object}} instance. @@ -51751,7 +55689,7 @@ - + Represents the {{object|#.ExecEnv}} instance where this {{object}} instance is installed. @@ -51761,11 +55699,11 @@ - + Update the associated {{object}}. - + Input arguments. @@ -51806,13 +55744,13 @@ - + Uninstall the associated {{object}}. - + This table serves as the Execution Unit inventory and contains both status information about each Execution Unit as well as configurable parameters for each Execution Unit. Each {{object|#.DeploymentUnit}} that is installed can have zero or more Execution Units. @@ -51827,7 +55765,7 @@ - + Execution Unit Identifier chosen by the {{object|#.ExecEnv}} during installation of the associated {{object|#.DeploymentUnit}}. The format of this value is Execution Environment specific, but it MUST be unique across {{object|#.ExecEnv}} instances. Thus, it is recommended that this be a combination of the {{param|#.ExecEnv.{i}.Name}} and an Execution Environment local unique value. @@ -51838,7 +55776,7 @@ - + {{datatype|expand}} @@ -51846,7 +55784,7 @@ - + The name of this {{object}} as it pertains to its associated {{object|#.DeploymentUnit}}, which SHOULD be unique across all {{object}} instances contained within its associated {{object|#.DeploymentUnit}}. @@ -51856,7 +55794,7 @@ - + The name of this {{object}} as provided by the {{object|#.ExecEnv}}, which SHOULD be unique across all {{object}} instances contained within a specific {{object|#.ExecEnv}}. @@ -51866,7 +55804,7 @@ - + Indicates the status of this {{object}}. @@ -51895,10 +55833,10 @@ - + If while running or transitioning between states this {{object}} identifies a fault this parameter embodies the problem. The value of {{enum|NoFault}} MUST be used when everything is working as intended. {{enum}} - For fault codes not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref|TR-106a4|Section 3.3}}. + For fault codes not included in this list, the vendor MAY include vendor-specific values, which MUST use the format defined in {{bibref|TR-106|Section 3.3}}. @@ -51912,7 +55850,7 @@ - + If while running or transitioning between states this {{object}} identifies a fault this parameter provides a more detailed explanation of the problem. If {{param|ExecutionFaultCode}} has the value of {{enum|NoFault|ExecutionFaultCode}} then the value of this parameter MUST {{empty}} and ignored by the Controller. @@ -51923,7 +55861,7 @@ - + If {{true}} and the {{param|RunLevel}} verification is also met, then this {{object}} will be automatically started by the device after its {{object|#.ExecEnv}} is either rebooted or restarted. If {{false}} this {{object}} will not be started after its {{object|#.ExecEnv}} is either rebooted or restarted until it is explicitly commanded to do so by either the Controller or another Execution Unit. @@ -51932,7 +55870,7 @@ - + Determines when this {{object}} will be started. If {{param|AutoStart}} is {{true}} and {{param|#.ExecEnv.{i}.CurrentRunLevel}} is greater than or equal to {{param}}, then this {{object}} will be started. @@ -51944,7 +55882,7 @@ - + Vendor of this {{object}}. @@ -51954,7 +55892,7 @@ - + Version of the {{object}}. The format of this value is Execution Environment specific. @@ -51964,7 +55902,7 @@ - + Textual description of this {{object}}. The format of this value is Execution Environment specific. @@ -51974,7 +55912,7 @@ - + The amount of disk space measured in {{units}} currently being used by this {{object}}. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable. @@ -51985,7 +55923,7 @@ - + The amount of physical RAM measured in {{units}} currently being used by this {{object}}. A value of -1 MUST be used for {{object}} instances where this parameter is not applicable. @@ -51996,7 +55934,7 @@ - + Represents the instances of multi-instanced objects that are directly controlled by, and have come into existence because of, this {{object}}. NOTE: All other objects and parameters (i.e. not multi-instanced objects) that this {{object}} has caused to come into existence can be discovered via the GetSupportedDM and GetInstances USP messages. @@ -52008,7 +55946,7 @@ - + Represents the system processes that are active in the system because of this {{object}}. If {{param|Status}} is not {{enum|Active|Status}} it is expected that this list will be {{empty}}. Some {{object}} instances MIGHT NOT have any system processes irrespective of the value of {{param|Status}}. @@ -52020,7 +55958,7 @@ - + Represents the vendor log files that have come into existence because of this {{object}}. When the {{object|#.DeploymentUnit}} (that caused this {{object}} to come into existence) is uninstalled the vendor log files referenced here SHOULD be removed from the device. @@ -52033,7 +55971,7 @@ - + Represents the vendor config files that have come into existence because of this {{object}}. When the {{object|#.DeploymentUnit}} (that caused this {{object}} to come into existence) is uninstalled the vendor config files referenced here SHOULD be removed from the device. @@ -52046,7 +55984,7 @@ - + Represents the {{object|#.ExecEnv}} that this {{object}} is associated with. @@ -52056,12 +55994,12 @@ - + - Set the state transition that the Controller is requesting for this instance of the {{object}} object. {{enum}} + Set the state transition that the Controller is requesting for this instance of the {{object}} object. If this instance of the {{object}} object is associated with an Execution Environment that is disabled and an attempt is made to alter this value, then a error message MUST be generated. - + Input arguments. @@ -52101,7 +56039,7 @@ - + {{datatype|expand}} @@ -52109,6 +56047,652 @@ + + + {{datatype|expand}} + + + + + + + + Human-readable description of the {{object}}. e.g. a more detailed description of {{param|Type}}. + + + + + + + + + + A textual name of the instance, which can be assigned by the user. {{object}}. + + + + + + + + + + This parameter provides the state of the {{object}} on the underlying (proxied) connected network. + + + + + + + + The date time of the last successful contact. + + + + + + + + {{reference|a protocol object that uses the {{param|ProxyProtocol}}}}. + + + + + + + + + + The protocol being used to communicate between the Agent and this Proxied Device. {{enum}} + Vendors can extend the enumerated values with vendor specific extensions, in which case the rules outlined in {{bibref|TR-106a6|3.3}} MUST be adhered to. + + + + + + see {{bibref|Z-Wave}} + + + + + see {{bibref|ZigBee}} + + + + + see {{bibref|UPnP-DM:1}} + + + + + + + + {{numentries}} + + + + + + + + + Each Node instance represents distinct functional devices, which are virtual and abstracted representation of functionality. + + + + + + + {{datatype|expand}} + + + + + + + + {{datatype|expand}} + + + + + + + + Human-readable description of the {{object}}. e.g. a more detailed description of {{param|Type}}. + + + + + + + + + + + This list of IoT capability objects. + + + + + + + + + + {{datatype|expand}} + + + + + + + + A textual name of the instance, which can be assigned by the user. + + + + + + + + + + Describes the type of functionality that {{object}} is representing. Depending on the functionality the corresponding sub-object is instantiated. + Note: Only one of the defined sub-objects can exist in an {{object}} instance. + + + + + + + + + + + + + + + + + This capability provides a boolean function that is mapped to the type of function it represents. + E.g. If the instance represents a door lock ({{param|Type}} is {{enum|Locked|Type}}), a {{param|Value}} of {{true}} says the door lock is locked. + + + + Describes the type of functionality that {{object}} is representing. + + + + + + + + + + + Human-readable description of the {{object}}. e.g. a more detailed description of {{param|Type}}. + + + + + + + + + + Value of {{true}} or {{false}} that reflects the functionality. + + + + + + + + Toggle the {{param|Value}}. + + + + + + LevelController is used to model a control with a range of continuous states. + These values are configurable via {{param|Value}} and measured in {{param|Unit}} and are restricted between a Min and Max values. + Intensity profile - {{param|Value}} of intensity and ability to update that level through {{param|StepUp}} and {{param|StepDown}} commands with a configurable {{param|StepValue}}. + + + + {{datatype|expand}} + + + + + + + + Human-readable description of the {{object}}. e.g. a more detailed description of {{param|Type}}. + + + + + + + + + + The desired run value that this {{object}} will be between {{param|MinValue}} and {{param|MaxValue}}. + + + + + + + + Units in which {{param|Value}}, {{param|Value}}, {{param|MinValue}}, {{param|MaxValue}} and {{param|StepValue}} are expressed. {{datatype|expand}}. + + + + + + + + Minimum allowed value for {{param|Value}}. + + + + + + + + Maximum allowed value for {{param|Value}}. + + + + + + + + Number of {{param|Unit}} changes of each {{param|StepUp}} and {{param|StepDown}} command. + + + + + + + + Step Up the {{param|Value}}. + + + + + Step Down the {{param|Value}}. + + + + + + The EnumControl reflects the Enumerated level Control functionality. + The enumeration is defined by the {{param|ValidValues}} parameter. This will provide a comma-separated list of values that are available for configuring via the {{param|Value}} parameter. + + + + {{datatype|expand}} + + + + + + + + Human-readable description of the {{object}}. e.g. a more detailed description of {{param|Type}}. + + + + + + + + + + Current value representing the {{object}}; MUST be an element of {{param|ValidValues}}. + + + + + + + + List of valid values from the control represented by the {{object}}. + + + + + + + + + + + Step up the {{param|Value}} to the next allowed value in the enum. + + + + + Step down the {{param|Value}} to the previous allowed value in the enum. + + + + + + BinarySensor is used to reflect the functionality of a sensor that reports a {{param|Value}}. The {{param|Sensitivity}} configures the degree of sensitivity that the sensor uses for detection. + Timed BinarySensor profile - To provide the ability to add time based control over the {{param|Value}} attribute. How long the {{param|Value}} remains true is controlled by the {{param|HoldTime}}. {{param|RestTime}} controls how soon, after being activated, the sensor will respond to continuous events. + + + + Describes the type of functionality that {{object}} is representing. + + + + + + + + + + + + + + + + Human-readable description of the {{object}}. e.g. a more detailed description of {{param|Type}}. + + + + + + + + + + If the {{object}} has been recently activated, the value would be true. For how long the state attribute remain true after being activated depends on the underlying sensor reports. + + + + + + + + The date and time in UTC when {{param|Value}} has been changed to the current value. + + + + + + + + A 0 to 100 value indicating how reactive to changes the {{object}} should be, 0 being not sensible / disabled and 100 max sensitivity. + + + + + + + + + + After activation has been detected and the sensing attribute set to true, how soon, in {{units}} should the {{param|Value}} be reset to {{false}}. + + + + + + + + + + After activation has been detected and the {{param|Value}} set to {{true}}, how soon, in {{units}} should affected again per subsequent event. + + + + + + + + + + + LevelSensor is used to reflect the functionality of a sensor that reports a {{param|Value}} in {{param|Unit}}. + + + + {{datatype|expand}} + + + + + + + + Human-readable description of the {{object}}. e.g. a more detailed description of {{param|Type}}. + + + + + + + + + + The current value reading of this {{object}} in units defined in {{param|Unit}}. + + + + + + + + The date and time in UTC when {{param|Value}} has been changed to the current value. + + + + + + + + {{datatype|expand}} + Unit in which {{param|Value}} is expressed. + + + + + + + + Low level indicator. Is set to {{true}} if {{param|Value}} is equal or less than the value defined in {{param|LowLevelThreshold}}. + + + + + + + + The threshold value in for {{param|LowLevel}} expressed in the same units like {{param|Value}}. + + + + + + + + High level indicator. Is set to {{true}} if {{param|Value}} is equal or higher than the value defined in {{param|HighLevelThreshold}}. + + + + + + + + The threshold value in for {{param|HighLevel}} expressed in the same units like {{param|Value}}. + + + + + + + + + MultiLevelSensor is used to reflect the functionality of a sensor that reports multiple {{param|Values}} with the same {{param|Unit}}. + + + + Describes the type of functionality that {{object}} is representing. + + + + + + RGB color, encoded as integer value between 0 (usually represented as 0x000000) and 16777215 (usually represented as 0xFFFFFF), e.g. Blue would be 255 (usually represented as 0x0000FF) + + + + + The sensor reports a location with the values of Longitude, Latitude, Altitude as decimal values in km. + + + + + + + + Human-readable description of the {{object}}. e.g. a more detailed description of {{param|Type}}. + + + + + + + + + + The current value reading of this {{object}} in units defined in {{param|Unit}}. + + + + + + + + + The names of the values expressed in {{param|Values}}. + + + + + + + + + The date and time when {{param|Values}} has been changed to the current values. + + + + + + + + {{datatype|expand}} + Unit in which {{param|Values}} are expressed. + + + + + + + + + EnumSensor is used to reflect the functionality of a sensor that reports explicit non-continuous values. + + + + {{datatype|expand}} + + + + + + + + Human-readable description of the {{object}}. e.g. a more detailed description of {{param|Type}}. + + + + + + + + + + The actual reading value; MUST be a member of the enumeration defined in {{param|ValidValues}}. + + + + + + + + The date and time when {{param|Value}} has been changed to the current value. + + + + + + + + List of valid values reported from the sensor represented by this {{object}}. + + + + + + + + + + + + Each Node instance represents distinct functional devices, which are virtual and abstracted representation of functionality. + + + + + + + {{datatype|expand}} + + + + + + + + {{datatype|expand}} + + + + + + + + Human-readable description of the {{object}}. e.g. a more detailed description of {{param|Type}}. + + + + + + + @@ -53834,7 +58418,7 @@ - + @@ -53931,7 +58515,7 @@ - + @@ -55144,6 +59728,33 @@ + + + Provides MQTT client control + + + + + + + + + + + + + + + + + + + + + + + + Provides basic MQTT client control and statistics @@ -55154,11 +59765,11 @@ + - @@ -55171,6 +59782,9 @@ Adds client subscription control and access to received topics + + + @@ -55939,7 +60553,118 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -55952,6 +60677,7 @@ + @@ -55961,17 +60687,18 @@ - + + - + @@ -55984,6 +60711,7 @@ + @@ -55993,26 +60721,28 @@ - + + - + + - + @@ -56023,6 +60753,7 @@ + @@ -56036,10 +60767,53 @@ - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -56051,6 +60825,7 @@ + @@ -56060,7 +60835,7 @@ - + @@ -56072,6 +60847,7 @@ + @@ -56081,7 +60857,7 @@ - + @@ -56094,6 +60870,7 @@ + @@ -56105,7 +60882,7 @@ - + @@ -56114,6 +60891,7 @@ + @@ -56123,7 +60901,7 @@ - + Note: This profile is valid for G.992.1 modems. @@ -56133,6 +60911,7 @@ + @@ -56146,7 +60925,7 @@ - + Note: This profile is valid for G.992.3 and G.992.5 modems. @@ -56156,6 +60935,7 @@ + @@ -56184,7 +60964,7 @@ - + Note: This profile is valid for G.993.2 modems. @@ -56194,6 +60974,7 @@ + @@ -56230,7 +61011,33 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -56244,6 +61051,7 @@ + @@ -56256,7 +61064,7 @@ - + @@ -56265,13 +61073,14 @@ + - + @@ -56285,6 +61094,7 @@ + @@ -56304,7 +61114,7 @@ - + @@ -56314,6 +61124,7 @@ + @@ -56343,19 +61154,6 @@ - - - - - - - - - - - - - @@ -56557,6 +61355,22 @@ + + + + + + + + + + + + + + + + @@ -56597,11 +61411,36 @@ + + + + + + + + + + + + + + + + + + This profile adds USP agent extensions for MQTT transport. + + + + + + + @@ -56619,13 +61458,37 @@ + + - + + + + + + + + + + + + + + + + This profile adds USP controller extensions for MQTT transport. + + + + + + + @@ -56638,7 +61501,6 @@ - @@ -56657,6 +61519,26 @@ + + + + + + + + + + + + + + + + + + + +