Модуль cisco.mso.ndo_tenant_igmp_interface_policy — управление политиками интерфейсов Internet Group Management Protocol (IGMP) в шаблонах политик арендатора в Cisco Nexus Dashboard Orchestrator (NDO).

Примечание

Этот модуль входит в коллекцию cisco.mso (версия 2.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.mso. Для работы с этим модулем необходимы дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.mso.ndo_tenant_igmp_interface_policy.

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры

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

Управление политиками интерфейсов IGMP в шаблонах политик арендатора в Cisco Nexus Dashboard Orchestrator (NDO).
Этот модуль поддерживается только в ND v3.1 (NDO v4.3) и более поздних версиях.

Требования

На узле, на котором выполняется этот модуль, необходимы следующие компоненты.

Multi Site Orchestrator v2.1 или новее

Параметры

Параметр	Описание
description string	Описание политики интерфейса IGMP. Если указать пустую строку, из политики интерфейса IGMP будет удалено `description=""`.
fast_leave string	Включение или отключение быстрого выхода. Если значение не задано при создании, по умолчанию используется `disabled`. Допустимые значения: `"enabled"` `"disabled"`
group_timeout integer	Значение времени ожидания группы в секундах. Если значение не задано при создании, по умолчанию используется 260. Допустимый диапазон: от 3 до 65535.
host aliases: hostname string	IP-адрес или имя узла ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_HOST`.
igmp_version string	Версия IGMP для политики интерфейса IGMP. Если значение не задано при создании, по умолчанию используется `v2`. Допустимые значения: `"v2"` `"v3"`
last_member_count integer	Количество запросов последнего участника. Если значение не задано при создании, по умолчанию используется 2. Допустимый диапазон: от 1 до 5.
last_member_response_time integer	Время ответа на запрос последнего участника в секундах. Если значение не задано при создании, по умолчанию используется 1. Допустимый диапазон: от 1 до 25.
login_domain string	Имя домена входа, используемого для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_LOGIN_DOMAIN`. При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не задан, будет использоваться переменная инвентаризации `ansible_httpapi_login_domain`.
maximum_multicast_entries integer	Максимальное количество записей многоадресной рассылки. Если значение не задано при создании, по умолчанию используется 4294967295. Допустимый диапазон: от 1 до 4294967295. Этот параметр применяется только в том случае, если `state_limit_route_map_uuid` или `state_limit_route_map` не пусто.
name aliases: igmp_interface_policy string	Имя политики интерфейса IGMP.
output_level string	Управляет составом выходных данных этого модуля MSO. `normal` означает стандартные выходные данные, включая словарь `current` `info` добавляет информационные данные, включая `previous`, `proposed` и словари `sent` `debug` добавляет отладочные данные, включая сведения `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_OUTPUT_LEVEL`. Допустимые значения: `"debug"` `"info"` `"normal"` ← (по умолчанию)
password string	Пароль, используемый для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта для REST-соединения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_PORT`.
querier_timeout integer	Значение времени ожидания опрашивающего устройства в секундах. Если значение не задано при создании, по умолчанию используется 255. Допустимый диапазон: от 1 до 65535.
query_interval integer	Интервал между запросами в секундах. Если значение не задано при создании, по умолчанию используется 125. Допустимый диапазон: от 1 до 18000.
query_response_interval integer	Интервал ответа на запрос в секундах. Если значение не задано при создании, по умолчанию используется 10. Допустимый диапазон: от 1 до 25.
report_link_local_groups string	Включение или отключение отправки отчетов о группах link-local. Если значение не задано при создании, по умолчанию используется `disabled`. Допустимые значения: `"enabled"` `"disabled"`
report_policy_route_map aliases: report_policy_route_map_policy, report_policy_route_map_policy_multicast dictionary	Политика карты маршрутизации для многоадресной рассылки. Этот параметр можно использовать вместо `report_policy_route_map_uuid`. Если заданы оба параметра, `report_policy_route_map` будет проигнорирован. Если указать пустую карту, из политики интерфейса IGMP будет удалено `report_policy_route_map={}`.
name string	Имя политики карты маршрутизации для многоадресной рассылки.
report_policy_route_map_uuid aliases: report_policy_route_map_for_multicast string	UUID карты маршрутизации политики отчетов. Если указать пустую строку, из политики интерфейса IGMP будет удалено `report_policy_route_map_uuid=""`.
reserved_multicast_entries integer	Количество зарезервированных записей многоадресной рассылки. Если значение не задано при создании, по умолчанию используется 0. Допустимый диапазон: от 0 до 4294967295.
robustness_variable integer	Значение переменной устойчивости. Если значение не задано при создании, по умолчанию используется 2. Допустимый диапазон: от 1 до 7.
startup_query_count integer	Количество запросов при запуске. Если значение не задано при создании, по умолчанию используется 2. Допустимый диапазон: от 1 до 10.
startup_query_interval integer	Интервал между запросами при запуске в секундах. Если значение не задано при создании, по умолчанию используется 31. Допустимый диапазон: от 1 до 18000.
state string	Для удаления используйте `absent`. Для получения одного или нескольких объектов используйте `query`. Для создания или обновления используйте `present`. Допустимые значения: `"absent"` `"query"` ← (по умолчанию) `"present"`
state_limit_route_map aliases: state_limit_route_map_policy, state_limit_route_map_policy_multicast dictionary	Политика карты маршрутизации для многоадресной рассылки. Этот параметр можно использовать вместо `state_limit_route_map_uuid`. Если заданы оба параметра, `state_limit_route_map` будет проигнорирован. Если указать пустую карту, из политики интерфейса IGMP будет удалено `state_limit_route_map={}`.
name string	Имя политики карты маршрутизации для многоадресной рассылки.
state_limit_route_map_uuid aliases: state_limit_route_map_for_multicast string	UUID карты маршрутизации ограничения состояний. Если указать пустую строку, из политики интерфейса IGMP будет удалено `state_limit_route_map_uuid=""`.
static_report_route_map aliases: static_report_route_map_policy, static_report_route_map_policy_multicast dictionary	Политика карты маршрутизации для многоадресной рассылки. Этот параметр можно использовать вместо `static_report_route_map_uuid`. Если заданы оба параметра, `static_report_route_map` будет проигнорирован. Если указать пустую карту, из политики интерфейса IGMP будет удалено `static_report_route_map={}`.
name string	Имя политики карты маршрутизации для многоадресной рассылки.
static_report_route_map_uuid aliases: static_report_route_map_for_multicast string	UUID статической карты маршрутизации отчетов. Если указать пустую строку, из политики интерфейса IGMP будет удалено `static_report_route_map_uuid=""`.
template aliases: tenant_template string / обязательный	Имя шаблона арендатора. Необходимо указать этот параметр или `template_id`.
template_id aliases: l3out_template_id string	ID шаблона L3Out. Необходимо указать этот параметр или `template`.
timeout integer	Тайм-аут на уровне сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_TIMEOUT`.
use_proxy boolean	Если задано `false`, прокси использоваться не будет, даже если он указан в переменной окружения на целевых узлах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_USE_PROXY`. Значение по умолчанию — `true`. Допустимые значения: `false` `true`
use_ssl boolean	Если задано `false`, вместо HTTPS-соединения, используемого по умолчанию, будет использоваться HTTP-соединение. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_USE_SSL`. При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не задан, будет использоваться переменная инвентаризации `ansible_httpapi_use_ssl`. При использовании подключаемого модуля соединения HTTPAPI (mso или nd) значение по умолчанию — `false`, а при использовании устаревшего способа соединения (только для mso) — `true`. Допустимые значения: `false` `true`
username string	Имя пользователя, используемое для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
uuid aliases: igmp_interface_policy_uuid string	UUID политики интерфейса IGMP. Этот параметр обязателен, если требуется обновить политику интерфейса IGMP `name`.
validate_certs boolean	Если задано `false`, проверка SSL-сертификатов выполняться не будет. Задавайте значение `false` только на контролируемых вами ресурсах, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Допустимые значения: `false` `true`
version3_asm aliases: allow_version3_asm string	Включение или отключение ASM для IGMP версии 3. Если значение не задано при создании, по умолчанию используется `disabled`. Допустимые значения: `"enabled"` `"disabled"`

Примечания

Примечание

Перед использованием этого модуля в плейбуке должен существовать template. Используйте cisco.mso.ndo_template для создания шаблона арендатора.
Для state_limit_route_map_uuid или state_limit_route_map требуется политика карты маршрутизации для многоадресной рассылки. Для report_policy_route_map_uuid или report_policy_route_map требуется политика карты маршрутизации для многоадресной рассылки. Для static_report_route_map_uuid или static_report_route_map требуется политика карты маршрутизации для многоадресной рассылки. Используйте cisco.mso.ndo_route_map_policy_multicast для создания политики карты маршрутизации для многоадресной рассылки.
Этот модуль создан для поддержки Multi Site Orchestrator v2.1 или новее. Некоторые или все функции могут не работать в более ранних версиях.

См. также

cisco.mso.ndo_template: Управление шаблонами в Cisco Nexus Dashboard Orchestrator (NDO).
cisco.mso.ndo_route_map_policy_multicast: Управление политиками карт маршрутизации многоадресной рассылки в Cisco Nexus Dashboard Orchestrator (NDO).

Примеры

- name: Create an IGMP Interface Policy
  cisco.mso.ndo_tenant_igmp_interface_policy:
    template: ansible_tenant_template
    name: test_igmp_interface_policy
    description: Test Description
    version3_asm: enabled
    fast_leave: enabled
    report_link_local_groups: enabled
    igmp_version: v3
    group_timeout: 260
    query_interval: 125
    query_response_interval: 10
    last_member_count: 2
    last_member_response_time: 1
    startup_query_count: 2
    startup_query_interval: 31
    querier_timeout: 255
    robustness_variable: 2
    state_limit_route_map_uuid: "2be2b2e6-727d-4534-9d09-4abc36ed0194"
    report_policy_route_map_uuid: "{{ route_map_policy_for_multicast.current.uuid }}"
    static_report_route_map:
      name: TestStaticReportRouteMap
    maximum_multicast_entries: 4294967295
    reserved_multicast_entries: 4294967
    state: present
  register: igmp_interface_policy

- name: Update an IGMP Interface Policy name with the UUID
  cisco.mso.ndo_tenant_igmp_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: test_igmp_interface_policy_updated
    uuid: "{{ igmp_interface_policy.current.uuid }}"
    state: present
  register: igmp_interface_policy_update

- name: Query an IGMP Interface Policy with the name
  cisco.mso.ndo_tenant_igmp_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: test_igmp_interface_policy
    state: query
  register: query

- name: Query an IGMP Interface Policy with the UUID
  cisco.mso.ndo_tenant_igmp_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    uuid: "{{ igmp_interface_policy.current.uuid }}"
    state: query
  register: query_uuid

- name: Query all IGMP Interface Policies in the template
  cisco.mso.ndo_tenant_igmp_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    state: query
  register: query_all

- name: Delete an IGMP Interface Policy with the name
  cisco.mso.ndo_tenant_igmp_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    name: test_igmp_interface_policy
    state: absent

- name: Delete an IGMP Interface Policy with the UUID
  cisco.mso.ndo_tenant_igmp_interface_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    uuid: "{{ igmp_interface_policy.current.uuid }}"
    state: absent

Авторы

Anvitha Jain (@anvjain)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/mso/ndo_tenant_igmp_interface_policy_module.html