f5networks.f5_modules.bigip_ssl_key модуль — Импорт/удаление ключей SSL с BIG-IP

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: 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	Объект словаря, содержащий данные подключения.
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`

Примечания

Примечание

Этот модуль ведет себя не так, как другие модули, которые вы можете включить в роли, где ссылка на файлы или шаблоны в первую очередь ищет их в каталоге файлов или шаблонов роли. Чтобы модуль вел себя таким образом, используйте поиск Ansible file или template (см. Примеры). Эти поиски ведут себя ожидаемо в контексте роли.
Дополнительную информацию об использовании 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 ключа. Возвращается: changed и created Пример: `"cf23df2207d99a74fbe169e3eba035e633b65d94"`
key_filename строка	Имя ключа SSL-сертификата. `key_filename` и `cert_filename` будут похожи друг на друга, однако `key_filename` будет иметь расширение `.key`. Возвращается: created Пример: `"cert1.key"`
key_source_path строка	Путь на BIG-IP, где хранится исходный ключ. Возвращается: created Пример: `"/var/config/rest/downloads/cert1.key"`

Авторы

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