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

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

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

Описание

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

Параметры

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

Примечания

Примечание

Этот модуль не управляет предметами контрактов, см. aci_contract_subject для этого. Предметы контрактов всё ещё могут быть удалены с помощью этого модуля.
Необходимо, чтобы tenant существовал перед использованием этого модуля в вашем плане. Модуль aci_tenant может быть использован для этого.

См. также

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

Примеры

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

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

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

- name: Query all contracts
  aci_contract:
    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 строка	ошибка разбора	Необработанный вывод, возвращенный API REST APIC (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. [сертифицировано]

Авторы

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