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

Примечание

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

Для его установки используйте: ansible-galaxy collection install cisco.nxos.

Для использования в плейбуке укажите: cisco.nxos.nxos_vtp_password.

В версии 1.0.0: коллекции cisco.nxos

Обзор
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Примечание

У данного модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Начиная с Ansible 2.6, рекомендуется использовать `connection: httpapi` для NX-API. Этот параметр будет удалён в релизе после 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, это значение игнорируется.
state строка		Варианты: present ← absent	Управление состоянием ресурса
vtp_password строка			Пароль VTP

Примечания

Примечание

Тестировалось на NXOSv 7.3.(0)D1(1) на VIRL
Функция VTP должна быть активирована на устройстве для использования этого модуля.
Этот модуль используется только для управления паролями VTP.
Используйте его в сочетании с cisco.nxos.nxos_vtp_domain и cisco.nxos.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
- cisco.nxos.nxos_vtp_password:
    state: present
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'

# ENSURE VTP PASSWORD IS REMOVED
- cisco.nxos.nxos_vtp_password:
    state: absent
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'

Значения возврата

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

Ключ	Возвращаемое значение	Описание
changed логическое значение	всегда	проверка, были ли внесены изменения на устройстве Пример: 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']

Авторы

Gabriele Gerbino (@GGabriele)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_vtp_password_module.html