Broadband Forum

USP Device:2.15 Root Object definition
tr-181-2-15-1-usp.xml (changes)

DATA MODEL DEFINITION

License

Copyright (c) 2010-2022, Broadband Forum

The undersigned members have elected to grant the copyright to their contributed material used in this software:
Copyright (c) 2017-2019, 2021 ARRIS Enterprises, LLC.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The above license is used as a license under copyright only. Please reference the Forum IPR Policy for patent licensing terms <https://www.broadband-forum.org/ipr-policy>.

Any moral rights which are necessary to exercise under the above license grant are also deemed granted under this license.

Comments or questions about this Broadband Forum data model should be directed to <info@broadband-forum.org>.

Data Types

The Parameters defined in this specification make use of a limited subset of the default SOAP data types [SOAP1.1]. These data types and the named data types used by this specification are described below.

Note: A Parameter that is defined to be one of the named data types is reported as such at the beginning of the Parameter's description via a reference back to the associated data type definition (e.g. [MacAddress]). However, such parameters still indicate their SOAP data type.

Data Type Base Type Description
base64 -

Base64 encoded binary (no line-length limitation).

A minimum and maximum allowed length can be indicated using the form base64(Min:Max), where Min and Max are the minimum and maximum length in characters before Base64 encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in base64(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

boolean - Boolean, where the allowed values are 0 or 1 (or equivalently, true or false).
dateTime - The subset of the ISO 8601 date-time format defined by the SOAP dateTime type.
decimal -

Decimal value.

For some decimal types, a value range is given using the form decimal[Min:Max] where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

hexBinary -

Hex encoded binary.

A minimum and maximum allowed length can be indicated using the form hexBinary(Min:Max), where Min and Max are the minimum and maximum length in characters before Hex Binary encoding. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in hexBinary(Max). Multiple comma-separated ranges can be specified, in which case the length MUST be in one of the ranges.

int -

Integer in the range -2147483648 to +2147483647, inclusive.

For some int types, a value range is given using the form int[Min:Max] or int[Min:Max step Step] where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

long -

Long integer in the range -9223372036854775808 to 9223372036854775807, inclusive.

For some long types, a value range is given using the form long[Min:Max] or long[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

string - For strings, a minimum and maximum allowed length can be indicated using the form string(Min:Max), where Min and Max are the minimum and maximum string length in characters. If either Min or Max are missing, this indicates no limit, and if Min is missing the colon can also be omitted, as in string(Max). Multiple comma-separated ranges can be specified, in which case the string length will be in one of the ranges.
unsignedInt -

Unsigned integer in the range 0 to 4294967295, inclusive.

For some unsignedInt types, a value range is given using the form unsignedInt[Min:Max] or unsigned[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

unsignedLong -

Unsigned long integer in the range 0 to 18446744073709551615, inclusive.

For some unsignedLong types, a value range is given using the form unsignedLong[Min:Max] or unsignedLong[Min:Max step Step], where the Min and Max values are inclusive. If either Min or Max are missing, this indicates no limit. If Step is missing, this indicates a step of 1. Multiple comma-separated ranges can be specified, in which case the value will be in one of the ranges.

References

Legend

Object definition.
Mountable Object definition.
Mount Point definition.
Parameter definition.
Command or Event definition.
Command Input / Output Arguments container.
Command or Event Object Input / Output Argument definition.
Command or Event Parameter Input / Output Argument definition.

Device:2.15 Data Model ​(changes)

For a given implementation of this data model, the Agent MUST indicate support for the highest version number of any object or parameter that it supports. For example, even if the Agent supports only a single parameter that was introduced in version 2.15, then it will indicate support for version 2.15. The version number associated with each object and parameter is shown in the Version column.

Name Type Syntax Write Description Object Default Version Spec
Device. object object​[1:1] - The top-level object for a Device. - 2.12 TR-181i2a14
Boot! event object - Boot event indicating that the Device was rebooted. - 2.12 TR-181i2a15c1
⇒ Cause string string -

The cause of the boot. Enumeration of:

  • LocalReboot (A Boot! Event that was the result of a reboot triggered locally on the Device (NOT as a result of a Reboot() Command or other remote trigger, e.g. another remote management protocol))
  • RemoteReboot (A Boot! Event that was the result of a reboot triggered via the Reboot() Command or other remote trigger, e.g. another remote management protocol)
  • FactoryReset (A Boot! Event that was the result of a factory reset triggered locally on the Device or remotely (as a result of a FactoryReset() Command or other remote trigger, e.g. another remote management protocol), which is to be used when the Agent cannot differentiate between local and remote, added in v2.15)
  • LocalFactoryReset (A Boot! Event that was the result of a factory reset triggered locally on the Device (NOT as a result of a FactoryReset() Command or other remote trigger, e.g. another remote management protocol))
  • RemoteFactoryReset (A Boot! Event that was the result of a factory reset triggered via the FactoryReset() Command or other remote trigger, e.g. another remote management protocol)
- 2.12 TR-181i2a15c1
Device.​WiFi. object object​[1:1] - The WiFi object is based on the IEEE 802.11 specifications ([802.11-2020]). It defines interface objects (Radio and SSID), and application objects (AccessPoint and EndPoint). - 2.12 TR-181i2a15
Device.​WiFi.​DataElements. object object​[1:1] - This object represents the Wi-Fi Alliance Data Elements as defined in [DataElements] with extended capabilities in additional objects whose names begin with MultiAP. - 2.13 TR-181i2a15
Device.​WiFi.​DataElements.​Network. object object​[1:1] - This object describes a Wi-Fi network containing 1 or more Access Point (AP) devices. - 2.13 TR-181i2a15
SetTrafficSeparation​() command object -

[ASYNC] This command allows or disallows EasyMesh traffic separation [Section 19.1/EasyMesh]. If Enable is true then the parameters defining traffic separation details can also be input with this command.

This command applies to all EasyMesh Agent devices in the Wi-Fi network.

This command can configure Device.{i}.SSIDtoVIDMapping.{i}. and Device.{i}.TrafficSeparationAllowed.

Status is to be returned after implementation or failed implementation on all agents/devices/APs in this Multi-AP network.

- 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ Enable boolean boolean W

[MANDATORY]

true: EasyMesh traffic separation is allowed.
false: EasyMesh traffic separation is not allowed.
- 2.15 TR-181i2a15c1
⇒ SSIDtoVIDMapping.​{i}. object​[0:] object​[0:∞] W

The Service Set Identifier (SSID) to VLAN ID (VID) mapping for EasyMesh traffic separation [EasyMesh]. Consists of a table of pairs of SSID and corresponding VID.

If this input is not provided, then existing Device.{i}.SSIDtoVIDMapping.{i}. apply.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for SSID.

- 2.15 TR-181i2a15c1
⇒ SSID string string W The SSID name. - 2.15 TR-181i2a15c1
⇒ VID unsignedInt​(:4095) unsignedInt​(:4095) W The VLAN ID (VID). - 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to allow or disallow EasyMesh traffic separation. Enumeration of:

- 2.15 TR-181i2a15c1
SetServicePrioritization​() command object -

[ASYNC] This command allows or disallows EasyMesh service prioritization [Section 20/EasyMesh]. If Enable is true then the parameters defining service prioritization details can also be input with this command.

This command can configure Device.{i}.SPRule.{i}., Device.{i}.DSCPMap and Device.{i}.ServicePrioritizationAllowed.

This command applies to all EasyMesh Agent devices in the Wi-Fi network.

Status is to be returned after implementation or failed implementation on all agents/devices/APs in this Multi-AP network.

- 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ Enable boolean boolean W

[MANDATORY]

true: EasyMesh service prioritization is allowed.
false: EasyMesh service prioritization is not allowed.
- 2.15 TR-181i2a15c1
⇒ DSCPMap hexBinary​(64) hexBinary​(64) W

A hexadecimal string of 64 PCP values (one octet per value) corresponding to the DSCP markings 0x00 to 0x3F, ordered by increasing DSCP value. Each octet is in the range 0x00 – 0x07. This is used to select a PCP value if a Service Prioritization Rule specifies Rule Output: 0x08.

If this input is not provided, then the existing Device.{i}.DSCPMap applies.

- 2.15 TR-181i2a15c1
⇒ SPRule.​{i}. object​[0:] object​[0:∞] W

This object describes a list of service prioritization (SP) rules [EasyMesh].

If this input is not provided, then existing Device.{i}.SPRule.{i}. apply.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for ID.

- 2.15 TR-181i2a15c1
⇒ ID unsignedInt unsignedInt W Service prioritization rule Identifier. - 2.15 TR-181i2a15c1
⇒ Precedence unsignedInt​(:254) unsignedInt​(:254) W Rule Precedence – higher number means higher priority. - 2.15 TR-181i2a15c1
⇒ Output unsignedInt​(:9) unsignedInt​(:9) W Rule Output. The value of, or method used to select the 802.1Q C-TAG Priority Code Point (PCP) output value. - 2.15 TR-181i2a15c1
⇒ AlwaysMatch boolean boolean W Indicates if the rule always matches. - 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to allow or disallow EasyMesh service prioritization. Enumeration of:

- 2.15 TR-181i2a15c1
SetPreferredBackhauls​() command object - [ASYNC] This command sets preferred backhaul links for EasyMesh [EasyMesh] backhaul. - 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ PreferredBackhauls.​{i}. object​[1:] object​[1:∞] W

Indicates preferred backhaul links for EasyMesh [EasyMesh] backhaul. Consists of a table of pairs of MAC addresses. For a WI-Fi connection pair, an entry contains the BSSID and bSTA MAC address. For a wired connection pair, an entry contains the interface MAC addresses. This command applies to all EasyMesh Agent devices in the Wi-Fi network.

Status is to be returned after implementation or failed implementation on all agents/devices/APs in this Multi-AP network.

This table MUST contain at least 1 entry. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for BackhaulMACAddress.

- 2.15 TR-181i2a15c1
⇒ BackhaulMACAddress string​(17) MACAddress W [MANDATORY] [MACAddress] The MAC address of the BSS, or similar Ethernet interface, on this preferred backhaul link. - 2.15 TR-181i2a15c1
⇒ bSTAMACAddress string​(17) MACAddress W [MANDATORY] [MACAddress] The MAC address of the backhaul STA (bSTA), or similar Ethernet interface, on this preferred backhaul link. - 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to set preferred backhaul links. Enumeration of:

- 2.15 TR-181i2a15c1
SetSSID​() command object -

[ASYNC] This command specifies an SSID for fronthaul use across this Wi-Fi Multi-AP network, or on this single-AP. Also specifies the PassPhrase, whether to add or remove this SSID, and specifies the Band for each SSID.

This command applies to all EasyMesh Agent devices in the Wi-Fi network, or to this AP in the single-AP case.

This command can be used to set only PassPhrase if SSID matches an existing SSID.{i}.SSID for this Band for fronthaul use across this Wi-Fi Multi-AP network.

This command can configure SSID.{i}.

Status is to be returned after implementation or failed implementation on all agents/devices/APs in this Multi-AP network.

- 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ SSID string string W [MANDATORY] The SSID for fronthaul use across this Wi-Fi Multi-AP network. - 2.15 TR-181i2a15c1
⇒ AddRemove string string W

[MANDATORY] Indicates whether to add or remove this SSID.

true: add this SSID,
false: remove this SSID.

Status is to be returned after implementation or failed implementation on all agents/devices/APs in this Multi-AP network.

If set to true, and this SSID already exists for this Band, then there is no change to the SSID, but the PassPhrase is set.

- 2.15 TR-181i2a15c1
⇒ PassPhrase string string W The WPA2 Passphrase and/or SAE password for this SSID. - 2.15 TR-181i2a15c1
⇒ Band string​[] list of string W

Comma-separated list of strings. The band(s) for which this SSID applies. Each list item is an enumeration of:

  • All (Applies to all bands)
  • 2.4 (2.4 GHz band)
  • 5 (The entire 5 GHz band)
  • 6 (The entire 6 GHz band)
  • 5_UNII_1 (5 GHz UNII-1 band, 5.15 to 5.25 GHz)
  • 5_UNII_2 (5 GHz UNII-2 band, 5.25 to 5.725 GHz)
  • 5_UNII_3 (5 GHz UNII-3 band, 5.725 to 5.85 GHz)
  • 5_UNII_4 (5 GHz UNII-4 band, 5.85 to 5.925 GHz)
  • 6_UNII_5 (6 GHz UNII-5 band, 5.925 to 6.425 GHz)
  • 6_UNII_6 (6 GHz UNII-6 band, 6.425 to 6.525 GHz)
  • 6_UNII_7 (5 GHz UNII-7 band, 6.525 to 6.875 GHz)
  • 6_UNII_8 (5 GHz UNII-8 band, 6.875 to 7.125 GHz)

If this input is not provided, then a value of All applies.

- 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to set the SSID. Enumeration of:

- 2.15 TR-181i2a15c1
SetMSCSDisallowed​() command object -

[ASYNC] This command disallows Mirrored Stream Classification Service (MSCS) service prioritization to particular STA(s). [EasyMesh]

This command applies to all EasyMesh Agent devices in the Wi-Fi network.

This command configures MSCSDisallowedStaList.

- 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ MSCSDisallowedStaList string​[]​(17) list of MACAddress W [MANDATORY] [MACAddress] Comma-separated list of MACAddresses. List of STAs for which MSCS operation is disallowed. - 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to disallow MSCS service prioritization to particular STA(s) Enumeration of:

- 2.15 TR-181i2a15c1
SetSCSDisallowed​() command object -

[ASYNC] This command disallows Stream Classification Service (SCS) service prioritization to particular STA(s). [EasyMesh]

This command applies to all EasyMesh Agent devices in the Wi-Fi network.

This command can configure SCSDisallowedStaList.

- 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ SCSDisallowedStaList string​[]​(17) list of MACAddress W [MANDATORY] [MACAddress] Comma-separated list of MACAddresses. List of STAs for which SCS operation is disallowed. - 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to disallow SCS service prioritization to particular STA(s). Enumeration of:

- 2.15 TR-181i2a15c1
Device.​WiFi.​DataElements.​Network.​Device.​{i}. object​[1:] object​[1:∞] -

Each instance of this object represents an individual Access Point device in the Wi-Fi network.

This table MUST contain at least 1 entry.

At most one entry in this table can exist with a given value for ID.

- 2.13 TR-181i2a15
SetSTASteeringState​() command object -

[ASYNC] Disallow or allow EasyMesh [EasyMesh] controller-initiated station (STA) steering on this device.

This command can configure STASteeringState.

- 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ Disallowed boolean boolean W

[MANDATORY]

true: EasyMesh controller-initiated station steering disallowed;
false: EasyMesh controller-initiated station steering allowed.
- 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to allow or disallow EasyMesh controller-initiated station steering. Enumeration of:

- 2.15 TR-181i2a15c1
SetDFSState​() command object -

[ASYNC] Enables/disables the use of Dynamic Frequency Selection (DFS) channels on this device.

This command can configure DFSEnable.

- 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ DFSEnable boolean boolean W

[MANDATORY]

true: the use of Dynamic Frequency Selection (DFS) channels is allowed;
false: the use of Dynamic Frequency Selection (DFS) channels is disallowed;
- 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to allow or disallow the use of Dynamic Frequency Selection (DFS) channels. Enumeration of:

- 2.15 TR-181i2a15c1
SetAnticipatedChannelPreference​() command object - [ASYNC] This command requests to set the Anticipated Channel Preference. The operating classes, and list of channels for each operating class, are input. For 2.4GHz and 5GHz bands, only 20MHz operating classes are valid inputs. - 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ OpClass unsignedInt​(:255) unsignedInt​(:255) W

[MANDATORY] The Operating Class per [Table E-4/802.11-2020] For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid.

Note that the operating class identifies the band and channel width.

- 2.15 TR-181i2a15
⇒ ChannelList unsignedInt​[]​(:255) list of unsignedInt​(:255) W [MANDATORY] Comma-separated list of unsigned integers (value 0 to 255). The channel numbers in this Operating Class for which the capability is being described. - 2.15 TR-181i2a15
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to set the anticipated channel preference. Enumeration of:

- 2.15 TR-181i2a15c1
Device.​WiFi.​DataElements.​Network.​Device.​{i}.​MultiAPDevice. object object​[1:1] - This object represents an individual Access Point device. - 2.15 TR-181i2a15
Device.​WiFi.​DataElements.​Network.​Device.​{i}.​MultiAPDevice.​Backhaul. object object​[1:1] -

This object represents an individual Access Point device's Backhaul and unique aspects in the Wi-Fi network.

The endpoints of the backhaul interface are represented by the (Device's ID and interface MAC Address). This object represents the upward view of the backhaul interface. The two endpoints of the backhaul interface are - (BackhaulDeviceID, BackhaulMACAddress) of the uplinked Backhaul Device - MACAddress of this Access Point Device

  BackhaulDeviceID / BackhaulMACAddress <--
  LinkType --- < MACAddress
An empty string is reserved for the Backhaul instance that represents the Multi-AP Controller.
- 2.15 TR-181i2a15
SteerWiFiBackhaul​() command object -

[ASYNC] This command requests the Wi-Fi backhaul link to be steered to associate to a different BSS when the device is working as a bridge in a mesh network. The device needs to already have the necessary credentials for the switch to happen.

The TargetBSS should be an instance of a Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.BSS.{i}.BSSID.

- 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ TargetBSS string​(17) MACAddress W [MANDATORY] [MACAddress] Basic Service Set Identifier (BSSID) of the target BSS which the associated device(s) is to be associated to. - 2.15 TR-181i2a15
⇒ Channel unsignedInt unsignedInt W The number of the Wi-Fi channel the backhaul BSS is to be associated to. If Channel is not specified, then the radio is to determine which channel to use to associate to the requested SSID. - 2.15 TR-181i2a15
⇒ TimeOut unsignedInt unsignedInt W [MANDATORY] The maximum timeout for this backhaul steering to occur in milliseconds. - 2.15 TR-181i2a15
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the response to the Wi-Fi backhaul steering request. Enumeration of:

- 2.15 TR-181i2a15c1
Device.​WiFi.​DataElements.​Network.​Device.​{i}.​Radio.​{i}. object​[1:] object​[1:∞] -

This object represents all of the individual Radios contained within the identified Access Point device known to the controller.

This table MUST contain at least 1 entry.

At most one entry in this table can exist with a given value for ID.

- 2.13 TR-181i2a15
ChannelScanRequest​() command object -

[ASYNC] Request to initiate a channel scan. The operating classes, and list of channels for each operating class, are input. For 2.4GHz and 5GHz bands, only 20MHz operating classes are valid inputs.

This command should result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult.

- 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ OpClass unsignedInt​(:255) unsignedInt​(:255) W

[MANDATORY] The Operating Class per [Table E-4/802.11-2020] For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid.

Note that the operating class identifies the band and channel width.

- 2.15 TR-181i2a15
⇒ ChannelList unsignedInt​[]​(:255) list of unsignedInt​(:255) W [MANDATORY] Comma-separated list of unsigned integers (value 0 to 255). The channel numbers in this Operating Class for which the capability is being described. - 2.15 TR-181i2a15
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to initiate a channel scan. Enumeration of:

- 2.15 TR-181i2a15c1
RadioEnable​() command object -

[ASYNC] Request to enable or disable this radio.

This command can result in updating Enabled.

- 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ Enable boolean boolean W

[MANDATORY]

true: this radio is to be enabled.
false: this radio is to be disabled.
- 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to enable or disable this radio. Enumeration of:

- 2.15 TR-181i2a15c1
SetTxPowerLimit​() command object -

[ASYNC] This command sets the upper limit on transmit power TransmitPowerLimit for this radio and OperatingClass.

This command can configure CurrentOperatingClassProfile.{i}.TransmitPowerLimit.

- 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ TransmitPowerLimit int​(-128:127) int​(-128:127) W [MANDATORY] This is the upper limit on nominal transmit Equivalent Isotropically Radiated Power (EIRP) that this radio can use for the OperatingClass. In units of decibels relative to 1 mW dBm. - 2.15 TR-181i2a15c1
⇒ OperatingClass unsignedInt​(:255) unsignedInt​(:255) W [MANDATORY] The Operating Class per [Table E-4/802.11-2020] of the radio. Note that the Operating Class identifies the band and channel width. - 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to set a transmit power limit. Enumeration of:

- 2.15 TR-181i2a15c1
SetSpatialReuse​() command object -

[ASYNC] This command sets the spatial reuse configuration of this radio. Applies only to Wi-Fi 6 and possibly later generations of radios.

Acronyms: Spatial Reuse Group (SRG), Overlapping Basic Service Set (OBSS), Preamble Detection (PD).

This command can configure SpatialReuse..

If some input parameter(s) are not provided, then the corresponding existing parameter in SpatialReuse. applies.

- 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ BSSColor unsignedInt unsignedInt W The value of the BSS Color subfield of the HEOperations.BSSColorInformation field being transmitted by BSSs operating on this radio. (EasyMesh TLV Field: BSS Color) - 2.15 TR-181i2a15
⇒ HESIGASpatialReuseValue15Allowed boolean boolean W

Indicates if the Agent is allowed to set HESIGA.SpatialReuse field to value 15 (PSR_AND_NON_SRG_OBSS_PD_PROHIBITED) in HE PPDU transmissions of this radio. (EasyMesh TLV Field: HESIGA_Spatial_reuse_value15_allowed)

true: allowed;
false: disallowed.
- 2.15 TR-181i2a15
⇒ SRGInformationValid boolean boolean W

This field indicates whether the SRG Information fields (SRG OBSS PD Min Offset, SRG OBSS PD Max Offset, SRG BSS Color Bitmap and SRG Partial BSSID Bitmap) in this command are valid. (EasyMesh TLV Field: SRG Information Valid)

true: SRG Information fields valid;
false: SRG Information fields not valid.
- 2.15 TR-181i2a15
⇒ NonSRGOffsetValid boolean boolean W

This field indicates whether the Non-SRG OBSSPD Max Offset field in this command is valid. (EasyMesh TLV Field: Non-SRG Offset Valid)

true: Non-SRG Max Offset field valid;
false: Non-SRG Max Offset field not valid.
- 2.15 TR-181i2a15
⇒ PSRDisallowed boolean boolean W

Indicates if the Agent is disallowed to use Parameterized Spatial Reuse (PSR)-based Spatial Reuse for transmissions by the specified radio. (EasyMesh TLV Field: PSR Disallowed)

true: PSR disallowed;
false: PSR allowed.
- 2.15 TR-181i2a15
⇒ NonSRGOBSSPDMaxOffset unsignedInt unsignedInt W

The value of dot11NonSRGAPOBSSPDMaxOffset (i.e the Non-SRG OBSSPD Max Offset value being used to control the transmissions of the specified radio). (EasyMesh TLV Field: Non-SRG OBSSPD Max Offset)

This field is valid only if NonSRGOffsetValid is true.

- 2.15 TR-181i2a15
⇒ SRGOBSSPDMinOffset unsignedInt unsignedInt W

The value of dot11SRGAPOBSSPDMinOffset (i.e. the SRG OBSSPD Min Offset value being used to control the transmissions of the specified radio). (EasyMesh TLV Field: SRG OBSSPD Min Offset)

This field is valid only if SRGInformationValid is true.

- 2.15 TR-181i2a15
⇒ SRGOBSSPDMaxOffset unsignedInt unsignedInt W

The value of dot11SRGAPOBSSPDMaxOffset (i.e. the SRG OBSSPD Max Offset value being used to control the transmissions of the specified radio). (EasyMesh TLV Field: SRG OBSSPD Max Offset)

This field is valid only if SRGInformationValid is true.

- 2.15 TR-181i2a15
⇒ SRGBSSColorBitmap hexBinary​(8:8) hexBinary​(8:8) W

The value of dot11SRGAPBSSColorBitmap (i.e. the SRG BSS Color Bitmap being used to control the tranmissions of the specified radio). (EasyMesh TLV Field: SRG BSS Color Bitmap)

This field is valid only if SRGInformationValid is true.

- 2.15 TR-181i2a15
⇒ SRGPartialBSSIDBitmap hexBinary​(8:8) hexBinary​(8:8) W

The value of dot11SRGAPBSSIDBitmap (i.e. the SRG Partial BSSID Color Bitmap being used to control the transmissions of the specified radio). (EasyMesh TLV Field: SRG Partial BSSID Bitmap)

This field is valid only if SRGInformationValid is true.

Note: See rules in section 26.10.2.3 of [17] regarding the members of an SRG.

- 2.15 TR-181i2a15
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to set the spatial reuse configuration of this radio. Enumeration of:

- 2.15 TR-181i2a15c1
WiFiRestart​() command object - [ASYNC] Request a restart of the Wi-Fi subsystem. - 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to restart the Wi-Fi subsystem. Enumeration of:

- 2.15 TR-181i2a15c1
Device.​WiFi.​DataElements.​Network.​Device.​{i}.​Radio.​{i}.​BSS.​{i}. object​[1:] object​[1:∞] -

A single logical BSS operating on this radio.

This table MUST contain at least 1 entry.

At most one entry in this table can exist with a given value for BSSID.

- 2.13 TR-181i2a15
SetQMDescriptors​() command object -

[ASYNC] This command configures each of the descriptor elements for Mirrored Stream Classification Service (MSCS), Stream Classification Service (SCS), or QoS Management. [EasyMesh].

This command can configure QMDescriptor.{i}..

If QMDescriptor.{i}.DescriptorElement is for SCS or MSCS, the AP adds/changes/removes the rule according to the descriptor element request type.

If a QMDescriptor.{i}.DescriptorElement is a QoS Management DSCP Policy, the AP sends it to the STA identified by the QMDescriptor.{i}.ClientMAC.

- 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ QMDescriptor.​{i}. object​[1:] object​[1:∞] W

This object contains a table of DescriptorElement.

This table MUST contain at least 1 entry. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for ClientMAC.

- 2.15 TR-181i2a15c1
⇒ ClientMAC string​(17) MACAddress W [MANDATORY] [MACAddress] MAC address of the Station (STA) for which this descriptor applies. - 2.15 TR-181i2a15c1
⇒ DescriptorElement hexBinary hexBinary W

[MANDATORY] The descriptor element. One of:

MSCS descriptor element (as described in [Section 9.4.2.243/802.11-2020], or
SCS descriptor element (as described in [Section 9.4.2.121/802.11-2020], or
QoS Management DSCP policy element (as described in [Section 5.3/RFC8325]).
- 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to configure descriptor elements. Enumeration of:

- 2.15 TR-181i2a15c1
Device.​WiFi.​DataElements.​Network.​Device.​{i}.​Radio.​{i}.​BSS.​{i}.​STA.​{i}. object​[0:] object​[0:∞] -

Object describing a single Associated Device (STA).

At most one entry in this table can exist with a given value for MACAddress.

- 2.13 TR-181i2a15
Device.​WiFi.​DataElements.​Network.​Device.​{i}.​Radio.​{i}.​BSS.​{i}.​STA.​{i}.​MultiAPSTA. object object​[1:1] -

The summary of statistics and operations for an individual STA on the Wi-Fi network.

The counters contained in MultiAPSTA are all reset on reboot.

- 2.15 TR-181i2a15
Disassociate​() command object - [ASYNC] This command represents a request to disassociate this associated device. - 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ DisassociationTimer unsignedInt unsignedInt W [MANDATORY] The time for which the associated device is to be disassociated in minutes. If set to 0, then the associated device is blocked indefinately. - 2.15 TR-181i2a15
⇒ ReasonCode unsignedInt unsignedInt W [MANDATORY] The reason code for the request for the associated device to be disassociated, as defined in [Table 9-49/802.11-2020]. - 2.15 TR-181i2a15
⇒ Silent boolean boolean W

An optional input, if true then this is a request for a Silent Disassociate, whereby the AP is to remove the station from its list of associated devices without sending a message to the station.

If this input in not provided, then a value of false is assumed.

- 2.15 TR-181i2a15
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the response to the request to disassociate an associated device. Enumeration of:

- 2.15 TR-181i2a15c1
BTMRequest​() command object - [ASYNC] This command requests initiation of a BSS Transition Management (BTM) request to influence this client's roaming behavior to another BSS as defined in [Section 9.6.13.9/802.11-2020]. - 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ DisassociationImminent boolean boolean W [MANDATORY] Indicates if the disassociation is imminent, as defined in [Section 9.6.13.9/802.11-2020]. - 2.15 TR-181i2a15
⇒ DisassociationTimer unsignedInt unsignedInt W [MANDATORY] The number of beacon transmission times until the AP sends a disassociation frame to this station. If DisassociationTimer=0 then DisassociationTimer is not used. - 2.15 TR-181i2a15
⇒ BSSTerminationDuration unsignedInt unsignedInt W [MANDATORY] The number of minutes for which the BSS is not present. If BSSTerminationDuration=0 or if this input in not provided, then BSSTerminationDuration is not used. - 2.15 TR-181i2a15
⇒ ValidityInterval unsignedInt unsignedInt W The amount of time in beacon intervals that the ValidityInterval is valid for. If ValidityInterval=0 or if this input in not provided, then ValidityInterval is not used. - 2.15 TR-181i2a15
⇒ SteeringTimer unsignedInt unsignedInt W The amount of time in beacon intervals that this associated device is not allowed to return to the original BSS. If SteeringTimer=0 or if this input in not provided, then SteeringTimer is not used. - 2.15 TR-181i2a15
⇒ TargetBSS string​(17) MACAddress W [MANDATORY] [MACAddress] BSSID of the target BSS which the associated device(s) is to be associated to. - 2.15 TR-181i2a15
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the response to the BSS Transition Management (BTM) request. Enumeration of:

- 2.15 TR-181i2a15c1
Device.​WiFi.​DataElements.​Network.​Device.​{i}.​Radio.​{i}.​MultiAPRadio. object object​[1:1] - This object represents an individual Access Point Radio in the Wi-Fi network. - 2.15 TR-181i2a15
FullScan​() command object - [ASYNC] This parameter represents a request to initiate a full scan on this radio, including all channels supported by this radio, for a specific DwellTime and HomeTime. This command will result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult. - 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ DwellTime unsignedInt unsignedInt W [MANDATORY] The duration of the time to scan each channel in milliseconds. A value of 50 milliseconds is suggested. - 2.15 TR-181i2a15
⇒ DFSDwellTime unsignedInt unsignedInt W [MANDATORY] The duration of time to scan each Dynamic Frequency Selection (DFS) channel in milliseconds. A value of at least one beacon interval, typically 100 milliseconds, is suggested. - 2.15 TR-181i2a15
⇒ HomeTime unsignedInt unsignedInt W The time in milliseconds after which the driver has to go back to the original channel before scanning the next channel to avoid disruption. If this is omitted, or is not supported by the device, then it should be ignored. - 2.15 TR-181i2a15
⇒ SSID string string W The Service Set Identifier (SSID) to scan. If omitted, then all SSIDs are scanned. - 2.15 TR-181i2a15
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to initiate a full band scan. Enumeration of:

- 2.15 TR-181i2a15c1
⇐ ScanResult.​{i}. object​[0:] object​[0:∞] -

The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

- 2.15 TR-181i2a15
⇐ TimeStamp string string - The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. - 2.15 TR-181i2a15
⇐ ScanResult.​{i}.​OpClassScan.​{i}. object​[0:] object​[0:∞] -

The Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for OperatingClass.

- 2.15 TR-181i2a15
⇐ OperatingClass unsignedInt​(:255) unsignedInt​(:255) -

The Operating Class per [Table E-4/802.11-2020] 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.

- 2.15 TR-181i2a15
⇐ ScanResult.​{i}.​OpClassScan.​{i}.​ChannelScan.​{i}. object​[0:] object​[0:∞] -

The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for Channel.

- 2.15 TR-181i2a15
⇐ Channel unsignedInt​(:255) unsignedInt​(:255) - The channel number of the Channel scanned by the Radio given the Operating Class. - 2.15 TR-181i2a15
⇐ TimeStamp string string - The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. - 2.15 TR-181i2a15
⇐ Utilization unsignedInt​(:255) unsignedInt​(:255) - The current Channel Utilization measured by the Radio on the scanned 20MHz channel, as defined by [Section 9.4.2.27/802.11-2020]. - 2.15 TR-181i2a15
⇐ Noise unsignedInt​(:255) unsignedInt​(:255) -

An indicator of the average radio noise plus interference power measured for the primary operating channel.

Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020].

- 2.15 TR-181i2a15
⇐ ScanResult.​{i}.​OpClassScan.​{i}.​ChannelScan.​{i}.​NeighborBSS.​{i}. object​[0:] object​[0:∞] -

The neighboring BSS discovered by a Radio during a channel scan.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for BSSID.

- 2.15 TR-181i2a15
⇐ BSSID string​(17) MACAddress - [MACAddress] The BSSID indicated by the neighboring BSS. - 2.15 TR-181i2a15
⇐ SSID string string - The SSID indicated by the neighboring BSS. - 2.15 TR-181i2a15
⇐ SignalStrength unsignedInt​(:255) unsignedInt​(:255) -

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 dBm. (RSSI is encoded per [Table 9-176/802.11-2020]). 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.

- 2.15 TR-181i2a15
⇐ ChannelBandwidth string string - Indicates the maximum bandwidth at which the neighboring BSS is operating. e.g. "20" or "40" or "80" or "80+80" or "160" MHz. - 2.15 TR-181i2a15
⇐ ChannelUtilization unsignedInt​(:255) unsignedInt​(:255) - 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.27/802.11-2020]. - 2.15 TR-181i2a15
⇐ StationCount unsignedInt unsignedInt - 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 [Section 9.4.2.27/802.11-2020]. - 2.15 TR-181i2a15
⇐ SecurityModeEnabled string string -

The type of encryption the neighboring WiFi SSID advertises.

The WEP value indicates either WEP-64 or WEP-128.

The WPA value is the same as WPA-Personal.

The WPA2 value is the same as WPA2-Personal.

The WPA-WPA2 value is the same as WPA-WPA2-Personal.

The WPA3-SAE value is the same as WPA3-Personal.

The WPA2-PSK-WPA3-SAE value is the same as WPA3-Personal-Transition. Enumeration of:

- 2.15 TR-181i2a15
⇐ EncryptionMode string​[] list of string -

Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises.

When SecurityModeEnabled is one of WPA3-SAE, WPA2-PSK-WPA3-SAE, or WPA3-Enterprise, TKIP is not valid, and should not be in the list. Each list item is an enumeration of:

- 2.15 TR-181i2a15
⇐ SupportedStandards string​[] list of string -

Comma-separated list of strings. List items indicate which IEEE 802.11 standards this NeighborBSS instance can support simultaneously, in the frequency band specified by Channel. Each list item is an enumeration of:

Each value indicates support for the indicated standard.

- 2.15 TR-181i2a15
⇐ OperatingStandards string​[] list of string -

Comma-separated list of strings. Each list item MUST be a member of the list reported by the SupportedStandards parameter. List items indicate which IEEE 802.11 standard that is detected for this NeighborBSS.

Each value indicates support for the indicated standard.

For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard can be used.

- 2.15 TR-181i2a15
⇐ BasicDataTransferRates string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Basic data transmit rates (in Mbps) for the SSID. For example, if BasicDataTransferRates is "1,2", this indicates that the SSID is operating with basic rates of 1 Mbps and 2 Mbps. - 2.15 TR-181i2a15
⇐ SupportedDataTransferRates string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Data transmit rates (in Mbps) for unicast frames at which the SSID will permit a station to connect. For example, if SupportedDataTransferRates is "1,2,5.5", this indicates that the SSID will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps. - 2.15 TR-181i2a15
⇐ SupportedNSS unsignedInt unsignedInt - The maximum number of spatial streams (NSS) that can be supported. - 2.15 TR-181i2a15
⇐ DTIMPeriod unsignedInt unsignedInt - The number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2020] - 2.15 TR-181i2a15
⇐ BeaconPeriod unsignedInt unsignedInt - Time interval (in ms) between transmitting beacons. - 2.15 TR-181i2a15
ChannelScan​() command object - [ASYNC] This parameter represents a request to initiate a channel scan on this radio on the given channel using a specific DwellTime. This command should result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult. - 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ DwellTime unsignedInt unsignedInt W [MANDATORY] The duration of the time to scan each channel in milliseconds. A value of 50 milliseconds is suggested. - 2.15 TR-181i2a15
⇒ DFSDwellTime unsignedInt unsignedInt W [MANDATORY] The duration of time to scan each Dynamic Frequency Selection (DFS) channel in milliseconds. A value of at least one beacon interval, typically 100 milliseconds, is suggested. - 2.15 TR-181i2a15
⇒ HomeTime unsignedInt unsignedInt W The time in milliseconds after which the driver has to go back to the original channel before scanning the next channel to avoid disruption. If this is omitted, or is not supported by the device, then it should be ignored. - 2.15 TR-181i2a15
⇒ SSID string string W The Service Set Identifier (SSID) to scan. If omitted, then all SSIDs are scanned. - 2.15 TR-181i2a15
⇒ OpClass.​{i}. object​[0:] object​[0:∞] W

The Operating Classes for which this channel scan is requested.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

- 2.15 TR-181i2a15
⇒ OperatingClass unsignedInt​(:255) unsignedInt​(:255) W [MANDATORY] The Operating Class per [Table E-4/802.11-2020] of the OpClass and Channel tuple scanned by the Radio. Note that the Operating Class identifies the band and channel width. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. - 2.15 TR-181i2a15
⇒ OpClass.​{i}.​Channel.​{i}. object​[0:] object​[0:∞] W

The Channels for which this channel scan is requested.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

- 2.15 TR-181i2a15
⇒ Channel unsignedInt​(:255) unsignedInt​(:255) W [MANDATORY] The Channel number of the Channel that is requested to be scanned. - 2.15 TR-181i2a15
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to initiate a channel scan. Enumeration of:

- 2.15 TR-181i2a15c1
⇐ ScanResult.​{i}. object​[0:] object​[0:∞] -

The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

- 2.15 TR-181i2a15
⇐ TimeStamp string string - The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. - 2.15 TR-181i2a15
⇐ ScanResult.​{i}.​OpClassScan.​{i}. object​[0:] object​[0:∞] -

The Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for OperatingClass.

- 2.15 TR-181i2a15
⇐ OperatingClass unsignedInt​(:255) unsignedInt​(:255) -

The Operating Class per [Table E-4/802.11-2020] 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.

- 2.15 TR-181i2a15
⇐ ScanResult.​{i}.​OpClassScan.​{i}.​ChannelScan.​{i}. object​[0:] object​[0:∞] -

The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for Channel.

- 2.15 TR-181i2a15
⇐ Channel unsignedInt​(:255) unsignedInt​(:255) - The channel number of the Channel scanned by the Radio given the Operating Class. - 2.15 TR-181i2a15
⇐ TimeStamp string string - The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. - 2.15 TR-181i2a15
⇐ Utilization unsignedInt​(:255) unsignedInt​(:255) - The current Channel Utilization measured by the Radio on the scanned 20MHz channel, as defined by [Section 9.4.2.27/802.11-2020]. - 2.15 TR-181i2a15
⇐ Noise unsignedInt​(:255) unsignedInt​(:255) -

An indicator of the average radio noise plus interference power measured for the primary operating channel.

Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020].

- 2.15 TR-181i2a15
⇐ ScanResult.​{i}.​OpClassScan.​{i}.​ChannelScan.​{i}.​NeighborBSS.​{i}. object​[0:] object​[0:∞] -

The neighboring BSS discovered by a Radio during a channel scan.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for BSSID.

- 2.15 TR-181i2a15
⇐ BSSID string​(17) MACAddress - [MACAddress] The BSSID indicated by the neighboring BSS. - 2.15 TR-181i2a15
⇐ SSID string string - The SSID indicated by the neighboring BSS. - 2.15 TR-181i2a15
⇐ SignalStrength unsignedInt​(:255) unsignedInt​(:255) -

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 dBm. (RSSI is encoded per [Table 9-176/802.11-2020]). 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.

- 2.15 TR-181i2a15
⇐ ChannelBandwidth string string - Indicates the maximum bandwidth at which the neighboring BSS is operating. e.g. "20" or "40" or "80" or "80+80" or "160" MHz. - 2.15 TR-181i2a15
⇐ ChannelUtilization unsignedInt​(:255) unsignedInt​(:255) - 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.27/802.11-2020]. - 2.15 TR-181i2a15
⇐ StationCount unsignedInt unsignedInt - 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 [Section 9.4.2.27/802.11-2020]. - 2.15 TR-181i2a15
⇐ SecurityModeEnabled string string -

The type of encryption the neighboring WiFi SSID advertises.

The WEP value indicates either WEP-64 or WEP-128.

The WPA value is the same as WPA-Personal.

The WPA2 value is the same as WPA2-Personal.

The WPA-WPA2 value is the same as WPA-WPA2-Personal.

The WPA3-SAE value is the same as WPA3-Personal.

The WPA2-PSK-WPA3-SAE value is the same as WPA3-Personal-Transition. Enumeration of:

- 2.15 TR-181i2a15
⇐ EncryptionMode string​[] list of string -

Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises.

When SecurityModeEnabled is one of WPA3-SAE, WPA2-PSK-WPA3-SAE, or WPA3-Enterprise, TKIP is not valid, and should not be in the list. Each list item is an enumeration of:

- 2.15 TR-181i2a15
⇐ SupportedStandards string​[] list of string -

Comma-separated list of strings. List items indicate which IEEE 802.11 standards this NeighborBSS instance can support simultaneously, in the frequency band specified by Channel. Each list item is an enumeration of:

Each value indicates support for the indicated standard.

- 2.15 TR-181i2a15
⇐ OperatingStandards string​[] list of string -

Comma-separated list of strings. Each list item MUST be a member of the list reported by the SupportedStandards parameter. List items indicate which IEEE 802.11 standard that is detected for this NeighborBSS.

Each value indicates support for the indicated standard.

For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard can be used.

- 2.15 TR-181i2a15
⇐ BasicDataTransferRates string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Basic data transmit rates (in Mbps) for the SSID. For example, if BasicDataTransferRates is "1,2", this indicates that the SSID is operating with basic rates of 1 Mbps and 2 Mbps. - 2.15 TR-181i2a15
⇐ SupportedDataTransferRates string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Data transmit rates (in Mbps) for unicast frames at which the SSID will permit a station to connect. For example, if SupportedDataTransferRates is "1,2,5.5", this indicates that the SSID will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps. - 2.15 TR-181i2a15
⇐ SupportedNSS unsignedInt unsignedInt - The maximum number of spatial streams (NSS) that can be supported. - 2.15 TR-181i2a15
⇐ DTIMPeriod unsignedInt unsignedInt - The number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2020] - 2.15 TR-181i2a15
⇐ BeaconPeriod unsignedInt unsignedInt - Time interval (in ms) between transmitting beacons. - 2.15 TR-181i2a15
Device.​WiFi.​DataElements.​AssociationEvent. object object​[1:1] - This object contains the events generated when a STA associates to a BSS. - 2.13 TR-181i2a15
Associated! event object - The event is generated when an Associated Device (STA) associates to a BSS. - 2.15 TR-181i2a15c1
⇒ BSSID string​(17) MACAddress - [MACAddress] The MAC Address of the logical BSS (BSSID) which is reporting the Association Event. - 2.15 TR-181i2a15
⇒ MACAddress string​(17) MACAddress - [MACAddress] The MAC Address of the Associated Device (STA). - 2.15 TR-181i2a15
⇒ StatusCode unsignedInt unsignedInt - The status code sent to the Associated Device (STA) in the Association Response frame as defined by [Table 9-50/802.11-2020]. - 2.15 TR-181i2a15
⇒ HTCapabilities base64​(1:1) base64​(1:1) - Describes the HT capabilities of the Associated Device (STA). - 2.15 TR-181i2a15
⇒ VHTCapabilities base64​(2:6) base64​(2:6) - Describes the VHT capabilities of the Associated Device (STA). - 2.15 TR-181i2a15
⇒ HECapabilities base64​(4:14) base64​(4:14) - Describes the HE capabilities of the Associated Device (STA). - 2.15 TR-181i2a15
⇒ TimeStamp string string - The time this event happened. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. - 2.15 TR-181i2a15
Device.​WiFi.​DataElements.​DisassociationEvent. object object​[1:1] - This object contains the events generated when an Associated Device (STA) disassociates from a BSS. - 2.13 TR-181i2a15
Disassociated! event object - The event is generated when an Associated Device (STA) disassociates from a BSS. - 2.15 TR-181i2a15c1
⇒ BSSID string​(17) MACAddress - [MACAddress] The MAC Address of the logical BSS ( BSSID) which is reporting the Disassociation Event. - 2.15 TR-181i2a15
⇒ MACAddress string​(17) MACAddress - [MACAddress] The MAC Address of the Associated Device (STA). - 2.15 TR-181i2a15
⇒ ReasonCode unsignedInt unsignedInt - 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 Deauthentication frame as defined in [Table 9-49/802.11-2020]. - 2.15 TR-181i2a15
⇒ BytesSent unsignedLong StatsCounter64 - [StatsCounter64] The total number of bytes transmitted to the Associated Device (STA). - 2.15 TR-181i2a15
⇒ BytesReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of bytes received from the Associated Device (STA). - 2.15 TR-181i2a15
⇒ PacketsSent unsignedLong StatsCounter64 - [StatsCounter64] The total number of packets transmitted to the Associated Device (STA). - 2.15 TR-181i2a15
⇒ PacketsReceived unsignedLong StatsCounter64 - [StatsCounter64] The total number of packets received from the Associated Device (STA). - 2.15 TR-181i2a15
⇒ ErrorsSent unsignedInt StatsCounter32 - [StatsCounter32] 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. - 2.15 TR-181i2a15
⇒ ErrorsReceived unsignedInt StatsCounter32 - [StatsCounter32] The total number of inbound packets from the Associated Device (STA) that contained errors preventing them from being delivered to a higher-layer protocol. - 2.15 TR-181i2a15
⇒ RetransCount unsignedInt StatsCounter32 -

