Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_interface_policy_pim — Управление политиками интерфейсов протокола независимого многоадресного вещания (PIM) (pim:IfPol)

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_interface_policy_pim.

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

Обзор

  • Управление политиками интерфейсов протокола независимого многоадресного вещания для арендаторов на фабриках Cisco ACI.

Параметры

Параметр

Комментарии

annotation

строка

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

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

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

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

authentication_key

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

строка

Ключ аутентификации.

authentication_type

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

строка

Тип аутентификации.

Варианты:

  • "none"
  • "md5_hmac"

certificate_name

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

строка

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

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

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

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

control_state

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

Состояние управления политикой интерфейса PIM.

Это список одного или нескольких следующих параметров:

multicast_domain_boundary – Граница многоадресной области.

strict_rfc_compliant – Только прослушивание пакетов протокола PIM.

passive – Не отправлять/получать пакеты протокола PIM.

Варианты:

  • "multicast_domain_boundary"
  • "strict_rfc_compliant"
  • "passive"

description

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

строка

Описание политики интерфейса PIM.

designated_router_delay

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

целое число

Задержка маршрутизатора PIM.

Допустимые значения находятся в диапазоне от 1 до 65535.

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

designated_router_priority

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

целое число

Приоритет маршрутизатора PIM.

Допустимые значения находятся в диапазоне от 1 до 4294967295.

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

hello_interval

целое число

Интервал времени в секундах между пакетами hello, которые PIM отправляет по интерфейсу.

Чем меньше интервал hello, тем быстрее будут обнаружены топологические изменения, но это приведет к большему трафику маршрутизации.

Допустимые значения находятся в диапазоне от 1 до 18724286.

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

host

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

строка

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

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

inbound_join_prune_filter_policy

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

строка

Политика фильтрации входящих join/prune на уровне интерфейса.

Для этого можно использовать cisco.aci.aci_pim_route_map_policy.

Для удаления установите пустую строку.

join_prune_interval

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

целое число

Интервал join/prune в секундах.

Допустимые значения находятся в диапазоне от 60 до 65520.

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

name_alias

строка

Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.

neighbor_filter_policy

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

строка

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

Для этого можно использовать cisco.aci.aci_pim_route_map_policy.

Для удаления установите пустую строку.

outbound_join_prune_filter_policy

aliases: outbound_filter

string

Политика фильтрации исходящих запросов на присоединение/отключение на уровне интерфейса.

Для этого можно использовать cisco.aci.aci_pim_route_map_policy.

Чтобы удалить её, передайте пустую строку.

output_level

string

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

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

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

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

aliases: pim_interface_policy, name

string

Имя политики интерфейса PIM.

Имя нельзя изменить после создания объекта.

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.

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, вместо стандартного HTTPS соединения будет использовано соединение HTTP.

Если значение не указано в задаче, будет использовано значение переменной окружения 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

Примечания

Примечание

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

См. также

См. также

cisco.aci.aci_tenant

Управление арендаторами (fv:Tenant).

cisco.aci.aci_pim_route_map_policy

Управление политикой маршрутизации Protocol-Independent Multicast (PIM) (pim:RouteMapPol).

APIC Management Information Model reference

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

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

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

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

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

Примеры

- name: Create a PIM interface policy
  cisco.aci.aci_interface_policy_pim:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    pim: my_pim_policy
    control_state: [multicast_domain_boundary, strict_rfc_compliant]
    designated_router_delay: 10
    designated_router_priority: tens_of_micro
    hello_interval: 5
    join_prune_interval: 15
    inbound_join_prune_filter_policy: my_pim_route_map_policy_1
    outbound_join_prune_filter_policy: my_pim_route_map_policy_2
    neighbor_filter_policy: my_pim_route_map_policy_3
    state: present
  delegate_to: localhost

- name: Query a PIM interface policy
  cisco.aci.aci_interface_policy_pim:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    pim: my_pim_policy
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all PIM interface policies in tenant production
  cisco.aci.aci_interface_policy_pim:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    state: query
  delegate_to: localhost
  register: query_result

- name: Delete a PIM interface policy
  cisco.aci.aci_interface_policy_pim:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    pim: my_pim_policy
    state: present
  delegate_to: localhost

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

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

Ключ

Описание

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

строка

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

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

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

Авторы

  • Gaspard Micol (@gmicol)

Ссылки на сборку

  • Отслеживание проблем
  • Репозиторий (источники)

© 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_interface_policy_pim_module.html

Spec-Zone.ru

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