avi_pkiprofile - Модуль для настройки объекта PKIProfile Avi RESTful
Новое в версии 2.3.
Описание
- Этот модуль используется для настройки объекта PKIProfile.
- Дополнительные примеры см. на странице https://github.com/avinetworks/devops
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context (добавлено в 2.5) | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить однократный вход и повторно использовать сеанс. | |
| api_version | По умолчанию: "16.4.4" | Версия API Avi, используемая для взаимодействия с Avi API и объектами. |
| avi_api_patch_op (добавлено в 2.5) |
| Операция обновления, используемая при использовании avi_api_update_method как patch. |
| avi_api_update_method (добавлено в 2.5) |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка в patch переопределит это поведение, чтобы использовать HTTP PATCH. |
| avi_credentials (добавлено в 2.5) | Словарь учетных данных Avi, который может использоваться вместо перечисления данных входа в Avi контроллер. | |
| ca_certs | Список доверенных центров сертификации (корневых и промежуточных), используемых для проверки сертификатов. | |
| controller | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. |
| created_by | Имя создателя. | |
| crl_check bool |
| При включении Avi проверит с помощью проверок CRL, что сертификаты в цепочке доверия не были отозваны. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется Avi контроллером как True. |
| crls | Списки отозванных сертификатов. | |
| ignore_peer_chain bool |
| При включении Avi не будет доверять промежуточным и корневым сертификатам, представленным клиентом. Вместо этого для проверки доверия сертификата клиента будут использоваться только сертификаты цепочки, настроенные в разделе центра сертификации. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется Avi контроллером как False. |
| is_federated bool (добавлено в 2.4) |
| Этот параметр описывает область репликации объекта. Если параметр установлен в false, объект виден в кластере контроллера и его связанных сервисных узлах. Если параметр установлен в true, объект реплицируется по всей федерации. Параметр введен в версии 17.1.3. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется Avi контроллером как False. |
| name обязательно | Имя профиля pki. | |
| password | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. |
| state |
| Состояние, которое должно быть применено к сущности. |
| tenant | По умолчанию: "admin" | Имя арендатора, используемого для всех вызовов API Avi и контекста объекта. |
| tenant_ref | Ссылка на объект типа арендатор. | |
| tenant_uuid | По умолчанию: "" | UUID арендатора, используемого для всех вызовов API Avi и контекста объекта. |
| url | URL контроллера Avi для объекта. | |
| username | По умолчанию: "" | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. |
| uuid | Уникальный идентификатор объекта. | |
| validate_only_leaf_crl bool |
| При включении Avi будет проверять только статус отзыва лист-сертификата с помощью CRL. Для включения проверки всей цепочки отключите этот параметр и предоставьте все необходимые CRL. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется Avi контроллером как True. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.
Примеры
- name: Example to create PKIProfile object
avi_pkiprofile:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_pkiprofile
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| obj dict | успех, изменилось | Объект PKIProfile (api/pkiprofile) |
Статус
Этот модуль помечен как предварительный просмотр, что означает, что его интерфейс не гарантируется как обратной совместимости.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. Дополнительную информацию см. в разделе Техническое обслуживание модулей и поддержка.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Gaurav Rastogi (grastogi@avinetworks.com)
Подсказка
Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/avi_pkiprofile_module.html
