Модуль f5networks.f5_modules.bigip_device_certificate — Управление самоподписанными сертификатами устройства

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Для использования в плейбуке укажите: f5networks.f5_modules.bigip_device_certificate.

Добавлена в f5networks.f5_modules 1.0.0

Описание
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Модуль используется для создания и/или обновления самоподписанных сертификатов устройств BIG-IP.

Параметры

Параметр	Комментарии
add_to_trusted boolean	Указывает, нужно ли добавлять сертификат в файлы доверенных клиентских и серверных сертификатов. Варианты: `false` ← (по умолчанию) `true`
cert_name string	Указывает полное имя файла сертификата. Если имя не по умолчанию `server.crt`, модуль настроит `httpd` для их использования перед перезапуском демона `httpd`. По умолчанию: `"server.crt"`
days_valid integer / обязательно	Указывает срок действия самозаверяющегося сертификата. Максимальное значение — 25 лет: `9125` дней
force boolean	Если `true`, будет обновлять или перезаписывать существующий сертификат, если он не просрочен на устройстве. Если `false`, сертификат будет обновлён/перезаписан только в случае истечения срока действия. Обычно следует устанавливать `true` только в тех случаях, когда требуется обновить сертификат, срок действия которого близится к концу. Этот параметр также необходим при генерации нового сертификата для замены непросроченного. Варианты: `false` ← (по умолчанию) `true`
issuer dictionary	Свойства сертификата, необходимые при генерации новых сертификатов.
common_name string	Указывает атрибут Общее имя для сертификата.
country string	Указывает атрибут Страна для сертификата.
division string	Указывает атрибут Департамент для сертификата.
email string	Указывает адрес электронной почты администратора домена.
locality string	Указывает город или название населенного пункта для сертификата.
organization string	Указывает атрибут Организация для сертификата.
state string	Указывает атрибут Штат или Провинция для сертификата.
key_name string	Указывает полное имя файла ключа. Если имя не по умолчанию `server.key`, модуль настроит `httpd` для их использования перед перезапуском демона `httpd`. По умолчанию: `"server.key"`
key_size integer	Указывает желаемый размер ключа в битах. Обязательный параметр при генерации нового сертификата. Варианты: `512` `1024` `2048` ← (по умолчанию) `4096`
new_cert boolean	Указывает, нужно ли модулю сгенерировать новый сертификат. При `true`, сертификат устройства и ключ будут заменены. Варианты: `false` ← (по умолчанию) `true`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект словаря, содержащий детали подключения.
auth_provider string	Настраивает поставщика аутентификации для получения маркеров аутентификации с удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Ранее используемая переменная `F5_TEEM` устарела, так как её название вызывало путаницу. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательно	Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, установив переменную среды `F5_PASSWORD`.

server string / обязательно	Хост BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Вы можете опустить этот параметр, установив переменную окружения `F5_SERVER_PORT`. По умолчанию: `22`
ssh_keyfile путь	Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Вы можете опустить этот параметр, установив переменную окружения `ANSIBLE_NET_SSH_KEYFILE`.
timeout целое число	Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку.
transport строка	Настраивает транспортное соединение для подключения к удалённому устройству. Доступные значения: `"cli"` ← (по умолчанию)
user строка / обязательно	Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь права администратора на устройстве. Вы можете опустить этот параметр, установив переменную окружения `F5_USER`.
validate_certs булево	Если `no`, сертификаты SSL не будут валидироваться. Используйте это только на сайтах, контролируемых вами, использующих самоподписанные сертификаты. Вы можете опустить этот параметр, установив переменную окружения `F5_VALIDATE_CERTS`. Доступные значения: `false` `true` ← (по умолчанию)

Примечания

Примечание

При использовании данного модуля убедитесь, что тип SSH не установлен на libssh. Для этого можно установить переменную окружения так: ANSIBLE_NETWORK_CLI_SSH_TYPE=paramiko или установить add ssh_type = paramiko в разделе persistent_connection в файле ansible.cfg.
Дополнительную информацию об использовании 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: true
    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: true
    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: true
    force: true
    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 строка	Полное имя файла сертификата. Возвращено: changed Пример: `"common.crt"`
days_valid целое число	Период действия самозаверяющегося сертификата. Возвращено: changed Пример: `365`
issuer сложный	Указывает свойства сертификата. Возвращено: changed
common_name строка	Атрибут Общее имя сертификата. Возвращено: changed Пример: `"foo.bar.local"`
country строка	Атрибут Страна сертификата. Возвращено: changed Пример: `"US"`
division строка	Атрибут Департамент сертификата. Возвращено: changed Пример: `"IT"`
email строка	Электронный адрес администратора домена. Возвращено: changed Пример: `"admin@foo.bar.local"`
locality строка	Атрибут Город или населенный пункт сертификата. Возвращено: changed Пример: `"Seattle"`
organization строка	Атрибут Организация сертификата. Возвращено: changed Пример: `"F5"`
state строка	Атрибут Штат или провинция сертификата. Возвращено: changed Пример: `"WA"`
key_name строка	Полное имя файла ключа. Возвращено: changed Пример: `"common.key"`
key_size целое число	Желаемый размер ключа в битах. Возвращено: changed Пример: `2048`

Авторы

Wojciech Wypior (@wojtek0806)

Ссылки на коллекции

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_device_certificate_module.html