aci_filter — Управляет объектами фильтров верхнего уровня (vz:Filter)
Новая версия с 2.4.
Обзор
- Управляет объектами фильтров верхнего уровня на тканях Cisco ACI.
- Этот модуль не управляет записями фильтров, см. aci_filter_entry для этой функциональности.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| certificate_name | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию — private_key базовое имя без расширения.Псевдонимы: 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 обязательно | Пароль для аутентификации. Этот параметр взаимоисключающий с private_key. Если также указан private_key, он будет использован вместо него. | |
| port | Порт, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. | |
| private_key обязательно | Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации на основе подписи. Имя ключа (без расширения) используется в качестве имени сертификата в ACI, если не указано certificate_name. Этот параметр взаимоисключающий с password. Если также указан password, он будет проигнорирован.Псевдонимы: cert_key | |
| state |
| Используйте present или absent для добавления или удаления.Используйте query для получения списка объекта или нескольких объектов. |
| tenant обязательно | Имя арендатора. Псевдонимы: tenant_name | |
| timeout int | По умолчанию: 30 | Таймаут уровня сокета в секундах. |
| use_proxy bool |
| Если no, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах. |
| use_ssl bool |
| Если no, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения. |
| username | По умолчанию: "admin" | Имя пользователя для аутентификации. Псевдонимы: user |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены.Это следует устанавливать в no только при работе с собственными сертификатами на контролируемых сайтах. |
Примечания
Примечание
- Используемый
tenantдолжен существовать, прежде чем использовать этот модуль в вашей книге сценариев. Для этого можно использовать модуль aci_tenant. - Дополнительную информацию об внутреннем классе APIC vz:Filter см. в справочнике по модели информации управления APIC.
- Подробную информацию об управлении инфраструктурой ACI с помощью Ansible см. в руководстве Cisco ACI.
Примеры
- 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': {'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 строка | ошибка разбора | Необработанный вывод, возвращаемый 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-адрес, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json |
Статус
Этот модуль помечен как превью, что означает, что гарантии обратной совместимости нет.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/aci_filter_module.html
