static/redfish/v1/JsonSchemas/PCIeDevice/PCIeDevice.json

{
    "$ref": "#/definitions/PCIeDevice",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "Actions": {
            "additionalProperties": false,
            "description": "The available actions for this resource.",
            "longDescription": "This type shall contain the available actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Oem": {
                    "$ref": "#/definitions/OemActions",
                    "description": "This property contains the available OEM specific actions for this resource.",
                    "longDescription": "This property shall contain any additional OEM actions for this resource."
                }
            },
            "type": "object"
        },
        "DeviceType": {
            "enum": [
                "SingleFunction",
                "MultiFunction",
                "Simulated"
            ],
            "enumDescriptions": {
                "MultiFunction": "A multi-function PCIe device.",
                "Simulated": "A PCIe device which is not currently physically present, but is being simulated by the PCIe infrastructure.",
                "SingleFunction": "A single-function PCIe device."
            },
            "type": "string"
        },
        "Links": {
            "additionalProperties": false,
            "description": "Contains references to other resources that are related to this resource.",
            "longDescription": "This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Chassis": {
                    "description": "An array of references to the chassis in which the PCIe device is contained.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/Chassis.json#/definitions/Chassis"
                    },
                    "longDescription": "The value of this property shall reference a resource of type Chassis that represents the physical container associated with this resource.",
                    "readonly": true,
                    "type": "array"
                },
                "Chassis@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "Oem extension object.",
                    "longDescription": "This object represents the Oem property.  All values for resources described by this schema shall comply to the requirements as described in the Redfish specification."
                },
                "PCIeFunctions": {
                    "description": "An array of references to PCIeFunctions exposed by this device.",
                    "items": {
                        "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction"
                    },
                    "longDescription": "The value of this property shall be a reference to the resources that this device exposes and shall reference a resource of type PCIeFunction.",
                    "readonly": true,
                    "type": "array"
                },
                "PCIeFunctions@odata.count": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/count"
                }
            },
            "type": "object"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM specific actions for this resource.",
            "longDescription": "This type shall contain any additional OEM actions for this resource.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {},
            "type": "object"
        },
        "PCIeDevice": {
            "additionalProperties": false,
            "description": "This is the schema definition for the PCIeDevice resource.  It represents the properties of a PCIeDevice attached to a System.",
            "longDescription": "This resource shall be used to represent a PCIeDevice attached to a System.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "The Actions property shall contain the available actions for this resource."
                },
                "Assembly": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Assembly.json#/definitions/Assembly",
                    "description": "A reference to the Assembly resource associated with this PCIe device.",
                    "longDescription": "The value of this property shall be a link to a resource of type Assembly.",
                    "readonly": true
                },
                "AssetTag": {
                    "description": "The user assigned asset tag for this PCIe device.",
                    "longDescription": "The value of this property shall be an identifying string used to track the PCIe device for inventory purposes.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "DeviceType": {
                    "$ref": "#/definitions/DeviceType",
                    "description": "The device type for this PCIe device.",
                    "longDescription": "The value of this property shall be the device type of the PCIe device such as SingleFunction or MultiFunction.",
                    "readonly": true
                },
                "FirmwareVersion": {
                    "description": "The version of firmware for this PCIe device.",
                    "longDescription": "The value of this property shall be the firmware version of the PCIe device.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "Links": {
                    "$ref": "#/definitions/Links",
                    "description": "The links object contains the links to other resources that are related to this resource.",
                    "longDescription": "The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource."
                },
                "Manufacturer": {
                    "description": "This is the manufacturer of this PCIe device.",
                    "longDescription": "The value of this property shall be the name of the organization responsible for producing the PCIe device. This organization might be the entity from whom the PCIe device is purchased, but this is not necessarily true.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Model": {
                    "description": "This is the model number for the PCIe device.",
                    "longDescription": "The value of this property shall be the name by which the manufacturer generally refers to the PCIe device.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "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*."
                },
                "PCIeInterface": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/PCIeInterface"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The PCIe interface details for this PCIe device.",
                    "longDescription": "This object shall contain details on the PCIe interface used to connect this PCIe Device to its host or upstream switch."
                },
                "PartNumber": {
                    "description": "The part number for this PCIe device.",
                    "longDescription": "The value of this property shall be a part number assigned by the organization that is responsible for producing or manufacturing the PCIe device.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "SKU": {
                    "description": "This is the SKU for this PCIe device.",
                    "longDescription": "The value of this property shall be the stock-keeping unit number for this PCIe device.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "SerialNumber": {
                    "description": "The serial number for this PCIe device.",
                    "longDescription": "The value of this property shall be a manufacturer-allocated number used to identify the PCIe device.",
                    "readonly": true,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Status": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
                    "description": "This property describes the status and health of the resource and its children.",
                    "longDescription": "This property shall contain any status or health properties of the resource."
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "PCIeInterface": {
            "additionalProperties": false,
            "description": "This is the definition for a PCI Interface object.",
            "longDescription": "These properties shall be the definition for a PCIe Interface for a Redfish implementation.",
            "patternProperties": {
                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
                    "description": "This property shall specify a valid odata or Redfish property.",
                    "type": [
                        "array",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "LanesInUse": {
                    "description": "This is the number of PCIe lanes in use by this device.",
                    "longDescription": "The value of this property shall be the number of PCIe lanes in use by this device, which shall be equal or less than the value of MaxLanes.",
                    "maximum": 32,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "MaxLanes": {
                    "description": "This is the number of PCIe lanes supported by this device.",
                    "longDescription": "The value of this property shall be the maximum number of PCIe lanes supported by this device.",
                    "maximum": 32,
                    "readonly": true,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "MaxPCIeType": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeTypes"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The highest version of the PCIe specification supported by this device.",
                    "longDescription": "The value of this property shall be the maximum PCIe specification that this device supports.",
                    "readonly": true
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "Oem extension object.",
                    "longDescription": "This object represents the Oem property.  All values for resources described by this schema shall comply to the requirements as described in the Redfish specification."
                },
                "PCIeType": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeDevice.json#/definitions/PCIeTypes"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The version of the PCIe specification in use by this device.",
                    "longDescription": "The value of this property shall be the negotiated PCIe interface version in use by this device.",
                    "readonly": true
                }
            },
            "type": "object"
        },
        "PCIeTypes": {
            "enum": [
                "Gen1",
                "Gen2",
                "Gen3",
                "Gen4",
                "Gen5"
            ],
            "enumDescriptions": {
                "Gen1": "A PCIe v1.0 slot.",
                "Gen2": "A PCIe v2.0 slot.",
                "Gen3": "A PCIe v3.0 slot.",
                "Gen4": "A PCIe v4.0 slot.",
                "Gen5": "A PCIe v5.0 slot."
            },
            "type": "string"
        }
    },
    "owningEntity": "DMTF",
    "title": "#PCIeDevice.v1_3_0.PCIeDevice"
}