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

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

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
bounce_age		Интервал старения записи отскока (диапазон 150 сек - 65535 сек) 0 используется для бесконечного значения. APIC по умолчанию устанавливает `630`, если значение не задано при создании.
bounce_trigger	Варианты: coop flood	Определяет, устанавливаются ли записи отскока протоколом RARP Flood или COOP. APIC по умолчанию устанавливает `coop`, если значение не задано при создании.
certificate_name		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию используется `private_key`, без расширения. Псевдонимы: 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` dict `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию
password обязательно		Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если `private_key` также указан, будет использован он.
port		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
private_key обязательно		Файл в формате PEM с вашим закрытым ключом для аутентификации на основе подписи. Имя ключа (без расширения) используется в качестве имени сертификата в ACI, если не указано `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 int	По умолчанию: 30	Таймаут уровня сокета в секундах.
use_proxy bool	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах.
use_ssl bool	Варианты: no yes ←	Если `no`, вместо стандартного HTTPS соединения будет использовано HTTP соединение.
username	По умолчанию: "admin"	Имя пользователя для аутентификации. Псевдонимы: user
validate_certs bool	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это должно быть установлено в `no` только при использовании на сайтах под личным контролем, использующих самозаверенные сертификаты.

Примечания

Примечание

Необходимо, чтобы tenant существовал перед использованием этого модуля в вашем плейбуке. Для этого можно использовать модуль aci_tenant.
Дополнительную информацию об внутреннем классе APIC fv:EpRetPol можно найти в справочнике по модели управления информацией APIC.
Для получения более подробной информации о управлении вашей инфраструктурой ACI с помощью Ansible, обратитесь к Руководству Cisco ACI.

Примеры

- 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': {'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. Дополнительная информация доступна в разделе Поддержка и обслуживание модулей.

Список других модулей, поддерживаемых сообществом 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.6/modules/aci_tenant_ep_retention_policy_module.html