aci_contract - Управление ресурсами контрактов (vz:BrCP)

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

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

Обзор

Управление ресурсами контрактов в Cisco ACI сетях.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
certificate_name	По умолчанию: C(private_key) имя_базового_файла	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию используется имя `private_key`, без расширения. Псевдонимы: cert_name
contract обязательно		Имя контракта. Псевдонимы: contract_name, 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 не указано ←	Значение целевого DSCP (Differentiated Services Code Point). Псевдонимы: target
host обязательно		IP-адрес или имя хоста APIC, разрешимые для хоста управления Ansible. Псевдонимы: hostname
output_level	Варианты: отладка информация обычный ←	Влияние на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь `info` означает информативный вывод, включая `previous`, `proposed` и `sent` словари `debug` означает вывод отладки, включая `filter_string`, `method`, `response`, `status` и `url` информацию
password обязательно		Пароль для аутентификации.
port	По умолчанию: 443 (для https) и 80 (для http)	Номер порта для подключения REST.
priority	Варианты: уровень1 уровень2 уровень3 не указано ←	Требуемый класс QoS.
private_key		Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации на основе подписи. Имя ключа (без расширения) используется как имя сертификата в ACI, если не указано `certificate_name`. Псевдонимы: cert_key
scope	Варианты: профиль-приложения контекст ← глобальный аренда	Область действия контракта службы.
state	Варианты: отсутствует существует ← запрос	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
tenant обязательно		Имя аренды. Псевдонимы: tenant_name
timeout	По умолчанию: 30	Таймаут сокета в секундах.
use_proxy	Варианты: нет да ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
use_ssl	Варианты: нет да ←	Если `no`, вместо стандартного HTTPS-соединения будет использовано HTTP-соединение.
username обязательно	По умолчанию: admin	Имя пользователя для аутентификации. Псевдонимы: user
validate_certs	Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Это должно быть установлено на `no` только для сайтов с собственными сертификатами, контролируемыми вами лично.

Примечания

Примечание

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

Примеры

- name: Add a new contract
  aci_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    description: Communication between web-servers and database
    scope: application-profile
    state: present

- name: Remove an existing contract
  aci_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    state: absent

- name: Query a specific contract
  aci_contract:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    contract: web_to_db
    state: query

- name: Query all contracts
  aci_contract:
    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 строка	ошибка разбора	Необработанный вывод, возвращенный 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

Статус

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

Автор

Dag Wieers (@dagwieers)

Подсказка

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

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