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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: cisco.nxos.nxos_vtp_domain.

Новое в версии 1.0.0: cisco.nxos

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

Обзор

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

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
domain строка / обязательно			Имя домена 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, это значение игнорируется.

Примечания

Примечание

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

Примеры

# ENSURE VTP DOMAIN IS CONFIGURED
- cisco.nxos.nxos_vtp_domain:
    domain: ntc
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'

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

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

Ключ	Возвращаемое значение	Описание
changed булево	всегда	проверка изменения на устройстве Пример: True
end_state словарь	всегда	k/v пары домена vtp после выполнения модуля Пример: {'domain': 'ntc', 'version': '2', 'vtp_password': ''}
existing словарь	всегда	k/v пары существующего домена vtp Пример: {'domain': 'testing', 'version': '2', 'vtp_password': ''}
proposed словарь	всегда	k/v пары параметров, переданных в модуль Пример: {'domain': 'ntc'}
updates список / элементы=строка	всегда	команда, отправленная на устройство Пример: ['vtp domain 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_domain_module.html