Spec-Zone.ru › Ansible

Модуль f5networks.f5_modules.bigip_ssl_key_cert — импорт/удаление ключей и сертификатов SSL из 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_key_cert.

Добавлено в f5networks.f5_modules 1.6.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры

Краткое описание

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

Параметры

Параметр

Комментарии

cert_content

string

Задаёт содержимое сертификата напрямую указанным значением. Используется с плагинами поиска или в случаях, когда требуется форматирование либо

content необходимо указать, если state имеет значение present.

cert_name

string

Имя сертификата SSL. Это имя сертификата, используемое при импорте сертификата в BIG-IP. Оно также определяет имена файлов объектов в LTM.

issuer_cert

string

Сертификат издателя, используемый для мониторинга OCSP.

Этот параметр действителен только для версий BIG-IP 13.0.0 и выше.

key_content

string

Задаёт содержимое ключа напрямую указанным значением. Используется с плагинами поиска или в случаях, когда требуется форматирование или обработка шаблонов. Это необходимо указать, если state имеет значение present.

key_name

string

Имя ключа.

partition

string

Раздел устройства, в котором будут управляться ресурсы.

По умолчанию: "Common"

passphrase

string

Парольная фраза ключа.

provider

dictionary

добавлено в f5networks.f5_modules 1.0.0

Объект dict, содержащий сведения для подключения.

auth_provider

string

Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства.

Этот параметр используется преимущественно при работе с устройствами BIG-IQ.

no_f5_teem

boolean

Если yes, телеметрические данные TEEM не отправляются в F5.

Этот параметр можно не указывать, задав переменную окружения F5_TELEMETRY_OFF.

Ранее использовавшаяся переменная F5_TEEM объявлена устаревшей, так как её название вводило в заблуждение.

Возможные значения:

  • false ← (по умолчанию)
  • true

password

псевдонимы: pass, pwd

string / обязательный

Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную окружения F5_PASSWORD.

server

string / обязательный

Имя хоста BIG-IP или BIG-IQ.

Этот параметр можно не указывать, задав переменную окружения F5_SERVER.

server_port

integer

Порт сервера BIG-IP.

Этот параметр можно не указывать, задав переменную окружения F5_SERVER_PORT.

По умолчанию: 443

timeout

integer

Задаёт время ожидания в секундах при обмене данными с сетевым устройством: для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль завершится с ошибкой.

transport

string

Настраивает транспортное подключение для соединения с удалённым устройством.

Возможные значения:

  • "rest" ← (по умолчанию)

user

string / обязательный

Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве.

Этот параметр можно не указывать, задав переменную окружения F5_USER.

validate_certs

boolean

Если no, сертификаты SSL не проверяются. Используйте этот параметр только на сайтах, находящихся под вашим контролем и использующих самоподписанные сертификаты.

Этот параметр можно не указывать, задав переменную окружения F5_VALIDATE_CERTS.

Возможные значения:

  • false
  • true ← (по умолчанию)

state

string

Если present, обеспечивает загрузку ключа и/или сертификата на устройство. Если absent, обеспечивает удаление ключа и/или сертификата с устройства. Если ключ и/или сертификат используются, модуль не сможет удалить ключ.

Возможные значения:

  • "present" ← (по умолчанию)
  • "absent"

true_names

boolean

добавлено в f5networks.f5_modules 1.24.0

Если true, модуль не добавляет расширения .crt и .key к указанным именам сертификатов и ключей.

Если false, модуль добавляет расширения .crt и .key к указанным именам сертификатов и ключей.

Возможные значения:

  • false ← (по умолчанию)
  • true

Примечания

Примечание

  • Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
  • Требуется BIG-IP версии >= 12.
  • Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы сохранить специфичную для BIG-IP конфигурацию на диск, обязательно добавьте хотя бы одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Правильный способ сохранения текущей конфигурации описан в документации модуля.

Примеры

- name: Import both key and cert
  bigip_ssl_key_cert:
    key_content: "{{ lookup('file', 'key.pem') }}"
    key_name: cert1
    cert_content: "{{ lookup('file', 'cert.pem') }}"
    cert_name: cert1
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Авторы

  • Nitin Khanna (@nitinthewiz)

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

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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_key_cert_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API