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

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

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе сертификатов. Если был предоставлен `private_key` имя файла, значение по умолчанию устанавливается в `private_key` базовое имя без расширения. Если для `private_key` был предоставлен контент в формате PEM, значение по умолчанию устанавливается в `username` значение. Псевдонимы: 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-адрес или имя хоста APIC, разрешаемое управляющим хостом 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 или содержимое приватного ключа, используемого для аутентификации на основе сертификатов. Это значение также влияет на значение по умолчанию `certificate_name`. Этот параметр взаимоисключающий с `password`. Если также предоставлено `password`, оно будет проигнорировано. Псевдонимы: cert_key
provider_match строка	Варианты: all at_least_one at_most_one none	Критерии сопоставления по поставщикам. APIC по умолчанию использует значение `at_least_one`, если оно не задано при создании.
reverse_filter логическое значение	Варианты: no yes	Определяет, должен ли APIC перевернуть исходные и конечные порты, чтобы разрешить обратный трафик, так как 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.

См. также

aci_contract – Управление ресурсами контрактов (vz:BrCP): Официальная документация модуля aci_contract.
aci_tenant – Управление арендаторами (fv:Tenant): Официальная документация модуля aci_tenant.
APIC Management Information Model reference: Дополнительная информация о внутреннем классе APIC vz:Subj.
Руководство по 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.9/modules/aci_contract_subject_module.html