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

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

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

Описание

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

Параметры

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

Примечания

Примечание

Тестировано на 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_prefix, oif_source, и oif_routemap будут удалены.
Для использования этого модуля необходимо включить PIM.
Этот модуль предназначен для интерфейсов уровня 3.
Проверка маршрутной карты не выполняется (также как в CLI) при настройке маршрутной карты с 'static-oif'
Если перезапуск установлен в true вместе с другими параметрами, перезапуск произойдет последним, т. е. после завершения конфигурации.
Дополнительную информацию об использовании CLI и NX-API см. в руководстве NXOS Platform Options
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco Cisco integration page.

Примеры

- nxos_igmp_interface:
    interface: ethernet1/32
    startup_query_interval: 30
    state: present

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
changed boolean	всегда	проверка, было ли внесено изменение на устройстве Пример: True
end_state dict	всегда	k/v пары конфигурации BGP после выполнения модуля Пример: {'router_id': '1.1.1.1', 'neighbor_down_fib_accelerate': False, 'confederation_peers': '', 'confederation_id': '', 'bestpath_compare_neighborid': False, 'local_as': '', 'bestpath_always_compare_med': False, 'bestpath_med_non_deterministic': False, 'cluster_id': '', 'vrf': 'test', 'graceful_restart_helper': False, 'timer_bgp_hold': '180', 'bestpath_aspath_multipath_relax': False, 'asn': '65535', 'timer_bestpath_limit': '', 'graceful_restart_timers_stalepath_time': '300', 'graceful_restart_timers_restart': '120', 'maxas_limit': '', 'bestpath_med_confed': False, 'log_neighbor_changes': False, 'timer_bgp_keepalive': '60', 'bestpath_cost_community_ignore': False, 'reconnect_interval': '60', 'suppress_fib_pending': False, 'bestpath_med_missing_as_worst': False, 'bestpath_compare_routerid': False, 'graceful_restart': True}
existing dict	всегда	k/v пары существующей конфигурации BGP Пример: {'router_id': '11.11.11.11', 'neighbor_down_fib_accelerate': False, 'confederation_peers': '', 'confederation_id': '', 'bestpath_compare_neighborid': False, 'local_as': '', 'bestpath_always_compare_med': False, 'bestpath_med_non_deterministic': False, 'cluster_id': '', 'vrf': 'test', 'graceful_restart_helper': False, 'timer_bgp_hold': '180', 'bestpath_aspath_multipath_relax': False, 'asn': '65535', 'timer_bestpath_limit': '', 'graceful_restart_timers_stalepath_time': '300', 'graceful_restart_timers_restart': '120', 'maxas_limit': '', 'bestpath_med_confed': False, 'log_neighbor_changes': False, 'timer_bgp_keepalive': '60', 'bestpath_cost_community_ignore': False, 'reconnect_interval': '60', 'suppress_fib_pending': False, 'bestpath_med_missing_as_worst': False, 'bestpath_compare_routerid': False, 'graceful_restart': True}
proposed dict	всегда	k/v пары параметров, переданных в модуль Пример: {'router_id': '1.1.1.1', 'asn': '65535', 'vrf': 'test'}
updates list	всегда	команды, отправленные на устройство Пример: ['router bgp 65535', 'vrf test', 'router-id 1.1.1.1']

Статус

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

Поддержка

Дополнительную информацию о поддержке этого модуля 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.5/modules/nxos_igmp_interface_module.html