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

Примечание

Этот плагин входит в коллекцию community.network (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install community.network.

Для использования в книге задач укажите: community.network.netscaler_ssl_certkey.

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

Обзор

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

Примечания

Примечание

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

Примеры

- name: Setup ssl certkey
  delegate_to: localhost
  community.network.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 строка	ошибка	Сообщение, описывающее причину ошибки Пример: Действие не существует

Авторы

George Nikolopoulos (@giorgos-nikolopoulos)

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