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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
group_timeout -			Устанавливает таймаут членства в группе для IGMPv2. Значения могут варьироваться от 3 до 65 535 секунд или ключевое слово 'default'. Значение по умолчанию — 260 секунд.
immediate_leave boolean		Варианты: 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. Объект словаря, содержащий данные подключения.
	auth_pass - добавлено в 2.5.3	По умолчанию: "none"	Указывает пароль для использования при входе в привилегированный режим на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, будет использоваться значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлено в 2.5.3	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	host - / обязательно		Указывает имя хоста DNS или адрес для подключения к удаленному устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта.
	password -		Указывает пароль для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_PASSWORD`.
	port -	По умолчанию: "0 (использовать общий порт)"	Указывает порт, используемый при построении подключения к удалённому устройству. Это значение применяется к cli или nxapi. Значение порта будет по умолчанию соответствовать общему порту соответствующего транспорта, если в задаче не указано иное. (cli=22, http=80, https=443).
	ssh_keyfile -		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	timeout - добавлено в 2.3	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.).
	transport - / обязательно	По умолчанию: "cli"	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi.
	use_proxy boolean добавлено в 2.5	Варианты: no yes ←	Если `no`, переменные среды `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl boolean	Варианты: no ← yes	Настраивает transport на использование SSL, если значение равно true, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username -		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: 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 boolean		Варианты: no yes	Настраивает report-link-local-groups. Включает отправку отчетов о группах в 224.0.0.0/24. Отчеты всегда отправляются для групп, не относящихся к локальной сети. По умолчанию отчеты не отправляются для групп локальной сети.
restart boolean		Варианты: no ← yes	Перезапустить IGMP. Это НЕ идемпотентная операция, так как это действие только.

устойчивость -		Устанавливает переменную устойчивости. Значения могут варьироваться от 1 до 7 или ключевое слово 'default'. По умолчанию значение равно 2.
startup_query_count -		Количество запросов, используемых при запуске процесса IGMP. Диапазон от 1 до 10 или ключевое слово 'default'. По умолчанию значение равно 2.
startup_query_interval -		Интервал запросов, используемых при запуске процесса IGMP. Диапазон от 1 до 18000 или ключевое слово 'default'. По умолчанию значение равно 31.
состояние -	Варианты: present ← absent default	Управляет желаемым состоянием ресурса.
версия -	Варианты: 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'.
Если перезагрузка установлена в true вместе с другими параметрами, перезагрузка произойдёт последней, т.е. после того, как конфигурация будет выполнена. Однако, сама перезагрузка не является идемпотентной, так как это действие, а не конфигурация.
Для получения информации об использовании CLI и NX-API см. Руководство по параметрам платформы NXOS
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. Руководство по сетям Ansible
Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco https://www.ansible.com/integrations/networks/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 словарь	всегда	k/v пары конфигурации интерфейса igmp после выполнения модуля Пример: {'startup_query_count': '30', 'oif_ps': [{'prefix': '238.2.2.6'}, {'source': '192.168.0.1', 'prefix': '238.2.2.5'}]}
existing словарь	всегда	k/v пары существующей конфигурации igmp_interface Пример: {'startup_query_count': '2', 'oif_ps': []}
proposed словарь	всегда	k/v пары параметров, переданных в модуль Пример: {'startup_query_count': '30', 'oif_ps': [{'prefix': '238.2.2.6'}, {'source': '192.168.0.1', 'prefix': '238.2.2.5'}]}
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']

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается командой Ansible Network Team. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке Red Hat этого модуля можно найти в этой статье базы знаний Red Hat: https://access.redhat.com/articles/3166901.

Авторы

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