dellemc.openmanage.idrac_support_assist 模块 – 运行和导出 iDRAC SupportAssist 收集日志

注意

此模块是 dellemc.openmanage 集合（版本 9.9.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install dellemc.openmanage。您需要进一步的要求才能使用此模块，请参阅要求获取详细信息。

要在剧本中使用它，请指定：dellemc.openmanage.idrac_support_assist。

dellemc.openmanage 9.6.0 中的新增功能

概要 

此模块允许您在 iDRAC 上运行和导出 SupportAssist 收集日志。

要求 

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

python >= 3.9.6

参数 

参数	注释
accept_eula 布尔值	此参数接受 SupportAssist 注册所需的 EULA 条款和条件。如果 EULA 条款和条件未被接受，则无法运行或导出 SupportAssist 收集。选择 `false` `true`
ca_path 路径在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
data_collector 列表 / 元素=字符串	此选项提供了在 SupportAssist 收集中保留的数据的选择。系统信息默认在 SupportAssist 集合中可用。 `hardware_data`，SupportAssist 收集包括与硬件相关的数据。 `storage_logs`，SupportAssist 收集包括与存储设备相关的日志。 `os_app_data`，SupportAssist 收集包括与操作系统和应用程序相关的数据。 `debug_logs`，SupportAssist 收集包括与调试相关的日志。 `telemetry_reports`，SupportAssist 收集包括与遥测相关的报告。 `gpu_logs`，SupportAssist 收集包括与 GPU 相关的日志。选择 `"hardware_data"` `"storage_logs"` `"os_app_data"` `"debug_logs"` `"telemetry_reports"` `"gpu_logs"`
export 布尔值	将 SupportAssist 收集导出到给定的网络共享。此操作需要 share_parameters。选择 `false` `true` ←（默认）
filter_data 布尔值	此选项提供了选择过滤数据以保护隐私的选项。它不包括主机名、MAC 地址、热数据、日志或注册表内容。选择 `false` ←（默认） `true`
idrac_ip 字符串 / 必填	iDRAC IP 地址。
idrac_password 别名：idrac_pwd 字符串	iDRAC 用户密码。如果未提供密码，则使用环境变量 `IDRAC_PASSWORD`。示例：export IDRAC_PASSWORD=password
idrac_port 整数	iDRAC 端口。默认值： `443`
idrac_user 字符串	iDRAC 用户名。如果未提供用户名，则使用环境变量 `IDRAC_USERNAME`。示例：export IDRAC_USERNAME=username
job_wait 布尔值	此选项确定是否等待作业完成。选择 `false` `true` ←（默认）
job_wait_timeout 整数	等待作业完成的时间（以秒为单位）。当 job_wait 为 `true` 时适用。默认值： `3600`
resource_id 字符串	资源的 ID。如果未提供资源 ID 的值，则模块从 iDRAC 返回的系统资源列表中选取第一个可用的资源 ID。
run 布尔值	根据 iDRAC 上集合中不同类型的日志运行 SupportAssist 作业。选择 `false` `true` ←（默认）
share_parameters 字典	SupportAssist 收集导出操作所需的参数。当export为`true`时，必须提供share_parameters。
ignore_certificate_warning 字符串	连接到网络共享时忽略证书警告，仅当share_type为`https`时适用。 `on` 表示忽略证书警告。 `off` 表示不忽略证书警告。选择 `"off"` ← (默认) `"on"`
ip_address 字符串	网络共享的 IP 地址。当share_type为`nfs`、`cifs`、`http`或`https`时，必须提供ip_address。当share_type为`local`时，不需要提供ip_address。
password 字符串	网络共享的密码。当share_type为`cifs`时，必须提供password。
proxy_password 字符串	代理服务器的密码。 proxy_password仅当share_type为`http`或`https`且proxy_support为`parameters_proxy`时适用。
proxy_port 整数	代理服务器的端口。 proxy_port仅当share_type为`http`或`https`且proxy_support为`parameters_proxy`时适用。默认值： `80`
proxy_server 字符串	代理服务器的 IP 地址。当proxy_support为`parameters_proxy`时，必须提供proxy_server。 proxy_server仅当share_type为`http`或`https`且proxy_support为`parameters_proxy`时适用。
proxy_support 字符串	指定是否必须使用代理支持。 `off` 表示不使用代理设置。 `default_proxy` 表示使用默认的代理设置。 `parameters_proxy` 表示使用指定的代理设置。当proxy_support为`parameters_proxy`时，必须提供proxy_server。 proxy_support仅当share_type为`http`或`https`时适用。选择 `"off"` ← (默认) `"default_proxy"` `"parameters_proxy"`
proxy_type 字符串	代理服务器的代理类型。 `http` 表示选择 HTTP 代理。 `socks` 表示选择 SOCKS 代理。 proxy_type仅当share_type为`http`或`https`且proxy_support为`parameters_proxy`时适用。选择 `"http"` ← (默认) `"socks"`
proxy_username 字符串	代理服务器的用户名。 proxy_username仅当share_type为`http`或`https`且proxy_support为`parameters_proxy`时适用。
share_name 字符串	网络共享路径或导出 SupportAssist 收集文件的目录的完整本地路径。当share_type为`local`时，默认路径将为当前目录
share_type 字符串	网络共享的共享类型。 `local` 表示为export操作使用本地路径。 `nfs` 表示为export操作使用 NFS 共享。 `cifs` 表示为export操作使用 CIFS 共享。 `http` 表示为export操作使用 HTTP 共享。 `https` 表示为export操作使用 HTTPS 共享。 `ftp` 表示为export操作使用 FTP 共享。选择 `"local"` ← (默认) `"nfs"` `"cifs"` `"http"` `"https"` `"ftp"`
username 字符串	网络共享的用户名。当share_type为`cifs`时，必须提供username。
workgroup 字符串	网络共享的工作组。 workgroup仅当share_type为`cifs`时适用。
timeout 整数在 dellemc.openmanage 5.0.0 中添加	套接字级别的超时时间（以秒为单位）。默认值： `30`
validate_certs 布尔值在 dellemc.openmanage 5.0.0 中添加	如果为`false`，则不会验证 SSL 证书。仅在个人控制的使用自签名证书的站点上配置为`false`。在收集版本`5.0.0`之前，validate_certs默认为`false`。选择 `false` `true` ←（默认）
x_auth_token 字符串在 dellemc.openmanage 9.3.0 中添加	身份验证令牌。如果未提供 x_auth_token，则将使用环境变量`IDRAC_X_AUTH_TOKEN`。示例：export IDRAC_X_AUTH_TOKEN=x_auth_token

