cisco.ise.support_bundle – Resource module for Support Bundle

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

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

New in version 1.0.0: of cisco.ise

Synopsis

  • Manage operation create of the resource Support Bundle.

Note

This module has a corresponding action plugin.

Requirements

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

  • ciscoisesdk >= 1.2.0

  • python >= 3.5

Parameters

Parameter Choices/Defaults Comments
description
string
Support Bundle's description.
hostName
string
This parameter is hostName only, xxxx of xxxx.yyy.zz.
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.
name
string
Resource Name.
supportBundleIncludeOptions
dictionary
Support Bundle's supportBundleIncludeOptions.
fromDate
string
Date from where support bundle should include the logs.
includeConfigDB
boolean
    Choices:
  • no
  • yes
Set to include Config DB in Support Bundle.
includeCoreFiles
boolean
    Choices:
  • no
  • yes
Set to include Core files in Support Bundle.
includeDebugLogs
boolean
    Choices:
  • no
  • yes
Set to include Debug logs in Support Bundle.
includeLocalLogs
boolean
    Choices:
  • no
  • yes
Set to include Local logs in Support Bundle.
includeSystemLogs
boolean
    Choices:
  • no
  • yes
Set to include System logs in Support Bundle.
mntLogs
boolean
    Choices:
  • no
  • yes
Set to include Monitoring and troublshooting logs in Support Bundle.
policyXml
boolean
    Choices:
  • no
  • yes
Set to include Policy XML in Support Bundle.
toDate
string
Date upto where support bundle should include the logs.

Notes

Note

  • Does not support check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco ISE SDK

  • The parameters starting with ise_ are used by the Cisco ISE Python SDK to establish the connection

See Also

See also

Support Bundle reference

Complete reference of the Support Bundle object model.

Examples

- 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

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:
{}


Authors

  • Rafael Campos (@racampos)