xref: /openbmc/bmcweb/redfish-core/schema/dmtf/csdl/JobExecutor_v1.xml (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)
1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################       -->
4<!--# Redfish Schema:  JobExecutor 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-2025 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/Job_v1.xml">
28    <edmx:Include Namespace="Job"/>
29  </edmx:Reference>
30  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Chassis_v1.xml">
31    <edmx:Include Namespace="Chassis"/>
32  </edmx:Reference>
33  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ComputerSystem_v1.xml">
34    <edmx:Include Namespace="ComputerSystem"/>
35  </edmx:Reference>
36
37  <edmx:DataServices>
38
39    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="JobExecutor">
40      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
41      <Annotation Term="Redfish.Language" String="en"/>
42
43      <EntityType Name="JobExecutor" BaseType="Resource.v1_0_0.Resource" Abstract="true">
44        <Annotation Term="OData.Description" String="The `JobExecutor` schema describes an entity that carries out a job."/>
45        <Annotation Term="OData.LongDescription" String="This resource shall represent a job executor for a Redfish implementation."/>
46        <Annotation Term="Capabilities.InsertRestrictions">
47          <Record>
48            <PropertyValue Property="Insertable" Bool="false"/>
49          </Record>
50        </Annotation>
51        <Annotation Term="Capabilities.UpdateRestrictions">
52          <Record>
53            <PropertyValue Property="Updatable" Bool="false"/>
54          </Record>
55        </Annotation>
56        <Annotation Term="Capabilities.DeleteRestrictions">
57          <Record>
58            <PropertyValue Property="Deletable" Bool="true"/>
59          </Record>
60        </Annotation>
61        <Annotation Term="Redfish.Uris">
62          <Collection>
63            <String>/redfish/v1/JobService/Executors/{JobExecutorId}</String>
64          </Collection>
65        </Annotation>
66      </EntityType>
67    </Schema>
68
69    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="JobExecutor.v1_0_0">
70      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
71      <Annotation Term="Redfish.Release" String="2025.2"/>
72
73      <EntityType Name="JobExecutor" BaseType="JobExecutor.JobExecutor">
74        <Property Name="ExecutorType" Type="Edm.String" Nullable="false">
75          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
76          <Annotation Term="OData.Description" String="The primary type of job this executor processes."/>
77          <Annotation Term="OData.LongDescription" String="This property shall contain the primary type of job executed by this resource."/>
78        </Property>
79        <Property Name="Status" Type="Resource.Status" Nullable="false">
80          <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
81          <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
82        </Property>
83        <Property Name="MaximumConcurrentJobs" Type="Edm.Int64" Nullable="false">
84          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
85          <Annotation Term="OData.Description" String="The maximum concurrent jobs this executor can process."/>
86          <Annotation Term="OData.LongDescription" String="This property shall contain the maximum concurrent jobs this executor can process."/>
87        </Property>
88        <Property Name="Links" Type="JobExecutor.v1_0_0.Links" Nullable="false">
89          <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
90          <Annotation Term="OData.LongDescription" String="This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."/>
91        </Property>
92        <Property Name="Actions" Type="JobExecutor.v1_0_0.Actions" Nullable="false">
93          <Annotation Term="OData.Description" String="The available actions for this resource."/>
94          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
95        </Property>
96      </EntityType>
97
98      <ComplexType Name="Links">
99        <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
100        <Annotation Term="OData.LongDescription" String="This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."/>
101        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
102        <NavigationProperty Name="ExecutingJobs" Type="Collection(Job.Job)">
103          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
104          <Annotation Term="OData.Description" String="Links to jobs this executor is running."/>
105          <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type `Job` that represent the jobs this executor is running."/>
106          <Annotation Term="OData.AutoExpandReferences"/>
107        </NavigationProperty>
108        <NavigationProperty Name="Chassis" Type="Collection(Chassis.Chassis)">
109          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
110          <Annotation Term="OData.Description" String="An array of links to the chassis that contain this equipment."/>
111          <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type `Chassis` that represent the physical containers that contain this equipment."/>
112          <Annotation Term="OData.AutoExpandReferences"/>
113        </NavigationProperty>
114        <NavigationProperty Name="ComputerSystem" Type="ComputerSystem.ComputerSystem" Nullable="false">
115          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
116          <Annotation Term="OData.Description" String="The system that is performing the work of this job executor."/>
117          <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type `ComputerSystem` that represents the system that is performing the work of this job executor."/>
118          <Annotation Term="OData.AutoExpandReferences"/>
119        </NavigationProperty>
120      </ComplexType>
121
122      <ComplexType Name="Actions">
123        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
124        <Annotation Term="OData.Description" String="The available actions for this resource."/>
125        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
126        <Property Name="Oem" Type="JobExecutor.v1_0_0.OemActions" Nullable="false">
127          <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
128          <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
129        </Property>
130      </ComplexType>
131
132      <ComplexType Name="OemActions">
133        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
134        <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
135        <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
136      </ComplexType>
137    </Schema>
138
139  </edmx:DataServices>
140</edmx:Edmx>
141