f5networks.f5_modules.bigip_ssl_certificate – Импорт/удаление сертификатов с BIG-IP

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.7.1).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать его в playbook, укажите: f5networks.f5_modules.bigip_ssl_certificate.

Новое в версии 1.0.0: модуля f5networks.f5_modules

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль импортирует/удаляет SSL-сертификаты на BIG-IP LTM. Сертификаты могут быть импортированы из файлов сертификата и ключа на локальном диске в формате PEM.

Требования

Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.

BIG-IP >= v12

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
content строка			Устанавливает содержимое сертификата непосредственно в указанное значение. Используется с плагинами поиска или для чего-либо с форматированием, или `content` должен быть предоставлен, когда `state` равен `present`. Псевдонимы: cert_content
issuer_cert строка			Сертификат издателя, используемый для мониторинга OCSP. Этот параметр действителен только в версиях BIG-IP 13.0.0 и выше.
name строка / обязательный			Имя SSL-сертификата. Это имя сертификата, используемое при импорте сертификата в BIG-IP. Оно также определяет имена файлов объектов на LTM.
partition строка		Значение по умолчанию: "Common"	Раздел устройства для управления ресурсами.
provider словарь добавлен в 1.0.0 f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется при работе с устройствами BIG-IQ.
	no_f5_teem логическое	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную окружения `F5_TEEM`.
	password строка / обязательный		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`. Псевдонимы: pass, pwd
	server строка / обязательный		Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_SERVER_PORT`.
	timeout целое число		Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное соединение для использования при подключении к удаленному устройству.
	user строка / обязательный		Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды `F5_USER`.
	validate_certs логическое	Варианты: no yes ←	Если `no`, SSL-сертификаты не будут валидироваться. Используйте это только на контролируемых вами сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, установив переменную среды `F5_VALIDATE_CERTS`.
state строка		Варианты: present ← absent	Состояние сертификата. Это определяет, будет ли предоставленный сертификат и ключ `present` на устройстве или `absent`.

Примечания

Примечание

Этот модуль ведет себя не так, как другие модули, которые вы можете включить в роли, где ссылка на файлы или шаблоны сначала ищет файлы или шаблоны в каталоге роли. Чтобы заставить его вести себя таким образом, используйте поиск Ansible по файлам или шаблонам (см. Примеры). Поиск ведёт себя так, как ожидается, в контексте роли.
Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 манипулируют только активной конфигурацией продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохраняется на диске, убедитесь, что включен хотя бы один task, использующий модуль f5networks.f5_modules.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 строка	created	Имя сертификата. Пример: cert1
checksum строка	changed and created	SHA1 контрольная сумма сертификата. Пример: f7ff9e8b7bb2e09b70935a5d785e0cc5d9d0abf0
filename строка	created	Имя SSL-сертификата. Пример: cert1.crt
source_path строка	created	Путь на BIG-IP, где хранится исходный сертификат. Пример: /var/config/rest/downloads/cert1.crt

Авторы

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/f5networks/f5_modules/bigip_ssl_certificate_module.html