cisco.nxos.nxos_udld module – Manages UDLD global configuration params.

Note

This module is part of the cisco.nxos collection (version 9.2.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_udld.

New in cisco.nxos 1.0.0

Synopsis

  • Manages UDLD global configuration params.

Aliases: udld

Parameters

Parameter

Comments

aggressive

string

Toggles aggressive mode.

Choices:

  • "enabled"

  • "disabled"

msg_time

string

Message time in seconds for UDLD packets or keyword ‘default’.

reset

boolean

Ability to reset all ports shut down by UDLD. ‘state’ parameter cannot be ‘absent’ when this is present.

Choices:

  • false

  • true

state

string

Manage the state of the resource. When set to ‘absent’, aggressive and msg_time are set to their default values.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL

  • Unsupported for Cisco MDS

  • Module will fail if the udld feature has not been previously enabled.

  • For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`

  • For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`

  • For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.

Examples

# ensure udld aggressive mode is globally disabled and se global message interval is 20
- cisco.nxos.nxos_udld:
    aggressive: disabled
    msg_time: 20
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'

# Ensure agg mode is globally enabled and msg time is 15
- cisco.nxos.nxos_udld:
    aggressive: enabled
    msg_time: 15
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

check to see if a change was made on the device

Returned: always

Sample: true

end_state

dictionary

k/v pairs of udld configuration after module execution

Returned: always

Sample: {"aggressive": "enabled", "msg_time": "40"}

existing

dictionary

k/v pairs of existing udld configuration

Returned: always

Sample: {"aggressive": "disabled", "msg_time": "15"}

proposed

dictionary

k/v pairs of parameters passed into module

Returned: always

Sample: {"aggressive": "enabled", "msg_time": "40"}

updates

list / elements=string

command sent to the device

Returned: always

Sample: ["udld message-time 40", "udld aggressive"]

Authors

  • Jason Edelman (@jedelman8)