Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Made description of 'disabled' property less ambiguous.

...

PropertyDescription

band ( 2ghz-g | 2ghz-n | 2ghz-ax | 5ghz-a | 5ghz-ac | 5ghz-an | 5ghz-ax )

Supported frequency band and wireless standard. Defaults to newest supported standard. Note that band support is limited by radio capabilities.

channel-width ( 20mhz | 20/40mhz | 20/40mhz-Ce | 20/40mhz-eC | 20/40/80mhz | 20/40/80+80mhz  20/40/80/160mhz )

Width of radio channel. Defaults to widest supported.
configuration.chains (list of integer [0..7])Radio chains to use for receiving signals. Defaults to all available chains.
configuration.tx-chains (list of integer [0..7])Radio chains to use for transmitting signals. Defaults to all available chains.
configuration.country (name of a country)Determines, which regulatory domain restrictions are applied to an interface. Defaults to "United States", prohibiting use of frequencies 2467-2472 in the 2.4GHz band.
configuration.hide-ssid (no | yes)
  • yes - AP does not include SSID in the beacon frames, and does not reply to probe requests that have broadcast SSID.
  • no - AP includes SSID in the beacon frames, and replies to probe requests that have broadcast SSID.

Default: no

disable-running-check (no | yes)
  • yes - interface will have the 'running' flag whenever it is enabled and has a valid configuration applied to it
  • no - interface will only have the 'running' flag when it has established an active wireless link

Default: no

disabled ( no | yes )Whether interface is disabled. By default, hardware (master) Hardware interfaces are disabled by default, while but virtual interfaces ones are enablednot.
frequency ( list of integer ranges Start[-End][:RangeStep] )

Frequencies to use for control channel when operating as AP or frequencies to scan for APs on when operating as a station (client). Defaults to all supported channels in the given frequency band.

Note: unlike the standard wireless package wifiwave2 does not support operating on non-standard radio channels (channels without an official number e.g. 5200/ac/Ceee).

mac-address (MAC)

MAC address (BSSID) to use for an interface.

Hardware interfaces default to the MAC address of the associated radio interface.

Virtual interfaces are assigned MAC addresses are generated by

  1. Taking the MAC address of the associated master interface
  2. Setting the second-least-significant bit of the first octet to 1, resulting in a locally administered MAC address
  3. If needed, incrementing the last octet of the address to ensure it doesn't overlap with the address of another interface on the device
master ( name of an interface )Master interface for virtual interfaces.
mode ( ap | station )Operating mode for the interface. Defaults to 'ap'.
secondary-frequency ( list of integer | disabled )Frequency to use for the center of the second part of a split 80+80MHz channel.
security.authentication-types ( list of owe, wpa-eap, wpa-psk, wpa2-eap, wpa2-psk, wpa3-eap, wpa3-psk )Authentication types to enable on the interface. Defaults to an empty list (open AP) if security.passphrase is unset or 'wpa2-psk', if it is.
security.passphrase ( string 0..63 chars )Passphrase to use for PSK authentication types. Defaults to "". WPA-PSK and WPA2-PSK authentication requires a minimum of 8 chars, while WPA3-PSK does not have minimum passphrase length.
security.management-protection ( allowed | disabled | required )Whether to use 802.11w management frame protection (incompatible with management frame protection in standard wireless package). Defaults to 'allowed' when PSK authentication is used.
security.owe-transition-interface (name of interface)Name of an interface whose MAC address and SSID to advertise as the matching AP when running in OWE transition mode. Required for setting up open APs that offer OWE, but also work with older devices that don't support the standard. See configuration example below.
ssid (string)ESSID (extended service set identifier) is a name that identifies wireless network. Default: None.

...