blob: 4e839e531e85412d6ada5f96750e3eb16b9a043b [file] [log] [blame]
Ed Tanous530520e2019-01-02 13:41:37 -08001{
Ed Tanouscb103132019-10-08 11:34:22 -07002 "$id": "http://redfish.dmtf.org/schemas/v1/JobService.v1_0_2.json",
Ed Tanous530520e2019-01-02 13:41:37 -08003 "$ref": "#/definitions/JobService",
4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
Ed Tanouscb103132019-10-08 11:34:22 -07005 "copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous530520e2019-01-02 13:41:37 -08006 "definitions": {
7 "Actions": {
8 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -07009 "description": "The available actions for this Resource.",
10 "longDescription": "This type shall contain the available actions for this Resource.",
Ed Tanous530520e2019-01-02 13:41:37 -080011 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070012 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous530520e2019-01-02 13:41:37 -080013 "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",
Ed Tanouscb103132019-10-08 11:34:22 -070028 "description": "The available OEM-specific actions for this Resource.",
29 "longDescription": "This property shall contain the available OEM-specific actions for this Resource."
Ed Tanous530520e2019-01-02 13:41:37 -080030 }
31 },
32 "type": "object"
33 },
34 "JobService": {
35 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -070036 "description": "The Redfish Job Service enables the scheduling and execution of operations, represents the properties for the Job Service itself, and has links to the actual Resource Collection of Jobs.",
37 "longDescription": "This Resource shall represent a Job Service for a Redfish implementation.",
Ed Tanous530520e2019-01-02 13:41:37 -080038 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -070039 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous530520e2019-01-02 13:41:37 -080040 "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": {
Ed Tanouscb103132019-10-08 11:34:22 -070054 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
Ed Tanous530520e2019-01-02 13:41:37 -080055 },
56 "@odata.etag": {
Ed Tanouscb103132019-10-08 11:34:22 -070057 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
Ed Tanous530520e2019-01-02 13:41:37 -080058 },
59 "@odata.id": {
Ed Tanouscb103132019-10-08 11:34:22 -070060 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
Ed Tanous530520e2019-01-02 13:41:37 -080061 },
62 "@odata.type": {
Ed Tanouscb103132019-10-08 11:34:22 -070063 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
Ed Tanous530520e2019-01-02 13:41:37 -080064 },
65 "Actions": {
66 "$ref": "#/definitions/Actions",
Ed Tanouscb103132019-10-08 11:34:22 -070067 "description": "The available actions for this Resource.",
68 "longDescription": "This property shall contain the available actions for this Resource."
Ed Tanous530520e2019-01-02 13:41:37 -080069 },
70 "DateTime": {
Ed Tanouscb103132019-10-08 11:34:22 -070071 "description": "The current date and time, with UTC offset, setting that the Job Service uses.",
Ed Tanous530520e2019-01-02 13:41:37 -080072 "format": "date-time",
Ed Tanouscb103132019-10-08 11:34:22 -070073 "longDescription": "This property shall represent the current DateTime value for the Job Service, with UTC offset, in Redfish Timestamp format.",
Ed Tanous530520e2019-01-02 13:41:37 -080074 "readonly": true,
75 "type": [
76 "string",
77 "null"
78 ]
79 },
80 "Description": {
81 "anyOf": [
82 {
83 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
84 },
85 {
86 "type": "null"
87 }
88 ],
89 "readonly": true
90 },
91 "Id": {
92 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
93 "readonly": true
94 },
95 "Jobs": {
96 "$ref": "http://redfish.dmtf.org/schemas/v1/JobCollection.json#/definitions/JobCollection",
Ed Tanouscb103132019-10-08 11:34:22 -070097 "description": "The links to the Jobs collection.",
98 "longDescription": "This property shall contain a link to a Resource of type JobCollection.",
Ed Tanous530520e2019-01-02 13:41:37 -080099 "readonly": true
100 },
101 "Log": {
102 "$ref": "http://redfish.dmtf.org/schemas/v1/LogService.json#/definitions/LogService",
Ed Tanouscb103132019-10-08 11:34:22 -0700103 "description": "The link to a Log Service that the Job Service uses. This service may be a dedicated Log Service or a pointer a Log Service under another entity, such as Manager.",
104 "longDescription": "This property shall contain a link to a Log Service that this Job Service uses.",
Ed Tanous530520e2019-01-02 13:41:37 -0800105 "readonly": true
106 },
107 "Name": {
108 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
109 "readonly": true
110 },
111 "Oem": {
112 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
Ed Tanouscb103132019-10-08 11:34:22 -0700113 "description": "The OEM extension property.",
114 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
Ed Tanous530520e2019-01-02 13:41:37 -0800115 },
116 "ServiceCapabilities": {
117 "$ref": "#/definitions/JobServiceCapabilities",
Ed Tanouscb103132019-10-08 11:34:22 -0700118 "description": "The supported capabilities of this Job Service implementation.",
119 "longDescription": "This type shall contain properties that describe the capabilities or supported features of this implementation of a Job Service."
Ed Tanous530520e2019-01-02 13:41:37 -0800120 },
121 "ServiceEnabled": {
Ed Tanouscb103132019-10-08 11:34:22 -0700122 "description": "An indication of whether this service is enabled.",
123 "longDescription": "This property shall indicate whether this service is enabled.",
Ed Tanous530520e2019-01-02 13:41:37 -0800124 "readonly": false,
125 "type": [
126 "boolean",
127 "null"
128 ]
129 },
130 "Status": {
131 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
Ed Tanouscb103132019-10-08 11:34:22 -0700132 "description": "The status and health of the Resource and its subordinate or dependent Resources.",
133 "longDescription": "This property shall contain any status or health properties of the Resource."
Ed Tanous530520e2019-01-02 13:41:37 -0800134 }
135 },
136 "required": [
137 "@odata.id",
138 "@odata.type",
139 "Id",
140 "Name"
141 ],
142 "type": "object"
143 },
144 "JobServiceCapabilities": {
145 "additionalProperties": false,
Ed Tanouscb103132019-10-08 11:34:22 -0700146 "description": "The supported capabilities of this Job Service implementation.",
147 "longDescription": "This type shall contain properties that describe the capabilities or supported features of this implementation of a Job Service.",
Ed Tanous530520e2019-01-02 13:41:37 -0800148 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700149 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous530520e2019-01-02 13:41:37 -0800150 "description": "This property shall specify a valid odata or Redfish property.",
151 "type": [
152 "array",
153 "boolean",
154 "integer",
155 "number",
156 "null",
157 "object",
158 "string"
159 ]
160 }
161 },
162 "properties": {
163 "MaxJobs": {
Ed Tanouscb103132019-10-08 11:34:22 -0700164 "description": "The maximum number of jobs supported.",
165 "longDescription": "This property shall contain the maximum number of jobs supported by the implementation.",
Ed Tanous530520e2019-01-02 13:41:37 -0800166 "readonly": true,
167 "type": [
168 "integer",
169 "null"
170 ]
171 },
172 "MaxSteps": {
Ed Tanouscb103132019-10-08 11:34:22 -0700173 "description": "The maximum number of job steps supported.",
174 "longDescription": "This property shall contain the maximum number of steps supported by a single job instance.",
Ed Tanous530520e2019-01-02 13:41:37 -0800175 "readonly": true,
176 "type": [
177 "integer",
178 "null"
179 ]
180 },
181 "Scheduling": {
Ed Tanouscb103132019-10-08 11:34:22 -0700182 "description": "An indication of whether scheduling of jobs is supported.",
183 "longDescription": "This property shall indicate whether the Schedule property within the job supports scheduling of jobs.",
Ed Tanous530520e2019-01-02 13:41:37 -0800184 "readonly": true,
185 "type": [
186 "boolean",
187 "null"
188 ]
189 }
190 },
191 "type": "object"
192 },
193 "OemActions": {
194 "additionalProperties": true,
Ed Tanouscb103132019-10-08 11:34:22 -0700195 "description": "The available OEM-specific actions for this Resource.",
196 "longDescription": "This type shall contain the available OEM-specific actions for this Resource.",
Ed Tanous530520e2019-01-02 13:41:37 -0800197 "patternProperties": {
Ed Tanouscb103132019-10-08 11:34:22 -0700198 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
Ed Tanous530520e2019-01-02 13:41:37 -0800199 "description": "This property shall specify a valid odata or Redfish property.",
200 "type": [
201 "array",
202 "boolean",
203 "integer",
204 "number",
205 "null",
206 "object",
207 "string"
208 ]
209 }
210 },
211 "properties": {},
212 "type": "object"
213 }
214 },
215 "owningEntity": "DMTF",
Ed Tanouscb103132019-10-08 11:34:22 -0700216 "release": "2018.2",
217 "title": "#JobService.v1_0_2.JobService"
Ed Tanous530520e2019-01-02 13:41:37 -0800218}