static/redfish/v1/JsonSchemas/VCATEntry/VCATEntry.json

{
    "$id": "http://redfish.dmtf.org/schemas/v1/VCATEntry.v1_0_1.json",
    "$ref": "#/definitions/VCATEntry",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2020 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": "The available OEM-specific actions for this resource.",
                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
                }
            },
            "type": "object"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM-specific actions for this resource.",
            "longDescription": "This type shall contain the available OEM-specific 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"
        },
        "VCATEntry": {
            "additionalProperties": false,
            "description": "The VCATEntry schema defines an entry in a Virtual Channel Action Table.  A Virtual Channel is a mechanism used to create multiple, logical communication streams across a physical link.",
            "longDescription": "This resource shall represent and entry of Virtual Channel Action Table in 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": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "This property shall contain the available actions for this resource."
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "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": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
                },
                "RawEntryHex": {
                    "description": "The hexadecimal value of the Virtual Channel Action Table entries.",
                    "longDescription": "This property shall contain the hexadecimal value of the Virtual Channel Action Table entries.  The length of hexadecimal value depends on the number of Virtual Channel Action entries supported by the component.",
                    "pattern": "^0[xX](([a-fA-F]|[0-9])*)$",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "VCEntries": {
                    "description": "An array of entries of the Virtual Channel Action Table.",
                    "items": {
                        "$ref": "#/definitions/VCATableEntry"
                    },
                    "longDescription": "This property shall contain an array of entries of the Virtual Channel Action Table.  The length of the array depends on the number of Virtual Channel Action entries supported by the component.",
                    "type": "array"
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "VCATableEntry": {
            "additionalProperties": false,
            "description": "The Virtual Channel Action Table entry corresponding to a specific Virtual Channel.",
            "longDescription": "This type shall contain a Virtual Channel entry definition that describes a specific Virtual Channel.",
            "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": {
                "Threshold": {
                    "description": "The configured threshold.",
                    "longDescription": "This property shall contain the Gen-Z Core Specification-defined 'TH' 7-bit threshold.",
                    "pattern": "^0[xX]([a-fA-F]|[0-9]){2}$",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "VCMask": {
                    "description": "The bits corresponding to the supported Virtual Channel.",
                    "longDescription": "This property shall contain a 32-bit value where the bits correspond to a supported Virtual Channel.",
                    "pattern": "^0[xX](([a-fA-F]|[0-9]){2}){4}$",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                }
            },
            "type": "object"
        }
    },
    "owningEntity": "DMTF",
    "release": "2019.4",
    "title": "#VCATEntry.v1_0_1.VCATEntry"
}