netscaler_ssl_certkey — Управление ключами сертификатов SSL.
Новая в версии 2.4.0.
Обзор
- Управление ключами сертификатов SSL.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- nitro python sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| cert | Имя и, необязательно, путь к файлу X509-сертификата, используемого для создания пары сертификат-ключ. Файл сертификата должен находиться на жестком диске или твердотельном накопителе устройства. Хранение сертификата в другом месте, отличном от стандартного, может привести к несоответствиям в конфигурации высокодоступной системы. По умолчанию используется путь /nsconfig/ssl/. Минимальная длина = 1 | |
| certkey | Имя пары сертификат-ключ. Должно начинаться с символа латинского алфавита, цифры или подчёркивания _, и содержать только символы латинского алфавита, цифры, подчёркивания _, символы хэша #, точки ., пробелы, двоеточия :, знаки @ @, знаки = =, и дефисы -. Не может быть изменено после создания пары сертификат-ключ.Следующее требование относится только к NetScaler CLI: Если имя содержит один или несколько пробелов, заключите имя в двойные или одинарные кавычки (например, "мой сертификат" или 'мой сертификат'). Минимальная длина = 1 | |
| expirymonitor |
| Выводить предупреждение, когда сертификат скоро истекает. |
| inform |
| Формат входных данных для файлов сертификата и закрытого ключа. Устройство поддерживает следующие три формата: PEM — Privacy Enhanced Mail DER — Distinguished Encoding Rule PFX — Personal Information Exchange. |
| key | Имя и, необязательно, путь к файлу закрытого ключа, используемого для создания пары сертификат-ключ. Файл сертификата должен находиться на жестком диске или твердотельном накопителе устройства. Хранение сертификата в другом месте, отличном от стандартного, может привести к несоответствиям в конфигурации высокодоступной системы. По умолчанию используется путь /nsconfig/ssl/. Минимальная длина = 1 | |
| nitro_pass обязательно | Пароль для аутентификации на узле netscaler. | |
| nitro_protocol |
| Протокол для доступа к объектам 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, модуль сохранит конфигурацию на узле netscaler, если внесёт изменения. Если модуль не внес изменений, конфигурация на узле netscaler не будет сохранена. |
| state |
| Состояние ресурса, настраиваемого модулем на узле netscaler. При значении present ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При значении absent ресурс будет удалён с узла netscaler. |
| validate_certs | По умолчанию: yes | Если 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 словарь | failure | Список различий между фактическим настроенным объектом и конфигурацией, указанной в модуле Пример: { 'targetlbvserver': 'различие. наш: (str) server1 другой: (str) server2' } |
| loglines список | всегда | список сообщений, записанных модулем Пример: ['сообщение 1', 'сообщение 2'] |
| msg строка | failure | Сообщение, описывающее причину ошибки Пример: Действие не существует |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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.5/modules/netscaler_ssl_certkey_module.html
