Spec-Zone.ru › Ansible

Модуль cisco.ise.system_certificate — Модуль ресурсов для сертификата системы

Примечание

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

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

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

Для использования в книге задач укажите: cisco.ise.system_certificate.

Новое в cisco.ise 1.0.0

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

Обзор

  • Управление операциями обновления и удаления ресурса «Сертификат системы».
  • Этот API удаляет сертификат системы определенного узла на основе заданного имени хоста и идентификатора.
  • Обновление сертификата системы.

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5
END_OF_DOCUMENT_MARKER

Параметры

Параметр

Комментарии

admin

boolean

Использовать сертификат для аутентификации в портале администратора Cisco ISE.

Варианты:

  • false
  • true

allowPortalTagTransferForSameSubject

boolean

Разрешить перезапись тега портала из совпадающего сертификата с тем же субъектом.

Варианты:

  • false
  • true

allowReplacementOfPortalGroupTag

boolean

Разрешить замену тега группы портала (обязательно).

Варианты:

  • false
  • true

allowRoleTransferForSameSubject

boolean

Разрешить передачу ролей для сертификата с совпадающим субъектом.

Варианты:

  • false
  • true

allowWildcardDelete

boolean

Если данный сертификат, подлежащий удалению, является сертификатом с подстановочным знаком, соответствующий сертификат удаляется и на остальных узлах в развертывании.

Варианты:

  • false
  • true

description

string

Описание системного сертификата.

eap

boolean

Использовать сертификат для протоколов EAP, использующих туннелирование SSL/TLS.

Варианты:

  • false
  • true

expirationTTLPeriod

integer

expirationTTLPeriod системного сертификата.

expirationTTLUnits

string

expirationTTLUnits системного сертификата.

hostName

string

Параметр пути HostName. Имя узла, сертификат которого необходимо обновить.

id

string

Параметр пути Id. ID системного сертификата, который необходимо обновить.

ims

boolean

Использовать сертификат для службы обмена сообщениями Cisco ISE.

Варианты:

  • false
  • true

ise_debug

boolean

Флаг для Identity Services Engine SDK для включения отладки.

Варианты:

  • false ← (по умолчанию)
  • 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 ← (по умолчанию)

ise_uses_csrf_token

boolean

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

Флаг, который информирует SDK о необходимости отправки токена CSRF в API ERS ISE.

Если это True, SDK предполагает, что проверка CSRF вашего ISE включена.

Если это True, предполагается, что вам необходимо, чтобы SDK автоматически управлял токеном CSRF.

Варианты:

  • false ← (по умолчанию)
  • 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

Имя сертификата.

portal

boolean

Использовать для портала.

Варианты:

  • false
  • true

portalGroupTag

string

Установить тег группы.

pxgrid

boolean

Использовать сертификат для контроллера pxGrid.

Варианты:

  • false
  • true

radius

boolean

Использовать сертификат для сервера RADSec.

Варианты:

  • false
  • true

renewSelfSignedCertificate

boolean

Обновить самоподписанный сертификат.

Варианты:

  • false
  • true

saml

boolean

Использовать сертификат для подписи SAML.

Варианты:

  • false
  • true

Примечания

Примечание

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

См. также

См. также

Документация Cisco ISE по сертификатам

Полное описание API сертификатов.

Примеры

- name: Update by id
  cisco.ise.system_certificate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    admin: true
    allowPortalTagTransferForSameSubject: true
    allowReplacementOfPortalGroupTag: true
    allowRoleTransferForSameSubject: true
    description: string
    eap: true
    expirationTTLPeriod: 0
    expirationTTLUnits: string
    hostName: string
    id: string
    ims: true
    name: string
    portal: true
    portalGroupTag: string
    pxgrid: true
    radius: true
    renewSelfSignedCertificate: true
    saml: true

- name: Delete by id
  cisco.ise.system_certificate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: absent
    allowWildcardDelete: true
    hostName: string
    id: string

Возвращаемые значения

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

Ключ

Описание

ise_response

словарь

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

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

Пример: {"expirationDate": "string", "friendlyName": "string", "groupTag": "string", "id": "string", "issuedBy": "string", "issuedTo": "string", "keySize": 0, "link": {"href": "string", "rel": "string", "type": "string"}, "portalsUsingTheTag": "string", "selfSigned": true, "serialNumberDecimalFormat": "string", "sha256Fingerprint": "string", "signatureAlgorithm": "string", "usedBy": "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", "status": "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/system_certificate_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API