Spec-Zone.ru › Ansible

cisco.aci.aci_vrf_multicast модуль – Управление объектами VRF Multicast (pim:CtxP)

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.aci.aci_vrf_multicast.

  • Обзор
  • Параметры
  • Примечания
  • См. также
  • Примеры
  • Возвращаемые значения

Обзор

  • Управление объектами VRF Multicast на Cisco ACI фабриках.
  • Создание state=present включает Protocol Independent Multicast (PIM) на VRF.
  • Удаление state=absent отключает Protocol Independent Multicast (PIM) на VRF.

Параметры

Параметр

Комментарии

annotation

строка

Пользовательская строка для аннотирования объекта.

Если значение не указано в задаче, будет использовано значение переменной среды ACI_ANNOTATION.

Если значение не указано в задаче и переменная среды ACI_ANNOTATION не задана, будет использовано значение по умолчанию.

По умолчанию: "orchestrator:ansible"

any_source_multicast

псевдонимы: asm, any_source

словарь

Контейнер настроек для протокола независимого многоадресного вещания (PIM) Any Source Multicast (ASM).

expiry

псевдонимы: expiry_seconds

целое число

Время истечения срока действия в секундах.

APIC по умолчанию использует значение default-timeout при создании, если не задано.

Установите значение 0, чтобы сбросить до значения default-timeout.

max_rate

псевдонимы: max_rate_per_second

целое число

Максимальная скорость в секунду.

APIC по умолчанию использует значение 65535 при создании, если не задано.

shared_range_route_map

псевдонимы: shared_range_policy

строка

DN карты маршрутизации.

Укажите "", чтобы удалить конфигурацию карты маршрутизации.

source_group_expiry_route_map

псевдонимы: sg_expiry_route_map

строка

DN карты маршрутизации.

Укажите "", чтобы удалить конфигурацию карты маршрутизации.

source_ip

псевдонимы: source, source_ip_address

строка

IP-адрес источника.

auto_rp

псевдонимы: auto

словарь

Контейнер настроек для протокола независимого многоадресного вещания (PIM) Auto-Rendezvous Point (Auto-RP).

ma_filter

псевдонимы: filter, route_map, route_map_dn

строка

DN карты маршрутизации.

Укажите "", чтобы удалить конфигурацию карты маршрутизации.

rp_updates

псевдонимы: control, ctrl

список / элементы=строка

Состояние управления политикой Auto-Rendezvous Point (Auto-RP).

Укажите [] для удаления конфигурации состояния управления.

Варианты:

  • "forward"
  • "listen"

bootstrap_router

псевдонимы: bsr, bootstrap

словарь

Контейнер настроек для протокола независимого многоадресного вещания (PIM) Bootstrap Router (BSR).

bsr_filter

псевдонимы: filter, route_map, route_map_dn

строка

DN карты маршрутизации.

Укажите "", чтобы удалить конфигурацию карты маршрутизации.

rp_updates

псевдонимы: control, ctrl

список / элементы=строка

Состояние управления политикой Bootstrap Router (BSR).

Укажите [] для удаления конфигурации состояния управления.

Варианты:

  • "forward"
  • "listen"

certificate_name

псевдонимы: cert_name

строка

Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи.

Если предоставлено имя файла private_key, по умолчанию используется имя private_key без расширения.

Если для private_key предоставлено содержимое в формате PEM, по умолчанию используется значение username.

Если значение не указано в задаче, будет использовано значение переменной среды ACI_CERTIFICATE_NAME.

host

псевдонимы: hostname

строка

IP-адрес или имя хоста APIC, разрешаемого хостом управления Ansible.

Если значение не указано в задаче, будет использовано значение переменной среды ACI_HOST.

output_level

string

Влияет на вывод этого модуля ACI.

normal означает стандартный вывод, включая current словарь.

info добавляет информационный вывод, включая previous, proposed и sent словари.

debug добавляет отладочный вывод, включая filter_string, method, response, status и url информацию.

Если значение не указано в задаче, используется значение переменной среды ACI_OUTPUT_LEVEL.

Варианты:

  • "debug"
  • "info"
  • "normal" ← (по умолчанию)

output_path

string

Путь к файлу, который будет использоваться для вывода объектов конфигурации ACI в формате JSON, сгенерированных модулем.

Если значение не указано в задаче, используется значение переменной среды ACI_OUTPUT_PATH.

owner_key

string

Пользовательская строка для атрибута ownerKey объекта ACI.

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

Если значение не указано в задаче, используется значение переменной среды ACI_OWNER_KEY.

owner_tag

string

Пользовательская строка для атрибута ownerTag объекта ACI.

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

Например, чтобы указать, кто создал этот объект.

Если значение не указано в задаче, используется значение переменной среды ACI_OWNER_TAG.

password

string

Пароль для аутентификации.

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

Если значение не указано в задаче, используется значение переменных среды ACI_PASSWORD или ANSIBLE_NET_PASSWORD.

pim_setting

dictionary

