Spec-Zone.ru › Ansible 2.4

netscaler_ssl_certkey — Управление ключами SSL-сертификатов.

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

  • Обзор
  • Требования (к хосту, на котором выполняется модуль)
  • Параметры
  • Примеры
  • Возвращаемые значения
    • Статус

Обзор

  • Управление ключами SSL-сертификатов.

Требования (к хосту, на котором выполняется модуль)

  • nitro python sdk

Параметры

параметр обязательно по умолчанию варианты комментарии
cert
нет
Имя и, необязательно, путь к файлу X509-сертификата, используемого для создания пары сертификат-ключ. Файл сертификата должен находиться на жёстком диске или твердотельном накопителе устройства. Хранение сертификата в любом месте, отличном от стандартного, может привести к несоответствию в настройках высокой доступности. По умолчанию используется путь /nsconfig/ssl/.
Минимальная длина = 1
certkey
нет
Имя пары сертификат-приватный ключ. Должно начинаться с символа латинского алфавита, цифры или нижнего подчёркивания _, и может содержать только символы латинского алфавита, цифры, нижнее подчёркивание _, символ решётки #, точку ., пробел, двоеточие :, символ @ @, знак равенства =, и дефис -. Не может быть изменено после создания пары сертификат-ключ.
Данное требование относится только к NetScaler CLI:
Если имя содержит один или несколько пробелов, заключите имя в двойные или одинарные кавычки (например, "мой сертификат" или 'мой сертификат').
Минимальная длина = 1
expirymonitor
нет
  • enabled
  • disabled
Выдать предупреждение, когда сертификат приближается к дате истечения срока действия.
inform
нет
  • DER
  • PEM
  • PFX
Формат входных файлов сертификата и приватного ключа. Поддерживаемые форматы устройства:
PEM - Privacy Enhanced Mail
DER - Distinguished Encoding Rule
PFX - Personal Information Exchange.
key
нет
Имя и, необязательно, путь к файлу приватного ключа, используемого для создания пары сертификат-ключ. Файл сертификата должен находиться на жёстком диске или твердотельном накопителе устройства. Хранение сертификата в любом месте, отличном от стандартного, может привести к несоответствию в настройках высокой доступности. По умолчанию используется путь /nsconfig/ssl/.
Минимальная длина = 1
nitro_pass
да
Пароль для аутентификации на узле netscaler.
nitro_protocol
нет http
  • http
  • https
Протокол для доступа к объектам API nitro.
nitro_timeout
нет 310
Время в секундах до таймаута при установлении нового сеанса с NetScaler
nitro_user
да
Имя пользователя для аутентификации на узле netscaler.
notificationperiod
нет
Время в днях до истечения срока действия сертификата, по истечении которого генерируется предупреждение о приближающейся дате истечения срока действия сертификата.
Минимальное значение = 10
Максимальное значение = 100
nsip
да
IP-адрес устройства netscaler, на котором будут выполняться вызовы API nitro.
Порт можно указать с двоеточием (:). Например, 192.168.1.1:555.
passplain
нет
Пароль, используемый для шифрования приватного ключа. Требуется при добавлении зашифрованного приватного ключа в формате PEM.
Минимальная длина = 1
password
нет
Пароль, который использовался для шифрования приватного ключа. Используйте этот параметр для загрузки зашифрованных приватных ключей в формате PEM.
save_config
нет True
  • да
  • нет
Если true, модуль сохранит конфигурацию на узле netscaler, если он внесёт изменения.
Если модуль не внес изменений, конфигурация на узле netscaler не будет сохранена.
state
нет present
  • present
  • absent
Состояние настраиваемого ресурса на узле netscaler.
При значении present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля.
При значении absent ресурс будет удалён с узла netscaler.
validate_certs
нет да
Если no, SSL-сертификаты не будут проверены. Это следует использовать только на сайтах, управляемых лично, использующих самозаверяющие сертификаты.

Примеры

- name: Setup ssl certkey
  delegate_to: localhost
  netscaler_ssl_certkey:
    nitro_user: nsroot
    nitro_pass: nsroot
    nsip: 172.18.0.2

    certkey: certirificate_1
    cert: server.crt
    key: server.key
    expirymonitor: enabled
    notificationperiod: 30
    inform: PEM
    password: False
    passplain: somesecret

Возвращаемые значения

Общие значения возврата описаны здесь Возвращаемые значения, ниже приведены поля, уникальные для данного модуля:

имя описание возвращается тип пример
diff
Список различий между фактически настроенным объектом и конфигурацией, указанной в модуле
ошибка словарь { 'targetlbvserver': 'различие. наше: (str) server1 другое: (str) server2' }
loglines
Список сообщений, записанных модулем
всегда список ['сообщение 1', 'сообщение 2']
msg
Сообщение, описывающее причину ошибки
ошибка строка Действие не существует

Статус

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

Для получения помощи в разработке модулей ознакомьтесь с Информацией о сообществе и участии в нём, Тестирование Ansible и Разработка модулей.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/netscaler_ssl_certkey_module.html

Spec-Zone.ru

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