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

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

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

Обзор

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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом 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_sslkeyandcertificate_module.html