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, 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	Целевое значение Differentiated Service (DSCP). APIC по умолчанию использует значение `unspecified`, если оно не задано при создании. Псевдонимы: target
host строка / обязательно		IP-адрес или имя хоста APIC, разрешаемого управляющим хостом Ansible. Псевдонимы: hostname
output_level строка	Варианты: debug info normal ←	Влияние на вывод данного модуля ACI. `normal` означает стандартный вывод, включая `current` dict. `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` dicts. `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
scope строка	Варианты: application-profile context global tenant	Область применения контракта службы. APIC по умолчанию использует значение `context` если не задано при создании.
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для отображения объекта или нескольких объектов.
tenant строка / обязательно		Имя клиента. Псевдонимы: tenant_name
timeout целое число	По умолчанию: 30	Таймаут на уровне сокета в секундах.
use_proxy булево	Варианты: no yes ←	Если `no`, не будет использоваться прокси-сервер, даже если он определён в переменной окружения на целевых хостах.
use_ssl булево	Варианты: no yes ←	Если `no`, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. Псевдонимы: user
validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это значение должно быть установлено в `no` только при работе с сайтами, находящимися под личным контролем и использующими самозаверенные сертификаты.

Примечания

Примечание

Этот модуль не управляет объектами контракта. Для этого см. aci_contract_subject. Объекты контракта все ещё могут быть удалены с помощью этого модуля.
Перед использованием этого модуля в вашем плейбуке tenant должен существовать. Для этого можно использовать модуль aci_tenant.

См. также

aci_contract_subject – Управление исходными объектами контрактов (vz:Subj): Официальная документация модуля aci_contract_subject.
aci_tenant – Управление клиентами (fv:Tenant): Официальная документация модуля aci_tenant.
Ссылка на справочник модели информации управления APIC: Дополнительная информация о внутренней категории 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 строка	ошибка разбора	Необработанный вывод, возвращённый 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. [сертифицировано]

Авторы

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