dellemc.openmanage.idrac_lifecycle_controller_status_info – Get the status of the Lifecycle Controller

From Get docs
Ansible/docs/2.11/collections/dellemc/openmanage/idrac lifecycle controller status info module


dellemc.openmanage.idrac_lifecycle_controller_status_info – Get the status of the Lifecycle Controller

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_status_info.


New in version 2.1.0: of dellemc.openmanage


Synopsis

  • This module shows the status of the Lifecycle Controller on a Dell EMC PowerEdge server.

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.



Notes

Note

  • Run this module from a system that has direct access to DellEMC iDRAC.
  • This module supports check_mode.


Examples

---
- name: Show status of the Lifecycle Controller
  dellemc.openmanage.idrac_lifecycle_controller_status_info:
    idrac_ip: "192.168.0.1"
    idrac_user: "user_name"
    idrac_password: "user_password"

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_status_info

dictionary

success

Displays the status of the Lifecycle Controller on a Dell EMC PowerEdge server.


Sample:

{'msg': {'LCReady': True, 'LCStatus': 'Ready'}}

msg

string

always

Overall status of fetching lifecycle controller status.


Sample:

Successfully fetched the lifecycle controller status.




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_status_info_module.html