nxos_vtp_domain - Управление конфигурацией домена VTP.
Новая в версии 2.2.
Обзор
- Управление конфигурацией домена VTP.
Параметры
| параметр | обязателен | по умолчанию | возможные значения | комментарии |
|---|---|---|---|---|
| auth_pass (добавлено в 2.4.4)
| нет | нет | Указывает пароль, используемый при необходимости входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлено в 2.4.4)
| нет |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| domain | да | Имя домена VTP. | ||
| host | да | Указывает имя или адрес DNS хоста для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password | нет | Указывает пароль, используемый для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт, используемый при построении соединения с удалённым устройством. Это значение применимо к cli или nxapi. Значение порта по умолчанию соответствует стандартному порту соответствующего транспорта, если оно не указано в задаче (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, который позволяет передавать все аргументы nxos в виде объекта словаря. Все ограничения (обязательность, возможные значения и т. д.) должны быть соблюдены либо отдельными аргументами, либо значениями в этом словаре. | ||
| 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_ssl | нет |
| Настраивает transport на использование SSL, если значение true только при transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых лично сайтах, использующих самозаверенные сертификаты. Если аргумент transport не nxapi, это значение игнорируется. |
Примеры
# ENSURE VTP DOMAIN IS CONFIGURED
- nxos_vtp_domain:
domain: ntc
host: "{{ inventory_hostname }}"
username: "{{ un }}"
password: "{{ pwd }}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| changed | проверка, были ли внесены изменения на устройстве | всегда | boolean | True |
| end_state | параметры домена vtp после выполнения модуля | всегда | словарь | {'domain': 'ntc', 'version': '2', 'vtp_password': ''} |
| existing | параметры существующего домена vtp | всегда | словарь | {'domain': 'testing', 'version': '2', 'vtp_password': ''} |
| proposed | параметры, переданные в модуль | всегда | словарь | {'domain': 'ntc'} |
| updates | команды, отправленные на устройство | всегда | список | ['vtp domain ntc'] |
Примечания
Примечание
- Тестировалось на NXOSv 7.3.(0)D1(1) на VIRL
- Функция VTP должна быть активна на устройстве, чтобы использовать этот модуль.
- Этот модуль используется для управления только именами домена VTP.
- Имена доменов VTP чувствительны к регистру.
- Если домен никогда не настраивался ранее, версия VTP устанавливается по умолчанию в 1. В противном случае предыдущая настроенная версия остается без изменений. Используйте nxos_vtp_version для её изменения.
- Используйте его в сочетании с nxos_vtp_password и nxos_vtp_version для полного управления операциями VTP.
Статус
Этот модуль помечен как preview, что означает, что интерфейс не гарантирует обратную совместимость.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке этого модуля компанией Red Hat, обратитесь к knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для получения помощи в разработке модулей, если вы так желаете, прочитайте Информация о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_vtp_domain_module.html