Контейнер конфигурации для настроек Protocol Independent Multicast (PIM).

control_state

aliases: control, ctrl

list / elements=string

Действие(я), которые необходимо выполнить при обнаружении цикла.

Укажите [] для удаления конфигурации состояния управления.

Варианты:

  • "fast"
  • "strict"

mtu

integer

Размер MTU, поддерживаемый для мультикаста.

APIC по умолчанию использует 1500 при отсутствии указания.

port

integer

Номер порта, используемый для подключения REST.

Значение по умолчанию зависит от параметра use_ssl.

Если значение не указано в задаче, используется значение переменной среды ACI_PORT.

private_key

aliases: cert_key

string

Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи.

Это значение также влияет на значение по умолчанию certificate_name, которое используется.

Этот параметр взаимоисключающий с password. Если также предоставлен password, он будет проигнорирован.

Если значение не указано в задаче, используется значение переменных среды ACI_PRIVATE_KEY или ANSIBLE_NET_SSH_KEYFILE.

resource_policy

dictionary

Контейнер конфигурации для политики ресурсов Protocol Independent Multicast (PIM).

maximum_limit

aliases: max

integer

Максимальное количество записей мультикаста.

APIC по умолчанию использует unlimited при отсутствии указания.

Укажите 0 для сброса до unlimited.

reserved_multicast_entries

aliases: rsvd

integer

Зарезервированные записи мультикаста.

APIC по умолчанию использует undefined при отсутствии указания.

Требуется при указании reserved_route_map.

reserved_route_map

aliases: route_map, route_map_dn

string

Идентификатор (DN) карты маршрутизации.

Укажите "" для удаления конфигурации карты маршрутизации.

Требуется при указании reserved_multicast_entries.

source_specific_multicast

aliases: ssm, specific_source

dictionary

Контейнер конфигурации для настроек Protocol Independent Multicast (PIM) Source Specific Multicast (SSM).

group_range_route_map

aliases: group_range_policy

string

Идентификатор (DN) карты маршрутизации.

Укажите "" для удаления конфигурации карты маршрутизации.
END_OF_DOCUMENT_MARKER

state

string

Использовать present или absent для добавления или удаления.

Использовать query для получения списка объекта или нескольких объектов.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

suppress_previous

aliases: no_previous, ignore_previous

boolean

Если true, GET-запрос для проверки предыдущего состояния не будет отправлен перед обновлением POST на APIC.

Если значение не указано в задаче, будет использовано значение переменной окружения ACI_SUPPRESS_PREVIOUS.

Значение по умолчанию false.

ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым.

Предыдущее состояние объекта не будет проверяться, и обновление POST будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, проверяющий GET-запрос не будет отправлен после обновления POST на APIC.

Если значение не указано в задаче, будет использовано значение переменной окружения ACI_SUPPRESS_VERIFICATION.

Значение по умолчанию false.

ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное.

Текущий объект, включая значения по умолчанию, не будет проверяем в одной задаче.

Варианты:

  • false
  • true

tenant

aliases: tenant_name

string

Имя существующего арендатора.

timeout

integer

Таймаут уровня сокета в секундах.

Если значение не указано в задаче, будет использовано значение переменной окружения ACI_TIMEOUT.

Значение по умолчанию 30.

use_proxy

boolean

Если false, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах.

Если значение не указано в задаче, будет использовано значение переменной окружения ACI_USE_PROXY.

Значение по умолчанию true.

Варианты:

  • false
  • true

use_ssl

boolean

Если false, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения.

Если значение не указано в задаче, будет использовано значение переменной окружения ACI_USE_SSL.

Значение по умолчанию true, если соединение локальное.

Варианты:

  • false
  • true

username

aliases: user

string

Имя пользователя для аутентификации.

Если значение не указано в задаче, будут использованы значения переменных окружения ACI_USERNAME или ANSIBLE_NET_USERNAME.

Значение по умолчанию admin.

validate_certs

boolean

Если false, сертификаты SSL не будут проверяться.

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

Если значение не указано в задаче, будет использовано значение переменной окружения ACI_VALIDATE_CERTS.

Значение по умолчанию true.

Варианты:

  • false
  • true

vrf

aliases: vrf_name

string

Имя существующей VRF.

Примечания

Примечание

  • tenant и vrf должны существовать до использования этого модуля в вашем плейбуке. Для этого можно использовать модули cisco.aci.aci_tenant и cisco.aci.aci_vrf.

См. также

См. также

Справочник по модели управления информацией APIC

Дополнительная информация о внутреннем классе APIC pim:CtxP.

Руководство по Cisco ACI

Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.

Разработка модулей Cisco ACI

Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Enable Multicast on a VRF
  cisco.aci.aci_vrf_multicast:
    host: apic
    username: admin
    password: SomeSecretePassword
    tenant: ansible_tenant
    vrf: ansible_vrf
    state: present
  delegate_to: localhost

