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

Note

This plugin is part of the dellemc.openmanage collection (version 3.0.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
Requirements
Parameters
Notes
Examples
Return Values

Synopsis

Export Lifecycle Controller logs to a given network share.

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	no yes ←	Whether to wait for the running job completion or not.
share_name string / required		Network share path.
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 'user@domain' or 'domain\user' if user is part of a domain else 'user'. This option is mandatory for CIFS Network Share.

Notes

Note

Run this module from a system that has direct access to DellEMC iDRAC.
This module does not support check_mode.

Examples

---
- name: Export Lifecycle Controller Logs
  dellemc.openmanage.idrac_lifecycle_controller_logs:
       idrac_ip:   "190.168.0.1"
       idrac_user: "user_name"
       idrac_password:  "user_password"
       idrac_port:  443
       share_name: "192.168.0.0:/nfsfileshare"
       share_user: "share_user_name"
       share_password:  "share_user_pwd"
       job_wait: True

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. Sample: {'msg': {'Message': 'File exported successfully!!', 'Status': 'Success'}}
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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/dellemc/openmanage/idrac_lifecycle_controller_logs_module.html