bigip_device_certificate – Управление самозаверяющимися сертификатами устройства
Новое в версии 2.9.
Обзор
- Модуль, используемый для создания и/или обновления самозаверяющих сертификатов устройства для BIG-IP.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| add_to_trusted boolean |
| Указывает, следует ли добавить сертификат в файлы доверенных клиентских и серверных сертификатов. | |
| cert_name string | Значение по умолчанию: "server.crt" | Указывает полное имя файла сертификата. Если имя не по умолчанию server.crt, модуль настроит httpd для их использования перед перезапуском демона httpd. | |
| days_valid integer / обязательно | Указывает интервал действия самозаверяющего сертификата. Максимальное значение — 25 лет: 9125 дней | ||
| force boolean |
| При значении yes, обновит или перезапишет существующий сертификат, даже если устройство не истекло.При значении no, сертификат будет обновлён/перезаписан только в случае истечения срока действия.Обычно следует использовать yes только в случаях, когда требуется обновить сертификат, срок действия которого близок к истечению.Этот параметр также необходим при создании нового сертификата для замены неистекшего. | |
| issuer dictionary | Свойства сертификата, необходимые при создании новых сертификатов. | ||
| common_name string | Указывает атрибут «общее имя» для сертификата. | ||
| country string | Указывает атрибут «страна» для сертификата. | ||
| division string | Указывает атрибут «департамент» для сертификата. | ||
| email string | Указывает электронный адрес администратора домена. | ||
| locality string | Указывает город или населенный пункт для сертификата. | ||
| organization string | Указывает атрибут «организация» для сертификата. | ||
| state string | Указывает атрибут «штат» или «провинция» для сертификата. | ||
| key_name string | Значение по умолчанию: "server.key" | Указывает полное имя файла ключа. Если имя не по умолчанию server.key, модуль настроит httpd для их использования перед перезапуском демона httpd. | |
| key_size integer |
| Указывает желаемый размер ключа в битах. Обязательный параметр при создании нового сертификата. | |
| new_cert boolean |
| Указывает, следует ли модулю сгенерировать новый сертификат. При значении yes сертификат устройства и ключ будут заменены | |
| provider dictionary добавлено в 2.5 | Объект словаря, содержащий данные подключения. | ||
| auth_provider string | Настраивает поставщика аутентификации для получения маркеров аутентификации от удаленного устройства. Этот параметр используется, в основном, при работе с устройствами BIG-IQ. | ||
| password string / обязательно | Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить, задав переменную среды F5_PASSWORD. псевдонимы: pass, pwd | ||
| server string / обязательно | Хост BIG-IP. Можно опустить, задав переменную среды F5_SERVER. | ||
| server_port integer | Значение по умолчанию: 443 | Порт сервера BIG-IP. Можно опустить, задав переменную среды F5_SERVER_PORT. | |
| ssh_keyfile path | Указывает файл SSH-ключа для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Можно опустить, задав переменную среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку. | ||
| transport string |
| Настраивает транспортное соединение для подключения к удалённому устройству. | |
| user string / обязательно | Имя пользователя для подключения к BIG-IP. Этот пользователь должен обладать административными правами на устройстве. Можно опустить, задав переменную среды F5_USER. | ||
| validate_certs boolean |
| Если no, SSL-сертификаты не проверяются. Используйте только на сайтах, управляемых лично, и с использованием самозаверяющих сертификатов.Можно опустить, задав переменную среды F5_VALIDATE_CERTS. | |
| transport - / обязательно |
| Настраивает транспортное соединение для подключения к удалённому устройству. В настоящее время модуль поддерживает только подключение к устройству по протоколу cli (ssh). | |
Примечания
Примечание
- Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
- Требуется версия программного обеспечения BIG-IP >= 12.
- Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы убедиться, что конфигурация BIG-IP сохранится на диске, обязательно включите хотя бы одну задачу, использующую модуль 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 | |
Статус
- Данному модулю не гарантируется обратная совместимость интерфейса. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицировано]
Авторы
- 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_device_certificate_module.html
