bigip_ssl_key – Импорт/удаление SSL-ключей с BIG-IP
Новое в версии 2.5.
Описание
- Этот модуль импортирует/удаляет SSL-ключи на BIG-IP. Ключи могут быть импортированы из файлов ключей на локальном диске в формате PEM.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- BIG-IP >= v12
- f5-sdk >= 3.0.16
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| content - | Устанавливает содержимое ключа непосредственно в указанное значение. Используется с плагинами поиска или для чего-либо с форматированием или шаблонизацией. Это должно быть предоставлено, когда state равно present.псевдонимы: key_content | ||
| name - / обязательно | Имя ключа. | ||
| partition - добавлен в 2.5 | Значение по умолчанию: "Common" | Раздел устройства для управления ресурсами. | |
| passphrase - | Пароль ключа. | ||
| password - / обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Этот параметр можно опустить, установив переменную среды F5_PASSWORD.псевдонимы: pass, pwd | ||
| provider - добавлен в 2.5 | Значение по умолчанию: null | Объект типа dict содержащий данные подключения. | |
| 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 - | Значение по умолчанию: 10 | Устанавливает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |
| transport - / обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| user - / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, установив переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте только на сайтах, контролируемых лично, с самоподписанными сертификатами.Этот параметр можно опустить, установив переменную среды F5_VALIDATE_CERTS. | |
| 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 boolean добавлен в 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. - Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что специфичная для BIG-IP конфигурация сохраняется на диск, обязательно включите хотя бы одну задачу, которая использует модуль bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.
Примеры
- 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]
- Этот модуль поддерживается партнером Ansible. [certified]
Авторы
- 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.7/modules/bigip_ssl_key_module.html
