Newer
Older
staStatisticsConf:
$ref: '#/components/schemas/StaStatisticsConfig'
MeasurementReportNotification:
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
title: MeasurementReportNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- type: object
properties:
beaconReport:
minItems: 0
type: array
items:
$ref: '#/components/schemas/BeaconReport'
description: Beacon Report as defined in IEEE 802.11-2016 [8].
channelLoad:
minItems: 0
type: array
items:
$ref: '#/components/schemas/ChannelLoad'
description: Channel Load reports as seen by the station as defined in IEEE 802.11-2016 [8].
neighborReport:
minItems: 0
type: array
items:
$ref: '#/components/schemas/NeighborReport'
description: Neighbor Report providing information about neighbor Access Points seen by the station as defined in IEEE 802.112016 [8].
staStatistics:
minItems: 0
type: array
items:
$ref: '#/components/schemas/StaStatistics'
description: STA Statistics Report as defined in IEEE 802.11-2016 [8].
timeStamp:
$ref: '#/components/schemas/TimeStamp'
title: MeasurementReportSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
- staId
type: object
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
measurementId:
type: string
description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement subscription.
measurementInfo:
$ref: '#/components/schemas/MeasurementInfo'
requestTestNotification:
type: boolean
description: Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications.
staId:
minItems: 1
type: array
items:
$ref: '#/components/schemas/StaIdentity'
description: Identifier(s) to uniquely specify the target client station(s) for the subscription.
websockNotifConfig:
$ref: '#/components/schemas/WebsockNotifConfig'
title: NeighborReport
required:
- bssid
- bssidInfo
- channel
- measurementId
- operatingClass
- phyType
type: object
description: Relative value indicating the preferred ordering for this BSS as a transition candidate for roaming. 255 indicating the most preferred candidate and 1 indicating the least preferred candidate, as defined in Table 9-152 within IEEE 802.112016 [8].
contentEncoding: int32
description: BSSID (MAC address) of the Access Point that is being reported.
description: Channel field indicates a channel number, which is interpreted in the context of the indicated operating class. Channel numbers are defined in Annex E within IEEE 802.11-2016 [8].
contentEncoding: int32
description: Measurement ID of the Measurement configuration applied to this Neighbor Report.
description: Operating Class field indicates an operating class value as defined in Annex E within IEEE 802.11-2016 [8].
contentEncoding: int32
description: >-
PHY type of the AP indicated by this BSSID. It is an integer value coded according to the value of the dot11PHYType, Annex C within IEEE 802.11-2016 [8].
2 = dsss
4 = ofdm
5 = hrdsss
6 = erp
7 = ht
8 = dmg
9 = vht
10 = tvht
contentEncoding: int32
staId:
$ref: '#/components/schemas/StaIdentity'
title: NeighborReportConfig
type: object
description: BSSID of the neighbor AP which information is intended to obtain. If no specific BSSID is given, the information will be provided for all APs matching the ssid criteria.
type: string
description: The SSID field is optionally present. If present, it contains an SSID element. The presence of an SSID element in a Neighbor Report indicates a request for a neighbor list for the specified SSID in the SSID Element. The absence of an SSID element indicates neighbor report for the current ESS.
title: OBssLoad
required:
- allocatedTrafficSelfMean
- allocatedTrafficShareMean
type: object
description: Mean of allocated traffic from this AP (BSS) in units of 32 µs per second.
contentEncoding: int32
description: Standard deviation from the mean of allocation traffic from this BSS in units of 32 µs per second.
contentEncoding: int32
description: Mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.
contentEncoding: int32
description: Standard deviation from the mean of the sum of allocated traffic from other APs on the overlapping channel in unit of 32 µs per second.
contentEncoding: int32
description: Indicates the number of other APs that are sharing the same channel as the reporting AP.
contentEncoding: int32
title: ProblemDetails
type: object
description: A human-readable explanation specific to this occurrence of the problem
description: A URI reference that identifies the specific occurrence of the problem
description: The HTTP status code for this occurrence of the problem
contentEncoding: int32
description: A short, human-readable summary of the problem type
description: A URI reference according to IETF RFC 3986 that identifies the problem type
title: ReportedBeaconFrameInfo
required:
- frameType
- phyType
type: object
type: integer
description: >-
description: Value between 0 and 127 coded according to dot11PHYType.
contentEncoding: int32
ReportingReasonQoSCounters:
title: ReportingReasonQoSCounters
- qosAckFailure
- qosDiscarded
- qosFailed
- qosFrameDuplicate
- qosMultipleRetry
- qosRetry
- qosRtsFailure
type: object
properties:
qosAckFailure:
type: boolean
description: dot11QoSFrameDuplicate
description: dot11QoSMultipleRetry
description: dot11QoSRTSFailure
ReportingReasonStaCounters:
title: ReportingReasonStaCounters
- ackFailure
- failed
- fcsError
- frameDuplicate
- multipleRetry
- retry
- rtsFailure
type: object
properties:
ackFailure:
type: boolean
title: Rssi
required:
- rssi
type: object
description: The Received Signal Strength Indicator from a station
contentEncoding: int32
title: STACounterTriggerCondition
type: object
description: Configure and set threshold for dot11AckFailureCount trigger
contentEncoding: int32
description: Configure and set threshold for dot11FailedCount trigger
contentEncoding: int32
description: Configure and set threshold for dot11FCSErrorCount trigger
contentEncoding: int32
description: Configure and set threshold for dot11FrameDuplicateCount trigger
contentEncoding: int32
description: Configure and set threshold for dot11MultipleRetryCount trigger
contentEncoding: int32
description: Configure and set threshold for dot11RetryCount trigger
contentEncoding: int32
description: Configure and set threshold for dot11RTSFailureCount trigger
contentEncoding: int32
title: StaDataRate
type: object
properties:
staId:
$ref: '#/components/schemas/StaIdentity'
staLastDataDownlinkRate:
description: The data transmit rate in kbps that was most recently used for transmission of data PPDUs from the access point to the station.
contentEncoding: int32
description: The data transmit rate in Kbps that was most recently used for transmission of data PPDUs from the associated station to the access point.
contentEncoding: int32
title: StaDataRateNotification
allOf:
- $ref: '#/components/schemas/InlineNotification'
- type: object
properties:
staDataRate:
minItems: 0
type: array
items:
$ref: '#/components/schemas/StaDataRate'
description: Data rates of a client station.
timeStamp:
$ref: '#/components/schemas/TimeStamp'
title: StaDataRateSubscription
allOf:
- $ref: '#/components/schemas/InlineSubscription'
- required:
- staId
type: object
properties:
_links:
$ref: '#/components/schemas/Links'
callbackReference:
type: string
expiryDeadline:
$ref: '#/components/schemas/TimeStamp'
notificationEvent:
$ref: '#/components/schemas/NotificationEvent1'
notificationPeriod:
type: integer
description: >-
Set for periodic notification reporting.
Value indicates the notification period in seconds.
contentEncoding: int32
requestTestNotification:
type: boolean
description: Set to TRUE by the service consumer to request a test notification on the callbackReference URI to determine if it is reachable by the WAIS for notifications.
staId:
minItems: 1
type: array
items:
$ref: '#/components/schemas/StaIdentity'
description: Identifier(s) to uniquely specify the target client station(s) for the subscription.
websockNotifConfig:
$ref: '#/components/schemas/WebsockNotifConfig'
StaIdentity:
title: StaIdentity
description: Number which identifies a particular association between a station and an Access Point
items:
type: string
description: IPv4 or IPv6 address(es) allocated for the station.
description: Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment.
items:
type: string
description: Service Set Identifier(s) to identify logical networks.
StaInfo:
title: StaInfo
type: object
properties:
apAssociated:
$ref: '#/components/schemas/ApAssociated'
beaconReport:
minItems: 0
type: array
items:
$ref: '#/components/schemas/BeaconReport'
description: Beacon Report as defined in IEEE 802.11-2016 [8].
description: Channel currently used by the station to connect with its associated Access Point.
contentEncoding: int32
description: Channel Load reports as seen by the station as defined IEEE 802.11-2016 [8]. Channel Load reports may be configured for any channel, including the station's current channel for association.
neighborReport:
minItems: 0
type: array
items:
$ref: '#/components/schemas/NeighborReport'
description: Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016 [8].
rssi:
$ref: '#/components/schemas/Rssi'
staDataRate:
$ref: '#/components/schemas/StaDataRate'
staId:
$ref: '#/components/schemas/StaIdentity'
staStatistics:
minItems: 0
type: array
items:
$ref: '#/components/schemas/StaStatistics'
description: Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration.
StaStatistics:
title: StaStatistics
- groupIdentity
- measurementDuration
- measurementId
type: object
properties:
group2to9Data:
$ref: '#/components/schemas/StaStatisticsGroup2to9Data'
groupIdentity:
description: >-
Indicates the requested statistics group describing the Statistics Group Data according to Table 9-114 of IEEE 802.11-2016 [8].
Depending on group identity, one and only one of the STA Statistics Group Data will be present.
contentEncoding: int32
groupOneData:
$ref: '#/components/schemas/StaStatisticsGroupOneData'
groupZeroData:
$ref: '#/components/schemas/StaStatisticsGroupZeroData'
measurementDuration:
type: integer
description: Duration over which the Statistics Group Data was measured in time units of 1 024 µs. Duration equal to zero indicates a report of current values.
contentEncoding: int32
description: Measurement ID of the Measurement configuration applied to this STA Statistics Report.
StaStatisticsConfig:
title: StaStatisticsConfig
- groupIdentity
- triggeredReport
type: object
properties:
groupIdentity:
type: integer
description: As per Table 9-92 of IEEE 802.11-2016 [8].
contentEncoding: int32
Specifies the number of MAC service data units or protocol data units to determine if the trigger conditions are met.
contentEncoding: int32
triggerCondition:
$ref: '#/components/schemas/STACounterTriggerCondition'
triggerTimeout:
The Trigger Timeout field contains a value in units of 100 time-units of 1 024 µs during which a measuring STA does not generate further triggered STA Statistics Reports after a trigger condition has been met.
contentEncoding: int32
description: True = triggered reporting, otherwise duration.
StaStatisticsGroup2to9Data:
title: StaStatisticsGroup2to9Data
- qosAckFailureCount
- qosDiscardedFrameCount
- qosFailedCount
- qosFrameDuplicateCount
- qosMPDUsReceivedCount
- qosMultipleRetryCount
- qosRTSFailureCount
- qosRTSSuccessCount
- qosReceivedFragmentCount
- qosRetriesReceivedCount
- qosRetryCount
- qosTransmittedFragmentCount
- qosTransmittedFrameCount
description: dot11QosAckFailureCount counter
contentEncoding: int32
description: dot11QosDiscardedFrameCount counter
contentEncoding: int32
description: dot11QosFailedCount counter
contentEncoding: int32
description: dot11QosFrameDuplicateCount counter
contentEncoding: int32
description: dot11QosMPDUsReceivedCount counter
contentEncoding: int32
description: dot11QosMultipleRetryCount counter
contentEncoding: int32
description: dot11QosRTSFailureCount counter
contentEncoding: int32
description: dot11QosRTSSuccessCount counter
contentEncoding: int32
description: dot11QosReceivedFragmentCount counter
contentEncoding: int32
description: dot11QosRetriesReceivedCount counter
contentEncoding: int32
description: dot11QosRetryCount counter
contentEncoding: int32
description: dot11QosTransmittedFragmentCount counter
contentEncoding: int32
description: dot11QosTransmittedFrameCount counter
contentEncoding: int32
reportingReasonQoSCounters:
$ref: '#/components/schemas/ReportingReasonQoSCounters'
StaStatisticsGroupOneData:
title: StaStatisticsGroupOneData
- ackFailureCount
- frameDuplicateCount
- multipleRetryCount
- retryCount
- rtsFailureCount
- rtsSuccessCount
description: dot11AckFailureCount counter
contentEncoding: int32
description: dot11FrameDuplicateCount counter
contentEncoding: int32
description: dot11MultipleRetryCount counter
contentEncoding: int32
reportingReasonStaCounters:
$ref: '#/components/schemas/ReportingReasonStaCounters'
retryCount:
description: dot11RetryCount counter
contentEncoding: int32
description: dot11RTSFailureCount counter
contentEncoding: int32
description: dot11RTSSuccessCount counter
contentEncoding: int32
StaStatisticsGroupZeroData:
title: StaStatisticsGroupZeroData
- failedCount
- fcsErrorCount
- groupReceivedFrameCount
- groupTransmittedFrameCount
- receivedFragmentCount
- transmittedFragmentCount
- transmittedFrameCount
description: dot11FailedCount counter
contentEncoding: int32
description: dot11FCSErrorCount counter
contentEncoding: int32
description: dot11GroupReceivedFrameCount counter
contentEncoding: int32
description: dot11GroupTransmittedFrameCount counter
contentEncoding: int32
description: dot11ReceivedFragmentCount counter
contentEncoding: int32
reportingReasonStaCounters:
$ref: '#/components/schemas/ReportingReasonStaCounters'
transmittedFragmentCount:
description: dot11TransmittedFragmentCount counter
contentEncoding: int32
description: dot11TransmittedFrameCount counter
contentEncoding: int32
SubscriptionLinkList:
title: SubscriptionLinkList
$ref: '#/components/schemas/Links6'
items:
$ref: '#/components/schemas/Subscription'
description: ''
TestNotification:
title: TestNotification
$ref: '#/components/schemas/Links1'
description: Shall be set to "TestNotification".
TimeStamp:
title: TimeStamp
type: object
properties:
nanoSeconds:
type: integer
description: The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.
contentEncoding: int32
description: The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.
contentEncoding: int32
VhtCapabilities:
title: VhtCapabilities
type: object
properties:
vhtCapInfo:
type: integer
description: VHT capabilities Info as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
description: Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8].
contentEncoding: int32
WanMetrics:
title: WanMetrics
- downlinkLoad
- downlinkSpeed
- lmd
- uplinkLoad
- uplinkSpeed
- wanInfo
type: object
properties:
downlinkLoad:
type: integer
description: 1-octet positive integer representing the current percentage loading of the downlink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval the duration of which is reported in Load Measurement Duration. In cases where the downlink load is unknown to the AP, the value is set to zero.
contentEncoding: int32
description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second.
contentEncoding: int32
type: integer
description: The LMD (Load Measurement Duration) field is a 2-octet positive integer representing the duration over which the Downlink Load and Uplink Load have been measured, in tenths of a second. When the actual load measurement duration is greater than the maximum value, the maximum value will be reported. The value of the LMD field is set to 0 when neither the uplink nor downlink load can be computed. When the uplink and downlink loads are computed over different intervals, the maximum interval is reported.
contentEncoding: int32
description: 1-octet positive integer representing the current percentage loading of the uplink WAN connection, scaled linearly with 255 representing 100 %, as measured over an interval, the duration of which is reported in Load Measurement Duration. In cases where the uplink load is unknown to the AP, the value is set to zero.
contentEncoding: int32
description: 4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.
contentEncoding: int32
description: Info about WAN link status, link symmetricity and capacity currently used.
contentEncoding: int32
title: WebsockNotifConfig
type: object
description: Set to true by the service consumer to indicate that Websocket delivery is requested.
description: Set by WAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.
title: WlanCapabilities
type: object
properties:
dmg:
$ref: '#/components/schemas/DmgCapabilities'
edmg:
$ref: '#/components/schemas/EdmgCapabilities'
he:
$ref: '#/components/schemas/HeCapabilities'
ht:
$ref: '#/components/schemas/HtCapabilities'
vht:
$ref: '#/components/schemas/VhtCapabilities'
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
InlineNotification:
title: InlineNotification
required:
- notificationType
type: object
properties:
notificationType:
type: string
discriminator:
propertyName: notificationType
mapping:
AssocStaNotification: AssocStaNotification
MeasurementReportNotification: MeasurementReportNotification
StaDataRateNotification: StaDataRateNotification
InlineSubscription:
title: InlineSubscription
required:
- subscriptionType
type: object
properties:
subscriptionType:
type: string
discriminator:
propertyName: subscriptionType
mapping:
AssocStaSubscription: AssocStaSubscription
MeasurementReportSubscription: MeasurementReportSubscription
StaDataRateSubscription: StaDataRateSubscription
Links:
title: Links
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
description: Hyperlink related to the resource. This shall be only included in the HTTP responses and in HTTP PUT requests.
Links1:
title: Links1
required:
- subscription
type: object
properties:
subscription:
$ref: '#/components/schemas/LinkType'
description: Hyperlink related to the resource.
Links4:
title: Links4
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
description: Hyperlink related to the resource.
Links6:
title: Links6
required:
- self
type: object
properties:
self:
$ref: '#/components/schemas/LinkType'
description: List of hyperlinks related to the resource.
MeasurementConfig1:
title: MeasurementConfig1
required:
- href
- measurementId
type: object
properties:
href:
type: string
description: The URI referring to a measurement configuration.
measurementId:
type: string
description: Unique identifier allocated by the service consumer to identify measurement reports associated with this measurement configuration.
NotificationEvent:
title: NotificationEvent
required:
- threshold
- trigger
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
properties:
threshold:
type: integer
description: Number of connected stations threshold for trigger-based event reporting.
contentEncoding: int32
trigger:
$ref: '#/components/schemas/Trigger'
description: Set for trigger-based event notification reporting.
NotificationEvent1:
title: NotificationEvent1
required:
- trigger
type: object
properties:
downlinkRateThreshold:
type: integer
description: Downlink data rate threshold for StaDataRate reporting.
contentEncoding: int32
trigger:
$ref: '#/components/schemas/Trigger1'
uplinkRateThreshold:
type: integer
description: Uplink data rate threshold for StaDataRate reporting.
contentEncoding: int32
description: Set for trigger-based event notification reporting.
Subscription:
title: Subscription
required:
- href
- subscriptionType
type: object
properties:
href:
type: string
description: The URI referring to the subscription.
subscriptionType:
type: string
description: >-
Type of the subscription. The string shall be set according to the "subscriptionType" attribute of the associated subscription data type defined in 6.3.2, 6.3.3. and 6.3.5:
“AssocStaSubscription”
“StaDataRateSubscription”
“MeasurementReportSubscription”
Trigger:
title: Trigger
enum:
- 1
- 2
type: integer
description: >-
Trigger for the notification:
1 = Notification issued when the number of connected stations is greater than or equal to the threshold.
2 = Notification issued when the number of connected stations is less than or equal to the threshold.
examples:
- 1
Trigger1:
title: Trigger1
enum:
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
type: integer
description: >-
Trigger event for the notification:
1 = Notification issued when the STA's downlink data rate is greater than or equal to the downlink threshold.
2 = Notification issued when the STA's downlink data rate is less than or equal to the downlink threshold.
3 = Notification issued when the STA's uplink data rate is greater than or equal to the uplink threshold.
4 = Notification issued when the STA's uplink data rate is less than or equal to the uplink threshold.
5 = Notification issued when the STA's downlink and uplink data rate is greater than or equal to their thresholds.
6 = Notification issued when the STA's downlink and uplink data rate is less than or equal to their thresholds.
7 = Notification issued when the STA's downlink or uplink data rate is greater than or equal to their thresholds.
8 = Notification issued when the STA's downlink or uplink data rate is less than or equal to their thresholds.
examples:
- 1
security:
- {}