avi_pkiprofile – Модуль для настройки PKIProfile Avi RESTful объекта
Новый в версии 2.3.
Краткое описание
- Этот модуль используется для конфигурации объекта PKIProfile
- больше примеров по адресу https://github.com/avinetworks/devops
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_context - добавлено в 2.5 | Контекст Avi API, включающий текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | |
| api_version - | По умолчанию: "16.4.4" | Версия Avi API для использования с 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 Credentials, который может быть использован вместо перечисления данных входа в Avi контроллер. | |
| ca_certs - | Список уполномоченных центров сертификации (корневые и промежуточные), используемых для проверки сертификатов. | |
| controller - | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. |
| created_by - | Имя создателя. | |
| crl_check boolean |
| При включенном значении, Avi проверит, используя проверки CRL, что сертификаты в цепочке доверия не были отозваны. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi контроллером как True. |
| crls - | Списки отозванных сертификатов. | |
| ignore_peer_chain boolean |
| При включенном значении, Avi не будет доверять промежуточным и корневым сертификатам, представленным клиентом. Вместо этого, будут использованы только сертификаты цепочки, настроенные в разделе центра сертификации, для проверки доверия к сертификату клиента. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi контроллером как False. |
| is_federated boolean добавлено в 2.4 |
| Это поле описывает область репликации объекта. Если поле установлено в false, объект виден внутри кластера контроллера и его связанных сервисных узлов. Если поле установлено в true, объект реплицируется по всей федерации. Поле добавлено в 17.1.3. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi контроллером как False. |
| name - / обязательно | Имя профиля pki. | |
| password - | По умолчанию: "" | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды AVI_PASSWORD. |
| state - |
| Состояние, которое должно быть применено к сущности. |
| tenant - | По умолчанию: "admin" | Имя клиента, используемого для всех вызовов Avi API и контекста объекта. |
| tenant_ref - | Ссылка на объект типа клиент. | |
| tenant_uuid - | По умолчанию: "" | UUID клиента, используемого для всех вызовов Avi API и контекста объекта. |
| url - | URL контроллера Avi объекта. | |
| username - | По умолчанию: "" | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. |
| uuid - | Уникальный идентификатор объекта. | |
| validate_only_leaf_crl boolean |
| При включенном значении Avi проверит только статус отзыва лиственного сертификата с помощью CRL. Для включения проверки всей цепочки отключите этот параметр и укажите все соответствующие CRL. Значение по умолчанию, если не указано в API или модуле, интерпретируется Avi контроллером как True. |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице 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 словарь | success, changed | Объект PKIProfile (api/pkiprofile) |
Статус
- Гарантируется, что этот модуль будет иметь обратную совместимость. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.7/modules/avi_pkiprofile_module.html
