nxos_igmp - Управляет глобальной конфигурацией IGMP.
Новая версия с 2.2.
Описание
- Управляет параметрами глобальной конфигурации IGMP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| enforce_rtr_alert bool |
| Включает или отключает проверку опции уведомления маршрутизатора для пакетов IGMPv2 и IGMPv3. | |
| flush_routes bool |
| Удаляет маршруты при перезапуске процесса IGMP. По умолчанию маршруты не удаляются. | |
| 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 | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в командную строку или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Этот параметр обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| authorize bool (добавлено в 2.5.3) |
| Указывает модулю перейти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| auth_pass (добавлено в 2.5.3) | Значение по умолчанию: "none" | Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если 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 будут проигнорированы. | |
| restart bool |
| Перезапускает процесс igmp (используя команду exec config). | |
| state |
| Управляет желаемым состоянием ресурса. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Если
state=default, все поддерживаемые параметры будут сброшены в состояние по умолчанию. - Если restart установлено в true, а другие параметры установлены, перезапуск произойдет последним, т.е. после того, как конфигурация будет выполнена.
- Дополнительная информация о использовании командной строки и 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 список | всегда | Команды, отправленные на устройство Пример: ['ip igmp flush-routes'] |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантированно будет обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible Network. Подробности см. в поддержке модулей.
Список других модулей, также поддерживаемых командой Ansible Network, см. в здесь.
Поддержка
Для получения дополнительной информации о поддержке этого модуля компанией Red Hat, обратитесь к этой статье базы знаний.
Автор
- 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.6/modules/nxos_igmp_module.html
