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

iosxe.Udld

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 UDLD configuration.

    Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = new Iosxe.Udld("example", new()
    {
        Aggressive = true,
        Enable = true,
        MessageTime = 77,
        RecoveryInterval = 8640,
    });

});

    package main

import (
	"github.com/lbrlabs/pulumi-iosxe/sdk/go/iosxe"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := iosxe.NewUdld(ctx, "example", &iosxe.UdldArgs{
			Aggressive:       pulumi.Bool(true),
			Enable:           pulumi.Bool(true),
			MessageTime:      pulumi.Int(77),
			RecoveryInterval: pulumi.Int(8640),
		})
		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.iosxe.Udld;
import com.pulumi.iosxe.UdldArgs;
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 Udld("example", UdldArgs.builder()        
            .aggressive(true)
            .enable(true)
            .messageTime(77)
            .recoveryInterval(8640)
            .build());

    }
}

    import pulumi
import lbrlabs_pulumi_iosxe as iosxe

example = iosxe.Udld("example",
    aggressive=True,
    enable=True,
    message_time=77,
    recovery_interval=8640)

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

const example = new iosxe.Udld("example", {
    aggressive: true,
    enable: true,
    messageTime: 77,
    recoveryInterval: 8640,
});

    resources:
  example:
    type: iosxe:Udld
    properties:
      aggressive: true
      enable: true
      messageTime: 77
      recoveryInterval: 8640

    Create Udld Resource

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

    Constructor syntax

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

@overload
def Udld(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         aggressive: Optional[bool] = None,
         delete_mode: Optional[str] = None,
         device: Optional[str] = None,
         enable: Optional[bool] = None,
         message_time: Optional[int] = None,
         recovery_interval: Optional[int] = None)
    func NewUdld(ctx *Context, name string, args *UdldArgs, opts ...ResourceOption) (*Udld, error)
    public Udld(string name, UdldArgs? args = null, CustomResourceOptions? opts = null)
    public Udld(String name, UdldArgs args)
public Udld(String name, UdldArgs args, CustomResourceOptions options)

    type: iosxe:Udld
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 UdldArgs
    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 UdldArgs
    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 UdldArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UdldArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UdldArgs
    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 udldResource = new Iosxe.Udld("udldResource", new()
{
    Aggressive = false,
    DeleteMode = "string",
    Device = "string",
    Enable = false,
    MessageTime = 0,
    RecoveryInterval = 0,
});

    example, err := iosxe.NewUdld(ctx, "udldResource", &iosxe.UdldArgs{
	Aggressive:       pulumi.Bool(false),
	DeleteMode:       pulumi.String("string"),
	Device:           pulumi.String("string"),
	Enable:           pulumi.Bool(false),
	MessageTime:      pulumi.Int(0),
	RecoveryInterval: pulumi.Int(0),
})

    var udldResource = new Udld("udldResource", UdldArgs.builder()
    .aggressive(false)
    .deleteMode("string")
    .device("string")
    .enable(false)
    .messageTime(0)
    .recoveryInterval(0)
    .build());

    udld_resource = iosxe.Udld("udldResource",
    aggressive=False,
    delete_mode="string",
    device="string",
    enable=False,
    message_time=0,
    recovery_interval=0)

    const udldResource = new iosxe.Udld("udldResource", {
    aggressive: false,
    deleteMode: "string",
    device: "string",
    enable: false,
    messageTime: 0,
    recoveryInterval: 0,
});

    type: iosxe:Udld
