Модуль cisco.ise.system_certificate_export_info – Модуль информации для экспорта сертификата системы

Примечание

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

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

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

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

Новая в cisco.ise 1.0.0

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

Описание

Получение информации об экспорте сертификата системы.
Экспорт сертификата системы.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
dirPath строка	Абсолютный путь к каталогу. По умолчанию используется текущий рабочий каталог.
export строка	Экспорт информации о экспорте сертификата системы.
filename строка	Имя файла для сохранения загружаемого файла.
hostName строка	Имя хоста узла Cisco ISE, на котором должен быть сгенерирован самозаверяющий сертификат.
id строка	Идентификатор информации об экспорте сертификата системы.
ise_debug логическое значение	Флаг для включения отладки SDK Identity Services Engine. Варианты: `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 для отправки запросов. Если значение истинно, используется шлюз 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 логическое значение	Флаг для включения автоматической обработки лимитов запросов в Identity Services Engine SDK. Варианты: `false` `true` ← (по умолчанию)
password строка	Пароль для информации об экспорте сертификата системы.
saveFile логическое значение	Включить или отключить автоматическое создание файла с сырым ответом. Варианты: `false` `true`

Примечания

Примечание

Используемые методы SDK: certificates.Certificates.export_system_certificate,
Используемые пути:
Поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления соединения

См. также

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

Примеры

- name: Create
  cisco.ise.system_certificate_export_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    dirPath: /tmp/downloads/
    export: string
    filename: download_filename.extension
    hostName: string
    id: string
    password: string
    saveFile: true

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

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `{"description": "string", "file": "string", "filename": "string", "inputStream": {}, "open": true, "readable": true, "uri": "string", "url": "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_export_info_module.html