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

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

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
bounce_age целое число		Интервал старения записи bounce в секундах. Допустимые значения в диапазоне от `150` до `65535`; 0 используется для бесконечного значения. APIC по умолчанию использует значение `630`, если оно не задано при создании.
bounce_trigger строка	Варианты: coop flood	Определяет, устанавливаются ли записи bounce с помощью протокола RARP Flood или COOP. APIC по умолчанию использует значение `coop`, если оно не задано при создании.
certificate_name строка		Имя сертификата X.509, привязанного к пользователю APIC AAA для аутентификации на основе сертификатов. Если предоставлено имя файла с расширением `private_key`, по умолчанию используется имя файла без расширения `private_key`. Если для `private_key` предоставлено содержимое в формате PEM, по умолчанию используется значение `username`. псевдонимы: cert_name
description строка		Описание политики удержания конечных точек. псевдонимы: descr
epr_policy строка		Имя политики удержания конечных точек. псевдонимы: epr_name, name
hold_interval целое число		Интервал удержания в секундах. Допустимые значения в диапазоне от `5` до `65535`. APIC по умолчанию использует значение `300`, если оно не задано при создании.
host строка / обязательно		IP-адрес или имя хоста APIC, разрешаемый хостом управления Ansible. псевдонимы: hostname
local_ep_interval целое число		Интервал старения локальной конечной точки в секундах. Допустимые значения в диапазоне от `120` до `65535`; 0 используется для бесконечного значения. APIC по умолчанию использует значение `900`, если оно не задано при создании.
move_frequency целое число		Частота перемещения в секунду. Допустимые значения в диапазоне от `0` до `65535`; 0 используется для отсутствия перемещения. APIC по умолчанию использует значение `256`, если оно не задано при создании.
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию.
password строка / обязательно		Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если указан `private_key`, он будет использован вместо него.
port целое число		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
private_key строка / обязательно		Файл закрытого ключа в формате PEM или содержимое закрытого ключа для аутентификации на основе сертификатов. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключающий с `password`. Если указан `password`, он будет проигнорирован. псевдонимы: cert_key
remote_ep_interval целое число		Интервал старения удаленной конечной точки в секундах. Допустимые значения в диапазоне от `120` до `65535`; 0 используется для бесконечного значения. APIC по умолчанию использует значение `300`, если оно не задано при создании.
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.

См. также

aci_tenant – Управление арендаторами (fv:Tenant): Официальная документация по модулю aci_tenant.
Справочник по модели информации управления APIC: Дополнительная информация о внутреннем классе APIC fv:EpRetPol.
Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

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

Статус

Этот модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается партнером Ansible. [сертифицировано]

Авторы

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.9/modules/aci_tenant_ep_retention_policy_module.html