equinix.metal.VirtualCircuit
Explore with Pulumi AI
Use this resource to associate VLAN with a Dedicated Port from Equinix Fabric - software-defined interconnections.
See the Virtual Routing and Forwarding documentation for product details and API reference material.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Equinix = Pulumi.Equinix;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var projectId = config.Require("projectId");
var connectionId = config.Require("connectionId");
var vlanId = config.Require("vlanId");
var portId = Equinix.Metal.GetInterconnection.Invoke(new()
{
ConnectionId = connectionId,
}).Apply(invoke => invoke.Ports[0]?.Id);
var vc = new Equinix.Metal.VirtualCircuit("vc", new()
{
ConnectionId = connectionId,
ProjectId = projectId,
PortId = portId,
VlanId = vlanId,
NniVlan = 1056,
});
return new Dictionary<string, object?>
{
["vcStatus"] = vc.Status,
["vcVnid"] = vc.Vnid,
};
});
package main
import (
"github.com/equinix/pulumi-equinix/sdk/go/equinix/metal"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
cfg := config.New(ctx, "")
projectId := cfg.Require("projectId")
connectionId := cfg.Require("connectionId")
vlanId := cfg.Require("vlanId")
portId := metal.LookupInterconnection(ctx, &metal.LookupInterconnectionArgs{
ConnectionId: connectionId,
}, nil).Ports[0].Id
vc, err := metal.NewVirtualCircuit(ctx, "vc", &metal.VirtualCircuitArgs{
ConnectionId: pulumi.String(connectionId),
ProjectId: pulumi.String(projectId),
PortId: *pulumi.String(portId),
VlanId: pulumi.String(vlanId),
NniVlan: pulumi.Int(1056),
})
if err != nil {
return err
}
ctx.Export("vcStatus", vc.Status)
ctx.Export("vcVnid", vc.Vnid)
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.equinix.pulumi.metal.inputs.GetInterconnectionArgs;
import com.equinix.pulumi.metal.MetalFunctions;
import com.equinix.pulumi.metal.VirtualCircuit;
import com.equinix.pulumi.metal.VirtualCircuitArgs;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = ctx.config();
final var projectId = config.get("projectId").get();
final var connectionId = config.get("connectionId").get();
final var vlanId = config.get("vlanId").get();
final var portId = MetalFunctions.getInterconnection(GetInterconnectionArgs.builder()
.connectionId(connectionId)
.build()).applyValue(data -> data.ports().get(0).id());
var vc = new VirtualCircuit("vc", VirtualCircuitArgs.builder()
.connectionId(connectionId)
.projectId(projectId)
.portId(portId)
.vlanId(vlanId)
.nniVlan(1056)
.build());
ctx.export("vcStatus", vc.status());
ctx.export("vcVnid", vc.vnid());
}
}
import pulumi
import pulumi_equinix as equinix
config = pulumi.Config()
project_id = config.require("projectId")
connection_id = config.require("connectionId")
vlan_id = config.require("vlanId")
port_id = equinix.metal.get_interconnection(connection_id=connection_id).ports[0].id
vc = equinix.metal.VirtualCircuit("vc",
connection_id=connection_id,
project_id=project_id,
port_id=port_id,
vlan_id=vlan_id,
nni_vlan=1056)
pulumi.export("vcStatus", vc.status)
pulumi.export("vcVnid", vc.vnid)
import * as pulumi from "@pulumi/pulumi";
import * as equinix from "@equinix-labs/pulumi-equinix";
const config = new pulumi.Config();
const projectId = config.require("projectId");
const connectionId = config.require("connectionId");
const vlanId = config.require("vlanId");
const portId = equinix.metal.getInterconnection({
connectionId: connectionId,
}).then(invoke => invoke.ports?.[0]?.id);
const vc = new equinix.metal.VirtualCircuit("vc", {
connectionId: connectionId,
projectId: projectId,
portId: portId,
vlanId: vlanId,
nniVlan: 1056,
});
export const vcStatus = vc.status;
export const vcVnid = vc.vnid;
config:
projectId:
type: string
connectionId:
type: string
vlanId:
type: string
variables:
portId:
fn::invoke:
function: equinix:metal:getInterconnection
arguments:
connectionId: ${connectionId}
return: ports[0].id
resources:
vc:
type: equinix:metal:VirtualCircuit
properties:
connectionId: ${connectionId}
projectId: ${projectId}
portId: ${portId}
vlanId: ${vlanId}
nniVlan: 1056
outputs:
vcStatus: ${vc.status}
vcVnid: ${vc.vnid}
Create VirtualCircuit Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new VirtualCircuit(name: string, args: VirtualCircuitArgs, opts?: CustomResourceOptions);
@overload
def VirtualCircuit(resource_name: str,
args: VirtualCircuitArgs,
opts: Optional[ResourceOptions] = None)
@overload
def VirtualCircuit(resource_name: str,
opts: Optional[ResourceOptions] = None,
connection_id: Optional[str] = None,
project_id: Optional[str] = None,
port_id: Optional[str] = None,
md5: Optional[str] = None,
metal_ip: Optional[str] = None,
name: Optional[str] = None,
nni_vlan: Optional[int] = None,
peer_asn: Optional[int] = None,
description: Optional[str] = None,
customer_ip: Optional[str] = None,
speed: Optional[str] = None,
subnet: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
vlan_id: Optional[str] = None,
vrf_id: Optional[str] = None)
func NewVirtualCircuit(ctx *Context, name string, args VirtualCircuitArgs, opts ...ResourceOption) (*VirtualCircuit, error)
public VirtualCircuit(string name, VirtualCircuitArgs args, CustomResourceOptions? opts = null)
public VirtualCircuit(String name, VirtualCircuitArgs args)
public VirtualCircuit(String name, VirtualCircuitArgs args, CustomResourceOptions options)
type: equinix:metal:VirtualCircuit
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 VirtualCircuitArgs
- 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 VirtualCircuitArgs
- 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 VirtualCircuitArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args VirtualCircuitArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args VirtualCircuitArgs
- 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 virtualCircuitResource = new Equinix.Metal.VirtualCircuit("virtualCircuitResource", new()
{
ConnectionId = "string",
ProjectId = "string",
PortId = "string",
Md5 = "string",
MetalIp = "string",
Name = "string",
NniVlan = 0,
PeerAsn = 0,
Description = "string",
CustomerIp = "string",
Speed = "string",
Subnet = "string",
Tags = new[]
{
"string",
},
VlanId = "string",
VrfId = "string",
});
example, err := metal.NewVirtualCircuit(ctx, "virtualCircuitResource", &metal.VirtualCircuitArgs{
ConnectionId: pulumi.String("string"),
ProjectId: pulumi.String("string"),
PortId: pulumi.String("string"),
Md5: pulumi.String("string"),
MetalIp: pulumi.String("string"),
Name: pulumi.String("string"),
NniVlan: pulumi.Int(0),
PeerAsn: pulumi.Int(0),
Description: pulumi.String("string"),
CustomerIp: pulumi.String("string"),
Speed: pulumi.String("string"),
Subnet: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
VlanId: pulumi.String("string"),
VrfId: pulumi.String("string"),
})
var virtualCircuitResource = new VirtualCircuit("virtualCircuitResource", VirtualCircuitArgs.builder()
.connectionId("string")
.projectId("string")
.portId("string")
.md5("string")
.metalIp("string")
.name("string")
.nniVlan(0)
.peerAsn(0)
.description("string")
.customerIp("string")
.speed("string")
.subnet("string")
.tags("string")
.vlanId("string")
.vrfId("string")
.build());
virtual_circuit_resource = equinix.metal.VirtualCircuit("virtualCircuitResource",
connection_id="string",
project_id="string",
port_id="string",
md5="string",
metal_ip="string",
name="string",
nni_vlan=0,
peer_asn=0,
description="string",
customer_ip="string",
speed="string",
subnet="string",
tags=["string"],
vlan_id="string",
vrf_id="string")
const virtualCircuitResource = new equinix.metal.VirtualCircuit("virtualCircuitResource", {
connectionId: "string",
projectId: "string",
portId: "string",
md5: "string",
metalIp: "string",
name: "string",
nniVlan: 0,
peerAsn: 0,
description: "string",
customerIp: "string",
speed: "string",
subnet: "string",
tags: ["string"],
vlanId: "string",
vrfId: "string",
});
type: equinix:metal:VirtualCircuit
properties:
connectionId: string
customerIp: string
description: string
md5: string
metalIp: string
name: string
nniVlan: 0
peerAsn: 0
portId: string
projectId: string
speed: string
subnet: string
tags:
- string
vlanId: string
vrfId: string
VirtualCircuit 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 VirtualCircuit resource accepts the following input properties:
- Connection
Id string - UUID of Connection where the VC is scoped to.
- Port
Id string - UUID of the Connection Port where the VC is scoped to.
- Project
Id string - UUID of the Project where the VC is scoped to.
- Customer
Ip string - The Customer IP address which the CSR switch will peer with. Will default to the other usable IP in the subnet.
- Description string
- Description for the Virtual Circuit resource.
- Md5 string
- The password that can be set for the VRF BGP peer
- Metal
Ip string - The Metal IP address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the subnet.
- Name string
- Name of the Virtual Circuit resource.
- Nni
Vlan int - Equinix Metal network-to-network VLAN ID.
- Peer
Asn int - The BGP ASN of the peer. The same ASN may be the used across several VCs, but it cannot be the same as the local_asn of the VRF.
- Speed string
- Speed of the Virtual Circuit resource.
- Subnet string
- A subnet from one of the IP
blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /30 or /31.
- For a /31 block, it will only have two IP addresses, which will be used for the metal_ip and customer_ip.
- For a /30 block, it will have four IP addresses, but the first and last IP addresses are not usable. We will default to the first usable IP address for the metal_ip.
- List<string>
- Tags for the Virtual Circuit resource.
- Vlan
Id string - UUID of the VLAN to associate.
- Vrf
Id string - UUID of the VRF to associate.
- Connection
Id string - UUID of Connection where the VC is scoped to.
- Port
Id string - UUID of the Connection Port where the VC is scoped to.
- Project
Id string - UUID of the Project where the VC is scoped to.
- Customer
Ip string - The Customer IP address which the CSR switch will peer with. Will default to the other usable IP in the subnet.
- Description string
- Description for the Virtual Circuit resource.
- Md5 string
- The password that can be set for the VRF BGP peer
- Metal
Ip string - The Metal IP address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the subnet.
- Name string
- Name of the Virtual Circuit resource.
- Nni
Vlan int - Equinix Metal network-to-network VLAN ID.
- Peer
Asn int - The BGP ASN of the peer. The same ASN may be the used across several VCs, but it cannot be the same as the local_asn of the VRF.
- Speed string
- Speed of the Virtual Circuit resource.
- Subnet string
- A subnet from one of the IP
blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /30 or /31.
- For a /31 block, it will only have two IP addresses, which will be used for the metal_ip and customer_ip.
- For a /30 block, it will have four IP addresses, but the first and last IP addresses are not usable. We will default to the first usable IP address for the metal_ip.
- []string
- Tags for the Virtual Circuit resource.
- Vlan
Id string - UUID of the VLAN to associate.
- Vrf
Id string - UUID of the VRF to associate.
- connection
Id String - UUID of Connection where the VC is scoped to.
- port
Id String - UUID of the Connection Port where the VC is scoped to.
- project
Id String - UUID of the Project where the VC is scoped to.
- customer
Ip String - The Customer IP address which the CSR switch will peer with. Will default to the other usable IP in the subnet.
- description String
- Description for the Virtual Circuit resource.
- md5 String
- The password that can be set for the VRF BGP peer
- metal
Ip String - The Metal IP address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the subnet.
- name String
- Name of the Virtual Circuit resource.
- nni
Vlan Integer - Equinix Metal network-to-network VLAN ID.
- peer
Asn Integer - The BGP ASN of the peer. The same ASN may be the used across several VCs, but it cannot be the same as the local_asn of the VRF.
- speed String
- Speed of the Virtual Circuit resource.
- subnet String
- A subnet from one of the IP
blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /30 or /31.
- For a /31 block, it will only have two IP addresses, which will be used for the metal_ip and customer_ip.
- For a /30 block, it will have four IP addresses, but the first and last IP addresses are not usable. We will default to the first usable IP address for the metal_ip.
- List<String>
- Tags for the Virtual Circuit resource.
- vlan
Id String - UUID of the VLAN to associate.
- vrf
Id String - UUID of the VRF to associate.
- connection
Id string - UUID of Connection where the VC is scoped to.
- port
Id string - UUID of the Connection Port where the VC is scoped to.
- project
Id string - UUID of the Project where the VC is scoped to.
- customer
Ip string - The Customer IP address which the CSR switch will peer with. Will default to the other usable IP in the subnet.
- description string
- Description for the Virtual Circuit resource.
- md5 string
- The password that can be set for the VRF BGP peer
- metal
Ip string - The Metal IP address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the subnet.
- name string
- Name of the Virtual Circuit resource.
- nni
Vlan number - Equinix Metal network-to-network VLAN ID.
- peer
Asn number - The BGP ASN of the peer. The same ASN may be the used across several VCs, but it cannot be the same as the local_asn of the VRF.
- speed string
- Speed of the Virtual Circuit resource.
- subnet string
- A subnet from one of the IP
blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /30 or /31.
- For a /31 block, it will only have two IP addresses, which will be used for the metal_ip and customer_ip.
- For a /30 block, it will have four IP addresses, but the first and last IP addresses are not usable. We will default to the first usable IP address for the metal_ip.
- string[]
- Tags for the Virtual Circuit resource.
- vlan
Id string - UUID of the VLAN to associate.
- vrf
Id string - UUID of the VRF to associate.
- connection_
id str - UUID of Connection where the VC is scoped to.
- port_
id str - UUID of the Connection Port where the VC is scoped to.
- project_
id str - UUID of the Project where the VC is scoped to.
- customer_
ip str - The Customer IP address which the CSR switch will peer with. Will default to the other usable IP in the subnet.
- description str
- Description for the Virtual Circuit resource.
- md5 str
- The password that can be set for the VRF BGP peer
- metal_
ip str - The Metal IP address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the subnet.
- name str
- Name of the Virtual Circuit resource.
- nni_
vlan int - Equinix Metal network-to-network VLAN ID.
- peer_
asn int - The BGP ASN of the peer. The same ASN may be the used across several VCs, but it cannot be the same as the local_asn of the VRF.
- speed str
- Speed of the Virtual Circuit resource.
- subnet str
- A subnet from one of the IP
blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /30 or /31.
- For a /31 block, it will only have two IP addresses, which will be used for the metal_ip and customer_ip.
- For a /30 block, it will have four IP addresses, but the first and last IP addresses are not usable. We will default to the first usable IP address for the metal_ip.
- Sequence[str]
- Tags for the Virtual Circuit resource.
- vlan_
id str - UUID of the VLAN to associate.
- vrf_
id str - UUID of the VRF to associate.
- connection
Id String - UUID of Connection where the VC is scoped to.
- port
Id String - UUID of the Connection Port where the VC is scoped to.
- project
Id String - UUID of the Project where the VC is scoped to.
- customer
Ip String - The Customer IP address which the CSR switch will peer with. Will default to the other usable IP in the subnet.
- description String
- Description for the Virtual Circuit resource.
- md5 String
- The password that can be set for the VRF BGP peer
- metal
Ip String - The Metal IP address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the subnet.
- name String
- Name of the Virtual Circuit resource.
- nni
Vlan Number - Equinix Metal network-to-network VLAN ID.
- peer
Asn Number - The BGP ASN of the peer. The same ASN may be the used across several VCs, but it cannot be the same as the local_asn of the VRF.
- speed String
- Speed of the Virtual Circuit resource.
- subnet String
- A subnet from one of the IP
blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /30 or /31.
- For a /31 block, it will only have two IP addresses, which will be used for the metal_ip and customer_ip.
- For a /30 block, it will have four IP addresses, but the first and last IP addresses are not usable. We will default to the first usable IP address for the metal_ip.
- List<String>
- Tags for the Virtual Circuit resource.
- vlan
Id String - UUID of the VLAN to associate.
- vrf
Id String - UUID of the VRF to associate.
Outputs
All input properties are implicitly available as output properties. Additionally, the VirtualCircuit resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Nni
Vnid int - NNI VLAN parameters, see the documentation for Equinix Fabric.
- Status string
- Status of the virtal circuit.
- Vnid int
- VNID VLAN parameter, see the documentation for Equinix Fabric.
- Id string
- The provider-assigned unique ID for this managed resource.
- Nni
Vnid int - NNI VLAN parameters, see the documentation for Equinix Fabric.
- Status string
- Status of the virtal circuit.
- Vnid int
- VNID VLAN parameter, see the documentation for Equinix Fabric.
- id String
- The provider-assigned unique ID for this managed resource.
- nni
Vnid Integer - NNI VLAN parameters, see the documentation for Equinix Fabric.
- status String
- Status of the virtal circuit.
- vnid Integer
- VNID VLAN parameter, see the documentation for Equinix Fabric.
- id string
- The provider-assigned unique ID for this managed resource.
- nni
Vnid number - NNI VLAN parameters, see the documentation for Equinix Fabric.
- status string
- Status of the virtal circuit.
- vnid number
- VNID VLAN parameter, see the documentation for Equinix Fabric.
- id str
- The provider-assigned unique ID for this managed resource.
- nni_
vnid int - NNI VLAN parameters, see the documentation for Equinix Fabric.
- status str
- Status of the virtal circuit.
- vnid int
- VNID VLAN parameter, see the documentation for Equinix Fabric.
- id String
- The provider-assigned unique ID for this managed resource.
- nni
Vnid Number - NNI VLAN parameters, see the documentation for Equinix Fabric.
- status String
- Status of the virtal circuit.
- vnid Number
- VNID VLAN parameter, see the documentation for Equinix Fabric.
Look up Existing VirtualCircuit Resource
Get an existing VirtualCircuit 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?: VirtualCircuitState, opts?: CustomResourceOptions): VirtualCircuit
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
connection_id: Optional[str] = None,
customer_ip: Optional[str] = None,
description: Optional[str] = None,
md5: Optional[str] = None,
metal_ip: Optional[str] = None,
name: Optional[str] = None,
nni_vlan: Optional[int] = None,
nni_vnid: Optional[int] = None,
peer_asn: Optional[int] = None,
port_id: Optional[str] = None,
project_id: Optional[str] = None,
speed: Optional[str] = None,
status: Optional[str] = None,
subnet: Optional[str] = None,
tags: Optional[Sequence[str]] = None,
vlan_id: Optional[str] = None,
vnid: Optional[int] = None,
vrf_id: Optional[str] = None) -> VirtualCircuit
func GetVirtualCircuit(ctx *Context, name string, id IDInput, state *VirtualCircuitState, opts ...ResourceOption) (*VirtualCircuit, error)
public static VirtualCircuit Get(string name, Input<string> id, VirtualCircuitState? state, CustomResourceOptions? opts = null)
public static VirtualCircuit get(String name, Output<String> id, VirtualCircuitState 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.
- Connection
Id string - UUID of Connection where the VC is scoped to.
- Customer
Ip string - The Customer IP address which the CSR switch will peer with. Will default to the other usable IP in the subnet.
- Description string
- Description for the Virtual Circuit resource.
- Md5 string
- The password that can be set for the VRF BGP peer
- Metal
Ip string - The Metal IP address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the subnet.
- Name string
- Name of the Virtual Circuit resource.
- Nni
Vlan int - Equinix Metal network-to-network VLAN ID.
- Nni
Vnid int - NNI VLAN parameters, see the documentation for Equinix Fabric.
- Peer
Asn int - The BGP ASN of the peer. The same ASN may be the used across several VCs, but it cannot be the same as the local_asn of the VRF.
- Port
Id string - UUID of the Connection Port where the VC is scoped to.
- Project
Id string - UUID of the Project where the VC is scoped to.
- Speed string
- Speed of the Virtual Circuit resource.
- Status string
- Status of the virtal circuit.
- Subnet string
- A subnet from one of the IP
blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /30 or /31.
- For a /31 block, it will only have two IP addresses, which will be used for the metal_ip and customer_ip.
- For a /30 block, it will have four IP addresses, but the first and last IP addresses are not usable. We will default to the first usable IP address for the metal_ip.
- List<string>
- Tags for the Virtual Circuit resource.
- Vlan
Id string - UUID of the VLAN to associate.
- Vnid int
- VNID VLAN parameter, see the documentation for Equinix Fabric.
- Vrf
Id string - UUID of the VRF to associate.
- Connection
Id string - UUID of Connection where the VC is scoped to.
- Customer
Ip string - The Customer IP address which the CSR switch will peer with. Will default to the other usable IP in the subnet.
- Description string
- Description for the Virtual Circuit resource.
- Md5 string
- The password that can be set for the VRF BGP peer
- Metal
Ip string - The Metal IP address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the subnet.
- Name string
- Name of the Virtual Circuit resource.
- Nni
Vlan int - Equinix Metal network-to-network VLAN ID.
- Nni
Vnid int - NNI VLAN parameters, see the documentation for Equinix Fabric.
- Peer
Asn int - The BGP ASN of the peer. The same ASN may be the used across several VCs, but it cannot be the same as the local_asn of the VRF.
- Port
Id string - UUID of the Connection Port where the VC is scoped to.
- Project
Id string - UUID of the Project where the VC is scoped to.
- Speed string
- Speed of the Virtual Circuit resource.
- Status string
- Status of the virtal circuit.
- Subnet string
- A subnet from one of the IP
blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /30 or /31.
- For a /31 block, it will only have two IP addresses, which will be used for the metal_ip and customer_ip.
- For a /30 block, it will have four IP addresses, but the first and last IP addresses are not usable. We will default to the first usable IP address for the metal_ip.
- []string
- Tags for the Virtual Circuit resource.
- Vlan
Id string - UUID of the VLAN to associate.
- Vnid int
- VNID VLAN parameter, see the documentation for Equinix Fabric.
- Vrf
Id string - UUID of the VRF to associate.
- connection
Id String - UUID of Connection where the VC is scoped to.
- customer
Ip String - The Customer IP address which the CSR switch will peer with. Will default to the other usable IP in the subnet.
- description String
- Description for the Virtual Circuit resource.
- md5 String
- The password that can be set for the VRF BGP peer
- metal
Ip String - The Metal IP address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the subnet.
- name String
- Name of the Virtual Circuit resource.
- nni
Vlan Integer - Equinix Metal network-to-network VLAN ID.
- nni
Vnid Integer - NNI VLAN parameters, see the documentation for Equinix Fabric.
- peer
Asn Integer - The BGP ASN of the peer. The same ASN may be the used across several VCs, but it cannot be the same as the local_asn of the VRF.
- port
Id String - UUID of the Connection Port where the VC is scoped to.
- project
Id String - UUID of the Project where the VC is scoped to.
- speed String
- Speed of the Virtual Circuit resource.
- status String
- Status of the virtal circuit.
- subnet String
- A subnet from one of the IP
blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /30 or /31.
- For a /31 block, it will only have two IP addresses, which will be used for the metal_ip and customer_ip.
- For a /30 block, it will have four IP addresses, but the first and last IP addresses are not usable. We will default to the first usable IP address for the metal_ip.
- List<String>
- Tags for the Virtual Circuit resource.
- vlan
Id String - UUID of the VLAN to associate.
- vnid Integer
- VNID VLAN parameter, see the documentation for Equinix Fabric.
- vrf
Id String - UUID of the VRF to associate.
- connection
Id string - UUID of Connection where the VC is scoped to.
- customer
Ip string - The Customer IP address which the CSR switch will peer with. Will default to the other usable IP in the subnet.
- description string
- Description for the Virtual Circuit resource.
- md5 string
- The password that can be set for the VRF BGP peer
- metal
Ip string - The Metal IP address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the subnet.
- name string
- Name of the Virtual Circuit resource.
- nni
Vlan number - Equinix Metal network-to-network VLAN ID.
- nni
Vnid number - NNI VLAN parameters, see the documentation for Equinix Fabric.
- peer
Asn number - The BGP ASN of the peer. The same ASN may be the used across several VCs, but it cannot be the same as the local_asn of the VRF.
- port
Id string - UUID of the Connection Port where the VC is scoped to.
- project
Id string - UUID of the Project where the VC is scoped to.
- speed string
- Speed of the Virtual Circuit resource.
- status string
- Status of the virtal circuit.
- subnet string
- A subnet from one of the IP
blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /30 or /31.
- For a /31 block, it will only have two IP addresses, which will be used for the metal_ip and customer_ip.
- For a /30 block, it will have four IP addresses, but the first and last IP addresses are not usable. We will default to the first usable IP address for the metal_ip.
- string[]
- Tags for the Virtual Circuit resource.
- vlan
Id string - UUID of the VLAN to associate.
- vnid number
- VNID VLAN parameter, see the documentation for Equinix Fabric.
- vrf
Id string - UUID of the VRF to associate.
- connection_
id str - UUID of Connection where the VC is scoped to.
- customer_
ip str - The Customer IP address which the CSR switch will peer with. Will default to the other usable IP in the subnet.
- description str
- Description for the Virtual Circuit resource.
- md5 str
- The password that can be set for the VRF BGP peer
- metal_
ip str - The Metal IP address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the subnet.
- name str
- Name of the Virtual Circuit resource.
- nni_
vlan int - Equinix Metal network-to-network VLAN ID.
- nni_
vnid int - NNI VLAN parameters, see the documentation for Equinix Fabric.
- peer_
asn int - The BGP ASN of the peer. The same ASN may be the used across several VCs, but it cannot be the same as the local_asn of the VRF.
- port_
id str - UUID of the Connection Port where the VC is scoped to.
- project_
id str - UUID of the Project where the VC is scoped to.
- speed str
- Speed of the Virtual Circuit resource.
- status str
- Status of the virtal circuit.
- subnet str
- A subnet from one of the IP
blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /30 or /31.
- For a /31 block, it will only have two IP addresses, which will be used for the metal_ip and customer_ip.
- For a /30 block, it will have four IP addresses, but the first and last IP addresses are not usable. We will default to the first usable IP address for the metal_ip.
- Sequence[str]
- Tags for the Virtual Circuit resource.
- vlan_
id str - UUID of the VLAN to associate.
- vnid int
- VNID VLAN parameter, see the documentation for Equinix Fabric.
- vrf_
id str - UUID of the VRF to associate.
- connection
Id String - UUID of Connection where the VC is scoped to.
- customer
Ip String - The Customer IP address which the CSR switch will peer with. Will default to the other usable IP in the subnet.
- description String
- Description for the Virtual Circuit resource.
- md5 String
- The password that can be set for the VRF BGP peer
- metal
Ip String - The Metal IP address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the subnet.
- name String
- Name of the Virtual Circuit resource.
- nni
Vlan Number - Equinix Metal network-to-network VLAN ID.
- nni
Vnid Number - NNI VLAN parameters, see the documentation for Equinix Fabric.
- peer
Asn Number - The BGP ASN of the peer. The same ASN may be the used across several VCs, but it cannot be the same as the local_asn of the VRF.
- port
Id String - UUID of the Connection Port where the VC is scoped to.
- project
Id String - UUID of the Project where the VC is scoped to.
- speed String
- Speed of the Virtual Circuit resource.
- status String
- Status of the virtal circuit.
- subnet String
- A subnet from one of the IP
blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /30 or /31.
- For a /31 block, it will only have two IP addresses, which will be used for the metal_ip and customer_ip.
- For a /30 block, it will have four IP addresses, but the first and last IP addresses are not usable. We will default to the first usable IP address for the metal_ip.
- List<String>
- Tags for the Virtual Circuit resource.
- vlan
Id String - UUID of the VLAN to associate.
- vnid Number
- VNID VLAN parameter, see the documentation for Equinix Fabric.
- vrf
Id String - UUID of the VRF to associate.
Package Details
- Repository
- equinix equinix/pulumi-equinix
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
equinix
Terraform Provider.