nxos_vtp_domain — Управление конфигурацией домена VTP.
Новая версия с 2.2.
Обзор
- Управление конфигурацией домена VTP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| domain обязательно | Имя домена VTP. | ||
| provider | По умолчанию: None | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Дополнительную информацию можно найти в руководстве NXOS Platform Options. Объект словаря, содержащий сведения о подключении. | |
| username | Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в командную строку или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| authorize (добавлен в 2.5.3) |
| Указывает модулю перейти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлен в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| auth_pass (добавлен в 2.5.3) | По умолчанию: none | Указывает пароль, если требуется перейти в привилегированный режим на удаленном устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| timeout (добавлен в 2.3) | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.). | |
| use_ssl |
| Настраивает transport для использования SSL, если установлено в true только когда transport=nxapi, в противном случае это значение игнорируется. | |
| password | По умолчанию: None | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | |
| validate_certs |
None | Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяемые сертификаты. Если аргумент transport не nxapi, это значение игнорируется. | |
| port | По умолчанию: 0 (используется стандартный порт) | Указывает порт для подключения к удаленному устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию устанавливается на соответствующий стандартный порт для транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| transport обязательно | По умолчанию: cli | Настраивает транспортное подключение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Функция VTP должна быть активной на устройстве для использования этого модуля.
- Этот модуль используется только для управления именами доменов VTP.
- Имена доменов VTP чувствительны к регистру.
- Если домен ранее не настраивался, версия VTP устанавливается по умолчанию в 1. В противном случае предыдущая настроенная версия остается без изменений. Для изменения версии используйте nxos_vtp_version.
- Используйте его в сочетании с nxos_vtp_password и nxos_vtp_version для полного управления операциями VTP.
- Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.
Примеры
# ENSURE VTP DOMAIN IS CONFIGURED
- 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'] |
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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.5/modules/nxos_vtp_domain_module.html