update_wlan
Change an existing UniFi SSID: update passphrase, enable/disable, hide SSID, WPA3, roaming, or PMF mode. Only supplied fields are changed; target resolved by ID or name.
Instructions
Update a wireless network (SSID); only the fields you provide change.
Mutating operation: applied immediately and persisted on the UniFi console. Any single field updates the matching SSID (resolved by ID or name). Requoting passphrase sets the WiFi password; pmf_mode is disabled|optional|required. Inspect with get_wlans.
Args: wlan: WLAN id or SSID name to update. enabled: Enable or disable the SSID. hide_ssid: Hide the SSID from beacon broadcasts. passphrase: New WiFi password (minimum 8 characters). wpa3_support: Enable WPA3 support on the SSID. wpa3_transition: WPA2/WPA3 transition mode (keeps WPA2 for legacy clients). pmf_mode: Protected Management Frames mode — "disabled", "optional", or "required". bss_transition: Enable 802.11k/v band and AP steering. fast_roaming_enabled: Enable 802.11r fast roaming. site: Site to operate on. Defaults to "default". device: Optional console name to target a specific UniFi device; omit for default.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site | No | Site to operate on. Defaults to "default". | default |
| wlan | Yes | WLAN id or SSID name to update. | |
| device | No | Optional console name to target a specific UniFi device; omit for default. | |
| enabled | No | Enable or disable the SSID. | |
| pmf_mode | No | Protected Management Frames mode — "disabled", "optional", or "required". | |
| hide_ssid | No | Hide the SSID from beacon broadcasts. | |
| passphrase | No | New WiFi password (minimum 8 characters). | |
| wpa3_support | No | Enable WPA3 support on the SSID. | |
| bss_transition | No | Enable 802.11k/v band and AP steering. | |
| wpa3_transition | No | WPA2/WPA3 transition mode (keeps WPA2 for legacy clients). | |
| fast_roaming_enabled | No | Enable 802.11r fast roaming. |