Spec-Zone.ru › Ansible 2.5

bigip_ssl_key - Импорт/удаление ключей SSL с BIG-IP

Новое в версии 2.5.

  • Описание
    • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения
  • Статус
    • Автор

Описание

  • Этот модуль будет импортировать/удалять ключи SSL на BIG-IP. Ключи могут быть импортированы из файлов ключей на локальном диске в формате PEM.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • BIG-IP >= v12
  • f5-sdk >= 3.0.9

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
content
Устанавливает содержимое ключа непосредственно в указанное значение. Используется с плагинами поиска или для всего, что требует форматирования или шаблонизации. Это необходимо при state, равном present.

псевдонимы: key_content
name
обязательно
Имя ключа.
partition
(добавлено в 2.5)
По умолчанию:
Common
Раздел устройства для управления ресурсами.
passphrase
Пароль к ключу.
password
обязательно
Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, если переменная окружения F5_PASSWORD установлена.

псевдонимы: pass, pwd
provider
(добавлено в 2.5)
По умолчанию:
None
Объект словаря, содержащий данные подключения.
ssh_keyfile
Указывает файл SSH-ключа для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
timeout По умолчанию:
10
Устанавливает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль вернёт ошибку.
server
обязательно
Хост BIG-IP. Можно опустить этот параметр, если переменная окружения F5_SERVER установлена.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если переменная окружения F5_USER установлена.
server_port По умолчанию:
443
Порт сервера BIG-IP. Можно опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена.
password
обязательно
Пароль учетной записи пользователя для подключения к BIG-IP. Можно опустить этот параметр, если переменная окружения F5_PASSWORD установлена.

псевдонимы: pass, pwd
validate_certs
    Варианты:
  • no
  • да ←
Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых сайтах, использующих самозаверенные сертификаты. Можно опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена.
transport
обязательно
    Варианты:
  • rest
  • cli ←
Настраивает транспортное соединение для подключения к удаленному устройству.
server
обязательно
Хост BIG-IP. Можно опустить этот параметр, если переменная окружения F5_SERVER установлена.
server_port
(добавлено в 2.2)
По умолчанию:
443
Порт сервера BIG-IP. Можно опустить этот параметр, если переменная окружения F5_SERVER_PORT установлена.
state
    Варианты:
  • present ←
  • absent
Если present, гарантирует, что ключ загружен на устройство. Если absent, гарантирует, что ключ удалён с устройства. Если ключ используется в данный момент, модуль не сможет удалить ключ.
user
обязательно
Имя пользователя для подключения к BIG-IP. Этот пользователь должен иметь административные привилегии на устройстве. Можно опустить этот параметр, если переменная окружения F5_USER установлена.
validate_certs
(добавлено в 2.0)
    Варианты:
  • no
  • да ←
Если no, сертификаты SSL не будут проверены. Используйте только на контролируемых сайтах, использующих самозаверенные сертификаты. Можно опустить этот параметр, если переменная окружения F5_VALIDATE_CERTS установлена.

Примечания

Примечание

  • Этот модуль не ведет себя как другие модули, которые вы можете включить в роли, где ссылка на файлы или шаблоны сначала ищет в каталоге файлов или шаблонов роли. Чтобы заставить его вести себя таким образом, используйте поиск Ansible по файлам или шаблонам (см. Примеры). Поиски работают так, как ожидается, в контексте роли.
  • Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на https://www.ansible.com/integrations/networks/f5.
  • Требуется пакет f5-sdk Python на хосте. Это так же просто, как pip install f5-sdk.

Примеры

- 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


Статус

Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.

Автор

  • 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.5/modules/bigip_ssl_key_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API