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

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

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

Описание

Управляет настройками конфигурации интерфейса 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). Это список словарей, где каждый словарь содержит источник и префикс, или только префикс, если источник не нужен. Указанные значения будут сконфигурированы на устройстве, и если существуют какие-либо предыдущие префиксы/источники, они будут удалены. Также принимается ключевое слово '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 целое число добавлен в 2.3	По умолчанию: 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 не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с самозаверенными сертификатами. Если аргумент 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	Варианты: нет ← да	Перезапуск 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.
Проверка route-map не выполняется (такая же, как в CLI) при конфигурировании route-map с ‘static-oif’
Если restart установлен в true, а другие параметры установлены, перезапуск произойдет в последнюю очередь, т.е. после выполнения конфигурации. Однако сам ‘restart’ не является идемпотентным, так как это действие, а не конфигурация.
Для получения информации об использовании CLI и NX-API см. руководство NXOS Platform Options
Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство Ansible Network Guide
Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco integration.

Примеры

- 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. [сеть]

Поддержка 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.8/modules/nxos_igmp_interface_module.html