Newer
Older
"required": [
"trigger"
],
"type": "object",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Structure (inline)"
},
"notificationPeriod": {
"description": "Set for periodic notification reporting.\nValue indicates the notification period in seconds.",
"format": "uint8",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint8"
},
"requestTestNotification": {
"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.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
},
"description": "Identifier(s) to uniquely specify the target client station(s) for the subscription.",
"items": {
"$ref": "#/components/schemas/StaIdentity"
},
"minItems": 1,
"type": "array",
"x-etsi-mec-cardinality": "1..N",
"x-etsi-mec-origin-type": "StaIdentity"
},
"subscriptionType": {
"description": "Shall be set to \"StaDataRateSubscription\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"websockNotifConfig": {
"$ref": "#/components/schemas/WebsockNotifConfig"
}
},
"required": [
"subscriptionType",
"staId"
],
"type": "object",
"x-etsi-notes": "NOTE 1:\tAt least one of callbackReference and websockNotifConfig shall be provided by the service consumer. If both are provided, it is up to WAIS to select the method to be used for notifications and to return only that method in the response.\nNOTE 2:\tStaDataRateSubscription shall include either notificationPeriod or notificationEvent.\nNOTE 3:\tIf both notificationPeriod and notificationEvent attributes are set, notifications are issued periodically when the trigger threshold is satisfied.",
"x-etsi-ref": "6.3.3"
},
"StaIdentity": {
"properties": {
"aid": {
"description": "Number which identifies a particular association between a station and an Access Point",
"type": "string",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "String"
},
"ipAddress": {
"description": "IPv4 or IPv6 address(es) allocated for the station.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
},
"macId": {
"description": "Unique identifier assigned to station (as network interface controller) for communications at the data link layer of a network segment.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"ssid": {
"description": "Service Set Identifier(s) to identify logical networks.",
"items": {
"type": "string"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"macId"
],
"type": "object",
"x-etsi-ref": "6.5.11"
},
"StaInfo": {
"properties": {
"apAssociated": {
"description": "Beacon Report as defined in IEEE 802.11-2016 [8]. ",
"items": {
"$ref": "#/components/schemas/BeaconReport"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "BeaconReport"
"description": "Channel currently used by the station to connect with its associated Access Point.",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"channelLoad": {
"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.",
"items": {
"$ref": "#/components/schemas/ChannelLoad"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "ChannelLoad"
},
"neighborReport": {
"description": "Information about neighbor Access Points seen by the station as defined IEEE 802.11-2016 [8].",
"items": {
"$ref": "#/components/schemas/NeighborReport"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "NeighborReport"
},
"description": "Statistics as defined in IEEE 802.11-2016 [8] for the client station collected over measurement duration.",
"items": {
"$ref": "#/components/schemas/StaStatistics"
},
"minItems": 0,
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "StaStatistics"
"$ref": "#/components/schemas/TimeStamp"
}
},
"required": [
"staId"
],
"type": "object",
"x-etsi-ref": "6.2.3"
},
"StaStatistics": {
"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].\nDepending on group identity, one and only one of the STA Statistics Group Data will be present.",
"format": "uint8",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt8"
"groupOneData": {
"$ref": "#/components/schemas/StaStatisticsGroupOneData"
"groupZeroData": {
"$ref": "#/components/schemas/StaStatisticsGroupZeroData"
"measurementDuration": {
"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.",
"format": "uint16",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt16"
"measurementId": {
"description": "Measurement ID of the Measurement configuration applied to this STA Statistics Report.",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
"staId": {
"$ref": "#/components/schemas/StaIdentity"
}
},
"required": [
"measurementId",
"measurementDuration",
"groupIdentity"
],
"type": "object",
"x-etsi-ref": "6.5.13"
},
"StaStatisticsConfig": {
"properties": {
"groupIdentity": {
"description": "As per Table 9-92 of IEEE 802.11-2016 [8].",
"format": "uint8",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
"measurementCount": {
"description": "Valid if triggeredReport = true.\nSpecifies the number of MAC service data units or protocol data units to determine if the trigger conditions are met.",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Uint32"
},
"triggerCondition": {
"$ref": "#/components/schemas/STACounterTriggerCondition"
"triggerTimeout": {
"description": "Valid if triggeredReport = true.\nThe 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.",
"format": "uint16",
"type": "integer",
"x-etsi-mec-cardinality": "0..1",
"triggeredReport": {
"description": "True = triggered reporting, otherwise duration.",
"type": "boolean",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Boolean"
}
},
"required": [
"groupIdentity",
"triggeredReport"
],
"type": "object",
"x-etsi-ref": "6.5.26"
},
"StaStatisticsGroup2to9Data": {
"properties": {
"qosAckFailureCount": {
"description": "dot11QosAckFailureCount counter",
"qosDiscardedFrameCount": {
"description": "dot11QosDiscardedFrameCount counter",
"qosFailedCount": {
"description": "dot11QosFailedCount counter",
"qosFrameDuplicateCount": {
"description": "dot11QosFrameDuplicateCount counter",
"qosMPDUsReceivedCount": {
"description": "dot11QosMPDUsReceivedCount counter",
"qosMultipleRetryCount": {
"description": "dot11QosMultipleRetryCount counter",
"qosRTSFailureCount": {
"description": "dot11QosRTSFailureCount counter",
"qosRTSSuccessCount": {
"description": "dot11QosRTSSuccessCount counter",
"qosReceivedFragmentCount": {
"description": "dot11QosReceivedFragmentCount counter",
"qosRetriesReceivedCount": {
"description": "dot11QosRetriesReceivedCount counter",
"qosRetryCount": {
"description": "dot11QosRetryCount counter",
"qosTransmittedFragmentCount": {
"description": "dot11QosTransmittedFragmentCount counter",
"qosTransmittedFrameCount": {
"description": "dot11QosTransmittedFrameCount counter",
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
"reportingReasonQoSCounters": {
"$ref": "#/components/schemas/ReportingReasonQoSCounters"
}
},
"required": [
"qosTransmittedFragmentCount",
"qosFailedCount",
"qosRetryCount",
"qosMultipleRetryCount",
"qosFrameDuplicateCount",
"qosRTSSuccessCount",
"qosRTSFailureCount",
"qosAckFailureCount",
"qosReceivedFragmentCount",
"qosTransmittedFrameCount",
"qosDiscardedFrameCount",
"qosMPDUsReceivedCount",
"qosRetriesReceivedCount"
],
"type": "object",
"x-etsi-ref": "6.5.36"
},
"StaStatisticsGroupOneData": {
"properties": {
"ackFailureCount": {
"description": "dot11AckFailureCount counter",
"frameDuplicateCount": {
"description": "dot11FrameDuplicateCount counter",
"multipleRetryCount": {
"description": "dot11MultipleRetryCount counter",
"reportingReasonStaCounters": {
"$ref": "#/components/schemas/ReportingReasonStaCounters"
"retryCount": {
"description": "dot11RetryCount counter",
"rtsFailureCount": {
"description": "dot11RTSFailureCount counter",
"rtsSuccessCount": {
"description": "dot11RTSSuccessCount counter",
}
},
"required": [
"retryCount",
"multipleRetryCount",
"frameDuplicateCount",
"rtsSuccessCount",
"rtsFailureCount",
"ackFailureCount"
],
"type": "object",
"x-etsi-ref": "6.5.35"
},
"StaStatisticsGroupZeroData": {
"properties": {
"failedCount": {
"description": "dot11FailedCount counter",
"fcsErrorCount": {
"description": "dot11FCSErrorCount counter",
"groupReceivedFrameCount": {
"description": "dot11GroupReceivedFrameCount counter",
"groupTransmittedFrameCount": {
"description": "dot11GroupTransmittedFrameCount counter",
"receivedFragmentCount": {
"description": "dot11ReceivedFragmentCount counter",
"reportingReasonStaCounters": {
"$ref": "#/components/schemas/ReportingReasonStaCounters"
"transmittedFragmentCount": {
"description": "dot11TransmittedFragmentCount counter",
"transmittedFrameCount": {
"description": "dot11TransmittedFrameCount counter",
"x-etsi-mec-origin-type": "Uint32"
}
},
"required": [
"transmittedFragmentCount",
"groupTransmittedFrameCount",
"failedCount",
"receivedFragmentCount",
"groupReceivedFrameCount",
"fcsErrorCount",
"transmittedFrameCount"
],
"type": "object",
"x-etsi-ref": "6.5.34"
},
"SubscriptionLinkList": {
"properties": {
"_links": {
"description": "List of hyperlinks related to the resource.",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
"minItems": 0,
"properties": {
"href": {
"description": "The URI referring to the subscription.",
"format": "uri",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "URI"
},
"subscriptionType": {
"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:\n“AssocStaSubscription”\n“StaDataRateSubscription”\n“MeasurementReportSubscription”",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
}
},
"required": [
"href",
"subscriptionType"
],
"type": "object"
},
"type": "array",
"x-etsi-mec-cardinality": "0..N",
"x-etsi-mec-origin-type": "Structure (inlined)"
}
},
"required": [
"_links"
],
"type": "object",
"x-etsi-ref": "6.3.4"
},
"TestNotification": {
"properties": {
"_links": {
"description": "Hyperlink related to the resource. ",
"properties": {
"subscription": {
"$ref": "#/components/schemas/LinkType"
}
"required": [
"subscription"
],
"type": "object",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Structure (inlined)"
},
"notificationType": {
"description": "Shall be set to \"TestNotification\".",
"type": "string",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "String"
},
"TimeStamp": {
"properties": {
"nanoSeconds": {
"description": "The nanoseconds part of the time. Time is defined as Unix-time since January 1, 1970, 00:00:00 UTC.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
},
"seconds": {
"description": "The seconds part of the time. Time is defined as Unixtime since January 1, 1970, 00:00:00 UTC.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
}
},
"required": [
"seconds",
"nanoSeconds"
],
"type": "object",
"x-etsi-ref": "6.5.2"
},
"VhtCapabilities": {
"properties": {
"vhtCapInfo": {
"description": "VHT capabilities Info as defined in IEEE 802.11-2016 [8].",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt32"
},
"vhtMcsNss": {
"description": "Supported VHT-MCS and NSS Set as defined in IEEE 802.11-2016 [8].",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt64"
}
},
"required": [
"vhtCapInfo",
"vhtMcsNss"
],
"type": "object",
"x-etsi-ref": "6.5.15"
},
"WanMetrics": {
"properties": {
"downlinkLoad": {
"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.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt8"
},
"downlinkSpeed": {
"description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link current downlink speed in kilobits per second.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint32"
},
"lmd": {
"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.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint16"
},
"uplinkLoad": {
"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.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
},
"uplinkSpeed": {
"description": "4-octet positive integer whose value is an estimate of the WAN Backhaul link's current uplink speed in kilobits per second.",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "UInt32"
},
"wanInfo": {
"description": "Info about WAN link status, link symmetricity and capacity currently used.",
"type": "integer",
"x-etsi-mec-cardinality": "1",
"x-etsi-mec-origin-type": "Uint8"
}
},
"required": [
"wanInfo",
"downlinkSpeed",
"uplinkSpeed",
"downlinkLoad",
"uplinkLoad",
"lmd"
],
"type": "object",
"x-etsi-ref": "6.5.6"
},
"WebsockNotifConfig": {
"properties": {
"requestWebsocketUri": {
"description": "Set to true by the service consumer to indicate that Websocket delivery is requested.",
"type": "boolean",
"x-etsi-mec-cardinality": "0..1",
"x-etsi-mec-origin-type": "Boolean"
},
"websocketUri": {
"description": "Set by WAIS to indicate to the service consumer the Websocket URI to be used for delivering notifications.",
"type": "string"
}
},
"type": "object",
"x-etsi-ref": "6.3.6"
},
"WlanCapabilities": {
"properties": {
"dmg": {
}
},
"type": "object",
"x-etsi-ref": "6.5.4"
}
}
}
}