dellemc.openmanage.ome_diagnostics module – Export technical support logs(TSR) to network share location
Note
This module is part of the dellemc.openmanage collection (version 9.12.3).
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.ome_diagnostics.
New in dellemc.openmanage 3.6.0
Synopsis
This module allows to export SupportAssist collection logs from OpenManage Enterprise and OpenManage Enterprise Modular and application logs from OpenManage Enterprise Modular to a CIFS or NFS share.
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. |
|
Name of the device group to export This is applicable for This option is not applicable for OpenManage Enterprise Modular. This option is mutually exclusive with device_ids and device_service_tags. |
|
List of target device IDs. This is applicable for This option is mutually exclusive with device_service_tags and device_group_name. |
|
List of target identifier. This is applicable for This option is mutually exclusive with device_ids and device_group_name. |
|
OpenManage Enterprise or OpenManage Enterprise Modular IP address or hostname. |
|
Whether to wait for the Job completion or not. The maximum wait time is job_wait_timeout. Choices:
|
|
The maximum wait time of job_wait in minutes. This option is applicable job_wait is true. Default: |
|
Extract the logs from Lead chassis only. lead_chassis_only is only applicable when log_type is Choices:
|
|
By default, the SupportAssist logs contain only hardware logs. To collect additional logs such as OS logs, RAID logs or Debug logs, specify the log types to be collected in the choices list. If the log types are not specified, only the hardware logs are exported.
This option is applicable only for Choices:
|
|
Choices:
|
|
Select this option to mask the personal identification information such as IPAddress, DNS, alert destination, email, gateway, inet6, MacAddress, netmask etc. This option is applicable for Choices:
|
|
OpenManage Enterprise or OpenManage Enterprise Modular password. If the password is not provided, then the environment variable Example: export OME_PASSWORD=password |
|
OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port. Default: |
|
Network share IP address. |
|
Network share domain name. This option is applicable for |
|
Network share path. Filename is auto generated and should not be provided as part of share_name. |
|
Network share password This option is applicable for |
|
Network share type Choices:
|
|
Network share username. This option is applicable for |
|
Test the availability of the network share location. job_wait and job_wait_timeout options are not applicable for test_connection. Choices:
|
|
The socket level timeout in seconds. Default: |
|
OpenManage Enterprise or OpenManage Enterprise Modular username. If the username is not provided, then the environment variable Example: export OME_USERNAME=username |
|
If Configure Prior to collection version Choices:
|
|
Authentication token. If the x_auth_token is not provided, then the environment variable Example: export OME_X_AUTH_TOKEN=x_auth_token |
Notes
Note
Run this module from a system that has direct access to OpenManage Enterprise.
This module performs the test connection and device validations. It does not create a job for copying the logs in check mode and always reports as changes found.
This module supports
check_mode.
Examples
---
- name: Export application log using CIFS share location
dellemc.openmanage.ome_diagnostics:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
share_type: CIFS
share_address: "192.168.0.2"
share_user: share_username
share_password: share_password
share_name: cifs_share
log_type: application
mask_sensitive_info: false
test_connection: true
- name: Export application log using NFS share location
dellemc.openmanage.ome_diagnostics:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
share_address: "192.168.0.3"
share_type: NFS
share_name: nfs_share
log_type: application
mask_sensitive_info: true
test_connection: true
- name: Export SupportAssist log using CIFS share location
dellemc.openmanage.ome_diagnostics:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
share_address: "192.168.0.3"
share_user: share_username
share_password: share_password
share_name: cifs_share
share_type: CIFS
log_type: support_assist_collection
device_ids: [10011, 10022]
log_selectors: [OS_LOGS]
test_connection: true
- name: Export SupportAssist log using NFS share location
dellemc.openmanage.ome_diagnostics:
hostname: "192.168.0.1"
username: "username"
password: "password"
ca_path: "/path/to/ca_cert.pem"
share_address: "192.168.0.3"
share_type: NFS
share_name: nfs_share
log_type: support_assist_collection
device_group_name: group_name
test_connection: true
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: |
|
Details of the export log operation status. Returned: success Sample: |
|
Overall status of the export log. Returned: always Sample: |
Authors
Felix Stephen (@felixs88)
Sachin Apagundi(@sachin-apa)