Newbie question on Redfish URI resource names

Newbie question on Redfish URI resource names

[Jeff Friedman]

[-- Attachment #1: Type: text/plain, Size: 1499 bytes --]

Hello all,
 
New to OpenBMC, and am not clear on one thing as pertaining to the Redfish schema and URI resource names:
 
The DMTF Redfish schema URIs are defined as:
 
/redfish/v1/Chassis/{ChassisId}/
/redfish/v1/Managers/{ManagerId}
/redfish/v1/Systems/{ComputerSystemId}
 
Vendors can use their own names for {ChassisId}, {ManagerId}, and {ComputerSystemId} as long as they conform to the syntax rules.
 
Question: Does OpenBMC specify names for these resources as part of the OpenBMC spec? Or does OpenBMC just refer to the existing DMTF Redfish schemas?
 
I ask because I have seen reference to the following names in examples for Managers and Systems on the OpenBMC website:
 
/redfish/v1/Chassis/{ChassisId}/               
/redfish/v1/Managers/bmc/                                                      
/redfish/v1/Systems/system/    
 
In summary, does OpenBMC specify these resource names as part of their spec, or does it refer to existing DMTF Redfish schema specs?
 
Thank you!
 
Jeff Friedman
Sr. Field Systems Engineer | ZT Systems
M: 206.819.2824

<image001.gif>


This email and any files transmitted with it are privileged/confidential and intended solely for the use of the individual to whom they are addressed. If you have received this email in error, you are not authorized to distribute it in whole or in part. This communication does not constitute a contract offer, amendment, or acceptance of a contract offer, unless explicitly stated. 

 

[-- Attachment #2: Type: text/html, Size: 4583 bytes --]

Re: Newbie question on Redfish URI resource names

[John Broadbent]

[-- Attachment #1: Type: text/plain, Size: 2746 bytes --]

Hello Jeff,

I am not an authority, but I will give you a quick answer for chassis ID.
For chassis bmcweb checks with the dbus mapper to find all daemon in
"/xyz/openbmc_project/inventory" that have either
the "xyz.openbmc_project.Inventory.Item.Board", or
the "xyz.openbmc_project.Inventory.Item.Chassis" interfaces. There are some
extra checks and information, but that is a simplified version of it.

See the bmcweb code that sets up the handler here
https://github.com/openbmc/bmcweb/blob/5b9e95a17fae7aaf9f8716b65345bb64ade5f403/redfish-core/lib/chassis.hpp#L206


The next question might be "how are these interfaces created", and I
believe they come from entity-manager. Entity-manager reads a json file,
and creates the corresponding dbus interfaces. I know less
about entity-manager. But this looks to be the creation of the interfaces,
which depending on the json, could be a chassis.
https://github.com/openbmc/entity-manager/blob/e45d8c71bdbae39f14a638137da9dc03474536c1/src/entity_manager.cpp#L603

Ed, Patrick, and Brad know more about this process.





On Wed, Jun 8, 2022 at 4:27 PM Jeff Friedman <jfriedman.seattle@gmail.com>
wrote:

> Hello all,
>
>
>
> New to OpenBMC, and am not clear on one thing as pertaining to the Redfish
> schema and URI resource names:
>
>
>
> The DMTF Redfish schema URIs are defined as:
>
>
>
> /redfish/v1/Chassis/{ChassisId}/
>
> /redfish/v1/Managers/{ManagerId}
>
> /redfish/v1/Systems/{ComputerSystemId}
>
>
>
> Vendors can use their own names for {ChassisId}, {ManagerId}, and
> {ComputerSystemId} as long as they conform to the syntax rules.
>
>
>
> Question: Does OpenBMC specify names for these resources as part of the
> OpenBMC spec? Or does OpenBMC just refer to the existing DMTF Redfish
> schemas?
>
>
>
> I ask because I have seen reference to the following names in examples for
> Managers and Systems on the OpenBMC website:
>
>
>
> /redfish/v1/Chassis/{ChassisId}/
>
> /redfish/v1/Managers/*bmc*/
>
>
> /redfish/v1/Systems/*system*/
>
>
>
> In summary, does OpenBMC specify these resource names as part of their
> spec, or does it refer to existing DMTF Redfish schema specs?
>
>
>
> Thank you!
>
>
>
> *Jeff Friedman*
> Sr. Field Systems Engineer | ZT Systems
>
> M: 206.819.2824 <(206)%20819-2824>
>
> <http://www.ztsystems.com/>
> <image001.gif> <http://www.ztsystems.com/>
>
>
> This email and any files transmitted with it are privileged/confidential
> and intended solely for the use of the individual to whom they are
> addressed. If you have received this email in error, you are not authorized
> to distribute it in whole or in part. This communication does not
> constitute a contract offer, amendment, or acceptance of a contract offer,
> unless explicitly stated.
>
>
>

[-- Attachment #2: Type: text/html, Size: 5713 bytes --]