xref: /openbmc/bmcweb/features/redfish/schema/dmtf/csdl/JobExecutor_v1.xml (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)
1*c6d7a45dSGunnar Mills<?xml version="1.0" encoding="UTF-8"?>
2*c6d7a45dSGunnar Mills<!---->
3*c6d7a45dSGunnar Mills<!--################################################################################       -->
4*c6d7a45dSGunnar Mills<!--# Redfish Schema:  JobExecutor v1.0.0                                                  -->
5*c6d7a45dSGunnar Mills<!--#                                                                                      -->
6*c6d7a45dSGunnar Mills<!--# For a detailed change log, see the README file contained in the DSP8010 bundle,      -->
7*c6d7a45dSGunnar Mills<!--# available at http://www.dmtf.org/standards/redfish                                   -->
8*c6d7a45dSGunnar Mills<!--# Copyright 2014-2025 DMTF.                                                            -->
9*c6d7a45dSGunnar Mills<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10*c6d7a45dSGunnar Mills<!--################################################################################       -->
11*c6d7a45dSGunnar Mills<!---->
12*c6d7a45dSGunnar Mills<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13*c6d7a45dSGunnar Mills
14*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16*c6d7a45dSGunnar Mills  </edmx:Reference>
17*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19*c6d7a45dSGunnar Mills  </edmx:Reference>
20*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
21*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Resource"/>
22*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Resource.v1_0_0"/>
23*c6d7a45dSGunnar Mills  </edmx:Reference>
24*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
25*c6d7a45dSGunnar Mills    <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
26*c6d7a45dSGunnar Mills  </edmx:Reference>
27*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Job_v1.xml">
28*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Job"/>
29*c6d7a45dSGunnar Mills  </edmx:Reference>
30*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Chassis_v1.xml">
31*c6d7a45dSGunnar Mills    <edmx:Include Namespace="Chassis"/>
32*c6d7a45dSGunnar Mills  </edmx:Reference>
33*c6d7a45dSGunnar Mills  <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/ComputerSystem_v1.xml">
34*c6d7a45dSGunnar Mills    <edmx:Include Namespace="ComputerSystem"/>
35*c6d7a45dSGunnar Mills  </edmx:Reference>
36*c6d7a45dSGunnar Mills
37*c6d7a45dSGunnar Mills  <edmx:DataServices>
38*c6d7a45dSGunnar Mills
39*c6d7a45dSGunnar Mills    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="JobExecutor">
40*c6d7a45dSGunnar Mills      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
41*c6d7a45dSGunnar Mills      <Annotation Term="Redfish.Language" String="en"/>
42*c6d7a45dSGunnar Mills
43*c6d7a45dSGunnar Mills      <EntityType Name="JobExecutor" BaseType="Resource.v1_0_0.Resource" Abstract="true">
44*c6d7a45dSGunnar Mills        <Annotation Term="OData.Description" String="The `JobExecutor` schema describes an entity that carries out a job."/>
45*c6d7a45dSGunnar Mills        <Annotation Term="OData.LongDescription" String="This resource shall represent a job executor for a Redfish implementation."/>
46*c6d7a45dSGunnar Mills        <Annotation Term="Capabilities.InsertRestrictions">
47*c6d7a45dSGunnar Mills          <Record>
48*c6d7a45dSGunnar Mills            <PropertyValue Property="Insertable" Bool="false"/>
49*c6d7a45dSGunnar Mills          </Record>
50*c6d7a45dSGunnar Mills        </Annotation>
51*c6d7a45dSGunnar Mills        <Annotation Term="Capabilities.UpdateRestrictions">
52*c6d7a45dSGunnar Mills          <Record>
53*c6d7a45dSGunnar Mills            <PropertyValue Property="Updatable" Bool="false"/>
54*c6d7a45dSGunnar Mills          </Record>
55*c6d7a45dSGunnar Mills        </Annotation>
56*c6d7a45dSGunnar Mills        <Annotation Term="Capabilities.DeleteRestrictions">
57*c6d7a45dSGunnar Mills          <Record>
58*c6d7a45dSGunnar Mills            <PropertyValue Property="Deletable" Bool="true"/>
59*c6d7a45dSGunnar Mills          </Record>
60*c6d7a45dSGunnar Mills        </Annotation>
61*c6d7a45dSGunnar Mills        <Annotation Term="Redfish.Uris">
62*c6d7a45dSGunnar Mills          <Collection>
63*c6d7a45dSGunnar Mills            <String>/redfish/v1/JobService/Executors/{JobExecutorId}</String>
64*c6d7a45dSGunnar Mills          </Collection>
65*c6d7a45dSGunnar Mills        </Annotation>
66*c6d7a45dSGunnar Mills      </EntityType>
67*c6d7a45dSGunnar Mills    </Schema>
68*c6d7a45dSGunnar Mills
69*c6d7a45dSGunnar Mills    <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="JobExecutor.v1_0_0">
70*c6d7a45dSGunnar Mills      <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
71*c6d7a45dSGunnar Mills      <Annotation Term="Redfish.Release" String="2025.2"/>
72*c6d7a45dSGunnar Mills
73*c6d7a45dSGunnar Mills      <EntityType Name="JobExecutor" BaseType="JobExecutor.JobExecutor">
74*c6d7a45dSGunnar Mills        <Property Name="ExecutorType" Type="Edm.String" Nullable="false">
75*c6d7a45dSGunnar Mills          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
76*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The primary type of job this executor processes."/>
77*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the primary type of job executed by this resource."/>
78*c6d7a45dSGunnar Mills        </Property>
79*c6d7a45dSGunnar Mills        <Property Name="Status" Type="Resource.Status" Nullable="false">
80*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
81*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
82*c6d7a45dSGunnar Mills        </Property>
83*c6d7a45dSGunnar Mills        <Property Name="MaximumConcurrentJobs" Type="Edm.Int64" Nullable="false">
84*c6d7a45dSGunnar Mills          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
85*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The maximum concurrent jobs this executor can process."/>
86*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the maximum concurrent jobs this executor can process."/>
87*c6d7a45dSGunnar Mills        </Property>
88*c6d7a45dSGunnar Mills        <Property Name="Links" Type="JobExecutor.v1_0_0.Links" Nullable="false">
89*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
90*c6d7a45dSGunnar Mills          <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*c6d7a45dSGunnar Mills        </Property>
92*c6d7a45dSGunnar Mills        <Property Name="Actions" Type="JobExecutor.v1_0_0.Actions" Nullable="false">
93*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The available actions for this resource."/>
94*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
95*c6d7a45dSGunnar Mills        </Property>
96*c6d7a45dSGunnar Mills      </EntityType>
97*c6d7a45dSGunnar Mills
98*c6d7a45dSGunnar Mills      <ComplexType Name="Links">
99*c6d7a45dSGunnar Mills        <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
100*c6d7a45dSGunnar Mills        <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*c6d7a45dSGunnar Mills        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
102*c6d7a45dSGunnar Mills        <NavigationProperty Name="ExecutingJobs" Type="Collection(Job.Job)">
103*c6d7a45dSGunnar Mills          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
104*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="Links to jobs this executor is running."/>
105*c6d7a45dSGunnar Mills          <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*c6d7a45dSGunnar Mills          <Annotation Term="OData.AutoExpandReferences"/>
107*c6d7a45dSGunnar Mills        </NavigationProperty>
108*c6d7a45dSGunnar Mills        <NavigationProperty Name="Chassis" Type="Collection(Chassis.Chassis)">
109*c6d7a45dSGunnar Mills          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
110*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="An array of links to the chassis that contain this equipment."/>
111*c6d7a45dSGunnar Mills          <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*c6d7a45dSGunnar Mills          <Annotation Term="OData.AutoExpandReferences"/>
113*c6d7a45dSGunnar Mills        </NavigationProperty>
114*c6d7a45dSGunnar Mills        <NavigationProperty Name="ComputerSystem" Type="ComputerSystem.ComputerSystem" Nullable="false">
115*c6d7a45dSGunnar Mills          <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
116*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The system that is performing the work of this job executor."/>
117*c6d7a45dSGunnar Mills          <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*c6d7a45dSGunnar Mills          <Annotation Term="OData.AutoExpandReferences"/>
119*c6d7a45dSGunnar Mills        </NavigationProperty>
120*c6d7a45dSGunnar Mills      </ComplexType>
121*c6d7a45dSGunnar Mills
122*c6d7a45dSGunnar Mills      <ComplexType Name="Actions">
123*c6d7a45dSGunnar Mills        <Annotation Term="OData.AdditionalProperties" Bool="false"/>
124*c6d7a45dSGunnar Mills        <Annotation Term="OData.Description" String="The available actions for this resource."/>
125*c6d7a45dSGunnar Mills        <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
126*c6d7a45dSGunnar Mills        <Property Name="Oem" Type="JobExecutor.v1_0_0.OemActions" Nullable="false">
127*c6d7a45dSGunnar Mills          <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
128*c6d7a45dSGunnar Mills          <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
129*c6d7a45dSGunnar Mills        </Property>
130*c6d7a45dSGunnar Mills      </ComplexType>
131*c6d7a45dSGunnar Mills
132*c6d7a45dSGunnar Mills      <ComplexType Name="OemActions">
133*c6d7a45dSGunnar Mills        <Annotation Term="OData.AdditionalProperties" Bool="true"/>
134*c6d7a45dSGunnar Mills        <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
135*c6d7a45dSGunnar Mills        <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
136*c6d7a45dSGunnar Mills      </ComplexType>
137*c6d7a45dSGunnar Mills    </Schema>
138*c6d7a45dSGunnar Mills
139*c6d7a45dSGunnar Mills  </edmx:DataServices>
140*c6d7a45dSGunnar Mills</edmx:Edmx>
141