1. Packages
  2. Equinix
  3. API Docs
  4. metal
  5. getVirtualCircuit
Equinix v0.10.0 published on Wednesday, May 22, 2024 by Equinix

equinix.metal.getVirtualCircuit

Explore with Pulumi AI

equinix logo
Equinix v0.10.0 published on Wednesday, May 22, 2024 by Equinix

    Use this data source to retrieve a virtual circuit resource from Equinix Fabric - software-defined interconnections

    See the Virtual Routing and Forwarding documentation for product details and API reference material.

    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.

    function getVirtualCircuit(args: GetVirtualCircuitArgs, opts?: InvokeOptions): Promise<GetVirtualCircuitResult>
    function getVirtualCircuitOutput(args: GetVirtualCircuitOutputArgs, opts?: InvokeOptions): Output<GetVirtualCircuitResult>
    def get_virtual_circuit(virtual_circuit_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetVirtualCircuitResult
    def get_virtual_circuit_output(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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: equinix:metal/getVirtualCircuit:getVirtualCircuit
      arguments:
        # arguments dictionary

    The following arguments are supported:

    VirtualCircuitId string
    ID of the virtual circuit resource
    VirtualCircuitId string
    ID of the virtual circuit resource
    virtualCircuitId String
    ID of the virtual circuit resource
    virtualCircuitId string
    ID of the virtual circuit resource
    virtual_circuit_id str
    ID of the virtual circuit resource
    virtualCircuitId String
    ID of the virtual circuit resource

    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 for the Virtual Circuit resource.
    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 resource.
    NniVlan int
    NniVnid int
    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 project to which the VC belongs.
    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.
    Tags List<string>
    Tags for the Virtual Circuit resource.
    VirtualCircuitId string
    VlanId string
    Vnid int
    , nni_vlan, nni_nvid - VLAN parameters, see the documentation for Equinix Fabric.
    VrfId string
    UUID of the VLAN to associate.
    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 for the Virtual Circuit resource.
    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 resource.
    NniVlan int
    NniVnid int
    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 project to which the VC belongs.
    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.
    Tags []string
    Tags for the Virtual Circuit resource.
    VirtualCircuitId string
    VlanId string
    Vnid int
    , nni_vlan, nni_nvid - VLAN parameters, see the documentation for Equinix Fabric.
    VrfId string
    UUID of the VLAN to associate.
    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 for the Virtual Circuit resource.
    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 resource.
    nniVlan Integer
    nniVnid Integer
    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 project to which the VC belongs.
    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.
    tags List<String>
    Tags for the Virtual Circuit resource.
    virtualCircuitId String
    vlanId String
    vnid Integer
    , nni_vlan, nni_nvid - VLAN parameters, see the documentation for Equinix Fabric.
    vrfId String
    UUID of the VLAN to associate.
    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 for the Virtual Circuit resource.
    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 resource.
    nniVlan number
    nniVnid number
    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 project to which the VC belongs.
    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.
    tags string[]
    Tags for the Virtual Circuit resource.
    virtualCircuitId string
    vlanId string
    vnid number
    , nni_vlan, nni_nvid - VLAN parameters, see the documentation for Equinix Fabric.
    vrfId string
    UUID of the VLAN 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.
    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 resource.
    nni_vlan int
    nni_vnid int
    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 project to which the VC belongs.
    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.
    tags Sequence[str]
    Tags for the Virtual Circuit resource.
    virtual_circuit_id str
    vlan_id str
    vnid int
    , nni_vlan, nni_nvid - VLAN parameters, see the documentation for Equinix Fabric.
    vrf_id str
    UUID of the VLAN to associate.
    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 for the Virtual Circuit resource.
    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 resource.
    nniVlan Number
    nniVnid Number
    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 project to which the VC belongs.
    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.
    tags List<String>
    Tags for the Virtual Circuit resource.
    virtualCircuitId String
    vlanId String
    vnid Number
    , nni_vlan, nni_nvid - VLAN parameters, see the documentation for Equinix Fabric.
    vrfId String
    UUID of the VLAN to associate.

    Package Details

    Repository
    equinix equinix/pulumi-equinix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the equinix Terraform Provider.
    equinix logo
    Equinix v0.10.0 published on Wednesday, May 22, 2024 by Equinix