equinix.metal.getVirtualCircuit

Explore with Pulumi AI

Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix

Using getVirtualCircuit

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getVirtualCircuit(args: GetVirtualCircuitArgs, opts?: InvokeOptions): Promise<GetVirtualCircuitResult>
function getVirtualCircuitOutput(args: GetVirtualCircuitOutputArgs, opts?: InvokeOptions): Output<GetVirtualCircuitResult>

def get_virtual_circuit(customer_ipv6: Optional[str] = None,
                        metal_ipv6: Optional[str] = None,
                        subnet_ipv6: Optional[str] = None,
                        virtual_circuit_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVirtualCircuitResult
def get_virtual_circuit_output(customer_ipv6: Optional[pulumi.Input[str]] = None,
                        metal_ipv6: Optional[pulumi.Input[str]] = None,
                        subnet_ipv6: Optional[pulumi.Input[str]] = None,
                        virtual_circuit_id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVirtualCircuitResult]

func LookupVirtualCircuit(ctx *Context, args *LookupVirtualCircuitArgs, opts ...InvokeOption) (*LookupVirtualCircuitResult, error)
func LookupVirtualCircuitOutput(ctx *Context, args *LookupVirtualCircuitOutputArgs, opts ...InvokeOption) LookupVirtualCircuitResultOutput

> Note: This function is named LookupVirtualCircuit in the Go SDK.

public static class GetVirtualCircuit 
{
    public static Task<GetVirtualCircuitResult> InvokeAsync(GetVirtualCircuitArgs args, InvokeOptions? opts = null)
    public static Output<GetVirtualCircuitResult> Invoke(GetVirtualCircuitInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVirtualCircuitResult> getVirtualCircuit(GetVirtualCircuitArgs args, InvokeOptions options)
public static Output<GetVirtualCircuitResult> getVirtualCircuit(GetVirtualCircuitArgs args, InvokeOptions options)

fn::invoke:
  function: equinix:metal/getVirtualCircuit:getVirtualCircuit
  arguments:
    # arguments dictionary

The following arguments are supported:

VirtualCircuitId string: ID of the virtual circuit to lookup
CustomerIpv6 string: The Customer IPv6 address which the CSR switch will peer with. Will default to the other usable IP in the IPv6 subnet.
MetalIpv6 string: The Metal IPv6 address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the IPv6 subnet.
SubnetIpv6 string: A subnet from one of the IPv6 blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /126 or /127. * For a /127 block, it will only have two IP addresses, which will be used for the metalip and customerip. * For a /126 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.

VirtualCircuitId string: ID of the virtual circuit to lookup
CustomerIpv6 string: The Customer IPv6 address which the CSR switch will peer with. Will default to the other usable IP in the IPv6 subnet.
MetalIpv6 string: The Metal IPv6 address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the IPv6 subnet.
SubnetIpv6 string: A subnet from one of the IPv6 blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /126 or /127. * For a /127 block, it will only have two IP addresses, which will be used for the metalip and customerip. * For a /126 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.

virtualCircuitId String: ID of the virtual circuit to lookup
customerIpv6 String: The Customer IPv6 address which the CSR switch will peer with. Will default to the other usable IP in the IPv6 subnet.
metalIpv6 String: The Metal IPv6 address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the IPv6 subnet.
subnetIpv6 String: A subnet from one of the IPv6 blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /126 or /127. * For a /127 block, it will only have two IP addresses, which will be used for the metalip and customerip. * For a /126 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.

virtualCircuitId string: ID of the virtual circuit to lookup
customerIpv6 string: The Customer IPv6 address which the CSR switch will peer with. Will default to the other usable IP in the IPv6 subnet.
metalIpv6 string: The Metal IPv6 address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the IPv6 subnet.
subnetIpv6 string: A subnet from one of the IPv6 blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /126 or /127. * For a /127 block, it will only have two IP addresses, which will be used for the metalip and customerip. * For a /126 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.

virtual_circuit_id str: ID of the virtual circuit to lookup
customer_ipv6 str: The Customer IPv6 address which the CSR switch will peer with. Will default to the other usable IP in the IPv6 subnet.
metal_ipv6 str: The Metal IPv6 address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the IPv6 subnet.
subnet_ipv6 str: A subnet from one of the IPv6 blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /126 or /127. * For a /127 block, it will only have two IP addresses, which will be used for the metalip and customerip. * For a /126 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.

virtualCircuitId String: ID of the virtual circuit to lookup
customerIpv6 String: The Customer IPv6 address which the CSR switch will peer with. Will default to the other usable IP in the IPv6 subnet.
metalIpv6 String: The Metal IPv6 address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the IPv6 subnet.
subnetIpv6 String: A subnet from one of the IPv6 blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /126 or /127. * For a /127 block, it will only have two IP addresses, which will be used for the metalip and customerip. * For a /126 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.

getVirtualCircuit Result

The following output properties are available:

ConnectionId string: UUID of Connection where the VC is scoped to
CustomerIp 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 of the virtual circuit
Id string: The provider-assigned unique ID for this managed resource.
Md5 string: The password that can be set for the VRF BGP peer
MetalIp 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
NniVlan int: Nni VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
NniVnid int: Nni VLAN ID parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
PeerAsn 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.
PortId string: UUID of the Connection Port where the VC is scoped to
ProjectId string: ID of the projct to which the virtual circuit belongs
Speed string: Description of the Virtual Circuit speed. This is for information purposes and is computed when the connection type is shared.
Status string: Status of the virtual 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 metalip and customerip. * 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.
Tags List<string>: Tags attached to the virtual circuit
VirtualCircuitId string: ID of the virtual circuit to lookup
VlanId string: UUID of the associated VLAN
Vnid int: VNID VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
VrfId string: UUID of the associated VRF
CustomerIpv6 string: The Customer IPv6 address which the CSR switch will peer with. Will default to the other usable IP in the IPv6 subnet.
MetalIpv6 string: The Metal IPv6 address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the IPv6 subnet.
SubnetIpv6 string: A subnet from one of the IPv6 blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /126 or /127. * For a /127 block, it will only have two IP addresses, which will be used for the metalip and customerip. * For a /126 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.

ConnectionId string: UUID of Connection where the VC is scoped to
CustomerIp 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 of the virtual circuit
Id string: The provider-assigned unique ID for this managed resource.
Md5 string: The password that can be set for the VRF BGP peer
MetalIp 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
NniVlan int: Nni VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
NniVnid int: Nni VLAN ID parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
PeerAsn 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.
PortId string: UUID of the Connection Port where the VC is scoped to
ProjectId string: ID of the projct to which the virtual circuit belongs
Speed string: Description of the Virtual Circuit speed. This is for information purposes and is computed when the connection type is shared.
Status string: Status of the virtual 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 metalip and customerip. * 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.
Tags []string: Tags attached to the virtual circuit
VirtualCircuitId string: ID of the virtual circuit to lookup
VlanId string: UUID of the associated VLAN
Vnid int: VNID VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
VrfId string: UUID of the associated VRF
CustomerIpv6 string: The Customer IPv6 address which the CSR switch will peer with. Will default to the other usable IP in the IPv6 subnet.
MetalIpv6 string: The Metal IPv6 address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the IPv6 subnet.
SubnetIpv6 string: A subnet from one of the IPv6 blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /126 or /127. * For a /127 block, it will only have two IP addresses, which will be used for the metalip and customerip. * For a /126 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.

connectionId String: UUID of Connection where the VC is scoped to
customerIp 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 of the virtual circuit
id String: The provider-assigned unique ID for this managed resource.
md5 String: The password that can be set for the VRF BGP peer
metalIp 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
nniVlan Integer: Nni VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
nniVnid Integer: Nni VLAN ID parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
peerAsn 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.
portId String: UUID of the Connection Port where the VC is scoped to
projectId String: ID of the projct to which the virtual circuit belongs
speed String: Description of the Virtual Circuit speed. This is for information purposes and is computed when the connection type is shared.
status String: Status of the virtual 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 metalip and customerip. * 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.
tags List<String>: Tags attached to the virtual circuit
virtualCircuitId String: ID of the virtual circuit to lookup
vlanId String: UUID of the associated VLAN
vnid Integer: VNID VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
vrfId String: UUID of the associated VRF
customerIpv6 String: The Customer IPv6 address which the CSR switch will peer with. Will default to the other usable IP in the IPv6 subnet.
metalIpv6 String: The Metal IPv6 address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the IPv6 subnet.
subnetIpv6 String: A subnet from one of the IPv6 blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /126 or /127. * For a /127 block, it will only have two IP addresses, which will be used for the metalip and customerip. * For a /126 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.

connectionId string: UUID of Connection where the VC is scoped to
customerIp 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 of the virtual circuit
id string: The provider-assigned unique ID for this managed resource.
md5 string: The password that can be set for the VRF BGP peer
metalIp 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
nniVlan number: Nni VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
nniVnid number: Nni VLAN ID parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
peerAsn 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.
portId string: UUID of the Connection Port where the VC is scoped to
projectId string: ID of the projct to which the virtual circuit belongs
speed string: Description of the Virtual Circuit speed. This is for information purposes and is computed when the connection type is shared.
status string: Status of the virtual 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 metalip and customerip. * 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.
tags string[]: Tags attached to the virtual circuit
virtualCircuitId string: ID of the virtual circuit to lookup
vlanId string: UUID of the associated VLAN
vnid number: VNID VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
vrfId string: UUID of the associated VRF
customerIpv6 string: The Customer IPv6 address which the CSR switch will peer with. Will default to the other usable IP in the IPv6 subnet.
metalIpv6 string: The Metal IPv6 address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the IPv6 subnet.
subnetIpv6 string: A subnet from one of the IPv6 blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /126 or /127. * For a /127 block, it will only have two IP addresses, which will be used for the metalip and customerip. * For a /126 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.

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 of the virtual circuit
id str: The provider-assigned unique ID for this managed 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
nni_vlan int: Nni VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
nni_vnid int: Nni VLAN ID parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
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: ID of the projct to which the virtual circuit belongs
speed str: Description of the Virtual Circuit speed. This is for information purposes and is computed when the connection type is shared.
status str: Status of the virtual 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 metalip and customerip. * 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.
tags Sequence[str]: Tags attached to the virtual circuit
virtual_circuit_id str: ID of the virtual circuit to lookup
vlan_id str: UUID of the associated VLAN
vnid int: VNID VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
vrf_id str: UUID of the associated VRF
customer_ipv6 str: The Customer IPv6 address which the CSR switch will peer with. Will default to the other usable IP in the IPv6 subnet.
metal_ipv6 str: The Metal IPv6 address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the IPv6 subnet.
subnet_ipv6 str: A subnet from one of the IPv6 blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /126 or /127. * For a /127 block, it will only have two IP addresses, which will be used for the metalip and customerip. * For a /126 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.

connectionId String: UUID of Connection where the VC is scoped to
customerIp 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 of the virtual circuit
id String: The provider-assigned unique ID for this managed resource.
md5 String: The password that can be set for the VRF BGP peer
metalIp 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
nniVlan Number: Nni VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
nniVnid Number: Nni VLAN ID parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
peerAsn 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.
portId String: UUID of the Connection Port where the VC is scoped to
projectId String: ID of the projct to which the virtual circuit belongs
speed String: Description of the Virtual Circuit speed. This is for information purposes and is computed when the connection type is shared.
status String: Status of the virtual 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 metalip and customerip. * 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.
tags List<String>: Tags attached to the virtual circuit
virtualCircuitId String: ID of the virtual circuit to lookup
vlanId String: UUID of the associated VLAN
vnid Number: VNID VLAN parameter, see https://deploy.equinix.com/developers/docs/metal/interconnections/introduction/
vrfId String: UUID of the associated VRF
customerIpv6 String: The Customer IPv6 address which the CSR switch will peer with. Will default to the other usable IP in the IPv6 subnet.
metalIpv6 String: The Metal IPv6 address for the SVI (Switch Virtual Interface) of the VirtualCircuit. Will default to the first usable IP in the IPv6 subnet.
subnetIpv6 String: A subnet from one of the IPv6 blocks associated with the VRF that we will help create an IP reservation for. Can only be either a /126 or /127. * For a /127 block, it will only have two IP addresses, which will be used for the metalip and customerip. * For a /126 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.

Package Details

Repository: equinix equinix/pulumi-equinix
License: Apache-2.0
Notes: This Pulumi package is based on the equinix Terraform Provider.

Equinix v0.21.0 published on Friday, Feb 28, 2025 by Equinix

equinix/pulumi-equinix

equinix.metal.getVirtualCircuit

On this page

On this page

Using getVirtualCircuit

getVirtualCircuit Result

Package Details

On this page

On this page