dellemc.openmanage.idrac_lifecycle_controller_logs module – Export Lifecycle Controller logs to a network share or local path.
Note
This module is part of the dellemc.openmanage collection (version 8.5.0).
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_lifecycle_controller_logs
.
New in dellemc.openmanage 2.1.0
Synopsis
Export Lifecycle Controller logs to a given network share or local path.
Requirements
The below requirements are needed on the host that executes this module.
omsdk >= 1.2.488
python >= 3.9.6
Parameters
Parameter |
Comments |
---|---|
The Privacy Enhanced Mail (PEM) file that contains a CA certificate to be used for the validation. |
|
iDRAC IP Address. |
|
iDRAC user password. |
|
iDRAC port. Default: |
|
iDRAC username. |
|
Whether to wait for the running job completion or not. Choices:
|
|
Network share or local path. CIFS, NFS network share types are supported. |
|
Network share user password. This option is mandatory for CIFS Network Share. |
|
Network share user in the format ‘user@domain’ or ‘domain\user’ if user is part of a domain else ‘user’. This option is mandatory for CIFS Network Share. |
|
The socket level timeout in seconds. Default: |
|
If Configure Prior to collection version Choices:
|
Notes
Note
This module requires ‘Administrator’ privilege for idrac_user.
Exporting data to a local share is supported only on iDRAC9-based PowerEdge Servers and later.
Run this module from a system that has direct access to Dell iDRAC.
This module supports both IPv4 and IPv6 address for idrac_ip.
This module does not support
check_mode
.
Examples
---
- name: Export lifecycle controller logs to NFS share.
dellemc.openmanage.idrac_lifecycle_controller_logs:
idrac_ip: "190.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
share_name: "192.168.0.0:/nfsfileshare"
- name: Export lifecycle controller logs to CIFS share.
dellemc.openmanage.idrac_lifecycle_controller_logs:
idrac_ip: "190.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
share_name: "\\\\192.168.0.2\\share"
share_user: "share_user_name"
share_password: "share_user_pwd"
- name: Export lifecycle controller logs to LOCAL path.
dellemc.openmanage.idrac_lifecycle_controller_logs:
idrac_ip: "190.168.0.1"
idrac_user: "user_name"
idrac_password: "user_password"
ca_path: "/path/to/ca_cert.pem"
share_name: "/example/export_lc"
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: |
|
Status of the export operation along with job details and file path. Returned: success Sample: |
|
Status of the export lifecycle controller logs job. Returned: always Sample: |
Authors
Rajeev Arakkal (@rajeevarakkal)
Anooja Vardhineni (@anooja-vardhineni)