Xena Series (3.8.0 - 3.12.x) Release Notes


Bug Fixes

  • Makes the unstripped version of an Etag available in addition to the stripped one in order to support vendor implementations which require one or the other.


Bug Fixes

  • Changing boot device string for virtual media from “Cd” to “UsbCd” on SuperMicro machines to match their specific naming convention.

  • If available, uses headers with an Etag to set the boot options.

  • Fixes issues with the refresh of Session based authentication where a previous refresh attempt failing could result in a fallback to Basic authentication and would silently fail. The client library now attempts to re-authenticate.

  • Fixes silent failures when a refresh of an authentication Session fails and was unable to be re-established due to an AccessError. Should this occur, now the AccessError exception is explicitly raised as opposed to attempting to fall back to Basic authentication.

  • Fixes issues where the Session and Basic auth interface would fallback to Basic authentication should a ConnectionError exception occur while attempting to perform an authentication action. ConnectionError exceptions are signs of networking transport issues, and should be investigated. A ConnectionError exception is now raised.

  • Prevents the combined Session and Basic authentication support from falling back to Basic authentication once Session based authentication has been established. This should be considered a potential security issue or an environmental change requiring potential client re-initialization. This is exposed as an AccessError exception. Continued operations against the Sushy library will attempt to reauthenticate, if possible.

  • Resolved virtualmedia attach failures caused by the lack of TransferProtocolType parameter in the request payload which is required by certain BMCs (e.g. on Nokia servers). This is done by adding capability to retry virtualmedia InsertMedia with the updated payload in such cases.

  • Fixes incompatibility with BMCs that require use of a specific SettingsObject URI specified in @Redfish.Settings resource in order to set BootSourceOverride or similar attributes. For example, this is required on Nokia servers.


New Features

  • The VirtualMedia.insert_media call now supports credentials for the image URI.

Bug Fixes


New Features

  • Adds root property to Sushy resources to link to main Sushy object. Empty for Sushy root itself.

Upgrade Notes

  • “Inserted” and “WriteProtected” optional attributes are no longer present in the InsertMedia API call payload when default values {“Inserted”: True, “WriteProtected”: True} are specified by the consumer (e.g. Ironic) and PATCH method of configuring virtual media is not used. Behaviour is unchanged if PATCH method is used.

Bug Fixes

  • Removing “Inserted” and “WriteProtected” parameters from the Redfish VirtualMedia::insert_media() API call payload when default values {“Inserted”: True, “WriteProtected”: True} are set and PATCH method is not used. Those parameters are optional as per Redfish schema 2021.1. Some BMCs (e.g. SuperMicro X11/X12 platforms) treat these fields as read-only and setting them causes vMedia insert failures. These attributes should default to True on the BMC side. Some BMCs using PATCH method of configuring virtual media (e.g. Lenovo SD530) still require “Inserted” attribute, so only changing this for non-PATCH methods of configuring virtual media such as InsertMedia action.

  • Fixes OEM resource attribute parsing for OEM resources with required fields. Before the fix an error such as “The attribute <attribute name> is missing from the resource <resource path>” occurred.


New Features

  • Adds Drive.volumes property for list of volumes that drive is part of.

Bug Fixes

  • Removes the requirement from Context to be present when requesting a subscription, some BMCs do not report Context when the subscription is created with empty string and would cause MissingAttributeError.

  • Fixes Processor.sub_processors for “‘Processor’ object has no attribute ‘conn’” error.


New Features

  • Adds support for the Redfish EventService resource. EventService is responsible for managing event subscriptions and generates the events sent to subscribers.


New Features

  • Add support for caching Redfish Attribute Registries. In particular, cache the BIOS Attribute Registry and provide a function to return it if it matches the AttributeRegistry field in System BIOS.

Bug Fixes

  • Adds a fallback for inserting and ejecting virtual media using the PATCH HTTP request instead of the explicit action URIs. The fallback is required for Lenovo ThinkSystem machines (i.e. SD530, ..) that only implement the PATCH method.