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

From Get docs
Ansible/docs/2.11/collections/cisco/nxos/nxos udld module


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

Note

This plugin is part of the cisco.nxos collection (version 1.4.0).

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

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


New in version 1.0.0: of cisco.nxos


Synopsis

  • Manages UDLD global configuration params.

Note

This module has a corresponding action plugin.


Parameters

Parameter Choices/Defaults Comments

aggressive

string

  • enabled
  • disabled

Toggles aggressive mode.

msg_time

string

Message time in seconds for UDLD packets or keyword 'default'.

provider

dictionary

Deprecated

Starting with Ansible 2.5 we recommend using connection: network_cli.

Starting with Ansible 2.6 we recommend using connection: httpapi for NX-API.

This option will be removed in a release after 2022-06-01.

For more information please see the NXOS Platform Options guide.

A dict object containing connection details.

auth_pass

string

Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead.

authorize

boolean

  • no

  • yes

Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead.

host

string

Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.

password

string

Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.

port

integer

Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).

ssh_keyfile

string

Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.

timeout

integer

Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc).

transport

string

  • cli

  • nxapi

Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi.

use_proxy

boolean

  • no
  • yes

If no, the environment variables http_proxy and https_proxy will be ignored.

use_ssl

boolean

  • no

  • yes

Configures the transport to use SSL if set to yes only when the transport=nxapi, otherwise this value is ignored.

username

string

Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

validate_certs

boolean

  • no

  • yes

If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.

reset

boolean

  • no
  • yes

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

state

string

  • present

  • absent

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



Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL
  • Module will fail if the udld feature has not been previously enabled.
  • For information on using CLI and NX-API see the NXOS Platform Options guide
  • For more information on using Ansible to manage network devices see the Ansible Network Guide
  • For more information on using Ansible to manage Cisco devices see the Cisco integration page.


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 Returned Description

changed

boolean

always

check to see if a change was made on the device


Sample:

True

end_state

dictionary

always

k/v pairs of udld configuration after module execution


Sample:

{'aggressive': 'enabled', 'msg_time': '40'}

existing

dictionary

always

k/v pairs of existing udld configuration


Sample:

{'aggressive': 'disabled', 'msg_time': '15'}

proposed

dictionary

always

k/v pairs of parameters passed into module


Sample:

{'aggressive': 'enabled', 'msg_time': '40'}

updates

list / elements=string

always

command sent to the device


Sample:

['udld message-time 40', 'udld aggressive']




Authors

  • Jason Edelman (@jedelman8)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_udld_module.html