ansible.builtin.nxos_udld (v2.9.0) — module

Manages UDLD global configuration params.

| "added in version" 2.2 of ansible.builtin"

Authors: Jason Edelman (@jedelman8)

preview | supported by network

Install Ansible via pip

Install with pip install ansible==2.9.0

Description

Manages UDLD global configuration params.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# ensure udld aggressive mode is globally disabled and se global message interval is 20
- nxos_udld:
    aggressive: disabled
    msg_time: 20
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Ensure agg mode is globally enabled and msg time is 15
- nxos_udld:
    aggressive: enabled
    msg_time: 15
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

Inputs

    
reset:
    default: 'no'
    description:
    - Ability to reset all ports shut down by UDLD. 'state' parameter cannot be 'absent'
      when this is present.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - Manage the state of the resource. When set to 'absent', aggressive and msg_time
      are set to their default values.

msg_time:
    description:
    - Message time in seconds for UDLD packets or keyword 'default'.

aggressive:
    choices:
    - enabled
    - disabled
    description:
    - Toggles aggressive mode.

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: bool
end_state:
  description: k/v pairs of udld configuration after module execution
  returned: always
  sample:
    aggressive: enabled
    msg_time: '40'
  type: dict
existing:
  description:
  - k/v pairs of existing udld configuration
  returned: always
  sample:
    aggressive: disabled
    msg_time: '15'
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: always
  sample:
    aggressive: enabled
    msg_time: '40'
  type: dict
updates:
  description: command sent to the device
  returned: always
  sample:
  - udld message-time 40
  - udld aggressive
  type: list