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

Новая версия 2.4.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
bounce_age	Значение по умолчанию: 630	Интервал старения записей Bounce (диапазон 150 сек - 65535 сек) 0 используется для бесконечного значения.
bounce_trigger	Значение по умолчанию: coop	Определяет, устанавливаются ли записи Bounce протоколом RARP Flood или COOP. APIC по умолчанию устанавливает новые политики удержания конечных точек в значение `coop`.
certificate_name	Значение по умолчанию: C(private_key) basename	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию используется значение `private_key` basename без расширения. Псевдонимы: cert_name
description		Описание политики удержания конечной точки. Псевдонимы: descr
epr_policy		Имя политики удержания конечной точки. Псевдонимы: epr_name, name
hold_interval	Значение по умолчанию: 300	Интервал удержания (диапазон 5 сек - 65535 сек).
host обязательно		IP-адрес или имя хоста APIC, разрешаемые хостом управления Ansible. Псевдонимы: hostname
local_ep_interval	Значение по умолчанию: 900	Интервал старения локальной конечной точки (диапазон 120 сек - 65535 сек). 0 используется для бесконечного значения.
move_frequency	Значение по умолчанию: 256	Частота перемещения в секунду (диапазон 0 сек - 65535 сек). 0 используется для отсутствия.
output_level	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` означает информативный вывод, включая `previous`, `proposed` и `sent` dicts `debug` означает отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию
password обязательно		Пароль для аутентификации.
port	Значение по умолчанию: 443 (для https) и 80 (для http)	Номер порта для подключения REST.
private_key		Файл в формате PEM, содержащий ваш закрытый ключ для аутентификации на основе подписи. Имя ключа (без расширения) используется как имя сертификата в ACI, если не указано `certificate_name`. Псевдонимы: cert_key
remote_ep_interval	Значение по умолчанию: 300	Интервал старения удаленной конечной точки (диапазон 120 сек - 65535 сек). 0 используется для бесконечного значения.
state	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
tenant		Имя существующего арендатора. Псевдонимы: tenant_name
timeout	Значение по умолчанию: 30	Таймаут уровня сокета в секундах.
use_proxy	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
use_ssl	Варианты: no yes ←	Если `no`, вместо стандартного подключения HTTPS будет использоваться подключение HTTP.
username обязательно	Значение по умолчанию: admin	Имя пользователя для аутентификации. Псевдонимы: user
validate_certs	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверяться. Это следует устанавливать только в `no` на сайтах с собственной подписью, контролируемых лично.

Примечания

Примечание

Используемый tenant должен существовать перед использованием этого модуля в вашем плейбуке. Для этого можно использовать модуль aci_tenant.
Дополнительную информацию об внутреннем классе APIC fv:EpRetPol см. в справочнике по модели управления информацией APIC.
По умолчанию, если на целевом хосте установлена переменная среды <protocol>_proxy, запросы будут отправляться через этот прокси. Это поведение можно переопределить, установив переменную для этой задачи (см. настройка среды), или используя параметр use_proxy.
Перенаправления HTTP могут перенаправлять с HTTP на HTTPS, поэтому необходимо убедиться, что ваша среда прокси для обоих протоколов корректна.

Примеры

- name: Add a new EPR policy
  aci_epr_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

- name: Remove an EPR policy
  aci_epr_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    epr_policy: EPRPol1
    state: absent

- name: Query an EPR policy
  aci_epr_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    epr_policy: EPRPol1
    state: query

- name: Query all EPR policies
  aci_epr_policy:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query

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

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

Ключ	Возвращаемое значение	Описание
current список	успех	Текущая конфигурация с APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производственная среда', 'nameAlias': '', 'ownerTag': ''}}}]
error словарь	ошибка	Информация об ошибке, возвращенная с APIC Пример: {'text': 'неизвестный класс управляемого объекта foo', 'code': '122'}
filter_string строка	ошибка или отладка	Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only
method строка	ошибка или отладка	HTTP-метод, используемый для запроса к APIC Пример: POST
previous список	информация	Исходная конфигурация с APIC до запуска модуля Пример: [{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производственная', 'nameAlias': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собраная конфигурация из параметров, предоставленных пользователем Пример: {'fvTenant': {'attributes': {'name': 'production', 'descr': 'Производственная среда'}}}
raw строка	ошибка парсинга	Необработанный вывод, возвращенный API REST APIC (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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/aci_tenant_ep_retention_policy_module.html