Docs Packages
  1. Packages
  2. Cisco IOS XE Resource Provider
  3. API Docs
  4. InterfaceNve
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

iosxe.InterfaceNve

Explore with Pulumi AI

iosxe logo
Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
lbrlabs/pulumi-iosxe

    This resource can manage the Interface NVE configuration.

    Example Usage

    Coming soon!

    Coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.iosxe.InterfaceNve;
import com.pulumi.iosxe.InterfaceNveArgs;
import com.pulumi.iosxe.inputs.InterfaceNveVniArgs;
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 InterfaceNve("example", InterfaceNveArgs.builder()        
            .description("My Interface Description")
            .hostReachabilityProtocolBgp(true)
            .shutdown(false)
            .sourceInterfaceLoopback(100)
            .vnis(InterfaceNveVniArgs.builder()
                .ipv4_multicast_group("225.1.1.1")
                .vni_range("10000")
                .build())
            .build());

    }
}

    Coming soon!

    Coming soon!

    resources:
  example:
    type: iosxe:InterfaceNve
    properties:
      description: My Interface Description
      hostReachabilityProtocolBgp: true
      shutdown: false
      sourceInterfaceLoopback: 100
      vnis:
        - ipv4_multicast_group: 225.1.1.1
          vni_range: '10000'

    Create InterfaceNve Resource

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

    Constructor syntax

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

@overload
def InterfaceNve(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 delete_mode: Optional[str] = None,
                 description: Optional[str] = None,
                 device: Optional[str] = None,
                 host_reachability_protocol_bgp: Optional[bool] = None,
                 name: Optional[int] = None,
                 shutdown: Optional[bool] = None,
                 source_interface_loopback: Optional[int] = None,
                 vni_vrfs: Optional[Sequence[InterfaceNveVniVrfArgs]] = None,
                 vnis: Optional[Sequence[InterfaceNveVniArgs]] = None)
    func NewInterfaceNve(ctx *Context, name string, args *InterfaceNveArgs, opts ...ResourceOption) (*InterfaceNve, error)
    public InterfaceNve(string name, InterfaceNveArgs? args = null, CustomResourceOptions? opts = null)
    public InterfaceNve(String name, InterfaceNveArgs args)
public InterfaceNve(String name, InterfaceNveArgs args, CustomResourceOptions options)

    type: iosxe:InterfaceNve
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 InterfaceNveArgs
    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 InterfaceNveArgs
    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 InterfaceNveArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InterfaceNveArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InterfaceNveArgs
    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 interfaceNveResource = new Iosxe.InterfaceNve("interfaceNveResource", new()
{
    DeleteMode = "string",
    Description = "string",
    Device = "string",
    HostReachabilityProtocolBgp = false,
    Name = 0,
    Shutdown = false,
    SourceInterfaceLoopback = 0,
    VniVrfs = new[]
    {
        new Iosxe.Inputs.InterfaceNveVniVrfArgs
        {
            VniRange = "string",
            Vrf = "string",
        },
    },
    Vnis = new[]
    {
        new Iosxe.Inputs.InterfaceNveVniArgs
        {
            VniRange = "string",
            IngressReplication = false,
            Ipv4MulticastGroup = "string",
        },
    },
});

    example, err := iosxe.NewInterfaceNve(ctx, "interfaceNveResource", &iosxe.InterfaceNveArgs{
	DeleteMode:                  pulumi.String("string"),
	Description:                 pulumi.String("string"),
	Device:                      pulumi.String("string"),
	HostReachabilityProtocolBgp: pulumi.Bool(false),
	Name:                        pulumi.Int(0),
	Shutdown:                    pulumi.Bool(false),
	SourceInterfaceLoopback:     pulumi.Int(0),
	VniVrfs: iosxe.InterfaceNveVniVrfArray{
		&iosxe.InterfaceNveVniVrfArgs{
			VniRange: pulumi.String("string"),
			Vrf:      pulumi.String("string"),
		},
	},
	Vnis: iosxe.InterfaceNveVniArray{
		&iosxe.InterfaceNveVniArgs{
			VniRange:           pulumi.String("string"),
			IngressReplication: pulumi.Bool(false),
			Ipv4MulticastGroup: pulumi.String("string"),
		},
	},
})

    var interfaceNveResource = new InterfaceNve("interfaceNveResource", InterfaceNveArgs.builder()
    .deleteMode("string")
    .description("string")
    .device("string")
    .hostReachabilityProtocolBgp(false)
    .name(0)
    .shutdown(false)
    .sourceInterfaceLoopback(0)
    .vniVrfs(InterfaceNveVniVrfArgs.builder()
        .vniRange("string")
        .vrf("string")
        .build())
    .vnis(InterfaceNveVniArgs.builder()
        .vniRange("string")
        .ingressReplication(false)
        .ipv4MulticastGroup("string")
        .build())
    .build());

    interface_nve_resource = iosxe.InterfaceNve("interfaceNveResource",
    delete_mode="string",
    description="string",
    device="string",
    host_reachability_protocol_bgp=False,
    name=0,
    shutdown=False,
    source_interface_loopback=0,
    vni_vrfs=[iosxe.InterfaceNveVniVrfArgs(
        vni_range="string",
        vrf="string",
    )],
    vnis=[iosxe.InterfaceNveVniArgs(
        vni_range="string",
        ingress_replication=False,
        ipv4_multicast_group="string",
    )])

    const interfaceNveResource = new iosxe.InterfaceNve("interfaceNveResource", {
    deleteMode: "string",
    description: "string",
    device: "string",
    hostReachabilityProtocolBgp: false,
    name: 0,
    shutdown: false,
    sourceInterfaceLoopback: 0,
    vniVrfs: [{
        vniRange: "string",
        vrf: "string",
    }],
    vnis: [{
        vniRange: "string",
        ingressReplication: false,
        ipv4MulticastGroup: "string",
    }],
});

    type: iosxe:InterfaceNve
