Модуль cisco.ise.trusted_certificate – Модуль ресурсов для доверенного сертификата

Примечание

Этот модуль является частью коллекции cisco.ise (версия 2.9.3).

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

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

Для использования в playbook укажите: cisco.ise.trusted_certificate.

Новая функция в cisco.ise 1.0.0

Описание
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Описание

Управление операциями обновления и удаления ресурса «Доверенный сертификат».
Этот API удаляет доверенный сертификат из хранилища доверенных сертификатов на основе заданного идентификатора.
Обновление доверенного сертификата, присутствующего в хранилище доверенных сертификатов Cisco ISE.

Примечание

Данный модуль имеет соответствующий плагин действий.

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
authenticateBeforeCRLReceived boolean	Переключатель для включения или отключения проверки CRL, если CRL не получен. Варианты: `false` `true`
automaticCRLUpdate boolean	Переключатель для включения или отключения автоматического обновления CRL. Варианты: `false` `true`
automaticCRLUpdatePeriod integer	Период автоматического обновления CRL.
automaticCRLUpdateUnits string	Единица времени для автоматического обновления CRL.
crlDistributionUrl string	URL распространения CRL.
crlDownloadFailureRetries integer	Если загрузка CRL завершилась ошибкой, время ожидания перед повторной попыткой.
crlDownloadFailureRetriesUnits string	Единица времени перед повторной попыткой, если загрузка CRL завершилась ошибкой.
description string	Описание для доверенного сертификата.
downloadCRL boolean	Переключатель для включения или отключения загрузки CRL. Варианты: `false` `true`
enableOCSPValidation boolean	Переключатель для включения или отключения проверки OCSP. Варианты: `false` `true`
enableServerIdentityCheck boolean	Переключатель для включения или отключения проверки соответствия имени сертификата сервера HTTPS или LDAP настроенному URL сервера. Варианты: `false` `true`
id string	Параметр пути ID. ID доверенного сертификата.
ignoreCRLExpiration boolean	Переключатель для включения или отключения игнорирования истечения срока действия CRL. Варианты: `false` `true`
ise_debug boolean	Флаг для Identity Services Engine SDK для включения отладки. Варианты: `false` ← (default) `true`
ise_hostname string / required	Имя хоста Identity Services Engine.
ise_password string / required	Пароль Identity Services Engine для аутентификации.
ise_single_request_timeout integer добавлено в cisco.ise 3.0.0	Таймаут (в секундах) для HTTP-запросов RESTful. По умолчанию: `60`
ise_username string / required	Имя пользователя Identity Services Engine для аутентификации.
ise_uses_api_gateway boolean добавлено в 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). Варианты: `false` `true` ← (default)
ise_uses_csrf_token boolean добавлено в cisco.ise 3.0.0	Флаг, который сообщает SDK, отправляем ли мы токен CSRF в API ERS ISE. Если это True, SDK предполагает, что ваша проверка CSRF ISE включена. Если это True, он предполагает, что вам необходимо, чтобы SDK автоматически управлял токеном CSRF для вас. Варианты: `false` ← (default) `true`

ise_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
ise_version string	Указывает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit boolean	Флаг для Identity Services Engine SDK, чтобы включить автоматическую обработку лимита скорости. Варианты: `false` `true` ← (по умолчанию)
name string	Дружественное имя сертификата.
nonAutomaticCRLUpdatePeriod integer	Период обновления CRL без автоматического обновления.
nonAutomaticCRLUpdateUnits string	Единица измерения времени для неавтоматического обновления CRL.
rejectIfNoStatusFromOCSP boolean	Переключатель для отклонения сертификата, если нет статуса из OCSP. Варианты: `false` `true`
rejectIfUnreachableFromOCSP boolean	Переключатель для отклонения сертификата, если недоступен OCSP. Варианты: `false` `true`
selectedOCSPService string	Имя выбранной службы OCSP.
status string	Статус доверенного сертификата.
trustForCertificateBasedAdminAuth boolean	Доверие для аутентификации администратора на основе сертификата. Варианты: `false` `true`
trustForCiscoServicesAuth boolean	Доверие для аутентификации служб Cisco. Варианты: `false` `true`
trustForClientAuth boolean	Доверие для аутентификации клиента и Syslog. Варианты: `false` `true`
trustForIseAuth boolean	Доверие для аутентификации внутри Cisco ISE. Варианты: `false` `true`

