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 -	Варианты: absent 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 -		Уникальный идентификатор объекта.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Avi Network см. на странице 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 словарь	success, changed	SSLKeyAndCertificate (api/sslkeyandcertificate) объект

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

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_sslkeyandcertificate_module.html