blob: 9d5f6ac5051e1f5b16575daaef9843a2ba611aba [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -07001{
Gunnar Mills262d7d42021-01-20 16:28:41 -06002 "$id": "http://redfish.dmtf.org/schemas/v1/SessionService.v1_1_8.json",
Ed Tanous118b1c72018-09-13 13:45:51 -07003 "$ref": "#/definitions/SessionService",
Ed Tanous530520e2019-01-02 13:41:37 -08004 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
Gunnar Mills844b4152020-06-22 12:44:09 -05005 "copyright": "Copyright 2014-2020 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -07006 "definitions": {
Ed Tanous530520e2019-01-02 13:41:37 -08007 "Actions": {
8 "additionalProperties": false,
Gunnar Mills844b4152020-06-22 12:44:09 -05009 "description": "The available actions for this resource.",
10 "longDescription": "This type shall contain the available actions for this resource.",
Ed Tanous118b1c72018-09-13 13:45:51 -070011 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070012 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous530520e2019-01-02 13:41:37 -080013 "description": "This property shall specify a valid odata or Redfish property.",
Ed Tanous118b1c72018-09-13 13:45:51 -070014 "type": [
15 "array",
16 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -080017 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -070018 "number",
19 "null",
20 "object",
21 "string"
Ed Tanous530520e2019-01-02 13:41:37 -080022 ]
Ed Tanous118b1c72018-09-13 13:45:51 -070023 }
24 },
Ed Tanous530520e2019-01-02 13:41:37 -080025 "properties": {
26 "Oem": {
Ed Tanouscb103132019-10-08 11:34:22 -070027 "$ref": "#/definitions/OemActions",
Gunnar Mills844b4152020-06-22 12:44:09 -050028 "description": "The available OEM-specific actions for this resource.",
29 "longDescription": "This property shall contain the available OEM-specific actions for this resource.",
Ed Tanouscb103132019-10-08 11:34:22 -070030 "versionAdded": "v1_1_0"
Ed Tanous530520e2019-01-02 13:41:37 -080031 }
32 },
33 "type": "object"
34 },
35 "OemActions": {
36 "additionalProperties": true,
Gunnar Mills844b4152020-06-22 12:44:09 -050037 "description": "The available OEM-specific actions for this resource.",
38 "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
Ed Tanous530520e2019-01-02 13:41:37 -080039 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070040 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous530520e2019-01-02 13:41:37 -080041 "description": "This property shall specify a valid odata or Redfish property.",
42 "type": [
43 "array",
44 "boolean",
45 "integer",
46 "number",
47 "null",
48 "object",
49 "string"
50 ]
51 }
52 },
53 "properties": {},
54 "type": "object"
55 },
56 "SessionService": {
Ed Tanous118b1c72018-09-13 13:45:51 -070057 "additionalProperties": false,
Gunnar Mills844b4152020-06-22 12:44:09 -050058 "description": "The SessionService schema describes the session service and its properties, with links to the actual list of sessions.",
59 "longDescription": "This resource contains the session service properties for a Redfish implementation.",
Ed Tanous530520e2019-01-02 13:41:37 -080060 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070061 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous530520e2019-01-02 13:41:37 -080062 "description": "This property shall specify a valid odata or Redfish property.",
63 "type": [
64 "array",
65 "boolean",
66 "integer",
67 "number",
68 "null",
69 "object",
70 "string"
71 ]
72 }
73 },
Ed Tanous118b1c72018-09-13 13:45:51 -070074 "properties": {
75 "@odata.context": {
Ed Tanouscb103132019-10-08 11:34:22 -070076 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
Ed Tanous530520e2019-01-02 13:41:37 -080077 },
78 "@odata.etag": {
Ed Tanouscb103132019-10-08 11:34:22 -070079 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -070080 },
81 "@odata.id": {
Ed Tanouscb103132019-10-08 11:34:22 -070082 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -070083 },
84 "@odata.type": {
Ed Tanouscb103132019-10-08 11:34:22 -070085 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -070086 },
Ed Tanous530520e2019-01-02 13:41:37 -080087 "Actions": {
88 "$ref": "#/definitions/Actions",
Gunnar Mills844b4152020-06-22 12:44:09 -050089 "description": "The available actions for this resource.",
90 "longDescription": "This property shall contain the available actions for this resource.",
Ed Tanouscb103132019-10-08 11:34:22 -070091 "versionAdded": "v1_1_0"
Ed Tanous118b1c72018-09-13 13:45:51 -070092 },
93 "Description": {
94 "anyOf": [
Ed Tanous530520e2019-01-02 13:41:37 -080095 {
96 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
97 },
98 {
99 "type": "null"
100 }
Ed Tanous118b1c72018-09-13 13:45:51 -0700101 ],
102 "readonly": true
103 },
Ed Tanous530520e2019-01-02 13:41:37 -0800104 "Id": {
105 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
106 "readonly": true
107 },
Ed Tanous118b1c72018-09-13 13:45:51 -0700108 "Name": {
109 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
110 "readonly": true
111 },
Ed Tanous530520e2019-01-02 13:41:37 -0800112 "Oem": {
113 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700114 "description": "The OEM extension property.",
115 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
Ed Tanous118b1c72018-09-13 13:45:51 -0700116 },
117 "ServiceEnabled": {
Gunnar Mills844b4152020-06-22 12:44:09 -0500118 "description": "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.",
119 "longDescription": "This property shall indicate whether this service is enabled. If `true`, this service is enabled. If `false`, it is disabled, and new sessions shall not be created, old sessions shall not be deleted, and established sessions can continue operating.",
Ed Tanous530520e2019-01-02 13:41:37 -0800120 "readonly": false,
Ed Tanous118b1c72018-09-13 13:45:51 -0700121 "type": [
122 "boolean",
123 "null"
Ed Tanous530520e2019-01-02 13:41:37 -0800124 ]
Ed Tanous118b1c72018-09-13 13:45:51 -0700125 },
126 "SessionTimeout": {
Gunnar Mills844b4152020-06-22 12:44:09 -0500127 "description": "The number of seconds of inactivity that a session can have before the session service closes the session due to inactivity.",
128 "longDescription": "This property shall contain the threshold of time in seconds between requests on a specific session at which point the session service shall close the session due to inactivity. The session service shall support any value between the Validation.Minimum and Validation.Maximum.",
Ed Tanous530520e2019-01-02 13:41:37 -0800129 "maximum": 86400,
130 "minimum": 30,
131 "readonly": false,
132 "type": "integer",
133 "units": "s"
Ed Tanous118b1c72018-09-13 13:45:51 -0700134 },
135 "Sessions": {
136 "$ref": "http://redfish.dmtf.org/schemas/v1/SessionCollection.json#/definitions/SessionCollection",
Ed Tanouscb103132019-10-08 11:34:22 -0700137 "description": "The link to a collection of sessions.",
Gunnar Mills844b4152020-06-22 12:44:09 -0500138 "longDescription": "This property shall contain a link to a resource collection of type SessionCollection.",
Ed Tanous530520e2019-01-02 13:41:37 -0800139 "readonly": true
Ed Tanous118b1c72018-09-13 13:45:51 -0700140 },
Ed Tanous530520e2019-01-02 13:41:37 -0800141 "Status": {
142 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
Gunnar Mills844b4152020-06-22 12:44:09 -0500143 "description": "The status and health of the resource and its subordinate or dependent resources.",
144 "longDescription": "This property shall contain any status or health properties of the resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700145 }
146 },
147 "required": [
Ed Tanous530520e2019-01-02 13:41:37 -0800148 "@odata.id",
149 "@odata.type",
Ed Tanous118b1c72018-09-13 13:45:51 -0700150 "Id",
151 "Name"
152 ],
Ed Tanous530520e2019-01-02 13:41:37 -0800153 "type": "object"
Ed Tanous118b1c72018-09-13 13:45:51 -0700154 }
155 },
Ed Tanous530520e2019-01-02 13:41:37 -0800156 "owningEntity": "DMTF",
Ed Tanouscb103132019-10-08 11:34:22 -0700157 "release": "2016.2",
Gunnar Mills262d7d42021-01-20 16:28:41 -0600158 "title": "#SessionService.v1_1_8.SessionService"
Ed Tanous530520e2019-01-02 13:41:37 -0800159}