cisco.nxos.nxos_igmp – Управляет глобальной конфигурацией IGMP.

Примечание

Этот плагин входит в коллекцию cisco.nxos (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install cisco.nxos.

Для использования в playbook, укажите: cisco.nxos.nxos_igmp.

Новое в версии 1.0.0: модуля cisco.nxos

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Управляет настройками глобальной конфигурации IGMP.

Примечание

У этого модуля есть соответствующий плагин действий.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
enforce_rtr_alert boolean		Варианты: no yes	Включает или отключает проверку опции "enforce router alert" для пакетов IGMPv2 и IGMPv3.
flush_routes boolean		Варианты: no yes	Удаляет маршруты при перезапуске процесса IGMP. По умолчанию маршруты не удаляются.
provider dictionary			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Начиная с Ansible 2.6, рекомендуется использовать `connection: httpapi` для NX-API. Этот параметр будет удален в выпуске после 2022-06-01. Дополнительную информацию см. в руководстве NXOS Platform Options. Словарь, содержащий данные подключения.
	auth_pass string		Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host string		Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password string		Указывает пароль для аутентификации подключения к удаленному устройству. Этот аргумент обычно используется для транспорта cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port integer		Указывает порт для подключения к удаленному устройству. Это значение применимо к cli или nxapi. Если порт не указан в задаче, используется стандартный порт для соответствующего транспорта (cli=22, http=80, https=443).
	ssh_keyfile string		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout integer		Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечет до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (sh mac, sh bgp и т. д.).
	transport string	Варианты: cli ← nxapi	Устанавливает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy boolean	Варианты: no yes ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl boolean	Варианты: no ← yes	Настраивает transport для использования SSL, если значение равно `yes`, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username string		Устанавливает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: no ← yes	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, которые используют самозаверяющие сертификаты. Если аргумент transport не nxapi, это значение игнорируется.
restart boolean		Варианты: no ← yes	Перезапускает процесс igmp (используя команду exec config).
state string		Варианты: present ← default	Управляет желаемым состоянием ресурса.

Примечания

Примечание

Проверено на 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)
  cisco.nxos.nxos_igmp:
    state: default

- name: Ensure the following igmp global config exists on the device
  cisco.nxos.nxos_igmp:
    flush_routes: true
    enforce_rtr_alert: true

- name: Restart the igmp process
  cisco.nxos.nxos_igmp:
    restart: true

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
updates list / elements=string	всегда	Команды, отправленные на устройство Пример: ['ip igmp flush-routes']

Авторы

Jason Edelman (@jedelman8)
Gabriele Gerbino (@GGabriele)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_igmp_module.html