wlan-ucentral-schema/schema/radio.yml

description:
  Describe a physical radio on the AP. A radio is be parent to several VAPs.
  They all share the same physical properties.
type: object
properties:
  band:
    description:
      Specifies the wireless band to configure the radio for. Available radio device
      phys on the target system are matched by the wireless band given here.
      If multiple radio phys support the same band, the settings specified here will
      be applied to all of them.
    type: string
    enum:
    - 2G
    - 5G
    - 5G-lower
    - 5G-upper
    - 6G
    - HaLow
  bandwidth:
    description:
      Specifies a narrow channel width in MHz, possible values are 5, 10, 20.
    type: integer
    enum:
    - 5
    - 10
    - 20
  channel:
    description:
      Specifies the wireless channel to use. A value of 'auto' starts the ACS
      algorithm.
    oneOf:
      - type: integer
        maximum: 233
        minimum: 1
      - type: string
        const: auto
  valid-channels:
    description:
      Pass a list of valid-channels that can be used during ACS.
    type: array
    items:
      type: integer
      maximum: 233
      minimum: 1
  acs-exclude-6ghz-non-psc:
    description:
      Exclude non-psc when doing auto channel selection on 6GHz
    type: boolean
    default: false
  country:
    description:
      Specifies the country code, affects the available channels and
      transmission powers.
    type: string
    maxLength: 2
    minLength: 2
    examples:
    - US
  allow-dfs:
    description:
      This property defines whether a radio may use DFS channels.
    type: boolean
    default: true
  channel-mode:
    description:
      Define the ideal channel mode that the radio shall use. This can be 802.11n, 802.11ac
      or 802.11ax. This is just a hint for the AP. If the requested value is not supported
      then the AP will use the highest common denominator.
    type: string
    enum:
    - HT
    - VHT
    - HE
    - EHT
    default: HE
  channel-width:
    description:
      The channel width that the radio shall use. This is just a hint for the AP. If the
      requested value is not supported then the AP will use the highest common denominator.
    type: integer
    enum:
    - 1
    - 2
    - 4
    - 8
    - 20
    - 40
    - 80
    - 160
    - 320
    - 8080
    default: 80
  enable:
    description:
      Specifies radio is enabled/disabled.
    type: boolean
  require-mode:
    description:
      Stations that do no fulfill these HT modes will be rejected.
    type: string
    enum:
    - HT
    - VHT
    - HE
  mimo:
    description:
      This option allows configuring the antenna pairs that shall be used.
      This is just a hint for the AP. If the requested value is not supported
      then the AP will use the highest common denominator.
    type: string
    enum:
    - 1x1
    - 2x2
    - 3x3
    - 4x4
    - 5x5
    - 6x6
    - 7x7
    - 8x8
  tx-power:
    description:
      This option specifies the transmission power in dBm
    type: integer
    maximum: 30
    minimum: 0
  legacy-rates:
    description:
      Allow legacy 802.11b data rates.
    type: boolean
    default: false
  maximum-clients:
    description:
      Set the maximum number of clients that may connect to this radio. This
      value is accumulative for all attached VAP interfaces.
    type: integer
    example: 64
  maximum-clients-ignore-probe:
    description:
      Ignore probe requests if maximum-clients was reached.
    type: boolean
  rates:
    $ref: "https://ucentral.io/schema/v1/radio/rates/"
  he-settings:
    $ref: "https://ucentral.io/schema/v1/radio/he/"
  he-6ghz-settings:
    $ref: "https://ucentral.io/schema/v1/radio/he-6ghz/"
  hostapd-iface-raw:
    description:
      This array allows passing raw hostapd.conf lines.
    type: array
    items:
      type: string
      examples:
      - 'ap_table_expiration_time=3600'
      - 'device_type=6-0050F204-1'
      - 'ieee80211h=1'
      - 'rssi_ignore_probe_request=-75'
      - 'time_zone=EST5'
      - 'uuid=12345678-9abc-def0-1234-56789abcdef0'
      - 'venue_url=1:http://www.example.com/info-eng'
      - 'wpa_deny_ptk0_rekey=0'