avi_sslkeyandcertificate - Модуль для настройки SSLKeyAndCertificate Avi RESTful объекта
Новый в версии 2.3.
- Описание
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
Описание
- Этот модуль используется для настройки объекта SSLKeyAndCertificate
- Дополнительные примеры см. на https://github.com/avinetworks/devops
Требования (к хосту, на котором выполняется модуль)
- avisdk
Параметры
| параметр | обязателен | по умолчанию | значения | комментарии |
|---|---|---|---|---|
| api_version | нет | Версия Avi API для использования с Avi API и объектами. | ||
| ca_certs | нет | Сертификаты CA в цепочке сертификатов. | ||
| certificate | да | Настройки sslcertificate для sslkeyandcertificate. | ||
| certificate_management_profile_ref | нет | Ссылка на объект типа certificatemanagementprofile. | ||
| controller | нет | IP-адрес или имя хоста контроллера. Значение по умолчанию - переменная окружения AVI_CONTROLLER. | ||
| created_by | нет | Имя создателя. | ||
| dynamic_params | нет | Динамические параметры, необходимые для профиля управления сертификатами. | ||
| enckey_base64 | нет | Зашифрованный закрытый ключ, соответствующий закрытому ключу (например, те, что сгенерированы HSM, например, Thales nShield). | ||
| enckey_name | нет | Имя зашифрованного закрытого ключа (например, те, что сгенерированы HSM, например, Thales nShield). | ||
| hardwaresecuritymodulegroup_ref | нет | Ссылка на объект типа hardwaresecuritymodulegroup. | ||
| key | нет | Закрытый ключ. | ||
| key_params | нет | Настройки sslkeyparams для sslkeyandcertificate. | ||
| name | да | Имя объекта. | ||
| password | нет | Пароль пользователя Avi в контроллере Avi. Значение по умолчанию - переменная окружения AVI_PASSWORD. | ||
| state | нет | present |
| Состояние, которое должно быть применено к сущности. |
| status | нет | Варианты перечисления - ssl_certificate_finished, ssl_certificate_pending. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как SSL_CERTIFICATE_FINISHED. | ||
| tenant | нет | admin | Имя арендатора, используемое для всех вызовов Avi API и контекста объекта. | |
| tenant_ref | нет | Ссылка на объект типа tenant. | ||
| tenant_uuid | нет | UUID арендатора, используемого для всех вызовов Avi API и контекста объекта. | ||
| type | нет | Варианты перечисления - ssl_certificate_type_virtualservice, ssl_certificate_type_system, ssl_certificate_type_ca. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как SSL_CERTIFICATE_TYPE_VIRTUALSERVICE. | ||
| url | нет | URL контроллера Avi объекта. | ||
| username | нет | Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию - переменная окружения AVI_USERNAME. | ||
| uuid | нет | Уникальный идентификатор объекта. |
Примеры
- name: Create a SSL Key and Certificate
avi_sslkeyandcertificate:
controller: 10.10.27.90
username: admin
password: AviNetworks123!
key: |
-----BEGIN PRIVATE KEY-----
....
-----END PRIVATE KEY-----
certificate:
self_signed: true
certificate: |
-----BEGIN CERTIFICATE-----
....
-----END CERTIFICATE-----
type: SSL_CERTIFICATE_TYPE_VIRTUALSERVICE
name: MyTestCert
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие поля уникальны для этого модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| obj | Объект SSLKeyAndCertificate (api/sslkeyandcertificate) | успех, изменение | 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_sslkeyandcertificate_module.html