nxos_vtp_version — Управление конфигурацией версии VTP.
Новая версия с 2.2.
Описание
- Управление конфигурацией версии VTP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| provider | Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект типа dict, содержащий данные подключения. | ||
| host обязательно | Указывает имя или адрес хоста DNS для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве целевого адреса для транспорта. | ||
| port | По умолчанию: "0 (использовать стандартный порт)" | Указывает порт для использования при установлении соединения с удалённым устройством. Это значение применяется к cli или nxapi. Значение порта по умолчанию соответствует стандартному порту транспорта, если он не задан в задании. (cli=22, http=80, https=443). | |
| username | Настройка имени пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий параметр, используемый для транспортов cli или nxapi. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлено в 2.5.3) |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой каких-либо команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлено в 2.5.3) | По умолчанию: "нет" | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это необходимо. Если authorize ложно, то этот параметр ничего не делает. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| timeout (добавлено в 2.3) | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т.д.). | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно | По умолчанию: "cli" | Настраивает транспортное подключение для подключения к удалённому устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl bool |
| Настраивает transport на использование SSL, если значение равно true, только при transport=nxapi, в противном случае это значение игнорируется. | |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Если параметр transport не nxapi, это значение игнорируется. | |
| use_proxy bool (добавлено в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| version обязательно |
| Номер версии VTP. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Функция VTP должна быть активной на устройстве для использования этого модуля.
- Этот модуль используется только для управления версией VTP.
- Используйте его в сочетании с nxos_vtp_password и nxos_vtp_version для полного управления операциями VTP.
- Сведения об использовании CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительные сведения об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительные сведения об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
# ENSURE VTP VERSION IS 2
- nxos_vtp_version:
version: 2
host: "{{ inventory_hostname }}"
username: "{{ un }}"
password: "{{ pwd }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed boolean | всегда | проверка внесённых изменений на устройстве Пример: True |
| end_state dict | всегда | пар k/v vtp после выполнения модуля Пример: {'domain': 'testing', 'version': '2', 'vtp_password': ''} |
| existing dict | всегда | пар k/v существующих значений vtp Пример: {'domain': 'testing', 'version': '1', 'vtp_password': ''} |
| proposed dict | всегда | пар k/v параметров, переданных в модуль Пример: {'version': '2'} |
| updates list | всегда | команды, отправленные на устройство Пример: ['vtp version 2'] |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантированно будет совместим со старыми версиями.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible Network Team. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, которые также поддерживаются командой Ansible Network Team, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний
Автор
- Габриэле Гербино (@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.6/modules/nxos_vtp_version_module.html