blob: 97cec3dd2375e66e3fe125e43b30b7f2ffb72709 [file] [log] [blame]
Jason M. Billsea4aa752018-06-05 13:29:11 -07001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
4<!--# Redfish Schema: TaskService v1.1.1-->
5<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
8<!--# Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). -->
9<!--# 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>
55 </EntityType>
56
57 </Schema>
58
59 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_0">
60 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
61
62 <EntityType Name="TaskService" BaseType="TaskService.TaskService">
63 <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."/>
64 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent a task service for a Redfish implementation."/>
65 <Property Name="CompletedTaskOverWritePolicy" Type="TaskService.v1_0_0.OverWritePolicy" Nullable="false">
66 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
67 <Annotation Term="OData.Description" String="Overwrite policy of completed tasks."/>
68 <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."/>
69 </Property>
70 <Property Name="DateTime" Type="Edm.DateTimeOffset">
71 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
72 <Annotation Term="OData.Description" String="The current DateTime (with offset) setting that the task service is using."/>
73 <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."/>
74 </Property>
75 <Property Name="LifeCycleEventOnTaskStateChange" Type="Edm.Boolean" Nullable="false">
76 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
77 <Annotation Term="OData.Description" String="Send an Event upon Task State Change."/>
78 <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."/>
79 </Property>
80 <Property Name="ServiceEnabled" Type="Edm.Boolean">
81 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
82 <Annotation Term="OData.Description" String="This indicates whether this service is enabled."/>
83 <Annotation Term="OData.LongDescription" String="The value of this property shall be a boolean indicating whether this service is enabled."/>
84 </Property>
85 <Property Name="Status" Type="Resource.Status" Nullable="false"/>
86 <NavigationProperty Name="Tasks" Type="TaskCollection.TaskCollection" ContainsTarget="true" Nullable="false">
87 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
88 <Annotation Term="OData.Description" String="References to the Tasks collection."/>
89 <Annotation Term="OData.LongDescription" String="The value of this property shall be a link to a resource of type TaskCollection."/>
90 <Annotation Term="OData.AutoExpandReferences"/>
91 </NavigationProperty>
92 </EntityType>
93
94 <EnumType Name="OverWritePolicy">
95 <Member Name="Manual">
96 <Annotation Term="OData.Description" String="Completed tasks are not automatically overwritten."/>
97 </Member>
98 <Member Name="Oldest">
99 <Annotation Term="OData.Description" String="Oldest completed tasks are overwritten."/>
100 </Member>
101 </EnumType>
102
103 </Schema>
104
105 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_2">
106 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
107 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
108 <EntityType Name="TaskService" BaseType="TaskService.v1_0_0.TaskService"/>
109 </Schema>
110
111 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_3">
112 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
113 <Annotation Term="OData.Description" String="This version was created to add explicit Permissions annotations to all properties for clarity."/>
114 <EntityType Name="TaskService" BaseType="TaskService.v1_0_2.TaskService"/>
115 </Schema>
116
117 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_0_4">
118 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
119 <Annotation Term="OData.Description" String="This version was created to correct the LongDescription for LifeCycleEventOnTaskStateChange."/>
120 <EntityType Name="TaskService" BaseType="TaskService.v1_0_3.TaskService"/>
121 </Schema>
122
123 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_1_0">
124 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
125 <EntityType Name="TaskService" BaseType="TaskService.v1_0_3.TaskService">
126 <Property Name="Actions" Type="TaskService.v1_1_0.Actions" Nullable="false">
127 <Annotation Term="OData.Description" String="The available actions for this resource."/>
128 <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/>
129 </Property>
130 </EntityType>
131
132 <ComplexType Name="Actions">
133 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
134 <Annotation Term="OData.Description" String="The available actions for this resource."/>
135 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
136 <Property Name="Oem" Type="TaskService.v1_1_0.OemActions" Nullable="false"/>
137 </ComplexType>
138
139 <ComplexType Name="OemActions">
140 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
141 <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
142 <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
143 </ComplexType>
144 </Schema>
145
146 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="TaskService.v1_1_1">
147 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
148 <Annotation Term="OData.Description" String="This version was created to correct the LongDescription for LifeCycleEventOnTaskStateChange."/>
149 <EntityType Name="TaskService" BaseType="TaskService.v1_1_0.TaskService"/>
150 </Schema>
151
152 </edmx:DataServices>
153</edmx:Edmx>