WlanInformationApi.yaml 85.5 KB
Newer Older
Michel Roy's avatar
Michel Roy committed
2001 2002 2003 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 2035 2036 2037 2038 2039 2040 2041 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 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RSNAStatsCMACReplays:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RSNAStatsRobustMgmtCCMPReplays:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RSNAStatsTKIPICVErrors:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RSNAStatsTKIPReplays:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RTSFailureCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RTSLSIGFailureCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RTSLSIGSuccessCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RTSSuccessCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11ReceivedAMSDUCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11ReceivedFragmentCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11ReceivedOctetsInAMPDUCount:
          format: uint64
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint64
        dot11ReceivedOctetsInAMSDUCount:
          format: uint64
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint64
        dot11RetryAMSDUCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11RetryCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11STAStatisticsAPAverageAccessDelay:
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STAStatisticsAverageAccessDelayBackGround:
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STAStatisticsAverageAccessDelayBestEffort:
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STAStatisticsAverageAccessDelayVideo:
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STAStatisticsAverageAccessDelayVoice:
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STAStatisticsChannelUtilization:
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STAStatisticsStationCount:
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint8
        dot11STBCCTSFailureCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11STBCCTSSuccessCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedAMPDUCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedAMSDUCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedFragmentCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedFrameCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedFramesInGrantedRDGCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedMPDUsInAMPDUCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedOctetsInAMPDUCount:
          format: uint64
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint64
        dot11TransmittedOctetsInAMSDUCount:
          format: uint64
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TransmittedOctetsInGrantedRDGCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TwentyMHzFrameReceivedCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11TwentyMHzFrameTransmittedCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11nonSTBCCTSFailureCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
        dot11nonSTBCCTSSuccessCount:
          format: uint32
          type: integer
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Uint32
      type: object
    SubscriptionLinkList:
      properties:
        _links:
          description: Hyperlink related to the resource. This shall be only included
            in the HTTP responses and in HTTP PUT requests.
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/LinkType'
              - description: URI referring to a resource
              - x-etsi-mec-cardinality: 1
              - x-etsi-mec-origin-type: LinkType
          type: object
          x-etsi-mec-cardinality: 0..1
          x-etsi-mec-origin-type: Structure (inlined)
        assocStaSubscription:
          items:
            $ref: '#/components/schemas/AssocStaSubscription'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: AssocStaSubscription
        staDataRateSubscription:
          items:
            $ref: '#/components/schemas/StaDataRateSubscription'
          type: array
          x-etsi-mec-cardinality: 0..N
          x-etsi-mec-origin-type: StaDataRateSubscription
      required:
      - _links
      type: object
    TimeStamp:
      properties:
        nanoSeconds:
          type: integer
          format: uint32
          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:
          type: integer
          format: uint32
          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:
          type: integer
          format: uint32
          description: VHT capabilities Info as defined in IEEE 802.11-2016 [8].
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt32
        vhtMcsNss:
          type: integer
          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:
          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.
          x-etsi-mec-cardinality: '1'
          x-etsi-mec-origin-type: UInt8
        downlinkSpeed:
          type: integer
          format: uint32
          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:
          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.
          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:
          type: integer
          format: uint32
          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
    WlanCapabilities:
      properties:
        dmg:
          allOf:
          - $ref: '#/components/schemas/DmgCapabilities'
          - description: Information about Access Point DMG capabilities as defined in IEEE 802.11-2016 [8].
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: DmgCapabilities
        edmg:
          allOf:
          - $ref: '#/components/schemas/EdmgCapabilities'
          - description: Information about Access Point EDMG capabilities as defined in draft IEEE P802.11/D4.0 [i.11].
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: EdmgCapabilities
        he:
          allOf:
          - $ref: '#/components/schemas/HeCapabilities'
          - description: Information about Access Point HE capabilities as defined in FFS.
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: HeCapabilities
        ht:
          allOf:
          - $ref: '#/components/schemas/HtCapabilities'
          - description: "Information about Access Point HT capabilities as defined\
            \ in IEEE\_802.11-2016 [8]."
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: HtCapabilities
        vht:
          allOf:
          - $ref: '#/components/schemas/VhtCapabilities'
          - description: Information about Access Point VHT capabilities as defined in IEEE 802.11-2016 [8].
          - x-etsi-mec-cardinality: 0..1
          - x-etsi-mec-origin-type: VhtCapabilities
      type: object
      x-etsi-ref: 6.5.4