cisco.nxos.nxos_vtp_password_module.rst

cisco.nxos.nxos_vtp_password

Manages VTP password configuration.

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• Manages VTP password configuration.

Parameters

Parameter	Choices/Defaults	Comments
state string	Choices: present ← absent	Manage the state of the resource
vtp_password string		VTP password

Notes

Note

• Tested against NXOSv 7.3.(0)D1(1) on VIRL
• Unsupported for Cisco MDS
• 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 :ref:`cisco.nxos.nxos_vtp_domain <cisco.nxos.nxos_vtp_domain_module>` and :ref:`cisco.nxos.nxos_vtp_version <cisco.nxos.nxos_vtp_version_module>` 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.
• 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.

Examples

# ENSURE VTP PASSWORD IS SET
- cisco.nxos.nxos_vtp_password:
    state: present
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'

# ENSURE VTP PASSWORD IS REMOVED
- cisco.nxos.nxos_vtp_password:
    state: absent
    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 vtp after module execution Sample: {'domain': 'ntc', 'version': '1', 'vtp_password': 'new_ntc'}
existing dictionary	always	k/v pairs of existing vtp Sample: {'domain': 'ntc', 'version': '1', 'vtp_password': 'ntc'}
proposed dictionary	always	k/v pairs of parameters passed into module Sample: {'vtp_password': 'new_ntc'}
updates list	always	command sent to the device Sample: ['vtp password new_ntc']

Status

Authors

• Gabriele Gerbino (@GGabriele)