cisco.aci.aci_filter – Управляет фильтрами верхнего уровня (vz:Filter)

Примечание

Этот плагин входит в коллекцию cisco.aci (версия 1.1.1).

Для его установки используйте: ansible-galaxy collection install cisco.aci.

Чтобы использовать его в плейбуке, укажите: cisco.aci.aci_filter.

Описание
Параметры
Примечания
См. также
Примеры
Значения возврата

Описание

Управляет фильтрами верхнего уровня на фабриках Cisco ACI.
Этот модуль не управляет записями фильтров, см. cisco.aci.aci_filter_entry для этой функциональности.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотации объекта. Если значение не указано в задаче, используется значение переменной окружения `ACI_ANNOTATION`.
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если предоставлено имя файла `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если предоставлено содержание в формате PEM для `private_key`, по умолчанию используется значение `username`. Если значение не указано в задаче, используется значение переменной окружения `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
description строка		Описание фильтра. псевдонимы: descr
filter строка		Имя фильтра. псевдонимы: filter_name, name
host строка / обязательно		IP-адрес или имя хоста APIC, разрешимый хостом управления Ansible. Если значение не указано в задаче, используется значение переменной окружения `ACI_HOST`. псевдонимы: hostname
name_alias строка		Псевдоним текущего объекта. Он относится к полю nameAlias в ACI.
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, используется значение переменной окружения `ACI_OUTPUT_LEVEL`.
output_path строка		Путь к файлу, который будет использоваться для вывода объектов конфигурации ACI JSON, сгенерированных модулем. Если значение не указано в задаче, используется значение переменной окружения `ACI_OUTPUT_PATH`.
owner_key строка		Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет ключ, который позволяет клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, используется значение переменной окружения `ACI_OWNER_KEY`.
owner_tag строка		Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет тег, который позволяет клиентам добавлять свои собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задаче, используется значение переменной окружения `ACI_OWNER_TAG`.
password строка		Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если `private_key` также предоставлен, он будет использован вместо него. Если значение не указано в задаче, используется значение переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число		Номер порта, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, используется значение переменной окружения `ACI_PORT`.
private_key строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключающий с `password`. Если `password` также предоставлен, он будет проигнорирован. Если значение не указано в задаче, используется значение переменной окружения `ACI_PRIVATE_KEY`. псевдонимы: cert_key
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для получения списка объекта или нескольких объектов.
tenant строка		Имя клиента. псевдонимы: tenant_name
timeout целое число	Значение по умолчанию: 30	Таймаут уровня сокета в секундах. Если значение не указано в задаче, используется значение переменной окружения `ACI_TIMEOUT`.
use_proxy логическое значение	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Если значение не указано в задаче, используется значение переменной окружения `ACI_USE_PROXY`.
use_ssl логическое значение	Варианты: no yes ←	Если `no`, вместо стандартного HTTPS соединения будет использоваться HTTP соединение. Если значение не указано в задаче, используется значение переменной окружения `ACI_USE_SSL`.
username строка	Значение по умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, используется значение переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: user
validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверяться. Это следует установить в `no` только при использовании на контролируемых вами сайтах с самозаверяющимися сертификатами. Если значение не указано в задаче, используется значение переменной окружения `ACI_VALIDATE_CERTS`.

Примечания

Примечание

Клиент tenant должен существовать перед использованием этого модуля в вашем плейбуке. Модуль cisco.aci.aci_tenant может использоваться для этого.

См. также

cisco.aci.aci_tenant: Официальная документация по модулю cisco.aci.aci_tenant.
Справочник по модели информации управления APIC: Дополнительная информация об внутреннем классе APIC vz:Filter.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a new filter to a tenant
  cisco.aci.aci_filter:
    host: apic
    username: admin
    password: SomeSecretPassword
    filter: web_filter
    description: Filter for web protocols
    tenant: production
    state: present
  delegate_to: localhost

- name: Remove a filter for a tenant
  cisco.aci.aci_filter:
    host: apic
    username: admin
    password: SomeSecretPassword
    filter: web_filter
    tenant: production
    state: absent
  delegate_to: localhost

- name: Query a filter of a tenant
  cisco.aci.aci_filter:
    host: apic
    username: admin
    password: SomeSecretPassword
    filter: web_filter
    tenant: production
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all filters for a tenant
  cisco.aci.aci_filter:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    state: query
  delegate_to: localhost
  register: query_result

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
current список / элементы=строка	успех	Текущая конфигурация с APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'производство', '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': 'производство', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собранная конфигурация из параметров пользователя Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'производство'}}}
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.10/collections/cisco/aci/aci_filter_module.html