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

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. Требования.

Для использования в книге задач укажите: community.network.avi_sslkeyandcertificate.

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

Описание

Этот модуль используется для настройки объекта SSLKeyAndCertificate.
Дополнительные примеры см. на https://github.com/avinetworks/devops

Псевдонимы: network.avi.avi_sslkeyandcertificate

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

avisdk

Параметры

Параметр	Комментарии
api_context словарь	Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию.
api_version строка	Версия API Avi для использования в Avi API и объектах. По умолчанию: `"16.4.4"`
avi_api_patch_op строка	Операция исправления, используемая при использовании avi_api_update_method как исправления. Варианты: `"add"` `"replace"` `"delete"`
avi_api_update_method строка	Метод по умолчанию для обновления объекта — HTTP PUT. Установка на исправление переопределит это поведение, чтобы использовать HTTP PATCH. Варианты: `"put"` ← (по умолчанию) `"patch"`
avi_credentials словарь	Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi.
api_version строка	Версия контроллера Avi По умолчанию: `"16.4.4"`
controller строка	IP-адрес или SQDN контроллера Avi
csrftoken строка	Маркер csrftoken API контроллера Avi для повторного использования существующей сессии с идентификатором сессии По умолчанию: `""`
password строка	Пароль контроллера Avi
port строка	Порт контроллера Avi
session_id строка	Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken По умолчанию: `""`
tenant строка	Тенет контроллера Avi По умолчанию: `"admin"`
tenant_uuid строка	UUID тенента контроллера Avi По умолчанию: `""`
timeout строка	Таймаут запроса контроллера Avi По умолчанию: `300`
token строка	Токен API контроллера Avi По умолчанию: `""`
username строка	Имя пользователя контроллера Avi
avi_disable_session_cache_as_fact булево	Отключает кеширование информации о сессии avi в качестве факта. Варианты: `false` ← (по умолчанию) `true`
ca_certs строка	Сертификаты CA в цепочке сертификатов.
certificate строка / обязательно	Настройки sslcertificate для sslkeyandcertificate.
certificate_base64 булево	Указывает, закодирован ли сертификат в base64. Поле добавлено в 18.1.2, 18.2.1. Значение по умолчанию, если оно не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты: `false` `true`
certificate_management_profile_ref строка	Ссылка на объект типа certificatemanagementprofile.

END_OF_DOCUMENT_MARKER

controller string	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения `AVI_CONTROLLER`.
created_by string	Имя создателя.
dynamic_params string	Динамические параметры, необходимые для профиля управления сертификатами.
enckey_base64 string	Зашифрованный закрытый ключ, соответствующий закрытому ключу (например, сгенерированные HSM, такими как Thales nShield).
enckey_name string	Имя зашифрованного закрытого ключа (например, сгенерированные HSM, такими как Thales nShield).
format string	Формат файла ключа/сертификата. Варианты перечисления - SSL_PEM, SSL_PKCS12. Поле добавлено в версиях 18.1.2, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как SSL_PEM.
hardwaresecuritymodulegroup_ref string	Это ссылка на объект типа hardwaresecuritymodulegroup.
key string	Закрытый ключ.
key_base64 boolean	Указывает, закодирован ли закрытый ключ в base64. Поле добавлено в версиях 18.1.2, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. Варианты: `false` `true`
key_params string	Параметры Sslkeyparams для sslkeyandcertificate.
key_passphrase string	Пароль, используемый для шифрования закрытого ключа. Поле добавлено в версиях 18.1.2, 18.2.1.
name string / required	Имя объекта.
password string	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная окружения `AVI_PASSWORD`.
state string	Состояние, которое должно быть применено к объекту. Варианты: `"absent"` `"present"` ← (по умолчанию)
status string	Варианты перечисления - ssl_certificate_finished, ssl_certificate_pending. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как SSL_CERTIFICATE_FINISHED.
tenant string	Имя арендатора, используемого для всех вызовов Avi API и контекста объекта. По умолчанию: `"admin"`
tenant_ref string	Это ссылка на объект типа tenant.
tenant_uuid string	UUID арендатора, используемого для всех вызовов Avi API и контекста объекта. По умолчанию: `""`
type string	Варианты перечисления - ssl_certificate_type_virtualservice, ssl_certificate_type_system, ssl_certificate_type_ca.
url string	URL контроллера Avi объекта.
username string	Имя пользователя, используемое для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения `AVI_USERNAME`.
uuid string	Уникальный идентификатор объекта.

Примечания

Примечание

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

Примеры

- name: Create a SSL Key and Certificate
  community.network.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) Возвращается: успех, изменение

Авторы

Gaurav Rastogi (@grastogi23)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/avi_sslkeyandcertificate_module.html