Jump to content

Redfish (specification): Difference between revisions

Edit links
From Wikipedia, the free encyclopedia
Browse history interactively
← Previous edit
Content deleted Content added
VisualWikitext
tone down promotional material
 
(28 intermediate revisions by 22 users not shown)
Line 1: Line 1:
{{Short description|Standard management API}}
{{Infobox standardref
{{Infobox standardref
| title = Redfish
| title = Redfish
| status = Published
| status = Published
| year_started = 2014
| year_started = {{Start date and age|2014}}
| organization = [[Distributed Management Task Force]]
| organization = [[Distributed Management Task Force]]
| related_standards = [[Systems Management Architecture for Server Hardware]]
| related_standards = [[Systems Management Architecture for Server Hardware]]
| abbreviation = Redfish
| abbreviation = Redfish
| domain = [[Data center]] management
| domain = Server management
| website = {{URL|http://www.dmtf.org/standards/redfish}}
| website = {{URL|http://www.dmtf.org/standards/redfish}}
}}
}}
⚫
The '''Redfish''' standard is a suite of specifications that deliver an industry standard [[Communication protocol|protocol]] providing a [[REST|RESTful]] interface for the management of servers, storage, networking, and [[converged infrastructure]].<ref>{{cite web |last1=Sharwood |first1=Simon |title=Gang of five plans extensions to Redfish management spec |url=https://www.theregister.co.uk/2016/03/21/redfish_extensions/ |website=www.theregister.co.uk |language=en |date=March 21, 2016}}</ref><ref>{{cite web |last1=Miller |first1=Michael J. |title=Advances in USB, PCIe, InfiniBand and Redfish Point the Way Forward at IDF |url=https://forwardthinking.pcmag.com/show-reports/347342-advances-in-usb-pcie-infiniband-and-redfish-point-the-way-forward-at-idf |website=PCMAG |language=en |date=August 25, 2016}}</ref>

⚫
The '''Redfish''' standard is a suite of specifications that deliver an industry standard [[Protocol (computing)|protocol]] providing a [[REST|RESTful]] interface for the management of servers, storage, networking, and [[converged infrastructure]].<ref>{{cite web |last1=Sharwood |first1=Simon |title=Gang of five plans extensions to Redfish management spec |url=https://www.theregister.co.uk/2016/03/21/redfish_extensions/ |website=www.theregister.co.uk |language=en |date=March 21, 2016}}</ref><ref>{{cite web |last1=Miller |first1=Michael J. |title=Advances in USB, PCIe, InfiniBand and Redfish Point the Way Forward at IDF |url=https://forwardthinking.pcmag.com/show-reports/347342-advances-in-usb-pcie-infiniband-and-redfish-point-the-way-forward-at-idf |website=PCMAG |language=en |date=August 25, 2016}}</ref>


== History ==
== History ==
The Redfish standard has been elaborated under the SPMF umbrella at the [[Distributed Management Task Force|DMTF]] in 2014. The first specification with base models (1.0) was published in August 2015<ref>{{cite web|title=DMTF signs off Redfish server management spec v 1.0|url=https://www.theregister.co.uk/2015/08/05/dmtf_signs_off_redfish_server_management_spec_v_10/|accessdate=29 January 2019}}</ref>. In 2016, Models for BIOS, disk drives, memory, storage, volume, endpoint, fabric, switch, PCIe device, zone, software/firmware inventory & update, multi-function NICs), host interface (KCS replacement) and privilege mapping were added. In 2017, Models for Composability, Location and errata were added<ref>{{cite web|title=DMTF announces Redfish API advancements|url=https://digitalisationworld.com/news/49120/dmtf-announces-redfish-api-advancements|accessdate=29 January 2019}}</ref>. There is work in progress for Ethernet Switching, DCIM, and OCP.
The Redfish standard has been elaborated under the SPMF umbrella at the [[Distributed Management Task Force|DMTF]] in 2014. The first specification with base models (1.0) was published in August 2015.<ref>{{cite web|title=DMTF signs off Redfish server management spec v 1.0|website=[[The Register]] |url=https://www.theregister.co.uk/2015/08/05/dmtf_signs_off_redfish_server_management_spec_v_10/|accessdate=29 January 2019}}</ref> In 2016, Models for BIOS, disk drives, memory, storage, volume, endpoint, fabric, switch, PCIe device, zone, software/firmware inventory & update, multi-function NICs), host interface (KCS replacement) and privilege mapping were added. In 2017, Models for Composability, Location and errata were added.<ref>{{cite web|title=DMTF announces Redfish API advancements|date=23 August 2016 |url=https://digitalisationworld.com/news/49120/dmtf-announces-redfish-api-advancements|accessdate=29 January 2019}}</ref> There is work in progress for Ethernet Switching, [[Data center management|DCIM]], and OCP.


In August 2016, [[Storage Networking Industry Association|SNIA]] released a first model for network storage services (Swordfish<ref>{{cite web|title=How to get started with the Swordfish storage management standard|url=https://www.techrepublic.com/article/how-to-get-started-with-the-swordfish-storage-management-standard/|accessdate=29 January 2019}}</ref>), an extension of the Redfish specification.
In August 2016, [[Storage Networking Industry Association|SNIA]] released a first model for network storage services (Swordfish<ref>{{cite web|title=How to get started with the Swordfish storage management standard|date=7 May 2018 |url=https://www.techrepublic.com/article/how-to-get-started-with-the-swordfish-storage-management-standard/|accessdate=29 January 2019}}</ref>), an extension of the Redfish specification.


== Industry adoption ==
== Industry adoption ==


=== Redfish support on server ===
=== Redfish support on server ===
* Advantech SKY Server BMC<ref>{{Cite web|url=https://www.advantech.com/products/industrial-telecom-and-cloud-servers/sub_ecb3d229-3519-40c8-9487-5d8abe5a5361|title=Advantech SKY Server series|website=www.advantech.com|language=en-US|access-date=2021-09-08}}</ref>
* [[DELL]] [[iDRAC]] [[Intelligent Platform Management Interface#Baseboard management controller|BMC]] with Minimum iDRAC 7/8 FW 2.40.40.40, iDRAC9 FW 3.00.00.0
* [[Dell]] [[iDRAC]] [[Intelligent Platform Management Interface#Baseboard management controller|BMC]] with minimum iDRAC 7/8 FW 2.40.40.40, iDRAC9 FW 3.00.00.0
* [[Fujitsu]] iRMCS5 BMC <ref>{{Cite web|url=https://support.ts.fujitsu.com/IndexDownload.asp?SoftwareGuid=85DBC785-B759-4CDE-A1D3-C335B5EC7C1D|title=iRMC Redfish API|website=support.ts.fujitsu.com|language=en-US|access-date=2022-05-05}}</ref>
* [[Hewlett Packard Enterprise|HPE]] [[HP Integrated Lights-Out|iLO]] BMC with minimum iLO4 FW 2.30, iLO5
* [[Hewlett Packard Enterprise|HPE]] [[HP Integrated Lights-Out|iLO]] BMC with minimum iLO4 FW 2.30, iLO5
* [[Hewlett Packard Enterprise|HPE]] Moonshot BMC with minimum FW 1.41
* [[Hewlett Packard Enterprise|HPE]] Moonshot BMC with minimum FW 1.41
* [[Lenovo|Lenovo]] XClarity Controller (XCC) BMC with minimum XCC FW 1.00
* [[Lenovo]] XClarity Controller (XCC) BMC with minimum XCC FW 1.00
* [[Supermicro]] X10 BMC with minimum FW 3.0 and X11 with minimum FW 1.0
* [[Supermicro]] X10 BMC with minimum FW 3.0 and X11 with minimum FW 1.0
*[[IBM Power Systems]] BMC with minimum [[OpenPOWER Foundation|OpenPOWER]] (OP) firmware level OP940<ref>{{Cite web|url=https://www.ibm.com/support/knowledgecenter/TI0002C/p8ej4/p8ej4_kickoff.htm|title=IBM Knowledge Center|website=www.ibm.com|language=en-US|access-date=2020-02-12}}</ref>
*[[IBM Power Systems]] BMC with minimum [[OpenPOWER Foundation|OpenPOWER]] (OP) firmware level OP940<ref>{{Cite web|url=https://www.ibm.com/support/knowledgecenter/TI0002C/p8ej4/p8ej4_kickoff.htm|title=IBM Knowledge Center|website=www.ibm.com|date=5 June 2017 |language=en-US|access-date=2020-02-12}}</ref>
*IBM Power Systems Flexible Service Processor (FSP) with minimum firmware level FW860.20<ref>{{Cite web|url=https://www.ibm.com/support/knowledgecenter/POWER9/p9eih/p9eih_redfish.htm|title=IBM Knowledge Center|website=www.ibm.com|language=en-US|access-date=2020-02-12}}</ref>
*IBM Power Systems Flexible Service Processor (FSP) with minimum firmware level FW860.20<ref>{{Cite web|url=https://www.ibm.com/support/knowledgecenter/POWER9/p9eih/p9eih_redfish.htm|title=IBM Knowledge Center|website=www.ibm.com|language=en-US|access-date=2020-02-12}}</ref>
*[[Cisco]] Integrated Management Controller with minimum IMC SW Version 3.0<ref>{{Cite web|date=2017-01-04|title=Cisco Supports Redfish Standard: API Enhances UCS Programmability|url=https://blogs.cisco.com/datacenter/cisco-supports-redfish-standard-api-enhances-ucs-programmability|access-date=2020-11-24|website=Cisco Blogs|language=en-US}}*
</ref>


=== Redfish support on BMC ===
=== Redfish support on BMC ===
* [[Insyde Software]] Supervyse<ref>{{cite web|title=BMC Firmware Products|url=https://www.insyde.com/products/supervyse|accessdate=29 January 2019}}</ref> BMC
* [[Insyde Software]] Supervyse<ref>{{cite web|title=BMC Firmware Products|url=https://www.insyde.com/products/supervyse|accessdate=29 January 2019}}</ref> BMC
*[[OpenBMC]] a [[Linux Foundation]] collaborative [[Open-source model|open-source]] BMC Firmware Stack<ref>{{Citation|title=A do everything Redfish, KVM, GUI, and DBus webserver for OpenBMC: openbmc/bmcweb|date=2019-08-29|url=https://github.com/openbmc/bmcweb|publisher=openbmc|access-date=2019-08-29}}</ref>
*[[OpenBMC]] a [[Linux Foundation]] collaborative [[Open-source model|open-source]] BMC firmware stack<ref>{{Citation|title=A do everything Redfish, KVM, GUI, and DBus webserver for OpenBMC: openbmc/bmcweb|date=2019-08-29|url=https://github.com/openbmc/bmcweb|publisher=openbmc|access-date=2019-08-29}}</ref>
* [[American Megatrends]] MegaRAC Remote Management Firmware<ref>{{cite web|title=MegaRAC Remote Management Firmware|url=https://ami.com/en/products/remote-management/|accessdate=26 February 2020}}</ref>
* [[American Megatrends]] MegaRAC Remote Management Firmware<ref>{{cite web|title=MegaRAC Remote Management Firmware|url=https://ami.com/en/products/remote-management/|accessdate=26 February 2020}}</ref>
* [[Vertiv]] Avocent Core Insight Embedded Management Systems<ref>{{cite web|title=Avocent Core Insight Embedded Management Systems|url=https://www.vertiv.com/en-us/products/monitoring-control--management/avocent-embedded-management-systems/|accessdate=26 February 2020}}</ref>
* [[Vertiv]] Avocent Core Insight Embedded Management Systems<ref>{{cite web|title=Avocent Core Insight Embedded Management Systems|url=https://www.vertiv.com/en-us/products/monitoring-control--management/avocent-embedded-management-systems/|accessdate=26 February 2020}}</ref>


=== Software using Redfish APIs ===
=== Software using Redfish APIs ===

* [[OpenStack]] [[OpenStack#Bare metal (Ironic)|Ironic]] bare metal deployment project has a Redfish driver.
* [[OpenStack]] [[OpenStack#Bare metal (Ironic)|Ironic]] bare metal deployment project has a Redfish driver.
* [[Ansible_(software)|Ansible]] has multiple Redfish modules for Remote Management including redfish_facts, redfish_config, and redfish_command
* [[Ansible_(software)|Ansible]] has multiple Redfish modules for Remote Management including redfish_info, redfish_config, and redfish_command
* [[ManageIQ]]


=== Redfish libraries and tools ===
=== Redfish libraries and tools ===
* DMTF libraries and tools<ref>{{cite web|title=DMTF Redfish libraries and tools|website=[[GitHub]] |url=https://github.com/DMTF|accessdate=6 May 2019}}</ref>

* DMTF libraries and tools <ref>{{cite web|title=DMTF Redfish libraries and tools|url=https://github.com/DMTF|accessdate=6 May 2019}}</ref>
* GoLang gofish <ref>{{Cite web |title=redfish package - github.com/stmcginnis/gofish/redfish - Go Packages |url=https://pkg.go.dev/github.com/stmcginnis/gofish/redfish |access-date=2023-08-01 |website=pkg.go.dev}}</ref>
* Mojo::Redfish::Client <ref>{{cite web|title=Mojo::Redfish::Client - A Redfish client with a Mojo flair|url=https://metacpan.org/pod/Mojo::Redfish::Client|accessdate=28 Feb 2020}}</ref>
* Mojo::Redfish::Client<ref>{{cite web|title=Mojo::Redfish::Client - A Redfish client with a Mojo flair|url=https://metacpan.org/pod/Mojo::Redfish::Client|accessdate=28 Feb 2020}}</ref>
* python-redfish <ref>{{cite web|title=python-redfish Documentation|url=https://pythonhosted.org/python-redfish/|accessdate=6 May 2019}}</ref>
* python-redfish<ref>{{cite web|title=python-redfish Documentation|url=https://pythonhosted.org/python-redfish/|accessdate=6 May 2019}}</ref>
* Sushy <ref>{{cite web|title=Sushy Documentation|url=https://docs.openstack.org/sushy/latest/|accessdate=6 May 2019}}</ref>
* Sushy<ref>{{cite web|title=Sushy Documentation|url=https://docs.openstack.org/sushy/latest/|accessdate=6 May 2019}}</ref>


Redfish is used by both proprietary software (such as HPE OneView) as well as FLOSS ones (such as OpenBMC).<ref>{{cite web|title=Open Source Projects Using DMTF Technologies|url=https://www.dmtf.org/standards/opensource|accessdate=3 February 2019}}</ref><ref>{{Cite web|url=https://github.com/openbmc/bmcweb|title=openbmc/bmcweb|website=GitHub|language=en|access-date=2020-02-12}}</ref>
Redfish is used by both proprietary software (such as HPE OneView) as well as FLOSS ones (such as OpenBMC).<ref>{{cite web|title=Open Source Projects Using DMTF Technologies|url=https://www.dmtf.org/standards/opensource|accessdate=3 February 2019}}</ref><ref>{{Cite web|url=https://github.com/openbmc/bmcweb|title=openbmc/bmcweb|website=GitHub|language=en|access-date=2020-02-12}}</ref>


== See also ==
== See also ==
* [[Intelligent Platform Management Interface|IPMI]]
* [[Intelligent Platform Management Interface]] (IPMI)
* [[Create, read, update and delete]] (CRUD)
* [[Create, read, update and delete]] (CRUD)
* [[JSON]]
* [[JSON]]
* [[REST|RESTful API]]
* [[Open Data Protocol|OData]] – Protocol for REST APIs
* [[Open Data Protocol|OData]] – Protocol for REST APIs
*[[OpenBMC]]


== References ==
== References ==
{{Reflist|2}}
{{Reflist|2}}

==External links==
* [http://www.dmtf.org/standards/redfish/ DMTF Redfish initiative]
* [https://redfish.dmtf.org/ Redfish Developer Hub]
* [https://blog.dellemc.com/en-us/fish-on-dell-emc-nets-enhanced-and-expanded-redfish-support-for-poweredge/ DELL Redfish ecosystem]
* [https://www.hpe.com/us/en/servers/restful-api.html HPE Redfish ecosystem]
* [https://www.supermicro.com/en/solutions/management-software/redfish SuperMicro Redfish ecosystem]
* [https://sysmgt.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.systems.management.xcc.doc%2Frest_api.html Lenovo Redfish ecosystem]
* [https://github.com/jorika/Redfish-Scripting DMTF Redfish scripting for Gigabyte systems]


{{DMTF Standards}}
{{DMTF Standards}}


[[Category:Networking standards]]
[[Category:Networking standards]]

[[Category:DMTF standards]]
[[Category:DMTF standards]]
[[Category:System administration]]
[[Category:System administration]]
[[Category:Out-of-band management]]
[[Category:Out-of-band management]]
[[Category:Computer hardware standards]]

{{Compu-network-stub}}

Latest revision as of 10:53, 9 April 2024

Redfish
AbbreviationRedfish
StatusPublished
Year started2014; 10 years ago (2014)
OrganizationDistributed Management Task Force
Related standardsSystems Management Architecture for Server Hardware
DomainServer management
Websitewww.dmtf.org/standards/redfish

The Redfish standard is a suite of specifications that deliver an industry standard protocol providing a RESTful interface for the management of servers, storage, networking, and converged infrastructure.[1][2]

History

[edit]

The Redfish standard has been elaborated under the SPMF umbrella at the DMTF in 2014. The first specification with base models (1.0) was published in August 2015.[3] In 2016, Models for BIOS, disk drives, memory, storage, volume, endpoint, fabric, switch, PCIe device, zone, software/firmware inventory & update, multi-function NICs), host interface (KCS replacement) and privilege mapping were added. In 2017, Models for Composability, Location and errata were added.[4] There is work in progress for Ethernet Switching, DCIM, and OCP.

In August 2016, SNIA released a first model for network storage services (Swordfish[5]), an extension of the Redfish specification.

Industry adoption

[edit]

Redfish support on server

[edit]
  • Advantech SKY Server BMC[6]
  • Dell iDRAC BMC with minimum iDRAC 7/8 FW 2.40.40.40, iDRAC9 FW 3.00.00.0
  • Fujitsu iRMCS5 BMC [7]
  • HPE iLO BMC with minimum iLO4 FW 2.30, iLO5
  • HPE Moonshot BMC with minimum FW 1.41
  • Lenovo XClarity Controller (XCC) BMC with minimum XCC FW 1.00
  • Supermicro X10 BMC with minimum FW 3.0 and X11 with minimum FW 1.0
  • IBM Power Systems BMC with minimum OpenPOWER (OP) firmware level OP940[8]
  • IBM Power Systems Flexible Service Processor (FSP) with minimum firmware level FW860.20[9]
  • Cisco Integrated Management Controller with minimum IMC SW Version 3.0[10]

Redfish support on BMC

[edit]

Software using Redfish APIs

[edit]
  • OpenStack Ironic bare metal deployment project has a Redfish driver.
  • Ansible has multiple Redfish modules for Remote Management including redfish_info, redfish_config, and redfish_command
  • ManageIQ

Redfish libraries and tools

[edit]
  • DMTF libraries and tools[15]
  • GoLang gofish [16]
  • Mojo::Redfish::Client[17]
  • python-redfish[18]
  • Sushy[19]

Redfish is used by both proprietary software (such as HPE OneView) as well as FLOSS ones (such as OpenBMC).[20][21]

See also

[edit]

References

[edit]
  1. ^ Sharwood, Simon (March 21, 2016). "Gang of five plans extensions to Redfish management spec". www.theregister.co.uk.
  2. ^ Miller, Michael J. (August 25, 2016). "Advances in USB, PCIe, InfiniBand and Redfish Point the Way Forward at IDF". PCMAG.
  3. ^ "DMTF signs off Redfish server management spec v 1.0". The Register. Retrieved 29 January 2019.
  4. ^ "DMTF announces Redfish API advancements". 23 August 2016. Retrieved 29 January 2019.
  5. ^ "How to get started with the Swordfish storage management standard". 7 May 2018. Retrieved 29 January 2019.
  6. ^ "Advantech SKY Server series". www.advantech.com. Retrieved 2021-09-08.
  7. ^ "iRMC Redfish API". support.ts.fujitsu.com. Retrieved 2022-05-05.
  8. ^ "IBM Knowledge Center". www.ibm.com. 5 June 2017. Retrieved 2020-02-12.
  9. ^ "IBM Knowledge Center". www.ibm.com. Retrieved 2020-02-12.
  10. ^ "Cisco Supports Redfish Standard: API Enhances UCS Programmability". Cisco Blogs. 2017-01-04. Retrieved 2020-11-24.*
  11. ^ "BMC Firmware Products". Retrieved 29 January 2019.
  12. ^ A do everything Redfish, KVM, GUI, and DBus webserver for OpenBMC: openbmc/bmcweb, openbmc, 2019-08-29, retrieved 2019-08-29
  13. ^ "MegaRAC Remote Management Firmware". Retrieved 26 February 2020.
  14. ^ "Avocent Core Insight Embedded Management Systems". Retrieved 26 February 2020.
  15. ^ "DMTF Redfish libraries and tools". GitHub. Retrieved 6 May 2019.
  16. ^ "redfish package - github.com/stmcginnis/gofish/redfish - Go Packages". pkg.go.dev. Retrieved 2023-08-01.
  17. ^ "Mojo::Redfish::Client - A Redfish client with a Mojo flair". Retrieved 28 Feb 2020.
  18. ^ "python-redfish Documentation". Retrieved 6 May 2019.
  19. ^ "Sushy Documentation". Retrieved 6 May 2019.
  20. ^ "Open Source Projects Using DMTF Technologies". Retrieved 3 February 2019.
  21. ^ "openbmc/bmcweb". GitHub. Retrieved 2020-02-12.
Retrieved from "https://en.wikipedia.org/enwiki/w/index.php?title=Redfish_(specification)&oldid=1218040344"