avi_sslkeyandcertificate - Модуль для настройки объекта SSLKeyAndCertificate Avi RESTful

Новый в версии 2.3.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

Этот модуль используется для конфигурации объекта SSLKeyAndCertificate
Дополнительные примеры см. на странице 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)	Варианты: add replace delete	Операция обновления для использования при использовании avi_api_update_method как patch.
avi_api_update_method (добавлен в 2.5)	Варианты: put ← patch	Метод по умолчанию для обновления объекта - HTTP PUT. Установка на patch переопределит это поведение, чтобы использовать HTTP PATCH.
avi_credentials (добавлен в 2.5)		Словарь Avi Credentials, который может использоваться вместо перечисления данных входа в Avi контроллер.
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	Варианты: absent present ←	Состояние, которое должно быть применено к сущности.
status		Варианты перечисления - ssl_certificate_finished, ssl_certificate_pending. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как SSL_CERTIFICATE_FINISHED.
tenant	Значение по умолчанию: admin	Имя клиента, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref		Ссылка на объект типа tenant.
tenant_uuid	Значение по умолчанию:	UUID клиента, используемого для всех вызовов API Avi и контекста объекта.
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		Уникальный идентификатор объекта.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- 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 dict	успешно, изменилось	Объект SSLKeyAndCertificate (api/sslkeyandcertificate)

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.

Автор

Гaurav 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.5/modules/avi_sslkeyandcertificate_module.html