dellemc.openmanage.idrac_lifecycle_controller_logs – Export Lifecycle Controller logs to a network share or local path.

Note

This plugin is part of the dellemc.openmanage collection (version 3.6.0).

To install it use: ansible-galaxy collection install dellemc.openmanage.

To use it in a playbook, specify: dellemc.openmanage.idrac_lifecycle_controller_logs.

New in version 2.1.0: of dellemc.openmanage

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

  • python >= 2.7.5

Parameters

Parameter Choices/Defaults Comments
idrac_ip
string / required
iDRAC IP Address.
idrac_password
string / required
iDRAC user password.

aliases: idrac_pwd
idrac_port
integer
Default:
443
iDRAC port.
idrac_user
string / required
iDRAC username.
job_wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for the running job completion or not.
share_name
string / required
Network share or local path.
CIFS, NFS network share types are supported.
share_password
string
Network share user password. This option is mandatory for CIFS Network Share.

aliases: share_pwd
share_user
string
Network share user in the format '[email protected]' or 'domain\user' if user is part of a domain else 'user'. This option is mandatory for CIFS Network Share.

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 EMC iDRAC.

  • 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"
    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"
    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"
    share_name: "/example/export_lc"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
error_info
dictionary
on HTTP error
Details of the 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.'}}
lc_logs_status
dictionary
success
Status of the export operation along with job details and file path.

Sample:
{'ElapsedTimeSinceCompletion': '0', 'InstanceID': 'JID_274774785395', 'JobStartTime': 'NA', 'JobStatus': 'Completed', 'JobUntilTime': 'NA', 'Message': 'LCL Export was successful', 'MessageArguments': 'NA', 'MessageID': 'LC022', 'Name': 'LC Export', 'PercentComplete': '100', 'Status': 'Success', 'file': '192.168.0.0:/nfsfileshare/190.168.0.1_20210728_133437_LC_Log.log', 'retval': True}
msg
string
always
Status of the export lifecycle controller logs job.

Sample:
Successfully exported the lifecycle controller logs.


Authors

  • Rajeev Arakkal (@rajeevarakkal)

  • Anooja Vardhineni (@anooja-vardhineni)