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

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

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
certificate_name -		Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию устанавливается в `private_key` basename без расширения. Псевдонимы: 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 - / обязательно		Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если указан `private_key`, он будет использован вместо него.
port -		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
priority -	Варианты: level1 level2 level3 unspecified	Класс QoS. APIC по умолчанию использует `unspecified` при отсутствии значения при создании.
private_key - / обязательно		Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации на основе подписи. Имя ключа (без расширения) используется как имя сертификата в ACI, если не указан `certificate_name`. Этот параметр взаимоисключающий с `password`. Если указан `password`, он будет проигнорирован. Псевдонимы: cert_key
provider_match -	Варианты: all at_least_one at_most_one none	Критерии соответствия между поставщиками. APIC по умолчанию использует `at_least_one` при отсутствии значения при создании.
reverse_filter boolean	Варианты: 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 integer	По умолчанию: 30	Таймаут уровня сокета в секундах.
use_proxy boolean	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах.
use_ssl boolean	Варианты: no yes ←	Если `no`, будет использовано соединение HTTP вместо стандартного HTTPS.
username -	По умолчанию: "admin"	Имя пользователя для аутентификации. Псевдонимы: user
validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это должно быть установлено в `no` только при использовании на контролируемых сайтах с самозаверенными сертификатами.

Примечания

Примечание

Необходимо, чтобы tenant и contract существовали перед использованием этого модуля в вашей книге задач.
Модули aci_tenant и aci_contract могут быть использованы для этого.
Дополнительную информацию о внутреннем классе APIC vz:Subj можно найти в справочнике по модели управления информацией APIC.

См. также

Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

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

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

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

- name: Query all contract subjects
  aci_contract_subject:
    host: apic
    username: admin
    password: SomeSecretPassword
    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-URL, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Статус

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

Авторы

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