Welcome to Sushy’s documentation!

Overview

Sushy is a Python library to communicate with Redfish based systems.

The goal of the library is to be extremely simple, small, have as few dependencies as possible and be very conservative when dealing with BMCs by issuing just enough requests to it (BMCs are very flaky).

Therefore, the scope of the library has been limited to what is supported by the OpenStack Ironic project. As the project grows and more features from Redfish are needed we can expand Sushy to fulfill those requirements.

• Free software: Apache license

• Includes Redfish registry files licensed under

  Creative Commons Attribution 4.0 License: https://creativecommons.org/licenses/by/4.0/

• Documentation: https://docs.openstack.org/sushy/latest/

• Usage: https://docs.openstack.org/sushy/latest/reference/usage.html

• Source: https://opendev.org/openstack/sushy

• Bugs: https://bugs.launchpad.net/sushy

Features

• Abstraction around the SystemCollection and System resources (Basic server identification and asset information)

• RAID in Redfish based Systems

• Redfish Ethernet Interface

• System mappings

• System processor

• Storage management

• Systems power management (Both soft and hard; Including NMI injection)

• Changing systems boot device, frequency (Once or permanently) and mode (UEFI or BIOS)

• Chassis management

• OEM extension

• Virtual media management

• Session Management

Documentation

• Installing Sushy
• Contributing to Sushy
• Sushy Library Reference

• Index