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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.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	Указывает атрибут Common Name сертификата.
country string	Указывает атрибут названия страны для сертификата.
division string	Указывает атрибут названия отдела для сертификата.
email string	Указывает адрес электронной почты администратора домена.
locality string	Указывает название города или населённого пункта для сертификата.
organization string	Указывает атрибут Organization сертификата.
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	Объект dict с параметрами подключения.
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 integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER_PORT`. По умолчанию: `22`
ssh_keyfile path	Указывает файл ключа SSH для аутентификации при подключении к удалённому устройству. Этот аргумент используется только для транспортов cli. Этот параметр можно не указывать, задав переменную окружения `ANSIBLE_NET_SSH_KEYFILE`.
timeout integer	Указывает время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если операция не завершится до истечения времени ожидания, модуль завершится с ошибкой.
transport string	Настраивает транспортное соединение для подключения к удалённому устройству. Варианты: `"cli"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную окружения `F5_USER`.
validate_certs boolean	Если задано значение `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 string	Полное имя файла сертификата. Возвращается: changed Пример: `"common.crt"`
days_valid integer	Срок действия самоподписанного сертификата. Возвращается: changed Пример: `365`
issuer complex	Свойства сертификата. Возвращается: changed
common_name string	Атрибут Common Name сертификата. Возвращается: changed Пример: `"foo.bar.local"`
country string	Атрибут названия страны в сертификате. Возвращается: changed Пример: `"US"`
division string	Атрибут названия отдела в сертификате. Возвращается: changed Пример: `"IT"`
email string	Адрес электронной почты администратора домена. Возвращается: changed Пример: `"admin@foo.bar.local"`
locality string	Атрибут названия города или населённого пункта в сертификате. Возвращается: changed Пример: `"Seattle"`
organization string	Атрибут Organization сертификата. Возвращается: changed Пример: `"F5"`
state string	Атрибут штата или провинции в сертификате. Возвращается: changed Пример: `"WA"`
key_name string	Полное имя файла ключа. Возвращается: changed Пример: `"common.key"`
key_size integer	Требуемый размер ключа в битах. Возвращается: changed Пример: `2048`

Авторы

Wojciech Wypior (@wojtek0806)

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

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