- name: Change Multicast PIM Settings on a VRF
  cisco.aci.aci_vrf_multicast:
    host: apic
    username: admin
    password: SomeSecretePassword
    tenant: ansible_tenant
    vrf: ansible_vrf
    pim_setting:
      mtu: 2000
      control_state: [fast, strict]
    state: present
  delegate_to: localhost

- name: Change Multicast Resource Policy on a VRF
  cisco.aci.aci_vrf_multicast:
    host: apic
    username: admin
    password: SomeSecretePassword
    tenant: ansible_tenant
    vrf: ansible_vrf
    resource_policy:
      maximum_limit: 100
      reserved_multicast_entries: 20
      reserved_route_map: uni/tn-ansible_test/rtmap-ansible_test
    state: present
  delegate_to: localhost

- name: Remove Route-Map from Multicast Resource Policy on a VRF
  cisco.aci.aci_vrf_multicast:
    host: apic
    username: admin
    password: SomeSecretePassword
    tenant: ansible_tenant
    vrf: ansible_vrf
    resource_policy:
      reserved_route_map: ""
    state: present
  delegate_to: localhost

- name: Change Multicast Any Source Multicast (ASM) Settings on a VRF
  cisco.aci.aci_vrf_multicast:
    host: apic
    username: admin
    password: SomeSecretePassword
    tenant: ansible_tenant
    vrf: ansible_vrf
    any_source_multicast:
      shared_range_route_map: uni/tn-ansible_test/rtmap-ansible_test
      source_group_expiry_route_map: uni/tn-ansible_test/rtmap-ansible_test
      expiry: 500
      max_rate: 64000
      source_ip: 1.1.1.1
    state: present
  delegate_to: localhost

- name: Change Multicast Source Specific Multicast (SSM) Settings on a VRF
  cisco.aci.aci_vrf_multicast:
    host: apic
    username: admin
    password: SomeSecretePassword
    tenant: ansible_tenant
    vrf: ansible_vrf
    source_specific_multicast:
      group_range_route_map: uni/tn-ansible_test/rtmap-ansible_test
    state: present
  delegate_to: localhost

- name: Change Multicast Bootstrap Router (BSR) Settings on a VRF
  cisco.aci.aci_vrf_multicast:
    host: apic
    username: admin
    password: SomeSecretePassword
    tenant: ansible_tenant
    vrf: ansible_vrf
    bootstrap_router:
      bsr_filter: uni/tn-ansible_test/rtmap-ansible_test
      rp_updates: [forward, listen]
    state: present
  delegate_to: localhost

- name: Change Multicast Auto-Rendezvous Point (Auto-RP) Settings on a VRF
  cisco.aci.aci_vrf_multicast:
    host: apic
    username: admin
    password: SomeSecretePassword
    tenant: ansible_tenant
    vrf: ansible_vrf
    auto_rp:
      ma_filter: uni/tn-ansible_test/rtmap-ansible_test
      rp_updates: [forward, listen]
    state: present
  delegate_to: localhost

- name: Disable Multicast on a VRF
  cisco.aci.aci_vrf_multicast:
    host: apic
    username: admin
    password: SomeSecretePassword
    tenant: ansible_tenant
    vrf: ansible_vrf
    state: absent
  delegate_to: localhost

- name: Query Multicast Settings for a VRF
  cisco.aci.aci_vrf_multicast:
    host: apic
    username: admin
    password: SomeSecretePassword
    tenant: ansible_tenant
    vrf: ansible_vrf
    state: query
  delegate_to: localhost
  register: query_result

- name: Query Multicast Settings for all VRFs
  cisco.aci.aci_vrf_multicast:
    host: apic
    username: admin
    password: SomeSecretePassword
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ

Описание

current

список / элементы=строка

Текущая конфигурация из APIC после завершения модуля

Возвращено: успех

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

словарь

Информация об ошибке, возвращенная из APIC

Возвращено: ошибка

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

строка

Используемая строка фильтра для запроса

Возвращено: ошибка или отладка

Пример: "?rsp-prop-include=config-only"

method

строка

Используемый HTTP-метод для запроса к APIC

Возвращено: ошибка или отладка

Пример: "POST"

previous

список / элементы=строка

Исходная конфигурация из APIC до запуска модуля

Возвращено: информация

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

словарь

Скомпонованная конфигурация из параметров пользователя

Возвращено: информация

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

строка

Необработанный вывод, возвращенный REST API APIC (xml или json)

Возвращено: ошибка разбора

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class \"/></imdata>"

response

строка

HTTP-ответ от APIC

Возвращено: ошибка или отладка

Пример: "OK (30 bytes)"

sent

список / элементы=строка

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращено: информация

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

целое число

HTTP-статус от APIC

Возвращено: ошибка или отладка

Пример: 200

url

строка

Используемый HTTP-URL для запроса к APIC

Возвращено: ошибка или отладка

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"

Авторы

  • Tim Cragg (@timcragg)
  • Akini Ross (@akinross)

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

  • Система отслеживания ошибок
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API