cisco.nxos.nxos_igmp_interface – Управляет настройками интерфейса IGMP.

Примечание

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

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

Для использования в плейбуке укажите: cisco.nxos.nxos_igmp_interface.

Новое в версии 1.0.0: из cisco.nxos

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

Описание

Управляет настройками интерфейса IGMP.

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
group_timeout строка			Устанавливает таймаут членства в группе для IGMPv2. Значения могут варьироваться от 3 до 65 535 секунд или ключевое слово 'default'. Значение по умолчанию — 260 секунд.
immediate_leave логическое		Варианты: no yes	Включает возможность устройства немедленно удалять запись о группе из таблицы маршрутизации мультимедиа при получении сообщения о выходе из группы. Используйте эту команду для минимизации задержки выхода из групп IGMPv2 на данном интерфейсе IGMP, так как устройство не отправляет запросы, относящиеся к определённой группе. Значение по умолчанию — выключено.
interface строка / обязательно			Полное имя интерфейса для конфигурации IGMP. Например, Ethernet1/2.
last_member_qrt строка			Устанавливает интервал запроса, ожидаемый после отправки сообщений о членстве, прежде чем программное обеспечение удалит состояние группы. Значения могут варьироваться от 1 до 25 секунд или ключевое слово 'default'. Значение по умолчанию — 1 секунда.
last_member_query_count строка			Устанавливает количество раз, которое программное обеспечение отправляет запрос IGMP в ответ на сообщение о выходе узла. Значения могут варьироваться от 1 до 5 или ключевое слово 'default'. Значение по умолчанию — 2.
oif_ps сырые данные			Настройка префиксов и источников для статического исходящего интерфейса (OIF). Это список словарей, где каждый словарь содержит источник и префикс, или только префикс, если источник не нужен. Указанные значения будут настроены на устройстве, и если существуют какие-либо предыдущие префиксы/источники, они будут удалены. Ключевое слово 'default' также принимается, что удаляет все существующие префиксы/источники.
oif_routemap строка			Настройка карты маршрутизации для статического исходящего интерфейса (OIF) или ключевое слово 'default'.
provider словарь			Устарело Начиная с Ansible 2.5, мы рекомендуем использовать `connection: network_cli`. Начиная с Ansible 2.6, мы рекомендуем использовать `connection: httpapi` для NX-API. Этот параметр будет удалён в релизе после 2022-06-01. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения.
	auth_pass строка		Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize логическое	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение параметра host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль, используемый для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port целое число		Указывает порт, используемый при построении подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует общепринятому порту транспорта, если он не указан в задаче (cli=22, http=80, https=443).
	ssh_keyfile строка		Указывает SSH-ключ, используемый для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно отвечать на длительные команды (команды sh mac, sh bgp и т. д.).
	transport строка	Варианты: cli ← nxapi	Настраивает транспортное соединение, используемое при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству по протоколам cli (ssh) или nxapi.
	use_proxy логическое	Варианты: no yes ←	Если `no`, переменные среды `http_proxy` и `https_proxy` будут игнорироваться.
	use_ssl логическое	Варианты: no ← yes	Настраивает transport на использование SSL, если установлено значение `yes` только в случае `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя, используемое для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды `ANSIBLE_NET_USERNAME`.
	validate_certs логическое	Варианты: no ← yes	Если `no`, сертификаты SSL не будут проверяться. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов. Если аргумент transport не является nxapi, это значение игнорируется.
querier_timeout строка			Устанавливает таймаут запроса, который программное обеспечение использует для принятия решения о передаче роли запроса. Значения могут варьироваться от 1 до 65535 секунд или ключевое слово 'default'. Значение по умолчанию — 255 секунд.
query_interval строка			Устанавливает частоту, с которой программное обеспечение отправляет сообщения IGMP-запроса хосту. Значения могут варьироваться от 1 до 18000 секунд или ключевое слово 'default'. Значение по умолчанию — 125 секунд.
query_mrt строка			Устанавливает время отклика, объявленное в запросах IGMP. Значения могут варьироваться от 1 до 25 секунд или ключевое слово 'default'. Значение по умолчанию — 10 секунд.
report_llg логическое		Варианты: no yes	Настраивает report-link-local-groups. Включает отправку отчётов для групп в 224.0.0.0/24. Отчёты всегда отправляются для групп, не относящихся к link-local. По умолчанию отчёты не отправляются для групп link-local.
restart логическое		Варианты: no ← yes	Перезапуск IGMP. Это НЕ идемпотентная операция, так как это только действие.
robustness строка			Устанавливает переменную надёжности. Значения могут варьироваться от 1 до 7 или ключевое слово 'default'. Значение по умолчанию — 2.
startup_query_count строка			Количество запросов, используемых при запуске процесса IGMP. Диапазон значений — от 1 до 10 или ключевое слово 'default'. Значение по умолчанию — 2.
startup_query_interval строка			Интервал запросов, используемый при запуске процесса IGMP. Диапазон значений — от 1 до 18000 или ключевое слово 'default'. Значение по умолчанию — 31.
state строка		Варианты: present ← absent default	Управляет желаемым состоянием ресурса.
version строка		Варианты: 2 3 default	Версия IGMP. Может быть 2, 3 или ключевое слово 'default'.

Примечания

Примечание

Тестировано на NXOSv 7.3.(0)D1(1) на VIRL
При state=default, поддерживаемые параметры будут сброшены до значения по умолчанию. Это включает version, startup_query_interval, startup_query_count, robustness, querier_timeout, query_mrt, query_interval, last_member_qrt, last_member_query_count, group_timeout, report_llg и immediate_leave.
При state=absent, все конфигурации для oif_ps и oif_routemap будут удалены.
Для использования данного модуля необходимо включить PIM.
Данный модуль предназначен для интерфейсов уровня 3.
Проверка маршрутной карты не выполняется (так же, как и в CLI) при конфигурации маршрутной карты с 'static-oif'
Если параметр restart установлен в значение true вместе с другими параметрами, перезагрузка произойдёт последней, т.е. после выполнения конфигурации. Однако, 'restart' сам по себе не идемпотентен, так как это действие, а не конфигурация.
Для получения информации об использовании CLI и NX-API см. руководство NXOS Platform Options
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство Ansible Network Guide
Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco.

Примеры

- cisco.nxos.nxos_igmp_interface:
    interface: ethernet1/32
    startup_query_interval: 30
    oif_ps:
    - {prefix: 238.2.2.6}
    - {source: 192.168.0.1, prefix: 238.2.2.5}
    state: present

Значения возврата

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

Ключ	Возвращаемое значение	Описание
changed boolean	всегда	индикация, было ли произведено изменение на устройстве Пример: True
end_state словарь	всегда	пара ключ-значение конфигурации интерфейса igmp после выполнения модуля Пример: {'oif_ps': [{'prefix': '238.2.2.6'}, {'prefix': '238.2.2.5', 'source': '192.168.0.1'}], 'startup_query_count': '30'}
existing словарь	всегда	пара ключ-значение существующей конфигурации igmp_interface Пример: {'oif_ps': [], 'startup_query_count': '2'}
proposed словарь	всегда	пара ключ-значение параметров, переданных в модуль Пример: {'oif_ps': [{'prefix': '238.2.2.6'}, {'prefix': '238.2.2.5', 'source': '192.168.0.1'}], 'startup_query_count': '30'}
updates список / элементы=строка	всегда	команды, отправленные на устройство Пример: ['interface Ethernet1/32', 'ip igmp startup-query-count 30', 'ip igmp static-oif 238.2.2.6', 'ip igmp static-oif 238.2.2.5 source 192.168.0.1']

Авторы

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_interface_module.html