[StatsCounter32] 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.

- 2.15 TR-181i2a15
⇒ TimeStamp string string - The time this event happened. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. - 2.15 TR-181i2a15
Device.​WiFi.​DataElements.​FailedConnectionEvent. object object​[1:1] - This object contains the events generated when a Station (STA) fails to connect to a Basic Service Set (BSS). - 2.15 TR-181i2a15
FailedConnection! event object - The event is generated when an Associated Device (STA) fails to connect to a BSS. - 2.15 TR-181i2a15c1
⇒ MACAddress string​(17) MACAddress - [MACAddress] STA MAC Address identifying the client that has attempted to connect. - 2.15 TR-181i2a15
⇒ StatusCode unsignedInt unsignedInt - Status Code set to a non-zero value that indicates the reason for association or authentication failure as defined in [Table 9-50/802.11-2020], or Status Code set to zero and ReasonCode provided. - 2.15 TR-181i2a15
⇒ ReasonCode unsignedInt unsignedInt - Reason Code indicating the reason the STA was disassociated or deauthenticated as defined in [Table 9-49/802.11-2020]. - 2.15 TR-181i2a15
⇒ TimeStamp string string - The time this event happened. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. - 2.15 TR-181i2a15
Device.​WiFi.​Radio.​{i}. object​[0:] object​[0:∞] -

