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, используемая для API Avi и объектов. |
| avi_api_patch_op - добавлен в 2.5 |
| Операция исправления, используемая при использовании avi_api_update_method в качестве исправления. |
| avi_api_update_method - добавлен в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установив значение в patch, вы переопределите это поведение, чтобы использовать HTTP PATCH. |
| avi_credentials словарь добавлен в 2.5 | Словарь Avi Credentials, который может использоваться вместо перечисления данных входа в Avi Controller. | |
| ca_certs - | Список уполномоченных центров сертификации (корневой и промежуточный), используемых для проверки сертификатов. | |
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. |
| created_by - | Имя создателя. | |
| crl_check булево |
| При включении Avi проверит, используя проверки CRL, не были ли сертификаты в цепочке доверия отозваны. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется Avi Controller как True. |
| crls - | Списки отозванных сертификатов. | |
| ignore_peer_chain булево |
| При включении Avi не будет доверять промежуточным и корневым сертификатам, представленным клиентом. Вместо этого будут использованы только сертификаты цепочки, настроенные в разделе центра сертификации, для проверки доверия к сертификату клиента. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется Avi Controller как False. |
| is_federated булево добавлен в 2.4 |
| Это поле описывает область репликации объекта. Если поле установлено в false, объект виден в кластере контроллера и его связанных службах-движках. Если поле установлено в true, объект реплицируется по всей федерации. Поле введено в 17.1.3. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется Avi Controller как 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 булево |
| При включении Avi будет проверять статус отозвания только листового сертификата с помощью CRL. Чтобы включить проверку для всей цепочки, отключите этот параметр и укажите все соответствующие CRL. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется Avi Controller как 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) |
Статус
- Гарантии обратной совместимости интерфейса этого модуля нет. [preview]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Gaurav Rastogi (@grastogi23) <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.8/modules/avi_pkiprofile_module.html
