Модуль cisco.ise.endpoint_certificate — Модуль ресурсов для сертификата конечной точки

Примечание

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

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

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

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

Новое в cisco.ise 1.0.0

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

Обзор

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

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
certificateRequest словарь	Словарь значений. Должны быть указаны записи CN и SAN.
cn строка	Соответствует имени пользователя запрашивающего, если запрашивающий не является администратором ERS. Администраторы ERS могут создавать запросы для любого CN.
san строка	Действительный MAC-адрес, разделенный дефисами.
certTemplateName строка	Имя шаблона внутренней CA.
dirPath строка	Абсолютный путь к каталогу. По умолчанию — текущий рабочий каталог.
filename строка	Имя файла для сохранения загружаемого файла.
format строка	Допустимые значения: PKCS12, PKCS12_CHAIN, PKCS8, PKCS8_CHAIN.
ise_debug логическое	Флаг для включения отладки в Identity Services Engine SDK. Выбор: `false` ← (по умолчанию) `true`
ise_hostname строка / обязательно	Имя хоста Identity Services Engine.
ise_password строка / обязательно	Пароль для аутентификации в 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 для отправки запросов. Если True, используется шлюз API ISE, и запросы отправляются по адресу https://{{ise_hostname}}. Если False, запросы отправляются по адресу https://{{ise_hostname}}:{{port}}, где значение порта зависит от используемой службы (ERS, Mnt, UI, PxGrid). Выбор: `false` `true` ← (по умолчанию)
ise_uses_csrf_token логическое добавлено в cisco.ise 3.0.0	Флаг, указывающий SDK, отправлять ли токен CSRF в API ERS ISE. Если True, SDK предполагает, что проверка CSRF в вашем ISE включена. Если True, предполагается, что вам нужен SDK для автоматического управления токеном CSRF. Выбор: `false` ← (по умолчанию) `true`
ise_verify логическое	Флаг для включения или отключения проверки сертификата SSL. Выбор: `false` `true` ← (по умолчанию)
ise_version строка	Указывает SDK, какую версию Identity Services Engine использовать. По умолчанию: `"3.1_Patch_1"`
ise_wait_on_rate_limit логическое	Флаг для включения автоматической обработки лимита скорости в Identity Services Engine SDK. Выбор: `false` `true` ← (по умолчанию)
password строка	Защищает закрытый ключ. Должен содержать более 8 символов, менее 15 символов, по крайней мере одну заглавную букву, по крайней мере одну строчную букву, по крайней мере одну цифру и может содержать только символы A-Za-z0-9_#.
saveFile логическое	Включить или отключить автоматическое создание файла с необработанным ответом. Выбор: `false` `true`

Примечания

Примечание

Используемый метод SDK — endpoint_certificate.EndpointCertificate.create_endpoint_certificate,
Используемые пути — put /ers/config/endpointcert/certRequest,
Не поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

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

Примеры

- name: Create
  cisco.ise.endpoint_certificate:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    certTemplateName: string
    certificateRequest:
      cn: string
      san: string
    dirPath: /tmp/downloads/
    filename: download_filename.extension
    format: string
    password: string
    saveFile: true

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

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

Ключ	Описание
ise_response словарь	Словарь или список со значением, возвращённым Python SDK Cisco ISE Возвращается: всегда Пример: `{"data": "filecontent", "dirpath": "download/directory", "filename": "filename", "path": "download/directory/filename"}`

Авторы

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/endpoint_certificate_module.html