This object models an 802.11 wireless radio on a device (a stackable interface object as described in [Section 4.2/TR-181i2]).

If the device can establish more than one connection simultaneously (e.g. a dual radio device), a separate Radio instance MUST be used for each physical radio of the device. See [Appendix III.1/TR-181i2] for additional information.

Note: A dual-band single-radio device (e.g. an 802.11a/b/g radio) can be configured to operate at 2.4 or 5 GHz frequency bands, but only a single frequency band is used to transmit/receive at a given time. Therefore, a single Radio instance is used even for a dual-band radio.

At most one entry in this table can exist with a given value for Alias, or with a given value for Name.

- 2.12 TR-181i2a15
RemoteMeasurementRequest​() command object - [ASYNC] This command requests initiation of a Remote Measurement request to retrieve measurement data from a BSS on this radio. Upon receipt of this request, this radio is to initiate a measurement of the output SignalStrength and Noise for the indicated input. - 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ TargetBSS string​(17) MACAddress W [MANDATORY] [MACAddress] The BSSID of the remote BSS. - 2.15 TR-181i2a15
⇒ Timeout unsignedInt unsignedInt W [MANDATORY] The duration after which the request is timed out in seconds. - 2.15 TR-181i2a15
⇒ OperatingClass unsignedInt​(:255) unsignedInt​(:255) W [MANDATORY] The Operating Class in [Table E-4/802.11-2020] for which the measurement is requested. - 2.15 TR-181i2a15
⇒ Channel unsignedInt unsignedInt W [MANDATORY] The number of the channel for which the measurement is requested. - 2.15 TR-181i2a15
⇐ Output. arguments object - Output arguments. -
⇐ SignalStrength unsignedInt​(:255) unsignedInt​(:255) - The received signal strength (RSSI) as received by the radio measured in dBm. RSSI is encoded as per [Table 9-176/802.11-2020]. Reserved: 221 - 255. - 2.15 TR-181i2a15
⇐ Noise unsignedInt​(:255) unsignedInt​(:255) - An indicator of the average radio noise plus interference power as received by the radio. Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020]. - 2.15 TR-181i2a15
⇐ Status string string -

