bigip_ssl_certificate – Импорт/Удаление сертификатов с BIG-IP
Новое в версии 2.2.
Описание
- Этот модуль импортирует/удаляет SSL-сертификаты на BIG-IP LTM. Сертификаты могут быть импортированы из файлов сертификата и ключа на локальном диске в формате PEM.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- BIG-IP >= v12
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| content строка | Устанавливает содержимое сертификата непосредственно в указанное значение. Используется с плагинами поиска или для элементов с форматированием или content должен быть предоставлен, когда state является present.псевдонимы: cert_content | ||
| issuer_cert строка добавлен в 2.5 | Сертификат издателя, используемый для мониторинга OCSP. Этот параметр действителен только для версий BIG-IP 13.0.0 и выше. | ||
| name строка / обязательно | Имя SSL-сертификата. Это имя сертификата, используемое при импорте сертификата в F5. Оно также определяет имена файлов объектов на LTM. | ||
| partition строка добавлен в 2.5 | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| password строка / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| provider словарь добавлен в 2.5 | Объект словаря, содержащий данные подключения. | ||
| password строка / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Вы можете опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | По умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. | |
| transport строка |
| Настраивает транспортное подключение для подключения к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логическое значение |
| Если no, SSL-сертификаты не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число добавлен в 2.2 | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| state строка |
| Состояние сертификата. Это определяет, будет ли предоставленный сертификат и ключ present на устройстве или absent. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логическое значение добавлен в 2.0 |
| Если no, SSL-сертификаты не проверяются. Используйте только на контролируемых вами сайтах с самозаверяющими сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Этот модуль не ведет себя как другие модули, которые вы можете включить в роли, где ссылка на файлы или шаблоны сначала ищет в директории файлов или шаблонов роли. Чтобы он вел себя таким образом, используйте поиск Ansible file или template (см. примеры). Поиск ведет себя ожидаемо в контексте роли.
- Для получения дополнительной информации об использовании Ansible для управления устройствами F5 Networks см. https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что специфическая конфигурация BIG-IP сохраняется на диске, обязательно включите хотя бы одну задачу, использующую модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- name: Use a file lookup to import PEM Certificate
bigip_ssl_certificate:
name: certificate-name
state: present
content: "{{ lookup('file', '/path/to/cert.crt') }}"
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Use a file lookup to import CA certificate chain
bigip_ssl_certificate:
name: ca-chain-name
state: present
content: "{{ lookup('file', '/path/to/ca-chain.crt') }}"
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
- name: Delete Certificate
bigip_ssl_certificate:
name: certificate-name
state: absent
provider:
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| cert_name строка | создано | Имя сертификата, предоставленного пользователем Пример: cert1 |
| checksum строка | изменено и создано | Значение SHA1 контрольной суммы предоставленного сертификата. Пример: f7ff9e8b7bb2e09b70935a5d785e0cc5d9d0abf0 |
| filename строка | создано | Имя сертификата SSL. Пример: cert1.crt |
| source_path строка | создано | Путь на BIG-IP, где хранится исходный сертификат. Пример: /var/config/rest/downloads/cert1.crt |
Статус
- Данный модуль гарантированно не будет содержать обратной несовместимости в будущих изменениях. [stableinterface]
- Этот модуль поддерживается партнёром Ansible. [certified]
Авторы
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/bigip_ssl_certificate_module.html
