Модуль cisco.ise.renew_certificate – Модуль ресурсов для возобновления сертификата
Примечание
Этот модуль является частью коллекции cisco.ise (версия 2.9.3).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.ise. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.
Для использования в плейбуке укажите: cisco.ise.renew_certificate.
Новинка в cisco.ise 1.0.0
Описание
- Управление операцией создания ресурса «Возобновление сертификата».
- Этот API инициирует перегенерацию сертификатов. Ответ содержит идентификатор, который можно использовать для отслеживания статуса.
Примечание
Для этого модуля существует соответствующий плагин действий.
Требования
Ниже перечислены требования, необходимые на хосте, который выполняет этот модуль.
- ciscoisesdk >= 2.2.3
- python >= 3.5
Параметры
Параметр | Комментарии |
|---|---|
certType строка | certType сертификата «Возобновление сертификата». |
ise_debug булево | Флаг для Identity Services Engine SDK для включения отладки. Варианты:
|
ise_hostname строка / обязательно | Имя хоста Identity Services Engine. |
ise_password строка / обязательно | Пароль Identity Services Engine для аутентификации. |
ise_single_request_timeout целое число добавлен в cisco.ise 3.0.0 | Таймаут (в секундах) для запросов RESTful HTTP. По умолчанию: |
ise_username строка / обязательно | Имя пользователя Identity Services Engine для аутентификации. |
ise_uses_api_gateway булево добавлен в cisco.ise 1.1.0 | Флаг, информирующий SDK, следует ли использовать шлюз API Identity Services Engine для отправки запросов. Если true, используется шлюз API ISE и отправляются запросы к https://{{ise_hostname}}. Если false, запросы отправляются к https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Варианты:
|
ise_uses_csrf_token булево добавлен в cisco.ise 3.0.0 | Флаг, информирующий SDK, следует ли отправлять токен CSRF в API ERS ISE. Если True, SDK предполагает, что проверка CSRF ISE включена. Если True, предполагается, что SDK должен автоматически управлять токеном CSRF. Варианты:
|
ise_verify булево | Флаг для включения или выключения проверки SSL-сертификата. Варианты:
|
ise_version строка | Информирует SDK о том, какую версию Identity Services Engine использовать. По умолчанию: |
ise_wait_on_rate_limit булево | Флаг для Identity Services Engine SDK для включения автоматического управления лимитом запросов. Варианты:
|
Примечания
Примечание
- Используемые методы SDK — certificates.Certificates.renew_certificates,
- Используемые пути — post /api/v1/certs/renew-certificate,
- Не поддерживает
check_mode - Плагин выполняется на контрольном узле и не использует никаких плагинов подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
- Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения
См. также
См. также
- Документация Cisco ISE по сертификатам
-
Полная справка по API сертификатов.
Примеры
- name: Create
cisco.ise.renew_certificate:
ise_hostname: "{{ise_hostname}}"
ise_username: "{{ise_username}}"
ise_password: "{{ise_password}}"
ise_verify: "{{ise_verify}}"
certType: string
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
ise_response словарь | Словарь или список, содержащий ответ, возвращённый Python SDK Cisco ISE Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/cisco/ise/renew_certificate_module.html