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

Примечание

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

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

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

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

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

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

Обзор

Управление операцией создания ресурса Пакета поддержки.
Этот API позволяет клиенту создавать конфигурацию триггера для создания пакета поддержки.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
description строка	Описание пакета поддержки.
hostName строка	Этот параметр — только имя хоста, xxxx из xxxx.yyy.zz.
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` ← (по умолчанию)
name строка	Имя ресурса.
supportBundleIncludeOptions словарь	Параметры включения пакета поддержки.
fromDate строка	Дата, с которой пакет поддержки должен включать журналы.
includeConfigDB логический	Включить БД конфигурации в пакет поддержки. Варианты: `false` `true`
includeCoreFiles логический	Включить основные файлы в пакет поддержки. Варианты: `false` `true`
includeDebugLogs логический	Включить отладочные журналы в пакет поддержки. Варианты: `false` `true`
includeLocalLogs логический	Включить локальные журналы в пакет поддержки. Варианты: `false` `true`

includeSystemLogs boolean	Установить для включения системных журналов в пакет поддержки. Варианты: `false` `true`
mntLogs boolean	Установить для включения журналов мониторинга и устранения неполадок в пакет поддержки. Варианты: `false` `true`
policyXml boolean	Установить для включения XML-политики в пакет поддержки. Варианты: `false` `true`
toDate string	Дата до которой пакет поддержки должен включать журналы.

Примечания

Примечание

Используемые методы SDK: support_bundle_trigger_configuration.SupportBundleTriggerConfiguration.create_support_bundle,
Используемые пути: post /ers/config/supportbundle,
Не поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Cisco ISE Python SDK для установления подключения

См. также

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

Примеры

- name: Create
  cisco.ise.support_bundle:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    description: string
    hostName: string
    name: string
    supportBundleIncludeOptions:
      fromDate: string
      includeConfigDB: true
      includeCoreFiles: true
      includeDebugLogs: true
      includeLocalLogs: true
      includeSystemLogs: true
      mntLogs: true
      policyXml: true
      toDate: 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/support_bundle_module.html