Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Unifi
  3. API Docs
  4. Wlan
Unifi v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse
pulumiverse/pulumi-unifi

unifi.Wlan

Explore with Pulumi AI

Unifi v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse
pulumiverse/pulumi-unifi

unifi.Wlan manages a WiFi network / SSID.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as unifi from "@pulumi/unifi";
import * as unifi from "@pulumiverse/unifi";

const config = new pulumi.Config();
const vlanId = config.getNumber("vlanId") || 10;
const default = unifi.getApGroup({});
const defaultGetGroup = unifi.iam.getGroup({});
const vlan = new unifi.Network("vlan", {
    name: "wifi-vlan",
    purpose: "corporate",
    subnet: "10.0.0.1/24",
    vlanId: vlanId,
    dhcpStart: "10.0.0.6",
    dhcpStop: "10.0.0.254",
    dhcpEnabled: true,
});
const wifi = new unifi.Wlan("wifi", {
    name: "myssid",
    passphrase: "12345678",
    security: "wpapsk",
    wpa3Support: true,
    wpa3Transition: true,
    pmfMode: "optional",
    networkId: vlan.id,
    apGroupIds: [_default.then(_default => _default.id)],
    userGroupId: defaultGetGroup.then(defaultGetGroup => defaultGetGroup.id),
});
Copy
import pulumi
import pulumi_unifi as unifi
import pulumiverse_unifi as unifi

config = pulumi.Config()
vlan_id = config.get_float("vlanId")
if vlan_id is None:
    vlan_id = 10
default = unifi.get_ap_group()
default_get_group = unifi.iam.get_group()
vlan = unifi.Network("vlan",
    name="wifi-vlan",
    purpose="corporate",
    subnet="10.0.0.1/24",
    vlan_id=vlan_id,
    dhcp_start="10.0.0.6",
    dhcp_stop="10.0.0.254",
    dhcp_enabled=True)
