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`, по умолчанию используется базовое имя `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. псевдонимы: cert_name
description строка		Описание политики удержания конечной точки. псевдонимы: descr
epr_policy строка		Имя политики удержания конечной точки. псевдонимы: epr_name, name
hold_interval целое число		Интервал удержания в секундах. Принимаемые значения находятся в диапазоне от `5` до `65535`. APIC по умолчанию устанавливает значение `300` при отсутствии значения при создании.
host строка / обязательно		IP-адрес или имя хоста, разрешаемого хостом управления 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`, будет использоваться соединение HTTP вместо соединения HTTPS по умолчанию.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. псевдонимы: user
validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует установить в `no` только при использовании на сайтах, контролируемых лично, с использованием самозаверяемых сертификатов.

Примечания

Примечание

Абонент tenant должен существовать перед использованием этого модуля в вашем playbook. Для этого можно использовать модуль 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 строка	ошибка разбора	Необработанный вывод, возвращенный 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-адрес, используемый для запроса к 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.8/modules/aci_tenant_ep_retention_policy_module.html