aci_contract_subject - Управление начальными предметами контракта (vz:Subj)
Новое в версии 2.4.
Обзор
- Управление начальными предметами контракта на тканях Cisco ACI.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| certificate_name | Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию равно private_key базовому имени без расширения.Псевдонимы: cert_name | |
| consumer_match |
| Критерии сопоставления между потребителями. APIC по умолчанию устанавливает значение at_least_one при отсутствии значения во время создания. |
| contract | Имя контракта. Псевдонимы: contract_name | |
| description | Описание предмета контракта. Псевдонимы: descr | |
| dscp |
| Целевое значение DSCP. APIC по умолчанию устанавливает значение unspecified при отсутствии значения во время создания.Псевдонимы: target |
| host обязательно | IP-адрес или имя хоста APIC, разрешаемые хостом управления Ansible. Псевдонимы: hostname | |
| 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 |
| Класс QoS. APIC по умолчанию устанавливает значение unspecified при отсутствии значения во время создания. |
| private_key обязательно | Файл в формате PEM, содержащий ваш закрытый ключ для аутентификации на основе подписи. Имя ключа (без расширения) используется в качестве имени сертификата в ACI, если не указано certificate_name. Этот параметр взаимоисключает password. Если также указан password, он будет проигнорирован.Псевдонимы: cert_key | |
| provider_match |
| Критерии сопоставления между поставщиками. APIC по умолчанию устанавливает значение at_least_one при отсутствии значения во время создания. |
| reverse_filter bool |
| Определяет, должен ли APIC инвертировать порты src и dst, чтобы разрешить обратный трафик, поскольку ACI — это бессостоятельный фильтр. APIC по умолчанию устанавливает значение yes при отсутствии значения во время создания. |
| state |
| Используйте present или absent для добавления или удаления.Используйте query для получения списка объекта или нескольких объектов. |
| subject | Имя предмета контракта. Псевдонимы: contract_subject, name, subject_name | |
| tenant | Имя клиента. Псевдонимы: tenant_name | |
| timeout int | Значение по умолчанию: 30 | Таймаут уровня сокета в секундах. |
| use_proxy bool |
| Если no, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. |
| use_ssl bool |
| Если no, вместо стандартного подключения HTTPS будет использоваться соединение HTTP. |
| username | Значение по умолчанию: "admin" | Имя пользователя для аутентификации. Псевдонимы: user |
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены.Это следует устанавливать только в no при использовании на контролируемых сайтах с самозаверенными сертификатами. |
Примечания
Примечание
tenantиcontractдолжны существовать перед использованием этого модуля в вашей книге сценариев.- Модули aci_tenant и aci_contract могут быть использованы для этого.
- Дополнительную информацию о внутреннем классе APIC vz:Subj см. в справочнике по модели управления информацией APIC.
- Для получения более подробной информации о управлении инфраструктурой ACI с помощью Ansible, обратитесь к Руководству 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
- name: Remove a contract subject
aci_contract_subject:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
contract: web_to_db
subject: default
state: absent
- name: Query a contract subject
aci_contract_subject:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
contract: web_to_db
subject: default
state: query
- name: Query all contract subjects
aci_contract_subject:
host: apic
username: admin
password: SomeSecretPassword
state: query
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращено | Описание |
|---|---|---|
| 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. Подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом 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.6/modules/aci_contract_subject_module.html