Indicates the response to the Remote Measurement request. Enumeration of:

- 2.15 TR-181i2a15c1
InitiateCCAMeasurement​() command object - [ASYNC] This command represents a request to initiate a Clear Channel Assessment (CCA) measurement scan on this radio on the given channel using a specific DwellTime. - 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ Channel unsignedInt unsignedInt W [MANDATORY] The number of the Wi-Fi channel the clear channel assessment (CCA) measurement is run on. - 2.15 TR-181i2a15
⇒ DwellTime unsignedInt unsignedInt W [MANDATORY] The duration of the CCA measurement in milliseconds. - 2.15 TR-181i2a15
⇐ Output. arguments object - Output arguments. -
⇐ CCAReport hexBinary​(12:12) hexBinary​(12:12) -

The clear channel assessment (CCA) report in the format specified in [Section 9.4.2.21.3/802.11-2020].

When read, the value of this parameter MUST correspond to Channel. How this is achieved is a local matter to the CPE.

- 2.15 TR-181i2a15
⇐ Status string string -

Indicates the response to the request to initiate a Clear Channel Assessment (CCA) measurement. Enumeration of:

- 2.15 TR-181i2a15c1
FullScan​() command object - [ASYNC] This parameter represents a request to initiate a full scan on this radio, including all channels supported by this radio, for a specific DwellTime and HomeTime. This command will result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult. - 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ DwellTime unsignedInt unsignedInt W [MANDATORY] The duration of the time to scan each channel in milliseconds. A value of 50 milliseconds is suggested. - 2.15 TR-181i2a15
⇒ DFSDwellTime unsignedInt unsignedInt W [MANDATORY] The duration of time to scan each Dynamic Frequency Selection (DFS) channel in milliseconds. A value of at least one beacon interval, typically 100 milliseconds, is suggested. - 2.15 TR-181i2a15
⇒ HomeTime unsignedInt unsignedInt W The time in milliseconds after which the driver has to go back to the original channel before scanning the next channel to avoid disruption. If this is omitted, or is not supported by the device, then it should be ignored. - 2.15 TR-181i2a15
⇒ SSID string string W The Service Set Identifier (SSID) to scan. If omitted, then all SSIDs are scanned. - 2.15 TR-181i2a15
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to initiate a full band scan. Enumeration of:

