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

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

Краткое описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
group_timeout -			Устанавливает таймаут членства в группе для IGMPv2. Значения могут варьироваться от 3 до 65535 секунд или ключевое слово '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). Это список словарей, где каждый словарь имеет определенные значения для source и prefix или только prefix, если source не нужен. Указанные значения будут настроены на устройстве, и если какие-либо предыдущие префиксы/источники существуют, они будут удалены. Ключевое слово '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		Указывает пароль для использования при необходимости входа в привилегированный режим на удалённом устройстве. Если 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 целое число	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль сообщит об ошибке. NX-API может медленно возвращать данные при длительных командах (sh mac, sh bgp и т.д.).
	transport строка / обязательно	Варианты: cli ← nxapi	Настраивает транспортное подключение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по cli (ssh) или nxapi.
	use_proxy boolean добавлен в 2.5	Варианты: no yes ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут игнорироваться.
	use_ssl boolean	Варианты: no ← yes	Настраивает transport на использование SSL, если установлено `yes`, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, вместо него используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверенными сертификатами. Если транспортный аргумент не 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. Отчеты всегда отправляются для групп, не являющихся локальными связями. По умолчанию отчеты не отправляются для локальных групп.

END_OF_DOCUMENT_MARKER

restart boolean	Варианты: нет ← да	Перезапуск IGMP. Это НЕ идемпотентно, так как это только действие.
robustness -		Устанавливает переменную устойчивости. Значения могут варьироваться от 1 до 7 или ключевое слово 'default'. Значение по умолчанию - 2.
startup_query_count -		Количество запросов при запуске процесса IGMP. Диапазон от 1 до 10 или ключевое слово 'default'. Значение по умолчанию - 2.
startup_query_interval -		Интервал запросов при запуске процесса IGMP. Диапазон от 1 до 18000 или ключевое слово 'default'. Значение по умолчанию - 31.
state -	Варианты: присутствует ← отсутствует по умолчанию	Управляет желаемым состоянием ресурса.
version -	Варианты: 2 3 по умолчанию	Версия 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’
Если restart установлен в значение true с другими параметрами, перезапуск произойдет последним, т.е. после настройки. Однако сам ‘restart’ не является идемпотентным, так как это действие, а не конфигурация.
Для получения информации об использовании командной строки и NX-API см. Руководство по параметрам платформы NXOS
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
Дополнительную информацию об использовании 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 словарь	всегда	Пара-значение конфигурации интерфейса igmp после выполнения модуля Пример: {'startup_query_count': '30', 'oif_ps': [{'prefix': '238.2.2.6'}, {'source': '192.168.0.1', 'prefix': '238.2.2.5'}]}
existing словарь	всегда	Пара-значение существующей конфигурации igmp_interface Пример: {'startup_query_count': '2', 'oif_ps': []}
proposed словарь	всегда	Пара-значение параметров, переданных в модуль Пример: {'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. [сеть]

Поддержка Red Hat

Дополнительную информацию о поддержке данного модуля компанией Red Hat можно найти в статье базы знаний 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.9/modules/nxos_igmp_interface_module.html