bigip_ssl_key – Импорт/удаление SSL-ключей с BIG-IP
Новое в версии 2.5.
Описание
- Этот модуль импортирует/удаляет SSL-ключи на BIG-IP. Ключи могут быть импортированы из файлов ключей на локальном диске в формате PEM.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- BIG-IP >= v12
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| content строка | Устанавливает содержимое ключа непосредственно в указанное значение. Используется с плагинами поиска или для чего-либо с форматированием или шаблонами. Это необходимо, когда state равно present. псевдонимы: key_content | ||
| name строка / обязательно | Имя ключа. | ||
| partition строка добавлен в 2.5 | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| passphrase строка | Пароль к ключу. | ||
| provider словарь добавлен в 2.5 | Объект словаря, содержащий данные подключения. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| password строка / обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER. | ||
| server_port целое число | Значение по умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную среды F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает файл SSH-ключа, который нужно использовать для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, установив переменную среды F5_USER. | ||
| validate_certs логическое значение |
| Если no, SSL-сертификаты не проверяются. Используйте только на контролируемых вами сайтах с самозаверенными сертификатами.Вы можете опустить этот параметр, установив переменную среды F5_VALIDATE_CERTS. | |
| state строка |
| Когда present, гарантирует загрузку ключа на устройство. Когда absent, гарантирует удаление ключа с устройства. Если ключ в настоящее время используется, модуль не сможет удалить ключ. | |
Примечания
Примечание
- Этот модуль не ведет себя как другие модули, которые вы можете включить в роли, где ссылка на файлы или шаблоны сначала ищет в директории файлов или шаблонов роли. Чтобы сделать его поведением таким образом, используйте Ansible поиск файла или шаблона (см. примеры). Поиски ведут себя ожидаемо в контексте роли.
- Для получения дополнительной информации об использовании Ansible для управления устройствами F5 Networks см. https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 только манипулируют текущей конфигурацией продукта F5. Чтобы убедиться, что специфичная для BIG-IP конфигурация сохранится на диске, обязательно включите хотя бы одну задачу, использующую модуль 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 строка | changed и created | SHA1 контрольная сумма ключа, который был предоставлен. Пример: cf23df2207d99a74fbe169e3eba035e633b65d94 |
| key_filename строка | created | Имя ключа SSL-сертификата. key_filename и cert_filename будут похожи друг на друга, но key_filename будет иметь расширение .key. Пример: cert1.key |
| key_source_path строка | created | Путь на BIG-IP, где хранится исходный ключ. Пример: /var/config/rest/downloads/cert1.key |
Статус
- Этот модуль гарантирует совместимость интерфейса с обратной совместимостью в дальнейшем. [stableinterface]
- Этот модуль поддерживается партнером Ansible. [certified]
Авторы
- 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.9/modules/bigip_ssl_key_module.html