Примечания

Примечание

Используемые методы SDK: certificates.Certificates.delete_trusted_certificate_by_id, certificates.Certificates.update_trusted_certificate,
Используемые пути: delete /api/v1/certs/trusted-certificate/{id}, put /api/v1/certs/trusted-certificate/{id},
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

Документация Cisco ISE по сертификатам: Полная справка по API сертификатов.

Примеры

- name: Update by id
  cisco.ise.trusted_certificate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    authenticateBeforeCRLReceived: true
    automaticCRLUpdate: true
    automaticCRLUpdatePeriod: 0
    automaticCRLUpdateUnits: string
    crlDistributionUrl: string
    crlDownloadFailureRetries: 0
    crlDownloadFailureRetriesUnits: string
    description: string
    downloadCRL: true
    enableOCSPValidation: true
    enableServerIdentityCheck: true
    id: string
    ignoreCRLExpiration: true
    name: string
    nonAutomaticCRLUpdatePeriod: 0
    nonAutomaticCRLUpdateUnits: string
    rejectIfNoStatusFromOCSP: true
    rejectIfUnreachableFromOCSP: true
    selectedOCSPService: string
    status: string
    trustForCertificateBasedAdminAuth: true
    trustForCiscoServicesAuth: true
    trustForClientAuth: true
    trustForIseAuth: true

- name: Delete by id
  cisco.ise.trusted_certificate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    id: string

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: {"authenticateBeforeCRLReceived": "string", "automaticCRLUpdate": "string", "automaticCRLUpdatePeriod": "string", "automaticCRLUpdateUnits": "string", "crlDistributionUrl": "string", "crlDownloadFailureRetries": "string", "crlDownloadFailureRetriesUnits": "string", "description": "string", "downloadCRL": "string", "enableOCSPValidation": "string", "enableServerIdentityCheck": "string", "expirationDate": "string", "friendlyName": "string", "id": "string", "ignoreCRLExpiration": "string", "internalCA": true, "isReferredInPolicy": true, "issuedBy": "string", "issuedTo": "string", "keySize": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "nonAutomaticCRLUpdatePeriod": "string", "nonAutomaticCRLUpdateUnits": "string", "rejectIfNoStatusFromOCSP": "string", "rejectIfUnreachableFromOCSP": "string", "selectedOCSPService": "string", "serialNumberDecimalFormat": "string", "sha256Fingerprint": "string", "signatureAlgorithm": "string", "status": "string", "subject": "string", "trustedFor": "string", "validFrom": "string"}
ise_update_response словарь добавлено в cisco.ise 1.1.0	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `{"response": {"id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "message": "string"}, "version": "string"}`

Ключ

Описание

ise_response

словарь

Словарь или список с ответом, возвращённым Cisco ISE Python SDK

Возвращается: всегда

Пример: {"authenticateBeforeCRLReceived": "string", "automaticCRLUpdate": "string", "automaticCRLUpdatePeriod": "string", "automaticCRLUpdateUnits": "string", "crlDistributionUrl": "string", "crlDownloadFailureRetries": "string", "crlDownloadFailureRetriesUnits": "string", "description": "string", "downloadCRL": "string", "enableOCSPValidation": "string", "enableServerIdentityCheck": "string", "expirationDate": "string", "friendlyName": "string", "id": "string", "ignoreCRLExpiration": "string", "internalCA": true, "isReferredInPolicy": true, "issuedBy": "string", "issuedTo": "string", "keySize": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "nonAutomaticCRLUpdatePeriod": "string", "nonAutomaticCRLUpdateUnits": "string", "rejectIfNoStatusFromOCSP": "string", "rejectIfUnreachableFromOCSP": "string", "selectedOCSPService": "string", "serialNumberDecimalFormat": "string", "sha256Fingerprint": "string", "signatureAlgorithm": "string", "status": "string", "subject": "string", "trustedFor": "string", "validFrom": "string"}

ise_update_response

словарь

добавлено в cisco.ise 1.1.0

Словарь или список с ответом, возвращённым Cisco ISE Python SDK

Возвращается: всегда

Пример: {"response": {"id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "message": "string"}, "version": "string"}

Авторы

Rafael Campos (@racampos)

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

© 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/trusted_certificate_module.html