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

nxos.NveVni

Explore with Pulumi AI

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

    This resource can manage the configuration of Virtual Network ID (VNI).

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Nxos.NveVni("example", new()
    {
        AssociateVrf = false,
        MulticastGroup = "239.1.1.1",
        MultisiteIngressReplication = "disable",
        SuppressArp = "off",
        Vni = 103100,
    });

});

    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.NewNveVni(ctx, "example", &nxos.NveVniArgs{
			AssociateVrf:                pulumi.Bool(false),
			MulticastGroup:              pulumi.String("239.1.1.1"),
			MultisiteIngressReplication: pulumi.String("disable"),
			SuppressArp:                 pulumi.String("off"),
			Vni:                         pulumi.Int(103100),
		})
		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.NveVni;
import com.pulumi.nxos.NveVniArgs;
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 NveVni("example", NveVniArgs.builder()        
            .associateVrf(false)
            .multicastGroup("239.1.1.1")
            .multisiteIngressReplication("disable")
            .suppressArp("off")
            .vni(103100)
            .build());

    }
}

    import pulumi
import lbrlabs_pulumi_nxos as nxos

example = nxos.NveVni("example",
    associate_vrf=False,
    multicast_group="239.1.1.1",
    multisite_ingress_replication="disable",
    suppress_arp="off",
    vni=103100)

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

const example = new nxos.NveVni("example", {
    associateVrf: false,
    multicastGroup: "239.1.1.1",
    multisiteIngressReplication: "disable",
    suppressArp: "off",
    vni: 103100,
});

    resources:
  example:
    type: nxos:NveVni
    properties:
      associateVrf: false
      multicastGroup: 239.1.1.1
      multisiteIngressReplication: disable
      suppressArp: off
      vni: 103100

    Create NveVni Resource

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

    Constructor syntax

    new NveVni(name: string, args: NveVniArgs, opts?: CustomResourceOptions);
    @overload
