redfish_command - Manages Out-Of-Band controllers using Redfish APIs

• Synopsis
• Parameters
• Examples
• Return Values
• Status
• Maintenance
  • Author

Synopsis

• Builds Redfish URIs locally and sends them to remote OOB controllers to perform an action.
• Manages OOB controller ex. reboot, log management.
• Manages OOB controller users ex. add, remove, update.
• Manages system power ex. on, off, graceful and forced reboot.

Parameters

Examples

- name: Restart system power gracefully
  redfish_command:
    category: Systems
    command: PowerGracefulRestart
    baseuri: "{{ baseuri }}"
    user: "{{ user }}"
    password: "{{ password }}"

- name: Set one-time boot device to {{ bootdevice }}
  redfish_command:
    category: Systems
    command: SetOneTimeBoot
    bootdevice: "{{ bootdevice }}"
    baseuri: "{{ baseuri }}"
    user: "{{ user }}"
    password: "{{ password }}"

- name: Add and enable user
  redfish_command:
    category: Accounts
    command: AddUser,EnableUser
    baseuri: "{{ baseuri }}"
    user: "{{ user }}"
    password: "{{ password }}"
    userid: "{{ userid }}"
    username: "{{ username }}"
    userpswd: "{{ userpswd }}"
    userrole: "{{ userrole }}"

- name: Disable and delete user
  redfish_command:
    category: Accounts
    command: ["DisableUser", "DeleteUser"]
    baseuri: "{{ baseuri }}"
    user: "{{ user }}"
    password: "{{ password }}"
    userid: "{{ userid }}"

- name: Update user password
  redfish_command:
    category: Accounts
    command: UpdateUserPassword
    baseuri: "{{ baseuri }}"
    user: "{{ user }}"
    password: "{{ password }}"
    userid: "{{ userid }}"
    userpswd: "{{ userpswd }}"

- name: Clear Manager Logs
  redfish_command:
    category: Manager
    command: ClearLogs
    baseuri: "{{ baseuri }}"
    user: "{{ user }}"
    password: "{{ password }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

• Jose Delarosa (github: jose-delarosa)