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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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	Объект dict, содержащий сведения для подключения.
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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_ssl_certificate_module.html