bigip_ssl_certificate - Импорт/удаление сертификатов с BIG-IP.
Новое в версии 2.2.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Значения возврата
- Примечания
Обзор
- Этот модуль импортирует/удаляет SSL-сертификаты на BIG-IP LTM. Сертификаты могут быть импортированы из файлов сертификата и ключа на локальном диске в формате PEM.
Требования (к хосту, на котором выполняется модуль)
- f5-sdk >= 1.5.0
- BIG-IP >= v12
Параметры
| параметр | обязателен | по умолчанию | значения | примечания |
|---|---|---|---|---|
| cert_content | нет | При использовании вместо 'cert_src', устанавливает содержимое сертификата напрямую в указанное значение. Используется с плагинами поиска или для чего-либо с форматированием или шаблонами. Когда state имеет значение present, необходимо указать одно из key_src, key_content, cert_src или cert_content. | ||
| cert_src | нет | Это имя локального файла сертификата. Когда state имеет значение present, необходимо указать одно из key_src, key_content, cert_src или cert_content. | ||
| key_content | нет | При использовании вместо 'key_src', устанавливает содержимое ключа сертификата напрямую в указанное значение. Используется с плагинами поиска или для чего-либо с форматированием или шаблонами. Когда state имеет значение present, необходимо указать одно из key_src, key_content, cert_src или cert_content. | ||
| key_src | нет | Это имя локального файла приватного ключа. Когда state имеет значение present, необходимо указать одно из key_src, key_content, cert_src или cert_content. | ||
| name | да | Имя SSL-сертификата. Это имя пары cert/key, используемой при импорте сертификата/ключа в F5. Оно также определяет имена объектов на LTM (:Partition:name.cer_11111_1 и :Partition_name.key_11111_1). | ||
| passphrase | нет | Пароль к приватным ключам сертификата | ||
| password | да | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, если переменная окружения F5_PASSWORD установлена. | ||
| server | да | Хост BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER установлена. | ||
| server_port (добавлен в 2.2)
| нет | 443 | Порт сервера BIG-IP. Этот параметр можно опустить, если переменная окружения F5_SERVER_PORT установлена. | |
| state | нет | present |
| Состояние сертификата и ключа. Это определяет, будет ли предоставленный сертификат и ключ present на устройстве или absent. |
| user | да | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Этот параметр можно опустить, если переменная окружения F5_USER установлена. | ||
| validate_certs (добавлен в 2.0)
| нет | True |
| Если no, SSL-сертификаты не будут проверены. Это следует использовать только на контролируемых вами сайтах, использующих самозаверяющие сертификаты. Этот параметр можно опустить, если переменная окружения F5_VALIDATE_CERTS установлена. |
Примеры
- name: Import PEM Certificate from local disk
bigip_ssl_certificate:
name: "certificate-name"
server: "lb.mydomain.com"
user: "admin"
password: "secret"
state: "present"
cert_src: "/path/to/cert.crt"
key_src: "/path/to/key.key"
delegate_to: localhost
- name: Use a file lookup to import PEM Certificate
bigip_ssl_certificate:
name: "certificate-name"
server: "lb.mydomain.com"
user: "admin"
password: "secret"
state: "present"
cert_content: "{{ lookup('file', '/path/to/cert.crt') }}"
key_content: "{{ lookup('file', '/path/to/key.key') }}"
delegate_to: localhost
- name: "Delete Certificate"
bigip_ssl_certificate:
name: "certificate-name"
server: "lb.mydomain.com"
user: "admin"
password: "secret"
state: "absent"
delegate_to: localhost
Значения возврата
Общие значения возврата описаны здесь Значения возврата, следующие поля уникальны для данного модуля:
| имя | описание | возвращается | тип | пример |
|---|---|---|---|---|
| cert_checksum | SHA1 контрольная сумма предоставленного сертификата. | изменено и создано | строка | f7ff9e8b7bb2e09b70935a5d785e0cc5d9d0abf0 |
| cert_filename | Имя SSL-сертификата. cert_filename и key_filename будут похожи, но cert_filename будет иметь расширение .crt. | создано | строка | cert1.crt |
| cert_name | Имя сертификата, предоставленного пользователем. | создано | строка | cert1 |
| cert_source_path | Путь на BIG-IP, где хранится исходный сертификат. | создано | строка | /var/config/rest/downloads/cert1.crt |
| key_checksum | SHA1 контрольная сумма предоставленного ключа. | изменено и создано | строка | cf23df2207d99a74fbe169e3eba035e633b65d94 |
| key_filename | Имя SSL-ключа сертификата. key_filename и cert_filename будут похожи, но key_filename будет иметь расширение .key. | создано | строка | cert1.key |
| key_source_path | Путь на BIG-IP, где хранится исходный ключ. | создано | строка | /var/config/rest/downloads/cert1.key |
Примечания
Примечание
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.
- Этот модуль не ведет себя как другие модули, которые вы можете включить в роли, где ссылка на файлы или шаблоны сначала ищет файлы или шаблоны роли. Чтобы он вел себя таким образом, используйте поиск файлов или шаблонов Ansible (см. Примеры). Поиск работает как ожидается в контексте роли.
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для получения помощи в разработке модулей, если вы захотите, пожалуйста, прочтите Информация о сообществе и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/bigip_ssl_certificate_module.html
