1. Packages
  2. Equinix Metal (Deprecated)
  3. API Docs
  4. Vlan

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED

equinix-metal.Vlan

Explore with Pulumi AI

equinix-metal logo

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED

    Provides a resource to allow users to manage Virtual Networks in their projects.

    To learn more about Layer 2 networking in Equinix Metal, refer to

    Example Usage

    using Pulumi;
    using EquinixMetal = Pulumi.EquinixMetal;
    
    class MyStack : Stack
    {
        public MyStack()
        {
            // Create a new VLAN in facility "sv15"
            var vlan1Vlan = new EquinixMetal.Vlan("vlan1Vlan", new EquinixMetal.VlanArgs
            {
                Description = "VLAN in New Jersey",
                Facility = "sv15",
                ProjectId = local.Project_id,
            });
            // Create a new VLAN in metro "esv"
            var vlan1Index_vlanVlan = new EquinixMetal.Vlan("vlan1Index/vlanVlan", new EquinixMetal.VlanArgs
            {
                Description = "VLAN in New Jersey",
                Metro = "sv",
                ProjectId = local.Project_id,
                Vxlan = 1040,
            });
        }
    
    }
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-equinix-metal/sdk/v3/go/equinix-metal"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := equinix - metal.NewVlan(ctx, "vlan1Vlan", &equinix-metal.VlanArgs{
    			Description: pulumi.String("VLAN in New Jersey"),
    			Facility:    pulumi.String("sv15"),
    			ProjectId:   pulumi.Any(local.Project_id),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = equinix - metal.NewVlan(ctx, "vlan1Index_vlanVlan", &equinix-metal.VlanArgs{
    			Description: pulumi.String("VLAN in New Jersey"),
    			Metro:       pulumi.String("sv"),
    			ProjectId:   pulumi.Any(local.Project_id),
    			Vxlan:       pulumi.Int(1040),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Coming soon!

    import pulumi
    import pulumi_equinix_metal as equinix_metal
    
    # Create a new VLAN in facility "sv15"
    vlan1_vlan = equinix_metal.Vlan("vlan1Vlan",
        description="VLAN in New Jersey",
        facility="sv15",
        project_id=local["project_id"])
    # Create a new VLAN in metro "esv"
    vlan1_index_vlan_vlan = equinix_metal.Vlan("vlan1Index/vlanVlan",
        description="VLAN in New Jersey",
        metro="sv",
        project_id=local["project_id"],
        vxlan=1040)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as equinix_metal from "@pulumi/equinix-metal";
    
    // Create a new VLAN in facility "sv15"
    const vlan1Vlan = new equinix_metal.Vlan("vlan1Vlan", {
        description: "VLAN in New Jersey",
        facility: "sv15",
        projectId: local.project_id,
    });
    // Create a new VLAN in metro "esv"
    const vlan1Index_vlanVlan = new equinix_metal.Vlan("vlan1Index/vlanVlan", {
        description: "VLAN in New Jersey",
        metro: "sv",
        projectId: local.project_id,
        vxlan: 1040,
    });
    

    Coming soon!

    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,
             project_id: Optional[str] = None,
             description: Optional[str] = None,
             facility: Optional[Union[str, Facility]] = None,
             metro: Optional[str] = None,
             vxlan: 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: equinix-metal: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.

    Constructor example

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

    var vlanResource = new EquinixMetal.Vlan("vlanResource", new()
    {
        ProjectId = "string",
        Description = "string",
        Facility = "string",
        Metro = "string",
        Vxlan = 0,
    });
    
    example, err := equinixmetal.NewVlan(ctx, "vlanResource", &equinixmetal.VlanArgs{
    	ProjectId:   pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Facility:    pulumi.String("string"),
    	Metro:       pulumi.String("string"),
    	Vxlan:       pulumi.Int(0),
    })
    
    var vlanResource = new Vlan("vlanResource", VlanArgs.builder()
        .projectId("string")
        .description("string")
        .facility("string")
        .metro("string")
        .vxlan(0)
        .build());
    
    vlan_resource = equinix_metal.Vlan("vlanResource",
        project_id="string",
        description="string",
        facility="string",
        metro="string",
        vxlan=0)
    
    const vlanResource = new equinix_metal.Vlan("vlanResource", {
        projectId: "string",
        description: "string",
        facility: "string",
        metro: "string",
        vxlan: 0,
    });
    
    type: equinix-metal:Vlan
    properties:
        description: string
        facility: string
        metro: string
        projectId: string
        vxlan: 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:

    ProjectId string
    ID of parent project
    Description string
    Description string
    Facility string | Pulumi.EquinixMetal.Facility
    Facility where to create the VLAN
    Metro string
    Vxlan int
    VLAN ID, must be unique in metro
    ProjectId string
    ID of parent project
    Description string
    Description string
    Facility string | Facility
    Facility where to create the VLAN
    Metro string
    Vxlan int
    VLAN ID, must be unique in metro
    projectId String
    ID of parent project
    description String
    Description string
    facility String | Facility
    Facility where to create the VLAN
    metro String
    vxlan Integer
    VLAN ID, must be unique in metro
    projectId string
    ID of parent project
    description string
    Description string
    facility string | Facility
    Facility where to create the VLAN
    metro string
    vxlan number
    VLAN ID, must be unique in metro
    project_id str
    ID of parent project
    description str
    Description string
    facility str | Facility
    Facility where to create the VLAN
    metro str
    vxlan int
    VLAN ID, must be unique in metro

    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,
            description: Optional[str] = None,
            facility: Optional[Union[str, Facility]] = None,
            metro: Optional[str] = None,
            project_id: Optional[str] = None,
            vxlan: 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:
    Description string
    Description string
    Facility string | Pulumi.EquinixMetal.Facility
    Facility where to create the VLAN
    Metro string
    ProjectId string
    ID of parent project
    Vxlan int
    VLAN ID, must be unique in metro
    Description string
    Description string
    Facility string | Facility
    Facility where to create the VLAN
    Metro string
    ProjectId string
    ID of parent project
    Vxlan int
    VLAN ID, must be unique in metro
    description String
    Description string
    facility String | Facility
    Facility where to create the VLAN
    metro String
    projectId String
    ID of parent project
    vxlan Integer
    VLAN ID, must be unique in metro
    description string
    Description string
    facility string | Facility
    Facility where to create the VLAN
    metro string
    projectId string
    ID of parent project
    vxlan number
    VLAN ID, must be unique in metro
    description str
    Description string
    facility str | Facility
    Facility where to create the VLAN
    metro str
    project_id str
    ID of parent project
    vxlan int
    VLAN ID, must be unique in metro

    Supporting Types

    Facility, FacilityArgs

    EWR1
    ewr1
    SJC1
    sjc1
    DFW1
    dfw1
    DFW2
    dfw2
    AMS1
    ams1
    NRT1
    nrt1
    SEA1
    sea1
    LAX1
    lax1
    ORD1
    ord1
    ATL1
    atl1
    IAD1
    iad1
    SIN1
    sin1
    HKG1
    hkg1
    SYD1
    syd1
    MRS1
    mrs1
    YYZ1
    yyz1
    FRA2
    fra2
    AM6
    am6
    DC13
    dc13
    CH3
    ch3
    DA3
    da3
    DA11
    da11
    LA4
    la4
    NY5
    ny5
    SG1
    sg1
    SV15
    sv15
    FacilityEWR1
    ewr1
    FacilitySJC1
    sjc1
    FacilityDFW1
    dfw1
    FacilityDFW2
    dfw2
    FacilityAMS1
    ams1
    FacilityNRT1
    nrt1
    FacilitySEA1
    sea1
    FacilityLAX1
    lax1
    FacilityORD1
    ord1
    FacilityATL1
    atl1
    FacilityIAD1
    iad1
    FacilitySIN1
    sin1
    FacilityHKG1
    hkg1
    FacilitySYD1
    syd1
    FacilityMRS1
    mrs1
    FacilityYYZ1
    yyz1
    FacilityFRA2
    fra2
    FacilityAM6
    am6
    FacilityDC13
    dc13
    FacilityCH3
    ch3
    FacilityDA3
    da3
    FacilityDA11
    da11
    FacilityLA4
    la4
    FacilityNY5
    ny5
    FacilitySG1
    sg1
    FacilitySV15
    sv15
    EWR1
    ewr1
    SJC1
    sjc1
    DFW1
    dfw1
    DFW2
    dfw2
    AMS1
    ams1
    NRT1
    nrt1
    SEA1
    sea1
    LAX1
    lax1
    ORD1
    ord1
    ATL1
    atl1
    IAD1
    iad1
    SIN1
    sin1
    HKG1
    hkg1
    SYD1
    syd1
    MRS1
    mrs1
    YYZ1
    yyz1
    FRA2
    fra2
    AM6
    am6
    DC13
    dc13
    CH3
    ch3
    DA3
    da3
    DA11
    da11
    LA4
    la4
    NY5
    ny5
    SG1
    sg1
    SV15
    sv15
    EWR1
    ewr1
    SJC1
    sjc1
    DFW1
    dfw1
    DFW2
    dfw2
    AMS1
    ams1
    NRT1
    nrt1
    SEA1
    sea1
    LAX1
    lax1
    ORD1
    ord1
    ATL1
    atl1
    IAD1
    iad1
    SIN1
    sin1
    HKG1
    hkg1
    SYD1
    syd1
    MRS1
    mrs1
    YYZ1
    yyz1
    FRA2
    fra2
    AM6
    am6
    DC13
    dc13
    CH3
    ch3
    DA3
    da3
    DA11
    da11
    LA4
    la4
    NY5
    ny5
    SG1
    sg1
    SV15
    sv15
    EWR1
    ewr1
    SJC1
    sjc1
    DFW1
    dfw1
    DFW2
    dfw2
    AMS1
    ams1
    NRT1
    nrt1
    SEA1
    sea1
    LAX1
    lax1
    ORD1
    ord1
    ATL1
    atl1
    IAD1
    iad1
    SIN1
    sin1
    HKG1
    hkg1
    SYD1
    syd1
    MRS1
    mrs1
    YYZ1
    yyz1
    FRA2
    fra2
    AM6
    am6
    DC13
    dc13
    CH3
    ch3
    DA3
    da3
    DA11
    da11
    LA4
    la4
    NY5
    ny5
    SG1
    sg1
    SV15
    sv15
    "ewr1"
    ewr1
    "sjc1"
    sjc1
    "dfw1"
    dfw1
    "dfw2"
    dfw2
    "ams1"
    ams1
    "nrt1"
    nrt1
    "sea1"
    sea1
    "lax1"
    lax1
    "ord1"
    ord1
    "atl1"
    atl1
    "iad1"
    iad1
    "sin1"
    sin1
    "hkg1"
    hkg1
    "syd1"
    syd1
    "mrs1"
    mrs1
    "yyz1"
    yyz1
    "fra2"
    fra2
    "am6"
    am6
    "dc13"
    dc13
    "ch3"
    ch3
    "da3"
    da3
    "da11"
    da11
    "la4"
    la4
    "ny5"
    ny5
    "sg1"
    sg1
    "sv15"
    sv15

    Import

    This resource can be imported using an existing VLAN ID (UUID)

     $ pulumi import equinix-metal:index/vlan:Vlan metal_vlan {existing_vlan_id}
    

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

    Package Details

    Repository
    Equinix Metal pulumi/pulumi-equinix-metal
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the metal Terraform Provider.
    equinix-metal logo

    This package is deprecated. We recommend using the new Equinix package.

    Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED