1. Packages
  2. Packages
  3. Netbox Provider
  4. API Docs
  5. WirelessLan
Viewing docs for netbox 5.3.0
published on Thursday, Apr 9, 2026 by e-breuninger
Schema (JSON)
e-breuninger/terraform-provider-netbox

netbox.WirelessLan

Viewing docs for netbox 5.3.0
published on Thursday, Apr 9, 2026 by e-breuninger
Schema (JSON)
e-breuninger/terraform-provider-netbox

    A Wireless LAN represents a broadcast wireless network, identified by its SSID and optional authentication settings.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as netbox from "@pulumi/netbox";

const guest = new netbox.WirelessLan("guest", {
    ssid: "guest-wifi",
    status: "active",
});

    import pulumi
import pulumi_netbox as netbox

guest = netbox.WirelessLan("guest",
    ssid="guest-wifi",
    status="active")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v5/netbox"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netbox.NewWirelessLan(ctx, "guest", &netbox.WirelessLanArgs{
			Ssid:   pulumi.String("guest-wifi"),
			Status: pulumi.String("active"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;

return await Deployment.RunAsync(() => 
{
    var guest = new Netbox.WirelessLan("guest", new()
    {
        Ssid = "guest-wifi",
        Status = "active",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.WirelessLan;
import com.pulumi.netbox.WirelessLanArgs;
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) {
        var guest = new WirelessLan("guest", WirelessLanArgs.builder()
            .ssid("guest-wifi")
            .status("active")
            .build());

    }
}

    resources:
  guest:
    type: netbox:WirelessLan
    properties:
      ssid: guest-wifi
      status: active

    Create WirelessLan Resource

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

    Constructor syntax

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

@overload
def WirelessLan(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                ssid: Optional[str] = None,
                group_id: Optional[float] = None,
                auth_type: Optional[str] = None,
                comments: Optional[str] = None,
                custom_fields: Optional[Mapping[str, str]] = None,
                description: Optional[str] = None,
                auth_cipher: Optional[str] = None,
                auth_psk: Optional[str] = None,
                status: Optional[str] = None,
                tags: Optional[Sequence[str]] = None,
                tenant_id: Optional[float] = None,
                vlan_id: Optional[float] = None,
                wireless_lan_id: Optional[str] = None)
    func NewWirelessLan(ctx *Context, name string, args WirelessLanArgs, opts ...ResourceOption) (*WirelessLan, error)
    public WirelessLan(string name, WirelessLanArgs args, CustomResourceOptions? opts = null)
    public WirelessLan(String name, WirelessLanArgs args)
public WirelessLan(String name, WirelessLanArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args WirelessLanArgs
    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 WirelessLanArgs
    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 WirelessLanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WirelessLanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WirelessLanArgs
    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 wirelessLanResource = new Netbox.WirelessLan("wirelessLanResource", new()
{
    Ssid = "string",
    GroupId = 0,
    AuthType = "string",
    Comments = "string",
    CustomFields = 
    {
        { "string", "string" },
    },
    Description = "string",
    AuthCipher = "string",
    AuthPsk = "string",
    Status = "string",
    Tags = new[]
    {
        "string",
    },
    TenantId = 0,
    VlanId = 0,
    WirelessLanId = "string",
});

    example, err := netbox.NewWirelessLan(ctx, "wirelessLanResource", &netbox.WirelessLanArgs{
	Ssid:     pulumi.String("string"),
	GroupId:  pulumi.Float64(0),
	AuthType: pulumi.String("string"),
	Comments: pulumi.String("string"),
	CustomFields: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	AuthCipher:  pulumi.String("string"),
	AuthPsk:     pulumi.String("string"),
	Status:      pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TenantId:      pulumi.Float64(0),
	VlanId:        pulumi.Float64(0),
	WirelessLanId: pulumi.String("string"),
})

    var wirelessLanResource = new WirelessLan("wirelessLanResource", WirelessLanArgs.builder()
    .ssid("string")
    .groupId(0.0)
    .authType("string")
    .comments("string")
    .customFields(Map.of("string", "string"))
    .description("string")
    .authCipher("string")
    .authPsk("string")
    .status("string")
    .tags("string")
    .tenantId(0.0)
    .vlanId(0.0)
    .wirelessLanId("string")
    .build());

    wireless_lan_resource = netbox.WirelessLan("wirelessLanResource",
    ssid="string",
    group_id=float(0),
    auth_type="string",
    comments="string",
    custom_fields={
        "string": "string",
    },
    description="string",
    auth_cipher="string",
    auth_psk="string",
    status="string",
    tags=["string"],
    tenant_id=float(0),
    vlan_id=float(0),
    wireless_lan_id="string")

    const wirelessLanResource = new netbox.WirelessLan("wirelessLanResource", {
    ssid: "string",
    groupId: 0,
    authType: "string",
    comments: "string",
    customFields: {
        string: "string",
    },
    description: "string",
    authCipher: "string",
    authPsk: "string",
    status: "string",
    tags: ["string"],
    tenantId: 0,
    vlanId: 0,
    wirelessLanId: "string",
});

    type: netbox:WirelessLan
properties:
    authCipher: string
    authPsk: string
    authType: string
    comments: string
    customFields:
        string: string
    description: string
    groupId: 0
    ssid: string
    status: string
    tags:
        - string
    tenantId: 0
    vlanId: 0
    wirelessLanId: string

    WirelessLan 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 WirelessLan resource accepts the following input properties:

    Ssid string
    AuthCipher string
    Valid values are auto, tkip and aes.
    AuthPsk string
    AuthType string
    Valid values are open, wep, wpa-personal and wpa-enterprise.
    Comments string
    CustomFields Dictionary<string, string>
    Description string
    GroupId double
    Status string
    Valid values are active, reserved, disabled and deprecated. Defaults to active.
    Tags List<string>
    TenantId double
    VlanId double
    WirelessLanId string
    The ID of this resource.
    Ssid string
    AuthCipher string
    Valid values are auto, tkip and aes.
    AuthPsk string
    AuthType string
    Valid values are open, wep, wpa-personal and wpa-enterprise.
    Comments string
    CustomFields map[string]string
    Description string
    GroupId float64
    Status string
    Valid values are active, reserved, disabled and deprecated. Defaults to active.
    Tags []string
    TenantId float64
    VlanId float64
    WirelessLanId string
    The ID of this resource.
    ssid String
    authCipher String
    Valid values are auto, tkip and aes.
    authPsk String
    authType String
    Valid values are open, wep, wpa-personal and wpa-enterprise.
    comments String
    customFields Map<String,String>
    description String
    groupId Double
    status String
    Valid values are active, reserved, disabled and deprecated. Defaults to active.
    tags List<String>
    tenantId Double
    vlanId Double
    wirelessLanId String
    The ID of this resource.
    ssid string
    authCipher string
    Valid values are auto, tkip and aes.
    authPsk string
    authType string
    Valid values are open, wep, wpa-personal and wpa-enterprise.
    comments string
    customFields {[key: string]: string}
    description string
    groupId number
    status string
    Valid values are active, reserved, disabled and deprecated. Defaults to active.
    tags string[]
    tenantId number
    vlanId number
    wirelessLanId string
    The ID of this resource.
    ssid str
    auth_cipher str
    Valid values are auto, tkip and aes.
    auth_psk str
    auth_type str
    Valid values are open, wep, wpa-personal and wpa-enterprise.
    comments str
    custom_fields Mapping[str, str]
    description str
    group_id float
    status str
    Valid values are active, reserved, disabled and deprecated. Defaults to active.
    tags Sequence[str]
    tenant_id float
    vlan_id float
    wireless_lan_id str
    The ID of this resource.
    ssid String
    authCipher String
    Valid values are auto, tkip and aes.
    authPsk String
    authType String
    Valid values are open, wep, wpa-personal and wpa-enterprise.
    comments String
    customFields Map<String>
    description String
    groupId Number
    status String
    Valid values are active, reserved, disabled and deprecated. Defaults to active.
    tags List<String>
    tenantId Number
    vlanId Number
    wirelessLanId String
    The ID of this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAlls List<string>
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAlls []string
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAlls List<String>
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAlls string[]
    id str
    The provider-assigned unique ID for this managed resource.
    tags_alls Sequence[str]
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAlls List<String>

    Look up Existing WirelessLan Resource

    Get an existing WirelessLan 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?: WirelessLanState, opts?: CustomResourceOptions): WirelessLan
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_cipher: Optional[str] = None,
        auth_psk: Optional[str] = None,
        auth_type: Optional[str] = None,
        comments: Optional[str] = None,
        custom_fields: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        group_id: Optional[float] = None,
        ssid: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        tags_alls: Optional[Sequence[str]] = None,
        tenant_id: Optional[float] = None,
        vlan_id: Optional[float] = None,
        wireless_lan_id: Optional[str] = None) -> WirelessLan
    func GetWirelessLan(ctx *Context, name string, id IDInput, state *WirelessLanState, opts ...ResourceOption) (*WirelessLan, error)
    public static WirelessLan Get(string name, Input<string> id, WirelessLanState? state, CustomResourceOptions? opts = null)
    public static WirelessLan get(String name, Output<String> id, WirelessLanState state, CustomResourceOptions options)
    resources:  _:    type: netbox:WirelessLan    get:      id: ${id}
    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:
    AuthCipher string
    Valid values are auto, tkip and aes.
    AuthPsk string
    AuthType string
    Valid values are open, wep, wpa-personal and wpa-enterprise.
    Comments string
    CustomFields Dictionary<string, string>
    Description string
    GroupId double
    Ssid string
    Status string
    Valid values are active, reserved, disabled and deprecated. Defaults to active.
    Tags List<string>
    TagsAlls List<string>
    TenantId double
    VlanId double
    WirelessLanId string
    The ID of this resource.
    AuthCipher string
    Valid values are auto, tkip and aes.
    AuthPsk string
    AuthType string
    Valid values are open, wep, wpa-personal and wpa-enterprise.
    Comments string
    CustomFields map[string]string
    Description string
    GroupId float64
    Ssid string
    Status string
    Valid values are active, reserved, disabled and deprecated. Defaults to active.
    Tags []string
    TagsAlls []string
    TenantId float64
    VlanId float64
    WirelessLanId string
    The ID of this resource.
    authCipher String
    Valid values are auto, tkip and aes.
    authPsk String
    authType String
    Valid values are open, wep, wpa-personal and wpa-enterprise.
    comments String
    customFields Map<String,String>
    description String
    groupId Double
    ssid String
    status String
    Valid values are active, reserved, disabled and deprecated. Defaults to active.
    tags List<String>
    tagsAlls List<String>
    tenantId Double
    vlanId Double
    wirelessLanId String
    The ID of this resource.
    authCipher string
    Valid values are auto, tkip and aes.
    authPsk string
    authType string
    Valid values are open, wep, wpa-personal and wpa-enterprise.
    comments string
    customFields {[key: string]: string}
    description string
    groupId number
    ssid string
    status string
    Valid values are active, reserved, disabled and deprecated. Defaults to active.
    tags string[]
    tagsAlls string[]
    tenantId number
    vlanId number
    wirelessLanId string
    The ID of this resource.
    auth_cipher str
    Valid values are auto, tkip and aes.
    auth_psk str
    auth_type str
    Valid values are open, wep, wpa-personal and wpa-enterprise.
    comments str
    custom_fields Mapping[str, str]
    description str
    group_id float
    ssid str
    status str
    Valid values are active, reserved, disabled and deprecated. Defaults to active.
    tags Sequence[str]
    tags_alls Sequence[str]
    tenant_id float
    vlan_id float
    wireless_lan_id str
    The ID of this resource.
    authCipher String
    Valid values are auto, tkip and aes.
    authPsk String
    authType String
    Valid values are open, wep, wpa-personal and wpa-enterprise.
    comments String
    customFields Map<String>
    description String
    groupId Number
    ssid String
    status String
    Valid values are active, reserved, disabled and deprecated. Defaults to active.
    tags List<String>
    tagsAlls List<String>
    tenantId Number
    vlanId Number
    wirelessLanId String
    The ID of this resource.

    Package Details

    Repository
    netbox e-breuninger/terraform-provider-netbox
    License
    Notes
    This Pulumi package is based on the netbox Terraform Provider.
    Viewing docs for netbox 5.3.0
    published on Thursday, Apr 9, 2026 by e-breuninger
    Schema (JSON)
    e-breuninger/terraform-provider-netbox
      Try Pulumi Cloud free. Your team will thank you.