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

nxos.EvpnVniRouteTarget

Explore with Pulumi AI

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

    This resource can manage a EVPN VNI Route Target Entry.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Lbrlabs.PulumiPackage.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Nxos.EvpnVniRouteTarget("example", new()
        {
            Direction = "import",
            Encap = "vxlan-123456",
            RouteTarget = "route-target:as2-nn2:2:2",
        });
    
    });
    
    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.NewEvpnVniRouteTarget(ctx, "example", &nxos.EvpnVniRouteTargetArgs{
    			Direction:   pulumi.String("import"),
    			Encap:       pulumi.String("vxlan-123456"),
    			RouteTarget: pulumi.String("route-target:as2-nn2:2:2"),
    		})
    		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.EvpnVniRouteTarget;
    import com.pulumi.nxos.EvpnVniRouteTargetArgs;
    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) {
            var example = new EvpnVniRouteTarget("example", EvpnVniRouteTargetArgs.builder()        
                .direction("import")
                .encap("vxlan-123456")
                .routeTarget("route-target:as2-nn2:2:2")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.EvpnVniRouteTarget("example",
        direction="import",
        encap="vxlan-123456",
        route_target="route-target:as2-nn2:2:2")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.EvpnVniRouteTarget("example", {
        direction: "import",
        encap: "vxlan-123456",
        routeTarget: "route-target:as2-nn2:2:2",
    });
    
    resources:
      example:
        type: nxos:EvpnVniRouteTarget
        properties:
          direction: import
          encap: vxlan-123456
          routeTarget: route-target:as2-nn2:2:2
    

    Create EvpnVniRouteTarget Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EvpnVniRouteTarget(name: string, args: EvpnVniRouteTargetArgs, opts?: CustomResourceOptions);
    @overload
    def EvpnVniRouteTarget(resource_name: str,
                           args: EvpnVniRouteTargetArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def EvpnVniRouteTarget(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           direction: Optional[str] = None,
                           encap: Optional[str] = None,
                           route_target: Optional[str] = None,
                           device: Optional[str] = None)
    func NewEvpnVniRouteTarget(ctx *Context, name string, args EvpnVniRouteTargetArgs, opts ...ResourceOption) (*EvpnVniRouteTarget, error)
    public EvpnVniRouteTarget(string name, EvpnVniRouteTargetArgs args, CustomResourceOptions? opts = null)
    public EvpnVniRouteTarget(String name, EvpnVniRouteTargetArgs args)
    public EvpnVniRouteTarget(String name, EvpnVniRouteTargetArgs args, CustomResourceOptions options)
    
    type: nxos:EvpnVniRouteTarget
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args EvpnVniRouteTargetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EvpnVniRouteTargetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EvpnVniRouteTargetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EvpnVniRouteTargetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EvpnVniRouteTargetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var evpnVniRouteTargetResource = new Nxos.EvpnVniRouteTarget("evpnVniRouteTargetResource", new()
    {
        Direction = "string",
        Encap = "string",
        RouteTarget = "string",
        Device = "string",
    });
    
    example, err := nxos.NewEvpnVniRouteTarget(ctx, "evpnVniRouteTargetResource", &nxos.EvpnVniRouteTargetArgs{
    	Direction:   pulumi.String("string"),
    	Encap:       pulumi.String("string"),
    	RouteTarget: pulumi.String("string"),
    	Device:      pulumi.String("string"),
    })
    
    var evpnVniRouteTargetResource = new EvpnVniRouteTarget("evpnVniRouteTargetResource", EvpnVniRouteTargetArgs.builder()        
        .direction("string")
        .encap("string")
        .routeTarget("string")
        .device("string")
        .build());
    
    evpn_vni_route_target_resource = nxos.EvpnVniRouteTarget("evpnVniRouteTargetResource",
        direction="string",
        encap="string",
        route_target="string",
        device="string")
    
    const evpnVniRouteTargetResource = new nxos.EvpnVniRouteTarget("evpnVniRouteTargetResource", {
        direction: "string",
        encap: "string",
        routeTarget: "string",
        device: "string",
    });
    
    type: nxos:EvpnVniRouteTarget
    properties:
        device: string
        direction: string
        encap: string
        routeTarget: string
    

    EvpnVniRouteTarget Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The EvpnVniRouteTarget resource accepts the following input properties:

    Direction string
    Route Target direction. - Choices: import, export
    Encap string
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    RouteTarget string
    Route Target in NX-OS DME format.
    Device string
    A device name from the provider configuration.
    Direction string
    Route Target direction. - Choices: import, export
    Encap string
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    RouteTarget string
    Route Target in NX-OS DME format.
    Device string
    A device name from the provider configuration.
    direction String
    Route Target direction. - Choices: import, export
    encap String
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    routeTarget String
    Route Target in NX-OS DME format.
    device String
    A device name from the provider configuration.
    direction string
    Route Target direction. - Choices: import, export
    encap string
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    routeTarget string
    Route Target in NX-OS DME format.
    device string
    A device name from the provider configuration.
    direction str
    Route Target direction. - Choices: import, export
    encap str
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    route_target str
    Route Target in NX-OS DME format.
    device str
    A device name from the provider configuration.
    direction String
    Route Target direction. - Choices: import, export
    encap String
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    routeTarget String
    Route Target in NX-OS DME format.
    device String
    A device name from the provider configuration.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EvpnVniRouteTarget resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EvpnVniRouteTarget Resource

    Get an existing EvpnVniRouteTarget resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EvpnVniRouteTargetState, opts?: CustomResourceOptions): EvpnVniRouteTarget
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            device: Optional[str] = None,
            direction: Optional[str] = None,
            encap: Optional[str] = None,
            route_target: Optional[str] = None) -> EvpnVniRouteTarget
    func GetEvpnVniRouteTarget(ctx *Context, name string, id IDInput, state *EvpnVniRouteTargetState, opts ...ResourceOption) (*EvpnVniRouteTarget, error)
    public static EvpnVniRouteTarget Get(string name, Input<string> id, EvpnVniRouteTargetState? state, CustomResourceOptions? opts = null)
    public static EvpnVniRouteTarget get(String name, Output<String> id, EvpnVniRouteTargetState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Device string
    A device name from the provider configuration.
    Direction string
    Route Target direction. - Choices: import, export
    Encap string
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    RouteTarget string
    Route Target in NX-OS DME format.
    Device string
    A device name from the provider configuration.
    Direction string
    Route Target direction. - Choices: import, export
    Encap string
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    RouteTarget string
    Route Target in NX-OS DME format.
    device String
    A device name from the provider configuration.
    direction String
    Route Target direction. - Choices: import, export
    encap String
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    routeTarget String
    Route Target in NX-OS DME format.
    device string
    A device name from the provider configuration.
    direction string
    Route Target direction. - Choices: import, export
    encap string
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    routeTarget string
    Route Target in NX-OS DME format.
    device str
    A device name from the provider configuration.
    direction str
    Route Target direction. - Choices: import, export
    encap str
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    route_target str
    Route Target in NX-OS DME format.
    device String
    A device name from the provider configuration.
    direction String
    Route Target direction. - Choices: import, export
    encap String
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    routeTarget String
    Route Target in NX-OS DME format.

    Import

     $ pulumi import nxos:index/evpnVniRouteTarget:EvpnVniRouteTarget example "sys/evpn/bdevi-[vxlan-123456]/rttp-[import]/ent-[route-target:as2-nn2:2:2]"
    

    To learn more about importing existing cloud resources, see Importing resources.

    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