The Response of Actions Property | Redfish Specification Forum

jasonzhang
Minnow

Posts: 2

The Response of Actions Property Nov 27, 2017 3:02:37 GMT

Quote

Post by jasonzhang on Nov 27, 2017 3:02:37 GMT

According to the content of 6.5.4.7 chapter in Redfish Scalable Platforms Management API Specification, the response format about Actions property is as follows :

    {

        "#ComputerSystem.Reset": {

            "target":"/redfish/v1/Systems/1/Actions/ComputerSystem.Reset",

                "ResetType@Redfish.AllowableValues": [

                    "On",

                    "ForceOff",

                    "GracefulRestart",

                    "GracefulShutdown",

                    "ForceRestart",

                    "Nmi",

                    "ForceOn",

                    "PushPowerButton"

                ]

        },

        ...

}

In the example above, the parameter value of RestType is limited to enumeration array. If the type of a parameter of an action is Edm.Int32 and its value should be is limited to a specific range(such as 0 to 100), how to represent this constraint through AllowableValues in the response of Actions property

jautor
Administrator

Posts: 519

The Response of Actions Property Nov 29, 2017 0:36:06 GMT

Quote

Post by jautor on Nov 29, 2017 0:36:06 GMT

The AllowableValues array is only used for string enumerations. But your point is valid, and we should consider a mechanism for the service to expose its support for min/max values for integer types in parameters when it's not obvious. In my opinion, this is something that would be best suited in an ActionInfo resource for an Action.

Can you share an example of a parameter that this would apply to? We've generally tried to avoid integer values that have implementation-specific ranges (as opposed to well-known / static limits).

Jeff

jautor
Administrator

Posts: 519

The Response of Actions Property Nov 30, 2017 22:10:59 GMT

Quote

Post by jautor on Nov 30, 2017 22:10:59 GMT

We discussed this today, and concluded that this would be useful information to add to the ActionInfo definition. We'll add "MinimumSupportedValue" and "MaximumSupportedValue" (exact name TBD) properties to the 'Parameters' object in the ActionInfo resource (schema). That work will be done as part of our 2018.1 release bundle. I'll update you with the final property names ASAP.

Jeff