nxos_igmp - Управляет глобальной конфигурацией IGMP.
Новое в версии 2.2.
Описание
- Управляет настройками глобальной конфигурации IGMP.
Параметры
| параметр | обязательный | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| auth_pass (добавлено в 2.4.4)
| нет | нет | Указывает пароль, используемый при необходимости входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлено в 2.4.4)
| нет |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| enforce_rtr_alert | нет |
| Включает или отключает проверку параметра enforce router alert для пакетов IGMPv2 и IGMPv3. | |
| flush_routes | нет |
| Удаляет маршруты при перезапуске процесса IGMP. По умолчанию маршруты не очищаются. | |
| host | да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение применяется к cli или nxapi. Значение порта по умолчанию соответствует стандартному порту транспорта, если он не указан в задаче (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передавать все аргументы nxos в виде объекта словаря. Все ограничения (обязательные параметры, варианты и т. д.) должны быть соблюдены либо отдельными аргументами, либо значениями в этом словаре. | ||
| restart | нет |
| Перезапускает процесс igmp (используя команду exec config). | |
| ssh_keyfile | нет | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| state | нет | present |
| Управляет желаемым состоянием ресурса. |
| timeout (добавлено в 2.3)
| нет | 10 | Указывает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно реагировать на длительные команды (sh mac, sh bgp и т. д.). | |
| transport | да | cli | Настраивает транспортное подключение для соединения с удалённым устройством. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl | нет |
| Настраивает transport для использования SSL, если значение true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Если аргумент transport не является nxapi, это значение игнорируется. |
Примеры
- name: Default igmp global params (all params except restart)
nxos_igmp:
state: default
host: "{{ inventory_hostname }}"
- name: Ensure the following igmp global config exists on the device
nxos_igmp:
flush_routes: true
enforce_rtr_alert: true
host: "{{ inventory_hostname }}"
- name: Restart the igmp process
nxos_igmp:
restart: true
host: "{{ inventory_hostname }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращаемое | тип | пример |
|---|---|---|---|---|
| updates | команды, отправленные устройству | всегда | список | ['ip igmp flush-routes'] |
Примечания
Примечание
- Тестировано на NXOSv 7.3.(0)D1(1) на VIRL
- При
state=default, все поддерживаемые параметры будут сброшены до состояния по умолчанию. - Если restart установлено в true с другими установленными параметрами, перезапуск произойдёт в последнюю очередь, т. е. после выполнения конфигурации.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.
Информация о техническом обслуживании
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>.
Для помощи в разработке модулей, если вы так склонны, прочитайте Информацию о сообществе и вклад, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_igmp_module.html
