blob: 82c23053644ad01a196a2208c950a74fb923f470 [file] [log] [blame]
Jason M. Billsea4aa752018-06-05 13:29:11 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Ed Tanousa8d8f9d2023-01-26 13:57:00 -08004<!--# Redfish Schema: Session v1.6.0 -->
Jason M. Billsea4aa752018-06-05 13:29:11 -07005<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
Ed Tanoused761212022-09-23 15:03:29 -07008<!--# Copyright 2014-2022 DMTF. -->
Jason M. Billsea4aa752018-06-05 13:29:11 -07009<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
21 <edmx:Include Namespace="Resource.v1_0_0"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
24 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
25 </edmx:Reference>
26
27 <edmx:DataServices>
28
29 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session">
30 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
31
32 <EntityType Name="Session" BaseType="Resource.v1_0_0.Resource" Abstract="true">
Ed Tanoused761212022-09-23 15:03:29 -070033 <Annotation Term="OData.Description" String="The Session resource describes a single connection (session) between a client and a Redfish service instance."/>
34 <Annotation Term="OData.LongDescription" String="This resource shall represent a session for a Redfish implementation."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070035 <Annotation Term="Capabilities.InsertRestrictions">
36 <Record>
37 <PropertyValue Property="Insertable" Bool="false"/>
38 </Record>
39 </Annotation>
40 <Annotation Term="Capabilities.UpdateRestrictions">
41 <Record>
42 <PropertyValue Property="Updatable" Bool="false"/>
43 </Record>
44 </Annotation>
45 <Annotation Term="Capabilities.DeleteRestrictions">
46 <Record>
47 <PropertyValue Property="Deletable" Bool="true"/>
Ed Tanoused761212022-09-23 15:03:29 -070048 <Annotation Term="OData.Description" String="Delete the Session resource to remove a session."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070049 </Record>
50 </Annotation>
Ed Tanous530520e2019-01-02 13:41:37 -080051 <Annotation Term="Redfish.Uris">
52 <Collection>
53 <String>/redfish/v1/SessionService/Sessions/{SessionId}</String>
54 </Collection>
55 </Annotation>
Jason M. Billsea4aa752018-06-05 13:29:11 -070056 </EntityType>
57
58 </Schema>
59
60 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_0_0">
61 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060062 <Annotation Term="Redfish.Release" String="1.0"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070063
64 <EntityType Name="Session" BaseType="Session.Session">
65 <Property Name="UserName" Type="Edm.String">
66 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
67 <Annotation Term="Redfish.RequiredOnCreate"/>
Ed Tanoused761212022-09-23 15:03:29 -070068 <Annotation Term="OData.Description" String="The username for the account for this session."/>
69 <Annotation Term="OData.LongDescription" String="This property shall contain the username that matches an account recognized by the account service."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070070 </Property>
71 <Property Name="Password" Type="Edm.String">
Ed Tanousa8d8f9d2023-01-26 13:57:00 -080072 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/None"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070073 <Annotation Term="Redfish.RequiredOnCreate"/>
Ed Tanouscb103132019-10-08 11:34:22 -070074 <Annotation Term="OData.Description" String="The password for this session. The value is `null` in responses."/>
75 <Annotation Term="OData.LongDescription" String="This property shall contain the password for this session. The value shall be `null` in responses."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070076 </Property>
77 </EntityType>
Jason M. Billsea4aa752018-06-05 13:29:11 -070078 </Schema>
79
80 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_0_2">
81 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
82 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
83 <EntityType Name="Session" BaseType="Session.v1_0_0.Session"/>
84 </Schema>
85
86 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_0_3">
87 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
88 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
89 <EntityType Name="Session" BaseType="Session.v1_0_2.Session"/>
90 </Schema>
91
Ed Tanous530520e2019-01-02 13:41:37 -080092 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_0_4">
93 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
94 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
95 <EntityType Name="Session" BaseType="Session.v1_0_3.Session"/>
96 </Schema>
97
Ed Tanouscb103132019-10-08 11:34:22 -070098 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_0_5">
99 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
100 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
101 <EntityType Name="Session" BaseType="Session.v1_0_4.Session"/>
102 </Schema>
103
104 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_0_6">
105 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
106 <Annotation Term="OData.Description" String="This version was created to update the Password description. It was also created to update descriptions that this schema defines."/>
107 <EntityType Name="Session" BaseType="Session.v1_0_5.Session"/>
108 </Schema>
109
Ed Tanoused761212022-09-23 15:03:29 -0700110 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_0_7">
111 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
112 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
113 <EntityType Name="Session" BaseType="Session.v1_0_6.Session"/>
114 </Schema>
115
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800116 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_0_8">
117 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
118 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
119 <EntityType Name="Session" BaseType="Session.v1_0_7.Session"/>
120 </Schema>
121
Jason M. Billsea4aa752018-06-05 13:29:11 -0700122 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_1_0">
123 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600124 <Annotation Term="Redfish.Release" String="2017.1"/>
Ed Tanoused761212022-09-23 15:03:29 -0700125
Jason M. Billsea4aa752018-06-05 13:29:11 -0700126 <EntityType Name="Session" BaseType="Session.v1_0_3.Session">
127 <Property Name="Actions" Type="Session.v1_1_0.Actions" Nullable="false">
Ed Tanoused761212022-09-23 15:03:29 -0700128 <Annotation Term="OData.Description" String="The available actions for this resource."/>
129 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700130 </Property>
131 </EntityType>
132
133 <ComplexType Name="Actions">
134 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
Ed Tanoused761212022-09-23 15:03:29 -0700135 <Annotation Term="OData.Description" String="The available actions for this resource."/>
136 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800137 <Property Name="Oem" Type="Session.v1_1_0.OemActions" Nullable="false">
Ed Tanoused761212022-09-23 15:03:29 -0700138 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
139 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800140 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700141 </ComplexType>
142
143 <ComplexType Name="OemActions">
144 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
Ed Tanoused761212022-09-23 15:03:29 -0700145 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
146 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700147 </ComplexType>
148 </Schema>
149
Ed Tanous530520e2019-01-02 13:41:37 -0800150 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_1_1">
151 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
152 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that OData properties are marked as required, and integer properties are marked as integer rather than number."/>
153 <EntityType Name="Session" BaseType="Session.v1_1_0.Session"/>
154 </Schema>
155
Ed Tanouscb103132019-10-08 11:34:22 -0700156 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_1_2">
157 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
158 <Annotation Term="OData.Description" String="This version was created to force the regeneration of JSON Schema so that URI properties use the uri-reference format."/>
159 <EntityType Name="Session" BaseType="Session.v1_1_1.Session"/>
160 </Schema>
161
162 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_1_3">
163 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
164 <Annotation Term="OData.Description" String="This version was created to update the Password description. It was also created to update descriptions that this schema defines."/>
165 <EntityType Name="Session" BaseType="Session.v1_1_2.Session"/>
166 </Schema>
167
Ed Tanoused761212022-09-23 15:03:29 -0700168 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_1_4">
169 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
170 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
171 <EntityType Name="Session" BaseType="Session.v1_1_3.Session"/>
172 </Schema>
173
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800174 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_1_5">
175 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
176 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
177 <EntityType Name="Session" BaseType="Session.v1_1_4.Session"/>
178 </Schema>
179
Ed Tanouscb103132019-10-08 11:34:22 -0700180 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_2_0">
181 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
182 <Annotation Term="Redfish.Release" String="2019.1"/>
183
184 <EntityType Name="Session" BaseType="Session.v1_1_2.Session">
185 <Property Name="SessionType" Type="Session.v1_2_0.SessionTypes">
186 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
187 <Annotation Term="OData.Description" String="The active session type."/>
188 <Annotation Term="OData.LongDescription" String="This property shall represent the type of session that is currently active."/>
189 </Property>
190 <Property Name="OemSessionType" Type="Edm.String">
191 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
192 <Annotation Term="OData.Description" String="The active OEM-defined session type."/>
Ed Tanoused761212022-09-23 15:03:29 -0700193 <Annotation Term="OData.LongDescription" String="This property shall contain the OEM-specific session type that is currently active if SessionType contains `OEM`."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700194 </Property>
195 </EntityType>
196
197 <EnumType Name="SessionTypes">
198 <Member Name="HostConsole">
199 <Annotation Term="OData.Description" String="The host's console, which could be connected through Telnet, SSH, or other protocol."/>
200 </Member>
201 <Member Name="ManagerConsole">
202 <Annotation Term="OData.Description" String="The manager's console, which could be connected through Telnet, SSH, SM CLP, or other protocol."/>
203 </Member>
204 <Member Name="IPMI">
205 <Annotation Term="OData.Description" String="Intelligent Platform Management Interface."/>
206 </Member>
207 <Member Name="KVMIP">
208 <Annotation Term="OData.Description" String="Keyboard-Video-Mouse over IP Session."/>
209 </Member>
210 <Member Name="OEM">
Ed Tanoused761212022-09-23 15:03:29 -0700211 <Annotation Term="OData.Description" String="OEM type. For OEM session types, see the OemSessionType property."/>
Ed Tanouscb103132019-10-08 11:34:22 -0700212 </Member>
213 <Member Name="Redfish">
214 <Annotation Term="OData.Description" String="A Redfish session."/>
215 </Member>
216 <Member Name="VirtualMedia">
217 <Annotation Term="OData.Description" String="Virtual media."/>
218 </Member>
219 <Member Name="WebUI">
220 <Annotation Term="OData.Description" String="A non-Redfish web user interface session, such as a graphical interface or another web-based protocol."/>
221 </Member>
222 </EnumType>
223 </Schema>
224
225 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_2_1">
226 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
227 <Annotation Term="OData.Description" String="This version was created to update the Password description. It was also created to update descriptions that this schema defines."/>
228 <EntityType Name="Session" BaseType="Session.v1_2_0.Session"/>
229 </Schema>
230
Ed Tanoused761212022-09-23 15:03:29 -0700231 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_2_2">
232 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
233 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
234 <EntityType Name="Session" BaseType="Session.v1_2_1.Session"/>
235 </Schema>
236
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800237 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_2_3">
238 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
239 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
240 <EntityType Name="Session" BaseType="Session.v1_2_2.Session"/>
241 </Schema>
242
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500243 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_3_0">
244 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
245 <Annotation Term="Redfish.Release" String="2020.3"/>
246
247 <EntityType Name="Session" BaseType="Session.v1_2_1.Session">
248 <Property Name="ClientOriginIPAddress" Type="Edm.String">
249 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
250 <Annotation Term="OData.Description" String="The IP address of the client that created the session."/>
251 <Annotation Term="OData.LongDescription" String="This property shall contain the IP address of the client that created the session."/>
252 </Property>
253 </EntityType>
254 </Schema>
255
Ed Tanoused761212022-09-23 15:03:29 -0700256 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_3_1">
257 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
258 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors."/>
259 <EntityType Name="Session" BaseType="Session.v1_3_0.Session"/>
260 </Schema>
261
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800262 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_3_2">
263 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
264 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
265 <EntityType Name="Session" BaseType="Session.v1_3_1.Session"/>
266 </Schema>
267
Ed Tanoused761212022-09-23 15:03:29 -0700268 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_4_0">
269 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
270 <Annotation Term="Redfish.Release" String="2022.1"/>
271
272 <EntityType Name="Session" BaseType="Session.v1_3_1.Session">
273 <Property Name="CreatedTime" Type="Edm.DateTimeOffset">
274 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
275 <Annotation Term="OData.Description" String="The date and time when the session was created."/>
276 <Annotation Term="OData.LongDescription" String="This property shall contain the date and time when the session was created."/>
277 </Property>
278 </EntityType>
279 </Schema>
280
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800281 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_4_1">
282 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
283 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
284 <EntityType Name="Session" BaseType="Session.v1_4_0.Session"/>
285 </Schema>
286
Asmitha Karunanithi009c6452022-09-22 01:07:59 -0500287 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_5_0">
288 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
289 <Annotation Term="Redfish.Release" String="2022.2"/>
290
291 <EntityType Name="Session" BaseType="Session.v1_4_0.Session">
292 <Property Name="Context" Type="Edm.String">
293 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
294 <Annotation Term="OData.Description" String="A client-supplied string that is stored with the session."/>
295 <Annotation Term="OData.LongDescription" String="This property shall contain a client-supplied context that remains with the session through the session's lifetime."/>
296 </Property>
297 </EntityType>
298 </Schema>
299
Ed Tanousa8d8f9d2023-01-26 13:57:00 -0800300 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_5_1">
301 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
302 <Annotation Term="OData.Description" String="This version was created to mark properties with values containing sensitive data as write-only."/>
303 <EntityType Name="Session" BaseType="Session.v1_5_0.Session"/>
304 </Schema>
305
306 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="Session.v1_6_0">
307 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
308 <Annotation Term="Redfish.Release" String="2022.3"/>
309
310 <EntityType Name="Session" BaseType="Session.v1_5_1.Session">
311 <Property Name="Token" Type="Edm.String">
312 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/None"/>
313 <Annotation Term="OData.Description" String="The multi-factor authentication token for this session. The value is `null` in responses."/>
314 <Annotation Term="OData.LongDescription" String="This property shall contain the multi-factor authentication token for this session. The value shall be `null` in responses."/>
315 </Property>
316 </EntityType>
317 </Schema>
318
Jason M. Billsea4aa752018-06-05 13:29:11 -0700319 </edmx:DataServices>
320</edmx:Edmx>