Модуль community.network.netscaler_ssl_certkey — Управление ключами SSL-сертификатов.

Примечание

Этот модуль входит в коллекцию community.network (версия 5.0.3).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.network. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Для использования в playbook используйте: community.network.netscaler_ssl_certkey.

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

Обзор

Управление ключами SSL-сертификатов.

Псевдонимы: network.netscaler.netscaler_ssl_certkey

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

nitro python sdk

Параметры

Параметр	Комментарии
cert string	Имя и, при необходимости, путь к файлу сертификата X509, который используется для формирования пары сертификат-ключ. Файл сертификата должен находиться на жестком диске или твердотельном накопителе устройства. Хранение сертификата в любом месте, отличном от места по умолчанию, может привести к несоответствиям в конфигурации высокой доступности. /nsconfig/ssl/ — путь по умолчанию. Минимальная длина = 1
certkey string	Имя для пары сертификат-закрытый ключ. Должно начинаться с буквенно-цифрового символа ASCII или символа подчеркивания `_` и содержать только буквенно-цифровые символы ASCII, символ подчеркивания `_`, символ решётки `#`, точку `.`, пробел, двоеточие `:`, символ @ `@`, знак равенства `=`, и дефис `-`. Не может быть изменено после создания пары сертификат-ключ. Следующее требование применяется только к NetScaler CLI: Если имя содержит один или несколько пробелов, заключите имя в двойные или одинарные кавычки (например, “my cert” или ‘my cert’). Минимальная длина = 1
expirymonitor string	Выдать предупреждение, когда сертификат скоро истечет. Варианты: `"enabled"` `"disabled"`
inform string	Входной формат файлов сертификата и закрытого ключа. Три формата, поддерживаемые устройством: PEM - Privacy Enhanced Mail DER - Distinguished Encoding Rule PFX - Personal Information Exchange. Варианты: `"DER"` `"PEM"` `"PFX"`
key string	Имя и, при необходимости, путь к файлу закрытого ключа, который используется для формирования пары сертификат-ключ. Файл сертификата должен находиться на жестком диске или твердотельном накопителе устройства. Хранение сертификата в любом месте, отличном от места по умолчанию, может привести к несоответствиям в конфигурации высокой доступности. /nsconfig/ssl/ — путь по умолчанию. Минимальная длина = 1
nitro_pass string / required	Пароль для аутентификации на узле netscaler.
nitro_protocol string	Какой протокол использовать при доступе к объектам API nitro. Варианты: `"http"` ← (default) `"https"`
nitro_timeout float	Время в секундах до возникновения ошибки тайм-аута при установлении нового сеанса с Netscaler По умолчанию: `310.0`
nitro_user string / required	Имя пользователя для аутентификации на узле netscaler.
notificationperiod string	Время в днях до истечения срока действия сертификата, по истечении которого будет генерироваться предупреждение о скором истечении срока действия сертификата. Минимальное значение = `10` Максимальное значение = `100`
nsip string / required	IP-адрес устройства netscaler, к которому будут выполняться вызовы API nitro. Порт может быть указан с помощью двоеточия (:). Например, 192.168.1.1:555.
passplain string	Пассфраз, используемый для шифрования закрытого ключа. Требуется при добавлении зашифрованного закрытого ключа в формате PEM. Минимальная длина = 1
password string	Пассфраз, который использовался для шифрования закрытого ключа. Используйте этот параметр для загрузки зашифрованных закрытых ключей в формате PEM.
save_config boolean	Если `yes`, модуль сохранит конфигурацию на узле netscaler, если он внесет какие-либо изменения. Модуль не будет сохранять конфигурацию на узле netscaler, если он не внес никаких изменений. Варианты: `false` `true` ← (default)
state string	Состояние ресурса, настраиваемого модулем на узле netscaler. При наличии ресурс будет создан при необходимости и настроен в соответствии с параметрами модуля. При отсутствии ресурс будет удален с узла netscaler. Варианты: `"absent"` `"present"` ← (default)
validate_certs boolean	Если `no`, SSL-сертификаты проверяться не будут. Это следует использовать только на лично контролируемых сайтах, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (default)

Примечания

Примечание

Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами Citrix NetScaler см. 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": "difference. ours: (str) server1 other: (str) server2"}`
loglines список / элементы=строка	Список сообщений, зарегистрированных модулем Возвращено: всегда Пример: `["['message 1'", " 'message 2']"]`
msg строка	Сообщение, описывающее причину ошибки Возвращено: ошибка Пример: `"Action does not exist"`

Авторы

George Nikolopoulos (@giorgos-nikolopoulos)

Ссылки на коллекции

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