netbox 4.0.0, Jun 12 25

netbox 4.0.0 published on Thursday, Jun 12, 2025 by e-breuninger

netbox.AvailableVlan

Explore with Pulumi AI

netbox 4.0.0 published on Thursday, Jun 12, 2025 by e-breuninger

A VLAN represents an isolated Layer 2 domain identified by a numeric ID (1–4094). VLANs may be assigned to specific sites or marked as global. Optionally, they can be organized within VLAN groups to define scope and enforce uniqueness.
Each VLAN can also be assigned an operational status and a functional role. Statuses are hard-coded in NetBox and include the following:
Active
Reserved
Deprecated

This resource will retrieve the next available VLAN ID from a given VLAN group (specified by ID).

Create AvailableVlan Resource

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

Constructor syntax

new AvailableVlan(name: string, args?: AvailableVlanArgs, opts?: CustomResourceOptions);

@overload
def AvailableVlan(resource_name: str,
                  args: Optional[AvailableVlanArgs] = None,
                  opts: Optional[ResourceOptions] = None)

@overload
def AvailableVlan(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  available_vlan_id: Optional[str] = None,
                  description: Optional[str] = None,
                  group_id: Optional[float] = None,
                  name: Optional[str] = None,
                  role_id: Optional[float] = None,
                  site_id: Optional[float] = None,
                  status: Optional[str] = None,
                  tags: Optional[Sequence[str]] = None,
                  tenant_id: Optional[float] = None)

func NewAvailableVlan(ctx *Context, name string, args *AvailableVlanArgs, opts ...ResourceOption) (*AvailableVlan, error)

public AvailableVlan(string name, AvailableVlanArgs? args = null, CustomResourceOptions? opts = null)

public AvailableVlan(String name, AvailableVlanArgs args)
public AvailableVlan(String name, AvailableVlanArgs args, CustomResourceOptions options)

type: netbox:AvailableVlan
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 AvailableVlanArgs: 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 AvailableVlanArgs: 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 AvailableVlanArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AvailableVlanArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AvailableVlanArgs: 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 availableVlanResource = new Netbox.AvailableVlan("availableVlanResource", new()
{
    AvailableVlanId = "string",
    Description = "string",
    GroupId = 0,
    Name = "string",
    RoleId = 0,
    SiteId = 0,
    Status = "string",
    Tags = new[]
    {
        "string",
    },
    TenantId = 0,
});

example, err := netbox.NewAvailableVlan(ctx, "availableVlanResource", &netbox.AvailableVlanArgs{
	AvailableVlanId: pulumi.String("string"),
	Description:     pulumi.String("string"),
	GroupId:         pulumi.Float64(0),
	Name:            pulumi.String("string"),
	RoleId:          pulumi.Float64(0),
	SiteId:          pulumi.Float64(0),
	Status:          pulumi.String("string"),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TenantId: pulumi.Float64(0),
})

var availableVlanResource = new AvailableVlan("availableVlanResource", AvailableVlanArgs.builder()
    .availableVlanId("string")
    .description("string")
    .groupId(0.0)
    .name("string")
    .roleId(0.0)
    .siteId(0.0)
    .status("string")
    .tags("string")
    .tenantId(0.0)
    .build());

available_vlan_resource = netbox.AvailableVlan("availableVlanResource",
    available_vlan_id="string",
    description="string",
    group_id=0,
    name="string",
    role_id=0,
    site_id=0,
    status="string",
    tags=["string"],
    tenant_id=0)

const availableVlanResource = new netbox.AvailableVlan("availableVlanResource", {
    availableVlanId: "string",
    description: "string",
    groupId: 0,
    name: "string",
    roleId: 0,
    siteId: 0,
    status: "string",
    tags: ["string"],
    tenantId: 0,
});

type: netbox:AvailableVlan
properties:
    availableVlanId: string
    description: string
    groupId: 0
    name: string
    roleId: 0
    siteId: 0
    status: string
    tags:
        - string
    tenantId: 0

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

AvailableVlanId string: The ID of this resource.
Description string
GroupId double
Name string
RoleId double
SiteId double
Status string
Tags List<string>
TenantId double

