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

Примечание

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

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

Для использования в playbook, укажите: 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 словарь	всегда	k/v пары VTP после выполнения модуля Пример: {'domain': 'ntc', 'version': '1', 'vtp_password': 'new_ntc'}
existing словарь	всегда	k/v пары существующих параметров VTP Пример: {'domain': 'ntc', 'version': '1', 'vtp_password': 'ntc'}
proposed словарь	всегда	k/v пары параметров, переданных в модуль Пример: {'vtp_password': 'new_ntc'}
updates список / элементы=строка	всегда	команда, отправленная на устройство Пример: ['vtp password new_ntc']

Авторы

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.10/collections/cisco/nxos/nxos_vtp_password_module.html