cisco.ise.support_bundle 模块 – 支持包资源模块

注意

此模块是 cisco.ise 集合 (版本 2.9.6) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.ise。您需要其他要求才能使用此模块，请参阅要求获取详细信息。

要在 playbook 中使用它，请指定：cisco.ise.support_bundle。

cisco.ise 1.0.0 中的新增功能

概要 

管理资源支持包的创建操作。
此 API 允许客户端创建支持包触发器配置。

注意

此模块具有相应的操作插件。

要求 

执行此模块的主机需要以下要求。

ciscoisesdk >= 2.2.3
python >= 3.5

参数 

参数	注释
description 字符串	支持包的描述。
hostName 字符串	此参数仅为 hostName，xxxx of 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 是否使用 Identity Services Engine 的 API 网关发送请求的标志。如果为 true，则使用 ISE 的 API 网关并将请求发送到 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 令牌发送到 ISE 的 ERS API 的标志。如果为 True，则 SDK 假设您的 ISE CSRF 检查已启用。如果为 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 字典	支持包的 supportBundleIncludeOptions。
fromDate 字符串	支持包应包含日志的起始日期。
includeConfigDB 布尔值	设置为在支持包中包含 Config DB。选项 `false` `true`
includeCoreFiles 布尔值	设置为在支持包中包含核心文件。选项 `false` `true`
includeDebugLogs 布尔值	设置为在支持包中包含调试日志。选项 `false` `true`
includeLocalLogs 布尔值	设置为在支持包中包含本地日志。选项 `false` `true`
includeSystemLogs 布尔值	设置为在支持包中包含系统日志。选项 `false` `true`
mntLogs 布尔值	设置为在支持包中包含监控和故障排除日志。选项 `false` `true`
policyXml 布尔值	设置为在支持包中包含策略 XML。选项 `false` `true`
toDate 字符串	支持包应包含日志的结束日期。

备注 

注意

使用的 SDK 方法是 support_bundle_trigger_configuration.SupportBundleTriggerConfiguration.create_support_bundle，
使用的路径是 post /ers/config/supportbundle，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco ISE SDK 中的嵌入式连接管理器
以 ise_ 开头的参数由 Cisco ISE Python SDK 用于建立连接

另请参见 

另请参见

有关 SupportBundleTriggerConfiguration 的 Cisco ISE 文档: SupportBundleTriggerConfiguration API 的完整参考。

示例 

- 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)