create_wlan
Create a secure Wi-Fi SSID on UniFi with WPA2/WPA3 transition, optional VLAN, guest isolation, or hidden broadcast. Set name and passphrase to deploy the wireless network immediately.
Instructions
Create a wireless network (SSID) with WPA2/WPA3 transition security by default.
Mutating operation: applied immediately and persisted on the UniFi console. Passphrase must be 8-63 characters. WPA2/WPA3 transition is enabled unless wpa3_transition is False, keeping WPA2 for legacy clients. Attach to a VLAN via network_conf_id, or mark is_guest for an isolated guest SSID. Inspect with get_wlans.
Args: name: SSID broadcast name. passphrase: WiFi password, 8-63 characters. network_conf_id: Network id to attach the SSID to; omit for the default LAN. wpa3_transition: Use WPA2/WPA3 transition mode. Defaults to True. hide_ssid: Broadcast the SSID hidden when True. Defaults to False. is_guest: Mark the SSID as an isolated guest network. Defaults to False. 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 |
|---|---|---|---|
| name | Yes | SSID broadcast name. | |
| site | No | Site to operate on. Defaults to "default". | default |
| device | No | Optional console name to target a specific UniFi device; omit for default. | |
| is_guest | No | Mark the SSID as an isolated guest network. Defaults to False. | |
| hide_ssid | No | Broadcast the SSID hidden when True. Defaults to False. | |
| passphrase | Yes | WiFi password, 8-63 characters. | |
| network_conf_id | No | Network id to attach the SSID to; omit for the default LAN. | |
| wpa3_transition | No | Use WPA2/WPA3 transition mode. Defaults to True. |