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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
provider -			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр необходим только если вы используете NX-API. Дополнительная информация в руководстве NXOS Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass - добавлено в 2.5.3	Значение по умолчанию: "none"	Указывает пароль, используемый для входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, то этот параметр не оказывает влияния. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлено в 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 - добавлено в 2.3	Значение по умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку. NX-API может быть медленным при выполнении длительных команд (sh mac, sh bgp и т.п.).
	transport - / обязательно	Значение по умолчанию: "cli"	Настраивает транспортное соединение для подключения к удалённому устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy boolean добавлено в 2.5	Варианты: no yes ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl boolean	Варианты: no ← yes	Настраивает транспорт transport для использования SSL, если установлено значение true, только когда `transport=nxapi`, иначе это значение игнорируется.
	username -		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: no yes	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с самозаверяющимися сертификатами. Если параметр transport не nxapi, это значение игнорируется.
state -		Варианты: present ← absent	Управление состоянием ресурса
vtp_password -			Пароль 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
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами можно найти в руководстве по сетям Ansible
Дополнительную информацию об использовании 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 словарь	всегда	пара ключ/значение vtp после выполнения модуля Пример: {'domain': 'ntc', 'version': '1', 'vtp_password': 'new_ntc'}
existing словарь	всегда	пара ключ/значение существующего vtp Пример: {'domain': 'ntc', 'version': '1', 'vtp_password': 'ntc'}
proposed словарь	всегда	пара ключ/значение параметров, переданных в модуль Пример: {'vtp_password': 'new_ntc'}
updates список	всегда	команда, отправленная на устройство Пример: ['vtp password new_ntc']

Статус

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

Поддержка 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.7/modules/nxos_vtp_password_module.html