Docs Packages
  1. Packages
  2. Cisco NX OS Resource Provider
  3. API Docs
  4. getVrf
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

nxos.getVrf

Explore with Pulumi AI

nxos logo
Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
lbrlabs/pulumi-nxos

    This data source can read a VRF.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nxos = Pulumi.Nxos;

return await Deployment.RunAsync(() => 
{
    var example = Nxos.GetVrf.Invoke(new()
    {
        Name = "VRF1",
    });

});

    package main

import (
	"github.com/lbrlabs/pulumi-nxos/sdk/go/nxos"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nxos.LookupVrf(ctx, &nxos.LookupVrfArgs{
			Name: "VRF1",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nxos.NxosFunctions;
import com.pulumi.nxos.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 example = NxosFunctions.getVrf(GetVrfArgs.builder()
            .name("VRF1")
            .build());

    }
}

    import pulumi
import pulumi_nxos as nxos

example = nxos.get_vrf(name="VRF1")

    import * as pulumi from "@pulumi/pulumi";
import * as nxos from "@pulumi/nxos";

const example = nxos.getVrf({
    name: "VRF1",
});

    variables:
  example:
    fn::invoke:
      Function: nxos:getVrf
      Arguments:
        name: VRF1

    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(device: Optional[str] = None,
            name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetVrfResult
def get_vrf_output(device: Optional[pulumi.Input[str]] = None,
            name: 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: nxos:index/getVrf:getVrf
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    VRF name.
    Device string
    A device name from the provider configuration.
    Name string
    VRF name.
    Device string
    A device name from the provider configuration.
    name String
    VRF name.
    device String
    A device name from the provider configuration.
    name string
    VRF name.
    device string
    A device name from the provider configuration.
    name str
    VRF name.
    device str
    A device name from the provider configuration.
    name String
    VRF name.
    device String
    A device name from the provider configuration.

    getVrf Result

    The following output properties are available:

    Description string
    VRF description.
    Encap string
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d.
    Id string
    The distinguished name of the object.
    Name string
    VRF name.
    Device string
    A device name from the provider configuration.
    Description string
    VRF description.
    Encap string
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d.
    Id string
    The distinguished name of the object.
    Name string
    VRF name.
    Device string
    A device name from the provider configuration.
    description String
    VRF description.
    encap String
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d.
    id String
    The distinguished name of the object.
    name String
    VRF name.
    device String
    A device name from the provider configuration.
    description string
    VRF description.
    encap string
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d.
    id string
    The distinguished name of the object.
    name string
    VRF name.
    device string
    A device name from the provider configuration.
    description str
    VRF description.
    encap str
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d.
    id str
    The distinguished name of the object.
    name str
    VRF name.
    device str
    A device name from the provider configuration.
    description String
    VRF description.
    encap String
    Encap for this Context, supported formats: unknown, vlan-%d or vxlan-%d.
    id String
    The distinguished name of the object.
    name String
    VRF name.
    device String
    A device name from the provider configuration.

    Package Details

    Repository
    nxos lbrlabs/pulumi-nxos
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the nxos Terraform Provider.
    nxos logo
    Cisco NX-OS v0.0.2 published on Friday, Sep 29, 2023 by lbrlabs
    lbrlabs/pulumi-nxos