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

nxos.getVrfRouteTarget

Explore with Pulumi AI

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

    This data source can read a VRF Route Target Entry.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Pulumi.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Nxos.GetVrfRouteTarget.Invoke(new()
        {
            AddressFamily = "ipv4-ucast",
            Direction = "import",
            RouteTarget = "route-target:as2-nn2:2:2",
            RouteTargetAddressFamily = "ipv4-ucast",
            Vrf = "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.LookupVrfRouteTarget(ctx, &nxos.LookupVrfRouteTargetArgs{
    			AddressFamily:            "ipv4-ucast",
    			Direction:                "import",
    			RouteTarget:              "route-target:as2-nn2:2:2",
    			RouteTargetAddressFamily: "ipv4-ucast",
    			Vrf:                      "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.GetVrfRouteTargetArgs;
    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.getVrfRouteTarget(GetVrfRouteTargetArgs.builder()
                .addressFamily("ipv4-ucast")
                .direction("import")
                .routeTarget("route-target:as2-nn2:2:2")
                .routeTargetAddressFamily("ipv4-ucast")
                .vrf("VRF1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_nxos as nxos
    
    example = nxos.get_vrf_route_target(address_family="ipv4-ucast",
        direction="import",
        route_target="route-target:as2-nn2:2:2",
        route_target_address_family="ipv4-ucast",
        vrf="VRF1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@pulumi/nxos";
    
    const example = nxos.getVrfRouteTarget({
        addressFamily: "ipv4-ucast",
        direction: "import",
        routeTarget: "route-target:as2-nn2:2:2",
        routeTargetAddressFamily: "ipv4-ucast",
        vrf: "VRF1",
    });
    
    variables:
      example:
        fn::invoke:
          Function: nxos:getVrfRouteTarget
          Arguments:
            addressFamily: ipv4-ucast
            direction: import
            routeTarget: route-target:as2-nn2:2:2
            routeTargetAddressFamily: ipv4-ucast
            vrf: VRF1
    

    Using getVrfRouteTarget

    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 getVrfRouteTarget(args: GetVrfRouteTargetArgs, opts?: InvokeOptions): Promise<GetVrfRouteTargetResult>
    function getVrfRouteTargetOutput(args: GetVrfRouteTargetOutputArgs, opts?: InvokeOptions): Output<GetVrfRouteTargetResult>
    def get_vrf_route_target(address_family: Optional[str] = None,
                             device: Optional[str] = None,
                             direction: Optional[str] = None,
                             route_target: Optional[str] = None,
                             route_target_address_family: Optional[str] = None,
                             vrf: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetVrfRouteTargetResult
    def get_vrf_route_target_output(address_family: Optional[pulumi.Input[str]] = None,
                             device: Optional[pulumi.Input[str]] = None,
                             direction: Optional[pulumi.Input[str]] = None,
                             route_target: Optional[pulumi.Input[str]] = None,
                             route_target_address_family: Optional[pulumi.Input[str]] = None,
                             vrf: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetVrfRouteTargetResult]
    func LookupVrfRouteTarget(ctx *Context, args *LookupVrfRouteTargetArgs, opts ...InvokeOption) (*LookupVrfRouteTargetResult, error)
    func LookupVrfRouteTargetOutput(ctx *Context, args *LookupVrfRouteTargetOutputArgs, opts ...InvokeOption) LookupVrfRouteTargetResultOutput

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

    public static class GetVrfRouteTarget 
    {
        public static Task<GetVrfRouteTargetResult> InvokeAsync(GetVrfRouteTargetArgs args, InvokeOptions? opts = null)
        public static Output<GetVrfRouteTargetResult> Invoke(GetVrfRouteTargetInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVrfRouteTargetResult> getVrfRouteTarget(GetVrfRouteTargetArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: nxos:index/getVrfRouteTarget:getVrfRouteTarget
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AddressFamily string
    Address family.
    Direction string
    Route Target direction.
    RouteTarget string
    Route Target in NX-OS DME format.
    RouteTargetAddressFamily string
    Route Target Address Family.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    AddressFamily string
    Address family.
    Direction string
    Route Target direction.
    RouteTarget string
    Route Target in NX-OS DME format.
    RouteTargetAddressFamily string
    Route Target Address Family.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    addressFamily String
    Address family.
    direction String
    Route Target direction.
    routeTarget String
    Route Target in NX-OS DME format.
    routeTargetAddressFamily String
    Route Target Address Family.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    addressFamily string
    Address family.
    direction string
    Route Target direction.
    routeTarget string
    Route Target in NX-OS DME format.
    routeTargetAddressFamily string
    Route Target Address Family.
    vrf string
    VRF name.
    device string
    A device name from the provider configuration.
    address_family str
    Address family.
    direction str
    Route Target direction.
    route_target str
    Route Target in NX-OS DME format.
    route_target_address_family str
    Route Target Address Family.
    vrf str
    VRF name.
    device str
    A device name from the provider configuration.
    addressFamily String
    Address family.
    direction String
    Route Target direction.
    routeTarget String
    Route Target in NX-OS DME format.
    routeTargetAddressFamily String
    Route Target Address Family.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.

    getVrfRouteTarget Result

    The following output properties are available:

    AddressFamily string
    Address family.
    Direction string
    Route Target direction.
    Id string
    The distinguished name of the object.
    RouteTarget string
    Route Target in NX-OS DME format.
    RouteTargetAddressFamily string
    Route Target Address Family.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    AddressFamily string
    Address family.
    Direction string
    Route Target direction.
    Id string
    The distinguished name of the object.
    RouteTarget string
    Route Target in NX-OS DME format.
    RouteTargetAddressFamily string
    Route Target Address Family.
    Vrf string
    VRF name.
    Device string
    A device name from the provider configuration.
    addressFamily String
    Address family.
    direction String
    Route Target direction.
    id String
    The distinguished name of the object.
    routeTarget String
    Route Target in NX-OS DME format.
    routeTargetAddressFamily String
    Route Target Address Family.
    vrf String
    VRF name.
    device String
    A device name from the provider configuration.
    addressFamily string
    Address family.
    direction string
    Route Target direction.
    id string
    The distinguished name of the object.
    routeTarget string
    Route Target in NX-OS DME format.
    routeTargetAddressFamily string
    Route Target Address Family.
    vrf string
    VRF name.
    device string
    A device name from the provider configuration.
    address_family str
    Address family.
    direction str
    Route Target direction.
    id str
    The distinguished name of the object.
    route_target str
    Route Target in NX-OS DME format.
    route_target_address_family str
    Route Target Address Family.
    vrf str
    VRF name.
    device str
    A device name from the provider configuration.
    addressFamily String
    Address family.
    direction String
    Route Target direction.
    id String
    The distinguished name of the object.
    routeTarget String
    Route Target in NX-OS DME format.
    routeTargetAddressFamily String
    Route Target Address Family.
    vrf 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