blob: c55ad7f3ac2a9b65b591ab5fdf1d998fd7361bbe [file] [log] [blame]
Jason M. Billsea4aa752018-06-05 13:29:11 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Ed Tanous530520e2019-01-02 13:41:37 -08004<!--# Redfish Schema: TaskService v1.1.2-->
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 Tanous530520e2019-01-02 13:41:37 -08008<!--# Copyright 2014-2018 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"/>
22 <edmx:Include Namespace="Resource.v1_0_0"/>
23 </edmx:Reference>
24 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
25 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/TaskCollection_v1.xml">
28 <edmx:Include Namespace="TaskCollection"/>
29 </edmx:Reference>
30
31 <edmx:DataServices>
32
33 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService">
34 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
35
36 <EntityType Name="TaskService" BaseType="Resource.v1_0_0.Resource" Abstract="true">
37 <Annotation Term="OData.Description" String="The Task Service of a Redfish service allows scheduling and execution of long-duration processes. It represents the properties for the Task Service itself and has links to the actual collection of Task resources."/>
38 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent a task service for a Redfish implementation."/>
39 <Annotation Term="Capabilities.InsertRestrictions">
40 <Record>
41 <PropertyValue Property="Insertable" Bool="false"/>
42 </Record>
43 </Annotation>
44 <Annotation Term="Capabilities.UpdateRestrictions">
45 <Record>
46 <PropertyValue Property="Updatable" Bool="true"/>
47 <Annotation Term="OData.Description" String="Task Service can be updated to enable or disable the service, though some implemenations may not allow the operation to succeed."/>
48 </Record>
49 </Annotation>
50 <Annotation Term="Capabilities.DeleteRestrictions">
51 <Record>
52 <PropertyValue Property="Deletable" Bool="false"/>
53 </Record>
54 </Annotation>
Ed Tanous530520e2019-01-02 13:41:37 -080055 <Annotation Term="Redfish.Uris">
56 <Collection>
57 <String>/redfish/v1/TaskService</String>
58 </Collection>
59 </Annotation>
Jason M. Billsea4aa752018-06-05 13:29:11 -070060 </EntityType>
61
62 </Schema>
63
64 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_0">
65 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -060066 <Annotation Term="Redfish.Release" String="1.0"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -070067
68 <EntityType Name="TaskService" BaseType="TaskService.TaskService">
69 <Annotation Term="OData.Description" String="This is the schema definition for the Task Service. It represents the properties for the service itself and has links to the actual list of tasks."/>
70 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent a task service for a Redfish implementation."/>
71 <Property Name="CompletedTaskOverWritePolicy" Type="TaskService.v1_0_0.OverWritePolicy" Nullable="false">
72 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
73 <Annotation Term="OData.Description" String="Overwrite policy of completed tasks."/>
74 <Annotation Term="OData.LongDescription" String="The value of this property shall indicate how completed tasks are handled should the task service need to track more tasks."/>
75 </Property>
76 <Property Name="DateTime" Type="Edm.DateTimeOffset">
77 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
78 <Annotation Term="OData.Description" String="The current DateTime (with offset) setting that the task service is using."/>
79 <Annotation Term="OData.LongDescription" String="The value of this property shall represent the current DateTime value for the TaskService, with offset from UTC, in Redfish Timestamp format."/>
80 </Property>
81 <Property Name="LifeCycleEventOnTaskStateChange" Type="Edm.Boolean" Nullable="false">
82 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
83 <Annotation Term="OData.Description" String="Send an Event upon Task State Change."/>
84 <Annotation Term="OData.LongDescription" String="The value of this property, if set to true, shall indicate that the service shall send a Life cycle event to Event Destinations Subscriptions registered for such events upon change of task state. Life cycle events are defined in the Eventing section of the Redfish Specification."/>
85 </Property>
86 <Property Name="ServiceEnabled" Type="Edm.Boolean">
87 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
88 <Annotation Term="OData.Description" String="This indicates whether this service is enabled."/>
89 <Annotation Term="OData.LongDescription" String="The value of this property shall be a boolean indicating whether this service is enabled."/>
90 </Property>
Ed Tanous530520e2019-01-02 13:41:37 -080091 <Property Name="Status" Type="Resource.Status" Nullable="false">
92 <Annotation Term="OData.Description" String="This property describes the status and health of the resource and its children."/>
93 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
94 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -070095 <NavigationProperty Name="Tasks" Type="TaskCollection.TaskCollection" ContainsTarget="true" Nullable="false">
96 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
97 <Annotation Term="OData.Description" String="References to the Tasks collection."/>
98 <Annotation Term="OData.LongDescription" String="The value of this property shall be a link to a resource of type TaskCollection."/>
99 <Annotation Term="OData.AutoExpandReferences"/>
100 </NavigationProperty>
101 </EntityType>
102
103 <EnumType Name="OverWritePolicy">
104 <Member Name="Manual">
105 <Annotation Term="OData.Description" String="Completed tasks are not automatically overwritten."/>
106 </Member>
107 <Member Name="Oldest">
108 <Annotation Term="OData.Description" String="Oldest completed tasks are overwritten."/>
109 </Member>
110 </EnumType>
111
112 </Schema>
113
114 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_2">
115 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
116 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
117 <EntityType Name="TaskService" BaseType="TaskService.v1_0_0.TaskService"/>
118 </Schema>
119
120 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_3">
121 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
122 <Annotation Term="OData.Description" String="This version was created to add explicit Permissions annotations to all properties for clarity."/>
123 <EntityType Name="TaskService" BaseType="TaskService.v1_0_2.TaskService"/>
124 </Schema>
125
126 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_4">
127 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
128 <Annotation Term="OData.Description" String="This version was created to correct the LongDescription for LifeCycleEventOnTaskStateChange."/>
129 <EntityType Name="TaskService" BaseType="TaskService.v1_0_3.TaskService"/>
130 </Schema>
131
Ed Tanous530520e2019-01-02 13:41:37 -0800132 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_5">
133 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
134 <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."/>
135 <EntityType Name="TaskService" BaseType="TaskService.v1_0_4.TaskService"/>
136 </Schema>
137
Jason M. Billsea4aa752018-06-05 13:29:11 -0700138 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_1_0">
139 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600140 <Annotation Term="Redfish.Release" String="2017.1"/>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700141 <EntityType Name="TaskService" BaseType="TaskService.v1_0_3.TaskService">
142 <Property Name="Actions" Type="TaskService.v1_1_0.Actions" Nullable="false">
143 <Annotation Term="OData.Description" String="The available actions for this resource."/>
144 <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800145 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700146 </EntityType>
147
148 <ComplexType Name="Actions">
149 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
150 <Annotation Term="OData.Description" String="The available actions for this resource."/>
151 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
Ed Tanous530520e2019-01-02 13:41:37 -0800152 <Property Name="Oem" Type="TaskService.v1_1_0.OemActions" Nullable="false">
153 <Annotation Term="OData.Description" String="This property contains the available OEM specific actions for this resource."/>
154 <Annotation Term="OData.LongDescription" String="This property shall contain any additional OEM actions for this resource."/>
155 </Property>
Jason M. Billsea4aa752018-06-05 13:29:11 -0700156 </ComplexType>
157
158 <ComplexType Name="OemActions">
159 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
160 <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
161 <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
162 </ComplexType>
163 </Schema>
164
165 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_1_1">
166 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
167 <Annotation Term="OData.Description" String="This version was created to correct the LongDescription for LifeCycleEventOnTaskStateChange."/>
168 <EntityType Name="TaskService" BaseType="TaskService.v1_1_0.TaskService"/>
169 </Schema>
170
Ed Tanous530520e2019-01-02 13:41:37 -0800171 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_1_2">
172 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
173 <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."/>
174 <EntityType Name="TaskService" BaseType="TaskService.v1_1_1.TaskService"/>
175 </Schema>
176
Jason M. Billsea4aa752018-06-05 13:29:11 -0700177 </edmx:DataServices>
178</edmx:Edmx>