aci_contract_subject_to_filter – Bind Contract Subjects to Filters (vz:RsSubjFiltAtt) — Ansible 2.9

Новое в версии 2.4.

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

Описание

Привязка предметов контракта к фильтрам на тканях Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
certificate_name строка		Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если было предоставлено имя файла `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. алиасы: cert_name
contract строка		Имя контракта. алиасы: contract_name
filter строка		Имя фильтра для привязки к предмету. алиасы: filter_name
host строка / обязательно		IP-адрес или имя хоста APIC, разрешаемый управляющим хостом Ansible. алиасы: hostname
log строка	Варианты: log none	Определяет, будет ли привязка регистрироваться. APIC по умолчанию использует `none` при отсутствии указания. алиасы: directive
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` dicts `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
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для отображения объекта или нескольких объектов.
subject строка		Имя предмета контракта. алиасы: contract_subject, subject_name
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, contract, subject, и filter_name. Модули aci_tenant, aci_contract, aci_contract_subject и aci_filter могут быть использованы для этого.

См. также

aci_contract_subject – Управление начальными субъектами контрактов (vz:Subj): Официальная документация по модулю aci_contract_subject.
aci_filter – Управление фильтрами верхнего уровня (vz:Filter): Официальная документация по модулю aci_filter.
APIC Management Information Model reference: Дополнительная информация о внутреннем классе APIC vz:RsSubjFiltAtt.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- 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
  delegate_to: localhost

- 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
  delegate_to: localhost

- 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
  delegate_to: localhost
  register: query_result

- 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
  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 строка	ошибка разбора	Необработанный результат, возвращаемый 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-адрес, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Статус

Этот модуль не гарантирует обратной совместимости. [превью]
Этот модуль поддерживается партнёром Ansible. [сертифицировано]

Авторы

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.9/modules/aci_contract_subject_to_filter_module.html

aci_contract_subject_to_filter – Привязка предметов контракта к фильтрам (vz:RsSubjFiltAtt)

Описание

Параметры

Примечания

См. также

Примеры

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

Статус

Авторы