sushy/doc/source/usage.rst

Usage

To use sushy in a project:

import logging

import sushy

# Enable logging at DEBUG level
LOG = logging.getLogger('sushy')
LOG.setLevel(logging.DEBUG)
LOG.addHandler(logging.StreamHandler())

s = sushy.Sushy('http://localhost:8000', username='foo', password='bar')

# Get the Redfish version
print(s.redfish_version)

# Instantiate a system object
sys_inst = s.get_system('/redfish/v1/Systems/437XR1138R2')


# Using system collections


# Instantiate a SystemCollection object
sys_col = s.get_system_collection()

# Print the ID of the systems available in the collection
print(sys_col.members_identities)

# Get a list of systems objects available in the collection
sys_col_insts = sys_col.get_members()

# Instantiate a system object, same as getting it directly
# from the s.get_system()
sys_inst = sys_col.get_member(sys_col.members_identities[0])

# Refresh the system collection object
sys_col.refresh()


# Using system actions


# Power the system ON
sys_inst.reset_system(sushy.RESET_ON)

# Get a list of allowed reset values
print(sys_inst.get_allowed_reset_system_values())

# Refresh the system object
sys_inst.refresh()

# Get the current power state
print(sys_inst.power_state)

# Set the next boot device to boot once from PXE in UEFI mode
sys_inst.set_system_boot_source(sushy.BOOT_SOURCE_TARGET_PXE,
                                enabled=sushy.BOOT_SOURCE_ENABLED_ONCE,
                                mode=sushy.BOOT_SOURCE_MODE_UEFI)

# Get the current boot source information
print(sys_inst.boot)

# Get a list of allowed boot source target values
print(sys_inst.get_allowed_system_boot_source_values())

Running a mockup server

Static mockup

Sushy ships a small script at tools/mockup_server.py that creates a HTTP server to serve any of the Redfish mockups. The files are static so operations like changing the boot device or the power state will not have any effect. But that should be enough for enabling people to test parts of the library. To setup it do:

1. Download the .zip containing the Redfish mockups files from https://www.dmtf.org/standards/redfish, for example:

   wget https://www.dmtf.org/sites/default/files/standards/documents/DSP2043_1.0.0.zip

2. Extract it somewhere in the file-system:

   unzip DSP2043_1.0.0.zip -d <output-path>

3. Now run the mockup_server.py script:

   python sushy/tools/mockup_server.py --mockup-files <output-path>/DSP2043-server --port 8000

Libvirt mockup

Sushy also ships a small application at tools/mockup_server_libvirt that starts a ReST API that users can use to interact with virtual machines using the Redfish protocol. So operations such as changing the boot device or the power state will actually affect the virtual machines. This allows users to test the library in a more dynamic way. To setup it do:

tox -elibvirt-simulator

# Or, running with custom parameters
tox -elibvirt-simulator -- --port 8000 --libvirt-uri "qemu:///system"

Note

Installing the dependencies requires libvirt development files. For example, run the following command to install them on Fedora:

sudo dnf install -y libvirt-devel

That's it, now you can test Sushy against the http://locahost:8000 endpoint.

Enabling SSL

Both mockup servers supports SSL if you want Sushy with it. To set it up, first you need to generate key and certificate files with OpenSSL use following command:

openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 365

Start the mockup server passing the --ssl-certificate and --ssl-key parameters to it to it, for example:

python sushy/tools/mockup_server.py --ssl-key key.pem --ssl-certificate cert.pem --mockup-files <output-path>/DSP2043-server --port 8000

Now to connect with SSL to the server use the verify parameter pointing to the certificate file when instantiating Sushy, for example:

import sushy

# Note the HTTP"S"
s = sushy.Sushy('https://localhost:8000', verify='cert.pem', username='foo', password='bar')