nxos_vtp_domain – Управление конфигурацией домена VTP.
Новая версия с 2.2.
Краткое описание
- Управляет конфигурацией домена VTP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| domain - / обязательно | Имя домена VTP. | ||
| provider - | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий детали соединения. | ||
| auth_pass - добавлено в 2.5.3 | По умолчанию: "none" | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize false, этот аргумент не выполняет никаких действий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize boolean добавлено в 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 - / обязательно | По умолчанию: "cli" | Устанавливает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy boolean добавлено в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Устанавливает использование SSL для транспорта, если значение равно true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username - | Указывает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Если аргумент транспорта не nxapi, это значение игнорируется. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Функция VTP должна быть активна на устройстве для использования этого модуля.
- Этот модуль используется только для управления именами домена VTP.
- Имена домена VTP чувствительны к регистру.
- Если домен VTP не был настроен ранее, версия VTP устанавливается по умолчанию в 1. В противном случае предыдущая настроенная версия не изменяется. Используйте nxos_vtp_version для её изменения.
- Используйте его в сочетании с nxos_vtp_password и nxos_vtp_version для полного управления операциями VTP.
- Для получения информации об использовании CLI и NX-API см. руководство NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
# 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'] |
Статус
- Данный модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается командой Ansible Network Team. [сеть]
Поддержка 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.7/modules/nxos_vtp_domain_module.html