Spec-Zone.ru › Ansible 2.6

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
Протокол для доступа к объектам nitro API.
nitro_timeout По умолчанию:
310
Время в секундах до истечения времени ожидания при установлении нового сеанса с Netscaler
nitro_user
обязательно
Имя пользователя для аутентификации на узле netscaler.
notificationperiod
Время в днях до истечения срока действия сертификата, в течение которого будет генерироваться предупреждение о приближении истечения срока действия сертификата.
Минимальное значение = 10
Максимальное значение = 100
nsip
обязательно
IP-адрес устройства netscaler, на котором будут выполняться вызовы nitro API.
Порт можно указать с двоеточием (:). Например, 192.168.1.1:555.
passplain
Пароль, используемый для шифрования приватного ключа. Требуется при добавлении зашифрованного приватного ключа в формате PEM.
Минимальная длина = 1
password
Пароль, использовавшийся для шифрования приватного ключа. Используйте этот параметр для загрузки зашифрованных приватных ключей в формате PEM.
save_config
bool
    Варианты:
  • no
  • yes ←
Если значение true, модуль сохранит конфигурацию на узле netscaler, если внесены какие-либо изменения.
Модуль не сохранит конфигурацию на узле netscaler, если изменения не были внесены.
state
    Варианты:
  • present ←
  • absent
Состояние ресурса, настраиваемого модулем на узле netscaler.
При значении present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля.
При значении absent ресурс будет удален с узла netscaler.
validate_certs По умолчанию:
"yes"
Если 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. Подробнее см. Техническое обслуживание и поддержка модулей.

Список других модулей, которые также поддерживаются сообществом 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.6/modules/netscaler_ssl_certkey_module.html

Spec-Zone.ru

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