dellemc.openmanage.idrac_system_erase 模块 – 擦除服务器的系统和存储组件

注意

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

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

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

要在 playbook 中使用它，请指定：dellemc.openmanage.idrac_system_erase。

dellemc.openmanage 9.7.0 中的新增功能

概要 

此模块允许您擦除 iDRAC、BIOS、DIAG 等系统组件。您还可以擦除服务器的存储组件，例如 PERC NV 缓存、非易失性内存、物理磁盘的加密擦除等

要求 

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

python >= 3.9.6

参数 

参数	注释
ca_path 路径在 dellemc.openmanage 5.0.0 中添加	包含用于验证的 CA 证书的隐私增强邮件 (PEM) 文件。
component list / elements=string / 必需	可以删除的系统和存储组件列表。以下是支持的组件。 AllApps BIOS CryptographicErasePD DIAG DPU DrvPack IDRAC LCData NonVolatileMemory OverwritePD PERCNVCache ReinstallFW vFlash
idrac_ip string / 必需	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 布尔值	是否等待作业完成。当 power_on 为 `true` 时适用。 `true` 等待作业完成。 `false` 不等待作业完成。选项 `false` `true` ← (默认)
job_wait_timeout 整数	job_wait 的最大等待时间（以秒为单位）。仅在此期间跟踪作业。当 job_wait 为 `true` 时，此选项适用。默认值： `1200`
power_on 布尔值	此参数允许您在擦除操作完成后打开服务器电源。当 job_wait 为 `true` 时适用。 `true` 打开服务器电源。 `false` 不打开服务器电源。选项 `false` ← (默认) `true`
resource_id 字符串	iDRAC 的管理器 ID。
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	支持：完整	运行任务以进行验证，而无需在目标计算机上执行操作。
diff_mode	支持：无	运行任务以报告已进行或将要进行的更改。

注释 

注意

从可以直接访问戴尔 iDRAC 的系统运行此模块。
此模块仅支持 iDRAC9 及更高版本。
此模块支持 IPv4 和 IPv6 地址。

示例 

---
- name: Erase a single component and power on the server
  dellemc.openmanage.idrac_system_erase:
    idrac_ip: 198.162.0.1
    idrac_user: username
    idrac_password: passw0rd
    ca_path: "/path/to/ca_cert.pem"
    component: ["BIOS"]
    power_on: true

- name: Erase multiple components and do not power on the server after the erase operation is completed
  dellemc.openmanage.idrac_system_erase:
    idrac_ip: 198.162.0.1
    idrac_user: username
    idrac_password: passw0rd
    ca_path: "/path/to/ca_cert.pem"
    component: ["BIOS", "DIAG", "PERCNVCache"]

- name: Erase multiple components and do not wait for the job completion
  dellemc.openmanage.idrac_system_erase:
    idrac_ip: 198.162.0.1
    idrac_user: username
    idrac_password: passw0rd
    ca_path: "/path/to/ca_cert.pem"
    component: ["IDRAC", "DPU", "LCData"]
    job_wait: false

返回值 

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

键	描述
error_info 字典	HTTP 错误的详细信息。返回: 发生 HTTP 错误时示例: {"error": {"@Message.ExtendedInfo": [{"Message": "无法完成操作，因为属性Component的输入值NonVolatileMemor不在可接受值的列表中。", "MessageArgs": ["NonVolatileMemor", "Component"], "MessageArgs@odata.count": 2, "MessageId": "IDRAC.2.9.SYS426", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "从Redfish服务支持的枚举列表中输入一个有效值，然后重试操作。有关有效值的信息，请参阅支持站点上提供的iDRAC用户指南。", "Severity": "Warning"}, {"Message": "属性 Component 的值 'NonVolatileMemor' 不在可接受值的列表中。", "MessageArgs": ["NonVolatileMemor", "Component"], "MessageArgs@odata.count": 2, "MessageId": "Base.1.12.PropertyValueNotInList", "RelatedProperties": [], "RelatedProperties@odata.count": 0, "Resolution": "从实现可以支持的枚举列表中选择一个值，如果操作失败，请重新提交请求。", "Severity": "Warning"}], "code": "Base.1.12.GeneralError", "message": "发生了一般错误。有关更多信息，请参阅 ExtendedInfo"}}
job_details 字典	返回作业状态的输出。返回: 用于系统擦除操作示例: `{"ActualRunningStartTime": null, "ActualRunningStopTime": null, "CompletionTime": "2024-08-06T19:55:01", "Description": "作业实例", "EndTime": "TIME_NA", "Id": "JID_229917427823", "JobState": "Completed", "JobType": "SystemErase", "Message": "作业已成功完成。", "MessageArgs": [], "MessageArgs@odata.count": 0, "MessageId": "SYS018", "Name": "System_Erase", "PercentComplete": 100, "StartTime": "2024-08-06T19:49:02", "TargetSettingsURI": null}`
msg 字符串	组件系统擦除操作的状态。返回: 始终示例: `"成功完成系统擦除操作。"`

作者

Rajshekar P(@rajshekarp87)