aci_contract_subject - Управление начальными предметами контрактов (vz:Subj)

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

Обзор
Параметры
Примечания
Примеры
Значения возврата
Статус
- Автор

Обзор

Управление начальными предметами контрактов на платформах Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
certificate_name	По умолчанию: C(private_key) имя_файла	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию — `private_key` имя_файла без расширения. Псевдонимы: cert_name
consumer_match	Варианты: all at_least_one ← at_most_one none	Критерии соответствия для потребителей. APIC по умолчанию устанавливает новые предметы контрактов на `at_least_one`.
contract		Имя контракта. Псевдонимы: contract_name
description		Описание предмета контракта. Псевдонимы: descr
dscp	Варианты: AF11 AF12 AF13 AF21 AF22 AF23 AF31 AF32 AF33 AF41 AF42 AF43 CS0 CS1 CS2 CS3 CS4 CS5 CS6 CS7 EF VA unspecified ←	Целевой DSCP. APIC по умолчанию устанавливает новые предметы контрактов на `unspecified`. Псевдонимы: target
host обязательно		IP-адрес или имя хоста, разрешаемого хостом управления Ansible. Псевдонимы: hostname
output_level	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` означает информативный вывод, включая `previous`, `proposed` и `sent` словари. `debug` означает отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию.
password обязательно		Пароль для аутентификации.
port	По умолчанию: 443 (для https) и 80 (для http)	Номер порта, используемого для подключения REST.
priority	Варианты: level1 level2 level3 unspecified ←	Класс QoS. APIC по умолчанию устанавливает новые предметы контрактов на `unspecified`.
private_key		Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации на основе подписи. Имя ключа (без расширения) используется в качестве имени сертификата в ACI, если не указано `certificate_name`. Псевдонимы: cert_key
provider_match	Варианты: all at_least_one ← at_most_one none	Критерии соответствия для поставщиков. APIC по умолчанию устанавливает новые предметы контрактов на `at_least_one`.
reverse_filter	Варианты: no yes ←	Определяет, должен ли APIC инвертировать порты src и dst, чтобы разрешить возврат трафика, поскольку ACI является бессостоятельным фильтром. APIC по умолчанию устанавливает новые предметы контрактов на `yes`.
state	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
subject		Имя предмета контракта. Псевдонимы: contract_subject, name, subject_name
tenant		Имя арендатора. Псевдонимы: tenant_name
timeout	По умолчанию: 30	Таймаут уровня сокета в секундах.
use_proxy	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
use_ssl	Варианты: no yes ←	Если `no`, вместо стандартного HTTPS-подключения будет использовано HTTP-подключение.
username обязательно	По умолчанию: admin	Имя пользователя для аутентификации. Псевдонимы: user
validate_certs	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует установить только на `no` сайтах с использованием самоподписанных сертификатов.

Примечания

Примечание

tenant и contract должны существовать перед использованием этого модуля в вашем плейбуке.
Модули aci_tenant и aci_contract могут быть использованы для этого.
Дополнительную информацию об внутренней APIC-классе vz:Subj см. в справочнике по модели управления информацией APIC.
По умолчанию, если переменная среды <protocol>_proxy установлена на целевом хосте, запросы будут отправляться через этот прокси. Это поведение можно переопределить, задав переменную для этой задачи (см. настройку среды) или используя параметр use_proxy.
HTTP-редиректы могут перенаправлять с HTTP на HTTPS, поэтому убедитесь, что ваша среда прокси для обоих протоколов корректна.

Примеры

- name: Add a new contract subject
  aci_contract_subject:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    subject: default
    description: test
    reverse_filter: yes
    priority: level1
    dscp: unspecified
    state: present

- name: Remove a contract subject
  aci_contract_subject:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    subject: default
    state: absent

- name: Query a contract subject
  aci_contract_subject:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    subject: default
    state: query

- name: Query all contract subjects
  aci_contract_subject:
    host: apic
    username: admin
    password: SomeSecretPassword
    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 строка	ошибка разбора	Необработанный вывод, возвращенный API APIC REST (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

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется обратной совместимости.

Автор

Swetha Chunduri (@schunduri)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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_module.html