avi_sslkeyandcertificate – Модуль для настройки SSLKeyAndCertificate Avi RESTful объекта
Описание
- Этот модуль используется для настройки объекта 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 |
| Операция обновления для использования при использовании avi_api_update_method в качестве обновления. | |
| avi_api_update_method - добавлен в 2.5 |
| Метод по умолчанию для обновления объекта — HTTP PUT. Установка на patch переопределит это поведение, чтобы использовать HTTP PATCH. | |
| avi_credentials словарь добавлен в 2.5 | Словарь учетных данных Avi, который можно использовать вместо перечисления данных входа в контроллер Avi. | ||
| api_version - | По умолчанию: "16.4.4" | Версия контроллера Avi | |
| controller - | IP-адрес или SQDN контроллера Avi | ||
| csrftoken - | Маркер csrf 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 булево добавлен в 2.6 |
| Отключает кэширование информации о сессии Avi в качестве факта. | |
| ca_certs - | Сертификаты CA в цепочке сертификатов. | ||
| certificate - / обязательно | Настройки sslcertificate для sslkeyandcertificate. | ||
| certificate_base64 булево добавлен в 2.9 |
| Указывает, закодирован ли сертификат в base64. Поле введено в 18.1.2, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| certificate_management_profile_ref - | Это ссылка на объект типа certificatemanagementprofile. | ||
| controller строка | По умолчанию: "" | IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды AVI_CONTROLLER. | |
| created_by - | Имя создателя. | ||
| dynamic_params - | Динамические параметры, необходимые для профиля управления сертификатами. | ||
| enckey_base64 - | Зашифрованный закрытый ключ, соответствующий закрытому ключу (например, те, которые сгенерированы HSM, например, Thales nShield). | ||
| enckey_name - | Имя зашифрованного закрытого ключа (например, те, которые сгенерированы HSM, например, Thales nShield). | ||
| format - добавлен в 2.9 | Формат файла ключа/сертификата. Варианты перечисления — SSL_PEM, SSL_PKCS12. Поле введено в 18.1.2, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как SSL_PEM. | ||
| hardwaresecuritymodulegroup_ref - | Это ссылка на объект типа hardwaresecuritymodulegroup. | ||
| key - | Закрытый ключ. | ||
| key_base64 булево добавлен в 2.9 |
| Указывает, закодирован ли закрытый ключ в base64. Поле введено в 18.1.2, 18.2.1. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. | |
| key_params - | Настройки sslkeyparams для sslkeyandcertificate. | ||
| key_passphrase - добавлен в 2.9 | Пароль, используемый для шифрования закрытого ключа. Поле введено в 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 string | По умолчанию: "" | Имя пользователя, используемое для доступа к контроллеру 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. [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.9/modules/avi_sslkeyandcertificate_module.html
