blob: 8b69c0e01ee9f43bfcd338f81fa7fc3128581983 [file] [log] [blame]
Ed Tanous530520e2019-01-02 13:41:37 -08001<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
4<!--# Redfish Schema: JobService v1.0.0-->
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-2018 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/RedfishExtensions_v1.xml">
21 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
24 <edmx:Include Namespace="Resource"/>
25 <edmx:Include Namespace="Resource.v1_0_0"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/JobCollection_v1.xml">
28 <edmx:Include Namespace="JobCollection"/>
29 </edmx:Reference>
30 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/LogService_v1.xml">
31 <edmx:Include Namespace="LogService"/>
32 </edmx:Reference>
33
34 <edmx:DataServices>
35
36 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="JobService">
37 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
38
39 <EntityType Name="JobService" BaseType="Resource.v1_0_0.Resource" Abstract="true">
40 <Annotation Term="OData.Description" String="The Job Service of a Redfish service allows scheduling and execution of long-duration processes. It represents the properties for the Job Service itself and has links to the actual collection of Job resources."/>
41 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent a job service for a Redfish implementation."/>
42 <Annotation Term="Capabilities.InsertRestrictions">
43 <Record>
44 <PropertyValue Property="Insertable" Bool="false"/>
45 </Record>
46 </Annotation>
47 <Annotation Term="Capabilities.UpdateRestrictions">
48 <Record>
49 <PropertyValue Property="Updatable" Bool="true"/>
50 <Annotation Term="OData.Description" String="Job Service can be updated to enable or disable the service, though some implementations may not allow the operation to succeed."/>
51 </Record>
52 </Annotation>
53 <Annotation Term="Capabilities.DeleteRestrictions">
54 <Record>
55 <PropertyValue Property="Deletable" Bool="false"/>
56 </Record>
57 </Annotation>
58 <Annotation Term="Redfish.Uris">
59 <Collection>
60 <String>/redfish/v1/JobService</String>
61 </Collection>
62 </Annotation>
63 </EntityType>
64 </Schema>
65
66 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="JobService.v1_0_0">
67 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
68 <EntityType Name="JobService" BaseType="JobService.JobService">
69 <Annotation Term="OData.Description" String="This is the schema definition for the Job 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 job service for a Redfish implementation."/>
71 <Property Name="DateTime" Type="Edm.DateTimeOffset">
72 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
73 <Annotation Term="OData.Description" String="The current DateTime (with offset) setting that the job service is using."/>
74 <Annotation Term="OData.LongDescription" String="The value of this property shall represent the current DateTime value for the JobService, with offset from UTC, in Redfish Timestamp format."/>
75 </Property>
76 <Property Name="ServiceEnabled" Type="Edm.Boolean">
77 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
78 <Annotation Term="OData.Description" String="This indicates whether this service is enabled."/>
79 <Annotation Term="OData.LongDescription" String="The value of this property shall be a boolean indicating whether this service is enabled."/>
80 </Property>
81 <Property Name="ServiceCapabilities" Type="JobService.v1_0_0.JobServiceCapabilities" Nullable="false">
82 <Annotation Term="OData.Description" String="This object describes the supported capabilities of this Job Service implementation."/>
83 <Annotation Term="OData.LongDescription" String="This type shall contain properties which describe the capabilities or supported features of this implementation of JobService."/>
84 </Property>
85 <Property Name="Status" Type="Resource.Status" Nullable="false">
86 <Annotation Term="OData.Description" String="This property describes the status and health of the resource and its children."/>
87 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
88 </Property>
89 <NavigationProperty Name="Log" Type="LogService.LogService" ContainsTarget="true" Nullable="false">
90 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
91 <Annotation Term="OData.Description" String="This is a reference to a Log Service used by the Job Service."/>
92 <Annotation Term="OData.LongDescription" String="The value of this property shall contain a reference to a LogService for the use by this JobService."/>
93 <Annotation Term="OData.AutoExpandReferences"/>
94 </NavigationProperty>
95 <NavigationProperty Name="Jobs" Type="JobCollection.JobCollection" ContainsTarget="true" Nullable="false">
96 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
97 <Annotation Term="OData.Description" String="References to the Jobs collection."/>
98 <Annotation Term="OData.LongDescription" String="The value of this property shall be a link to a resource of type JobCollection."/>
99 <Annotation Term="OData.AutoExpandReferences"/>
100 </NavigationProperty>
101 <Property Name="Actions" Type="JobService.v1_0_0.Actions" Nullable="false">
102 <Annotation Term="OData.Description" String="The available actions for this resource."/>
103 <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/>
104 </Property>
105 </EntityType>
106
107 <ComplexType Name="JobServiceCapabilities">
108 <Annotation Term="OData.Description" String="This object describes the supported capabilities of this Job Service implementation."/>
109 <Annotation Term="OData.LongDescription" String="This type shall contain properties which describe the capabilities or supported features of this implementation of JobService."/>
110 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
111 <Property Name="MaxJobs" Type="Edm.Int64">
112 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
113 <Annotation Term="OData.Description" String="Maximum number of Jobs supported."/>
114 <Annotation Term="OData.LongDescription" String="The value of this property shall be the maximum number of Job resources supported by the implementation."/>
115 </Property>
116 <Property Name="MaxSteps" Type="Edm.Int64">
117 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
118 <Annotation Term="OData.Description" String="Maximum number of Job Steps supported."/>
119 <Annotation Term="OData.LongDescription" String="The value of this property shall be the maximum number of Step resources supported by a single Job instance."/>
120 </Property>
121 <Property Name="Scheduling" Type="Edm.Boolean">
122 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
123 <Annotation Term="OData.Description" String="Indicates whether scheduling of Jobs is supported."/>
124 <Annotation Term="OData.LongDescription" String="The value of this property shall indicate the support of scheduling of Jobs using the Schedule object within the Job resource."/>
125 </Property>
126 </ComplexType>
127
128 <ComplexType Name="Actions">
129 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
130 <Annotation Term="OData.Description" String="The available actions for this resource."/>
131 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
132 <Property Name="Oem" Type="JobService.v1_0_0.OemActions" Nullable="false">
133 <Annotation Term="OData.Description" String="This property contains the available OEM specific actions for this resource."/>
134 <Annotation Term="OData.LongDescription" String="This property shall contain any additional OEM actions for this resource."/>
135 </Property>
136 </ComplexType>
137
138 <ComplexType Name="OemActions">
139 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
140 <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
141 <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
142 </ComplexType>
143 </Schema>
144
145 </edmx:DataServices>
146</edmx:Edmx>