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

Примечание

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

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

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

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

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

Обзор

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

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
group_timeout строка			Устанавливает тайм-аут членства в группе для IGMPv2. Значения могут варьироваться от 3 до 65535 секунд или ключевое слово 'default'. Значение по умолчанию — 260 секунд.
immediate_leave логическое		Варианты: нет да	Включает возможность устройства немедленно удалять запись о группе из таблицы маршрутизации мультимедиа при получении сообщения об уходе из группы. Используйте эту команду, чтобы свести к минимуму задержку ухода из групп 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 логическое	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, используется значение переменной окружения `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`, переменные окружения `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl логическое	Варианты: нет ← да	Настраивает transport для использования SSL, если установлено `yes`, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации соединения с удалённым устройством. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs логическое	Варианты: нет ← да	Если `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 логическое		Варианты: нет да	Настройка отчетов о группах link-local. Включает отправку отчетов о группах в 224.0.0.0/24. Отчеты всегда отправляются для групп, не являющихся link-local. По умолчанию отчеты не отправляются для групп link-local.
restart логическое		Варианты: нет ← да	Перезапуск 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.
Проверка маршрутной карты не выполняется (так же, как и в командной строке) при конфигурировании маршрутной карты с параметром ‘static-oif’
Если параметр перезагрузки установлен в значение true вместе с другими параметрами, перезагрузка произойдёт в последнюю очередь, т.е. после завершения конфигурации. Однако, сама перезагрузка не является идемпотентной, так как это действие, а не конфигурация.
Для получения информации об использовании командной строки и NX-API см. Руководство по параметрам платформы NXOS
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сетям Ansible
Для получения дополнительной информации об использовании 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 словарь	всегда	k/v пары конфигурации интерфейса igmp после выполнения модуля Пример: {'oif_ps': [{'prefix': '238.2.2.6'}, {'prefix': '238.2.2.5', 'source': '192.168.0.1'}], 'startup_query_count': '30'}
existing словарь	всегда	k/v пары существующей конфигурации igmp_interface Пример: {'oif_ps': [], 'startup_query_count': '2'}
proposed словарь	всегда	k/v пары параметров, переданных в модуль Пример: {'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–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_interface_module.html