nxos_udld – Manages UDLD global configuration params.

From Get docs
Ansible/docs/2.7/modules/nxos udld module


nxos_udld – Manages UDLD global configuration params.

New in version 2.2.


Synopsis

  • Manages UDLD global configuration params.

Parameters

Parameter Choices/Defaults Comments

aggressive

-

  • enabled
  • disabled

Toggles aggressive mode.

msg_time

-

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

provider

-

Deprecated

Starting with Ansible 2.5 we recommend using connection: network_cli.

This option is only required if you are using NX-API.

For more information please see the NXOS Platform Options guide.

A dict object containing connection details.

auth_pass

-

added in 2.5.3

Default:

"none"

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

added in 2.5.3

  • 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

- / required

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

-

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

-

Default:

"0 (use common port)"

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

-

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

-

added in 2.3

Default:

10

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

- / required

Default:

"cli"

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

added in 2.5

  • 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 true only when the transport=nxapi, otherwise this value is ignored.

username

-

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

-

  • 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
- 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
- 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

always

command sent to the device


Sample:

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




Status

Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors

  • Jason Edelman (@jedelman8)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/nxos_udld_module.html