Metadata-Version: 2.1
Name: sushy-oem-idrac
Version: 6.0.0
Summary: Dell EMC iDRAC OEM extension package for the sushy library
Home-page: https://docs.openstack.org/sushy/latest/
Author: OpenStack
Author-email: openstack-discuss@lists.openstack.org
Classifier: Environment :: OpenStack
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: pbr (!=2.1.0,>=2.0.0)
Requires-Dist: python-dateutil (>=2.7.0)
Requires-Dist: sushy (>=4.0.0)

Dell EMC OEM extension for sushy
================================

Sushy is a client [library](https://github.com/openstack/sushy) designed to
communicate with [Redfish](https://en.wikipedia.org/wiki/Redfish_(specification))
based BMC.

Redfish specification offers extensibility mechanism to let hardware vendors
introduce their own features with the common Redfish framework. At the same
time, `sushy` supports extending its data model by loading extensions found
within its "oem" namespace.

The `sushy-oem-idrac` package is a sushy extension package that aims at
adding high-level hardware management abstractions, that are specific to
Dell EMC BMC (which is known under the name of iDRAC), to the tree of sushy
Redfish resources.

Example use
-----------

Once installed, sushy user can access Dell EMC OEM resources. For example,
OEM extension of Manager resource can be instrumental for switching the
node to boot from a virtual media device:

```python

import sushy

root = sushy.Sushy('http://mydellemcbmc.example.com')
manager = root.get_manager('iDRAC.Embedded.1')

oem_manager = manager.get_oem_extension('Dell')

oem_manager.set_virtual_boot_device(
    sushy.VIRTUAL_MEDIA_CD, persistent=False, manager=manager)    
```

See full example of virtual media boot setup in the
[functional test suite](https://github.com/etingof/sushy-oem-idrac/blob/master/sushy_oem_idrac/tests/functional/vmedia_boot.py).

