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

Новая в версии 2.2.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Поддержка
- Автор

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
group_timeout			Устанавливает таймаут членства в группе для IGMPv2. Значения могут варьироваться от 3 до 65 535 секунд или ключевое слово 'default'. По умолчанию 260 секунд.
immediate_leave bool		Варианты: 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_prefix			Этот аргумент устарел, используйте вместо него oif_ps. Настройте префикс для статического исходящего интерфейса (OIF).
oif_ps (добавлен в 2.6)			Настройка префиксов и источников для статического исходящего интерфейса (OIF). Это список словарей, где каждый словарь определяет источник и префикс или только префикс, если источник не нужен. Указанные значения будут настроены на устройстве, а если существуют предыдущие префиксы/источники, они будут удалены. Также принимается ключевое слово 'default', которое удаляет все существующие префиксы/источники.
oif_routemap			Настройка карты маршрутизации для статического исходящего интерфейса (OIF) или ключевое слово 'default'.
oif_source			Этот аргумент устарел, используйте вместо него oif_ps. Настройте источник для статического исходящего интерфейса (OIF).
provider			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации, см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения.
	host обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	port	По умолчанию: "0 (использовать общий порт)"	Указывает порт для использования при построении соединения с удалённым устройством. Это значение применимо как к cli, так и к nxapi. Значение порта будет по умолчанию установлено на соответствующий общий порт транспорта, если не указан в задаче. (cli=22, http=80, https=443).
	username		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	password		Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	authorize bool (добавлен в 2.5.3)	Варианты: no ← yes	Указывает модулю перейти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	auth_pass (добавлен в 2.5.3)	По умолчанию: "none"	Указывает пароль для использования при необходимости перехода в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	timeout (добавлен в 2.3)	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно реагировать на длительные команды (sh mac, sh bgp и т. д.).
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	transport обязательно	По умолчанию: "cli"	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi.
	use_ssl bool	Варианты: no ← yes	Настраивает транспорт для использования SSL, если значение равно true, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	validate_certs bool	Варианты: no yes	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, использующих самозаверяющие сертификаты. Если аргумент transport не является nxapi, это значение игнорируется.
	use_proxy bool (добавлен в 2.5)	Варианты: no yes ←	Если `no`, переменные среды `http_proxy` и `https_proxy` будут проигнорированы.
querier_timeout			Устанавливает таймаут запросов, используемый программным обеспечением при принятии решения о переходе на роль запросителя. Значения могут варьироваться от 1 до 65535 секунд или ключевое слово 'default'. По умолчанию 255 секунд.
query_interval			Устанавливает частоту отправки программным обеспечением сообщений запроса IGMP хоста. Значения могут варьироваться от 1 до 18000 секунд или ключевое слово 'default'. По умолчанию 125 секунд.
query_mrt			Устанавливает время ответа, объявленное в запросах IGMP. Значения могут варьироваться от 1 до 25 секунд или ключевое слово 'default'. По умолчанию 10 секунд.
report_llg bool		Варианты: no yes	Настройка отправки отчетов о link-local группах. Включает отправку отчетов о группах в 224.0.0.0/24. Отчеты всегда отправляются для групп, не являющихся link local. По умолчанию отчеты не отправляются для link local групп.
restart bool		Варианты: 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.

Примеры

- 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 dict	всегда	параметры конфигурации интерфейса igmp после выполнения модуля Пример: {'startup_query_count': '30', 'oif_ps': [{'prefix': '238.2.2.6'}, {'source': '192.168.0.1', 'prefix': '238.2.2.5'}]}
existing dict	всегда	параметры существующей конфигурации igmp_interface Пример: {'startup_query_count': '2', 'oif_ps': []}
proposed dict	всегда	параметры, переданные в модуль Пример: {'startup_query_count': '30', 'oif_ps': [{'prefix': '238.2.2.6'}, {'source': '192.168.0.1', 'prefix': '238.2.2.5'}]}
updates list	всегда	команды, отправленные на устройство Пример: ['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']

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантированно будет обратной совместимым.

Техническое обслуживание

Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible по сетевым технологиям. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, поддерживаемых командой Ansible по сетевым технологиям, см. здесь.

Поддержка

Дополнительную информацию о поддержке данного модуля компанией Red Hat см. в этой статье базы знаний.

Автор

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.6/modules/nxos_igmp_interface_module.html