community.general.idrac_redfish_command (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

  - name: Create BIOS configuration job (schedule BIOS setting update)
    community.general.idrac_redfish_command:
      category: Systems
      command: CreateBiosConfigJob
      resource_id: System.Embedded.1
      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.
    elements: str
    required: true
    type: list

timeout:
    default: 10
    description:
    - Timeout in seconds for HTTP requests to iDRAC.
    type: int

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

password:
    description:
    - Password for authenticating to iDRAC.
    type: str

username:
    description:
    - Username for authenticating to iDRAC.
    type: str

auth_token:
    description:
    - Security token for authenticating to iDRAC.
    type: str
    version_added: 2.3.0
    version_added_collection: community.general

resource_id:
    description:
    - ID of the System, Manager or Chassis to modify.
    required: false
    type: str
    version_added: 0.2.0
    version_added_collection: community.general

Outputs

msg:
  description: Message with action result or error description
  returned: always
  sample: Action was successful
  type: str
return_values:
  description: Dictionary containing command-specific response data from the action.
  returned: on success
  sample:
    job_id: /redfish/v1/Managers/iDRAC.Embedded.1/Jobs/JID_471269252011
  type: dict
  version_added: 6.6.0
  version_added_collection: community.general