1{ 2 "$id": "http://redfish.dmtf.org/schemas/v1/SerialInterface.v1_2_1.json", 3 "$ref": "#/definitions/SerialInterface", 4 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", 5 "copyright": "Copyright 2014-2024 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 "versionAdded": "v1_1_0" 31 } 32 }, 33 "type": "object" 34 }, 35 "BitRate": { 36 "enum": [ 37 "1200", 38 "2400", 39 "4800", 40 "9600", 41 "19200", 42 "38400", 43 "57600", 44 "115200", 45 "230400" 46 ], 47 "enumDescriptions": { 48 "115200": "A bit rate of 115200 bit/s.", 49 "1200": "A bit rate of 1200 bit/s.", 50 "19200": "A bit rate of 19200 bit/s.", 51 "230400": "A bit rate of 230400 bit/s.", 52 "2400": "A bit rate of 2400 bit/s.", 53 "38400": "A bit rate of 38400 bit/s.", 54 "4800": "A bit rate of 4800 bit/s.", 55 "57600": "A bit rate of 57600 bit/s.", 56 "9600": "A bit rate of 9600 bit/s." 57 }, 58 "type": "string" 59 }, 60 "ConnectorType": { 61 "enum": [ 62 "RJ45", 63 "RJ11", 64 "DB9 Female", 65 "DB9 Male", 66 "DB25 Female", 67 "DB25 Male", 68 "USB", 69 "mUSB", 70 "uUSB" 71 ], 72 "enumDescriptions": { 73 "DB25 Female": "A DB25 Female connector.", 74 "DB25 Male": "A DB25 Male connector.", 75 "DB9 Female": "A DB9 Female connector.", 76 "DB9 Male": "A DB9 Male connector.", 77 "RJ11": "An RJ11 connector.", 78 "RJ45": "An RJ45 connector.", 79 "USB": "A USB connector.", 80 "mUSB": "A mUSB connector.", 81 "uUSB": "A uUSB connector." 82 }, 83 "type": "string" 84 }, 85 "DataBits": { 86 "enum": [ 87 "5", 88 "6", 89 "7", 90 "8" 91 ], 92 "enumDescriptions": { 93 "5": "Five bits of data following the start bit.", 94 "6": "Six bits of data following the start bit.", 95 "7": "Seven bits of data following the start bit.", 96 "8": "Eight bits of data following the start bit." 97 }, 98 "type": "string" 99 }, 100 "FlowControl": { 101 "enum": [ 102 "None", 103 "Software", 104 "Hardware" 105 ], 106 "enumDescriptions": { 107 "Hardware": "Out-of-band flow control imposed.", 108 "None": "No flow control imposed.", 109 "Software": "XON/XOFF in-band flow control imposed." 110 }, 111 "type": "string" 112 }, 113 "Links": { 114 "additionalProperties": false, 115 "description": "The links to other resources that are related to this resource.", 116 "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.", 117 "patternProperties": { 118 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 119 "description": "This property shall specify a valid odata or Redfish property.", 120 "type": [ 121 "array", 122 "boolean", 123 "integer", 124 "number", 125 "null", 126 "object", 127 "string" 128 ] 129 } 130 }, 131 "properties": { 132 "Oem": { 133 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 134 "description": "The OEM extension property.", 135 "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." 136 } 137 }, 138 "type": "object" 139 }, 140 "OemActions": { 141 "additionalProperties": true, 142 "description": "The available OEM-specific actions for this resource.", 143 "longDescription": "This type shall contain the available OEM-specific actions for this resource.", 144 "patternProperties": { 145 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 146 "description": "This property shall specify a valid odata or Redfish property.", 147 "type": [ 148 "array", 149 "boolean", 150 "integer", 151 "number", 152 "null", 153 "object", 154 "string" 155 ] 156 } 157 }, 158 "properties": {}, 159 "type": "object" 160 }, 161 "Parity": { 162 "enum": [ 163 "None", 164 "Even", 165 "Odd", 166 "Mark", 167 "Space" 168 ], 169 "enumDescriptions": { 170 "Even": "An even parity bit.", 171 "Mark": "A mark parity bit.", 172 "None": "No parity bit.", 173 "Odd": "An odd parity bit.", 174 "Space": "A space parity bit." 175 }, 176 "type": "string" 177 }, 178 "PinOut": { 179 "enum": [ 180 "Cisco", 181 "Cyclades", 182 "Digi" 183 ], 184 "enumDescriptions": { 185 "Cisco": "The Cisco pinout configuration.", 186 "Cyclades": "The Cyclades pinout configuration.", 187 "Digi": "The Digi pinout configuration." 188 }, 189 "type": "string" 190 }, 191 "SerialInterface": { 192 "additionalProperties": false, 193 "description": "The `SerialInterface` schema describes an asynchronous serial interface, such as an RS-232 interface, available to a system or device.", 194 "longDescription": "This resource shall represent a serial interface as part of the Redfish Specification.", 195 "patternProperties": { 196 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { 197 "description": "This property shall specify a valid odata or Redfish property.", 198 "type": [ 199 "array", 200 "boolean", 201 "integer", 202 "number", 203 "null", 204 "object", 205 "string" 206 ] 207 } 208 }, 209 "properties": { 210 "@odata.context": { 211 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context" 212 }, 213 "@odata.etag": { 214 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag" 215 }, 216 "@odata.id": { 217 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id" 218 }, 219 "@odata.type": { 220 "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type" 221 }, 222 "Actions": { 223 "$ref": "#/definitions/Actions", 224 "description": "The available actions for this resource.", 225 "longDescription": "This property shall contain the available actions for this resource.", 226 "versionAdded": "v1_1_0" 227 }, 228 "BitRate": { 229 "$ref": "#/definitions/BitRate", 230 "description": "The receive and transmit rate of data flow, typically in bits per second (bit/s), over the serial connection.", 231 "longDescription": "This property shall indicate the transmit and receive speed of the serial connection.", 232 "readonly": false 233 }, 234 "ConnectorType": { 235 "$ref": "#/definitions/ConnectorType", 236 "description": "The type of connector used for this interface.", 237 "longDescription": "This property shall indicate the type of physical connector used for this serial connection.", 238 "readonly": true 239 }, 240 "DataBits": { 241 "$ref": "#/definitions/DataBits", 242 "description": "The number of data bits that follow the start bit over the serial connection.", 243 "longDescription": "This property shall indicate number of data bits for the serial connection.", 244 "readonly": false 245 }, 246 "Description": { 247 "anyOf": [ 248 { 249 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description" 250 }, 251 { 252 "type": "null" 253 } 254 ], 255 "readonly": true 256 }, 257 "FlowControl": { 258 "$ref": "#/definitions/FlowControl", 259 "description": "The type of flow control, if any, that is imposed on the serial connection.", 260 "longDescription": "This property shall indicate the flow control mechanism for the serial connection.", 261 "readonly": false 262 }, 263 "Id": { 264 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id", 265 "readonly": true 266 }, 267 "InterfaceEnabled": { 268 "description": "An indication of whether this interface is enabled.", 269 "longDescription": "This property shall indicate whether this interface is enabled.", 270 "readonly": false, 271 "type": [ 272 "boolean", 273 "null" 274 ] 275 }, 276 "Links": { 277 "$ref": "#/definitions/Links", 278 "description": "The links to other resources that are related to this resource.", 279 "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource.", 280 "versionAdded": "v1_2_0" 281 }, 282 "Name": { 283 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name", 284 "readonly": true 285 }, 286 "Oem": { 287 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", 288 "description": "The OEM extension property.", 289 "longDescription": "This property shall contain the OEM extensions. All values for properties that this object contains shall conform to the Redfish Specification-described requirements." 290 }, 291 "Parity": { 292 "$ref": "#/definitions/Parity", 293 "description": "The type of parity used by the sender and receiver to detect errors over the serial connection.", 294 "longDescription": "This property shall indicate parity information for a serial connection.", 295 "readonly": false 296 }, 297 "PinOut": { 298 "anyOf": [ 299 { 300 "$ref": "#/definitions/PinOut" 301 }, 302 { 303 "type": "null" 304 } 305 ], 306 "description": "The physical pinout configuration for a serial connector.", 307 "longDescription": "This property shall indicate the physical pinout for the serial connector.", 308 "readonly": true 309 }, 310 "SignalType": { 311 "$ref": "#/definitions/SignalType", 312 "description": "The type of signal used for the communication connection.", 313 "longDescription": "This property shall contain the type of serial signaling in use for the serial connection.", 314 "readonly": true 315 }, 316 "StopBits": { 317 "$ref": "#/definitions/StopBits", 318 "description": "The period of time before the next start bit is transmitted.", 319 "longDescription": "This property shall indicate the stop bits for the serial connection.", 320 "readonly": false 321 } 322 }, 323 "required": [ 324 "@odata.id", 325 "@odata.type", 326 "Id", 327 "Name" 328 ], 329 "type": "object" 330 }, 331 "SignalType": { 332 "enum": [ 333 "Rs232", 334 "Rs485" 335 ], 336 "enumDescriptions": { 337 "Rs232": "The serial interface follows RS232.", 338 "Rs485": "The serial interface follows RS485." 339 }, 340 "type": "string" 341 }, 342 "StopBits": { 343 "enum": [ 344 "1", 345 "2" 346 ], 347 "enumDescriptions": { 348 "1": "One stop bit following the data bits.", 349 "2": "Two stop bits following the data bits." 350 }, 351 "type": "string" 352 } 353 }, 354 "language": "en", 355 "owningEntity": "DMTF", 356 "release": "2023.2", 357 "title": "#SerialInterface.v1_2_1.SerialInterface" 358}