- 2.15 TR-181i2a15c1
⇐ ScanResult.​{i}. object​[0:] object​[0:∞] -

The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

- 2.15 TR-181i2a15
⇐ TimeStamp string string - The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. - 2.15 TR-181i2a15
⇐ ScanResult.​{i}.​OpClassScan.​{i}. object​[0:] object​[0:∞] -

The Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for OperatingClass.

- 2.15 TR-181i2a15
⇐ OperatingClass unsignedInt​(:255) unsignedInt​(:255) -

The Operating Class per [Table E-4/802.11-2020] 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.

- 2.15 TR-181i2a15
⇐ ScanResult.​{i}.​OpClassScan.​{i}.​ChannelScan.​{i}. object​[0:] object​[0:∞] -

The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for Channel.

- 2.15 TR-181i2a15
⇐ Channel unsignedInt​(:255) unsignedInt​(:255) - The channel number of the Channel scanned by the Radio given the Operating Class. - 2.15 TR-181i2a15
⇐ TimeStamp string string - The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. - 2.15 TR-181i2a15
⇐ Utilization unsignedInt​(:255) unsignedInt​(:255) - The current Channel Utilization measured by the Radio on the scanned 20MHz channel, as defined by [Section 9.4.2.27/802.11-2020]. - 2.15 TR-181i2a15
⇐ Noise unsignedInt​(:255) unsignedInt​(:255) -

An indicator of the average radio noise plus interference power measured for the primary operating channel.

Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020].

- 2.15 TR-181i2a15
⇐ ScanResult.​{i}.​OpClassScan.​{i}.​ChannelScan.​{i}.​NeighborBSS.​{i}. object​[0:] object​[0:∞] -

The neighboring BSS discovered by a Radio during a channel scan.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for BSSID.

- 2.15 TR-181i2a15
⇐ BSSID string​(17) MACAddress - [MACAddress] The BSSID indicated by the neighboring BSS. - 2.15 TR-181i2a15
⇐ SSID string string - The SSID indicated by the neighboring BSS. - 2.15 TR-181i2a15
⇐ SignalStrength unsignedInt​(:255) unsignedInt​(:255) -

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 dBm. (RSSI is encoded per [Table 9-176/802.11-2020]). 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.

- 2.15 TR-181i2a15
⇐ ChannelBandwidth string string - Indicates the maximum bandwidth at which the neighboring BSS is operating. e.g. "20" or "40" or "80" or "80+80" or "160" MHz. - 2.15 TR-181i2a15
⇐ ChannelUtilization unsignedInt​(:255) unsignedInt​(:255) - 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.27/802.11-2020]. - 2.15 TR-181i2a15
⇐ StationCount unsignedInt unsignedInt - 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 [Section 9.4.2.27/802.11-2020]. - 2.15 TR-181i2a15
⇐ SecurityModeEnabled string string -

The type of encryption the neighboring WiFi SSID advertises.

The WEP value indicates either WEP-64 or WEP-128.

The WPA value is the same as WPA-Personal.

The WPA2 value is the same as WPA2-Personal.

The WPA-WPA2 value is the same as WPA-WPA2-Personal.

The WPA3-SAE value is the same as WPA3-Personal.

The WPA2-PSK-WPA3-SAE value is the same as WPA3-Personal-Transition. Enumeration of:

- 2.15 TR-181i2a15
⇐ EncryptionMode string​[] list of string -

Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises.

When SecurityModeEnabled is one of WPA3-SAE, WPA2-PSK-WPA3-SAE, or WPA3-Enterprise, TKIP is not valid, and should not be in the list. Each list item is an enumeration of:

- 2.15 TR-181i2a15
⇐ SupportedStandards string​[] list of string -

Comma-separated list of strings. List items indicate which IEEE 802.11 standards this NeighborBSS instance can support simultaneously, in the frequency band specified by Channel. Each list item is an enumeration of:

Each value indicates support for the indicated standard.

