SessionService

Session 1.8.0⁠

 

Version	v1.8
Release	2024.4

Description⁠

The Session resource describes a single connection (session) between a client and a Redfish service instance.

URIs⁠

/​redfish/​v1/​SessionService/​Sessions/​{SessionId}

Properties⁠

Property	Type	Attributes	Notes
Actions (v1.1+) {}	object		The available actions for this resource.
ClientOriginIPAddress (v1.3+)	string	read-only (null)	The IP address of the client that created the session.
Context (v1.5+)	string	read-only (null)	A client-supplied string that is stored with the session.
CreatedTime (v1.4+)	string (date-time)	read-only (null)	The date and time when the session was created.
ExpirationTime (v1.8+)	string (date-time)	read-only	The date and time when the session expires regardless of session activity.
Links (v1.7+) {	object		The links to other resources that are related to this resource.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
OutboundConnection (v1.7+) {	object		The outbound connection associated with this session.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
}
}
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
OemSessionType (v1.2+)	string	read-only (null)	The active OEM-defined session type.
Password	string	read-only required on create (null)	The password for this session. The value is null in responses.
Roles (v1.7+) [ ]	array (string, null)	read-only	The Redfish roles that contain the privileges of this session.
SessionType (v1.2+)	string (enum)	read-only (null)	The active session type. For the possible property values, see SessionType in Property details.
Token (v1.6+)	string	read-only (null)	The multi-factor authentication token for this session. The value is null in responses.
UserName	string	read-only required on create (null)	The username for the account for this session.

Property details⁠

SessionType⁠

 

The active session type.

string	Description
HostConsole	The host's console, which could be connected through Telnet, SSH, or another protocol.
IPMI	Intelligent Platform Management Interface.
KVMIP	A Keyboard-Video-Mouse over IP session.
ManagerConsole	The manager's console, which could be connected through Telnet, SSH, SM CLP, or another protocol.
OEM	OEM type. For OEM session types, see the OemSessionType property.
OutboundConnection (v1.7+)	A Redfish Specification-defined outbound connection. See the 'Outbound connections' clause of the Redfish Specification.
Redfish	A Redfish session.
VirtualMedia	Virtual media.
WebUI	A non-Redfish web user interface session, such as a graphical interface or another web-based protocol.

Example response⁠

{
    "@odata.type": "#Session.v1_8_0.Session",
    "Id": "1234567890ABCDEF",
    "Name": "User Session",
    "Description": "Manager User Session",
    "UserName": "Administrator",
    "@odata.id": "/redfish/v1/SessionService/Sessions/1234567890ABCDEF"
}

SessionService 1.2.0⁠

 

Version	v1.2
Release	2024.4

Description⁠

The SessionService schema describes the session service and its properties, with links to the actual list of sessions.

URIs⁠

/​redfish/​v1/​SessionService

Properties⁠

Property	Type	Attributes	Notes
AbsoluteSessionTimeout (v1.2+)	integer (s)	read-write	The maximum number of seconds that a session is open before the service closes the session regardless of activity.
AbsoluteSessionTimeoutEnabled (v1.2+)	boolean	read-write	An indication of whether an absolute session timeout is applied to sessions.
Actions (v1.1+) {}	object		The available actions for this resource.
Oem {}	object		The OEM extension property. See the Resource schema for details on this property.
ServiceEnabled	boolean	read-write (null)	An indication of whether this service is enabled. If true, this service is enabled. If false, it is disabled, and new sessions cannot be created, old sessions cannot be deleted, and established sessions can continue operating.
Sessions {	object		The link to a collection of sessions.
@odata.id	string (URI)	read-only	The unique identifier for a resource.
}
SessionTimeout	integer (s)	read-write	The number of seconds of inactivity that a session can have before the session service closes the session due to inactivity.
Status {}	object		The status and health of the resource and its subordinate or dependent resources. See the Resource schema for details on this property.

Example response⁠

{
    "@odata.type": "#SessionService.v1_2_0.SessionService",
    "Id": "SessionService",
    "Name": "Session Service",
    "Description": "Session Service",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "ServiceEnabled": true,
    "SessionTimeout": 30,
    "Sessions": {
        "@odata.id": "/redfish/v1/SessionService/Sessions"
    },
    "@odata.id": "/redfish/v1/SessionService"
}