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

Manages Out-Of-Band controllers using iDRAC OEM 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

Builds Redfish URIs locally and sends them to remote OOB controllers to perform an action.

For use with Dell iDRAC operations that require Redfish OEM extensions

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
  - name: Create BIOS configuration job (schedule BIOS setting update)
    idrac_redfish_command:
      category: Systems
      command: CreateBiosConfigJob
      baseuri: "{{ baseuri }}"
      username: "{{ username }}"
      password: "{{ password }}"

Inputs

    
baseuri:
    description:
    - Base URI of OOB controller
    required: true
    type: str

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

timeout:
    default: 10
    description:
    - Timeout in seconds for URL requests to OOB controller
    type: int
    version_added: '2.8'
    version_added_collection: ansible.builtin

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

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

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

Outputs

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