aci_filter - Управляет фильтрами верхнего уровня (vz:Filter)
Новое в версии 2.4.
Обзор
- Управляет фильтрами верхнего уровня на Cisco ACI фабриках.
- Этот модуль не управляет записями фильтров, см. aci_filter_entry для этой функциональности.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| certificate_name | По умолчанию: C(private_key) basename | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию равно private_key basename без расширения.псевдонимы: cert_name |
| description | Описание фильтра. псевдонимы: descr | |
| filter обязательно | Имя фильтра. псевдонимы: filter_name, name | |
| host обязательно | IP-адрес или имя хоста APIC, разрешимый управляющим хостом Ansible. псевдонимы: hostname | |
| output_level |
| Влияет на вывод этого модуля ACI. normal означает стандартный вывод, включая current словарь.info означает информационный вывод, включая previous, proposed и sent словари.debug означает отладочный вывод, включая filter_string, method, response, status и url информацию. |
| password обязательно | Пароль для аутентификации. | |
| port | По умолчанию: 443 (для https) и 80 (для http) | Порт, используемый для подключения REST. |
| private_key | Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации на основе подписи. Имя ключа (без расширения) используется в качестве имени сертификата в ACI, если не указано certificate_name. псевдонимы: cert_key | |
| state |
| Используйте present или absent для добавления или удаления.Используйте query для перечисления объекта или нескольких объектов. |
| tenant обязательно | Имя клиента. псевдонимы: tenant_name | |
| timeout | По умолчанию: 30 | Таймаут уровня сокета в секундах. |
| use_proxy |
| Если no, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. |
| use_ssl |
| Если no, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения. |
| username обязательно | По умолчанию: admin | Имя пользователя для аутентификации. псевдонимы: user |
| validate_certs |
| Если no, сертификаты SSL не будут проверены.Это следует устанавливать только в no на контролируемых сайтах с использованием самозаверенных сертификатов. |
Примечания
Примечание
- Файл
tenantдолжен существовать перед использованием этого модуля в вашем плане. Для этого можно использовать модуль aci_tenant. - Дополнительная информация об внутреннем классе APIC vz:Filter из справочника по модели управления информацией APIC.
- По умолчанию, если на целевом хосте установлена переменная среды
<protocol>_proxy, запросы будут отправляться через этот прокси. Это поведение можно переопределить, установив переменную для этой задачи (см. настройка среды), или используя опциюuse_proxy. - HTTP-редиректы могут перенаправлять с HTTP на HTTPS, поэтому убедитесь, что ваша среда прокси для обоих протоколов корректна.
Примеры
- name: Add a new filter to a tenant
aci_filter:
host: apic
username: admin
password: SomeSecretPassword
filter: web_filter
description: Filter for web protocols
tenant: production
state: present
- name: Remove a filter for a tenant
aci_filter:
host: apic
username: admin
password: SomeSecretPassword
filter: web_filter
tenant: production
state: absent
- name: Query a filter of a tenant
aci_filter:
host: apic
username: admin
password: SomeSecretPassword
filter: web_filter
tenant: production
state: query
- name: Query all filters for a tenant
aci_filter:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
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 строка | ошибка разбора | Необработанный вывод, возвращённый REST API 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 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Автор
- Dag Wieers (@dagwieers)
Подсказка
Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_filter_module.html
