f5networks.f5_modules.bigip_device_certificate – Управление самозаверяющимися сертификатами устройства BIG-IP
Примечание
Этот плагин входит в коллекцию f5networks.f5_modules (версия 1.6.0).
Для его установки используйте: ansible-galaxy collection install f5networks.f5_modules
Для использования в плейбуке укажите: f5networks.f5_modules.bigip_device_certificate
Новое в версии 1.0.0: модуля f5networks.f5_modules
Обзор
- Модуль используется для создания и/или обновления самозаверяющих сертификатов устройств для BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| add_to_trusted boolean |
| Указывает, следует ли добавить сертификат в файлы доверенных клиентских и серверных сертификатов. | |
| cert_name строка | Значение по умолчанию: "server.crt" | Указывает полное имя файла сертификата. Если имя не по умолчанию server.crt, модуль настроит httpd для их использования перед перезапуском демона httpd | |
| days_valid целое число / обязательно | Указывает интервал действия самозаверяющего сертификата. Максимальное значение составляет 25 лет: 9125 дней | ||
| force boolean |
| При значении yes, обновит или перезапишет существующий сертификат, если он не истек на устройстве.При значении no, сертификат будет обновлён/перезаписан только в случае истечения срока действия.В общем случае следует использовать yes только в тех случаях, когда необходимо обновить сертификат, срок действия которого близится к концу.Этот параметр также необходим при генерации нового сертификата для замены не истекшего. | |
| issuer словарь | Свойства сертификата, необходимые при генерации новых сертификатов. | ||
| common_name строка | Указывает атрибут общего имени для сертификата. | ||
| country строка | Указывает атрибут страны для сертификата. | ||
| division строка | Указывает атрибут названия департамента для сертификата. | ||
| email строка | Указывает адрес электронной почты администратора домена. | ||
| locality строка | Указывает название города или поселка для сертификата. | ||
| organization строка | Указывает атрибут организации для сертификата. | ||
| state строка | Указывает атрибут штата или провинции для сертификата. | ||
| key_name строка | Значение по умолчанию: "server.key" | Указывает полное имя файла ключа. Если имя не по умолчанию server.key, модуль настроит httpd для их использования перед перезапуском демона httpd | |
| key_size целое число |
2048 | Указывает требуемый размер ключа в битах. Обязательный параметр при генерации нового сертификата. | |
| new_cert boolean |
| Указывает, должен ли модуль сгенерировать новый сертификат. При значении yes, сертификат устройства и ключ будут заменены. | |
| provider словарь добавлен в 1.0.0 f5networks.f5_modules | Объект словаря, содержащий данные подключения. | ||
| auth_provider строка | Настраивает поставщика аутентификации для получения токенов аутентификации от удаленного устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ. | ||
| no_f5_teem boolean |
| Если yes, данные телеметрии TEEM не отправляются в F5.Этот параметр можно опустить, установив переменную окружения F5_TEEM. | |
| password строка / обязательно | Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_PASSWORD.псевдонимы: pass, pwd | ||
| server строка / обязательно | Хост BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_SERVER. | ||
| server_port целое число | Значение по умолчанию: 22 | Порт сервера BIG-IP. Этот параметр можно опустить, установив переменную окружения F5_SERVER_PORT. | |
| ssh_keyfile путь | Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Этот параметр можно опустить, установив переменную окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут превышен до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное подключение для подключения к удаленному устройству. | |
| user строка / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные права на устройстве. Этот параметр можно опустить, установив переменную окружения F5_USER. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не проверяются. Используйте это только на контролируемых вами сайтах, использующих самозаверяющие сертификаты.Этот параметр можно опустить, установив переменную окружения F5_VALIDATE_CERTS. | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия ПО BIG-IP >= 12.
- Модули F5 манипулируют только текущей конфигурацией продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, необходимо включить по крайней мере одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения вашей текущей конфигурации.
Примеры
- name: Update expired certificate
bigip_device_certificate:
days_valid: 365
provider:
password: secret
server: lb.mydomain.com
user: admin
transport: cli
server_port: 22
delegate_to: localhost
- name: Update expired certificate non-default names
bigip_device_certificate:
days_valid: 60
cert_name: custom.crt
key_name: custom.key
provider:
password: secret
server: lb.mydomain.com
user: admin
transport: cli
server_port: 22
delegate_to: localhost
- name: Force update not expired certificate
bigip_device_certificate:
days_valid: 365
force: yes
provider:
password: secret
server: lb.mydomain.com
user: admin
transport: cli
server_port: 22
delegate_to: localhost
- name: Create a new certificate to replace expired certificate
bigip_device_certificate:
days_valid: 365
new_cert: yes
issuer:
country: US
state: WA
common_name: foobar.foo.local
provider:
password: secret
server: lb.mydomain.com
user: admin
transport: cli
server_port: 22
delegate_to: localhost
- name: Force create a new custom named certificate to replace not expired certificate
bigip_device_certificate:
days_valid: 365
cert_name: custom.crt
key_name: custom.key
new_cert: yes
force: yes
issuer:
country: US
state: WA
common_name: foobar.foo.local
key_size: 2048
provider:
password: secret
server: lb.mydomain.com
user: admin
transport: cli
server_port: 22
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключи | Возвращаемое значение | Описание | |
|---|---|---|---|
| cert_name строка | изменённое | Полное имя файла сертификата. Пример: common.crt | |
| days_valid целое число | изменённое | Интервал действия самоподписанного сертификата. Пример: 365 | |
| issuer сложный | изменённое | Указывает свойства сертификата. | |
| common_name строка | изменённое | Атрибут общего имени сертификата. Пример: foo.bar.local | |
| country строка | изменённое | Атрибут имени страны сертификата. Пример: US | |
| division строка | изменённое | Атрибут названия отдела сертификата. Пример: IT | |
| email строка | изменённое | Электронный адрес администратора домена. Пример: admin@foo.bar.local | |
| locality строка | изменённое | Атрибут имени города или населенного пункта сертификата. Пример: Seattle | |
| organization строка | изменённое | Атрибут организации сертификата. Пример: F5 | |
| state строка | изменённое | Атрибут штата или провинции сертификата. Пример: WA | |
| key_name строка | изменённое | Полное имя файла ключа. Пример: common.key | |
| key_size целое число | изменённое | Желаемый размер ключа в битах. Пример: 2048 | |
Авторы
- 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_device_certificate_module.html
