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

nxos.EvpnVni

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 Distinguisher.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Nxos = Lbrlabs.PulumiPackage.Nxos;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Nxos.EvpnVni("example", new()
        {
            Encap = "vxlan-123456",
            RouteDistinguisher = "rd:unknown:0:0",
        });
    
    });
    
    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.NewEvpnVni(ctx, "example", &nxos.EvpnVniArgs{
    			Encap:              pulumi.String("vxlan-123456"),
    			RouteDistinguisher: pulumi.String("rd:unknown:0:0"),
    		})
    		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.EvpnVni;
    import com.pulumi.nxos.EvpnVniArgs;
    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 EvpnVni("example", EvpnVniArgs.builder()        
                .encap("vxlan-123456")
                .routeDistinguisher("rd:unknown:0:0")
                .build());
    
        }
    }
    
    import pulumi
    import lbrlabs_pulumi_nxos as nxos
    
    example = nxos.EvpnVni("example",
        encap="vxlan-123456",
        route_distinguisher="rd:unknown:0:0")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as nxos from "@lbrlabs/pulumi-nxos";
    
    const example = new nxos.EvpnVni("example", {
        encap: "vxlan-123456",
        routeDistinguisher: "rd:unknown:0:0",
    });
    
    resources:
      example:
        type: nxos:EvpnVni
        properties:
          encap: vxlan-123456
          routeDistinguisher: rd:unknown:0:0
    

    Create EvpnVni Resource

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

    Constructor syntax

    new EvpnVni(name: string, args: EvpnVniArgs, opts?: CustomResourceOptions);
    @overload
    def EvpnVni(resource_name: str,
                args: EvpnVniArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def EvpnVni(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                encap: Optional[str] = None,
                device: Optional[str] = None,
                route_distinguisher: Optional[str] = None)
    func NewEvpnVni(ctx *Context, name string, args EvpnVniArgs, opts ...ResourceOption) (*EvpnVni, error)
    public EvpnVni(string name, EvpnVniArgs args, CustomResourceOptions? opts = null)
    public EvpnVni(String name, EvpnVniArgs args)
    public EvpnVni(String name, EvpnVniArgs args, CustomResourceOptions options)
    
    type: nxos:EvpnVni
    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 EvpnVniArgs
    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 EvpnVniArgs
    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 EvpnVniArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EvpnVniArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EvpnVniArgs
    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 evpnVniResource = new Nxos.EvpnVni("evpnVniResource", new()
    {
        Encap = "string",
        Device = "string",
        RouteDistinguisher = "string",
    });
    
    example, err := nxos.NewEvpnVni(ctx, "evpnVniResource", &nxos.EvpnVniArgs{
    	Encap:              pulumi.String("string"),
    	Device:             pulumi.String("string"),
    	RouteDistinguisher: pulumi.String("string"),
    })
    
    var evpnVniResource = new EvpnVni("evpnVniResource", EvpnVniArgs.builder()        
        .encap("string")
        .device("string")
        .routeDistinguisher("string")
        .build());
    
    evpn_vni_resource = nxos.EvpnVni("evpnVniResource",
        encap="string",
        device="string",
        route_distinguisher="string")
    
    const evpnVniResource = new nxos.EvpnVni("evpnVniResource", {
        encap: "string",
        device: "string",
        routeDistinguisher: "string",
    });
    
    type: nxos:EvpnVni
    properties:
        device: string
        encap: string
        routeDistinguisher: string
    

    EvpnVni 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 EvpnVni resource accepts the following input properties:

    Encap string
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    Device string
    A device name from the provider configuration.
    RouteDistinguisher string
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    Encap string
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    Device string
    A device name from the provider configuration.
    RouteDistinguisher string
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    encap String
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    device String
    A device name from the provider configuration.
    routeDistinguisher String
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    encap string
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    device string
    A device name from the provider configuration.
    routeDistinguisher string
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    encap str
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    device str
    A device name from the provider configuration.
    route_distinguisher str
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    encap String
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    device String
    A device name from the provider configuration.
    routeDistinguisher String
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EvpnVni 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 EvpnVni Resource

    Get an existing EvpnVni 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?: EvpnVniState, opts?: CustomResourceOptions): EvpnVni
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            device: Optional[str] = None,
            encap: Optional[str] = None,
            route_distinguisher: Optional[str] = None) -> EvpnVni
    func GetEvpnVni(ctx *Context, name string, id IDInput, state *EvpnVniState, opts ...ResourceOption) (*EvpnVni, error)
    public static EvpnVni Get(string name, Input<string> id, EvpnVniState? state, CustomResourceOptions? opts = null)
    public static EvpnVni get(String name, Output<String> id, EvpnVniState 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.
    Encap string
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    RouteDistinguisher string
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    Device string
    A device name from the provider configuration.
    Encap string
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    RouteDistinguisher string
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    device String
    A device name from the provider configuration.
    encap String
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    routeDistinguisher String
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    device string
    A device name from the provider configuration.
    encap string
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    routeDistinguisher string
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    device str
    A device name from the provider configuration.
    encap str
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    route_distinguisher str
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0
    device String
    A device name from the provider configuration.
    encap String
    Encapsulation. Possible values are unknown, vlan-XX or vxlan-XX.
    routeDistinguisher String
    Route Distinguisher value in NX-OS DME format. - Default value: unknown:unknown:0:0

    Import

     $ pulumi import nxos:index/evpnVni:EvpnVni example "sys/evpn/bdevi-[vxlan-123456]"
    

    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