1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. getVrf
Viewing docs for Cisco IOS XE v0.0.1
published on Friday, Sep 22, 2023 by lbrlabs
Schema (JSON)
lbrlabs/pulumi-iosxe

iosxe.getVrf

iosxe logo
Viewing docs for Cisco IOS XE v0.0.1
published on Friday, Sep 22, 2023 by lbrlabs
Schema (JSON)
lbrlabs/pulumi-iosxe

    This data source can read the VRF configuration.

    Example Usage

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

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

});

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iosxe.LookupVrf(ctx, &iosxe.LookupVrfArgs{
			Name: "VRF22",
		}, 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.iosxe.IosxeFunctions;
import com.pulumi.iosxe.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 = IosxeFunctions.getVrf(GetVrfArgs.builder()
            .name("VRF22")
            .build());

    }
}

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

const example = iosxe.getVrf({
    name: "VRF22",
});

    import pulumi
import pulumi_iosxe as iosxe

example = iosxe.get_vrf(name="VRF22")

    variables:
  example:
    fn::invoke:
      Function: iosxe:getVrf
      Arguments:
        name: VRF22

    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)
public static Output<GetVrfResult> getVrf(GetVrfArgs args, InvokeOptions options)

    fn::invoke:
  function: iosxe:index/getVrf:getVrf
  arguments:
    # arguments dictionary

    The following arguments are supported:

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

    getVrf Result

    The following output properties are available:

    AddressFamilyIpv4 bool
    Address family
    AddressFamilyIpv6 bool
    Address family
    Description string
    VRF specific description
    Id string
    The path of the retrieved object.
    Ipv4RouteTargetExportStitchings List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetVrfIpv4RouteTargetExportStitching>
    Export Target-VPN community
    Ipv4RouteTargetExports List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetVrfIpv4RouteTargetExport>
    Export Target-VPN community
    Ipv4RouteTargetImportStitchings List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetVrfIpv4RouteTargetImportStitching>
    Import Target-VPN community
    Ipv4RouteTargetImports List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetVrfIpv4RouteTargetImport>
    Import Target-VPN community
    Ipv6RouteTargetExportStitchings List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetVrfIpv6RouteTargetExportStitching>
    Export Target-VPN community
    Ipv6RouteTargetExports List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetVrfIpv6RouteTargetExport>
    Export Target-VPN community
    Ipv6RouteTargetImportStitchings List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetVrfIpv6RouteTargetImportStitching>
    Import Target-VPN community
    Ipv6RouteTargetImports List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetVrfIpv6RouteTargetImport>
    Import Target-VPN community
    Name string
    WORD;;VRF name
    Rd string
    Specify Route Distinguisher
    RouteTargetExports List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetVrfRouteTargetExport>
    Export Target-VPN community
    RouteTargetImports List<Lbrlabs.PulumiPackage.Iosxe.Outputs.GetVrfRouteTargetImport>
    Import Target-VPN community
    VpnId string
    Configure VPN ID in rfc2685 format
    Device string
    A device name from the provider configuration.
    AddressFamilyIpv4 bool
    Address family
    AddressFamilyIpv6 bool
    Address family
    Description string
    VRF specific description
    Id string
    The path of the retrieved object.
    Ipv4RouteTargetExportStitchings []GetVrfIpv4RouteTargetExportStitching
    Export Target-VPN community
    Ipv4RouteTargetExports []GetVrfIpv4RouteTargetExport
    Export Target-VPN community
    Ipv4RouteTargetImportStitchings []GetVrfIpv4RouteTargetImportStitching
    Import Target-VPN community
    Ipv4RouteTargetImports []GetVrfIpv4RouteTargetImport
    Import Target-VPN community
    Ipv6RouteTargetExportStitchings []GetVrfIpv6RouteTargetExportStitching
    Export Target-VPN community
    Ipv6RouteTargetExports []GetVrfIpv6RouteTargetExport
    Export Target-VPN community
    Ipv6RouteTargetImportStitchings []GetVrfIpv6RouteTargetImportStitching
    Import Target-VPN community
    Ipv6RouteTargetImports []GetVrfIpv6RouteTargetImport
    Import Target-VPN community
    Name string
    WORD;;VRF name
    Rd string
    Specify Route Distinguisher
    RouteTargetExports []GetVrfRouteTargetExport
    Export Target-VPN community
    RouteTargetImports []GetVrfRouteTargetImport
    Import Target-VPN community
    VpnId string
    Configure VPN ID in rfc2685 format
    Device string
    A device name from the provider configuration.
    addressFamilyIpv4 Boolean
    Address family
    addressFamilyIpv6 Boolean
    Address family
    description String
    VRF specific description
    id String
    The path of the retrieved object.
    ipv4RouteTargetExportStitchings List<GetVrfIpv4RouteTargetExportStitching>
    Export Target-VPN community
    ipv4RouteTargetExports List<GetVrfIpv4RouteTargetExport>
    Export Target-VPN community
    ipv4RouteTargetImportStitchings List<GetVrfIpv4RouteTargetImportStitching>
    Import Target-VPN community
    ipv4RouteTargetImports List<GetVrfIpv4RouteTargetImport>
    Import Target-VPN community
    ipv6RouteTargetExportStitchings List<GetVrfIpv6RouteTargetExportStitching>
    Export Target-VPN community
    ipv6RouteTargetExports List<GetVrfIpv6RouteTargetExport>
    Export Target-VPN community
    ipv6RouteTargetImportStitchings List<GetVrfIpv6RouteTargetImportStitching>
    Import Target-VPN community
    ipv6RouteTargetImports List<GetVrfIpv6RouteTargetImport>
    Import Target-VPN community
    name String
    WORD;;VRF name
    rd String
    Specify Route Distinguisher
    routeTargetExports List<GetVrfRouteTargetExport>
    Export Target-VPN community
    routeTargetImports List<GetVrfRouteTargetImport>
    Import Target-VPN community
    vpnId String
    Configure VPN ID in rfc2685 format
    device String
    A device name from the provider configuration.
    addressFamilyIpv4 boolean
    Address family
    addressFamilyIpv6 boolean
    Address family
    description string
    VRF specific description
    id string
    The path of the retrieved object.
    ipv4RouteTargetExportStitchings GetVrfIpv4RouteTargetExportStitching[]
    Export Target-VPN community
    ipv4RouteTargetExports GetVrfIpv4RouteTargetExport[]
    Export Target-VPN community
    ipv4RouteTargetImportStitchings GetVrfIpv4RouteTargetImportStitching[]
    Import Target-VPN community
    ipv4RouteTargetImports GetVrfIpv4RouteTargetImport[]
    Import Target-VPN community
    ipv6RouteTargetExportStitchings GetVrfIpv6RouteTargetExportStitching[]
    Export Target-VPN community
    ipv6RouteTargetExports GetVrfIpv6RouteTargetExport[]
    Export Target-VPN community
    ipv6RouteTargetImportStitchings GetVrfIpv6RouteTargetImportStitching[]
    Import Target-VPN community
    ipv6RouteTargetImports GetVrfIpv6RouteTargetImport[]
    Import Target-VPN community
    name string
    WORD;;VRF name
    rd string
    Specify Route Distinguisher
    routeTargetExports GetVrfRouteTargetExport[]
    Export Target-VPN community
    routeTargetImports GetVrfRouteTargetImport[]
    Import Target-VPN community
    vpnId string
    Configure VPN ID in rfc2685 format
    device string
    A device name from the provider configuration.
    address_family_ipv4 bool
    Address family
    address_family_ipv6 bool
    Address family
    description str
    VRF specific description
    id str
    The path of the retrieved object.
    ipv4_route_target_export_stitchings Sequence[GetVrfIpv4RouteTargetExportStitching]
    Export Target-VPN community
    ipv4_route_target_exports Sequence[GetVrfIpv4RouteTargetExport]
    Export Target-VPN community
    ipv4_route_target_import_stitchings Sequence[GetVrfIpv4RouteTargetImportStitching]
    Import Target-VPN community
    ipv4_route_target_imports Sequence[GetVrfIpv4RouteTargetImport]
    Import Target-VPN community
    ipv6_route_target_export_stitchings Sequence[GetVrfIpv6RouteTargetExportStitching]
    Export Target-VPN community
    ipv6_route_target_exports Sequence[GetVrfIpv6RouteTargetExport]
    Export Target-VPN community
    ipv6_route_target_import_stitchings Sequence[GetVrfIpv6RouteTargetImportStitching]
    Import Target-VPN community
    ipv6_route_target_imports Sequence[GetVrfIpv6RouteTargetImport]
    Import Target-VPN community
    name str
    WORD;;VRF name
    rd str
    Specify Route Distinguisher
    route_target_exports Sequence[GetVrfRouteTargetExport]
    Export Target-VPN community
    route_target_imports Sequence[GetVrfRouteTargetImport]
    Import Target-VPN community
    vpn_id str
    Configure VPN ID in rfc2685 format
    device str
    A device name from the provider configuration.
    addressFamilyIpv4 Boolean
    Address family
    addressFamilyIpv6 Boolean
    Address family
    description String
    VRF specific description
    id String
    The path of the retrieved object.
    ipv4RouteTargetExportStitchings List<Property Map>
    Export Target-VPN community
    ipv4RouteTargetExports List<Property Map>
    Export Target-VPN community
    ipv4RouteTargetImportStitchings List<Property Map>
    Import Target-VPN community
    ipv4RouteTargetImports List<Property Map>
    Import Target-VPN community
    ipv6RouteTargetExportStitchings List<Property Map>
    Export Target-VPN community
    ipv6RouteTargetExports List<Property Map>
    Export Target-VPN community
    ipv6RouteTargetImportStitchings List<Property Map>
    Import Target-VPN community
    ipv6RouteTargetImports List<Property Map>
    Import Target-VPN community
    name String
    WORD;;VRF name
    rd String
    Specify Route Distinguisher
    routeTargetExports List<Property Map>
    Export Target-VPN community
    routeTargetImports List<Property Map>
    Import Target-VPN community
    vpnId String
    Configure VPN ID in rfc2685 format
    device String
    A device name from the provider configuration.

    Supporting Types

    GetVrfIpv4RouteTargetExport

    Value string
    Value
    Value string
    Value
    value String
    Value
    value string
    Value
    value str
    Value
    value String
    Value

    GetVrfIpv4RouteTargetExportStitching

    Stitching bool
    VXLAN route target set
    Value string
    Value
    Stitching bool
    VXLAN route target set
    Value string
    Value
    stitching Boolean
    VXLAN route target set
    value String
    Value
    stitching boolean
    VXLAN route target set
    value string
    Value
    stitching bool
    VXLAN route target set
    value str
    Value
    stitching Boolean
    VXLAN route target set
    value String
    Value

    GetVrfIpv4RouteTargetImport

    Value string
    Value
    Value string
    Value
    value String
    Value
    value string
    Value
    value str
    Value
    value String
    Value

    GetVrfIpv4RouteTargetImportStitching

    Stitching bool
    VXLAN route target set
    Value string
    Value
    Stitching bool
    VXLAN route target set
    Value string
    Value
    stitching Boolean
    VXLAN route target set
    value String
    Value
    stitching boolean
    VXLAN route target set
    value string
    Value
    stitching bool
    VXLAN route target set
    value str
    Value
    stitching Boolean
    VXLAN route target set
    value String
    Value

    GetVrfIpv6RouteTargetExport

    Value string
    Value
    Value string
    Value
    value String
    Value
    value string
    Value
    value str
    Value
    value String
    Value

    GetVrfIpv6RouteTargetExportStitching

    Stitching bool
    VXLAN route target set
    Value string
    Value
    Stitching bool
    VXLAN route target set
    Value string
    Value
    stitching Boolean
    VXLAN route target set
    value String
    Value
    stitching boolean
    VXLAN route target set
    value string
    Value
    stitching bool
    VXLAN route target set
    value str
    Value
    stitching Boolean
    VXLAN route target set
    value String
    Value

    GetVrfIpv6RouteTargetImport

    Value string
    Value
    Value string
    Value
    value String
    Value
    value string
    Value
    value str
    Value
    value String
    Value

    GetVrfIpv6RouteTargetImportStitching

    Stitching bool
    VXLAN route target set
    Value string
    Value
    Stitching bool
    VXLAN route target set
    Value string
    Value
    stitching Boolean
    VXLAN route target set
    value String
    Value
    stitching boolean
    VXLAN route target set
    value string
    Value
    stitching bool
    VXLAN route target set
    value str
    Value
    stitching Boolean
    VXLAN route target set
    value String
    Value

    GetVrfRouteTargetExport

    Stitching bool
    VXLAN route target set
    Value string
    Value
    Stitching bool
    VXLAN route target set
    Value string
    Value
    stitching Boolean
    VXLAN route target set
    value String
    Value
    stitching boolean
    VXLAN route target set
    value string
    Value
    stitching bool
    VXLAN route target set
    value str
    Value
    stitching Boolean
    VXLAN route target set
    value String
    Value

    GetVrfRouteTargetImport

    Stitching bool
    VXLAN route target set
    Value string
    Value
    Stitching bool
    VXLAN route target set
    Value string
    Value
    stitching Boolean
    VXLAN route target set
    value String
    Value
    stitching boolean
    VXLAN route target set
    value string
    Value
    stitching bool
    VXLAN route target set
    value str
    Value
    stitching Boolean
    VXLAN route target set
    value String
    Value

    Package Details

    Repository
    iosxe lbrlabs/pulumi-iosxe
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the iosxe Terraform Provider.
    iosxe logo
    Viewing docs for Cisco IOS XE v0.0.1
    published on Friday, Sep 22, 2023 by lbrlabs
    Schema (JSON)
    lbrlabs/pulumi-iosxe
      Try Pulumi Cloud free. Your team will thank you.