Try SpotterExport technical support logs(TSR) to network share location
| "added in version" 3.6.0 of dellemc.openmanage"
Authors: Felix Stephen (@felixs88), Sachin Apagundi(@sachin-apa)
Install with ansible-galaxy collection install dellemc.openmanage:==9.1.0
collections:
- name: dellemc.openmanage
version: 9.1.0This 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.
---
- 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
port:
default: 443
description: OpenManage Enterprise or OpenManage Enterprise Modular HTTPS port.
type: int
ca_path:
description:
- The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for
the validation.
type: path
version_added: 5.0.0
version_added_collection: dellemc.openmanage
timeout:
default: 30
description: The socket level timeout in seconds.
type: int
version_added: 5.0.0
version_added_collection: dellemc.openmanage
hostname:
description: OpenManage Enterprise or OpenManage Enterprise Modular IP address or
hostname.
required: true
type: str
job_wait:
default: true
description:
- Whether to wait for the Job completion or not.
- The maximum wait time is I(job_wait_timeout).
type: bool
log_type:
choices:
- application
- support_assist_collection
- supportassist_collection
default: support_assist_collection
description:
- C(application) is applicable for OpenManage Enterprise Modular to export the application
log bundle.
- C(support_assist_collection) and C(supportassist_collection) is applicable for one
or more devices to export SupportAssist logs.
- C(support_assist_collection) and C(supportassist_collection) supports both OpenManage
Enterprise and OpenManage Enterprise Modular.
- C(support_assist_collection) and C(supportassist_collection) does not support export
of C(OS_LOGS) from OpenManage Enterprise. If tried to export, the tasks will complete
with errors, and the module fails.
type: str
password:
description:
- OpenManage Enterprise or OpenManage Enterprise Modular password.
- If the password is not provided, then the environment variable C(OME_PASSWORD) is
used.
- 'Example: export OME_PASSWORD=password'
required: true
type: str
username:
description:
- OpenManage Enterprise or OpenManage Enterprise Modular username.
- If the username is not provided, then the environment variable C(OME_USERNAME) is
used.
- 'Example: export OME_USERNAME=username'
required: true
type: str
device_ids:
description:
- List of target device IDs.
- This is applicable for C(support_assist_collection) and C(supportassist_collection)
logs.
- This option is mutually exclusive with I(device_service_tags) and I(device_group_name).
elements: int
type: list
share_name:
description:
- Network share path.
- Filename is auto generated and should not be provided as part of I(share_name).
required: true
type: str
share_type:
choices:
- NFS
- CIFS
description: Network share type
required: true
type: str
share_user:
description:
- Network share username.
- This option is applicable for C(CIFS) of I(share_type).
type: str
share_domain:
description:
- Network share domain name.
- This option is applicable for C(CIFS) if I(share_type).
type: str
log_selectors:
choices:
- OS_LOGS
- RAID_LOGS
- DEBUG_LOGS
description:
- 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.
- C(OS_LOGS) to collect OS Logs.
- C(RAID_LOGS) to collect RAID controller logs.
- C(DEBUG_LOGS) to collect Debug logs.
- This option is applicable only for C(support_assist_collection) and C(supportassist_collection)
of I(log_type).
elements: str
type: list
share_address:
description: Network share IP address.
required: true
type: str
share_password:
description:
- Network share password
- This option is applicable for C(CIFS) of I(share_type).
type: str
validate_certs:
default: true
description:
- If C(false), the SSL certificates will not be validated.
- Configure C(false) only on personally controlled sites where self-signed certificates
are used.
- Prior to collection version C(5.0.0), the I(validate_certs) is C(false) by default.
type: bool
version_added: 5.0.0
version_added_collection: dellemc.openmanage
test_connection:
default: false
description:
- Test the availability of the network share location.
- I(job_wait) and I(job_wait_timeout) options are not applicable for I(test_connection).
type: bool
job_wait_timeout:
default: 60
description:
- The maximum wait time of I(job_wait) in minutes.
- This option is applicable I(job_wait) is true.
type: int
device_group_name:
description:
- Name of the device group to export C(support_assist_collection) or C(supportassist_collection)
logs of all devices within the group.
- This is applicable for C(support_assist_collection) and C(supportassist_collection)
logs.
- This option is not applicable for OpenManage Enterprise Modular.
- This option is mutually exclusive with I(device_ids) and I(device_service_tags).
type: str
lead_chassis_only:
default: false
description:
- Extract the logs from Lead chassis only.
- I(lead_chassis_only) is only applicable when I(log_type) is C(application) on OpenManage
Enterprise Modular.
type: bool
device_service_tags:
description:
- List of target identifier.
- This is applicable for C(support_assist_collection) and C(supportassist_collection)
logs.
- This option is mutually exclusive with I(device_ids) and I(device_group_name).
elements: str
type: list
mask_sensitive_info:
default: false
description:
- 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 C(application) of I(log_type).
type: bool
error_info:
description: Details of the HTTP Error.
returned: on HTTP error
sample:
error:
'@Message.ExtendedInfo':
- Message: Unable to process the request because an error occurred.
MessageArgs: []
MessageId: GEN1234
RelatedProperties: []
Resolution: Retry the operation. If the issue persists, contact your system
administrator.
Severity: Critical
code: Base.1.0.GeneralError
message: A general error has occurred. See ExtendedInfo for more information.
type: dict
jog_status:
description: Details of the export log operation status.
returned: success
sample:
Builtin: false
CreatedBy: root
Editable: true
EndTime: None
Id: 12778
JobDescription: Export device log
JobName: Export Log
JobStatus:
Id: 2080
Name: New
JobType:
Id: 18
Internal: false
Name: DebugLogs_Task
LastRun: '2021-07-06 10:52:50.519'
LastRunStatus:
Id: 2060
Name: Completed
NextRun: None
Params:
- JobId: 12778
Key: maskSensitiveInfo
Value: 'FALSE'
- JobId: 12778
Key: password
Value: tY86w7q92u0QzvykuF0gQQ
- JobId: 12778
Key: userName
Value: administrator
- JobId: 12778
Key: shareName
Value: iso
- JobId: 12778
Key: OPERATION_NAME
Value: EXTRACT_LOGS
- JobId: 12778
Key: shareType
Value: CIFS
- JobId: 12778
Key: shareAddress
Value: 100.96.32.142
Schedule: startnow
StartTime: None
State: Enabled
Targets:
- Data: ''
Id: 10053
JobId: 12778
TargetType:
Id: 1000
Name: DEVICE
UpdatedBy: None
UserGenerated: true
Visible: true
type: dict
msg:
description: Overall status of the export log.
returned: always
sample: Export log job completed successfully.
type: str