Spec-Zone.ru › Ansible

Модуль cisco.aci.aci_igmp_interface_policy – Управление политиками интерфейсов IGMP (igmp:IfPol)

Примечание

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

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

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

Для использования в playbook укажите: cisco.aci.aci_igmp_interface_policy.

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

Обзор

  • Управление политиками интерфейсов IGMP на тканях Cisco ACI.

Параметры

Параметр

Комментарии

allow_v3_asm

boolean

Включить опцию Allow v3 ASM.

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

Если этот параметр установлен, параметры fast_leave и report_link_local_groups также должны быть установлены.

Варианты:

  • false
  • true

annotation

string

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

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

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

Значение по умолчанию: "orchestrator:ansible"

certificate_name

алиасы: cert_name

string

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

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

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

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

description

string

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

fast_leave

boolean

Включить опцию Fast Leave.

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

Если этот параметр установлен, параметры allow_v3_asm и report_link_local_groups также должны быть установлены.

Варианты:

  • false
  • true

group_timeout

integer

Таймаут группы IGMP в секундах.

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

host

алиасы: hostname

string

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

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

igmp_version

string

Используемая версия IGMP.

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

Варианты:

  • "v2"
  • "v3"

last_member_count

integer

Количество запросов последнего участника.

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

last_member_response

integer

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

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

name

string

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

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.

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.

querier_timeout

integer

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

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

query_interval

integer

Интервал запроса IGMP в секундах.

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

query_response_interval

integer

Интервал ответа на запрос IGMP в секундах.

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

report_link_local_groups

boolean

Включить опцию «Отчёт о локальных группах ссылки».

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

Если этот параметр установлен, allow_v3_asm и fast_leave также должны быть установлены.

Варианты:

  • false
  • true

robustness_variable

integer

Коэффициент надёжности.

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

startup_query_count

integer

Количество запросов при запуске.

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

startup_query_interval

integer

Интервал запроса при запуске в секундах.

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

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

string

Тенент для создания политики IGMP Interface Policy.

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

См. также

См. также

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

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

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

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

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

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

Примеры

- name: Add an IGMP Interface Policy
  cisco.aci.aci_igmp_interface_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ans_igmp_intf_pol
    query_interval: 200
    state: present
  delegate_to: localhost

- name: Query an IGMP Interface Policy
  cisco.aci.aci_igmp_interface_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ans_igmp_intf_pol
    state: query
  delegate_to: localhost

- name: Query all IGMP Interface Policies
  cisco.aci.aci_igmp_interface_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Remove an IGMP Interface Policy
  cisco.aci.aci_igmp_interface_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: ans_igmp_intf_pol
    state: absent
  delegate_to: localhost

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

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

Ключ

Описание

current

list / elements=string

Существующая конфигурация из APIC после завершения работы модуля

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

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

error

dictionary

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

Возвращается: ошибка

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

filter_string

string

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

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

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

method

string

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

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

Пример: "POST"

previous

list / elements=string

Оригинальная конфигурация из APIC до начала работы модуля

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

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

proposed

dictionary

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

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

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

raw

string

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

Возвращается: ошибка разбора

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

response

string

HTTP-ответ от APIC

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

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

sent

list / elements=string

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

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

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

status

integer

HTTP-статус от APIC

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

Пример: 200

url

string

HTTP-url, используемый для запроса к APIC

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

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

Авторы

  • Tim Cragg (@timcragg)

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

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

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

Spec-Zone.ru

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