cisco.ise.support_bundle_status_info – Information module for Support Bundle Status

Note

This plugin is part of the cisco.ise collection (version 1.2.0).

To install it use: ansible-galaxy collection install cisco.ise.

To use it in a playbook, specify: cisco.ise.support_bundle_status_info.

New in version 1.0.0: of cisco.ise

Synopsis

• Get all Support Bundle Status.

• Get Support Bundle Status by id.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• ciscoisesdk >= 1.1.0

• python >= 3.5

Parameters

Parameter	Choices/Defaults	Comments
id string		Id path parameter.
ise_debug boolean	Choices: no ← yes	Flag for Identity Services Engine SDK to enable debugging.
ise_hostname string / required		The Identity Services Engine hostname.
ise_password string / required		The Identity Services Engine password to authenticate.
ise_username string / required		The Identity Services Engine username to authenticate.
ise_uses_api_gateway boolean added in 1.1.0 of cisco.ise	Choices: no yes ←	Flag that informs the SDK whether to use the Identity Services Engine's API Gateway to send requests. If it is true, it uses the ISE's API Gateway and sends requests to https://{{ise_hostname}}. If it is false, it sends the requests to https://{{ise_hostname}}:{{port}}, where the port value depends on the Service used (ERS, Mnt, UI, PxGrid).
ise_verify boolean	Choices: no yes ←	Flag to enable or disable SSL certificate verification.
ise_version string	Default: "3.1.0"	Informs the SDK which version of Identity Services Engine to use.
ise_wait_on_rate_limit boolean	Choices: no yes ←	Flag for Identity Services Engine SDK to enable automatic rate-limit handling.
page integer		Page query parameter. Page number.
size integer		Size query parameter. Number of objects returned per page.

Notes

Note

• Supports check_mode

See Also

See also

Support Bundle Status reference

Complete reference of the Support Bundle Status object model.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
ise_response dictionary	always	A dictionary or list with the response returned by the Cisco ISE Python SDK Sample: { "id": "string", "name": "string", "description": "string", "fileName": "string", "fileSize": "string", "hostName": "string", "message": "string", "startTime": "string", "status": "string", "link": { "rel": "string", "href": "string", "type": "string" } }
ise_responses list / elements=dictionary added in 1.1.0 of cisco.ise	always	A dictionary or list with the response returned by the Cisco ISE Python SDK Sample: [ { "id": "string", "name": "string", "description": "string", "link": { "rel": "string", "href": "string", "type": "string" } } ]

Authors

• Rafael Campos (@racampos)