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

equinix.metal.getVrf

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 VRF resource.

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as equinix from "@pulumi/equinix";
    
    const exampleVrf = equinix.metal.getVrf({
        vrfId: "48630899-9ff2-4ce6-a93f-50ff4ebcdf6e",
    });
    
    import pulumi
    import pulumi_equinix as equinix
    
    example_vrf = equinix.metal.get_vrf(vrf_id="48630899-9ff2-4ce6-a93f-50ff4ebcdf6e")
    
    package main
    
    import (
    	"github.com/equinix/pulumi-equinix/sdk/go/equinix/metal"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := metal.LookupVrf(ctx, &metal.LookupVrfArgs{
    			VrfId: "48630899-9ff2-4ce6-a93f-50ff4ebcdf6e",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Equinix = Pulumi.Equinix;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleVrf = Equinix.Metal.GetVrf.Invoke(new()
        {
            VrfId = "48630899-9ff2-4ce6-a93f-50ff4ebcdf6e",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.equinix.metal.MetalFunctions;
    import com.pulumi.equinix.metal.inputs.GetVrfArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var exampleVrf = MetalFunctions.getVrf(GetVrfArgs.builder()
                .vrfId("48630899-9ff2-4ce6-a93f-50ff4ebcdf6e")
                .build());
    
        }
    }
    
    variables:
      exampleVrf:
        fn::invoke:
          Function: equinix:metal:getVrf
          Arguments:
            vrfId: 48630899-9ff2-4ce6-a93f-50ff4ebcdf6e
    

    Using getVrf

    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 getVrf(args: GetVrfArgs, opts?: InvokeOptions): Promise<GetVrfResult>
    function getVrfOutput(args: GetVrfOutputArgs, opts?: InvokeOptions): Output<GetVrfResult>
    def get_vrf(vrf_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetVrfResult
    def get_vrf_output(vrf_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetVrfResult]
    func LookupVrf(ctx *Context, args *LookupVrfArgs, opts ...InvokeOption) (*LookupVrfResult, error)
    func LookupVrfOutput(ctx *Context, args *LookupVrfOutputArgs, opts ...InvokeOption) LookupVrfResultOutput

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

    public static class GetVrf 
    {
        public static Task<GetVrfResult> InvokeAsync(GetVrfArgs args, InvokeOptions? opts = null)
        public static Output<GetVrfResult> Invoke(GetVrfInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVrfResult> getVrf(GetVrfArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: equinix:metal/getVrf:getVrf
      arguments:
        # arguments dictionary

    The following arguments are supported:

    VrfId string
    ID of the VRF resource
    VrfId string
    ID of the VRF resource
    vrfId String
    ID of the VRF resource
    vrfId string
    ID of the VRF resource
    vrf_id str
    ID of the VRF resource
    vrfId String
    ID of the VRF resource

    getVrf Result

    The following output properties are available:

    Description string
    Description of the VRF.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpRanges List<string>
    All IPv4 and IPv6 Ranges that will be available to BGP Peers. IPv4 addresses must be /8 or smaller with a minimum size of /29. IPv6 must be /56 or smaller with a minimum size of /64. Ranges must not overlap other ranges within the VRF.
    LocalAsn int
    The 4-byte ASN set on the VRF.
    Metro string
    Metro ID or Code where the VRF will be deployed.
    Name string
    User-supplied name of the VRF, unique to the project
    ProjectId string
    Project ID where the VRF will be deployed.
    VrfId string
    Description string
    Description of the VRF.
    Id string
    The provider-assigned unique ID for this managed resource.
    IpRanges []string
    All IPv4 and IPv6 Ranges that will be available to BGP Peers. IPv4 addresses must be /8 or smaller with a minimum size of /29. IPv6 must be /56 or smaller with a minimum size of /64. Ranges must not overlap other ranges within the VRF.
    LocalAsn int
    The 4-byte ASN set on the VRF.
    Metro string
    Metro ID or Code where the VRF will be deployed.
    Name string
    User-supplied name of the VRF, unique to the project
    ProjectId string
    Project ID where the VRF will be deployed.
    VrfId string
    description String
    Description of the VRF.
    id String
    The provider-assigned unique ID for this managed resource.
    ipRanges List<String>
    All IPv4 and IPv6 Ranges that will be available to BGP Peers. IPv4 addresses must be /8 or smaller with a minimum size of /29. IPv6 must be /56 or smaller with a minimum size of /64. Ranges must not overlap other ranges within the VRF.
    localAsn Integer
    The 4-byte ASN set on the VRF.
    metro String
    Metro ID or Code where the VRF will be deployed.
    name String
    User-supplied name of the VRF, unique to the project
    projectId String
    Project ID where the VRF will be deployed.
    vrfId String
    description string
    Description of the VRF.
    id string
    The provider-assigned unique ID for this managed resource.
    ipRanges string[]
    All IPv4 and IPv6 Ranges that will be available to BGP Peers. IPv4 addresses must be /8 or smaller with a minimum size of /29. IPv6 must be /56 or smaller with a minimum size of /64. Ranges must not overlap other ranges within the VRF.
    localAsn number
    The 4-byte ASN set on the VRF.
    metro string
    Metro ID or Code where the VRF will be deployed.
    name string
    User-supplied name of the VRF, unique to the project
    projectId string
    Project ID where the VRF will be deployed.
    vrfId string
    description str
    Description of the VRF.
    id str
    The provider-assigned unique ID for this managed resource.
    ip_ranges Sequence[str]
    All IPv4 and IPv6 Ranges that will be available to BGP Peers. IPv4 addresses must be /8 or smaller with a minimum size of /29. IPv6 must be /56 or smaller with a minimum size of /64. Ranges must not overlap other ranges within the VRF.
    local_asn int
    The 4-byte ASN set on the VRF.
    metro str
    Metro ID or Code where the VRF will be deployed.
    name str
    User-supplied name of the VRF, unique to the project
    project_id str
    Project ID where the VRF will be deployed.
    vrf_id str
    description String
    Description of the VRF.
    id String
    The provider-assigned unique ID for this managed resource.
    ipRanges List<String>
    All IPv4 and IPv6 Ranges that will be available to BGP Peers. IPv4 addresses must be /8 or smaller with a minimum size of /29. IPv6 must be /56 or smaller with a minimum size of /64. Ranges must not overlap other ranges within the VRF.
    localAsn Number
    The 4-byte ASN set on the VRF.
    metro String
    Metro ID or Code where the VRF will be deployed.
    name String
    User-supplied name of the VRF, unique to the project
    projectId String
    Project ID where the VRF will be deployed.
    vrfId String

    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