netscaler_ssl_certkey – Управление ключами сертификатов ssl.
Новое в версии 2.4.0.
Обзор
- Управление ключами сертификатов ssl.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- nitro python sdk
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| cert - | Имя и (необязательно) путь к файлу X509-сертификата, используемого для создания пары сертификат-ключ. Файл сертификата должен быть доступен на жестком диске или твердотельном накопителе устройства. Хранение сертификата в любом месте, отличном от стандартного, может привести к несоответствиям в настройках высокой доступности. По умолчанию используется путь /nsconfig/ssl/. Минимальная длина = 1 | |
| certkey - | Имя пары сертификат-приватный ключ. Должно начинаться с символа ASCII, содержащего алфавитно-цифровые символы или символ подчеркивания _, и должно содержать только символы ASCII, алфавитно-цифровые символы, символ подчеркивания _, символ хэша #, точку ., пробел , двоеточие :, знак @ @, знак равенства =, и дефис -. Не может быть изменено после создания пары сертификат-ключ.Следующее требование применяется только к NetScaler CLI: Если имя содержит один или несколько пробелов, заключите имя в двойные или одинарные кавычки (например, "my cert" или 'my cert'). Минимальная длина = 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 boolean |
| Если значение true, модуль сохранит конфигурацию на узле 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': 'различие. наше: (строка) 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.7/modules/netscaler_ssl_certkey_module.html