- 2.15 TR-181i2a15
⇐ OperatingStandards string​[] list of string -

Comma-separated list of strings. Each list item MUST be a member of the list reported by the SupportedStandards parameter. List items indicate which IEEE 802.11 standard that is detected for this NeighborBSS.

Each value indicates support for the indicated standard.

For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard can be used.

- 2.15 TR-181i2a15
⇐ BasicDataTransferRates string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Basic data transmit rates (in Mbps) for the SSID. For example, if BasicDataTransferRates is "1,2", this indicates that the SSID is operating with basic rates of 1 Mbps and 2 Mbps. - 2.15 TR-181i2a15
⇐ SupportedDataTransferRates string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Data transmit rates (in Mbps) for unicast frames at which the SSID will permit a station to connect. For example, if SupportedDataTransferRates is "1,2,5.5", this indicates that the SSID will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps. - 2.15 TR-181i2a15
⇐ SupportedNSS unsignedInt unsignedInt - The maximum number of spatial streams (NSS) that can be supported. - 2.15 TR-181i2a15
⇐ DTIMPeriod unsignedInt unsignedInt - The number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2020] - 2.15 TR-181i2a15
⇐ BeaconPeriod unsignedInt unsignedInt - Time interval (in ms) between transmitting beacons. - 2.15 TR-181i2a15
ChannelScan​() command object - [ASYNC] This parameter represents a request to initiate a channel scan on this radio on the given channel using a specific DwellTime. This command should result in updating Device.WiFi.DataElements.Network.Device.{i}.Radio.{i}.ScanResult. - 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ DwellTime unsignedInt unsignedInt W [MANDATORY] The duration of the time to scan each channel in milliseconds. A value of 50 milliseconds is suggested. - 2.15 TR-181i2a15
⇒ DFSDwellTime unsignedInt unsignedInt W [MANDATORY] The duration of time to scan each Dynamic Frequency Selection (DFS) channel in milliseconds. A value of at least one beacon interval, typically 100 milliseconds, is suggested. - 2.15 TR-181i2a15
⇒ HomeTime unsignedInt unsignedInt W The time in milliseconds after which the driver has to go back to the original channel before scanning the next channel to avoid disruption. If this is omitted, or is not supported by the device, then it should be ignored. - 2.15 TR-181i2a15
⇒ SSID string string W The Service Set Identifier (SSID) to scan. If omitted, then all SSIDs are scanned. - 2.15 TR-181i2a15
⇒ OpClass.​{i}. object​[0:] object​[0:∞] W

The Operating Classes for which this channel scan is requested.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

- 2.15 TR-181i2a15
⇒ OperatingClass unsignedInt​(:255) unsignedInt​(:255) W [MANDATORY] The Operating Class per [Table E-4/802.11-2020] of the OpClass and Channel tuple scanned by the Radio. Note that the Operating Class identifies the band and channel width. For 2.4GHz and 5GHz bands, only 20MHz Operating Classes are valid. - 2.15 TR-181i2a15
⇒ OpClass.​{i}.​Channel.​{i}. object​[0:] object​[0:∞] W

The Channels for which this channel scan is requested.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

- 2.15 TR-181i2a15
⇒ Channel unsignedInt​(:255) unsignedInt​(:255) W [MANDATORY] The Channel number of the Channel that is requested to be scanned. - 2.15 TR-181i2a15
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the type of outcome of the request to initiate a channel scan. Enumeration of:

- 2.15 TR-181i2a15c1
⇐ ScanResult.​{i}. object​[0:] object​[0:∞] -

The list of neighboring Access Points discovered by a Radio organized per Operating Class and Channel tuple.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

- 2.15 TR-181i2a15
⇐ TimeStamp string string - The timestamp of the last scan. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. - 2.15 TR-181i2a15
⇐ ScanResult.​{i}.​OpClassScan.​{i}. object​[0:] object​[0:∞] -

The Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for OperatingClass.

- 2.15 TR-181i2a15
⇐ OperatingClass unsignedInt​(:255) unsignedInt​(:255) -

The Operating Class per [Table E-4/802.11-2020] 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.

- 2.15 TR-181i2a15
⇐ ScanResult.​{i}.​OpClassScan.​{i}.​ChannelScan.​{i}. object​[0:] object​[0:∞] -

The Channel associated with an Operating Class of neighboring Access Points discovered by a Radio during a channel scan.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for Channel.

- 2.15 TR-181i2a15
⇐ Channel unsignedInt​(:255) unsignedInt​(:255) - The channel number of the Channel scanned by the Radio given the Operating Class. - 2.15 TR-181i2a15
⇐ TimeStamp string string - The timestamp of the last scan of the channel. Formatted with the date-and-time string format as defined in [Section 3/RFC3339]. - 2.15 TR-181i2a15
⇐ Utilization unsignedInt​(:255) unsignedInt​(:255) - The current Channel Utilization measured by the Radio on the scanned 20MHz channel, as defined by [Section 9.4.2.27/802.11-2020]. - 2.15 TR-181i2a15
⇐ Noise unsignedInt​(:255) unsignedInt​(:255) -

An indicator of the average radio noise plus interference power measured for the primary operating channel.

Encoded as defined for ANPI in [Section 11.10.9.4/802.11-2020].

- 2.15 TR-181i2a15
⇐ ScanResult.​{i}.​OpClassScan.​{i}.​ChannelScan.​{i}.​NeighborBSS.​{i}. object​[0:] object​[0:∞] -

The neighboring BSS discovered by a Radio during a channel scan.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

At most one entry in this table can exist with a given value for BSSID.

- 2.15 TR-181i2a15
⇐ BSSID string​(17) MACAddress - [MACAddress] The BSSID indicated by the neighboring BSS. - 2.15 TR-181i2a15
⇐ SSID string string - The SSID indicated by the neighboring BSS. - 2.15 TR-181i2a15
⇐ SignalStrength unsignedInt​(:255) unsignedInt​(:255) -

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 dBm. (RSSI is encoded per [Table 9-176/802.11-2020]). 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.

- 2.15 TR-181i2a15
⇐ ChannelBandwidth string string - Indicates the maximum bandwidth at which the neighboring BSS is operating. e.g. "20" or "40" or "80" or "80+80" or "160" MHz. - 2.15 TR-181i2a15
⇐ ChannelUtilization unsignedInt​(:255) unsignedInt​(:255) - 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.27/802.11-2020]. - 2.15 TR-181i2a15
⇐ StationCount unsignedInt unsignedInt - 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 [Section 9.4.2.27/802.11-2020]. - 2.15 TR-181i2a15
⇐ SecurityModeEnabled string string -

The type of encryption the neighboring WiFi SSID advertises.

The WEP value indicates either WEP-64 or WEP-128.

The WPA value is the same as WPA-Personal.

The WPA2 value is the same as WPA2-Personal.

The WPA-WPA2 value is the same as WPA-WPA2-Personal.

The WPA3-SAE value is the same as WPA3-Personal.

The WPA2-PSK-WPA3-SAE value is the same as WPA3-Personal-Transition. Enumeration of:

- 2.15 TR-181i2a15
⇐ EncryptionMode string​[] list of string -

Comma-separated list of strings. The type of encryption the neighboring WiFi SSID advertises.

When SecurityModeEnabled is one of WPA3-SAE, WPA2-PSK-WPA3-SAE, or WPA3-Enterprise, TKIP is not valid, and should not be in the list. Each list item is an enumeration of:

- 2.15 TR-181i2a15
⇐ SupportedStandards string​[] list of string -

Comma-separated list of strings. List items indicate which IEEE 802.11 standards this NeighborBSS instance can support simultaneously, in the frequency band specified by Channel. Each list item is an enumeration of:

Each value indicates support for the indicated standard.

- 2.15 TR-181i2a15
⇐ OperatingStandards string​[] list of string -

Comma-separated list of strings. Each list item MUST be a member of the list reported by the SupportedStandards parameter. List items indicate which IEEE 802.11 standard that is detected for this NeighborBSS.

Each value indicates support for the indicated standard.

For example, a value of "g,b" (or "b,g" - order is not important) means that the 802.11g standard [802.11g-2003] is used with a backwards-compatible mode for 802.11b [802.11b-1999]. A value of "g" means that only the 802.11g standard can be used.

- 2.15 TR-181i2a15
⇐ BasicDataTransferRates string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Basic data transmit rates (in Mbps) for the SSID. For example, if BasicDataTransferRates is "1,2", this indicates that the SSID is operating with basic rates of 1 Mbps and 2 Mbps. - 2.15 TR-181i2a15
⇐ SupportedDataTransferRates string​(256)​[] list​(256) of string - Comma-separated list (maximum number of characters 256) of strings. Data transmit rates (in Mbps) for unicast frames at which the SSID will permit a station to connect. For example, if SupportedDataTransferRates is "1,2,5.5", this indicates that the SSID will only permit connections at 1 Mbps, 2 Mbps and 5.5 Mbps. - 2.15 TR-181i2a15
⇐ SupportedNSS unsignedInt unsignedInt - The maximum number of spatial streams (NSS) that can be supported. - 2.15 TR-181i2a15
⇐ DTIMPeriod unsignedInt unsignedInt - The number of beacon intervals that elapse between transmission of Beacon frames containing a TIM element whose DTIM count field is 0. This value is transmitted in the DTIM Period field of beacon frames. [802.11-2020] - 2.15 TR-181i2a15
⇐ BeaconPeriod unsignedInt unsignedInt - Time interval (in ms) between transmitting beacons. - 2.15 TR-181i2a15
Device.​WiFi.​AccessPoint.​{i}. object​[0:] object​[0:∞] W

This object models an 802.11 connection from the perspective of a wireless access point. Each AccessPoint entry is associated with a particular SSID interface instance via the SSIDReference parameter.

For enabled table entries, if SSIDReference is not a valid reference then the table entry is inoperable and the CPE MUST set Status to Error_Misconfigured.

Note: The AccessPoint table includes a unique key parameter that is a strong reference. If a strongly referenced object is deleted, the CPE will set the referencing parameter to an empty string. However, doing so under these circumstances might cause the updated AccessPoint row to then violate the table's unique key constraint; if this occurs, the CPE MUST set Status to Error_Misconfigured and disable the offending AccessPoint row.

At most one entry in this table can exist with a given value for Alias, or with a given value for SSIDReference.

- 2.12 TR-181i2a15
Device.​WiFi.​AccessPoint.​{i}.​WPS. object object​[1:1] - This object contains parameters related to Wi-Fi Protected Setup for this access point (as specified in [WPSv1.0] or {bibref|WPSv2.0}}). - 2.12 TR-181i2a15
InitiateWPSPBC​() command object - [ASYNC] Initiates a Wi-Fi Protected Setup (WPS) Push Button Configuration (PBC) process as defined in [WPS 2.0] . - 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the response to the request to start Wi-Fi Protected Setup (WPS) Push Button Configuration (PBC). Enumeration of:

