Docs Packages
  1. Packages
  2. F5 BIG-IP
  3. API Docs
  4. net
  5. Vlan
f5 BIG-IP v3.17.0 published on Thursday, Mar 28, 2024 by Pulumi
pulumi/pulumi-f5bigip

f5bigip.net.Vlan

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.17.0 published on Thursday, Mar 28, 2024 by Pulumi
pulumi/pulumi-f5bigip

    f5bigip.net.Vlan Manages a vlan configuration

    For resources should be named with their “full path”. The full path is the combination of the partition + name of the resource. For example /Common/my-pool.

    Example Usage

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

const vlan1 = new f5bigip.net.Vlan("vlan1", {
    interfaces: [{
        tagged: false,
        vlanport: "1.2",
    }],
    name: "/Common/Internal",
    tag: 101,
});

    import pulumi
import pulumi_f5bigip as f5bigip

vlan1 = f5bigip.net.Vlan("vlan1",
    interfaces=[f5bigip.net.VlanInterfaceArgs(
        tagged=False,
        vlanport="1.2",
    )],
    name="/Common/Internal",
    tag=101)

    package main

import (
	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/net"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := net.NewVlan(ctx, "vlan1", &net.VlanArgs{
			Interfaces: net.VlanInterfaceArray{
				&net.VlanInterfaceArgs{
					Tagged:   pulumi.Bool(false),
					Vlanport: pulumi.String("1.2"),
				},
			},
			Name: pulumi.String("/Common/Internal"),
			Tag:  pulumi.Int(101),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var vlan1 = new F5BigIP.Net.Vlan("vlan1", new()
    {
        Interfaces = new[]
        {
            new F5BigIP.Net.Inputs.VlanInterfaceArgs
            {
                Tagged = false,
                Vlanport = "1.2",
            },
        },
        Name = "/Common/Internal",
        Tag = 101,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.f5bigip.net.Vlan;
import com.pulumi.f5bigip.net.VlanArgs;
import com.pulumi.f5bigip.net.inputs.VlanInterfaceArgs;
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 vlan1 = new Vlan("vlan1", VlanArgs.builder()        
            .interfaces(VlanInterfaceArgs.builder()
                .tagged(false)
                .vlanport(1.2)
                .build())
            .name("/Common/Internal")
            .tag(101)
            .build());

    }
}

    resources:
  vlan1:
    type: f5bigip:net:Vlan
    properties:
      interfaces:
        - tagged: false
          vlanport: 1.2
      name: /Common/Internal
      tag: 101

    Create Vlan Resource

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

    Constructor syntax

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

@overload
def Vlan(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         name: Optional[str] = None,
         cmp_hash: Optional[str] = None,
         interfaces: Optional[Sequence[VlanInterfaceArgs]] = None,
         mtu: Optional[int] = None,
         tag: Optional[int] = None)
    func NewVlan(ctx *Context, name string, args VlanArgs, opts ...ResourceOption) (*Vlan, error)
    public Vlan(string name, VlanArgs args, CustomResourceOptions? opts = null)
    public Vlan(String name, VlanArgs args)
public Vlan(String name, VlanArgs args, CustomResourceOptions options)

    type: f5bigip:net:Vlan
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 VlanArgs
    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 VlanArgs
    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 VlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VlanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var vlanResource = new F5BigIP.Net.Vlan("vlanResource", new()
{
    Name = "string",
    CmpHash = "string",
    Interfaces = new[]
    {
        new F5BigIP.Net.Inputs.VlanInterfaceArgs
        {
            Tagged = false,
            Vlanport = "string",
        },
    },
    Mtu = 0,
    Tag = 0,
});

    example, err := net.NewVlan(ctx, "vlanResource", &net.VlanArgs{
	Name:    pulumi.String("string"),
	CmpHash: pulumi.String("string"),
	Interfaces: net.VlanInterfaceArray{
		&net.VlanInterfaceArgs{
			Tagged:   pulumi.Bool(false),
			Vlanport: pulumi.String("string"),
		},
	},
	Mtu: pulumi.Int(0),
	Tag: pulumi.Int(0),
})

    var vlanResource = new Vlan("vlanResource", VlanArgs.builder()        
    .name("string")
    .cmpHash("string")
    .interfaces(VlanInterfaceArgs.builder()
        .tagged(false)
        .vlanport("string")
        .build())
    .mtu(0)
    .tag(0)
    .build());

    vlan_resource = f5bigip.net.Vlan("vlanResource",
    name="string",
    cmp_hash="string",
    interfaces=[f5bigip.net.VlanInterfaceArgs(
        tagged=False,
        vlanport="string",
    )],
    mtu=0,
    tag=0)

    const vlanResource = new f5bigip.net.Vlan("vlanResource", {
    name: "string",
    cmpHash: "string",
    interfaces: [{
        tagged: false,
        vlanport: "string",
    }],
    mtu: 0,
    tag: 0,
});

    type: f5bigip:net:Vlan
properties:
    cmpHash: string
    interfaces:
        - tagged: false
          vlanport: string
    mtu: 0
    name: string
    tag: 0

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

    Name string
    Name of the vlan
    CmpHash string
    Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. possible options: [default, src-ip, dst-ip]
    Interfaces List<Pulumi.F5BigIP.Net.Inputs.VlanInterface>
    Specifies which interfaces you want this VLAN to use for traffic management.
    Mtu int
    Specifies the maximum transmission unit (MTU) for traffic on this VLAN. The default value is 1500.
    Tag int
    Specifies a number that the system adds into the header of any frame passing through the VLAN.
    Name string
    Name of the vlan
    CmpHash string
    Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. possible options: [default, src-ip, dst-ip]
    Interfaces []VlanInterfaceArgs
    Specifies which interfaces you want this VLAN to use for traffic management.
    Mtu int
    Specifies the maximum transmission unit (MTU) for traffic on this VLAN. The default value is 1500.
    Tag int
    Specifies a number that the system adds into the header of any frame passing through the VLAN.
    name String
    Name of the vlan
    cmpHash String
    Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. possible options: [default, src-ip, dst-ip]
    interfaces List<VlanInterface>
    Specifies which interfaces you want this VLAN to use for traffic management.
    mtu Integer
    Specifies the maximum transmission unit (MTU) for traffic on this VLAN. The default value is 1500.
    tag Integer
    Specifies a number that the system adds into the header of any frame passing through the VLAN.
    name string
    Name of the vlan
    cmpHash string
    Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. possible options: [default, src-ip, dst-ip]
    interfaces VlanInterface[]
    Specifies which interfaces you want this VLAN to use for traffic management.
    mtu number
    Specifies the maximum transmission unit (MTU) for traffic on this VLAN. The default value is 1500.
    tag number
    Specifies a number that the system adds into the header of any frame passing through the VLAN.
    name str
    Name of the vlan
    cmp_hash str
    Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. possible options: [default, src-ip, dst-ip]
    interfaces Sequence[VlanInterfaceArgs]
    Specifies which interfaces you want this VLAN to use for traffic management.
    mtu int
    Specifies the maximum transmission unit (MTU) for traffic on this VLAN. The default value is 1500.
    tag int
    Specifies a number that the system adds into the header of any frame passing through the VLAN.
    name String
    Name of the vlan
    cmpHash String
    Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. possible options: [default, src-ip, dst-ip]
    interfaces List<Property Map>
    Specifies which interfaces you want this VLAN to use for traffic management.
    mtu Number
    Specifies the maximum transmission unit (MTU) for traffic on this VLAN. The default value is 1500.
    tag Number
    Specifies a number that the system adds into the header of any frame passing through the VLAN.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Vlan 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 Vlan Resource

    Get an existing Vlan 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?: VlanState, opts?: CustomResourceOptions): Vlan
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cmp_hash: Optional[str] = None,
        interfaces: Optional[Sequence[VlanInterfaceArgs]] = None,
        mtu: Optional[int] = None,
        name: Optional[str] = None,
        tag: Optional[int] = None) -> Vlan
    func GetVlan(ctx *Context, name string, id IDInput, state *VlanState, opts ...ResourceOption) (*Vlan, error)
    public static Vlan Get(string name, Input<string> id, VlanState? state, CustomResourceOptions? opts = null)
    public static Vlan get(String name, Output<String> id, VlanState 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:
    CmpHash string
    Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. possible options: [default, src-ip, dst-ip]
    Interfaces List<Pulumi.F5BigIP.Net.Inputs.VlanInterface>
    Specifies which interfaces you want this VLAN to use for traffic management.
    Mtu int
    Specifies the maximum transmission unit (MTU) for traffic on this VLAN. The default value is 1500.
    Name string
    Name of the vlan
    Tag int
    Specifies a number that the system adds into the header of any frame passing through the VLAN.
    CmpHash string
    Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. possible options: [default, src-ip, dst-ip]
    Interfaces []VlanInterfaceArgs
    Specifies which interfaces you want this VLAN to use for traffic management.
    Mtu int
    Specifies the maximum transmission unit (MTU) for traffic on this VLAN. The default value is 1500.
    Name string
    Name of the vlan
    Tag int
    Specifies a number that the system adds into the header of any frame passing through the VLAN.
    cmpHash String
    Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. possible options: [default, src-ip, dst-ip]
    interfaces List<VlanInterface>
    Specifies which interfaces you want this VLAN to use for traffic management.
    mtu Integer
    Specifies the maximum transmission unit (MTU) for traffic on this VLAN. The default value is 1500.
    name String
    Name of the vlan
    tag Integer
    Specifies a number that the system adds into the header of any frame passing through the VLAN.
    cmpHash string
    Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. possible options: [default, src-ip, dst-ip]
    interfaces VlanInterface[]
    Specifies which interfaces you want this VLAN to use for traffic management.
    mtu number
    Specifies the maximum transmission unit (MTU) for traffic on this VLAN. The default value is 1500.
    name string
    Name of the vlan
    tag number
    Specifies a number that the system adds into the header of any frame passing through the VLAN.
    cmp_hash str
    Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. possible options: [default, src-ip, dst-ip]
    interfaces Sequence[VlanInterfaceArgs]
    Specifies which interfaces you want this VLAN to use for traffic management.
    mtu int
    Specifies the maximum transmission unit (MTU) for traffic on this VLAN. The default value is 1500.
    name str
    Name of the vlan
    tag int
    Specifies a number that the system adds into the header of any frame passing through the VLAN.
    cmpHash String
    Specifies how the traffic on the VLAN will be disaggregated. The value selected determines the traffic disaggregation method. possible options: [default, src-ip, dst-ip]
    interfaces List<Property Map>
    Specifies which interfaces you want this VLAN to use for traffic management.
    mtu Number
    Specifies the maximum transmission unit (MTU) for traffic on this VLAN. The default value is 1500.
    name String
    Name of the vlan
    tag Number
    Specifies a number that the system adds into the header of any frame passing through the VLAN.

    Supporting Types

    VlanInterface, VlanInterfaceArgs

    Tagged bool
    Specifies a list of tagged interfaces or trunks associated with this VLAN. Note that you can associate tagged interfaces or trunks with any number of VLANs.
    Vlanport string
    Physical or virtual port used for traffic
    Tagged bool
    Specifies a list of tagged interfaces or trunks associated with this VLAN. Note that you can associate tagged interfaces or trunks with any number of VLANs.
    Vlanport string
    Physical or virtual port used for traffic
    tagged Boolean
    Specifies a list of tagged interfaces or trunks associated with this VLAN. Note that you can associate tagged interfaces or trunks with any number of VLANs.
    vlanport String
    Physical or virtual port used for traffic
    tagged boolean
    Specifies a list of tagged interfaces or trunks associated with this VLAN. Note that you can associate tagged interfaces or trunks with any number of VLANs.
    vlanport string
    Physical or virtual port used for traffic
    tagged bool
    Specifies a list of tagged interfaces or trunks associated with this VLAN. Note that you can associate tagged interfaces or trunks with any number of VLANs.
    vlanport str
    Physical or virtual port used for traffic
    tagged Boolean
    Specifies a list of tagged interfaces or trunks associated with this VLAN. Note that you can associate tagged interfaces or trunks with any number of VLANs.
    vlanport String
    Physical or virtual port used for traffic

    Package Details

    Repository
    f5 BIG-IP pulumi/pulumi-f5bigip
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the bigip Terraform Provider.
    f5bigip logo
    f5 BIG-IP v3.17.0 published on Thursday, Mar 28, 2024 by Pulumi
    pulumi/pulumi-f5bigip