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 строка	Варианты: отсутствует имеется ←	Состояние ресурса, настраиваемого модулем на узле netscaler. В случае present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. В случае absent ресурс будет удален с узла netscaler.
validate_certs логический тип	Варианты: нет да ←	Если `no`, SSL-сертификаты не будут проверены. Это следует использовать только на сайтах под собственным управлением с самозаверенными сертификатами.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами Citrix NetScaler Network см. в разделе 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': 'различие. наш: (строка) сервер1 другой: (строка) сервер2' }
loglines список	всегда	список зарегистрированных сообщений модуля Пример: ['сообщение 1', 'сообщение 2']
msg строка	сбой	Сообщение с подробным описанием причины сбоя Пример: Действия не существует

Статус

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

Авторы

Джордж Николопулос (@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.9/modules/netscaler_ssl_certkey_module.html