cisco.aci.aci_tenant_ep_retention_policy – Управление политиками протоколов удержания конечных точек (EP) (fv:EpRetPol)

Примечание

Этот плагин является частью коллекции cisco.aci (версия 2.0.0).

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

Для использования в книге задач укажите: cisco.aci.aci_tenant_ep_retention_policy.

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

Описание

Управление политиками протоколов удержания конечных точек (EP) на Cisco ACI-матрицах.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_ANNOTATION`.
bounce_age целое число		Интервал старения записей отскока в секундах. Допустимые значения в диапазоне от `150` до `65535`; 0 используется для бесконечного значения. APIC по умолчанию использует `630`, если значение не задано при создании.
bounce_trigger строка	Варианты: coop flood	Определяет, устанавливаются ли записи отскока протоколом RARP Flood или COOP. APIC по умолчанию использует `coop`, если значение не задано при создании.
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, значение по умолчанию — базовое имя `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, значение по умолчанию — значение `username`. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`. алиасы: cert_name
description строка		Описание политики удержания конечной точки. алиасы: descr
epr_policy строка		Имя политики удержания конечной точки. алиасы: epr_name, name
hold_interval целое число		Интервал удержания в секундах. Допустимые значения в диапазоне от `5` до `65535`. APIC по умолчанию использует `300`, если значение не задано при создании.
host строка / обязательно		IP-адрес или имя хоста APIC, разрешимые для хоста Ansible. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_HOST`. алиасы: hostname
local_ep_interval целое число		Интервал старения локальной конечной точки в секундах. Допустимые значения в диапазоне от `120` до `65535`; 0 используется для бесконечного значения. APIC по умолчанию использует `900`, если значение не задано при создании.
move_frequency целое число		Частота перемещений в секунду. Допустимые значения в диапазоне от `0` до `65535`; 0 используется для отсутствия. APIC по умолчанию использует `256`, если значение не задано при создании.
name_alias строка		Псевдоним для текущего объекта. Он связан с полем nameAlias в ACI.
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OUTPUT_LEVEL`.
output_path строка		Путь к файлу, который будет использоваться для вывода конфигурационных объектов ACI в формате JSON, сгенерированных модулем. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OUTPUT_PATH`.
owner_key строка		Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OWNER_KEY`.
owner_tag строка		Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой метку, позволяющую клиентам добавлять свои собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OWNER_TAG`.
password строка		Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если также предоставлен `private_key`, будет использован он. Если значение не указано в задаче, будет использовано значение переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_PORT`.
private_key строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключающий с `password`. Если также предоставлен `password`, он будет проигнорирован. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_PRIVATE_KEY`. алиасы: cert_key
remote_ep_interval целое число		Интервал старения удаленной конечной точки в секундах. Допустимые значения в диапазоне от `120` до `65535`; 0 используется для бесконечного значения. APIC по умолчанию использует `300`, если значение не задано при создании.
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для отображения объекта или нескольких объектов.
tenant строка		Имя существующего тенанта. алиасы: tenant_name
timeout целое число	Значение по умолчанию: 30	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_TIMEOUT`.
use_proxy булево	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых узлах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_PROXY`.
use_ssl булево	Варианты: no yes ←	Если `no`, вместо стандартного подключения HTTPS будет использовано HTTP-подключение. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_SSL`.
username строка	Значение по умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. алиасы: user
validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует установить в `no` только при работе с контролируемыми сайтами с самозаверенными сертификатами. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`.

Примечания

Примечание

Перед использованием данного модуля в вашем исполняемом сценарии должен быть доступен tenant. Модуль cisco.aci.aci_tenant можно использовать для этого.

См. также

cisco.aci.aci_tenant: Официальная документация по модулю cisco.aci.aci_tenant.
APIC Management Information Model reference: Дополнительная информация об внутреннем классе APIC fv:EpRetPol.
Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a new EPR policy
  cisco.aci.aci_tenant_ep_retention_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    epr_policy: EPRPol1
    bounce_age: 630
    hold_interval: 300
    local_ep_interval: 900
    remote_ep_interval: 300
    move_frequency: 256
    description: test
    state: present
  delegate_to: localhost

- name: Remove an EPR policy
  cisco.aci.aci_tenant_ep_retention_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    epr_policy: EPRPol1
    state: absent
  delegate_to: localhost

- name: Query an EPR policy
  cisco.aci.aci_tenant_ep_retention_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    epr_policy: EPRPol1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all EPR policies
  cisco.aci.aci_tenant_ep_retention_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ	Возвращаемое значение	Описание
current список / элементы=строка	успех	Настройка, существующая в APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error словарь	ошибка	Информация об ошибке, возвращённая APIC Пример: {'code': '122', 'text': 'неизвестный класс управляемого объекта foo'}
filter_string строка	ошибка или отладка	Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only
method строка	ошибка или отладка	HTTP-метод, используемый для запроса к APIC Пример: POST
previous список / элементы=строка	информация	Исходная конфигурация из APIC до запуска модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производство', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собраная конфигурация из предоставленных пользователем параметров Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'production'}}}
raw строка	ошибка разбора	Необработанный вывод, возвращённый APIC REST API (xml или json) Пример: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="неизвестный класс управляемого объекта foo"/></imdata>
response строка	ошибка или отладка	HTTP-ответ от APIC Пример: OK (30 байт)
sent список / элементы=строка	информация	Фактическая/минимальная конфигурация, отправленная в APIC Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда'}}}
status целое число	ошибка или отладка	HTTP-статус от APIC Пример: 200
url строка	ошибка или отладка	HTTP-URL, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Авторы

Swetha Chunduri (@schunduri)

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