alexandria/alexandria/model/redfish/1.0/SerialInterface.1.0.0.json

{
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema.1.0.0.json",
    "title": "#SerialInterface.1.0.0.SerialInterface",
    "$ref": "#/definitions/SerialInterface",
    "definitions": {
        "BitRate": {
            "type": "string",
            "enum": [
                "1200",
                "2400",
                "4800",
                "9600",
                "19200",
                "38400",
                "57600",
                "115200",
                "230400"
            ]
        },
        "ConnectorType": {
            "type": "string",
            "enum": [
                "RJ45",
                "RJ11",
                "DB9 Female",
                "DB9 Male",
                "DB25 Female",
                "DB25 Male",
                "USB",
                "mUSB",
                "uUSB"
            ]
        },
        "DataBits": {
            "type": "string",
            "enum": [
                "5",
                "6",
                "7",
                "8"
            ]
        },
        "FlowControl": {
            "type": "string",
            "enum": [
                "None",
                "Software",
                "Hardware"
            ],
            "enumDescriptions": {
                "None": "No flow control imposed",
                "Software": "XON/XOFF in-band flow control imposed",
                "Hardware": "Out of band flow control imposed"
            }
        },
        "Parity": {
            "type": "string",
            "enum": [
                "None",
                "Even",
                "Odd",
                "Mark",
                "Space"
            ]
        },
        "PinOut": {
            "type": "string",
            "enum": [
                "Cisco",
                "Cyclades",
                "Digi"
            ]
        },
        "SerialInterface": {
            "type": "object",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message|Privileges)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "type": [
                        "array",
                        "boolean",
                        "number",
                        "null",
                        "object",
                        "string"
                    ],
                    "description": "This property shall specify a valid odata or Redfish property."
                }
            },
            "additionalProperties": false,
            "properties": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/context"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.4.0.0.json#/definitions/type"
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
                    "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id"
                },
                "Description": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name"
                },
                "InterfaceEnabled": {
                    "type": [
                        "boolean",
                        "null"
                    ],
                    "description": "This indicates whether this interface is enabled.",
                    "longDescription": "The value of this property shall be a boolean indicating whether this interface is enabled."
                },
                "SignalType": {
                    "$ref": "#/definitions/SignalType",
                    "readonly": true,
                    "description": "The type of signal used for the communication connection - RS232 or RS485.",
                    "longDescription": "This property shall indicate the type of serial signalling that will be utilized for the serial connection."
                },
                "BitRate": {
                    "$ref": "#/definitions/BitRate",
                    "description": "The receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection.",
                    "longDescription": "This property shall indicate the transmit and receive speed of the serial connection."
                },
                "Parity": {
                    "$ref": "#/definitions/Parity",
                    "description": "The type of parity used by the sender and receiver in order to detect errors over the serial connection.",
                    "longDescription": "This property shall indicate parity information for a serial connection."
                },
                "DataBits": {
                    "$ref": "#/definitions/DataBits",
                    "description": "The number of data bits that will follow the start bit over the serial connection.",
                    "longDescription": "This property shall indicate number of data bits for the serial connection."
                },
                "StopBits": {
                    "$ref": "#/definitions/StopBits",
                    "description": "The period of time before the next start bit is transmitted.",
                    "longDescription": "This property shall indicate the stop bits for the serial connection."
                },
                "FlowControl": {
                    "$ref": "#/definitions/FlowControl",
                    "description": "The type of flow control, if any, that will be imposed on the serial connection.",
                    "longDescription": "This property shall indicate the flow control mechanism for the serial connection."
                },
                "ConnectorType": {
                    "$ref": "#/definitions/ConnectorType",
                    "readonly": true,
                    "description": "The type of connector used for this interface.",
                    "longDescription": "This property shall indicate the type of phyiscal connector used for this serial connection."
                },
                "PinOut": {
                    "$ref": "#/definitions/PinOut",
                    "readonly": true,
                    "description": "The physical pin configuration needed for a serial connector.",
                    "longDescription": "This property shall indicate the physical pin out for the serial connection."
                }
            },
            "description": "This schema defines an asynchronous serial interface resource.",
            "longDescription": "This resource shall be used to represent serial resources as part of the Redfish specification."
        },
        "SignalType": {
            "type": "string",
            "enum": [
                "Rs232",
                "Rs485"
            ]
        },
        "StopBits": {
            "type": "string",
            "enum": [
                "1",
                "2"
            ]
        }
    },
    "copyright": "Copyright 2014-2015 Distributed Management Task Force, Inc. (DMTF). All rights reserved."
}