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

Примечание

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

Для его установки используйте: 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, для NX-API рекомендуется использовать `connection: httpapi`. Этот параметр будет удален в выпуске после 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/nxos/nxos_vtp_version_module.html