- 2.15 TR-181i2a15c1
Device.​IP. object object​[1:1] - IP object that contains the Interface, ActivePort, and Diagnostics objects. - 2.12 TR-181i2a15
Device.​IP.​Diagnostics. object object​[1:1] - The IP Diagnostics object. - 2.12 TR-181i2a15
IPLayerCapSupportedSoftwareVersion string​(64) string​(64) - Indicates the installed version of the test software. The software version string will be implementation-dependent, and SHOULD identify both the implementation and the version (e.g., UDPST-7.2.1). - 2.15 TR-181i2a15
IPLayerCapSupportedControlProtocolVersion string​(64) string​(64) - Indicates the control protocol version supported by the test software. Refer to [TR-471] for more information. - 2.15 TR-181i2a15
IPLayerCapacity​() command object -

[ASYNC] This command defines the IP Layer Capacity measurement configuration. IP Layer Capacity measurement is specified in [TR-471].

Data received in the IP Layer Capacity measurement do not require storage on the device.

- 2.14 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ UDPPayloadContent string string W

UDP Payload Content Type, If there is payload compression in the path and tests intend to characterize a possible advantage due to compression, then payload content SHOULD be supplied by a pseudo-random sequence generator, by using part of a compressed file, or by other means. Payload may also contain the test protocol PDUs. The default value SHOULD be zeroes. Enumeration of:

  • zeroes (All zero (0) payload content)
  • ones (All one (1) payload content)
  • alternates0and1 (Alternating zero (0) and one (1) payload content)
  • random (Random payload content)
- 2.15 TR-181i2a15
⇒ RIPREnable boolean boolean W Enables RIPRR (Replicated IP Packet Ratio) metric. The default value SHOULD be false. - 2.15 TR-181i2a15
⇒ NumberFirstModeTestSubIntervals unsignedInt​(0:100) unsignedInt​(0:100) W When the value >= 1, bimodal test mode is requested and the value represents the number of sub-intervals to be included in the first capacity test mode. The remaining sub-intervals of NumberTestSubIntervals are for the second capacity test mode. Value = 0 indicates that bimodal testing is disabled. The value MUST NOT be greater than NumberTestSubIntervals. The default value SHOULD be 0. - 2.15 TR-181i2a15
⇒ TimeoutNoTestTraffic unsignedInt​(500:1000) unsignedInt​(500:1000) W Timeout value. If no test traffic packets are received for TimeoutNoTestTraffic milliseconds, test will timeout. Value specified in milliseconds. The default value SHOULD be 1000 milliseconds. - 2.15 TR-181i2a15
⇒ TimeoutNoStatusMessage unsignedInt​(500:1000) unsignedInt​(500:1000) W Timeout value. If no status message packets are received for TimeoutNoStatusMessage milliseconds, test will timeout. Value specified in milliseconds. The default value SHOULD be 1000 milliseconds. - 2.15 TR-181i2a15
⇒ SeqErrThresh unsignedInt​(0:100) unsignedInt​(0:100) W This parameter is only meaningful if TestType is Search. Threshold for Loss or Reordering or Replication impairments measured (events where received packet sequence number did not increase by one). The default value SHOULD be 10. - 2.15 TR-181i2a15
⇒ ReordDupIgnoreEnable boolean boolean W This parameter is only meaningful if TestType is Search. When true (enabled) only Loss counts toward received packet sequence number errors, and reordering and Duplication impairments are ignored. When false (disabled), Loss, Reordering and Duplication are all counted as sequence number errors. The default value SHOULD be false (disabled). - 2.15 TR-181i2a15
⇐ Output. arguments object - Output arguments. -
⇐ MaxETHCapacityNoFCS decimal decimal - Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with Preamble and Inter-frame gap, but no ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. - 2.15 TR-181i2a15
⇐ MaxETHCapacityWithFCS decimal decimal - Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. - 2.15 TR-181i2a15
⇐ MaxETHCapacityWithFCSVLAN decimal decimal - Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence and VLAN tag. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. - 2.15 TR-181i2a15
⇐ ReplicatedRatioAtMax decimal decimal - Ratio of replicated packets to total packets during the sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ InterfaceEthMbpsAtMax decimal decimal - The number of bits observed on the Interface during an IP-Layer Capacity test for time interval of duration TestSubInterval ending at IncrementalResult.{i}.TimeOfSubInterval corresponding to the MaxIPLayerCapacity, divided by the duration of TestSubInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. - 2.15 TR-181i2a15
⇐ IPLayerCapacitySummary decimal decimal - The IP-Layer Capacity metric from among all IncrementalResult.{i}.IPLayerCapacity values measured between BOMTime and EOMTime across all connections for this test. This is calculated according to [TR-471] Equation 1. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. - 2.15 TR-181i2a15
⇐ LossRatioSummary decimal decimal - Ratio of lost packets to total packets during the complete TestInterval. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ RTTRangeSummary decimal decimal - The range of measured Round Trip Time (RTT) during the complete TestInterval. This value is expressed in seconds, as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ PDVRangeSummary decimal decimal - The range of Packet Delay Variation (PDV) during the complete TestInterval. This value is expressed in seconds, as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ MinOnewayDelaySummary decimal decimal - The minimum one-way delay during the complete TestInterval. This value is expressed in seconds, as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ MinRTTSummary decimal decimal - The minimum RTT during the complete TestInterval. This value is expressed in seconds, as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ ReorderedRatioSummary decimal decimal - Ratio of reordered packets to total packets during the complete TestInterval. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ ReplicatedRatioSummary decimal decimal - Ratio of replicated packets to total packets during the complete TestInterval. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ InterfaceEthMbpsSummary decimal decimal - The number of bits observed on the Interface during an IP-Layer Capacity test for the entire time interval of duration TestInterval, divided by the duration of TestInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. - 2.15 TR-181i2a15
⇐ ModalResult.​{i}. object​[1:] object​[1:∞] -

Modal test results. Only returned when bimodal test mode is enabled (NumberFirstModeTestSubIntervals >=1). If returned, it MUST contain 1 or more entries, with instance number 1 corresponding to the second mode and instance number 2 corresponding to the third mode.

Results for the Maximum in each mode/instance are calculated based on IncrementalResult.{i}. data within the boundary of its corresponding mode.

This table MUST contain at least 1 entry. This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

- 2.15 TR-181i2a15
⇐ MaxIPLayerCapacity decimal decimal - The maximum IP-Layer Capacity metric from among all IncrementalResult.{i}.IPLayerCapacity values within corresponding mode across all connections for this test. This is calculated according to [TR-471] Equation 1. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. - 2.15 TR-181i2a15
⇐ TimeOfMax dateTime dateTime - Time in UTC of end of the sub-interval when MaxIPLayerCapacity was measured. If the value of MaxIPLayerCapacity occurred in multiple sub-intervals, this MUST be the earliest of these sub-intervals. Value MUST be specified to TimestampResolution precision. For example: 2008-04-09T15:01:05.123456Z - 2.15 TR-181i2a15
⇐ MaxETHCapacityNoFCS decimal decimal - Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with Preamble and Inter-frame gap, but no ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. - 2.15 TR-181i2a15
⇐ MaxETHCapacityWithFCS decimal decimal - Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. - 2.15 TR-181i2a15
⇐ MaxETHCapacityWithFCSVLAN decimal decimal - Results of measurements using the Maximum IP-Layer Capacity metric, according to [TR-471] Equation 1, and calculations to estimate the capacity at Layer 2 with ETH Frame Check Sequence and VLAN tag. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6bits/second = 1 Mbps. - 2.15 TR-181i2a15
⇐ LossRatioAtMax decimal decimal - Ratio of lost packets to total packets during sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ RTTRangeAtMax decimal decimal - The range of Round Trip Time (RTT) during sub-interval of MaxIPLayerCapacity. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ PDVRangeAtMax decimal decimal - The range of Packet Delay Variation (PDV) during sub-interval of MaxIPLayerCapacity. This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ MinOnewayDelayAtMax decimal decimal - The minimum one-way delay during the sub-interval of MaxIPLayerCapacity. The minimum one-way delay is calculated at the conclusion of the test and SHALL be calculated using the conditional distribution of all packets with a finite one-way delay value (undefined delays are excluded). This value is expressed in seconds. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ ReorderedRatioAtMax decimal decimal - Ratio of reordered packets to total packets during the sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ ReplicatedRatioAtMax decimal decimal - Ratio of replicated packets to total packets during the sub-interval of MaxIPLayerCapacity. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ InterfaceEthMbpsAtMax decimal decimal - The number of bits observed on the Interface during an IP-Layer Capacity test for time interval of duration TestSubInterval ending at IncrementalResult.{i}.TimeOfSubInterval corresponding to the MaxIPLayerCapacity, divided by the duration of TestSubInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. - 2.15 TR-181i2a15
⇐ IncrementalResult.​{i}. object​[0:] object​[0:∞] -

Results for time segmented tests (tests where NumberTestSubIntervals > 1). This data is calculated across all connections in the test. A new object is created every TestSubInterval after that interval has completed. Instance numbers MUST start at 1 and sequentially increment as new instances are created. All instances are removed when new test is started or results are otherwise cleared.

This table's Instance Numbers MUST be 1, 2, 3... (assigned sequentially without gaps).

- 2.14 TR-181i2a15
⇐ ReplicatedRatio decimal decimal - Ratio of replicated packets to total packets, for time interval of duration TestSubInterval ending at TimeOfSubInterval across all connections for this test. This value is expressed as a decimal to 9 decimal digits. - 2.15 TR-181i2a15
⇐ InterfaceEthMbps decimal decimal - The number of bits observed on the Interface during an IP-Layer Capacity test for time interval of duration TestSubInterval ending at TimeOfSubInterval, divided by the duration of TestSubInterval. Result is expressed in Mbps with 2 digits beyond the decimal. 10^6 bits/second = 1 Mbps. This is primarily a diagnostic measurement. Measurement direction follows the Role. - 2.15 TR-181i2a15
Device.​Routing. object object​[1:1] - Routing object that contains the Router table and RIP protocol object. - 2.12 TR-181i2a15
Device.​Routing.​Babel. object object​[1:1] - This object provides parameters for configuration, troubleshooting, and monitoring of the Babel routing protocol [RFC8966]. This data model is based on the Babel information model defined in [RFC9046]. - 2.15 TR-181i2a15
StatsReset​() command object - This command represents a request to reset all statistics counters to zero. Statistics are provided in InterfaceSetting.{i}.Stats.. - 2.15 TR-181i2a15c1
Device.​Routing.​Babel.​MACKeySet.​{i}. object​[0:] object​[0:∞] W

This object provides parameters related to use of the HMAC security mechanism [RFC8967] to sign and verify Babel packets.

At most one entry in this table can exist with a given value for Alias.

- 2.15 TR-181i2a15
Device.​Routing.​Babel.​MACKeySet.​{i}.​MACKey.​{i}. object​[0:] object​[0:∞] W

This object provides the MAC keys used to calculate MACs for verification and sending by the MACKeySet instance.

At most one entry in this table can exist with a given value for Alias.

- 2.15 TR-181i2a15
MACTest​() command object - This command allows the MAC key and MAC algorithm to be tested to see if they produce an expected outcome. The command calculates a MAC for InputString using the KeyValue and MACKeyAlgorithm and compares that to the value of InputMAC. If the values match, the output Match is true. - 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ InputString hexBinary hexBinary W [MANDATORY] The command calculates a MAC of InputString using the KeyValue and MACKeyAlgorithm. - 2.15 TR-181i2a15c1
⇒ InputMAC hexBinary hexBinary W [MANDATORY] The command compares the calculated MAC to InputMAC. - 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Match boolean boolean - Match is true if the calculated MAC and InputMAC are the same. - 2.15 TR-181i2a15c1
Device.​CWMPManagementServer. object object​[1:1] -   - 2.15 TR-181i2a15c1
EnableCWMP boolean boolean W

