1. Packages
  2. Unifi
  3. API Docs
  4. Wlan
Unifi v0.0.3 published on Monday, Dec 5, 2022 by Pulumiverse

unifi.Wlan

Explore with Pulumi AI

unifi logo
Unifi v0.0.3 published on Monday, Dec 5, 2022 by Pulumiverse

    unifi.Wlan manages a WiFi network / SSID.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Unifi = Pulumi.Unifi;
    using Unifi = Pulumiverse.Unifi;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var vlanId = config.GetNumber("vlanId") ?? 10;
        var defaultApGroup = Unifi.GetApGroup.Invoke();
    
        var defaultGroup = Unifi.IAM.GetGroup.Invoke();
    
        var vlan = new Unifi.Network("vlan", new()
        {
            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()
        {
            Passphrase = "12345678",
            Security = "wpapsk",
            Wpa3Support = true,
            Wpa3Transition = true,
            PmfMode = "optional",
            NetworkId = vlan.Id,
            ApGroupIds = new[]
            {
                defaultApGroup.Apply(getApGroupResult => getApGroupResult.Id),
            },
            UserGroupId = defaultGroup.Apply(getGroupResult => getGroupResult.Id),
        });
    
    });
    
    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
    		}
    		defaultApGroup, err := unifi.GetApGroup(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		defaultGroup, err := iam.LookupGroup(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		vlan, err := unifi.NewNetwork(ctx, "vlan", &unifi.NetworkArgs{
    			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{
    			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(defaultApGroup.Id),
    			},
    			UserGroupId: pulumi.String(defaultGroup.Id),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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 defaultApGroup = UnifiFunctions.getApGroup();
    
            final var defaultGroup = IamFunctions.getGroup();
    
            var vlan = new Network("vlan", NetworkArgs.builder()        
                .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()        
                .passphrase("12345678")
                .security("wpapsk")
                .wpa3Support(true)
                .wpa3Transition(true)
                .pmfMode("optional")
                .networkId(vlan.id())
                .apGroupIds(defaultApGroup.applyValue(getApGroupResult -> getApGroupResult.id()))
                .userGroupId(defaultGroup.applyValue(getGroupResult -> getGroupResult.id()))
                .build());
    
        }
    }
    
    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_ap_group = unifi.get_ap_group()
    default_group = unifi.iam.get_group()
    vlan = unifi.Network("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",
        passphrase="12345678",
        security="wpapsk",
        wpa3_support=True,
        wpa3_transition=True,
        pmf_mode="optional",
        network_id=vlan.id,
        ap_group_ids=[default_ap_group.id],
        user_group_id=default_group.id)
    
    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 defaultApGroup = unifi.getApGroup({});
    const defaultGroup = unifi.iam.getGroup({});
    const vlan = new unifi.Network("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", {
        passphrase: "12345678",
        security: "wpapsk",
        wpa3Support: true,
        wpa3Transition: true,
        pmfMode: "optional",
        networkId: vlan.id,
        apGroupIds: [defaultApGroup.then(defaultApGroup => defaultApGroup.id)],
        userGroupId: defaultGroup.then(defaultGroup => defaultGroup.id),
    });
    
    configuration:
      vlanId:
        type: number
        default: 10
    resources:
      vlan:
        type: unifi:Network
        properties:
          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:
          passphrase: '12345678'
          security: wpapsk
          # enable WPA2/WPA3 support
          wpa3Support: true
          wpa3Transition: true
          pmfMode: optional
          networkId: ${vlan.id}
          apGroupIds:
            - ${defaultApGroup.id}
          userGroupId: ${defaultGroup.id}
    variables:
      defaultApGroup:
        fn::invoke:
          Function: unifi:getApGroup
          Arguments: {}
      defaultGroup:
        fn::invoke:
          Function: unifi:iam:getGroup
          Arguments: {}
    

    Create Wlan Resource

    new Wlan(name: string, args: WlanArgs, opts?: CustomResourceOptions);
    @overload
    def Wlan(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             ap_group_ids: Optional[Sequence[str]] = 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,
             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)
    @overload
    def Wlan(resource_name: str,
             args: WlanArgs,
             opts: Optional[ResourceOptions] = 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.
    
    
    name string
    The unique name of the resource.
    args WlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args WlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WlanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    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

    The Wlan resource accepts the following input properties:

    Security string
    The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
    UserGroupId string
    ID of the user group to use for this network.
    ApGroupIds List<string>
    IDs of the AP groups to use for this network.
    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.
    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 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.
    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 string
    The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
    UserGroupId string
    ID of the user group to use for this network.
    ApGroupIds []string
    IDs of the AP groups to use for this network.
    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.
    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 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.
    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 String
    The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
    userGroupId String
    ID of the user group to use for this network.
    apGroupIds List<String>
    IDs of the AP groups to use for this network.
    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.
    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 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.
    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 string
    The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
    userGroupId string
    ID of the user group to use for this network.
    apGroupIds string[]
    IDs of the AP groups to use for this network.
    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.
    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 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.
    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 str
    The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
    user_group_id 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.
    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.
    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 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.
    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 String
    The type of WiFi security for this network. Valid values are: wpapsk, wpaeap, and open.
    userGroupId String
    ID of the user group to use for this network.
    apGroupIds List<String>
    IDs of the AP groups to use for this network.
    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.
    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 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.
    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,
            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,
            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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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.
    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.
    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 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.
    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.
    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.
    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 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.
    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.
    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.
    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 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.
    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.
    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.
    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 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.
    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.
    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.
    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 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.
    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.
    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.
    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 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.
    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 string
    Day of week for the block. Valid values are sun, mon, tue, wed, thu, fri, sat.
    Duration int
    Length of the block in minutes.
    StartHour 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 string
    Day of week for the block. Valid values are sun, mon, tue, wed, thu, fri, sat.
    Duration int
    Length of the block in minutes.
    StartHour 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 String
    Day of week for the block. Valid values are sun, mon, tue, wed, thu, fri, sat.
    duration Integer
    Length of the block in minutes.
    startHour 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 string
    Day of week for the block. Valid values are sun, mon, tue, wed, thu, fri, sat.
    duration number
    Length of the block in minutes.
    startHour 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 str
    Day of week for the block. Valid values are sun, mon, tue, wed, thu, fri, sat.
    duration int
    Length of the block in minutes.
    start_hour 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 String
    Day of week for the block. Valid values are sun, mon, tue, wed, thu, fri, sat.
    duration Number
    Length of the block in minutes.
    startHour 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
    

    import from another site

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

    Package Details

    Repository
    unifi pulumiverse/pulumi-unifi
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the unifi Terraform Provider.
    unifi logo
    Unifi v0.0.3 published on Monday, Dec 5, 2022 by Pulumiverse