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