dellemc.openmanage.idrac_support_assist module – Run and Export iDRAC SupportAssist collection logs
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_support_assist.
New in dellemc.openmanage 9.6.0
Synopsis
This module allows you to run and export SupportAssist collection logs on iDRAC.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.9.6
Parameters
Parameter |
Comments |
|---|---|
This parameter accepts the EULA terms and conditions that are required for SupportAssist registration. If EULA terms and conditions are not accepted, then the SupportAssist collection cannot be run or exported. Choices:
|
|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
This option provides the choice of data to keep in SupportAssist collection. System Information is available in on the SupportAssist collection by default.
Choices:
|
|
Exports the SupportAssist collection to the given network share. This operation requires share_parameters. Choices:
|
|
This option provides the choice to filter data for privacy. It does not include hostname, MAC address, thermal data, logs, or registry content. 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 |
|
This option determines whether to wait for the job completion or not. Choices:
|
|
Time in seconds to wait for job completion. This is applicable when job_wait is Default: |
|
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 that are returned by the iDRAC. |
|
Run the SupportAssist job based on the different types of logs in the collection on iDRAC. Choices:
|
|
Parameters that are required for the export operation of SupportAssist collection. share_parameters is required when export is |
|
Ignores the certificate warning when connecting to the network share and is only applicable when share_type is
Choices:
|
|
IP address of the network share. ip_address is required when share_type is ip_address is not 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 path or full local path of the directory for exporting the SupportAssist collection file. The default path will be current directory when share_type is |
|
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 |
Attributes
Attribute |
Support |
Description |
|---|---|---|
Support: full |
Runs task to validate without performing action on the target machine. |
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.
localfor share_type is applicable only when run and export istrue.When share_type is
localfor run and (export) operation, then job_wait is not applicable.
Examples
---
- 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"
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 run and export operations Sample: |
|
Status of the SupportAssist operation. Returned: always Sample: |