community.general.idrac_redfish_info module – Gather PowerEdge server information through iDRAC using Redfish APIs

Note

This module is part of the community.general collection (version 10.7.3).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.idrac_redfish_info.

Synopsis
Parameters
Attributes
Examples
Return Values

Synopsis

Builds Redfish URIs locally and sends them to remote iDRAC controllers to get information back.
For use with Dell EMC iDRAC operations that require Redfish OEM extensions.

Parameters

Parameter	Comments
auth_token string added in community.general 2.3.0	Security token for authenticating to iDRAC.
baseuri string / required	Base URI of iDRAC.
ca_path path added in community.general 10.6.0	PEM formatted file that contains a CA certificate to be used for validation. Only used if `validate_certs=true`.
category string / required	Category to execute on iDRAC.
ciphers list / elements=string added in community.general 10.6.0	TLS/SSL Ciphers to use for the request. When a list is provided, all ciphers are joined in order with `:`. See the OpenSSL Cipher List Format for more details. The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions.
command list / elements=string / required	List of commands to execute on iDRAC. `GetManagerAttributes` returns the list of dicts containing iDRAC, LifecycleController and System attributes.
password string	Password for authenticating to iDRAC.
timeout integer	Timeout in seconds for HTTP requests to iDRAC. Default: `10`
username string	Username for authenticating to iDRAC.
validate_certs boolean added in community.general 10.6.0	If `false`, TLS/SSL certificates will not be validated. Set this to `true` to enable certificate checking. Should be used together with `ca_path`. Choices: `false` ← (default) `true`

Attributes

Attribute	Support	Description
check_mode	Support: full added in community.general 3.3.0 This action does not modify state.	Can run in `check_mode` and return changed status prediction without modifying target.
diff_mode	Support: N/A This action does not modify state.	Will return details on what has changed (or possibly needs changing in `check_mode`), when in diff mode.

Examples

- name: Get Manager attributes with a default of 20 seconds
  community.general.idrac_redfish_info:
    category: Manager
    command: GetManagerAttributes
    baseuri: "{{ baseuri }}"
    username: "{{ username }}"
    password: "{{ password }}"
    timeout: 20
  register: result

# Examples to display the value of all or a single iDRAC attribute
- name: Store iDRAC attributes as a fact variable
  ansible.builtin.set_fact:
    idrac_attributes: "{{ result.redfish_facts.entries | selectattr('Id', 'defined') | selectattr('Id', 'equalto', 'iDRACAttributes')
      | list | first }}"

- name: Display all iDRAC attributes
  ansible.builtin.debug:
    var: idrac_attributes

- name: Display the value of 'Syslog.1.SysLogEnable' iDRAC attribute
  ansible.builtin.debug:
    var: idrac_attributes['Syslog.1.SysLogEnable']

# Examples to display the value of all or a single LifecycleController attribute
- name: Store LifecycleController attributes as a fact variable
  ansible.builtin.set_fact:
    lc_attributes: "{{ result.redfish_facts.entries | selectattr('Id', 'defined') | selectattr('Id', 'equalto', 'LCAttributes')
      | list | first }}"

- name: Display LifecycleController attributes
  ansible.builtin.debug:
    var: lc_attributes

- name: Display the value of 'CollectSystemInventoryOnRestart' attribute
  ansible.builtin.debug:
    var: lc_attributes['LCAttributes.1.CollectSystemInventoryOnRestart']

# Examples to display the value of all or a single System attribute
- name: Store System attributes as a fact variable
  ansible.builtin.set_fact:
    system_attributes: "{{ result.redfish_facts.entries | selectattr('Id', 'defined') | selectattr('Id', 'equalto', 'SystemAttributes')
      | list | first }}"

- name: Display System attributes
  ansible.builtin.debug:
    var: system_attributes

- name: Display the value of 'PSRedPolicy'
  ansible.builtin.debug:
    var: system_attributes['ServerPwr.1.PSRedPolicy']

Return Values

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

Key	Description
msg dictionary	Different results depending on task. Returned: always Sample: `"List of Manager attributes"`

Authors

Jose Delarosa (@jose-delarosa)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/idrac_redfish_info_module.html