nxos_vtp_version - Управление конфигурацией версии VTP.
Новое в версии 2.2.
Описание
- Управление конфигурацией версии 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 не будут проверяться. Это следует использовать только на контролируемых локально сайтах, использующих самозаверяющие сертификаты. Если параметр транспорт не nxapi, это значение игнорируется. | |
| port | По умолчанию: 0 (используется стандартный порт) | Указывает порт для подключения к удаленному устройству. Это значение относится к транспорту cli или nxapi. Значение порта по умолчанию будет соответствовать стандартному порту транспорта, если оно не предоставлено в задаче. (cli=22, http=80, https=443). | |
| transport обязательно | По умолчанию: cli | Настраивает транспортное соединение для подключения к удаленному устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| 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 https://www.ansible.com/integrations/networks/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, что означает, что он не гарантирует обратную совместимость.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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_version_module.html