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, который можно использовать вместо перечисления данных входа в контроллер 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	Варианты: отсутствует наличие ←	Состояние, которое должно быть применено к сущности.
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 словарь	успех, изменилось	SSLKeyAndCertificate (api/sslkeyandcertificate) объект

Статус

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

Обслуживание

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

Список других модулей, которые также поддерживаются сообществом Ansible, см. в здесь.

Автор

Гаурав Растоги (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_sslkeyandcertificate_module.html