wifi = unifi.Wlan("wifi",
    name="myssid",
    passphrase="12345678",
    security="wpapsk",
    wpa3_support=True,
    wpa3_transition=True,
    pmf_mode="optional",
    network_id=vlan.id,
    ap_group_ids=[default.id],
    user_group_id=default_get_group.id)
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
	"github.com/pulumiverse/pulumi-unifi/sdk/go/unifi"
	"github.com/pulumiverse/pulumi-unifi/sdk/go/unifi/iam"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		vlanId := float64(10)
		if param := cfg.GetFloat64("vlanId"); param != 0 {
			vlanId = param
		}
		_default, err := unifi.GetApGroup(ctx, nil, nil)
		if err != nil {
			return err
		}
		defaultGetGroup, err := iam.LookupGroup(ctx, nil, nil)
		if err != nil {
			return err
		}
		vlan, err := unifi.NewNetwork(ctx, "vlan", &unifi.NetworkArgs{
			Name:        pulumi.String("wifi-vlan"),
			Purpose:     pulumi.String("corporate"),
			Subnet:      pulumi.String("10.0.0.1/24"),
			VlanId:      pulumi.Float64(vlanId),
			DhcpStart:   pulumi.String("10.0.0.6"),
			DhcpStop:    pulumi.String("10.0.0.254"),
			DhcpEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = unifi.NewWlan(ctx, "wifi", &unifi.WlanArgs{
			Name:           pulumi.String("myssid"),
			Passphrase:     pulumi.String("12345678"),
			Security:       pulumi.String("wpapsk"),
			Wpa3Support:    pulumi.Bool(true),
			Wpa3Transition: pulumi.Bool(true),
			PmfMode:        pulumi.String("optional"),
			NetworkId:      vlan.ID(),
			ApGroupIds: pulumi.StringArray{
				pulumi.String(_default.Id),
			},
			UserGroupId: pulumi.String(defaultGetGroup.Id),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Unifi = Pulumi.Unifi;
using Unifi = Pulumiverse.Unifi;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var vlanId = config.GetDouble("vlanId") ?? 10;
    var @default = Unifi.GetApGroup.Invoke();

    var defaultGetGroup = Unifi.IAM.GetGroup.Invoke();

    var vlan = new Unifi.Network("vlan", new()
    {
        Name = "wifi-vlan",
        Purpose = "corporate",
        Subnet = "10.0.0.1/24",
        VlanId = vlanId,
        DhcpStart = "10.0.0.6",
        DhcpStop = "10.0.0.254",
        DhcpEnabled = true,
    });

    var wifi = new Unifi.Wlan("wifi", new()
    {
        Name = "myssid",
        Passphrase = "12345678",
        Security = "wpapsk",
        Wpa3Support = true,
        Wpa3Transition = true,
        PmfMode = "optional",
        NetworkId = vlan.Id,
        ApGroupIds = new[]
        {
            @default.Apply(@default => @default.Apply(getApGroupResult => getApGroupResult.Id)),
        },
        UserGroupId = defaultGetGroup.Apply(getGroupResult => getGroupResult.Id),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.unifi.UnifiFunctions;
import com.pulumi.unifi.inputs.GetApGroupArgs;
import com.pulumi.unifi.iam.IamFunctions;
import com.pulumi.unifi.iam.inputs.GetGroupArgs;
import com.pulumi.unifi.Network;
import com.pulumi.unifi.NetworkArgs;
import com.pulumi.unifi.Wlan;
import com.pulumi.unifi.WlanArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var vlanId = config.get("vlanId").orElse(10);
        final var default = UnifiFunctions.getApGroup();

        final var defaultGetGroup = IamFunctions.getGroup();

        var vlan = new Network("vlan", NetworkArgs.builder()
            .name("wifi-vlan")
            .purpose("corporate")
            .subnet("10.0.0.1/24")
            .vlanId(vlanId)
            .dhcpStart("10.0.0.6")
            .dhcpStop("10.0.0.254")
            .dhcpEnabled(true)
            .build());

        var wifi = new Wlan("wifi", WlanArgs.builder()
            .name("myssid")
            .passphrase("12345678")
            .security("wpapsk")
            .wpa3Support(true)
            .wpa3Transition(true)
            .pmfMode("optional")
            .networkId(vlan.id())
            .apGroupIds(default_.id())
            .userGroupId(defaultGetGroup.applyValue(getGroupResult -> getGroupResult.id()))
            .build());

    }
}
Copy
configuration:
  vlanId:
    type: number
    default: 10
resources:
  vlan:
    type: unifi:Network
    properties:
      name: wifi-vlan
      purpose: corporate
      subnet: 10.0.0.1/24
      vlanId: ${vlanId}
      dhcpStart: 10.0.0.6
      dhcpStop: 10.0.0.254
      dhcpEnabled: true
  wifi:
    type: unifi:Wlan
    properties:
      name: myssid
      passphrase: '12345678'
      security: wpapsk
      wpa3Support: true
      wpa3Transition: true
      pmfMode: optional
      networkId: ${vlan.id}
      apGroupIds:
        - ${default.id}
      userGroupId: ${defaultGetGroup.id}
variables:
  default:
    fn::invoke:
      Function: unifi:getApGroup
      Arguments: {}
  defaultGetGroup:
    fn::invoke:
      Function: unifi:iam:getGroup
      Arguments: {}
Copy

Create Wlan Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Wlan(name: string, args: WlanArgs, opts?: CustomResourceOptions);
@overload
def Wlan(resource_name: str,
         args: WlanArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def Wlan(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         security: Optional[str] = None,
         user_group_id: Optional[str] = None,
         name: Optional[str] = None,
         mac_filter_enabled: Optional[bool] = None,
         no2ghz_oui: Optional[bool] = None,
         l2_isolation: Optional[bool] = None,
         passphrase: Optional[str] = None,
         mac_filter_lists: Optional[Sequence[str]] = None,
         mac_filter_policy: Optional[str] = None,
         pmf_mode: Optional[str] = None,
         minimum_data_rate5g_kbps: Optional[int] = None,
         multicast_enhance: Optional[bool] = None,
         ap_group_ids: Optional[Sequence[str]] = None,
         network_id: Optional[str] = None,
         is_guest: Optional[bool] = None,
         hide_ssid: Optional[bool] = None,
         minimum_data_rate2g_kbps: Optional[int] = None,
         proxy_arp: Optional[bool] = None,
         radius_profile_id: Optional[str] = None,
         schedules: Optional[Sequence[WlanScheduleArgs]] = None,
         fast_roaming_enabled: Optional[bool] = None,
         site: Optional[str] = None,
         uapsd: Optional[bool] = None,
         bss_transition: Optional[bool] = None,
         wlan_band: Optional[str] = None,
         wpa3_support: Optional[bool] = None,
         wpa3_transition: Optional[bool] = None)
func NewWlan(ctx *Context, name string, args WlanArgs, opts ...ResourceOption) (*Wlan, error)
public Wlan(string name, WlanArgs args, CustomResourceOptions? opts = null)
public Wlan(String name, WlanArgs args)
public Wlan(String name, WlanArgs args, CustomResourceOptions options)

type: unifi:Wlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WlanArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WlanArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WlanArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WlanArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WlanArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var wlanResource = new Unifi.Wlan("wlanResource", new()
{
    Security = "string",
    UserGroupId = "string",
    Name = "string",
    MacFilterEnabled = false,
    No2ghzOui = false,
    L2Isolation = false,
    Passphrase = "string",
    MacFilterLists = new[]
    {
        "string",
    },
    MacFilterPolicy = "string",
    PmfMode = "string",
    MinimumDataRate5gKbps = 0,
    MulticastEnhance = false,
    ApGroupIds = new[]
    {
        "string",
    },
    NetworkId = "string",
    IsGuest = false,
    HideSsid = false,
    MinimumDataRate2gKbps = 0,
    ProxyArp = false,
    RadiusProfileId = "string",
    Schedules = new[]
    {
        new Unifi.Inputs.WlanScheduleArgs
        {
            DayOfWeek = "string",
            Duration = 0,
            StartHour = 0,
            Name = "string",
            StartMinute = 0,
        },
    },
    FastRoamingEnabled = false,
    Site = "string",
    Uapsd = false,
    BssTransition = false,
    WlanBand = "string",
    Wpa3Support = false,
    Wpa3Transition = false,
});
Copy
example, err := unifi.NewWlan(ctx, "wlanResource", &unifi.WlanArgs{
	Security:         pulumi.String("string"),
	UserGroupId:      pulumi.String("string"),
	Name:             pulumi.String("string"),
	MacFilterEnabled: pulumi.Bool(false),
	No2ghzOui:        pulumi.Bool(false),
	L2Isolation:      pulumi.Bool(false),
	Passphrase:       pulumi.String("string"),
	MacFilterLists: pulumi.StringArray{
		pulumi.String("string"),
	},
	MacFilterPolicy:       pulumi.String("string"),
	PmfMode:               pulumi.String("string"),
	MinimumDataRate5gKbps: pulumi.Int(0),
	MulticastEnhance:      pulumi.Bool(false),
	ApGroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	NetworkId:             pulumi.String("string"),
	IsGuest:               pulumi.Bool(false),
	HideSsid:              pulumi.Bool(false),
	MinimumDataRate2gKbps: pulumi.Int(0),
	ProxyArp:              pulumi.Bool(false),
	RadiusProfileId:       pulumi.String("string"),
	Schedules: unifi.WlanScheduleArray{
		&unifi.WlanScheduleArgs{
			DayOfWeek:   pulumi.String("string"),
			Duration:    pulumi.Int(0),
			StartHour:   pulumi.Int(0),
			Name:        pulumi.String("string"),
			StartMinute: pulumi.Int(0),
		},
	},
	FastRoamingEnabled: pulumi.Bool(false),
	Site:               pulumi.String("string"),
	Uapsd:              pulumi.Bool(false),
	BssTransition:      pulumi.Bool(false),
	WlanBand:           pulumi.String("string"),
	Wpa3Support:        pulumi.Bool(false),
	Wpa3Transition:     pulumi.Bool(false),
})
Copy
var wlanResource = new Wlan("wlanResource", WlanArgs.builder()
    .security("string")
    .userGroupId("string")
    .name("string")
    .macFilterEnabled(false)
    .no2ghzOui(false)
    .l2Isolation(false)
    .passphrase("string")
    .macFilterLists("string")
    .macFilterPolicy("string")
    .pmfMode("string")
    .minimumDataRate5gKbps(0)
    .multicastEnhance(false)
    .apGroupIds("string")
    .networkId("string")
    .isGuest(false)
    .hideSsid(false)
    .minimumDataRate2gKbps(0)
    .proxyArp(false)
    .radiusProfileId("string")
    .schedules(WlanScheduleArgs.builder()
        .dayOfWeek("string")
        .duration(0)
        .startHour(0)
        .name("string")
        .startMinute(0)
        .build())
    .fastRoamingEnabled(false)
    .site("string")
    .uapsd(false)
    .bssTransition(false)
    .wlanBand("string")
    .wpa3Support(false)
    .wpa3Transition(false)
    .build());
Copy
wlan_resource = unifi.Wlan("wlanResource",
    security="string",
    user_group_id="string",
    name="string",
    mac_filter_enabled=False,
    no2ghz_oui=False,
    l2_isolation=False,
    passphrase="string",
    mac_filter_lists=["string"],
    mac_filter_policy="string",
    pmf_mode="string",
    minimum_data_rate5g_kbps=0,
    multicast_enhance=False,
    ap_group_ids=["string"],
    network_id="string",
    is_guest=False,
    hide_ssid=False,
    minimum_data_rate2g_kbps=0,
    proxy_arp=False,
    radius_profile_id="string",
    schedules=[{
        "day_of_week": "string",
        "duration": 0,
        "start_hour": 0,
        "name": "string",
        "start_minute": 0,
    }],
    fast_roaming_enabled=False,
    site="string",
    uapsd=False,
    bss_transition=False,
    wlan_band="string",
    wpa3_support=False,
    wpa3_transition=False)
Copy
const wlanResource = new unifi.Wlan("wlanResource", {
    security: "string",
    userGroupId: "string",
    name: "string",
    macFilterEnabled: false,
    no2ghzOui: false,
    l2Isolation: false,
    passphrase: "string",
    macFilterLists: ["string"],
    macFilterPolicy: "string",
    pmfMode: "string",
    minimumDataRate5gKbps: 0,
    multicastEnhance: false,
    apGroupIds: ["string"],
    networkId: "string",
    isGuest: false,
    hideSsid: false,
    minimumDataRate2gKbps: 0,
    proxyArp: false,
    radiusProfileId: "string",
    schedules: [{
        dayOfWeek: "string",
        duration: 0,
        startHour: 0,
        name: "string",
        startMinute: 0,
    }],
    fastRoamingEnabled: false,
    site: "string",
    uapsd: false,
    bssTransition: false,
    wlanBand: "string",
    wpa3Support: false,
    wpa3Transition: false,
});
Copy
type: unifi:Wlan
properties:
    apGroupIds:
        - string
    bssTransition: false
    fastRoamingEnabled: false
    hideSsid: false
    isGuest: false
    l2Isolation: false
    macFilterEnabled: false
    macFilterLists:
        - string
    macFilterPolicy: string
    minimumDataRate2gKbps: 0
    minimumDataRate5gKbps: 0
    multicastEnhance: false
    name: string
    networkId: string
    no2ghzOui: false
    passphrase: string
    pmfMode: string
    proxyArp: false
    radiusProfileId: string
    schedules:
        - dayOfWeek: string
          duration: 0
          name: string
          startHour: 0
          startMinute: 0
    security: string
    site: string
    uapsd: false
    userGroupId: string
    wlanBand: string
    wpa3Support: false
    wpa3Transition: false
Copy

Wlan Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Wlan resource accepts the following input properties:

Security This property is required. string
The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
UserGroupId This property is required. string
ID of the user group to use for this network.
ApGroupIds List<string>
IDs of the AP groups to use for this network.
BssTransition bool
Improves client transitions between APs when they have a weak signal. Defaults to true.
FastRoamingEnabled bool
Enables 802.11r fast roaming. Defaults to false.
HideSsid bool
Indicates whether or not to hide the SSID from broadcast.
IsGuest bool
Indicates that this is a guest WLAN and should use guest behaviors.
L2Isolation bool
Isolates stations on layer 2 (ethernet) level. Defaults to false.
MacFilterEnabled bool
Indicates whether or not the MAC filter is turned of for the network.
MacFilterLists List<string>
List of MAC addresses to filter (only valid if mac_filter_enabled is true).
MacFilterPolicy string
MAC address filter policy (only valid if mac_filter_enabled is true). Defaults to deny.
MinimumDataRate2gKbps int
Set minimum data rate control for 2G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 1000, 2000, 5500, 6000, 9000, 11000, 12000, 18000, 24000, 36000, 48000, and 54000.
MinimumDataRate5gKbps int
Set minimum data rate control for 5G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 6000, 9000, 12000, 18000, 24000, 36000, 48000, and 54000.
MulticastEnhance bool
Indicates whether or not Multicast Enhance is turned of for the network.
Name string
The SSID of the network.
NetworkId string
ID of the network for this SSID
No2ghzOui bool
Connect high performance clients to 5 GHz only. Defaults to true.
Passphrase string
The passphrase for the network, this is only required if security is not set to open.
PmfMode string
Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are required, optional and disabled. Defaults to disabled.
ProxyArp bool
Reduces airtime usage by allowing APs to "proxy" common broadcast frames as unicast. Defaults to false.
RadiusProfileId string
ID of the RADIUS profile to use when security wpaeap. You can query this via the unifi.RadiusProfile data source.
Schedules List<Pulumiverse.Unifi.Inputs.WlanSchedule>
Start and stop schedules for the WLAN
Site Changes to this property will trigger replacement. string
The name of the site to associate the wlan with.
Uapsd bool
Enable Unscheduled Automatic Power Save Delivery. Defaults to false.
WlanBand string
Radio band your WiFi network will use. Defaults to both.
Wpa3Support bool
Enable WPA 3 support (security must be wpapsk and PMF must be turned on).
Wpa3Transition bool
Enable WPA 3 and WPA 2 support (security must be wpapsk and wpa3_support must be true).
Security This property is required. string
The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
UserGroupId This property is required. string
ID of the user group to use for this network.
ApGroupIds []string
IDs of the AP groups to use for this network.
BssTransition bool
Improves client transitions between APs when they have a weak signal. Defaults to true.
FastRoamingEnabled bool
Enables 802.11r fast roaming. Defaults to false.
HideSsid bool
Indicates whether or not to hide the SSID from broadcast.
IsGuest bool
Indicates that this is a guest WLAN and should use guest behaviors.
L2Isolation bool
Isolates stations on layer 2 (ethernet) level. Defaults to false.
MacFilterEnabled bool
Indicates whether or not the MAC filter is turned of for the network.
MacFilterLists []string
List of MAC addresses to filter (only valid if mac_filter_enabled is true).
MacFilterPolicy string
MAC address filter policy (only valid if mac_filter_enabled is true). Defaults to deny.
MinimumDataRate2gKbps int
Set minimum data rate control for 2G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 1000, 2000, 5500, 6000, 9000, 11000, 12000, 18000, 24000, 36000, 48000, and 54000.
MinimumDataRate5gKbps int
Set minimum data rate control for 5G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 6000, 9000, 12000, 18000, 24000, 36000, 48000, and 54000.
MulticastEnhance bool
Indicates whether or not Multicast Enhance is turned of for the network.
Name string
The SSID of the network.
NetworkId string
ID of the network for this SSID
No2ghzOui bool
Connect high performance clients to 5 GHz only. Defaults to true.
Passphrase string
The passphrase for the network, this is only required if security is not set to open.
PmfMode string
Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are required, optional and disabled. Defaults to disabled.
ProxyArp bool
Reduces airtime usage by allowing APs to "proxy" common broadcast frames as unicast. Defaults to false.
RadiusProfileId string
ID of the RADIUS profile to use when security wpaeap. You can query this via the unifi.RadiusProfile data source.
Schedules []WlanScheduleArgs
Start and stop schedules for the WLAN
Site Changes to this property will trigger replacement. string
The name of the site to associate the wlan with.
Uapsd bool
Enable Unscheduled Automatic Power Save Delivery. Defaults to false.
WlanBand string
Radio band your WiFi network will use. Defaults to both.
Wpa3Support bool
Enable WPA 3 support (security must be wpapsk and PMF must be turned on).
Wpa3Transition bool
Enable WPA 3 and WPA 2 support (security must be wpapsk and wpa3_support must be true).
security This property is required. String
The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
userGroupId This property is required. String
ID of the user group to use for this network.
apGroupIds List<String>
IDs of the AP groups to use for this network.
bssTransition Boolean
Improves client transitions between APs when they have a weak signal. Defaults to true.
fastRoamingEnabled Boolean
Enables 802.11r fast roaming. Defaults to false.
hideSsid Boolean
Indicates whether or not to hide the SSID from broadcast.
isGuest Boolean
Indicates that this is a guest WLAN and should use guest behaviors.
l2Isolation Boolean
Isolates stations on layer 2 (ethernet) level. Defaults to false.
macFilterEnabled Boolean
Indicates whether or not the MAC filter is turned of for the network.
macFilterLists List<String>
List of MAC addresses to filter (only valid if mac_filter_enabled is true).
macFilterPolicy String
MAC address filter policy (only valid if mac_filter_enabled is true). Defaults to deny.
minimumDataRate2gKbps Integer
Set minimum data rate control for 2G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 1000, 2000, 5500, 6000, 9000, 11000, 12000, 18000, 24000, 36000, 48000, and 54000.
minimumDataRate5gKbps Integer
Set minimum data rate control for 5G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 6000, 9000, 12000, 18000, 24000, 36000, 48000, and 54000.
multicastEnhance Boolean
Indicates whether or not Multicast Enhance is turned of for the network.
name String
The SSID of the network.
networkId String
ID of the network for this SSID
no2ghzOui Boolean
Connect high performance clients to 5 GHz only. Defaults to true.
passphrase String
The passphrase for the network, this is only required if security is not set to open.
pmfMode String
Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are required, optional and disabled. Defaults to disabled.
proxyArp Boolean
Reduces airtime usage by allowing APs to "proxy" common broadcast frames as unicast. Defaults to false.
radiusProfileId String
ID of the RADIUS profile to use when security wpaeap. You can query this via the unifi.RadiusProfile data source.
schedules List<WlanSchedule>
Start and stop schedules for the WLAN
site Changes to this property will trigger replacement. String
The name of the site to associate the wlan with.
uapsd Boolean
Enable Unscheduled Automatic Power Save Delivery. Defaults to false.
wlanBand String
Radio band your WiFi network will use. Defaults to both.
wpa3Support Boolean
Enable WPA 3 support (security must be wpapsk and PMF must be turned on).
wpa3Transition Boolean
Enable WPA 3 and WPA 2 support (security must be wpapsk and wpa3_support must be true).
security This property is required. string
The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
userGroupId This property is required. string
ID of the user group to use for this network.
apGroupIds string[]
IDs of the AP groups to use for this network.
bssTransition boolean
Improves client transitions between APs when they have a weak signal. Defaults to true.
fastRoamingEnabled boolean
Enables 802.11r fast roaming. Defaults to false.
hideSsid boolean
Indicates whether or not to hide the SSID from broadcast.
isGuest boolean
Indicates that this is a guest WLAN and should use guest behaviors.
l2Isolation boolean
Isolates stations on layer 2 (ethernet) level. Defaults to false.
macFilterEnabled boolean
Indicates whether or not the MAC filter is turned of for the network.
macFilterLists string[]
List of MAC addresses to filter (only valid if mac_filter_enabled is true).
macFilterPolicy string
MAC address filter policy (only valid if mac_filter_enabled is true). Defaults to deny.
minimumDataRate2gKbps number
Set minimum data rate control for 2G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 1000, 2000, 5500, 6000, 9000, 11000, 12000, 18000, 24000, 36000, 48000, and 54000.
minimumDataRate5gKbps number
Set minimum data rate control for 5G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 6000, 9000, 12000, 18000, 24000, 36000, 48000, and 54000.
multicastEnhance boolean
Indicates whether or not Multicast Enhance is turned of for the network.
name string
The SSID of the network.
networkId string
ID of the network for this SSID
no2ghzOui boolean
Connect high performance clients to 5 GHz only. Defaults to true.
passphrase string
The passphrase for the network, this is only required if security is not set to open.
pmfMode string
Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are required, optional and disabled. Defaults to disabled.
proxyArp boolean
Reduces airtime usage by allowing APs to "proxy" common broadcast frames as unicast. Defaults to false.
radiusProfileId string
ID of the RADIUS profile to use when security wpaeap. You can query this via the unifi.RadiusProfile data source.
schedules WlanSchedule[]
Start and stop schedules for the WLAN
site Changes to this property will trigger replacement. string
The name of the site to associate the wlan with.
uapsd boolean
Enable Unscheduled Automatic Power Save Delivery. Defaults to false.
wlanBand string
Radio band your WiFi network will use. Defaults to both.
wpa3Support boolean
Enable WPA 3 support (security must be wpapsk and PMF must be turned on).
wpa3Transition boolean
Enable WPA 3 and WPA 2 support (security must be wpapsk and wpa3_support must be true).
security This property is required. str
The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
user_group_id This property is required. str
ID of the user group to use for this network.
ap_group_ids Sequence[str]
IDs of the AP groups to use for this network.
bss_transition bool
Improves client transitions between APs when they have a weak signal. Defaults to true.
fast_roaming_enabled bool
Enables 802.11r fast roaming. Defaults to false.
hide_ssid bool
Indicates whether or not to hide the SSID from broadcast.
is_guest bool
Indicates that this is a guest WLAN and should use guest behaviors.
l2_isolation bool
Isolates stations on layer 2 (ethernet) level. Defaults to false.
mac_filter_enabled bool
Indicates whether or not the MAC filter is turned of for the network.
mac_filter_lists Sequence[str]
List of MAC addresses to filter (only valid if mac_filter_enabled is true).
mac_filter_policy str
MAC address filter policy (only valid if mac_filter_enabled is true). Defaults to deny.
minimum_data_rate2g_kbps int
Set minimum data rate control for 2G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 1000, 2000, 5500, 6000, 9000, 11000, 12000, 18000, 24000, 36000, 48000, and 54000.
minimum_data_rate5g_kbps int
Set minimum data rate control for 5G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 6000, 9000, 12000, 18000, 24000, 36000, 48000, and 54000.
multicast_enhance bool
Indicates whether or not Multicast Enhance is turned of for the network.
name str
The SSID of the network.
network_id str
ID of the network for this SSID
no2ghz_oui bool
Connect high performance clients to 5 GHz only. Defaults to true.
passphrase str
The passphrase for the network, this is only required if security is not set to open.
pmf_mode str
Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are required, optional and disabled. Defaults to disabled.
proxy_arp bool
Reduces airtime usage by allowing APs to "proxy" common broadcast frames as unicast. Defaults to false.
radius_profile_id str
ID of the RADIUS profile to use when security wpaeap. You can query this via the unifi.RadiusProfile data source.
schedules Sequence[WlanScheduleArgs]
Start and stop schedules for the WLAN
site Changes to this property will trigger replacement. str
The name of the site to associate the wlan with.
uapsd bool
Enable Unscheduled Automatic Power Save Delivery. Defaults to false.
wlan_band str
Radio band your WiFi network will use. Defaults to both.
wpa3_support bool
Enable WPA 3 support (security must be wpapsk and PMF must be turned on).
wpa3_transition bool
Enable WPA 3 and WPA 2 support (security must be wpapsk and wpa3_support must be true).
security This property is required. String
The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
userGroupId This property is required. String
ID of the user group to use for this network.
apGroupIds List<String>
IDs of the AP groups to use for this network.
bssTransition Boolean
Improves client transitions between APs when they have a weak signal. Defaults to true.
fastRoamingEnabled Boolean
Enables 802.11r fast roaming. Defaults to false.
hideSsid Boolean
Indicates whether or not to hide the SSID from broadcast.
isGuest Boolean
Indicates that this is a guest WLAN and should use guest behaviors.
l2Isolation Boolean
Isolates stations on layer 2 (ethernet) level. Defaults to false.
macFilterEnabled Boolean
Indicates whether or not the MAC filter is turned of for the network.
macFilterLists List<String>
List of MAC addresses to filter (only valid if mac_filter_enabled is true).
macFilterPolicy String
MAC address filter policy (only valid if mac_filter_enabled is true). Defaults to deny.
minimumDataRate2gKbps Number
Set minimum data rate control for 2G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 1000, 2000, 5500, 6000, 9000, 11000, 12000, 18000, 24000, 36000, 48000, and 54000.
minimumDataRate5gKbps Number
Set minimum data rate control for 5G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 6000, 9000, 12000, 18000, 24000, 36000, 48000, and 54000.
multicastEnhance Boolean
Indicates whether or not Multicast Enhance is turned of for the network.
name String
The SSID of the network.
networkId String
ID of the network for this SSID
no2ghzOui Boolean
Connect high performance clients to 5 GHz only. Defaults to true.
passphrase String
The passphrase for the network, this is only required if security is not set to open.
pmfMode String
Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are required, optional and disabled. Defaults to disabled.
proxyArp Boolean
Reduces airtime usage by allowing APs to "proxy" common broadcast frames as unicast. Defaults to false.
radiusProfileId String
ID of the RADIUS profile to use when security wpaeap. You can query this via the unifi.RadiusProfile data source.
schedules List<Property Map>
Start and stop schedules for the WLAN
site Changes to this property will trigger replacement. String
The name of the site to associate the wlan with.
uapsd Boolean
Enable Unscheduled Automatic Power Save Delivery. Defaults to false.
wlanBand String
Radio band your WiFi network will use. Defaults to both.
wpa3Support Boolean
Enable WPA 3 support (security must be wpapsk and PMF must be turned on).
wpa3Transition Boolean
Enable WPA 3 and WPA 2 support (security must be wpapsk and wpa3_support must be true).

Outputs

All input properties are implicitly available as output properties. Additionally, the Wlan resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Wlan Resource

Get an existing Wlan resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: WlanState, opts?: CustomResourceOptions): Wlan
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ap_group_ids: Optional[Sequence[str]] = None,
        bss_transition: Optional[bool] = None,
        fast_roaming_enabled: Optional[bool] = None,
        hide_ssid: Optional[bool] = None,
        is_guest: Optional[bool] = None,
        l2_isolation: Optional[bool] = None,
        mac_filter_enabled: Optional[bool] = None,
        mac_filter_lists: Optional[Sequence[str]] = None,
        mac_filter_policy: Optional[str] = None,
        minimum_data_rate2g_kbps: Optional[int] = None,
        minimum_data_rate5g_kbps: Optional[int] = None,
        multicast_enhance: Optional[bool] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        no2ghz_oui: Optional[bool] = None,
        passphrase: Optional[str] = None,
        pmf_mode: Optional[str] = None,
        proxy_arp: Optional[bool] = None,
        radius_profile_id: Optional[str] = None,
        schedules: Optional[Sequence[WlanScheduleArgs]] = None,
        security: Optional[str] = None,
        site: Optional[str] = None,
        uapsd: Optional[bool] = None,
        user_group_id: Optional[str] = None,
        wlan_band: Optional[str] = None,
        wpa3_support: Optional[bool] = None,
        wpa3_transition: Optional[bool] = None) -> Wlan
func GetWlan(ctx *Context, name string, id IDInput, state *WlanState, opts ...ResourceOption) (*Wlan, error)
public static Wlan Get(string name, Input<string> id, WlanState? state, CustomResourceOptions? opts = null)
public static Wlan get(String name, Output<String> id, WlanState state, CustomResourceOptions options)
resources:  _:    type: unifi:Wlan    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApGroupIds List<string>
IDs of the AP groups to use for this network.
BssTransition bool
Improves client transitions between APs when they have a weak signal. Defaults to true.
FastRoamingEnabled bool
Enables 802.11r fast roaming. Defaults to false.
HideSsid bool
Indicates whether or not to hide the SSID from broadcast.
IsGuest bool
Indicates that this is a guest WLAN and should use guest behaviors.
L2Isolation bool
Isolates stations on layer 2 (ethernet) level. Defaults to false.
MacFilterEnabled bool
Indicates whether or not the MAC filter is turned of for the network.
MacFilterLists List<string>
List of MAC addresses to filter (only valid if mac_filter_enabled is true).
MacFilterPolicy string
MAC address filter policy (only valid if mac_filter_enabled is true). Defaults to deny.
MinimumDataRate2gKbps int
Set minimum data rate control for 2G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 1000, 2000, 5500, 6000, 9000, 11000, 12000, 18000, 24000, 36000, 48000, and 54000.
MinimumDataRate5gKbps int
Set minimum data rate control for 5G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 6000, 9000, 12000, 18000, 24000, 36000, 48000, and 54000.
MulticastEnhance bool
Indicates whether or not Multicast Enhance is turned of for the network.
Name string
The SSID of the network.
NetworkId string
ID of the network for this SSID
No2ghzOui bool
Connect high performance clients to 5 GHz only. Defaults to true.
Passphrase string
The passphrase for the network, this is only required if security is not set to open.
PmfMode string
Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are required, optional and disabled. Defaults to disabled.
ProxyArp bool
Reduces airtime usage by allowing APs to "proxy" common broadcast frames as unicast. Defaults to false.
RadiusProfileId string
ID of the RADIUS profile to use when security wpaeap. You can query this via the unifi.RadiusProfile data source.
Schedules List<Pulumiverse.Unifi.Inputs.WlanSchedule>
Start and stop schedules for the WLAN
Security string
The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
Site Changes to this property will trigger replacement. string
The name of the site to associate the wlan with.
Uapsd bool
Enable Unscheduled Automatic Power Save Delivery. Defaults to false.
UserGroupId string
ID of the user group to use for this network.
WlanBand string
Radio band your WiFi network will use. Defaults to both.
Wpa3Support bool
Enable WPA 3 support (security must be wpapsk and PMF must be turned on).
Wpa3Transition bool
Enable WPA 3 and WPA 2 support (security must be wpapsk and wpa3_support must be true).
ApGroupIds []string
IDs of the AP groups to use for this network.
BssTransition bool
Improves client transitions between APs when they have a weak signal. Defaults to true.
FastRoamingEnabled bool
Enables 802.11r fast roaming. Defaults to false.
HideSsid bool
Indicates whether or not to hide the SSID from broadcast.
IsGuest bool
Indicates that this is a guest WLAN and should use guest behaviors.
L2Isolation bool
Isolates stations on layer 2 (ethernet) level. Defaults to false.
MacFilterEnabled bool
Indicates whether or not the MAC filter is turned of for the network.
MacFilterLists []string
List of MAC addresses to filter (only valid if mac_filter_enabled is true).
MacFilterPolicy string
MAC address filter policy (only valid if mac_filter_enabled is true). Defaults to deny.
MinimumDataRate2gKbps int
Set minimum data rate control for 2G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 1000, 2000, 5500, 6000, 9000, 11000, 12000, 18000, 24000, 36000, 48000, and 54000.
MinimumDataRate5gKbps int
Set minimum data rate control for 5G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 6000, 9000, 12000, 18000, 24000, 36000, 48000, and 54000.
MulticastEnhance bool
Indicates whether or not Multicast Enhance is turned of for the network.
Name string
The SSID of the network.
NetworkId string
ID of the network for this SSID
No2ghzOui bool
Connect high performance clients to 5 GHz only. Defaults to true.
Passphrase string
The passphrase for the network, this is only required if security is not set to open.
PmfMode string
Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are required, optional and disabled. Defaults to disabled.
ProxyArp bool
Reduces airtime usage by allowing APs to "proxy" common broadcast frames as unicast. Defaults to false.
RadiusProfileId string
ID of the RADIUS profile to use when security wpaeap. You can query this via the unifi.RadiusProfile data source.
Schedules []WlanScheduleArgs
Start and stop schedules for the WLAN
Security string
The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
Site Changes to this property will trigger replacement. string
The name of the site to associate the wlan with.
Uapsd bool
Enable Unscheduled Automatic Power Save Delivery. Defaults to false.
UserGroupId string
ID of the user group to use for this network.
WlanBand string
Radio band your WiFi network will use. Defaults to both.
Wpa3Support bool
Enable WPA 3 support (security must be wpapsk and PMF must be turned on).
Wpa3Transition bool
Enable WPA 3 and WPA 2 support (security must be wpapsk and wpa3_support must be true).
apGroupIds List<String>
IDs of the AP groups to use for this network.
bssTransition Boolean
Improves client transitions between APs when they have a weak signal. Defaults to true.
fastRoamingEnabled Boolean
Enables 802.11r fast roaming. Defaults to false.
hideSsid Boolean
Indicates whether or not to hide the SSID from broadcast.
isGuest Boolean
Indicates that this is a guest WLAN and should use guest behaviors.
l2Isolation Boolean
Isolates stations on layer 2 (ethernet) level. Defaults to false.
macFilterEnabled Boolean
Indicates whether or not the MAC filter is turned of for the network.
macFilterLists List<String>
List of MAC addresses to filter (only valid if mac_filter_enabled is true).
macFilterPolicy String
MAC address filter policy (only valid if mac_filter_enabled is true). Defaults to deny.
minimumDataRate2gKbps Integer
Set minimum data rate control for 2G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 1000, 2000, 5500, 6000, 9000, 11000, 12000, 18000, 24000, 36000, 48000, and 54000.
minimumDataRate5gKbps Integer
Set minimum data rate control for 5G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 6000, 9000, 12000, 18000, 24000, 36000, 48000, and 54000.
multicastEnhance Boolean
Indicates whether or not Multicast Enhance is turned of for the network.
name String
The SSID of the network.
networkId String
ID of the network for this SSID
no2ghzOui Boolean
Connect high performance clients to 5 GHz only. Defaults to true.
passphrase String
The passphrase for the network, this is only required if security is not set to open.
pmfMode String
Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are required, optional and disabled. Defaults to disabled.
proxyArp Boolean
Reduces airtime usage by allowing APs to "proxy" common broadcast frames as unicast. Defaults to false.
radiusProfileId String
ID of the RADIUS profile to use when security wpaeap. You can query this via the unifi.RadiusProfile data source.
schedules List<WlanSchedule>
Start and stop schedules for the WLAN
security String
The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
site Changes to this property will trigger replacement. String
The name of the site to associate the wlan with.
uapsd Boolean
Enable Unscheduled Automatic Power Save Delivery. Defaults to false.
userGroupId String
ID of the user group to use for this network.
wlanBand String
Radio band your WiFi network will use. Defaults to both.
wpa3Support Boolean
Enable WPA 3 support (security must be wpapsk and PMF must be turned on).
wpa3Transition Boolean
Enable WPA 3 and WPA 2 support (security must be wpapsk and wpa3_support must be true).
apGroupIds string[]
IDs of the AP groups to use for this network.
bssTransition boolean
Improves client transitions between APs when they have a weak signal. Defaults to true.
fastRoamingEnabled boolean
Enables 802.11r fast roaming. Defaults to false.
hideSsid boolean
Indicates whether or not to hide the SSID from broadcast.
isGuest boolean
Indicates that this is a guest WLAN and should use guest behaviors.
l2Isolation boolean
Isolates stations on layer 2 (ethernet) level. Defaults to false.
macFilterEnabled boolean
Indicates whether or not the MAC filter is turned of for the network.
macFilterLists string[]
List of MAC addresses to filter (only valid if mac_filter_enabled is true).
macFilterPolicy string
MAC address filter policy (only valid if mac_filter_enabled is true). Defaults to deny.
minimumDataRate2gKbps number
Set minimum data rate control for 2G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 1000, 2000, 5500, 6000, 9000, 11000, 12000, 18000, 24000, 36000, 48000, and 54000.
minimumDataRate5gKbps number
Set minimum data rate control for 5G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 6000, 9000, 12000, 18000, 24000, 36000, 48000, and 54000.
multicastEnhance boolean
Indicates whether or not Multicast Enhance is turned of for the network.
name string
The SSID of the network.
networkId string
ID of the network for this SSID
no2ghzOui boolean
Connect high performance clients to 5 GHz only. Defaults to true.
passphrase string
The passphrase for the network, this is only required if security is not set to open.
pmfMode string
Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are required, optional and disabled. Defaults to disabled.
proxyArp boolean
Reduces airtime usage by allowing APs to "proxy" common broadcast frames as unicast. Defaults to false.
radiusProfileId string
ID of the RADIUS profile to use when security wpaeap. You can query this via the unifi.RadiusProfile data source.
schedules WlanSchedule[]
Start and stop schedules for the WLAN
security string
The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
site Changes to this property will trigger replacement. string
The name of the site to associate the wlan with.
uapsd boolean
Enable Unscheduled Automatic Power Save Delivery. Defaults to false.
userGroupId string
ID of the user group to use for this network.
wlanBand string
Radio band your WiFi network will use. Defaults to both.
wpa3Support boolean
Enable WPA 3 support (security must be wpapsk and PMF must be turned on).
wpa3Transition boolean
Enable WPA 3 and WPA 2 support (security must be wpapsk and wpa3_support must be true).
ap_group_ids Sequence[str]
IDs of the AP groups to use for this network.
bss_transition bool
Improves client transitions between APs when they have a weak signal. Defaults to true.
fast_roaming_enabled bool
Enables 802.11r fast roaming. Defaults to false.
hide_ssid bool
Indicates whether or not to hide the SSID from broadcast.
is_guest bool
Indicates that this is a guest WLAN and should use guest behaviors.
l2_isolation bool
Isolates stations on layer 2 (ethernet) level. Defaults to false.
mac_filter_enabled bool
Indicates whether or not the MAC filter is turned of for the network.
mac_filter_lists Sequence[str]
List of MAC addresses to filter (only valid if mac_filter_enabled is true).
mac_filter_policy str
MAC address filter policy (only valid if mac_filter_enabled is true). Defaults to deny.
minimum_data_rate2g_kbps int
Set minimum data rate control for 2G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 1000, 2000, 5500, 6000, 9000, 11000, 12000, 18000, 24000, 36000, 48000, and 54000.
minimum_data_rate5g_kbps int
Set minimum data rate control for 5G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 6000, 9000, 12000, 18000, 24000, 36000, 48000, and 54000.
multicast_enhance bool
Indicates whether or not Multicast Enhance is turned of for the network.
name str
The SSID of the network.
network_id str
ID of the network for this SSID
no2ghz_oui bool
Connect high performance clients to 5 GHz only. Defaults to true.
passphrase str
The passphrase for the network, this is only required if security is not set to open.
pmf_mode str
Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are required, optional and disabled. Defaults to disabled.
proxy_arp bool
Reduces airtime usage by allowing APs to "proxy" common broadcast frames as unicast. Defaults to false.
radius_profile_id str
ID of the RADIUS profile to use when security wpaeap. You can query this via the unifi.RadiusProfile data source.
schedules Sequence[WlanScheduleArgs]
Start and stop schedules for the WLAN
security str
The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
site Changes to this property will trigger replacement. str
The name of the site to associate the wlan with.
uapsd bool
Enable Unscheduled Automatic Power Save Delivery. Defaults to false.
user_group_id str
ID of the user group to use for this network.
wlan_band str
Radio band your WiFi network will use. Defaults to both.
wpa3_support bool
Enable WPA 3 support (security must be wpapsk and PMF must be turned on).
wpa3_transition bool
Enable WPA 3 and WPA 2 support (security must be wpapsk and wpa3_support must be true).
apGroupIds List<String>
IDs of the AP groups to use for this network.
bssTransition Boolean
Improves client transitions between APs when they have a weak signal. Defaults to true.
fastRoamingEnabled Boolean
Enables 802.11r fast roaming. Defaults to false.
hideSsid Boolean
Indicates whether or not to hide the SSID from broadcast.
isGuest Boolean
Indicates that this is a guest WLAN and should use guest behaviors.
l2Isolation Boolean
Isolates stations on layer 2 (ethernet) level. Defaults to false.
macFilterEnabled Boolean
Indicates whether or not the MAC filter is turned of for the network.
macFilterLists List<String>
List of MAC addresses to filter (only valid if mac_filter_enabled is true).
macFilterPolicy String
MAC address filter policy (only valid if mac_filter_enabled is true). Defaults to deny.
minimumDataRate2gKbps Number
Set minimum data rate control for 2G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 1000, 2000, 5500, 6000, 9000, 11000, 12000, 18000, 24000, 36000, 48000, and 54000.
minimumDataRate5gKbps Number
Set minimum data rate control for 5G devices, in Kbps. Use 0 to disable minimum data rates. Valid values are: 6000, 9000, 12000, 18000, 24000, 36000, 48000, and 54000.
multicastEnhance Boolean
Indicates whether or not Multicast Enhance is turned of for the network.
name String
The SSID of the network.
networkId String
ID of the network for this SSID
no2ghzOui Boolean
Connect high performance clients to 5 GHz only. Defaults to true.
passphrase String
The passphrase for the network, this is only required if security is not set to open.
pmfMode String
Enable Protected Management Frames. This cannot be disabled if using WPA 3. Valid values are required, optional and disabled. Defaults to disabled.
proxyArp Boolean
Reduces airtime usage by allowing APs to "proxy" common broadcast frames as unicast. Defaults to false.
radiusProfileId String
ID of the RADIUS profile to use when security wpaeap. You can query this via the unifi.RadiusProfile data source.
schedules List<Property Map>
Start and stop schedules for the WLAN
security String
The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
site Changes to this property will trigger replacement. String
The name of the site to associate the wlan with.
uapsd Boolean
Enable Unscheduled Automatic Power Save Delivery. Defaults to false.
userGroupId String
ID of the user group to use for this network.
wlanBand String
Radio band your WiFi network will use. Defaults to both.
wpa3Support Boolean
Enable WPA 3 support (security must be wpapsk and PMF must be turned on).
wpa3Transition Boolean
Enable WPA 3 and WPA 2 support (security must be wpapsk and wpa3_support must be true).

Supporting Types

WlanSchedule
, WlanScheduleArgs

DayOfWeek This property is required. string
Day of week for the block. Valid values are sun, mon, tue, wed, thu, fri, sat.
Duration This property is required. int
Length of the block in minutes.
StartHour This property is required. int
Start hour for the block (0-23).
Name string
Name of the block.
StartMinute int
Start minute for the block (0-59). Defaults to 0.
DayOfWeek This property is required. string
Day of week for the block. Valid values are sun, mon, tue, wed, thu, fri, sat.
Duration This property is required. int
Length of the block in minutes.
StartHour This property is required. int
Start hour for the block (0-23).
Name string
Name of the block.
StartMinute int
Start minute for the block (0-59). Defaults to 0.
dayOfWeek This property is required. String
Day of week for the block. Valid values are sun, mon, tue, wed, thu, fri, sat.
duration This property is required. Integer
Length of the block in minutes.
startHour This property is required. Integer
Start hour for the block (0-23).
name String
Name of the block.
startMinute Integer
Start minute for the block (0-59). Defaults to 0.
dayOfWeek This property is required. string
Day of week for the block. Valid values are sun, mon, tue, wed, thu, fri, sat.
duration This property is required. number
Length of the block in minutes.
startHour This property is required. number
Start hour for the block (0-23).
name string
Name of the block.
startMinute number
Start minute for the block (0-59). Defaults to 0.
day_of_week This property is required. str
Day of week for the block. Valid values are sun, mon, tue, wed, thu, fri, sat.
duration This property is required. int
Length of the block in minutes.
start_hour This property is required. int
Start hour for the block (0-23).
name str
Name of the block.
start_minute int
Start minute for the block (0-59). Defaults to 0.
dayOfWeek This property is required. String
Day of week for the block. Valid values are sun, mon, tue, wed, thu, fri, sat.
duration This property is required. Number
Length of the block in minutes.
startHour This property is required. Number
Start hour for the block (0-23).
name String
Name of the block.
startMinute Number
Start minute for the block (0-59). Defaults to 0.

Import

import from provider configured site

$ pulumi import unifi:index/wlan:Wlan mywlan 5dc28e5e9106d105bdc87217
Copy

import from another site

$ pulumi import unifi:index/wlan:Wlan mywlan bfa2l6i7:5dc28e5e9106d105bdc87217
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
unifi pulumiverse/pulumi-unifi
License
Apache-2.0
Notes
This Pulumi package is based on the unifi Terraform Provider.
Unifi v0.1.1 published on Wednesday, Jan 1, 2025 by Pulumiverse
pulumiverse/pulumi-unifi