bigip_ssl_certificate - Импорт/удаление сертификатов с BIG-IP
Новое в версии 2.2.
Обзор
- Этот модуль импортирует/удаляет SSL-сертификаты на BIG-IP LTM. Сертификаты могут быть импортированы из файлов сертификата и ключа на локальном диске в формате PEM.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- BIG-IP >= v12
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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) | По умолчанию: None | Объект словаря, содержащий сведения о подключении. | |
| ssh_keyfile | Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортных средств cli. Если значение не указано в задаче, вместо него будет использовано значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout | По умолчанию: 10 | Устанавливает тайм-аут в секундах для связи с сетевым устройством для подключения или отправки команд. Если тайм-аут превышен до завершения операции, модуль выдаст ошибку. | |
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена. | ||
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена. | |
| password обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| validate_certs |
| Если no, SSL-сертификаты не будут проверены. Используйте только на сайтах, контролируемых лично, с использованием самозаверенных сертификатов. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена. | |
| transport обязательно |
| Настраивает транспортное подключение для использования при подключении к удаленному устройству. | |
| 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 файлов или шаблонов (см. примеры). Поиск ведет себя как ожидается в контексте роли.
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на сайте https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- 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 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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.5/modules/bigip_ssl_certificate_module.html
