Модуль f5networks.f5_modules.bigip_ssl_key — импорт/удаление ключей 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.

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

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

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

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

Требования

На узле, выполняющем этот модуль, требуются следующие компоненты.

BIG-IP >= v12

Параметры

Параметр	Комментарии
content псевдонимы: key_content строка	Задает содержимое ключа непосредственно указанным значением. Используется с модулями поиска или для содержимого с форматированием либо шаблонизацией. Значение необходимо указать, если `state` равно `present`.
name строка / обязательный	Имя ключа.
partition строка	Раздел устройства, в котором будут управляться ресурсы. По умолчанию: `"Common"`
passphrase строка	Парольная фраза ключа.
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`, модуль не добавляет расширение `.key` к указанному имени ключа. Если значение равно `false`, модуль добавляет расширение `.key` к указанному имени ключа. Возможные значения: `false` ← (по умолчанию) `true`

Примечания

Примечание

Этот модуль работает не так, как другие модули, которые можно включать в роли: при указании файлов или шаблонов сначала выполняется поиск в каталогах files или templates роли. Чтобы модуль работал таким образом, используйте поиск файла или шаблона 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 key
  bigip_ssl_key:
    name: key-name
    state: present
    content: "{{ lookup('file', '/path/to/key.key') }}"
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Delete key
  bigip_ssl_key:
    name: key-name
    state: absent
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
key_checksum строка	Контрольная сумма ключа SHA1. Возвращается: если состояние изменено и ключ создан Пример: `"cf23df2207d99a74fbe169e3eba035e633b65d94"`
key_filename строка	Имя ключа сертификата SSL. Значения `key_filename` и `cert_filename` будут похожи, однако у значения `key_filename` будет расширение `.key`. Возвращается: если ключ создан Пример: `"cert1.key"`
key_source_path строка	Путь на BIG-IP, по которому хранится исходный ключ. Возвращается: если ключ создан Пример: `"/var/config/rest/downloads/cert1.key"`

Авторы

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_key_module.html