GET – Session management properties
Use the GET method to retrieve properties in SessionService resource for Redfish service.
Request URL
GET https://<BMC_IPADDR>/redfish/v1/SessionService
Request body
None
Response body
The response is a JSON object that contains the following parameters:
| Field | Type | Description | |||
|---|---|---|---|---|---|
Name | String | Fixed string "SessionService". | |||
Id | String | “SessionService” | |||
Sessions | Object | This property shall contain the link to a collection of Sessions. | |||
ServiceEnabled | Boolean | The value of this property shall be a boolean indicating whether this service is enabled. The default value is true. | |||
SessionTimeout | Number | This is the number of seconds of inactivity that a session may have before the session service closes the session due to inactivity. The value should between 30 and 86400. The default value is 300. | |||
Description | String | This string is used to represent the Session Service Properties for a Redfish implementation. | |||
Status code
| HTTP Status Code | Error Message ID |
|---|---|
| 500 | InternalError |
Response example
When the request is successful, a message body similar to the following is returned:
{
"Id": "SessionService",
"Name": "SessionService",
"@odata.context": "/redfish/v1/$metadata#SessionService.SessionService",
"@odata.etag": "\"e863af1e936fd7556be8ebb637f07117\"",
"@odata.type": "#SessionService.v1_1_4.SessionService",
"SessionTimeout": 300,
"@odata.id": "/redfish/v1/SessionService",
"Sessions": {
"@odata.id": "/redfish/v1/SessionService/Sessions"
},
"ServiceEnabled": true,
"Description": "This resource is used to represent a session service for a Redfish implementation."
}
Give documentation feedback