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

Примечание

Этот модуль является частью коллекции f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. Требования.

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_ssl_certificate.

Новая функция в f5networks.f5_modules 1.0.0

Описание
Требования
Параметры
Примечания
Примеры
Значения возврата

Описание

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

Требования

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

BIG-IP >= v12

Параметры

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

Примечания

Примечание

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

Авторы

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

Ссылки на коллекцию

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