модуль cisco.intersight.intersight_multicast_policy — настройка политики многоадресной рассылки для Cisco Intersight

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.intersight.

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

Обзор
Параметры
Примеры
Возвращаемые значения

Обзор

Управляет настройкой политики многоадресной рассылки в Cisco Intersight.
Политика для настройки параметров многоадресной рассылки, включая IGMP Snooping и querier, на коммутаторах, управляемых Cisco Intersight.
Подробнее см. в документации Cisco Intersight.

Параметры

Параметр	Комментарии
api_key_id string / обязательный	Идентификатор открытого ключа API, связанного с закрытым ключом. Если значение не задано, используется значение переменной окружения INTERSIGHT_API_KEY_ID.
api_private_key path / обязательный	Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате PEM для аутентификации в API Intersight. Если используется строка, для шифрования строковых данных следует использовать Ansible Vault. Например: ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file ‘-----BEGIN EC PRIVATE KEY----- <your private key data> -----END EC PRIVATE KEY-----’ Если значение не задано, используется значение переменной окружения INTERSIGHT_API_PRIVATE_KEY.
api_uri string	URI для доступа к API Intersight. Если значение не задано, используется значение переменной окружения INTERSIGHT_API_URI. По умолчанию: `"https://intersight.com/api/v1"`
description псевдонимы: descr string	Описание политики многоадресной рассылки, заданное пользователем. Описание может содержать буквы (a-z, A-Z), цифры (0-9), дефис (-), точку (.), двоеточие (:) или символ подчеркивания (_).
name string / обязательный	Имя, присвоенное политике многоадресной рассылки. Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_.
organization string	Имя организации, которой назначен этот ресурс. Профили, политики и пулы, созданные в пользовательской организации, применимы только к устройствам в той же организации. По умолчанию: `"default"`
querier_ip_address string	Задает IP-адрес IGMP Querier. Должен быть допустимым IPv4-адресом.
querier_ip_address_peer string	Задает IP-адрес IGMP Querier коммутатора-пира. Параметр необязателен и применяется только при значении ‘Enabled’ для querier_state. Должен быть допустимым IPv4-адресом.
querier_state string	Административное состояние IGMP Querier для этой VLAN. Варианты: `"Enabled"` `"Disabled"` ← (по умолчанию)
snooping_state string	Административное состояние IGMP Snooping для этой VLAN. Варианты: `"Enabled"` ← (по умолчанию) `"Disabled"`
src_ip_proxy string	Административное состояние прокси исходного IP-адреса IGMP для этой VLAN. Варианты: `"Enabled"` ← (по умолчанию) `"Disabled"`
state string	Если `present`, проверяет наличие ресурса и при необходимости создает его. Если `absent`, проверяет отсутствие ресурса и при необходимости удаляет его. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags list / элементы=dictionary	Список тегов в формате Key:<ключ, заданный пользователем> Value:<значение, заданное пользователем>.
use_proxy boolean	Если `no`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Логический параметр управления проверкой TLS-сертификата api_uri. Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Create a Multicast Policy with querier enabled
  cisco.intersight.intersight_multicast_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "Multicast-Policy-Querier"
    description: "Multicast policy with IGMP querier enabled"
    tags:
      - Key: "Site"
        Value: "DataCenter-A"
    querier_state: "Enabled"
    snooping_state: "Enabled"
    querier_ip_address: "192.168.1.1"
    querier_ip_address_peer: "192.168.1.2"
    src_ip_proxy: "Enabled"
    state: present

- name: Create a basic Multicast Policy with defaults
  cisco.intersight.intersight_multicast_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Basic-Multicast-Policy"
    description: "Basic multicast policy with snooping enabled"
    querier_state: "Disabled"
    snooping_state: "Enabled"
    src_ip_proxy: "Enabled"
    state: present

- name: Create a Multicast Policy with only snooping
  cisco.intersight.intersight_multicast_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Snooping-Only-Policy"
    description: "Multicast policy with only snooping enabled"
    querier_state: "Disabled"
    snooping_state: "Enabled"
    src_ip_proxy: "Disabled"
    state: present

- name: Delete a Multicast Policy
  cisco.intersight.intersight_multicast_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "Multicast-Policy-Querier"
    state: absent

Возвращаемые значения

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

Ключ	Описание
api_response dictionary	Результат ответа API, возвращенный указанным ресурсом. Возвращается: всегда Пример: `{"api_response": {"Name": "test_multicast_policy", "ObjectType": "fabric.MulticastPolicy", "QuerierIpAddress": "192.168.1.1", "QuerierIpAddressPeer": "192.168.1.2", "QuerierState": "Enabled", "SnoopingState": "Enabled", "SrcIpProxy": "Enabled", "Tags": [{"Key": "Site", "Value": "DataCenter-A"}]}}`

Ключ

Описание

api_response

dictionary

Результат ответа API, возвращенный указанным ресурсом.

Возвращается: всегда

Пример: {"api_response": {"Name": "test_multicast_policy", "ObjectType": "fabric.MulticastPolicy", "QuerierIpAddress": "192.168.1.1", "QuerierIpAddressPeer": "192.168.1.2", "QuerierState": "Enabled", "SnoopingState": "Enabled", "SrcIpProxy": "Enabled", "Tags": [{"Key": "Site", "Value": "DataCenter-A"}]}}

Авторы

Ron Gershburg (@rgershbu)

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

© 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/intersight/intersight_multicast_policy_module.html