Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 683f7276576dbf0bf7770570190f6b5b4e84d4c9 / . / static / redfish / v1 / JsonSchemas / SerialInterface / index.json
blob: 3c4658c9c6fe7f39cbc0cc2b4312803a983c732a [file] [log] [blame]
Ed Tanous683f7272018-07-26 12:47:19 -0700[diff] [blame^]1{
2 "$ref": "#/definitions/SerialInterface",
3 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.v1_3_0.json",
4 "copyright": "Copyright 2014-2017 Distributed Management Task Force, Inc. (DMTF). For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
5 "definitions": {
6 "Actions": {
7 "additionalProperties": false,
8 "description": "The available actions for this resource.",
9 "longDescription": "This type shall contain the available actions for this resource.",
10 "patternProperties": {
11 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
12 "description": "This property shall specify a valid odata or Redfish property.",
13 "type": [
14 "array",
15 "boolean",
16 "number",
17 "null",
18 "object",
19 "string"
20 ]
21 }
22 },
23 "properties": {
24 "Oem": {
25 "$ref": "#/definitions/OemActions"
26 }
27 },
28 "type": "object"
29 },
30 "BitRate": {
31 "enum": [
32 "1200",
33 "2400",
34 "4800",
35 "9600",
36 "19200",
37 "38400",
38 "57600",
39 "115200",
40 "230400"
41 ],
42 "enumDescriptions": {
43 "115200": "A bit rate of 115200bps.",
44 "1200": "A bit rate of 1200bps.",
45 "19200": "A bit rate of 19200bps.",
46 "230400": "A bit rate of 230400bps.",
47 "2400": "A bit rate of 2400bps.",
48 "38400": "A bit rate of 38400bps.",
49 "4800": "A bit rate of 4800bps.",
50 "57600": "A bit rate of 57600bps.",
51 "9600": "A bit rate of 9600bps."
52 },
53 "type": "string"
54 },
55 "ConnectorType": {
56 "enum": [
57 "RJ45",
58 "RJ11",
59 "DB9 Female",
60 "DB9 Male",
61 "DB25 Female",
62 "DB25 Male",
63 "USB",
64 "mUSB",
65 "uUSB"
66 ],
67 "enumDescriptions": {
68 "DB25 Female": "A DB25 Female connector.",
69 "DB25 Male": "A DB25 Male connector.",
70 "DB9 Female": "A DB9 Female connector.",
71 "DB9 Male": "A DB9 Male connector.",
72 "RJ11": "An RJ11 connector.",
73 "RJ45": "An RJ45 connector.",
74 "USB": "A USB connector.",
75 "mUSB": "A mUSB connector.",
76 "uUSB": "A uUSB connector."
77 },
78 "type": "string"
79 },
80 "DataBits": {
81 "enum": [
82 "5",
83 "6",
84 "7",
85 "8"
86 ],
87 "enumDescriptions": {
88 "5": "5 bits of data following the start bit.",
89 "6": "6 bits of data following the start bit.",
90 "7": "7 bits of data following the start bit.",
91 "8": "8 bits of data following the start bit."
92 },
93 "type": "string"
94 },
95 "FlowControl": {
96 "enum": [
97 "None",
98 "Software",
99 "Hardware"
100 ],
101 "enumDescriptions": {
102 "Hardware": "Out of band flow control imposed.",
103 "None": "No flow control imposed.",
104 "Software": "XON/XOFF in-band flow control imposed."
105 },
106 "type": "string"
107 },
108 "OemActions": {
109 "additionalProperties": true,
110 "description": "The available OEM specific actions for this resource.",
111 "longDescription": "This type shall contain any additional OEM actions for this resource.",
112 "patternProperties": {
113 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
114 "description": "This property shall specify a valid odata or Redfish property.",
115 "type": [
116 "array",
117 "boolean",
118 "number",
119 "null",
120 "object",
121 "string"
122 ]
123 }
124 },
125 "properties": {},
126 "type": "object"
127 },
128 "Parity": {
129 "enum": [
130 "None",
131 "Even",
132 "Odd",
133 "Mark",
134 "Space"
135 ],
136 "enumDescriptions": {
137 "Even": "An even parity bit.",
138 "Mark": "A mark parity bit.",
139 "None": "No parity bit.",
140 "Odd": "An odd parity bit.",
141 "Space": "A space parity bit."
142 },
143 "type": "string"
144 },
145 "PinOut": {
146 "enum": [
147 "Cisco",
148 "Cyclades",
149 "Digi"
150 ],
151 "enumDescriptions": {
152 "Cisco": "The Cisco pin configuration.",
153 "Cyclades": "The Cyclades pin configuration.",
154 "Digi": "The Digi pin configuration."
155 },
156 "type": "string"
157 },
158 "SerialInterface": {
159 "additionalProperties": false,
160 "description": "This schema defines an asynchronous serial interface resource.",
161 "longDescription": "This resource shall be used to represent serial resources as part of the Redfish specification.",
162 "patternProperties": {
163 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
164 "description": "This property shall specify a valid odata or Redfish property.",
165 "type": [
166 "array",
167 "boolean",
168 "number",
169 "null",
170 "object",
171 "string"
172 ]
173 }
174 },
175 "properties": {
176 "@odata.context": {
177 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/context"
178 },
179 "@odata.id": {
180 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/id"
181 },
182 "@odata.type": {
183 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_1.json#/definitions/type"
184 },
185 "Actions": {
186 "$ref": "#/definitions/Actions",
187 "description": "The available actions for this resource.",
188 "longDescription": "The Actions property shall contain the available actions for this resource."
189 },
190 "BitRate": {
191 "$ref": "#/definitions/BitRate",
192 "description": "The receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection.",
193 "longDescription": "This property shall indicate the transmit and receive speed of the serial connection.",
194 "readonly": false
195 },
196 "ConnectorType": {
197 "$ref": "#/definitions/ConnectorType",
198 "description": "The type of connector used for this interface.",
199 "longDescription": "This property shall indicate the type of phyiscal connector used for this serial connection.",
200 "readonly": true
201 },
202 "DataBits": {
203 "$ref": "#/definitions/DataBits",
204 "description": "The number of data bits that will follow the start bit over the serial connection.",
205 "longDescription": "This property shall indicate number of data bits for the serial connection.",
206 "readonly": false
207 },
208 "Description": {
209 "anyOf": [
210 {
211 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
212 },
213 {
214 "type": "null"
215 }
216 ],
217 "readonly": true
218 },
219 "FlowControl": {
220 "$ref": "#/definitions/FlowControl",
221 "description": "The type of flow control, if any, that will be imposed on the serial connection.",
222 "longDescription": "This property shall indicate the flow control mechanism for the serial connection.",
223 "readonly": false
224 },
225 "Id": {
226 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
227 "readonly": true
228 },
229 "InterfaceEnabled": {
230 "description": "This indicates whether this interface is enabled.",
231 "longDescription": "The value of this property shall be a boolean indicating whether this interface is enabled.",
232 "readonly": false,
233 "type": [
234 "boolean",
235 "null"
236 ]
237 },
238 "Name": {
239 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
240 "readonly": true
241 },
242 "Oem": {
243 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
244 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
245 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
246 },
247 "Parity": {
248 "$ref": "#/definitions/Parity",
249 "description": "The type of parity used by the sender and receiver in order to detect errors over the serial connection.",
250 "longDescription": "This property shall indicate parity information for a serial connection.",
251 "readonly": false
252 },
253 "PinOut": {
254 "anyOf": [
255 {
256 "$ref": "#/definitions/PinOut"
257 },
258 {
259 "type": "null"
260 }
261 ],
262 "description": "The physical pin configuration needed for a serial connector.",
263 "longDescription": "This property shall indicate the physical pin out for the serial connection.",
264 "readonly": true
265 },
266 "SignalType": {
267 "$ref": "#/definitions/SignalType",
268 "description": "The type of signal used for the communication connection - RS232 or RS485.",
269 "longDescription": "This property shall indicate the type of serial signalling that will be utilized for the serial connection.",
270 "readonly": true
271 },
272 "StopBits": {
273 "$ref": "#/definitions/StopBits",
274 "description": "The period of time before the next start bit is transmitted.",
275 "longDescription": "This property shall indicate the stop bits for the serial connection.",
276 "readonly": false
277 }
278 },
279 "required": [
280 "Id",
281 "Name"
282 ],
283 "type": "object"
284 },
285 "SignalType": {
286 "enum": [
287 "Rs232",
288 "Rs485"
289 ],
290 "enumDescriptions": {
291 "Rs232": "The serial interface follows RS232.",
292 "Rs485": "The serial interface follows RS485."
293 },
294 "type": "string"
295 },
296 "StopBits": {
297 "enum": [
298 "1",
299 "2"
300 ],
301 "enumDescriptions": {
302 "1": "1 stop bit following the data bits.",
303 "2": "2 stop bits following the data bits."
304 },
305 "type": "string"
306 }
307 },
308 "title": "#SerialInterface.v1_1_2.SerialInterface"
309}