nxos_igmp_interface - Управление конфигурацией интерфейса IGMP.
Новая версия с 2.2.
Описание
- Управление настройками интерфейса IGMP.
Параметры
| параметр | обязательно | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| auth_pass (добавлено в 2.4.4)
| нет | нет | Указывает пароль для входа в привилегированный режим на удалённом устройстве, если это требуется. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| authorize (добавлено в 2.4.4)
| нет |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в обычном режиме. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| group_timeout | нет | Устанавливает таймаут членства в группе для IGMPv2. Значения могут варьироваться от 3 до 65535 секунд. По умолчанию 260 секунд. | ||
| host | да | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение host используется в качестве адреса назначения для транспорта. | ||
| immediate_leave | нет |
| Включает возможность устройства немедленно удалить запись о группе из таблицы маршрутизации multicast после получения сообщения об уходе из группы. Используйте эту команду, чтобы минимизировать задержку ухода из групп IGMPv2 на данном интерфейсе IGMP, так как устройство не отправляет запросы, специфичные для группы. По умолчанию отключено. | |
| interface | да | Полное имя интерфейса для конфигурации IGMP. Например, Ethernet1/2. | ||
| last_member_qrt | нет | Устанавливает интервал запроса, ожидаемый после отправки отчётов о членстве, прежде чем программное обеспечение удалит состояние группы. Значения могут варьироваться от 1 до 25 секунд. По умолчанию 1 секунда. | ||
| last_member_query_count | нет | Устанавливает количество раз, которое программное обеспечение отправляет запрос IGMP в ответ на сообщение об уходе хоста. Значения могут варьироваться от 1 до 5. По умолчанию 2. | ||
| oif_prefix | нет | Настроить префикс для статического исходящего интерфейса (OIF). | ||
| oif_routemap | нет | Настроить карту маршрутизации для статического исходящего интерфейса (OIF). | ||
| oif_source | нет | Настроить источник для статического исходящего интерфейса (OIF). | ||
| password | нет | Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для cli или nxapi транспортов. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port | нет | 0 (использовать стандартный порт) | Указывает порт для подключения к удалённому устройству. Это значение относится к cli или nxapi. Если значение не указано в задаче, используется соответствующий стандартный порт для транспорта. (cli=22, http=80, https=443). | |
| provider | нет | Удобный метод, позволяющий передавать все аргументы nxos как объект словаря. Все ограничения (обязательность, значения и т.д.) должны быть выполнены либо отдельными аргументами, либо значениями в этом словаре. | ||
| querier_timeout | нет | Устанавливает таймаут запросителя, который программное обеспечение использует при решении вопроса о том, взять ли на себя роль запросителя. Значения могут варьироваться от 1 до 65535 секунд. По умолчанию 255 секунд. | ||
| query_interval | нет | Устанавливает частоту, с которой программное обеспечение отправляет сообщения запроса хоста IGMP. Значения могут варьироваться от 1 до 18000 секунд. По умолчанию 125 секунд. | ||
| query_mrt | нет | Устанавливает время ответа, объявленное в запросах IGMP. Значения могут варьироваться от 1 до 25 секунд. По умолчанию 10 секунд. | ||
| report_llg | нет |
| Конфигурирует report-link-local-groups. Включает отправку отчётов для групп в 224.0.0.0/24. Отчёты всегда отправляются для групп, не являющихся локальными для связи. По умолчанию отчёты не отправляются для локальных групп связи. | |
| restart | нет |
| Перезапустить IGMP. | |
| robustness | нет | Устанавливает переменную устойчивости. Значения могут варьироваться от 1 до 7. По умолчанию 2. | ||
| ssh_keyfile | нет | Указывает SSH ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| startup_query_count | нет | Количество запросов при запуске процесса IGMP. Диапазон от 1 до 10. По умолчанию 2. | ||
| startup_query_interval | нет | Интервал запросов при запуске процесса IGMP. Диапазон от 1 до 18000. По умолчанию 31. | ||
| state | нет | present |
| Управление желаемым состоянием ресурса. |
| timeout (добавлено в 2.3)
| нет | 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при длительных командах (sh mac, sh bgp и т.д.). | |
| transport | да | cli | Конфигурирует транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_ssl | нет |
| Конфигурирует transport для использования SSL, если значение равно true, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username | нет | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| validate_certs | нет |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на сайтах, контролируемых лично, с использованием самозаверяющих сертификатов. Если аргумент transport не nxapi, это значение игнорируется. | |
| version | нет |
| Версия IGMP. Может быть 2 или 3. |
Примеры
- nxos_igmp_interface:
interface: ethernet1/32
startup_query_interval: 30
state: present
username: "{{ un }}"
password: "{{ pwd }}"
host: "{{ inventory_hostname }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для данного модуля:
| name | description | returned | type | sample |
|---|---|---|---|---|
| changed | проверка, было ли произведено изменение на устройстве | всегда | boolean | True |
| end_state | параметры конфигурации BGP (ключ/значение) после выполнения модуля | всегда | dict | {'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 | параметры конфигурации BGP (ключ/значение) существующей конфигурации | всегда | dict | {'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 | {'router_id': '1.1.1.1', 'asn': '65535', 'vrf': 'test'} |
| updates | команды, отправленные на устройство | всегда | list | ['router bgp 65535', 'vrf test', 'router-id 1.1.1.1'] |
Примечания
Примечание
- Тестировано на 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.
- Проверка маршрутной карты не выполняется (так же, как и в командной строке) при конфигурировании маршрутной карты с 'static-oif'
- Если параметр перезапуска установлен в true, а другие параметры заданы, перезапуск произойдет последним, т.е. после выполнения конфигурации.
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Информация о техническом обслуживании
Для получения дополнительной информации о поддержке данного модуля Red Hat, обратитесь к этому knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
Для помощи в разработке модулей, если вы заинтересованы, прочитайте Информацию о сообществе и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/nxos_igmp_interface_module.html