cisco.nxos.nxos_vtp_version – Управляет конфигурацией версии VTP.

Примечание

Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install cisco.nxos

Чтобы использовать его в книге задач, укажите: cisco.nxos.nxos_vtp_version

Новое в версии 1.0.0: из cisco.nxos

Описание
Параметры
Примечания
Примеры
Значения возврата

Описание

Управляет конфигурацией версии VTP.

Примечание

У данного модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуем использовать `connection: network_cli` Начиная с Ansible 2.6, рекомендуем использовать `connection: httpapi` для NX-API. Этот параметр будет удалён в релизе после 2022-06-01. Для получения дополнительной информации, см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass строка		Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`
	authorize логическое значение	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTHORIZE`
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве целевого адреса для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_PASSWORD`
	port целое число		Указывает порт для подключения к удалённому устройству. Это значение применимо к cli или nxapi. Значение порта по умолчанию соответствует обычному порту для соответствующего транспорта, если он не указан в задаче (cli=22, http=80, https=443).
	ssh_keyfile строка		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`
	timeout целое число		Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.).
	transport строка	Варианты: cli ← nxapi	Настраивает транспортное подключение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy логическое значение	Варианты: нет да ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl логическое значение	Варианты: нет ← да	Настраивает transport для использования SSL, если установлено значение `yes`, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`
	validate_certs логическое значение	Варианты: нет ← да	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с самозаверяющимися сертификатами. Если аргумент transport не равен nxapi, это значение игнорируется.
version строка / обязательно		Варианты: 1 2	Номер версии VTP.

Примечания

Примечание

Проверено на NXOSv 7.3.(0)D1(1) на VIRL
Функция VTP должна быть активной на устройстве для использования данного модуля.
Данный модуль используется только для управления версией VTP.
Используйте его в сочетании с cisco.nxos.nxos_vtp_password и cisco.nxos.nxos_vtp_version для полного управления операциями VTP.
Дополнительную информацию о работе с CLI и NX-API см. в руководстве NXOS Platform Options.
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide.
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

# ENSURE VTP VERSION IS 2
- cisco.nxos.nxos_vtp_version:
    version: 2
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'

Значения возврата

Общие значения возврата описаны в здесь, следующие являются полями, уникальными для этого модуля:

Ключ	Возвращённое значение	Описание
changed логическое значение	всегда	проверка того, были ли внесены изменения на устройстве Пример: True
end_state словарь	всегда	k/v пары vtp после выполнения модуля Пример: {'domain': 'testing', 'version': '2', 'vtp_password': ''}
existing словарь	всегда	k/v пары существующего vtp Пример: {'domain': 'testing', 'version': '1', 'vtp_password': ''}
proposed словарь	всегда	k/v пары параметров, переданных в модуль Пример: {'version': '2'}
updates список / элементы=строка	всегда	команда, отправленная устройству Пример: ['vtp version 2']

Авторы

Gabriele Gerbino (@GGabriele)

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