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

Примечание

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

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

Чтобы использовать его в книге задач, укажите: 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, для NX-API рекомендуется использовать `connection: httpapi`. Этот параметр будет удалён в версии после 2022-06-01. Дополнительную информацию см. в руководстве NXOS Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass string		Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной окружения `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 да ←	Если `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 не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверенными сертификатами. Если аргумент 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/nxos/nxos_igmp_module.html