def NveVni(resource_name: str,
           args: NveVniArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def NveVni(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           vni: Optional[int] = None,
           associate_vrf: Optional[bool] = None,
           device: Optional[str] = None,
           multicast_group: Optional[str] = None,
           multisite_ingress_replication: Optional[str] = None,
           suppress_arp: Optional[str] = None)
    func NewNveVni(ctx *Context, name string, args NveVniArgs, opts ...ResourceOption) (*NveVni, error)
    public NveVni(string name, NveVniArgs args, CustomResourceOptions? opts = null)
    public NveVni(String name, NveVniArgs args)
public NveVni(String name, NveVniArgs args, CustomResourceOptions options)

    type: nxos:NveVni
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 NveVniArgs
    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 NveVniArgs
    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 NveVniArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NveVniArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NveVniArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var nveVniResource = new Nxos.NveVni("nveVniResource", new()
{
    Vni = 0,
    AssociateVrf = false,
    Device = "string",
    MulticastGroup = "string",
    MultisiteIngressReplication = "string",
    SuppressArp = "string",
});

    example, err := nxos.NewNveVni(ctx, "nveVniResource", &nxos.NveVniArgs{
	Vni:                         pulumi.Int(0),
	AssociateVrf:                pulumi.Bool(false),
	Device:                      pulumi.String("string"),
	MulticastGroup:              pulumi.String("string"),
	MultisiteIngressReplication: pulumi.String("string"),
	SuppressArp:                 pulumi.String("string"),
})

    var nveVniResource = new NveVni("nveVniResource", NveVniArgs.builder()
    .vni(0)
    .associateVrf(false)
    .device("string")
    .multicastGroup("string")
    .multisiteIngressReplication("string")
    .suppressArp("string")
    .build());

    nve_vni_resource = nxos.NveVni("nveVniResource",
    vni=0,
    associate_vrf=False,
    device="string",
    multicast_group="string",
    multisite_ingress_replication="string",
    suppress_arp="string")

    const nveVniResource = new nxos.NveVni("nveVniResource", {
    vni: 0,
    associateVrf: false,
    device: "string",
    multicastGroup: "string",
    multisiteIngressReplication: "string",
    suppressArp: "string",
});

    type: nxos:NveVni
properties:
    associateVrf: false
    device: string
    multicastGroup: string
    multisiteIngressReplication: string
    suppressArp: string
    vni: 0

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

    Vni int
    Virtual Network ID. - Range: 1-16777214
    AssociateVrf bool
    Configures VNI as L3 VNI. - Default value: false
    Device string
    A device name from the provider configuration.
    MulticastGroup string
    Configures multicast group address for VNI. - Default value: 0.0.0.0
    MultisiteIngressReplication string
    Enable or disable Multisite Ingress Replication for VNI(s). - Choices: enable, disable, enableOptimized - Default value: disable
    SuppressArp string
    Enable or disable ARP suppression for VNI(s). - Choices: enabled, disabled, off - Default value: off
    Vni int
    Virtual Network ID. - Range: 1-16777214
    AssociateVrf bool
    Configures VNI as L3 VNI. - Default value: false
    Device string
    A device name from the provider configuration.
    MulticastGroup string
    Configures multicast group address for VNI. - Default value: 0.0.0.0
    MultisiteIngressReplication string
    Enable or disable Multisite Ingress Replication for VNI(s). - Choices: enable, disable, enableOptimized - Default value: disable
    SuppressArp string
    Enable or disable ARP suppression for VNI(s). - Choices: enabled, disabled, off - Default value: off
    vni Integer
    Virtual Network ID. - Range: 1-16777214
    associateVrf Boolean
    Configures VNI as L3 VNI. - Default value: false
    device String
    A device name from the provider configuration.
    multicastGroup String
    Configures multicast group address for VNI. - Default value: 0.0.0.0
    multisiteIngressReplication String
    Enable or disable Multisite Ingress Replication for VNI(s). - Choices: enable, disable, enableOptimized - Default value: disable
    suppressArp String
    Enable or disable ARP suppression for VNI(s). - Choices: enabled, disabled, off - Default value: off
    vni number
    Virtual Network ID. - Range: 1-16777214
    associateVrf boolean
    Configures VNI as L3 VNI. - Default value: false
    device string
    A device name from the provider configuration.
    multicastGroup string
    Configures multicast group address for VNI. - Default value: 0.0.0.0
    multisiteIngressReplication string
    Enable or disable Multisite Ingress Replication for VNI(s). - Choices: enable, disable, enableOptimized - Default value: disable
    suppressArp string
    Enable or disable ARP suppression for VNI(s). - Choices: enabled, disabled, off - Default value: off
    vni int
    Virtual Network ID. - Range: 1-16777214
    associate_vrf bool
    Configures VNI as L3 VNI. - Default value: false
    device str
    A device name from the provider configuration.
    multicast_group str
    Configures multicast group address for VNI. - Default value: 0.0.0.0
    multisite_ingress_replication str
    Enable or disable Multisite Ingress Replication for VNI(s). - Choices: enable, disable, enableOptimized - Default value: disable
    suppress_arp str
    Enable or disable ARP suppression for VNI(s). - Choices: enabled, disabled, off - Default value: off
    vni Number
    Virtual Network ID. - Range: 1-16777214
    associateVrf Boolean
    Configures VNI as L3 VNI. - Default value: false
    device String
    A device name from the provider configuration.
    multicastGroup String
    Configures multicast group address for VNI. - Default value: 0.0.0.0
    multisiteIngressReplication String
    Enable or disable Multisite Ingress Replication for VNI(s). - Choices: enable, disable, enableOptimized - Default value: disable
    suppressArp String
    Enable or disable ARP suppression for VNI(s). - Choices: enabled, disabled, off - Default value: off

    Outputs

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

    Get an existing NveVni 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?: NveVniState, opts?: CustomResourceOptions): NveVni
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        associate_vrf: Optional[bool] = None,
        device: Optional[str] = None,
        multicast_group: Optional[str] = None,
        multisite_ingress_replication: Optional[str] = None,
        suppress_arp: Optional[str] = None,
        vni: Optional[int] = None) -> NveVni
    func GetNveVni(ctx *Context, name string, id IDInput, state *NveVniState, opts ...ResourceOption) (*NveVni, error)
    public static NveVni Get(string name, Input<string> id, NveVniState? state, CustomResourceOptions? opts = null)
    public static NveVni get(String name, Output<String> id, NveVniState 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:
    AssociateVrf bool
    Configures VNI as L3 VNI. - Default value: false
    Device string
    A device name from the provider configuration.
    MulticastGroup string
    Configures multicast group address for VNI. - Default value: 0.0.0.0
    MultisiteIngressReplication string
    Enable or disable Multisite Ingress Replication for VNI(s). - Choices: enable, disable, enableOptimized - Default value: disable
    SuppressArp string
    Enable or disable ARP suppression for VNI(s). - Choices: enabled, disabled, off - Default value: off
    Vni int
    Virtual Network ID. - Range: 1-16777214
    AssociateVrf bool
    Configures VNI as L3 VNI. - Default value: false
    Device string
    A device name from the provider configuration.
    MulticastGroup string
    Configures multicast group address for VNI. - Default value: 0.0.0.0
    MultisiteIngressReplication string
    Enable or disable Multisite Ingress Replication for VNI(s). - Choices: enable, disable, enableOptimized - Default value: disable
    SuppressArp string
    Enable or disable ARP suppression for VNI(s). - Choices: enabled, disabled, off - Default value: off
    Vni int
    Virtual Network ID. - Range: 1-16777214
    associateVrf Boolean
    Configures VNI as L3 VNI. - Default value: false
    device String
    A device name from the provider configuration.
    multicastGroup String
    Configures multicast group address for VNI. - Default value: 0.0.0.0
    multisiteIngressReplication String
    Enable or disable Multisite Ingress Replication for VNI(s). - Choices: enable, disable, enableOptimized - Default value: disable
    suppressArp String
    Enable or disable ARP suppression for VNI(s). - Choices: enabled, disabled, off - Default value: off
    vni Integer
    Virtual Network ID. - Range: 1-16777214
    associateVrf boolean
    Configures VNI as L3 VNI. - Default value: false
    device string
    A device name from the provider configuration.
    multicastGroup string
    Configures multicast group address for VNI. - Default value: 0.0.0.0
    multisiteIngressReplication string
    Enable or disable Multisite Ingress Replication for VNI(s). - Choices: enable, disable, enableOptimized - Default value: disable
    suppressArp string
    Enable or disable ARP suppression for VNI(s). - Choices: enabled, disabled, off - Default value: off
    vni number
    Virtual Network ID. - Range: 1-16777214
    associate_vrf bool
    Configures VNI as L3 VNI. - Default value: false
    device str
    A device name from the provider configuration.
    multicast_group str
    Configures multicast group address for VNI. - Default value: 0.0.0.0
    multisite_ingress_replication str
    Enable or disable Multisite Ingress Replication for VNI(s). - Choices: enable, disable, enableOptimized - Default value: disable
    suppress_arp str
    Enable or disable ARP suppression for VNI(s). - Choices: enabled, disabled, off - Default value: off
    vni int
    Virtual Network ID. - Range: 1-16777214
    associateVrf Boolean
    Configures VNI as L3 VNI. - Default value: false
    device String
    A device name from the provider configuration.
    multicastGroup String
    Configures multicast group address for VNI. - Default value: 0.0.0.0
    multisiteIngressReplication String
    Enable or disable Multisite Ingress Replication for VNI(s). - Choices: enable, disable, enableOptimized - Default value: disable
    suppressArp String
    Enable or disable ARP suppression for VNI(s). - Choices: enabled, disabled, off - Default value: off
    vni Number
    Virtual Network ID. - Range: 1-16777214

    Import

     $ pulumi import nxos:index/nveVni:NveVni example "sys/eps/epId-[1]/nws/vni-[103100]"

    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
    lbrlabs/pulumi-nxos