W3cubDocs

/Ansible

cisco.nxos.nxos_vtp_domain module – Manages VTP domain configuration.

Note

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

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_domain.

New in cisco.nxos 1.0.0

Synopsis

  • Manages VTP domain configuration.

Parameters

Parameter

Comments

domain

string / required

VTP domain name.

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 domain names.
  • VTP domain names are case-sensible.
  • If it’s never been configured before, VTP version is set to 1 by default. Otherwise, it leaves the previous configured version untouched. Use cisco.nxos.nxos_vtp_version to change it.
  • Use this in combination with cisco.nxos.nxos_vtp_password and cisco.nxos.nxos_vtp_version to fully manage VTP operations.
  • 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 DOMAIN IS CONFIGURED
- cisco.nxos.nxos_vtp_domain:
    domain: ntc
    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 domain after module execution

Returned: always

Sample: {"domain": "ntc", "version": "2", "vtp_password": "password"}

existing

dictionary

k/v pairs of existing vtp domain

Returned: always

Sample: {"domain": "testing", "version": "2", "vtp_password": "password"}

proposed

dictionary

k/v pairs of parameters passed into module

Returned: always

Sample: {"domain": "ntc"}

updates

list / elements=string

command sent to the device

Returned: always

Sample: ["vtp domain ntc"]

Authors

  • Gabriele Gerbino (@GGabriele)

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