1{
2    "$id": "http://redfish.dmtf.org/schemas/v1/AccelerationFunction.v1_0_5.json",
3    "$ref": "#/definitions/AccelerationFunction",
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        "AccelerationFunction": {
8            "additionalProperties": false,
9            "description": "The `AccelerationFunction` schema describes an acceleration function that a processor implements.  This can include functions such as audio processing, compression, encryption, packet inspection, packet switching, scheduling, or video processing.",
10            "longDescription": "This resource shall represent the acceleration function that a processor implements in a Redfish implementation.  This can include functions such as audio processing, compression, encryption, packet inspection, packet switching, scheduling, or video processing.",
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                "@odata.context": {
27                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
28                },
29                "@odata.etag": {
30                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
31                },
32                "@odata.id": {
33                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
34                },
35                "@odata.type": {
36                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
37                },
38                "AccelerationFunctionType": {
39                    "anyOf": [
40                        {
41                            "$ref": "#/definitions/AccelerationFunctionType"
42                        },
43                        {
44                            "type": "null"
45                        }
46                    ],
47                    "description": "The acceleration function type.",
48                    "longDescription": "This property shall contain the string that identifies the acceleration function type.",
49                    "readonly": true
50                },
51                "Actions": {
52                    "$ref": "#/definitions/Actions",
53                    "description": "The available actions for this resource.",
54                    "longDescription": "This property shall contain the available actions for this resource."
55                },
56                "Description": {
57                    "anyOf": [
58                        {
59                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
60                        },
61                        {
62                            "type": "null"
63                        }
64                    ],
65                    "readonly": true
66                },
67                "FpgaReconfigurationSlots": {
68                    "description": "An array of the reconfiguration slot identifiers of the FPGA that this acceleration function occupies.",
69                    "items": {
70                        "type": "string"
71                    },
72                    "longDescription": "This property shall contain an array of the FPGA reconfiguration slot identifiers that this acceleration function occupies.",
73                    "readonly": true,
74                    "type": "array"
75                },
76                "Id": {
77                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
78                    "readonly": true
79                },
80                "Links": {
81                    "$ref": "#/definitions/Links",
82                    "description": "The links to other resources that are related to this resource.",
83                    "longDescription": "This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."
84                },
85                "Manufacturer": {
86                    "description": "The acceleration function code manufacturer.",
87                    "longDescription": "This property shall contain a string that identifies the manufacturer of the acceleration function.",
88                    "readonly": true,
89                    "type": "string"
90                },
91                "Name": {
92                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
93                    "readonly": true
94                },
95                "Oem": {
96                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
97                    "description": "The OEM extension property.",
98                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
99                },
100                "PowerWatts": {
101                    "description": "The acceleration function power consumption, in watt units.",
102                    "longDescription": "This property shall contain the total acceleration function power consumption, in watt units.",
103                    "readonly": true,
104                    "type": "integer",
105                    "units": "W"
106                },
107                "Status": {
108                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Status",
109                    "description": "The status and health of the resource and its subordinate or dependent resources.",
110                    "longDescription": "This property shall contain any status or health properties of the resource."
111                },
112                "UUID": {
113                    "anyOf": [
114                        {
115                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/UUID"
116                        },
117                        {
118                            "type": "null"
119                        }
120                    ],
121                    "description": "The UUID for this acceleration function.",
122                    "longDescription": "This property shall contain a UUID for the acceleration function.  RFC4122 describes methods that can create the value.  The value should be considered to be opaque.  Client software should only treat the overall value as a UUID and should not interpret any subfields within the UUID.",
123                    "readonly": true
124                },
125                "Version": {
126                    "description": "The acceleration function version.",
127                    "longDescription": "This property shall describe the acceleration function version.",
128                    "readonly": true,
129                    "type": "string"
130                }
131            },
132            "required": [
133                "@odata.id",
134                "@odata.type",
135                "Id",
136                "Name"
137            ],
138            "type": "object"
139        },
140        "AccelerationFunctionType": {
141            "enum": [
142                "Encryption",
143                "Compression",
144                "PacketInspection",
145                "PacketSwitch",
146                "Scheduler",
147                "AudioProcessing",
148                "VideoProcessing",
149                "OEM"
150            ],
151            "enumDescriptions": {
152                "AudioProcessing": "An audio processing function.",
153                "Compression": "A compression function.",
154                "Encryption": "An encryption function.",
155                "OEM": "An OEM-defined acceleration function.",
156                "PacketInspection": "A packet inspection function.",
157                "PacketSwitch": "A packet switch function.",
158                "Scheduler": "A scheduler function.",
159                "VideoProcessing": "A video processing function."
160            },
161            "type": "string"
162        },
163        "Actions": {
164            "additionalProperties": false,
165            "description": "The available actions for this resource.",
166            "longDescription": "This type shall contain the available actions for this resource.",
167            "patternProperties": {
168                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
169                    "description": "This property shall specify a valid odata or Redfish property.",
170                    "type": [
171                        "array",
172                        "boolean",
173                        "integer",
174                        "number",
175                        "null",
176                        "object",
177                        "string"
178                    ]
179                }
180            },
181            "properties": {
182                "Oem": {
183                    "$ref": "#/definitions/OemActions",
184                    "description": "The available OEM-specific actions for this resource.",
185                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
186                }
187            },
188            "type": "object"
189        },
190        "Links": {
191            "additionalProperties": false,
192            "description": "The links to other resources that are related to this resource.",
193            "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.",
194            "patternProperties": {
195                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
196                    "description": "This property shall specify a valid odata or Redfish property.",
197                    "type": [
198                        "array",
199                        "boolean",
200                        "integer",
201                        "number",
202                        "null",
203                        "object",
204                        "string"
205                    ]
206                }
207            },
208            "properties": {
209                "Endpoints": {
210                    "description": "An array of links to the endpoints that connect to this acceleration function.",
211                    "items": {
212                        "$ref": "http://redfish.dmtf.org/schemas/v1/Endpoint.json#/definitions/Endpoint"
213                    },
214                    "longDescription": "This property shall contain an array of links to resources type `Endpoint` that are associated with this acceleration function.",
215                    "readonly": true,
216                    "type": "array"
217                },
218                "Endpoints@odata.count": {
219                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
220                },
221                "Oem": {
222                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
223                    "description": "The OEM extension property.",
224                    "longDescription": "This property shall contain the OEM extensions.  All values for properties contained in this object shall conform to the Redfish Specification-described requirements."
225                },
226                "PCIeFunctions": {
227                    "description": "An array of links to the PCIe functions associated with this acceleration function.",
228                    "items": {
229                        "$ref": "http://redfish.dmtf.org/schemas/v1/PCIeFunction.json#/definitions/PCIeFunction"
230                    },
231                    "longDescription": "This property shall contain an array of links to resources of type `PCIeFunction` that represent the PCIe functions associated with this acceleration function.",
232                    "readonly": true,
233                    "type": "array"
234                },
235                "PCIeFunctions@odata.count": {
236                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/count"
237                }
238            },
239            "type": "object"
240        },
241        "OemActions": {
242            "additionalProperties": true,
243            "description": "The available OEM-specific actions for this resource.",
244            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
245            "patternProperties": {
246                "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": {
247                    "description": "This property shall specify a valid odata or Redfish property.",
248                    "type": [
249                        "array",
250                        "boolean",
251                        "integer",
252                        "number",
253                        "null",
254                        "object",
255                        "string"
256                    ]
257                }
258            },
259            "properties": {},
260            "type": "object"
261        }
262    },
263    "language": "en",
264    "owningEntity": "DMTF",
265    "release": "2018.3",
266    "title": "#AccelerationFunction.v1_0_5.AccelerationFunction"
267}