nxos_vtp_domain — Управление конфигурацией домена VTP.

Новая версия с 2.2.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Поддержка
- Автор

Обзор

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

Параметры

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

Примечания

Примечание

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

Примеры

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

Возвращаемые значения

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

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

Статус

Этот модуль помечен как preview, что означает, что гарантия обратной совместимости не предоставляется.

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что его обслуживает команда Ansible Network. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.

Для просмотра списка других модулей, которые также поддерживаются командой Ansible Network, см. здесь.

Поддержка

Дополнительную информацию о поддержке этого модуля 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.6/modules/nxos_vtp_domain_module.html