bigip_ssl_certificate – Импорт/удаление сертификатов с BIG-IP
Новая версия 2.2.
Краткое описание
- Этот модуль будет импортировать/удалять SSL-сертификаты на BIG-IP LTM. Сертификаты можно импортировать из файлов сертификата и ключа на локальном диске в формате PEM.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- BIG-IP >= v12
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| content - | Устанавливает содержимое сертификата напрямую в указанное значение. Используется с плагинами поиска или для чего-либо с форматированием или content должно быть указано, когда state равно present.Псевдонимы: cert_content | ||
| issuer_cert - Добавлен в 2.5 | Сертификат издателя, используемый для мониторинга OCSP. Этот параметр действителен только для версий BIG-IP 13.0.0 и выше. | ||
| name - / обязательно | Имя SSL-сертификата. Это имя сертификата, используемое при импорте сертификата в F5. Оно также определяет имена файлов объектов на LTM. | ||
| partition - Добавлен в 2.5 | По умолчанию: "Общие" | Раздел устройства для управления ресурсами. | |
| password - / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную окружения F5_PASSWORD.Псевдонимы: pass, pwd | ||
| provider - Добавлен в 2.5 | По умолчанию: null | Объект словаря, содержащий сведения о подключении. | |
| 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 boolean |
| Если 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 boolean Добавлен в 2.0 |
| Если no, SSL-сертификаты не будут проверены. Используйте это только на сайтах, контролируемых лично, с самозаверяющимися сертификатами.Вы можете опустить этот параметр, установив переменную окружения F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Этот модуль ведет себя не так, как другие модули, которые вы можете включить в роли, где ссылка на файлы или шаблоны сначала ищет файлы или шаблоны роли. Чтобы заставить его вести себя таким образом, используйте поиск файлов или шаблонов Ansible (см. Примеры). Поисковые запросы ведут себя ожидаемо в контексте роли.
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
- Требуется пакет Python f5-sdk на хосте. Это так же просто, как
pip install f5-sdk. - Требуется версия ПО BIG-IP >= 12.
- Модули F5 манипулируют только рабочей конфигурацией продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохраняется на диске, обязательно включите хотя бы одну задачу, которая использует модуль bigip_config для сохранения рабочей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения рабочей конфигурации.
Примеры
- 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
content: "{{ lookup('file', '/path/to/cert.crt') }}"
delegate_to: localhost
- name: Use a file lookup to import CA certificate chain
bigip_ssl_certificate:
name: ca-chain-name
server: lb.mydomain.com
user: admin
password: secret
state: present
content: "{{ lookup('file', '/path/to/ca-chain.crt') }}"
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_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)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/bigip_ssl_certificate_module.html
