Модуль cisco.ise.support_bundle_status_info – Модуль информации о статусе пакета поддержки

Примечание

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

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

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

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

Новая функция в cisco.ise 1.0.0

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

Обзор

Получить все статусы пакетов поддержки.
Получить статус пакета поддержки по идентификатору.
Этот API позволяет клиенту получить статус пакета поддержки по идентификатору.
Этот API позволяет клиенту получить все статусы пакетов поддержки.

Примечание

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

Требования

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

ciscoisesdk >= 2.2.3
python >= 3.5

Параметры

Параметр	Комментарии
id строка	Параметр пути идентификатора.
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` ← (по умолчанию)
page целое число	Параметр запроса страницы. Номер страницы.
size целое число	Параметр запроса размера. Количество объектов, возвращаемых на страницу.

Примечания

Примечание

Используемые методы SDK: support_bundle_status.SupportBundleStatus.get_support_bundle_status_by_id, support_bundle_status.SupportBundleStatus.get_support_bundle_status_generator,
Используемые пути: get /ers/config/supportbundlestatus, get /ers/config/supportbundlestatus/{id},
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco ISE SDK
Параметры, начинающиеся с ise_, используются Python SDK Cisco ISE для установления подключения

Примеры

- name: Get all Support Bundle Status
  cisco.ise.support_bundle_status_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    page: 1
    size: 20
  register: result

- name: Get Support Bundle Status by id
  cisco.ise.support_bundle_status_info:
    ise_hostname: "{{ise_hostname}}"
    ise_username: "{{ise_username}}"
    ise_password: "{{ise_password}}"
    ise_verify: "{{ise_verify}}"
    id: string
  register: result

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

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

Ключ	Описание
ise_response словарь	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `{"description": "string", "fileName": "string", "fileSize": 0, "hostName": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "message": "string", "name": "string", "startTime": "string", "status": "string"}`
ise_responses список / элементы=словарь добавлен в cisco.ise 1.1.0	Словарь или список с ответом, возвращённым Cisco ISE Python SDK Возвращается: всегда Пример: `"[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"fileName\": \"string\",\n \"fileSize\": 0,\n \"hostName\": \"string\",\n \"message\": \"string\",\n \"startTime\": \"string\",\n \"status\": \"string\",\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"`

Ключ

Описание

ise_response

словарь

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

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

Пример: {"description": "string", "fileName": "string", "fileSize": 0, "hostName": "string", "id": "string", "link": {"href": "string", "rel": "string", "type": "string"}, "message": "string", "name": "string", "startTime": "string", "status": "string"}

ise_responses

список / элементы=словарь

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

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

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

Пример: "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"fileName\": \"string\",\n \"fileSize\": 0,\n \"hostName\": \"string\",\n \"message\": \"string\",\n \"startTime\": \"string\",\n \"status\": \"string\",\n \"link\": {\n \"rel\": \"string\",\n \"href\": \"string\",\n \"type\": \"string\"\n }\n }\n]\n"

Авторы

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_status_info_module.html