ansible / ansible.builtin / v2.7.7 / module / redfish_command Manages Out-Of-Band controllers using Redfish APIs | "added in version" 2.7 of ansible.builtin" Authors: Jose Delarosa (github: jose-delarosa) preview | supported by communityansible.builtin.redfish_command (v2.7.7) — module
pip
Install with pip install ansible==2.7.7
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.
- 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 }}"
user: description: - User for authentication with OOB controller required: true userid: description: - ID of user to add/delete/modify required: false baseuri: description: - Base URI of OOB controller required: true command: description: - List of commands to execute on OOB controller required: true category: description: - Category to execute on OOB controller required: true password: description: - Password for authentication with OOB controller required: true username: description: - name of user to add/delete/modify required: false userpswd: description: - password of user to add/delete/modify required: false userrole: description: - role of user to add/delete/modify required: false bootdevice: description: - bootdevice when setting boot configuration required: false
msg: description: Message with action result or error description returned: always sample: Action was successful type: string