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

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

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

Описание

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

Параметры

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

Примечания

Примечание

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

Примеры

# ENSURE VTP PASSWORD IS SET
- nxos_vtp_password:
    state: present
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

# ENSURE VTP PASSWORD IS REMOVED
- nxos_vtp_password:
    state: absent
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

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

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

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

Статус

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

Поддержка

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