bigip_ssl_key - Импорт/удаление ключей SSL с BIG-IP
Новая в версии 2.5.
Описание
- Этот модуль импортирует/удаляет ключи SSL на BIG-IP. Ключи могут быть импортированы из файлов ключей на локальном диске в формате PEM.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- BIG-IP >= v12
- f5-sdk >= 3.0.9
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| content | Устанавливает содержимое ключа напрямую в указанное значение. Используется с плагинами поиска или для чего-либо с форматированием или шаблонированием. Это обязательно, когда state является present. псевдонимы: key_content | ||
| name обязательно | Имя ключа. | ||
| partition (добавлено в 2.5) | По умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| passphrase | Пароль к ключу. | ||
| password обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| provider (добавлено в 2.5) | Объект словаря, содержащий данные подключения. | ||
| password обязательно | Пароль учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_PASSWORD установлена.псевдонимы: pass, pwd | ||
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена. | ||
| server_port | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена. | ||
| validate_certs bool |
| Если no, сертификаты SSL не будут проверены. Используйте это только на сайтах, контролируемых лично, с самозаверенными сертификатами. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена. | |
| timeout | По умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль вернёт ошибку. | |
| ssh_keyfile | Указывает файл SSH-ключа для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| transport обязательно |
| Настраивает транспортное соединение для использования при подключении к удалённому устройству. | |
| server обязательно | Хост BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER установлена. | ||
| server_port (добавлено в 2.2) | По умолчанию: 443 | Порт сервера BIG-IP. Вы можете опустить этот параметр, если переменная среды F5_SERVER_PORT установлена. | |
| state |
| При значении present, гарантирует, что ключ загружен на устройство. При значении absent, гарантирует удаление ключа с устройства. Если ключ используется, модуль не сможет удалить ключ. | |
| user обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Вы можете опустить этот параметр, если переменная среды F5_USER установлена. | ||
| validate_certs bool (добавлено в 2.0) |
| Если no, сертификаты SSL не будут проверены. Используйте это только на сайтах, контролируемых лично, с самозаверенными сертификатами. Вы можете опустить этот параметр, если переменная среды F5_VALIDATE_CERTS установлена. | |
Примечания
Примечание
- Этот модуль не ведет себя как другие модули, которые вы можете включить в роли, где ссылки на файлы или шаблоны сначала ищут в каталоге файлов или шаблонов роли. Чтобы он вел себя так, используйте поиск Ansible файлов или шаблонов (см. Примеры). Поиск работает как ожидается в контексте роли.
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется пакет f5-sdk Python на хосте. Это так же просто, как
pip install f5-sdk.
Примеры
- name: Use a file lookup to import key
bigip_ssl_key:
name: key-name
server: lb.mydomain.com
user: admin
password: secret
state: present
content: "{{ lookup('file', '/path/to/key.key') }}"
delegate_to: localhost
- name: Delete key
bigip_ssl_key:
name: key-name
server: lb.mydomain.com
user: admin
password: secret
state: absent
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 |
Статус
Этот модуль помечен как stableinterface, что означает, что авторы этого модуля гарантируют, что не будут вноситься несовместимые изменения в интерфейс.
Техническое обслуживание
Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Tim Rupp (@caphrim007)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ для его улучшения.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/bigip_ssl_key_module.html
