cisco.nxos.nxos_vtp_password module – Manages VTP password configuration.

Note

This module is part of the cisco.nxos collection (version 9.2.1).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

New in cisco.nxos 1.0.0

Synopsis

  • Manages VTP password configuration.

Aliases: vtp_password

Parameters

Parameter

Comments

state

string

Manage the state of the resource

Choices:

  • "present" ← (default)

  • "absent"

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 cisco.nxos.nxos_vtp_domain and cisco.nxos.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.

  • 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 <https://www.ansible.com/integrations/networks/cisco>`_.

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

Description

changed

boolean

check to see if a change was made on the device

Returned: always

Sample: true

end_state

dictionary

k/v pairs of vtp after module execution

Returned: always

Sample: {"domain": "ntc", "version": "1", "vtp_password": "new_ntc"}

existing

dictionary

k/v pairs of existing vtp

Returned: always

Sample: {"domain": "ntc", "version": "1", "vtp_password": "ntc"}

proposed

dictionary

k/v pairs of parameters passed into module

Returned: always

Sample: {"vtp_password": "new_ntc"}

updates

list / elements=string

command sent to the device

Returned: always

Sample: ["vtp password new_ntc"]

Authors

  • Gabriele Gerbino (@GGabriele)