Enables and disables the CPE's support for CWMP.

false means that CWMP support in the CPE is disabled, in which case the device MUST NOT send any Inform messages to the ACS or accept any Connection Request notifications from the ACS.

true means that CWMP support on the CPE is enabled.

The subscriber can re-enable the CPE's CWMP support either by performing a factory reset or by using a LAN-side protocol to change the value of this parameter back to true.

The factory default value MUST be true.

- 2.15 TR-181i2a15
Device.​Users. object object​[1:1] - Users object that contains the User, Group, and Role tables. - 2.12 TR-181i2a15c1
CheckCredentialsDiagnostics​() command object - [ASYNC] Checks whether the input Username and Password are valid for allowing access to the user interface on the device. If not valid, then an indication of why they are not valid is output. - 2.15 TR-181i2a15c1
⇒ Input. arguments object - Input arguments. -
⇒ Username string string W The user name for logging in to the user interface on the device. - 2.15 TR-181i2a15c1
⇒ Password string string W The password for logging in to the user interface on the device. - 2.15 TR-181i2a15c1
⇐ Output. arguments object - Output arguments. -
⇐ Status string string -

Indicates the response to request to check whether the credentials are valid and, if not, why not. Enumeration of:

- 2.15 TR-181i2a15c1
Device.​PeriodicStatistics. object object​[1:1] -

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 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.

- 2.12 TR-181i2a15
Device.​PeriodicStatistics.​SampleSet.​{i}. object​[0:] object​[0:∞] W

Periodic statistics sample set table. Each sample set has its own sample interval etc.

At most one entry in this table can exist with a given value for Name, or with a given value for Alias.

- 2.12 TR-181i2a15
Controller string string -

The value MUST be the Path Name of the Device.LocalAgent.Controller. instance that created SampleSet. If the referenced object is deleted, this instance MUST also be deleted (so the parameter value will never be an empty string).

The value of this parameter is automatically populated by the USP Agent upon SampleSet creation using the reference to the USP Controller that created the instance.

The USP Controller referenced by this parameter defines the set of permissions to use when updating the Device.PeriodicStatistics.SampleSet.{i}.Parameter.{i}. table. Furthermore, only the USP Controller referenced by this parameter will have access to the Parameter.{i}.Values, Parameter.{i}.SampleSeconds, Parameter.{i}.SuspectData and Parameter.{i}.Failures parameters.

- 2.15 TR-181i2a15c1
Device.​BulkData. object object​[1:1] -

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 [TR-232].

The HTTP solution is based on transfer mechanisms described in [Annex A/TR-369].

The USPEventNotif solution is based on sending a Profile.{i}.Push! Event Notification via USP [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.

- 2.12 TR-181i2a15
Device.​BulkData.​Profile.​{i}. object​[0:] object​[0:∞] W

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 Controller to configure multiple reports to be generated at different times for different sets of data.

At most one entry in this table can exist with a given value for Alias.

- 2.12 TR-181i2a15
ForceCollection​() command object -

Start the bulk data collection and transmission as defined in this profile immediately, regardless of the current values of the Enable and ReportingInterval parameters.

This command can be used for testing of the bulk data collection mechanism and profile but also to preempt any regular schedule without affecting it.

- 2.15 TR-181i2a15c1
Device.​LocalAgent. object object​[1:1] -

This object contains general information about the USP Agent itself. For information related to the Device that hosts the Agent, please reference the DeviceInfo object.

NOTE: The Vendor Log File table (DeviceInfo.VendorLogFile) details are located on the DeviceInfo object.

- 2.12 TR-181i2a15c1
Device.​LocalAgent.​MTP.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents a MTP used by the local Agent.

At most one entry in this table can exist with a given value for Alias.

- 2.12 TR-181i2a15
Device.​LocalAgent.​MTP.​{i}.​WebSocket. object​[0:1] object​[0:1] -

If the USP Endpoint uses the WebSocket Message Transport Protocol (MTP) as a WebSocket server, then this object contains WebSocket specific configuration parameters.

This object MUST be present if, and only if, Protocol is WebSocket.

- 2.12 TR-181i2a15
KeepAliveInterval unsignedInt​(1:) unsignedInt​(1:) W The duration in seconds between when WebSocket ping control frames are transmitted by the Agent's WebSocket server to the Controller's WebSocket client. - 2.15 TR-181i2a15
Device.​LocalAgent.​Controller.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents a USP Controller that has access to this USP Agent.

On the deletion of an entry from this table, the Agent MUST send the ObjectDeletion notification to all subscribed recipients, even if the recipient is the deleted Controller itself. This notification is the last notification sent to this Controller.

At most one entry in this table can exist with a given value for EndpointID, or with a given value for Alias.

- 2.12 TR-181i2a15
Device.​LocalAgent.​Controller.​{i}.​MTP.​{i}. object​[0:] object​[0:∞] W

Each instance of this table represents a MTP used by this Controller.

At most one entry in this table can exist with a given value for Protocol, or with a given value for Alias.

- 2.12 TR-181i2a15
Order unsignedInt​(1:) unsignedInt​(1:) W

The order (relative priority) to use when determining which MTP to use for communicating to the Controller.

A value of 1 indicates the highest precedence. For each configured MTP, the instance with the lowest value is attempted first.

When more than one MTP instance has the same value, then each instance with the same value SHOULD be attempted at the same time.

The value of Order on creation of a MTP table entry MUST be one greater than the largest current value (initially assigned the lowest precedence).

- 2.15 TR-181i2a15
Device.​LocalAgent.​Controller.​{i}.​E2ESession. object object​[1:1] - The E2ESession object represents the End to End (E2E) Session Context functionality for this Controller.{i} object instance. - 2.12 TR-181i2a15c1
SessionMode string string W

The desired usage mode of an End-to-End Session Context with this particular Controller. Enumeration of:

  • Require (A Session Context MUST be used and no USP Messages are allowed to be exchanged prior to establishment. Setting the parameter to Require MUST result in the establishment of a Session Context)
  • Allow (A Session Context MAY be used but is not required. When setting the parameter to Allow, the Agent MUST NOT initiate Session Context but MUST perpetuate any existing Session Context or Controller-initiated Session Context)
  • Forbid (A Session Context MUST NOT be used. Setting the parameter to Forbid MUST result in the immediate termination of any established Session Context)
- 2.15 TR-181i2a15c1
Device.​LocalAgent.​Threshold.​{i}. object​[0:] object​[0:∞] W

Each Threshold instance of this table represents a Threshold Event.

ThresholdParam is monitored to determine if it has met the ThresholdOperator condition against ThresholdValue, when it meets the condition a Triggered! Event is sent.

ThresholdParam may only reference integer parameters and ThresholdValue only usese integer values.

For example:

   ReferencePath:
   Device.Ethernet.Interface.[Enable=="1"].Stats.
   ThresholdParam: BytesSent
   ThresholdOperator: Rise
   ThresholdValue: 100000
This would trigger a Triggered! Event whenever a value of a parameter matching Device.Ethernet.Interface.[Enable==1].Stats.BytesSent rises from below to above 100000.

When creating a Threshold, if the ReferencePath, ThresholdParam or ThresholdValue are invalid (not in the supported Data Model), the object will not be created.

If the concatenation of ReferencePath and ThresholdParam reference a parameter that isn't in the instantiated data model, then there will be no Triggered! Event.

At most one entry in this table can exist with a given value for Alias.

- 2.13 TR-181i2a15c1
Controller string string -

The value MUST be the Path Name of the Device.LocalAgent.Controller. instance that created Threshold. If the referenced object is deleted, this instance MUST also be deleted (so the parameter value will never be an empty string).

The value of this parameter is automatically populated by the USP Agent upon Threshold creation using the reference to the USP Controller that created the instance.

The USP Controller referenced by this parameter also defines the set of permissions to use when evaluating the threshold. Furthermore, only the USP Controller referenced by this parameter will receive a Triggered! Event (assuming it has an associated Subscription), even if another USP Controller has an associated Subscription.

- 2.15 TR-181i2a15c1

Notification Requirements

Parameters for which Value Change Notification MAY be Denied

Parameter

Profile Definitions

Notation

The following abbreviations are used to specify profile requirements:

Abbreviation Description
R Read support is REQUIRED.
W Both Read and Write support is REQUIRED. This MUST NOT be specified for a parameter that is defined as read-only.
P The object is REQUIRED to be present.
C Creation and deletion of instances of the object is REQUIRED.
A Creation of instances of the object is REQUIRED, but deletion is not REQUIRED.
D Deletion of instances of the object is REQUIRED, but creation is not REQUIRED.

IPLayerCapacityTest:1 Profile

This table defines the IPLayerCapacityTest:1 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.15.

Name Requirement
Device.​IP.​Diagnostics. P
IPLayerCapacitySupported R
IPLayerCapSupportedSoftwareVersion R
IPLayerCapSupportedControlProtocolVersion R
IPLayerCapSupportedMetrics R
IPLayerCapacity() P
Input. -
Role W
Host W
JumboFramesPermitted W
DSCP W
TestType W
IPDVEnable W
TestSubInterval W
StatusFeedbackInterval W
SeqErrThresh W
ReordDupIgnoreEnable W
LowerThresh W
UpperThresh W
HighSpeedDelta W
SlowAdjThresh W
Output. -
BOMTime R
MaxIPLayerCapacity R
TimeOfMax R
LossRatioAtMax R
RTTRangeAtMax R
PDVRangeAtMax R
MaxETHCapacityNoFCS R
MaxETHCapacityWithFCS R
MaxETHCapacityWithFCSVLAN R
IPLayerCapacitySummary R
LossRatioSummary R
MinRTTSummary R

Baseline:4 Profile

This table defines the Baseline:4 profile for the Device:2 data model. The minimum REQUIRED version for this profile is Device:2.15.

Name Requirement
Device. P
RootDataModelVersion R
InterfaceStackNumberOfEntries R
Device.​DeviceInfo. P
Manufacturer R
ManufacturerOUI R
ModelName R
Description R
SerialNumber R
HardwareVersion R
SoftwareVersion R
ProvisioningCode W
UpTime R
Device.​InterfaceStack.​{i}. P
HigherLayer R
LowerLayer R
Device.​DNS. P
SupportedRecordTypes R
Device.​DNS.​Client. P
Enable W
Status R
ServerNumberOfEntries R
Device.​DNS.​Client.​Server.​{i}. C
Enable W
Status R
DNSServer W
Interface W
Type R


Generated by Broadband Forum report.pl#428+ (2022-01-07 version) on 2022/07/19 at 16:57:39 (INTERIM VERSION).
report.pl --exitcode=fatals --usp --cwmpindex=.. --nofontstyles --nowarnreport --quiet --lastonly --report=html --outfile=tr-181-2-15-1-usp-diffs.html tr-181-2-15-1-usp.xml --altnotifreqstyle --clampversion=2.12 --ignoreenableparameter --immutablenonfunctionalkeys --markmounttype --valuessuppliedoncreate