dellemc.openmanage.idrac_diagnostics module – Run and Export iDRAC diagnostics
Note
This module is part of the dellemc.openmanage collection (version 9.8.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_diagnostics
.
New in dellemc.openmanage 9.0.0
Synopsis
This module allows you to run and export diagnostics on iDRAC.
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. |
|
Exports the diagnostics information to the given share. This operation requires share_parameters. When run is Choices:
|
|
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 |
|
Provides the option to wait for job completion. This is applicable when run is This is applicable only to run the diagnostics job. Choices:
|
|
Time in seconds to wait for job completion. This is applicable when job_wait is Default: |
|
This option provides the choice to reboot the host immediately to run the diagnostics. This is applicable when run is
Choices:
|
|
Id of the resource. If the value for resource ID is not provided, the module picks the first resource ID available from the list of system resources returned by the iDRAC. |
|
Run the diagnostics job on iDRAC. Run the diagnostics job based on the run_mode and save the report in the internal storage. reboot_type is applicable. Choices:
|
|
This option provides the choices to run the diagnostics.
Choices:
|
|
Run the diagnostic until the specified end date and end time after the scheduled_start_time. The accepted formats are yyyymmddhhmmss and YYYY-MM-DDThh:mm:ss+HH:MM. If the run operation does not complete before the specified end time, then the operation fails. This is applicable when run is |
|
Schedules the job at the specified time. The accepted formats are yyyymmddhhmmss and YYYY-MM-DDThh:mm:ss+HH:MM. This is applicable when run is |
|
Parameters that are required for the export operation of diagnostics. share_parameters is required when export is |
|
Diagnostics file name for export operation. |
|
Ignores the certificate warning while connecting to Share and is only applicable when share_type is
Choices:
|
|
IP address of the network share. ip_address is required when share_type is |
|
Password of the network share. password is required when share_type is |
|
The password of the proxy server. proxy_password is only applicable when share_type is |
|
The port of the proxy server. proxy_port is only applicable when share_type is Default: |
|
The IP address of the proxy server. proxy_server is required when proxy_support is proxy_server is only applicable when share_type is |
|
Specifies if proxy support must be used or not.
proxy_support is only applicable when share_type is Choices:
|
|
The proxy type of the proxy server.
proxy_type is only applicable when share_type is Choices:
|
|
The username of the proxy server. proxy_username is only applicable when share_type is |
|
Network share or local path of the diagnostics file. |
|
Share type of the network share.
Choices:
|
|
Username of the network share. username is required when share_type is |
|
Workgroup of the network share. workgroup is applicable only when share_type is |
|
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 |
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.
This module supports
check_mode
.This module requires ‘Dell Diagnostics’ firmware package to be present on the server.
When share_type is
local
for export operation, job_details are not displayed.
Examples
---
- name: Run and export the diagnostics to local path
dellemc.openmanage.idrac_diagnostics:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "path/to/ca_file"
run: true
export: true
share_parameters:
share_type: "local"
share_path: "/opt/local/diagnostics/"
file_name: "diagnostics.txt"
- name: Run the diagnostics with power cycle reboot on schedule
dellemc.openmanage.idrac_diagnostics:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "path/to/ca_file"
run: true
run_mode: "express"
reboot_type: "power_cycle"
scheduled_start_time: 20240101101015
- name: Run and export the diagnostics to HTTPS share
dellemc.openmanage.idrac_diagnostics:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "path/to/ca_file"
run: true
export: true
share_parameters:
share_type: "HTTPS"
ignore_certificate_warning: "on"
share_name: "/share_path/diagnostics_collection_path"
ip_address: "192.168.0.2"
file_name: "diagnostics.txt"
- name: Run and export the diagnostics to NFS share
dellemc.openmanage.idrac_diagnostics:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "path/to/ca_file"
run: true
export: true
share_parameters:
share_type: "NFS"
share_name: "nfsshare/diagnostics_collection_path/"
ip_address: "192.168.0.3"
file_name: "diagnostics.txt"
- name: Export the diagnostics to CIFS share
dellemc.openmanage.idrac_diagnostics:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "path/to/ca_file"
export: true
share_parameters:
share_type: "CIFS"
share_name: "/cifsshare/diagnostics_collection_path/"
ip_address: "192.168.0.4"
file_name: "diagnostics.txt"
- name: Export the diagnostics to HTTPS share via proxy
dellemc.openmanage.idrac_diagnostics:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "path/to/ca_file"
export: true
share_parameters:
share_type: "HTTPS"
share_name: "/share_path/diagnostics_collection_path"
ignore_certificate_warning: "on"
ip_address: "192.168.0.2"
file_name: "diagnostics.txt"
proxy_support: parameters_proxy
proxy_type: http
proxy_server: "192.168.0.5"
proxy_port: 1080
proxy_username: "proxy_user"
proxy_password: "proxy_password"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Returns the full path of the diagnostics file. Returned: For export operation Sample: |
|
Details of the HTTP Error. Returned: on HTTP error Sample: |
|
Returns the output for status of the job. Returned: For run and export operations Sample: |
|
Status of the diagnostics operation. Returned: always Sample: |