nxos_igmp — Управление глобальной конфигурацией IGMP.
Новая версия 2.2.
Описание
- Управление параметрами глобальной конфигурации IGMP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| enforce_rtr_alert |
Значение по умолчанию: Нет |
Включает или отключает проверку параметра предупреждения маршрутизатора для пакетов IGMPv2 и IGMPv3. |
|
| flush_routes |
Значение по умолчанию: Нет |
Удаляет маршруты при перезапуске процесса IGMP. По умолчанию маршруты не очищаются. |
|
| provider | Значение по умолчанию: Нет |
Устарело Начиная с 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) |
Значение по умолчанию: нет |
Указывает пароль, если требуется для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. |
|
| host обязательно |
Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве целевого адреса для транспорта. |
||
| timeout (добавлено в 2.3) |
Значение по умолчанию: 10 |
Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истечет до завершения операции, модуль вернет ошибку. NX-API может медленно возвращаться при выполнении длительных команд (sh mac, sh bgp и т. д.). |
|
| use_ssl |
|
Настраивает транспорт для использования SSL, если значение равно true только когда transport=nxapi, в противном случае это значение игнорируется. |
|
| password | Значение по умолчанию: Нет |
Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. |
|
| validate_certs |
Значение по умолчанию: Нет |
Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых вами лично, с использованием самозаверяющих сертификатов. Если аргумент transport не nxapi, это значение игнорируется. |
|
| port | Значение по умолчанию: 0 (использовать стандартный порт) |
Указывает порт для построения подключения к удаленному устройству. Это значение относится как к транспорту cli, так и к nxapi. Значение порта будет по умолчанию соответствовать общему порту соответствующего транспорта, если в задаче ничего не указано (cli=22, http=80, https=443). |
|
| transport обязательно |
Значение по умолчанию: cli |
Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству по протоколу cli (ssh) или nxapi. |
|
| restart |
Значение по умолчанию: Нет |
Перезапускает процесс 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'] |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Поддержка
Дополнительную информацию о поддержке этого модуля 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.5/modules/nxos_igmp_module.html