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

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

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

Параметры

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

Примечания

Примечание

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

Примеры

# ENSURE VTP VERSION IS 2
- 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']

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается командой Ansible Network. [network]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.

Авторы

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.9/modules/nxos_vtp_version_module.html