W3cubDocs

nxos_vtp_domain - Manages VTP domain configuration.

New in version 2.2.

Synopsis
Options
Examples
Return Values
Notes
This is a Core Module

Synopsis

Manages VTP domain configuration.

Options

parameter	required	default	choices	comments
domain	yes			VTP domain name.
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.
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. The value of username 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.

Examples

# ENSURE VTP DOMAIN IS CONFIGURED
- nxos_vtp_domain:
    domain: ntc
    host: {{ inventory_hostname }}
    username: {{ un }}
    password: {{ pwd }}

Return Values

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

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

Notes

Note

VTP feature must be active on the device to use this module.

Note

This module is used to manage only VTP domain names.

Note

VTP domain names are case-sensible.

Note

If it’s never been configured before, VTP version is set to 1 by default. Otherwise, it leaves the previous configured version untouched. Use nxos_vtp_version to change it.

Note

Use this in combination with nxos_vtp_password and nxos_vtp_version to fully manage VTP operations.

This is a Core Module

For more information on what this means please read Core Modules

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

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