Copyright 2019 DMTF. All rights reserved.

Redfish Ansible Playbooks

About

This repository contains a set of example Ansible playbooks for invoking the Redfish Ansible modules.

Prerequisites

To use these playbooks, you first need to install the latest stable 2.9 release of Ansible. The Redfish Ansible modules are included in the Ansible distribution. Instructions for installing Ansible can be found here:

Ansible Installation Guide

Release process

The playbooks in the 2.9 branch of this repository are designed to work with the stable 2.9 release of Ansible. The playbooks in the main branch of this repository are designed to work with the latest stable release of Ansible.

Running the playbooks

1. Clone this repository
2. Edit the example inventory.yml file to specify the hostname/ip and credentials of your Redfish service(s).
3. Run a playbook, for example:

ansible-playbook -i inventory.yml playbooks/systems/get_system_inventory.yml

Redfish Ansible modules

The Redfish Ansible modules are maintained in the stable 2.9 Ansible GitHub repository.

The three Redfish modules are summarized here:

1. redfish_command (source: redish_command.py)

   The redfish_command module performs Out-Of-Band (OOB) controller operations like log management, adding/deleting/modifying users, and power operations (e.g. on, off, reboot, etc.).

2. redfish_config (source: redfish_config.py)

   The redfish_config module performs OOB controller operations like setting the BIOS configuration.

3. redfish_info (source: redfish_info.py)

   The redfish_info module retrieves information about the OOB controller like Systems inventory and Accounts inventory.

All three of the above modules use this utility module: redfish_utils.py

Contributing

For the Redfish Ansible modules: File issues or submit pull requests in the Ansible repo following the Ansible Community Guide.

For the Redfish Ansible playbooks: File issues or submit pull requests in this github repository.

OEM Extensions

See OEM_EXTENSIONS.md for an outine of how to extend the standard Redfish Ansible modules to support OEM extensions.

Acknowledgements

These playbooks are based on the ones provided in https://github.com/dell/redfish-ansible-module