xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/JobExecutor.v1_0_0.json (revision c6d7a45d427f9a6d9e761afcf305761dca60d7cf)
1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/JobExecutor.v1_0_0.json",
3    "$ref": "#/definitions/JobExecutor",
4    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
5    "copyright": "Copyright 2014-2025 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
6    "definitions": {
7        "Actions": {
8            "additionalProperties": false,
9            "description": "The available actions for this resource.",
10            "longDescription": "This type shall contain the available actions for this resource.",
11            "patternProperties": {
12                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
13                    "description": "This property shall specify a valid odata or Redfish property.",
14                    "type": [
15                        "array",
16                        "boolean",
17                        "integer",
18                        "number",
19                        "null",
20                        "object",
21                        "string"
22                    ]
23                }
24            },
25            "properties": {
26                "Oem": {
27                    "$ref": "#/definitions/OemActions",
28                    "description": "The available OEM-specific actions for this resource.",
29                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
30                }
31            },
32            "type": "object"
33        },
34        "JobExecutor": {
35            "additionalProperties": false,
36            "description": "The `JobExecutor` schema describes an entity that carries out a job.",
37            "longDescription": "This resource shall represent a job executor for a Redfish implementation.",
38            "patternProperties": {
39                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
40                    "description": "This property shall specify a valid odata or Redfish property.",
41                    "type": [
42                        "array",
43                        "boolean",
44                        "integer",
45                        "number",
46                        "null",
47                        "object",
48                        "string"
49                    ]
50                }
51            },
52            "properties": {
53                "@odata.context": {
54                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
55                },
56                "@odata.etag": {
57                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
58                },
59                "@odata.id": {
60                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
61                },
62                "@odata.type": {
63                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
64                },
65                "Actions": {
66                    "$ref": "#/definitions/Actions",
67                    "description": "The available actions for this resource.",
68                    "longDescription": "This property shall contain the available actions for this resource."
69                },
70                "Description": {
71                    "anyOf": [
72                        {
73                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
74                        },
75                        {
76                            "type": "null"
77                        }
78                    ],
79                    "readonly": true
80                },
81                "ExecutorType": {
82                    "description": "The primary type of job this executor processes.",
83                    "longDescription": "This property shall contain the primary type of job executed by this resource.",
84                    "readonly": true,
85                    "type": "string"
86                },
87                "Id": {
88                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
89                    "readonly": true
90                },
91                "Links": {
92                    "$ref": "#/definitions/Links",
93                    "description": "The links to other resources that are related to this resource.",
94                    "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."
95                },
96                "MaximumConcurrentJobs": {
97                    "description": "The maximum concurrent jobs this executor can process.",
98                    "longDescription": "This property shall contain the maximum concurrent jobs this executor can process.",
99                    "readonly": true,
100                    "type": "integer"
101                },
102                "Name": {
103                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
104                    "readonly": true
105                },
106                "Oem": {
107                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
108                    "description": "The OEM extension property.",
109                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
110                },
111                "Status": {
112                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
113                    "description": "The status and health of the resource and its subordinate or dependent resources.",
114                    "longDescription": "This property shall contain any status or health properties of the resource."
115                }
116            },
117            "required": [
118                "@odata.id",
119                "@odata.type",
120                "Id",
121                "Name"
122            ],
123            "type": "object"
124        },
125        "Links": {
126            "additionalProperties": false,
127            "description": "The links to other resources that are related to this resource.",
128            "longDescription": "This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.",
129            "patternProperties": {
130                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
131                    "description": "This property shall specify a valid odata or Redfish property.",
132                    "type": [
133                        "array",
134                        "boolean",
135                        "integer",
136                        "number",
137                        "null",
138                        "object",
139                        "string"
140                    ]
141                }
142            },
143            "properties": {
144                "Chassis": {
145                    "description": "An array of links to the chassis that contain this equipment.",
146                    "items": {
147                        "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis"
148                    },
149                    "longDescription": "This property shall contain an array of links to resources of type `Chassis` that represent the physical containers that contain this equipment.",
150                    "readonly": true,
151                    "type": "array"
152                },
153                "Chassis@odata.count": {
154                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
155                },
156                "ComputerSystem": {
157                    "$ref": "http://redfish.dmtf.org/schemas/v1/ComputerSystem.json#/definitions/ComputerSystem",
158                    "description": "The system that is performing the work of this job executor.",
159                    "longDescription": "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.",
160                    "readonly": true
161                },
162                "ExecutingJobs": {
163                    "description": "Links to jobs this executor is running.",
164                    "items": {
165                        "$ref": "http://redfish.dmtf.org/schemas/v1/Job.json#/definitions/Job"
166                    },
167                    "longDescription": "This property shall contain an array of links to resources of type `Job` that represent the jobs this executor is running.",
168                    "readonly": true,
169                    "type": "array"
170                },
171                "ExecutingJobs@odata.count": {
172                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
173                }
174            },
175            "type": "object"
176        },
177        "OemActions": {
178            "additionalProperties": true,
179            "description": "The available OEM-specific actions for this resource.",
180            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
181            "patternProperties": {
182                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
183                    "description": "This property shall specify a valid odata or Redfish property.",
184                    "type": [
185                        "array",
186                        "boolean",
187                        "integer",
188                        "number",
189                        "null",
190                        "object",
191                        "string"
192                    ]
193                }
194            },
195            "properties": {},
196            "type": "object"
197        }
198    },
199    "language": "en",
200    "owningEntity": "DMTF",
201    "release": "2025.2",
202    "title": "#JobExecutor.v1_0_0.JobExecutor"
203}