iLO 4 REST API Data Model (SessionService Resource Type) - shamimur/hp-proliant-sdk GitHub Wiki
See Resource Map for more details.
This is the schema definition for the Session Service. It represents the properties for the service itself and has links to the actual list of sessions.
"SessionService" defines the following properties:
This property is a member of [SessionService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SessionService-Resource-Type)#sessionservice-resource-type)This indicates whether this service is enabled.
JSON type:
Boolean ('true' or 'false')
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
This is the number of seconds of inactivity that a session may have before the session service closes the session due to inactivity.
JSON type:
Integer
from 30 to 86400.
| GET | Rendered if supported by the implementation or omitted if not. |
| PATCH | This property may be PATCHed if the resource instance of this type supports PATCH in the HTTP Allow headers. |
HTTP PATCH to resource with request JSON:
{"SessionTimeout": <integer-value>}
The property "SessionTimeout" on resource type SessionService may not support PATCH of all values and may result in an HTTP 400 error with response of Type ExtendedError. Multiple properties may be included in a single HTTP PATCH operation as long as the request is properly formatted JSON. To address an array entry other than the first, insert nulls as placeholders on skipped array entries.
This represents the health state of this resource in the absence of its dependent resources.
JSON type:
String containing one of the following supported values:
"OK"
"Warning"
"Critical"
This property is a member of [SessionService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SessionService-Resource-Type)#sessionservice-resource-type)
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values:
"OK"
"Warning"
"Critical"
This property is a member of [SessionService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SessionService-Resource-Type)#sessionservice-resource-type)
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
This represents the overall health state from the view of this resource.
JSON type:
String containing one of the following supported values:
"OK"
"Warning"
"Critical"
This property is a member of [SessionService](https://github.com/HewlettPackard/python-proliant-sdk/wiki/iLO-4-REST-API-Data-Model-(SessionService-Resource-Type)#sessionservice-resource-type)
| GET | Rendered if supported by the implementation or omitted if not. The value of this property may also be null if it is unavailable at the time of the request. |
This indicates the known state of the resource, such as if it is enabled.
JSON type: