dellemc.openmanage.idrac_system_erase module – Erase system and storage components of the server
Note
This module is part of the dellemc.openmanage collection (version 9.7.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 dellemc.openmanage.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: dellemc.openmanage.idrac_system_erase.
New in dellemc.openmanage 9.7.0
Synopsis
This module allows you to erase system components such as iDRAC, BIOS, DIAG, and so forth. You can also erase storage components such as PERC NV cache, non-volatile memory, cryptographic erase of physical disks, and so on of the server
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
List of system and storage components that can be deleted. The following are the supported components. AllApps BIOS CryptographicErasePD DIAG DPU DrvPack IDRAC LCData NonVolatileMemory OverwritePD PERCNVCache ReinstallFW vFlash |
|
iDRAC IP Address. |
|
iDRAC user password. If the password is not provided, then the environment variable Example: export IDRAC_PASSWORD=password |
|
iDRAC port. Default: |
|
iDRAC username. If the username is not provided, then the environment variable Example: export IDRAC_USERNAME=username |
|
Whether to wait till completion of the job. This is applicable when power_on is
Choices:
|
|
The maximum wait time of job_wait in seconds. The job is tracked only for this duration. This option is applicable when job_wait is Default: |
|
This parameter allows you to power on the server after the erase operation is completed. This is applicable when job_wait is
Choices:
|
|
Manager ID of the iDRAC. |
|
The socket level timeout in seconds. Default: |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export IDRAC_X_AUTH_TOKEN=x_auth_token |
Attributes
Attribute |
Support |
Description |
|---|---|---|
Support: full |
Runs task to validate without performing action on the target machine. |
|
Support: none |
Runs the task to report the changes made or to be made. |
Notes
Note
Run this module from a system that has direct access to Dell iDRAC.
This module supports only iDRAC9 and above.
This module supports IPv4 and IPv6 addresses.
Examples
---
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Details of the HTTP Error. Returned: On HTTP error Sample: |
|
Returns the output for status of the job. Returned: For system erase operation Sample: |
|
Status of the component system erase operation. Returned: always Sample: |