nxos_igmp – Управляет глобальной конфигурацией IGMP
Описание
- Управляет настройками глобальной конфигурации IGMP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| enforce_rtr_alert boolean |
| Включает или отключает проверку параметра enforce router alert для пакетов IGMPv2 и IGMPv3. | |
| flush_routes boolean |
| Удаляет маршруты при перезапуске процесса IGMP. По умолчанию, маршруты не очищаются. | |
| provider dictionary | Устаревший Начиная с Ansible 2.5, рекомендуем использовать connection: network_cli. Этот параметр необходим только если используется NX-API. Дополнительную информацию можно найти в руководстве NXOS Platform Options. Объект словаря, содержащий детали подключения. | ||
| auth_pass string добавлен в 2.5.3 | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это требуется. Если authorize имеет значение false, этот аргумент не используется. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean добавлен в 2.5.3 |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host string / обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password string | Указывает пароль для аутентификации подключения к удаленному устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port integer | Значение по умолчанию: "0 (использовать общий порт)" | Указывает порт для подключения к удаленному устройству. Это значение применяется к транспорту cli или nxapi. Значение порта по умолчанию будет соответствовать обычному порту для транспорта, если не указано в задаче. (cli=22, http=80, https=443). | |
| ssh_keyfile string | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.). | |
| transport string / обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству по протоколам cli (ssh) или nxapi. | |
| use_proxy boolean добавлен в 2.5 |
| Если no, переменные окружения http_proxy и https_proxy будут игнорироваться. | |
| use_ssl boolean |
| Настраивает transport для использования SSL, если установлено значение yes, только если transport=nxapi, иначе это значение игнорируется. | |
| username string | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых вами, с самозаверяющими сертификатами. Если аргумент транспорт не nxapi, это значение игнорируется. | |
| restart boolean |
| Перезапускает процесс igmp (используя команду exec config). | |
| state - |
| Управляет желаемым состоянием ресурса. | |
Примечания
Примечание
- Тестировано на NXOSv 7.3.(0)D1(1) на VIRL
- Когда
state=default, все поддерживаемые параметры будут сброшены до значения по умолчанию. - Если restart установлен в true, а другие параметры настроены, перезапуск произойдёт последним, т.е. после того, как будет выполнена конфигурация.
- Дополнительную информацию о работе с CLI и NX-API см. в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: Default igmp global params (all params except restart)
nxos_igmp:
state: default
- name: Ensure the following igmp global config exists on the device
nxos_igmp:
flush_routes: true
enforce_rtr_alert: true
- name: Restart the igmp process
nxos_igmp:
restart: true
Возвращаемые значения
Общие возвращаемые значения описаны в разделе здесь, ниже перечислены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| updates list | всегда | Команды, отправленные на устройство Пример: ['ip igmp flush-routes'] |
Статус
- Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
- Этот модуль поддерживается командой Ansible Network. [сеть]
Поддержка Red Hat
Дополнительную информацию о поддержке данного модуля компанией Red Hat можно найти в статье Red Hat Knowledge Base.
Авторы
- Jason Edelman (@jedelman8)
- 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.9/modules/nxos_igmp_module.html
