blob: fb3b57a38ef05ee846265130155eccbe555c938a [file] [log] [blame]
{
"$id": "http://redfish.dmtf.org/schemas/v1/AccelerationFunction.v1_0_0.json",
"$ref": "#/definitions/AccelerationFunction",
"$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": {
"AccelerationFunction": {
"additionalProperties": false,
"description": "The AccelerationFunction schema defines the accelerator implemented in a Processor device.",
"longDescription": "This resource shall be used to represent the acceleration function, implemented in a Processor, 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_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"
},
"AccelerationFunctionType": {
"anyOf": [
{
"$ref": "#/definitions/AccelerationFunctionType"
},
{
"type": "null"
}
],
"description": "The type of acceleration function.",
"longDescription": "This property shall contain the string which identifies the type of acceleration function.",
"readonly": true
},
"Actions": {
"$ref": "#/definitions/Actions",
"description": "The available actions for this resource.",
"longDescription": "The Actions 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
},
"FpgaReconfigurationSlots": {
"description": "An array of the reconfiguration slot identifiers for an FPGA.",
"items": {
"type": "string"
},
"longDescription": "The value of this property shall be an array of the FPGA reconfiguration slots identifiers that this acceleration function occupies.",
"readonly": true,
"type": "array"
},
"Id": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
"readonly": true
},
"Links": {
"$ref": "#/definitions/Links",
"description": "Contains references 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": "The acceleration function code manufacturer.",
"longDescription": "This property shall contain a string which identifies the manufacturer of the acceleration function.",
"readonly": true,
"type": "string"
},
"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*."
},
"PowerWatts": {
"description": "The acceleration function power consumption.",
"longDescription": "The total acceleration function power consumtion in watts.",
"readonly": true,
"type": "integer",
"units": "W"
},
"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."
},
"UUID": {
"anyOf": [
{
"$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/UUID"
},
{
"type": "null"
}
],
"description": "The universal unique identifier (UUID) for this acceleration function.",
"longDescription": "The value of this property shall be used to contain a universal unique identifier number for the acceleration function. RFC4122 describes methods that can be used to create the value. The value should be considered to be opaque. Client software should only treat the overall value as a universally unique identifier and should not interpret any sub-fields within the UUID.",
"readonly": true
},
"Version": {
"description": "The acceleration function version.",
"longDescription": "The value of this property shall contain a string decsribing the acceleration function version.",
"readonly": true,
"type": "string"
}
},
"required": [
"@odata.id",
"@odata.type",
"Id",
"Name"
],
"type": "object"
},
"AccelerationFunctionType": {
"enum": [
"Encryption",
"Compression",
"PacketInspection",
"PacketSwitch",
"Scheduler",
"AudioProcessing",
"VideoProcessing",
"OEM"
],
"enumDescriptions": {
"AudioProcessing": "An audio processing function.",
"Compression": "A compression function.",
"Encryption": "An encryption function.",
"OEM": "An OEM-defined acceleration function.",
"PacketInspection": "A packet inspection function.",
"PacketSwitch": "A packet switch function.",
"Scheduler": "A scheduler function.",
"VideoProcessing": "A video processing function."
},
"type": "string"
},
"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"
},
"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": {
"Endpoints": {
"description": "An array of references to the endpoints that connect to this acceleartion function.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
},
"longDescription": "The value of this property shall be an array of references to resources of type Endpoint that are associated with this acceleration function.",
"readonly": true,
"type": "array"
},
"Endpoints@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 the PCIeFunctions associated with this acceleration function.",
"items": {
"$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction"
},
"longDescription": "The value of this property shall be an array of references of type PCIeFunction that represent the PCI-e Functions associated with this acceleration function.",
"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"
}
},
"owningEntity": "DMTF",
"release": "2018.3",
"title": "#AccelerationFunction.v1_0_0.AccelerationFunction"
}