Meaning of SubordinateResources

trajeswaran
Minnow

Posts: 5

Meaning of SubordinateResources Apr 16, 2020 17:18:27 GMT

Quote

Post by trajeswaran on Apr 16, 2020 17:18:27 GMT

I am trying to understand the meaning of the property "SubordinateResources" in EventDestination schema. Any help in this regard is highly appreciated. Thanks.

Example: 1

/redfish/v1/Managers/BMC/NetworkProtocol

    HTTPS {
        Certificates {
            "@odata.id" : "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates"
        }
    }

Example : 2

/redfish/v1/Systems/BMC

    Links {
        Chassis [ {
            "@odata.id": "/redfish/v1/Chassis/1U"
        } ]
    }

In case of example 1, if the "OriginResources" is "/redfish/v1/Managers/BMC/NetworkProtocol" and "SubordinateResources" is true, then should it include the events in the resource "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates" ?

In case of example 2, if the "OriginResources" is "/redfish/v1/Systems/BMC" and "SubordinateResources" is true, then should it include the events in the resource "/redfish/v1/Chassis/1U" ?

If the property "ResourceTypes" has been specified and "SubordinateResources" is true and "OriginResources" is not specified, then should the property "SubordinateResources" be considered ? ie. "SubordinateResources" is applicable only if "OriginResources" is specified.

jautor
Administrator

Posts: 519

Meaning of SubordinateResources Apr 17, 2020 16:06:30 GMT

Quote

Post by jautor on Apr 17, 2020 16:06:30 GMT

Apr 16, 2020 17:18:27 GMT trajeswaran said:

I am trying to understand the meaning of the property "SubordinateResources" in EventDestination schema. Any help in this regard is highly appreciated. Thanks.

Good timing on this question, as we realized that term was not actually defined in the Redfish Specification, and will be added to the next version. A resource is subordinate if the "initial segment of the resource URI is the same as the URI of the other resource, but is at least one level deeper". And in Redfish usage, resources deeper in the tree are essentially "more details" about a resource higher in the tree.

So the ability to subscribe to events from "subordinate resources" means you get events about those detailed subsystems.

Example: 1

/redfish/v1/Managers/BMC/NetworkProtocol

    HTTPS {
        Certificates {
            "@odata.id" : "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates"
        }
    }

Example : 2

/redfish/v1/Systems/BMC

    Links {
        Chassis [ {
            "@odata.id": "/redfish/v1/Chassis/1U"
        } ]
    }

In case of example 1, if the "OriginResources" is "/redfish/v1/Managers/BMC/NetworkProtocol" and "SubordinateResources" is true, then should it include the events in the resource "/redfish/v1/Managers/BMC/NetworkProtocol/HTTPS/Certificates" ?

Correct.

In case of example 2, if the "OriginResources" is "/redfish/v1/Systems/BMC" and "SubordinateResources" is true, then should it include the events in the resource "/redfish/v1/Chassis/1U" ?

No, since the "Chassis" is not subordinate (it's a peer in the resource tree), those events would not be included in that subscription. For ComputerSystems, if you want all of the events - for both the functional aspects of the system, and the physical aspects - you would subscribe to both the "ComputerSystems" instance and the related "Chassis" instance for that machine.

If the property "ResourceTypes" has been specified and "SubordinateResources" is true and "OriginResources" is not specified, then should the property "SubordinateResources" be considered ? ie. "SubordinateResources" is applicable only if "OriginResources" is specified.

Yes, the "SubordinateResources" flag is only considered for "OriginResources" subscription types. A subscription of "ResourceTypes" looks only at the resource's schema definition, not its location in the resource tree.

Jeff

Last Edit: Apr 17, 2020 16:07:06 GMT by jautor

trajeswaran Minnow Posts: 5	Meaning of SubordinateResources Apr 20, 2020 5:15:36 GMT Quote Select Post Deselect Post Link to Post Back to Top Post by trajeswaran on Apr 20, 2020 5:15:36 GMT Thank you very much for your detailed explanation. Now, it is clear to me. I appreciate you. Thanks.

Post by trajeswaran on Apr 16, 2020 17:18:27 GMT

Post by jautor on Apr 17, 2020 16:06:30 GMT

Post by trajeswaran on Apr 20, 2020 5:15:36 GMT