community.general.wdc_redfish_info (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 get information back.

Usage examples

Scanned by Steampunk Spotter

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

- name: Get Simple Update Status with individual IOMs specified
  community.general.wdc_redfish_info:
    category: Update
    command: SimpleUpdateStatus
    ioms:
      - iom1.wdc.com
      - iom2.wdc.com
    username: "{{ username }}"
    password: "{{ password }}"
  register: result

Scanned by Steampunk Spotter

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

- name: Print fetched information
  ansible.builtin.debug:
    msg: "{{ result.redfish_facts.simple_update_status.entries | to_nice_json }}"

Scanned by Steampunk Spotter

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

- name: Get Simple Update Status with baseuri specified
  community.general.wdc_redfish_info:
    category: Update
    command: SimpleUpdateStatus
    baseuri: "iom1.wdc.com"
    username: "{{ username }}"
    password: "{{ password }}"
  register: result

Scanned by Steampunk Spotter

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

- name: Print fetched information
  ansible.builtin.debug:
    msg: "{{ result.redfish_facts.simple_update_status.entries | to_nice_json }}"

Inputs

    
ioms:
    description:
    - List of IOM FQDNs for the enclosure.  Must include this or O(baseuri).
    elements: str
    type: list

baseuri:
    description:
    - Base URI of OOB controller.  Must include this or O(ioms).
    type: str

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

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

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

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

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

auth_token:
    description:
    - Security token for authentication with OOB controller.
    type: str

Outputs

Description:
  description: Firmware update status description.
  returned: always
  sample: Ready for FW update
  type: str
ErrorCode:
  description: Numeric error code for firmware update status.  Non-zero indicates
    an error condition.
  returned: always
  sample: 0
  type: int
EstimatedRemainingMinutes:
  description: Estimated number of minutes remaining in firmware update operation.
  returned: always
  sample: 20
  type: int
StatusCode:
  description: Firmware update status code.
  returned: always
  sample: 2
  type: int