aci_contract_subject_to_filter - Привязка объектов контракта к фильтрам (vz:RsSubjFiltAtt)
Новое в версии 2.4.
Обзор
- Привязка объектов контракта к фильтрам на устройствах Cisco ACI.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| certificate_name | По умолчанию: C(private_key) basename | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию — private_key basename без расширения.Псевдонимы: cert_name |
| contract | Имя контракта. Псевдонимы: contract_name | |
| filter | Имя фильтра, привязываемого к объекту. Псевдонимы: filter_name | |
| host обязательно | IP-адрес или имя хоста APIC, разрешаемого управляющим хостом Ansible. Псевдонимы: hostname | |
| log |
| Определяет, должна ли привязка записываться в журнал. APIC по умолчанию устанавливает новые привязки "Объект-Фильтр" в none.Псевдонимы: directive |
| 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 для отображения объекта или нескольких объектов. |
| subject | Имя объекта контракта. Псевдонимы: contract_subject, subject_name | |
| tenant обязательно | Имя клиента. Псевдонимы: tenant_name | |
| timeout | По умолчанию: 30 | Таймаут уровня сокета в секундах. |
| use_proxy |
| Если no, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. |
| use_ssl |
| Если no, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения. |
| username обязательно | По умолчанию: admin | Имя пользователя для аутентификации. Псевдонимы: user |
| validate_certs |
| Если no, сертификаты SSL не будут проверены.Это следует использовать только на контролируемых локально сайтах, использующих самоподписанные сертификаты. |
Примечания
Примечание
- Модули
tenant,contract,subject, иfilter_nameдолжны существовать перед использованием этого модуля в вашем плейбуке. - Модули aci_tenant, aci_contract, aci_contract_subject, и aci_filter могут использоваться для этого.
- Дополнительная информация об внутреннем классе APIC vz:RsSubjFiltAtt из справочника по модели управления информацией APIC.
- По умолчанию, если переменная среды
<protocol>_proxyустановлена на целевом хосте, запросы будут отправляться через этот прокси. Это поведение можно переопределить, установив переменную для этой задачи (см. установку окружения), или используя опциюuse_proxy. - HTTP-редиректы могут перенаправлять с HTTP на HTTPS, поэтому убедитесь, что ваша среда прокси для обоих протоколов корректна.
Примеры
- name: Add a new contract subject to filer binding
aci_contract_subject_to_filter:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
contract: web_to_db
subject: test
filter: '{{ filter }}'
log: '{{ log }}'
state: present
- name: Remove an existing contract subject to filter binding
aci_contract_subject_to_filter:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
contract: web_to_db
subject: test
filter: '{{ filter }}'
log: '{{ log }}'
state: present
- name: Query a specific contract subject to filter binding
aci_contract_subject_to_filter:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
contract: web_to_db
subject: test
filter: '{{ filter }}'
state: query
- name: Query all contract subject to filter bindings
aci_contract_subject_to_filter:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
contract: web_to_db
subject: test
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 строка | ошибка разбора | Необработанный вывод, возвращённый 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 |
Состояние
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Автор
- Jacob McGill (@jmcgill298)
Подсказка
Если вы заметите какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.
© 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_contract_subject_to_filter_module.html