属性 

属性	支持	描述
check_mode	支持：完整	运行任务以进行验证，而不在目标计算机上执行操作。

说明 

注意

从可以直接访问 Dell iDRAC 的系统运行此模块。
此模块仅支持 iDRAC9 及更高版本。
此模块支持 IPv4 和 IPv6 地址。
当run和export为true时，share_type的local才适用。
当run和 (export) 操作的share_type为local时，job_wait 不适用。

示例 

---
- name: Accept the EULA and run and export the SupportAssist Collection to local path
  dellemc.openmanage.idrac_support_assist:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    accept_eula: true
    ca_path: "path/to/ca_file"
    data_collector: ["debug_logs", "hardware_data", "os_app_data", "storage_logs"]
    share_parameters:
      share_type: "local"
      share_path: "/opt/local/support_assist_collections/"

- name: Run the SupportAssist Collection with with custom data_to_collect with filter_data
  dellemc.openmanage.idrac_support_assist:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "path/to/ca_file"
    export: false
    filter_data: true
    data_collector: ["debug_logs", "hardware_data"]

- name: Run and export the SupportAssist Collection to HTTPS share
  dellemc.openmanage.idrac_support_assist:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "path/to/ca_file"
    data_collector: ["hardware_data"]
    share_parameters:
      share_type: "HTTPS"
      ignore_certificate_warning: "on"
      share_name: "/share_path/support_assist_collections"
      ip_address: "192.168.0.2"

- name: Run and export the SupportAssist Collection to NFS share
  dellemc.openmanage.idrac_support_assist:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "path/to/ca_file"
    data_collector: ["debug_logs"]
    share_parameters:
      share_type: "NFS"
      share_name: "nfsshare/support_assist_collections/"
      ip_address: "192.168.0.3"

- name: Export the last SupportAssist Collection to CIFS share
  dellemc.openmanage.idrac_support_assist:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "path/to/ca_file"
    run: false
    share_parameters:
      share_type: "NFS"
      share_name: "/cifsshare/support_assist_collections/"
      ip_address: "192.168.0.4"

- name: Export the last SupportAssist Collection to HTTPS share via proxy
  dellemc.openmanage.idrac_support_assist:
    hostname: "192.168.0.1"
    username: "username"
    password: "password"
    ca_path: "path/to/ca_file"
    run: false
    share_parameters:
      share_type: "HTTPS"
      share_name: "/share_path/support_assist_collections"
      ignore_certificate_warning: "on"
      ip_address: "192.168.0.2"
      proxy_support: parameters_proxy
      proxy_type: http
      proxy_server: "192.168.0.5"
      proxy_port: 1080
      proxy_username: "proxy_user"
      proxy_password: "proxy_password"

返回值 

常见的返回值在此处记录这里，以下是此模块特有的字段

键	描述
error_info 字典	HTTP 错误的详细信息。返回：在 HTTP 错误时示例： {"error": {"@Message.ExtendedInfo": [{"Message": "由于未接受 SupportAssist 最终用户许可协议 (EULA)，无法启动该操作。", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "IDRAC.2.8.SRV085", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "通过导航到 iDRAC GUI 上的 SupportAssist 页面来接受 SupportAssist 最终用户许可协议 (EULA)。", "Severity": "Warning"}], "code": "Base.1.12.GeneralError", "message": "发生一般错误。有关更多信息，请参见 ExtendedInfo。"}}
job_details 字典	返回作业状态的输出。返回：对于运行和导出操作示例： {"ActualRunningStartTime": "2024-07-08T01:50:54", "ActualRunningStopTime": "2024-07-08T01:56:45", "CompletionTime": "2024-07-08T01:56:45", "Description": "作业实例", "EndTime": null, "Id": "JID_XXXXXXXXXXXX", "JobState": "已完成", "JobType": "SACollectExportHealthData", "Message": "SupportAssist 收集和传输操作已成功完成。", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "SRV088", "Name": "SupportAssist 收集", "PercentComplete": 100, "StartTime": "2024-07-08T01:50:54", "TargetSettingsURI": null}
msg 字符串	SupportAssist 操作的状态。返回：总是示例： `"成功运行并导出了 SupportAssist 收集。"`

作者

Shivam Sharma(@ShivamSh3)