properties:
    deleteMode: string
    description: string
    device: string
    hostReachabilityProtocolBgp: false
    name: 0
    shutdown: false
    sourceInterfaceLoopback: 0
    vniVrfs:
        - vniRange: string
          vrf: string
    vnis:
        - ingressReplication: false
          ipv4MulticastGroup: string
          vniRange: string

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

    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Description string
    Interface specific description
    Device string
    A device name from the provider configuration.
    HostReachabilityProtocolBgp bool
    Name int
    • Range: 1-4096
    Shutdown bool
    Shutdown the selected interface
    SourceInterfaceLoopback int
    Loopback interface - Range: 0-2147483647
    VniVrfs List<Lbrlabs.PulumiPackage.Iosxe.Inputs.InterfaceNveVniVrf>
    Configure VNI information
    Vnis List<Lbrlabs.PulumiPackage.Iosxe.Inputs.InterfaceNveVni>
    Configure VNI information
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Description string
    Interface specific description
    Device string
    A device name from the provider configuration.
    HostReachabilityProtocolBgp bool
    Name int
    • Range: 1-4096
    Shutdown bool
    Shutdown the selected interface
    SourceInterfaceLoopback int
    Loopback interface - Range: 0-2147483647
    VniVrfs []InterfaceNveVniVrfArgs
    Configure VNI information
    Vnis []InterfaceNveVniArgs
    Configure VNI information
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    description String
    Interface specific description
    device String
    A device name from the provider configuration.
    hostReachabilityProtocolBgp Boolean
    name Integer
    • Range: 1-4096
    shutdown Boolean
    Shutdown the selected interface
    sourceInterfaceLoopback Integer
    Loopback interface - Range: 0-2147483647
    vniVrfs List<InterfaceNveVniVrf>
    Configure VNI information
    vnis List<InterfaceNveVni>
    Configure VNI information
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    description string
    Interface specific description
    device string
    A device name from the provider configuration.
    hostReachabilityProtocolBgp boolean
    name number
    • Range: 1-4096
    shutdown boolean
    Shutdown the selected interface
    sourceInterfaceLoopback number
    Loopback interface - Range: 0-2147483647
    vniVrfs InterfaceNveVniVrf[]
    Configure VNI information
    vnis InterfaceNveVni[]
    Configure VNI information
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    description str
    Interface specific description
    device str
    A device name from the provider configuration.
    host_reachability_protocol_bgp bool
    name int
    • Range: 1-4096
    shutdown bool
    Shutdown the selected interface
    source_interface_loopback int
    Loopback interface - Range: 0-2147483647
    vni_vrfs Sequence[InterfaceNveVniVrfArgs]
    Configure VNI information
    vnis Sequence[InterfaceNveVniArgs]
    Configure VNI information
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    description String
    Interface specific description
    device String
    A device name from the provider configuration.
    hostReachabilityProtocolBgp Boolean
    name Number
    • Range: 1-4096
    shutdown Boolean
    Shutdown the selected interface
    sourceInterfaceLoopback Number
    Loopback interface - Range: 0-2147483647
    vniVrfs List<Property Map>
    Configure VNI information
    vnis List<Property Map>
    Configure VNI information

    Outputs

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

    Get an existing InterfaceNve 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?: InterfaceNveState, opts?: CustomResourceOptions): InterfaceNve
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        delete_mode: Optional[str] = None,
        description: Optional[str] = None,
        device: Optional[str] = None,
        host_reachability_protocol_bgp: Optional[bool] = None,
        name: Optional[int] = None,
        shutdown: Optional[bool] = None,
        source_interface_loopback: Optional[int] = None,
        vni_vrfs: Optional[Sequence[InterfaceNveVniVrfArgs]] = None,
        vnis: Optional[Sequence[InterfaceNveVniArgs]] = None) -> InterfaceNve
    func GetInterfaceNve(ctx *Context, name string, id IDInput, state *InterfaceNveState, opts ...ResourceOption) (*InterfaceNve, error)
    public static InterfaceNve Get(string name, Input<string> id, InterfaceNveState? state, CustomResourceOptions? opts = null)
    public static InterfaceNve get(String name, Output<String> id, InterfaceNveState 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:
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Description string
    Interface specific description
    Device string
    A device name from the provider configuration.
    HostReachabilityProtocolBgp bool
    Name int
    • Range: 1-4096
    Shutdown bool
    Shutdown the selected interface
    SourceInterfaceLoopback int
    Loopback interface - Range: 0-2147483647
    VniVrfs List<Lbrlabs.PulumiPackage.Iosxe.Inputs.InterfaceNveVniVrf>
    Configure VNI information
    Vnis List<Lbrlabs.PulumiPackage.Iosxe.Inputs.InterfaceNveVni>
    Configure VNI information
    DeleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    Description string
    Interface specific description
    Device string
    A device name from the provider configuration.
    HostReachabilityProtocolBgp bool
    Name int
    • Range: 1-4096
    Shutdown bool
    Shutdown the selected interface
    SourceInterfaceLoopback int
    Loopback interface - Range: 0-2147483647
    VniVrfs []InterfaceNveVniVrfArgs
    Configure VNI information
    Vnis []InterfaceNveVniArgs
    Configure VNI information
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    description String
    Interface specific description
    device String
    A device name from the provider configuration.
    hostReachabilityProtocolBgp Boolean
    name Integer
    • Range: 1-4096
    shutdown Boolean
    Shutdown the selected interface
    sourceInterfaceLoopback Integer
    Loopback interface - Range: 0-2147483647
    vniVrfs List<InterfaceNveVniVrf>
    Configure VNI information
    vnis List<InterfaceNveVni>
    Configure VNI information
    deleteMode string
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    description string
    Interface specific description
    device string
    A device name from the provider configuration.
    hostReachabilityProtocolBgp boolean
    name number
    • Range: 1-4096
    shutdown boolean
    Shutdown the selected interface
    sourceInterfaceLoopback number
    Loopback interface - Range: 0-2147483647
    vniVrfs InterfaceNveVniVrf[]
    Configure VNI information
    vnis InterfaceNveVni[]
    Configure VNI information
    delete_mode str
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    description str
    Interface specific description
    device str
    A device name from the provider configuration.
    host_reachability_protocol_bgp bool
    name int
    • Range: 1-4096
    shutdown bool
    Shutdown the selected interface
    source_interface_loopback int
    Loopback interface - Range: 0-2147483647
    vni_vrfs Sequence[InterfaceNveVniVrfArgs]
    Configure VNI information
    vnis Sequence[InterfaceNveVniArgs]
    Configure VNI information
    deleteMode String
    Configure behavior when deleting/destroying the resource. Either delete the entire object (YANG container) being managed, or only delete the individual resource attributes configured explicitly and leave everything else as-is. Default value is all. - Choices: all, attributes
    description String
    Interface specific description
    device String
    A device name from the provider configuration.
    hostReachabilityProtocolBgp Boolean
    name Number
    • Range: 1-4096
    shutdown Boolean
    Shutdown the selected interface
    sourceInterfaceLoopback Number
    Loopback interface - Range: 0-2147483647
    vniVrfs List<Property Map>
    Configure VNI information
    vnis List<Property Map>
    Configure VNI information

    Supporting Types

    InterfaceNveVni, InterfaceNveVniArgs

    InterfaceNveVniVrf, InterfaceNveVniVrfArgs

    VniRange string
    Vrf string
    VniRange string
    Vrf string
    vniRange String
    vrf String
    vniRange string
    vrf string
    vni_range str
    vrf str
    vniRange String
    vrf String

    Import

     $ pulumi import iosxe:index/interfaceNve:InterfaceNve example "Cisco-IOS-XE-native:native/interface/nve=1"

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

    Package Details

    Repository
    iosxe lbrlabs/pulumi-iosxe
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the iosxe Terraform Provider.
    iosxe logo
    Cisco IOS XE v0.0.1 published on Friday, Sep 22, 2023 by lbrlabs
    lbrlabs/pulumi-iosxe