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 8.6.4).
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
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.
Aliases: remote_management.redfish.idrac_redfish_info
Parameters
Parameter |
Comments |
---|---|
Security token for authenticating to iDRAC. |
|
Base URI of iDRAC. |
|
Category to execute on iDRAC. |
|
List of commands to execute on iDRAC.
|
|
Password for authenticating to iDRAC. |
|
Timeout in seconds for HTTP requests to iDRAC. Default: |
|
Username for authenticating to iDRAC. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full added in community.general 3.3.0 This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
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 |
---|---|
different results depending on task Returned: always Sample: |