Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.ise.certificate_profile.

Новое в cisco.ise 1.0.0

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

Описание

  • Управление операциями создания и обновления ресурса «Профиль сертификата».
  • Этот API позволяет клиенту создавать профиль сертификата.
  • Этот API позволяет клиенту обновлять профиль сертификата.

Примечание

У этого модуля есть соответствующий плагин действия.

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

allowedAsUserName

boolean

Флаг allowedAsUserName.

Варианты:

  • false
  • true

certificateAttributeName

string

Имя атрибута Профиля сертификата — используется только при выборе CERTIFICATE в usernameFrom. Допустимые значения — SUBJECT_COMMON_NAME — SUBJECT_ALTERNATIVE_NAME — SUBJECT_SERIAL_NUMBER — SUBJECT — SUBJECT_ALTERNATIVE_NAME_OTHER_NAME — SUBJECT_ALTERNATIVE_NAME_EMAIL — SUBJECT_ALTERNATIVE_NAME_DNS. — Дополнительное внутреннее значение ALL_SUBJECT_AND_ALTERNATIVE_NAMES используется автоматически, когда usernameFrom=UPN.

description

string

Описание профиля сертификата.

externalIdentityStoreName

string

Имя хранилища идентификаторов, на которое ссылается профиль сертификата, или не применимо, если хранилище идентификаторов не выбрано.

id

string

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

ise_debug

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

ise_hostname

string / обязательно

Имя хоста Identity Services Engine.

ise_password

string / обязательно

Пароль Identity Services Engine для аутентификации.

ise_single_request_timeout

integer

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

Таймаут (в секундах) для запросов RESTful HTTP.

По умолчанию: 60

ise_username

string / обязательно

Имя пользователя 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 ← (по умолчанию)

matchMode

string

Режим сопоставления профиля сертификата. Допустимые значения — NEVER — RESOLVE_IDENTITY_AMBIGUITY — BINARY_COMPARISON.

name

string

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

usernameFrom

string

Атрибут в сертификате, из которого следует извлекать имя пользователя. Допустимые значения — CERTIFICATE (для конкретного атрибута, определенного в certificateAttributeName) — UPN (для использования любых атрибутов Subject или Alternative Name в сертификате — опция только для AD).

Примечания

Примечание

  • Используемые методы SDK: certificate_profile.CertificateProfile.create_certificate_profile, certificate_profile.CertificateProfile.update_certificate_profile_by_id,
  • Используемые пути: post /ers/config/certificateprofile, put /ers/config/certificateprofile/{id},
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Python SDK Cisco ISE для установления подключения

Примеры

- name: Update by id
  cisco.ise.certificate_profile:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    allowedAsUserName: true
    certificateAttributeName: string
    description: string
    externalIdentityStoreName: string
    id: string
    matchMode: string
    name: string
    usernameFrom: string

- name: Create
  cisco.ise.certificate_profile:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    state: present
    allowedAsUserName: true
    certificateAttributeName: string
    description: string
    externalIdentityStoreName: string
    id: string
    matchMode: string
    name: string
    usernameFrom: string

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

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

Ключ

Описание

ise_response

словарь

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

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

Пример: {"allowedAsUserName": true, "certificateAttributeName": "string", "description": "string", "externalIdentityStoreName": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "matchMode": "string", "name": "string", "usernameFrom": "string"}

ise_update_response

словарь

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

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

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

Пример: {"UpdatedFieldsList": {"updatedField": [{"field": "string", "newValue": "string", "oldValue": "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/certificate_profile_module.html

Spec-Zone.ru

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