Spec-Zone.ru › Ansible

Модуль cisco.ise.system_certificate_create – Модуль ресурсов для создания сертификата системы

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: cisco.ise.system_certificate_create.

Добавлена в cisco.ise 1.0.0

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

Обзор

  • Управляет операцией создания ресурса Создание сертификата системы.
  • Этот API позволяет клиенту создать системный сертификат.

Примечание

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

Требования

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

  • ciscoisesdk >= 2.2.3
  • python >= 3.5

Параметры

Параметр

Комментарии

ersLocalCertStub

dictionary

Вводные данные для создания сертификата.

allowWildcardCerts

string

allowWildcardCerts для создания системного сертификата.

certificatePolicies

string

certificatePolicies для создания системного сертификата.

certificateSanDns

string

certificateSanDns для создания системного сертификата.

certificateSanIp

string

certificateSanIp для создания системного сертификата.

certificateSanUri

string

certificateSanUri для создания системного сертификата.

digest

string

digest для создания системного сертификата.

ersSubjectStub

dictionary

Данные владельца сертификата.

commonName

string

commonName для создания системного сертификата.

countryName

string

countryName для создания системного сертификата.

localityName

string

localityName для создания системного сертификата.

organizationalUnitName

string

organizationalUnitName для создания системного сертификата.

organizationName

string

organizationName для создания системного сертификата.

stateOrProvinceName

string

stateOrProvinceName для создания системного сертификата.

expirationTTL

integer

expirationTTL для создания системного сертификата.

friendlyName

string

friendlyName для создания системного сертификата.

groupTagDD

string

groupTagDD для создания системного сертификата.

keyLength

string

keyLength для создания системного сертификата.

keyType

string

keyType для создания системного сертификата.

samlCertificate

string

samlCertificate для создания системного сертификата.

selectedExpirationTTLUnit

string

selectedExpirationTTLUnit для создания системного сертификата.

xgridCertificate

string

xgridCertificate для создания системного сертификата.

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

целое число

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

Время ожидания (в секундах) для RESTful HTTP-запросов.

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

ise_username

строка / обязательно

Имя пользователя Identity Services Engine для аутентификации.

ise_uses_api_gateway

логическое значение

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

Флаг, который сообщает SDK, использовать ли шлюз API Identity Services Engine для отправки запросов.

Если значение истинно, используется шлюз API ISE, и запросы отправляются на https://{{ise_hostname}}.

Если значение ложно, запросы отправляются на https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid).

Варианты:

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

ise_uses_csrf_token

логическое значение

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

Флаг, который сообщает SDK, отправлять ли токен CSRF в API ERS ISE.

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

Если значение истинно, предполагается, что SDK должен автоматически управлять токеном CSRF.

Варианты:

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

ise_verify

логическое значение

Флаг для включения или отключения проверки сертификата SSL.

Варианты:

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

ise_version

строка

Сообщает SDK, какую версию Identity Services Engine использовать.

По умолчанию: "3.1_Patch_1"

ise_wait_on_rate_limit

логическое значение

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

Варианты:

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

nodeId

строка

Идентификатор узла приложения Cisco ISE.

Примечания

Примечание

  • Используемые методы SDK — system_certificate.SystemCertificate.create_system_certificate,
  • Используемые пути — post /ers/config/systemcertificate,
  • Не поддерживает check_mode
  • Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
  • Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

Примеры

- name: Create
  cisco.ise.system_certificate_create:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    ersLocalCertStub:
      allowWildcardCerts: string
      certificatePolicies: string
      certificateSanDns: string
      certificateSanIp: string
      certificateSanUri: string
      digest: string
      ersSubjectStub:
        commonName: string
        countryName: string
        localityName: string
        organizationName: string
        organizationalUnitName: string
        stateOrProvinceName: string
      expirationTTL: 0
      friendlyName: string
      groupTagDD: string
      keyLength: string
      keyType: string
      samlCertificate: string
      selectedExpirationTTLUnit: string
      xgridCertificate: string
    nodeId: string

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

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

Ключ

Описание

ise_response

словарь

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

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

Пример: {}

Авторы

  • 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_create_module.html

Spec-Zone.ru

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