AvailableVlanId string: The ID of this resource.
Description string
GroupId float64
Name string
RoleId float64
SiteId float64
Status string
Tags []string
TenantId float64

availableVlanId String: The ID of this resource.
description String
groupId Double
name String
roleId Double
siteId Double
status String
tags List<String>
tenantId Double

availableVlanId string: The ID of this resource.
description string
groupId number
name string
roleId number
siteId number
status string
tags string[]
tenantId number

available_vlan_id str: The ID of this resource.
description str
group_id float
name str
role_id float
site_id float
status str
tags Sequence[str]
tenant_id float

availableVlanId String: The ID of this resource.
description String
groupId Number
name String
roleId Number
siteId Number
status String
tags List<String>
tenantId Number

Outputs

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

Comments string
Id string: The provider-assigned unique ID for this managed resource.
TagsAlls List<string>
Vid double

Comments string
Id string: The provider-assigned unique ID for this managed resource.
TagsAlls []string
Vid float64

comments String
id String: The provider-assigned unique ID for this managed resource.
tagsAlls List<String>
vid Double

comments string
id string: The provider-assigned unique ID for this managed resource.
tagsAlls string[]
vid number

comments str
id str: The provider-assigned unique ID for this managed resource.
tags_alls Sequence[str]
vid float

comments String
id String: The provider-assigned unique ID for this managed resource.
tagsAlls List<String>
vid Number

Look up Existing AvailableVlan Resource

Get an existing AvailableVlan 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?: AvailableVlanState, opts?: CustomResourceOptions): AvailableVlan

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        available_vlan_id: Optional[str] = None,
        comments: Optional[str] = None,
        description: Optional[str] = None,
        group_id: Optional[float] = None,
        name: Optional[str] = None,
        role_id: Optional[float] = None,
        site_id: Optional[float] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        tags_alls: Optional[Sequence[str]] = None,
        tenant_id: Optional[float] = None,
        vid: Optional[float] = None) -> AvailableVlan

func GetAvailableVlan(ctx *Context, name string, id IDInput, state *AvailableVlanState, opts ...ResourceOption) (*AvailableVlan, error)

public static AvailableVlan Get(string name, Input<string> id, AvailableVlanState? state, CustomResourceOptions? opts = null)

public static AvailableVlan get(String name, Output<String> id, AvailableVlanState state, CustomResourceOptions options)

resources:  _:    type: netbox:AvailableVlan    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:

AvailableVlanId string: The ID of this resource.
Comments string
Description string
GroupId double
Name string
RoleId double
SiteId double
Status string
Tags List<string>
TagsAlls List<string>
TenantId double
Vid double

AvailableVlanId string: The ID of this resource.
Comments string
Description string
GroupId float64
Name string
RoleId float64
SiteId float64
Status string
Tags []string
TagsAlls []string
TenantId float64
Vid float64

availableVlanId String: The ID of this resource.
comments String
description String
groupId Double
name String
roleId Double
siteId Double
status String
tags List<String>
tagsAlls List<String>
tenantId Double
vid Double

availableVlanId string: The ID of this resource.
comments string
description string
groupId number
name string
roleId number
siteId number
status string
tags string[]
tagsAlls string[]
tenantId number
vid number

available_vlan_id str: The ID of this resource.
comments str
description str
group_id float
name str
role_id float
site_id float
status str
tags Sequence[str]
tags_alls Sequence[str]
tenant_id float
vid float

availableVlanId String: The ID of this resource.
comments String
description String
groupId Number
name String
roleId Number
siteId Number
status String
tags List<String>
tagsAlls List<String>
tenantId Number
vid Number

Package Details

Repository: netbox e-breuninger/terraform-provider-netbox
License
Notes: This Pulumi package is based on the netbox Terraform Provider.

netbox 4.0.0 published on Thursday, Jun 12, 2025 by e-breuninger

e-breuninger/terraform-provider-netbox

netbox.AvailableVlan

On this page

On this page

Create AvailableVlan Resource

Constructor syntax

Parameters

Constructor example

AvailableVlan Resource Properties

Inputs

Outputs

Look up Existing AvailableVlan Resource

Package Details

On this page

On this page