ansible.builtin.idrac_redfish_config (v2.9.27) — module

Manages servers through iDRAC using Dell Redfish APIs

| "added in version" 2.8 of ansible.builtin"

Authors: Jose Delarosa (@jose-delarosa)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

For use with Dell iDRAC operations that require Redfish OEM extensions

Builds Redfish URIs locally and sends them to remote iDRAC controllers to set or update a configuration attribute.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Enable NTP in iDRAC
    idrac_redfish_config:
      category: Manager
      command: SetManagerAttributes
      manager_attribute_name: NTPConfigGroup.1.NTPEnable
      manager_attribute_value: Enabled
      baseuri: "{{ baseuri }}"
      username: "{{ username}}"
      password: "{{ password }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Set NTP server 1 to {{ ntpserver1 }} in iDRAC
    idrac_redfish_config:
      category: Manager
      command: SetManagerAttributes
      manager_attribute_name: NTPConfigGroup.1.NTP1
      manager_attribute_value: "{{ ntpserver1 }}"
      baseuri: "{{ baseuri }}"
      username: "{{ username}}"
      password: "{{ password }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Set Timezone to {{ timezone }} in iDRAC
    idrac_redfish_config:
      category: Manager
      command: SetManagerAttributes
      manager_attribute_name: Time.1.Timezone
      manager_attribute_value: "{{ timezone }}"
      baseuri: "{{ baseuri }}"
      username: "{{ username}}"
      password: "{{ password }}"

Inputs

    
baseuri:
    description:
    - Base URI of iDRAC
    required: true
    type: str

command:
    description:
    - List of commands to execute on iDRAC
    required: true
    type: list

timeout:
    default: 10
    description:
    - Timeout in seconds for URL requests to iDRAC controller
    type: int

category:
    description:
    - Category to execute on iDRAC
    required: true
    type: str

password:
    description:
    - Password for authentication with iDRAC
    required: true
    type: str

username:
    description:
    - User for authentication with iDRAC
    required: true
    type: str

manager_attribute_name:
    default: 'null'
    description:
    - name of iDRAC attribute to update
    required: false
    type: str

manager_attribute_value:
    default: 'null'
    description:
    - value of iDRAC attribute to update
    required: false
    type: str

Outputs

msg:
  description: Message with action result or error description
  returned: always
  sample: Action was successful
  type: str