properties:
    aggressive: false
    deleteMode: string
    device: string
    enable: false
    messageTime: 0
    recoveryInterval: 0

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

    Aggressive bool
    Enable UDLD protocol in aggressive mode on fiber ports exceptwhere locally configured
    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
    Device string
    A device name from the provider configuration.
    Enable bool
    Enable UDLD protocol on fiber ports except where locally configured
    MessageTime int
    Set UDLD message time period - Range: 1-90
    RecoveryInterval int
    timer-interval(sec) - Range: 30-86400
    Aggressive bool
    Enable UDLD protocol in aggressive mode on fiber ports exceptwhere locally configured
    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
    Device string
    A device name from the provider configuration.
    Enable bool
    Enable UDLD protocol on fiber ports except where locally configured
    MessageTime int
    Set UDLD message time period - Range: 1-90
    RecoveryInterval int
    timer-interval(sec) - Range: 30-86400
    aggressive Boolean
    Enable UDLD protocol in aggressive mode on fiber ports exceptwhere locally configured
    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
    device String
    A device name from the provider configuration.
    enable Boolean
    Enable UDLD protocol on fiber ports except where locally configured
    messageTime Integer
    Set UDLD message time period - Range: 1-90
    recoveryInterval Integer
    timer-interval(sec) - Range: 30-86400
    aggressive boolean
    Enable UDLD protocol in aggressive mode on fiber ports exceptwhere locally configured
    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
    device string
    A device name from the provider configuration.
    enable boolean
    Enable UDLD protocol on fiber ports except where locally configured
    messageTime number
    Set UDLD message time period - Range: 1-90
    recoveryInterval number
    timer-interval(sec) - Range: 30-86400
    aggressive bool
    Enable UDLD protocol in aggressive mode on fiber ports exceptwhere locally configured
    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
    device str
    A device name from the provider configuration.
    enable bool
    Enable UDLD protocol on fiber ports except where locally configured
    message_time int
    Set UDLD message time period - Range: 1-90
    recovery_interval int
    timer-interval(sec) - Range: 30-86400
    aggressive Boolean
    Enable UDLD protocol in aggressive mode on fiber ports exceptwhere locally configured
    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
    device String
    A device name from the provider configuration.
    enable Boolean
    Enable UDLD protocol on fiber ports except where locally configured
    messageTime Number
    Set UDLD message time period - Range: 1-90
    recoveryInterval Number
    timer-interval(sec) - Range: 30-86400

    Outputs

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

    Get an existing Udld 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?: UdldState, opts?: CustomResourceOptions): Udld
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aggressive: Optional[bool] = None,
        delete_mode: Optional[str] = None,
        device: Optional[str] = None,
        enable: Optional[bool] = None,
        message_time: Optional[int] = None,
        recovery_interval: Optional[int] = None) -> Udld
    func GetUdld(ctx *Context, name string, id IDInput, state *UdldState, opts ...ResourceOption) (*Udld, error)
    public static Udld Get(string name, Input<string> id, UdldState? state, CustomResourceOptions? opts = null)
    public static Udld get(String name, Output<String> id, UdldState 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:
    Aggressive bool
    Enable UDLD protocol in aggressive mode on fiber ports exceptwhere locally configured
    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
    Device string
    A device name from the provider configuration.
    Enable bool
    Enable UDLD protocol on fiber ports except where locally configured
    MessageTime int
    Set UDLD message time period - Range: 1-90
    RecoveryInterval int
    timer-interval(sec) - Range: 30-86400
    Aggressive bool
    Enable UDLD protocol in aggressive mode on fiber ports exceptwhere locally configured
    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
    Device string
    A device name from the provider configuration.
    Enable bool
    Enable UDLD protocol on fiber ports except where locally configured
    MessageTime int
    Set UDLD message time period - Range: 1-90
    RecoveryInterval int
    timer-interval(sec) - Range: 30-86400
    aggressive Boolean
    Enable UDLD protocol in aggressive mode on fiber ports exceptwhere locally configured
    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
    device String
    A device name from the provider configuration.
    enable Boolean
    Enable UDLD protocol on fiber ports except where locally configured
    messageTime Integer
    Set UDLD message time period - Range: 1-90
    recoveryInterval Integer
    timer-interval(sec) - Range: 30-86400
    aggressive boolean
    Enable UDLD protocol in aggressive mode on fiber ports exceptwhere locally configured
    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
    device string
    A device name from the provider configuration.
    enable boolean
    Enable UDLD protocol on fiber ports except where locally configured
    messageTime number
    Set UDLD message time period - Range: 1-90
    recoveryInterval number
    timer-interval(sec) - Range: 30-86400
    aggressive bool
    Enable UDLD protocol in aggressive mode on fiber ports exceptwhere locally configured
    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
    device str
    A device name from the provider configuration.
    enable bool
    Enable UDLD protocol on fiber ports except where locally configured
    message_time int
    Set UDLD message time period - Range: 1-90
    recovery_interval int
    timer-interval(sec) - Range: 30-86400
    aggressive Boolean
    Enable UDLD protocol in aggressive mode on fiber ports exceptwhere locally configured
    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
    device String
    A device name from the provider configuration.
    enable Boolean
    Enable UDLD protocol on fiber ports except where locally configured
    messageTime Number
    Set UDLD message time period - Range: 1-90
    recoveryInterval Number
    timer-interval(sec) - Range: 30-86400

    Import

     $ pulumi import iosxe:index/udld:Udld example "Cisco-IOS-XE-native:native/udld"

    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