W3cubDocs

/Ansible

nxos_vtp_password - Manages VTP password configuration.

New in version 2.2.

Synopsis

  • Manages VTP password configuration.

Options

parameter required default choices comments
host
 yes
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
 no
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
 no 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).
provider
 no
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
ssh_keyfile
 no
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.
state
 no present
  • present
  • absent
Manage the state of the resource
timeout
(added in 2.3)
 no 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
 yes 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_ssl
 no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
username
 no
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
 no
  • yes
  • no
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.
vtp_password
 no
VTP password

Examples

# ENSURE VTP PASSWORD IS SET
- nxos_vtp_password:
    password: ntc
    state: present
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

# ENSURE VTP PASSWORD IS REMOVED
- nxos_vtp_password:
    password: ntc
    state: absent
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

Return Values

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

name description returned type sample
end_state
k/v pairs of vtp after module execution
 always dict {'domain': 'ntc', 'version': '1', 'vtp_password': 'new_ntc'}
changed
check to see if a change was made on the device
 always boolean True
updates
command sent to the device
 always list ['vtp password new_ntc']
proposed
k/v pairs of parameters passed into module
 always dict {'vtp_password': 'new_ntc'}
existing
k/v pairs of existing vtp
 always dict {'domain': 'ntc', 'version': '1', 'vtp_password': 'ntc'}

Notes

Note

  • Tested against NXOSv 7.3.(0)D1(1) on VIRL
  • VTP feature must be active on the device to use this module.
  • This module is used to manage only VTP passwords.
  • Use this in combination with nxos_vtp_domain and nxos_vtp_version to fully manage VTP operations.
  • You can set/remove password only if a VTP domain already exist.
  • If state=absent and no vtp_password is provided, it remove the current VTP password.
  • If state=absent and vtp_password is provided, the proposed vtp_password has to match the existing one in order to remove it.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/nxos_vtp_password_module.html