avi_pkiprofile - Модуль для настройки объекта PKIProfile Avi RESTful
Новый в версии 2.3.
Обзор
- Этот модуль используется для настройки объекта PKIProfile.
- Дополнительные примеры на https://github.com/avinetworks/devops
Требования (к хосту, выполняющему модуль)
- avisdk
Параметры
| параметр | обязательный | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| api_version | нет | Версия API Avi для использования с Avi API и объектами. | ||
| ca_certs | нет | Список доверенных центров сертификации (корневые и промежуточные), используемых для проверки сертификатов. | ||
| controller | нет | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | ||
| created_by | нет | Имя создателя. | ||
| crl_check | нет | При включении Avi проверит с помощью проверок CRL, что сертификаты в цепочке доверия не были отозваны. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. | ||
| crls | нет | Списки отозванных сертификатов (CRL). | ||
| ignore_peer_chain | нет | При включении Avi не будет доверять промежуточным и корневым сертификатам, представленным клиентом. Вместо этого будут использоваться только сертификаты цепочки, настроенные в разделе центров сертификации, для проверки доверия к сертификату клиента. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| is_federated (добавлен в 2.4)
| нет | Этот параметр описывает область репликации объекта. Если значение равно false, объект виден в кластере контроллеров и связанных с ним сервис-шлюзах. Если значение равно true, объект реплицируется по всей федерации. Параметр введён в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | ||
| name | да | Имя профиля PKI. | ||
| password | нет | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. | ||
| state | нет | present |
| Состояние, которое должно быть применено к объекту. |
| tenant | нет | admin | Имя пользователя, используемое для всех вызовов Avi API и контекста объекта. | |
| tenant_ref | нет | Ссылка на объект типа tenant. | ||
| tenant_uuid | нет | UUID пользователя, используемый для всех вызовов Avi API и контекста объекта. | ||
| url | нет | URL контроллера Avi объекта. | ||
| username | нет | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | ||
| uuid | нет | Уникальный идентификатор объекта. | ||
| validate_only_leaf_crl | нет | При включении Avi будет проверять только статус отозвания лиственного сертификата с помощью CRL. Чтобы включить проверку для всей цепочки, отключите этот параметр и укажите все соответствующие CRL. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как True. |
Примеры
- name: Example to create PKIProfile object
avi_pkiprofile:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_pkiprofile
Возвращаемые значения
Общие значения возврата описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| obj | Объект PKIProfile (api/pkiprofile) | success, changed | dict |
Статус
Этот модуль помечен как предварительная версия, что означает, что он не гарантирует обратную совместимость интерфейса.
Для помощи в разработке модулей, если вы заинтересованы, ознакомьтесь с Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/avi_pkiprofile_module.html
