This package is deprecated. Equinix has shut down the Equinix Metal service.
published on Thursday, Dec 30, 2021 by Pulumi
This package is deprecated. Equinix has shut down the Equinix Metal service.
published on Thursday, Dec 30, 2021 by Pulumi
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
- https://metal.equinix.com/developers/docs/networking/layer2/
- https://metal.equinix.com/developers/docs/networking/layer2-configs/
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
})
}
Example coming soon!
Example coming soon!
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,
});
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)
Example 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)type: equinix-metal:Vlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "equinix-metal_vlan" "name" {
# resource properties
}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),
})
resource "equinix-metal_vlan" "vlanResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
description = "string"
facility = "string"
metro = "string"
vxlan = 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Vlan resource accepts the following input properties:
- Project
Id string - ID of parent project
- Description string
- Description string
- Facility
string | Pulumi.
Equinix Metal. Facility - Facility where to create the VLAN
- Metro string
- Vxlan int
- VLAN ID, must be unique in metro
- project_
id string - ID of parent project
- description string
- Description string
- facility string | "ewr1" | "sjc1" | "dfw1" | "dfw2" | "ams1" | "nrt1" | "sea1" | "lax1" | "ord1" | "atl1" | "iad1" | "sin1" | "hkg1" | "syd1" | "mrs1" | "yyz1" | "fra2" | "am6" | "dc13" | "ch3" | "da3" | "da11" | "la4" | "ny5" | "sg1" | "sv15"
- 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
- project
Id String - ID of parent project
- description String
- Description string
- facility String | "ewr1" | "sjc1" | "dfw1" | "dfw2" | "ams1" | "nrt1" | "sea1" | "lax1" | "ord1" | "atl1" | "iad1" | "sin1" | "hkg1" | "syd1" | "mrs1" | "yyz1" | "fra2" | "am6" | "dc13" | "ch3" | "da3" | "da11" | "la4" | "ny5" | "sg1" | "sv15"
- Facility where to create the VLAN
- metro String
- vxlan Number
- 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 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) -> Vlanfunc 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)resources: existingVlan: type: equinix-metal:Vlan get: id: ${id}import {
to = equinix-metal_vlan.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state VlanState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state VlanState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state VlanState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state VlanState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Description string
- Description string
- Facility
string | Pulumi.
Equinix Metal. Facility - Facility where to create the VLAN
- Metro string
- Project
Id string - ID of parent project
- Vxlan int
- VLAN ID, must be unique in metro
- description string
- Description string
- facility string | "ewr1" | "sjc1" | "dfw1" | "dfw2" | "ams1" | "nrt1" | "sea1" | "lax1" | "ord1" | "atl1" | "iad1" | "sin1" | "hkg1" | "syd1" | "mrs1" | "yyz1" | "fra2" | "am6" | "dc13" | "ch3" | "da3" | "da11" | "la4" | "ny5" | "sg1" | "sv15"
- Facility where to create the VLAN
- metro string
- project_
id 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
- description String
- Description string
- facility String | "ewr1" | "sjc1" | "dfw1" | "dfw2" | "ams1" | "nrt1" | "sea1" | "lax1" | "ord1" | "atl1" | "iad1" | "sin1" | "hkg1" | "syd1" | "mrs1" | "yyz1" | "fra2" | "am6" | "dc13" | "ch3" | "da3" | "da11" | "la4" | "ny5" | "sg1" | "sv15"
- Facility where to create the VLAN
- metro String
- project
Id String - ID of parent project
- vxlan Number
- VLAN ID, must be unique in metro
Supporting Types
Facility
| Name | Value |
|---|---|
| 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 |
| Name | Value |
|---|---|
| Facility | ewr1 |
| Facility | sjc1 |
| Facility | dfw1 |
| Facility | dfw2 |
| Facility | ams1 |
| Facility | nrt1 |
| Facility | sea1 |
| Facility | lax1 |
| Facility | ord1 |
| Facility | atl1 |
| Facility | iad1 |
| Facility | sin1 |
| Facility | hkg1 |
| Facility | syd1 |
| Facility | mrs1 |
| Facility | yyz1 |
| Facility | fra2 |
| Facility | am6 |
| Facility | dc13 |
| Facility | ch3 |
| Facility | da3 |
| Facility | da11 |
| Facility | la4 |
| Facility | ny5 |
| Facility | sg1 |
| Facility | sv15 |
| Value |
|---|
ewr1 |
sjc1 |
dfw1 |
dfw2 |
ams1 |
nrt1 |
sea1 |
lax1 |
ord1 |
atl1 |
iad1 |
sin1 |
hkg1 |
syd1 |
mrs1 |
yyz1 |
fra2 |
am6 |
dc13 |
ch3 |
da3 |
da11 |
la4 |
ny5 |
sg1 |
sv15 |
| Name | Value |
|---|---|
| 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 |
| Name | Value |
|---|---|
| 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 |
| Name | Value |
|---|---|
| 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 |
| Value |
|---|
ewr1 |
sjc1 |
dfw1 |
dfw2 |
ams1 |
nrt1 |
sea1 |
lax1 |
ord1 |
atl1 |
iad1 |
sin1 |
hkg1 |
syd1 |
mrs1 |
yyz1 |
fra2 |
am6 |
dc13 |
ch3 |
da3 |
da11 |
la4 |
ny5 |
sg1 |
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
metalTerraform Provider.
This package is deprecated. Equinix has shut down the Equinix Metal service.
published on Thursday, Dec 30, 2021 by Pulumi