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

Примечание

Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).

Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в книге задач укажите: f5networks.f5_modules.bigip_ssl_key.

Новое в версии 1.0.0: из f5networks.f5_modules

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Требования

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

BIG-IP >= v12

Параметры

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

Примечания

Примечание

Этот модуль ведет себя не так, как другие модули, которые вы можете включить в роли, где ссылка на файлы или шаблоны сначала ищет в каталоге файлов или шаблонов роли. Чтобы заставить его вести себя таким образом, используйте поиск 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_ssl_key_module.html