community.network.avi_sslkeyandcertificate – Модуль для настройки SSLKeyAndCertificate Avi RESTful объекта
Примечание
Этот плагин входит в сборку community.network (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.network.
Чтобы использовать его в книге задач, укажите: community.network.avi_sslkeyandcertificate.
Обзор
- Этот модуль используется для конфигурации объекта SSLKeyAndCertificate
- Дополнительные примеры на https://github.com/avinetworks/devops
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- avisdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| api_context словарь | Контекст API Avi, включающий текущий идентификатор сессии и маркер CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия API Avi для использования с Avi API и объектами. | |
| avi_api_patch_op строка |
| Операция обновления для использования при использовании avi_api_update_method как patch. | |
| avi_api_update_method строка |
| Метод обновления объекта по умолчанию — HTTP PUT. Установка в patch изменит это поведение на использование HTTP PATCH. | |
| avi_credentials словарь | Словарь Avi Credentials, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version строка | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller строка | IP-адрес или SQDN контроллера | ||
| csrftoken строка | Маркер csrftoken API контроллера Avi для повторного использования существующей сессии с идентификатором сессии | ||
| password строка | Пароль контроллера Avi | ||
| port строка | Порт контроллера Avi | ||
| session_id строка | Идентификатор сессии API контроллера Avi для повторного использования существующей сессии с csrftoken | ||
| tenant строка | По умолчанию: "admin" | Тенент контроллера Avi | |
| tenant_uuid строка | UUID тенента контроллера Avi | ||
| timeout строка | По умолчанию: 300 | Таймаут запроса контроллера Avi | |
| token строка | Токен API контроллера Avi | ||
| username строка | Имя пользователя контроллера Avi | ||
| avi_disable_session_cache_as_fact булево |
| Отключает кеширование информации о сессии avi в качестве факта. | |
| ca_certs строка | Сертификаты CA в цепочке сертификатов. | ||
| certificate строка / обязательно | Настройки sslcertificate для sslkeyandcertificate. | ||
| certificate_base64 булево |
| Указывает, закодирован ли сертификат в base64. Поле введено в 18.1.2, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как Ложь. | |
| certificate_management_profile_ref строка | Ссылка на объект типа certificatemanagementprofile. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| created_by строка | Имя создателя. | ||
| dynamic_params строка | Динамические параметры, необходимые для профиля управления сертификатами. | ||
| enckey_base64 строка | Зашифрованный приватный ключ, соответствующий приватному ключу (например, Сгенерированные средствами HSM, такими как Thales nShield). | ||
| enckey_name строка | Имя зашифрованного приватного ключа (например, Сгенерированные средствами HSM, такими как Thales nShield). | ||
| format строка | Формат файла ключа/сертификата. Варианты перечисления — SSL_PEM, SSL_PKCS12. Поле введено в 18.1.2, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как SSL_PEM. | ||
| hardwaresecuritymodulegroup_ref строка | Ссылка на объект типа hardwaresecuritymodulegroup. | ||
| key строка | Приватный ключ. | ||
| key_base64 булево |
| Указывает, закодирован ли приватный ключ в base64. Поле введено в 18.1.2, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как Ложь. | |
| key_params строка | Настройки sslkeyparams для sslkeyandcertificate. | ||
| key_passphrase строка | Пароль, используемый для шифрования приватного ключа. Поле введено в 18.1.2, 18.2.1. | ||
| 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. | ||
| url строка | URL контроллера Avi объекта. | ||
| username строка | По умолчанию: "" | Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная среды AVI_USERNAME. | |
| uuid строка | Уникальный идентификатор объекта. | ||
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице 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) <grastogi@avinetworks.com>
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/avi_sslkeyandcertificate_module.html
