Spec-Zone.ru › Ansible 2.8

netscaler_ssl_certkey – Управление ключами сертификатов ssl

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

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

Обзор

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

Требования

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

  • nitro python sdk

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
cert
-
Имя и (необязательно) путь к файлу X509-сертификата, используемого для создания пары сертификат-ключ. Файл сертификата должен быть доступен на жестком диске или твердотельном накопителе устройства. Сохранение сертификата в любом месте, отличном от стандартного, может привести к несоответствиям в настройках высокой доступности. Стандартный путь - /nsconfig/ssl/.
Минимальная длина = 1
certkey
-
Имя пары сертификат-приватный ключ. Должно начинаться с символа ASCII, являющегося буквой, цифрой или символом подчеркивания, и содержать только символы ASCII, являющиеся буквами, цифрами, символом подчеркивания, символом решетки, точкой, пробелом, двоеточием, знаком "@" знаками "=" и тире.
Это требование относится только к 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 ←
  • 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
логическое значение
    Варианты:
  • нет
  • да ←
Если yes модуль сохранит конфигурацию на узле netscaler, если внесены изменения.
Модуль не сохранит конфигурацию на узле netscaler, если не было изменений.
state
строка
    Варианты:
  • absent
  • present ←
Состояние ресурса, настраиваемого модулем на узле netscaler.
В состоянии present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля.
В состоянии absent ресурс будет удален с узла netscaler.
validate_certs
логическое значение
    Варианты:
  • нет
  • да ←
Если no, SSL-сертификаты не будут проверены. Это следует использовать только на сайтах, находящихся под личным контролем, которые используют самозаверенные сертификаты.

Примечания

Примечание

  • Дополнительную информацию об использовании Ansible для управления устройствами сети Citrix NetScaler см. на странице https://www.ansible.com/ansible-netscaler.

Примеры

- 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': 'различие. наше: (строка) server1 другое: (строка) server2' }
loglines
список
всегда
список сообщений, записанных модулем

Пример:
['сообщение 1', 'сообщение 2']
msg
строка
ошибка
Сообщение, описывающее причину ошибки

Пример:
Действие не существует


Статус

  • Данный модуль не гарантирует обратную совместимость. [превью]
  • Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

  • George Nikolopoulos (@giorgos-nikolopoulos)

Подсказка

Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать этот документ, чтобы улучшить его.

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

Spec-Zone.ru

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