Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 262d7d4ba6b43ede7edde97765f7d710f29c862f / . / static / redfish / v1 / schema / StorageController_v1.xml
blob: 3135b72c9c4607a9910c617417f48e77ff5789ff [file] [log] [blame]
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Gunnar Mills262d7d42021-01-20 16:28:41 -0600[diff] [blame^]4<!--# Redfish Schema: StorageController v1.1.0 -->
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]5<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
8<!--# Copyright 2014-2020 DMTF. -->
9<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Measures.V1.xml">
21 <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
24 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
25 <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
28 <edmx:Include Namespace="Resource"/>
29 <edmx:Include Namespace="Resource.v1_0_0"/>
30 </edmx:Reference>
31 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Endpoint_v1.xml">
32 <edmx:Include Namespace="Endpoint"/>
33 </edmx:Reference>
34 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Assembly_v1.xml">
35 <edmx:Include Namespace="Assembly"/>
36 </edmx:Reference>
37 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Protocol_v1.xml">
38 <edmx:Include Namespace="Protocol"/>
39 </edmx:Reference>
40 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/PCIeDevice_v1.xml">
41 <edmx:Include Namespace="PCIeDevice"/>
42 </edmx:Reference>
43 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/PCIeFunction_v1.xml">
44 <edmx:Include Namespace="PCIeFunction"/>
45 </edmx:Reference>
46 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/PortCollection_v1.xml">
47 <edmx:Include Namespace="PortCollection"/>
48 </edmx:Reference>
49 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/swordfish/v1/Volume_v1.xml">
50 <edmx:Include Namespace="Volume"/>
51 </edmx:Reference>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600[diff] [blame^]52 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/CertificateCollection_v1.xml">
53 <edmx:Include Namespace="CertificateCollection"/>
54 </edmx:Reference>
55 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/SoftwareInventory_v1.xml">
56 <edmx:Include Namespace="SoftwareInventory"/>
57 </edmx:Reference>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]58
59 <edmx:DataServices>
60
61 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="StorageController">
62 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
63
64 <EntityType Name="StorageController" BaseType="Resource.v1_0_0.Resource" Abstract="true">
65 <Annotation Term="OData.Description" String="The StorageController schema describes a storage controller and its properties. A storage controller represents a physical or virtual storage device that produces volumes."/>
66 <Annotation Term="OData.LongDescription" String="This resource shall represent a storage controller in the Redfish Specification."/>
67 <Annotation Term="Capabilities.InsertRestrictions">
68 <Record>
69 <PropertyValue Property="Insertable" Bool="false"/>
70 </Record>
71 </Annotation>
72 <Annotation Term="Capabilities.UpdateRestrictions">
73 <Record>
74 <PropertyValue Property="Updatable" Bool="true"/>
75 </Record>
76 </Annotation>
77 <Annotation Term="Capabilities.DeleteRestrictions">
78 <Record>
79 <PropertyValue Property="Deletable" Bool="false"/>
80 </Record>
81 </Annotation>
82 <Annotation Term="Redfish.Uris">
83 <Collection>
84 <String>/redfish/v1/Storage/{StorageId}/Controllers/{ControllerId}</String>
85 <String>/redfish/v1/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{ControllerId}</String>
86 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{ControllerId}</String>
87 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{ControllerId}</String>
88 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Storage/{StorageId}/Controllers/{ControllerId}</String>
89 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Storage/{StorageId}/Controllers/{ControllerId}</String>
90 </Collection>
91 </Annotation>
92 </EntityType>
93 </Schema>
94
95 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="StorageController.v1_0_0">
96 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
97 <Annotation Term="Redfish.Release" String="2020.3"/>
98
99 <EntityType Name="StorageController" BaseType="StorageController.StorageController">
100 <Property Name="Status" Type="Resource.Status" Nullable="false">
101 <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
102 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
103 </Property>
104 <Property Name="SpeedGbps" Type="Edm.Decimal">
105 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
106 <Annotation Term="OData.Description" String="The maximum speed of the storage controller's device interface."/>
107 <Annotation Term="OData.LongDescription" String="This property shall represent the maximum supported speed of the storage bus interface, in Gbit/s. The specified interface connects the controller to the storage devices, not the controller to a host. For example, SAS bus not PCIe host bus."/>
108 <Annotation Term="Validation.Minimum" Int="0"/>
109 <Annotation Term="Measures.Unit" String="Gbit/s"/>
110 </Property>
111 <Property Name="FirmwareVersion" Type="Edm.String">
112 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
113 <Annotation Term="OData.Description" String="The firmware version of this storage controller."/>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600[diff] [blame^]114 <Annotation Term="OData.LongDescription" String="This property shall contain the firmware version as defined by the manufacturer for the associated storage controller."/>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]115 </Property>
116 <Property Name="Manufacturer" Type="Edm.String">
117 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
118 <Annotation Term="OData.Description" String="The manufacturer of this storage controller."/>
119 <Annotation Term="OData.LongDescription" String="This property shall contain the name of the organization responsible for producing the storage controller. This organization might be the entity from which the storage controller is purchased, but this is not necessarily true."/>
120 </Property>
121 <Property Name="Model" Type="Edm.String">
122 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
123 <Annotation Term="OData.Description" String="The model number for the storage controller."/>
124 <Annotation Term="OData.LongDescription" String="This property shall contain the name by which the manufacturer generally refers to the storage controller."/>
125 </Property>
126 <Property Name="SKU" Type="Edm.String">
127 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
128 <Annotation Term="OData.Description" String="The SKU for this storage controller."/>
129 <Annotation Term="OData.LongDescription" String="This property shall contain the stock-keeping unit number for this storage storage controller."/>
130 </Property>
131 <Property Name="SerialNumber" Type="Edm.String">
132 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
133 <Annotation Term="OData.Description" String="The serial number for this storage controller."/>
134 <Annotation Term="OData.LongDescription" String="This property shall contain a manufacturer-allocated number that identifies the storage controller."/>
135 </Property>
136 <Property Name="PartNumber" Type="Edm.String">
137 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
138 <Annotation Term="OData.Description" String="The part number for this storage controller."/>
139 <Annotation Term="OData.LongDescription" String="This property shall contain a part number assigned by the organization that is responsible for producing or manufacturing the storage controller."/>
140 </Property>
141 <Property Name="AssetTag" Type="Edm.String">
142 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
143 <Annotation Term="OData.Description" String="The user-assigned asset tag for this storage controller."/>
144 <Annotation Term="OData.LongDescription" String="This property shall track the storage controller for inventory purposes."/>
145 </Property>
146 <Property Name="SupportedControllerProtocols" Type="Collection(Protocol.Protocol)" Nullable="false">
147 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
148 <Annotation Term="OData.Description" String="The supported set of protocols for communicating to this storage controller."/>
149 <Annotation Term="OData.LongDescription" String="This property shall contain the supported set of protocols for communicating to this storage controller."/>
150 </Property>
151 <Property Name="SupportedDeviceProtocols" Type="Collection(Protocol.Protocol)" Nullable="false">
152 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
153 <Annotation Term="OData.Description" String="The protocols that the storage controller can use to communicate with attached devices."/>
154 <Annotation Term="OData.LongDescription" String="This property shall contain the set of protocols this storage controller can use to communicate with attached devices."/>
155 </Property>
156 <Property Name="Identifiers" Type="Collection(Resource.Identifier)" Nullable="false">
157 <Annotation Term="OData.Description" String="The durable names for the storage controller."/>
158 <Annotation Term="OData.LongDescription" String="This property shall contain a list of all known durable names for the associated storage controller."/>
159 </Property>
160 <Property Name="Location" Type="Resource.Location" Nullable="false">
161 <Annotation Term="OData.Description" String="The location of the storage controller."/>
162 <Annotation Term="OData.LongDescription" String="This property shall contain location information of the associated storage controller."/>
163 </Property>
164 <NavigationProperty Name="Assembly" Type="Assembly.Assembly" ContainsTarget="true" Nullable="false">
165 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
166 <Annotation Term="OData.Description" String="The link to the assembly associated with this storage controller."/>
167 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type Assembly."/>
168 <Annotation Term="OData.AutoExpandReferences"/>
169 </NavigationProperty>
170 <Property Name="CacheSummary" Type="StorageController.v1_0_0.CacheSummary" Nullable="false">
171 <Annotation Term="OData.Description" String="The cache memory of the storage controller in general detail."/>
172 <Annotation Term="OData.LongDescription" String="This property shall contain properties that describe the cache memory for this resource."/>
173 </Property>
174 <Property Name="PCIeInterface" Type="PCIeDevice.PCIeInterface" Nullable="false">
175 <Annotation Term="OData.Description" String="The PCIe interface details for this controller."/>
176 <Annotation Term="OData.LongDescription" String="This property shall contain details on the PCIe interface that connects this PCIe-based controller to its host."/>
177 </Property>
178 <Property Name="SupportedRAIDTypes" Type="Collection(Volume.RAIDType)">
179 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
180 <Annotation Term="OData.Description" String="The set of RAID types supported by the storage controller."/>
181 <Annotation Term="OData.LongDescription" String="This property shall contain an array of all the RAID types supported by this controller."/>
182 </Property>
183 <NavigationProperty Name="Ports" Type="PortCollection.PortCollection" ContainsTarget="true" Nullable="false">
184 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
185 <Annotation Term="OData.Description" String="The link to the collection of ports that exist on the storage controller."/>
186 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type PortCollection."/>
187 </NavigationProperty>
188 <Property Name="ControllerRates" Type="StorageController.v1_0_0.Rates" Nullable="false">
189 <Annotation Term="OData.Description" String="This property describes the various controller rates used for processes such as volume rebuild or consistency checks."/>
190 <Annotation Term="OData.LongDescription" String="This object shall contain all the rate settings available on the controller."/>
191 </Property>
192 <Property Name="NVMeControllerProperties" Type="StorageController.v1_0_0.NVMeControllerProperties" Nullable="false">
193 <Annotation Term="OData.Description" String="The NVMe related properties for this storage controller."/>
194 <Annotation Term="OData.LongDescription" String="This property shall contain NVMe related properties for this storage controller."/>
195 </Property>
196 <Property Name="Links" Type="StorageController.v1_0_0.Links" Nullable="false">
197 <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
198 <Annotation Term="OData.LongDescription" String="This property shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."/>
199 </Property>
200 <Property Name="Actions" Type="StorageController.v1_0_0.Actions" Nullable="false">
201 <Annotation Term="OData.Description" String="The available actions for this resource."/>
202 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
203 </Property>
204 </EntityType>
205
206 <ComplexType Name="Links" BaseType="Resource.Links">
207 <Annotation Term="OData.Description" String="The links to other resources that are related to this resource."/>
208 <Annotation Term="OData.LongDescription" String="This Redfish Specification-described type shall contain links to resources that are related to but are not contained by, or subordinate to, this resource."/>
209 <NavigationProperty Name="Endpoints" Type="Collection(Endpoint.Endpoint)">
210 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
211 <Annotation Term="OData.Description" String="An array of links to the endpoints that connect to this controller."/>
212 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type Endpoint with which this controller is associated."/>
213 <Annotation Term="OData.AutoExpandReferences"/>
214 </NavigationProperty>
215 <NavigationProperty Name="PCIeFunctions" Type="Collection(PCIeFunction.PCIeFunction)">
216 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
217 <Annotation Term="OData.Description" String="An array of links to the PCIe functions that the storage controller produces."/>
218 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type PCIeFunction that represents the PCIe functions associated with this resource."/>
219 <Annotation Term="OData.AutoExpandReferences"/>
220 </NavigationProperty>
221 <NavigationProperty Name="AttachedVolumes" Type="Collection(Volume.Volume)">
222 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
223 <Annotation Term="OData.Description" String="An array of links to volumes that are attached to this controller instance."/>
224 <Annotation Term="OData.LongDescription" String="This property shall contain an array of links to resources of type Volume that are attached to this instance of storage controller."/>
225 <Annotation Term="OData.AutoExpandReferences"/>
226 </NavigationProperty>
227 </ComplexType>
228
229 <ComplexType Name="Actions">
230 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
231 <Annotation Term="OData.Description" String="The available actions for this resource."/>
232 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
233 <Property Name="Oem" Type="StorageController.v1_0_0.OemActions" Nullable="false">
234 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
235 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
236 </Property>
237 </ComplexType>
238
239 <ComplexType Name="OemActions">
240 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
241 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
242 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
243 </ComplexType>
244
245 <ComplexType Name="CacheSummary">
246 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
247 <Annotation Term="OData.Description" String="This type describes the cache memory of the storage controller in general detail."/>
248 <Annotation Term="OData.LongDescription" String="This type shall contain properties that describe the cache memory for a storage controller."/>
249 <Property Name="TotalCacheSizeMiB" Type="Edm.Int64">
250 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
251 <Annotation Term="OData.Description" String="The total configured cache memory, measured in MiB."/>
252 <Annotation Term="OData.LongDescription" String="This property shall contain the amount of configured cache memory as measured in mebibytes."/>
253 <Annotation Term="Validation.Minimum" Int="0"/>
254 <Annotation Term="Measures.Unit" String="MiBy"/>
255 <Annotation Term="Redfish.Required"/>
256 </Property>
257 <Property Name="PersistentCacheSizeMiB" Type="Edm.Int64">
258 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
259 <Annotation Term="OData.Description" String="The portion of the cache memory that is persistent, measured in MiB."/>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600[diff] [blame^]260 <Annotation Term="OData.LongDescription" String="This property shall contain the amount of cache memory that is persistent as measured in mebibytes. This size shall be less than or equal to the TotalCacheSizeMiB."/>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]261 <Annotation Term="Validation.Minimum" Int="0"/>
262 <Annotation Term="Measures.Unit" String="MiBy"/>
263 </Property>
264 <Property Name="Status" Type="Resource.Status" Nullable="false">
265 <Annotation Term="OData.Description" String="The status and health of the resource and its subordinate or dependent resources."/>
266 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
267 </Property>
268 </ComplexType>
269
270 <ComplexType Name="Rates">
271 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
272 <Annotation Term="OData.Description" String="This type describes the various controller rates used for processes such as volume rebuild or consistency checks."/>
273 <Annotation Term="OData.LongDescription" String="This type shall contain all the rate settings available on the controller."/>
274 <Property Name="RebuildRatePercent" Type="Edm.Int64">
275 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
276 <Annotation Term="OData.Description" String="The percentage of controller resources used for rebuilding/repairing volumes."/>
277 <Annotation Term="OData.LongDescription" String="This property shall contain the percentage of controller resources used for rebuilding volumes."/>
278 <Annotation Term="Validation.Minimum" Int="0"/>
279 <Annotation Term="Validation.Maximum" Int="100"/>
280 </Property>
281 <Property Name="TransformationRatePercent" Type="Edm.Int64">
282 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
283 <Annotation Term="OData.Description" String="The percentage of controller resources used for transforming volumes from one configuration to another."/>
284 <Annotation Term="OData.LongDescription" String="This property shall contain the percentage of controller resources used for transforming volumes."/>
285 <Annotation Term="Validation.Minimum" Int="0"/>
286 <Annotation Term="Validation.Maximum" Int="100"/>
287 </Property>
288 <Property Name="ConsistencyCheckRatePercent" Type="Edm.Int64">
289 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
290 <Annotation Term="OData.Description" String="The percentage of controller resources used for performing a data consistency check on volumes."/>
291 <Annotation Term="OData.LongDescription" String="This property shall contain the percentage of controller resources used for checking data consistency on volumes."/>
292 <Annotation Term="Validation.Minimum" Int="0"/>
293 <Annotation Term="Validation.Maximum" Int="100"/>
294 </Property>
295 </ComplexType>
296
297 <ComplexType Name="NVMeControllerProperties">
298 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
299 <Annotation Term="OData.Description" String="NVMe related properties for a storage controller."/>
300 <Annotation Term="OData.LongDescription" String="This type shall contain NVMe related properties for a storage controller."/>
301 <Property Name="ControllerType" Type="StorageController.v1_0_0.NVMeControllerType">
302 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
303 <Annotation Term="OData.Description" String="The type of NVMe controller."/>
304 <Annotation Term="OData.LongDescription" String="This property shall contain the type of NVMe controller."/>
305 </Property>
306 <Property Name="NVMeVersion" Type="Edm.String">
307 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
308 <Annotation Term="OData.Description" String="The version of the NVMe Base Specification supported."/>
309 <Annotation Term="OData.LongDescription" String="This property shall contain the version of the NVMe Base Specification supported."/>
310 </Property>
311 <Property Name="NVMeControllerAttributes" Type="StorageController.v1_0_0.NVMeControllerAttributes">
312 <Annotation Term="OData.Description" String="The NVMe controller attributes."/>
313 <Annotation Term="OData.LongDescription" String="This property shall contain NVMe controller attributes."/>
314 </Property>
315 <Property Name="MaxQueueSize" Type="Edm.Int64">
316 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
317 <Annotation Term="OData.Description" String="The maximum individual queue size that an NVMe IO controller supports."/>
318 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum individual queue entry size supported per queue. This is a zero-based value, where the minimum value is one, indicating two entries. For PCIe, this applies to both submission and completion queues. For NVMe-oF, this applies to only submission queues."/>
319 </Property>
320 <Property Name="ANACharacteristics" Type="Collection(StorageController.v1_0_0.ANACharacteristics)">
321 <Annotation Term="OData.Description" String="The ANA characteristics and volume information."/>
322 <Annotation Term="OData.LongDescription" String="This property shall contain the ANA characteristics and volume information."/>
323 </Property>
324 <Property Name="NVMeSMARTCriticalWarnings" Type="StorageController.v1_0_0.NVMeSMARTCriticalWarnings">
325 <Annotation Term="OData.Description" String="The NVMe SMART Critical Warnings for this storage controller. This property contains possible triggers for the predictive drive failure warning for the corresponding drive."/>
326 <Annotation Term="OData.LongDescription" String="This property shall contain the NVMe SMART Critical Warnings for this storage controller. This property can contain possible triggers for the predictive drive failure warning for the corresponding drive."/>
327 </Property>
328 </ComplexType>
329
330 <ComplexType Name="ANACharacteristics">
331 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
332 <Annotation Term="OData.Description" String="The ANA characteristics and volume information for a storage controller."/>
333 <Annotation Term="OData.LongDescription" String="This type shall contain the ANA characteristics and volume information for a storage controller."/>
334 <Property Name="AccessState" Type="StorageController.v1_0_0.ANAAccessState">
335 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
336 <Annotation Term="OData.Description" String="Reported ANA access state."/>
337 <Annotation Term="OData.LongDescription" String="This property shall contain the reported ANA access state."/>
338 </Property>
339 <NavigationProperty Name="Volume" Type="Volume.Volume" Nullable="false">
340 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
341 <Annotation Term="OData.Description" String="The specified volume."/>
342 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource of type Volume."/>
343 </NavigationProperty>
344 </ComplexType>
345
346 <ComplexType Name="NVMeControllerAttributes">
347 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
348 <Annotation Term="OData.Description" String="The NVMe controller attributes for a storage controller."/>
349 <Annotation Term="OData.LongDescription" String="This type shall contain NVMe controller attributes for a storage controller."/>
350 <Property Name="ReportsUUIDList" Type="Edm.Boolean">
351 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
352 <Annotation Term="OData.Description" String="Indicates whether or not the controller supports reporting of a UUID list."/>
353 <Annotation Term="OData.LongDescription" String="This property shall indicate whether or not the controller supports reporting of a UUID list."/>
354 </Property>
355 <Property Name="SupportsSQAssociations" Type="Edm.Boolean">
356 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
357 <Annotation Term="OData.Description" String="Indicates whether or not the controller supports SQ Associations."/>
358 <Annotation Term="OData.LongDescription" String="This property shall indicate whether or not the controller supports SQ Associations."/>
359 </Property>
360 <Property Name="ReportsNamespaceGranularity" Type="Edm.Boolean">
361 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
362 <Annotation Term="OData.Description" String="Indicates whether or not the controller supports reporting of Namespace Granularity."/>
363 <Annotation Term="OData.LongDescription" String="This property shall indicate whether or not the controller supports reporting of Namespace Granularity."/>
364 </Property>
365 <Property Name="SupportsTrafficBasedKeepAlive" Type="Edm.Boolean">
366 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
367 <Annotation Term="OData.Description" String="Indicates whether or not the controller supports restarting Keep Alive Timer if traffic is processed from an admin command or IO during a Keep Alive Timeout interval."/>
368 <Annotation Term="OData.LongDescription" String="This property shall indicate whether or not the controller supports restarting Keep Alive Timer if traffic is processed from an admin command or IO during a Keep Alive Timeout interval."/>
369 </Property>
370 <Property Name="SupportsPredictableLatencyMode" Type="Edm.Boolean">
371 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
372 <Annotation Term="OData.Description" String="Indicates whether or not the controller supports Predictable Latency Mode."/>
373 <Annotation Term="OData.LongDescription" String="This property shall indicate whether or not the controller supports Predictable Latency Mode."/>
374 </Property>
375 <Property Name="SupportsEnduranceGroups" Type="Edm.Boolean">
376 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
377 <Annotation Term="OData.Description" String="Indicates whether or not the controller supports Endurance Groups."/>
378 <Annotation Term="OData.LongDescription" String="This property shall indicate whether or not the controller supports Endurance Groups."/>
379 </Property>
380 <Property Name="SupportsReadRecoveryLevels" Type="Edm.Boolean">
381 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
382 <Annotation Term="OData.Description" String="Indicates whether or not the controller supports Read Recovery Levels."/>
383 <Annotation Term="OData.LongDescription" String="This property shall indicate whether or not the controller supports Read Recovery Levels."/>
384 </Property>
385 <Property Name="SupportsNVMSets" Type="Edm.Boolean">
386 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
387 <Annotation Term="OData.Description" String="Indicates whether or not the controller supports NVM Sets."/>
388 <Annotation Term="OData.LongDescription" String="This property shall indicate whether or not the controller supports NVM Sets."/>
389 </Property>
390 <Property Name="SupportsExceedingPowerOfNonOperationalState" Type="Edm.Boolean">
391 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
392 <Annotation Term="OData.Description" String="Indicates whether or not the controller supports exceeding Power of Non-Operational State in order to execute controller initiated background operations in a non-operational power state."/>
393 <Annotation Term="OData.LongDescription" String="This property shall indicate whether or not the controller supports exceeding Power of Non-Operational State in order to execute controller initiated background operations in a non-operational power state."/>
394 </Property>
395 <Property Name="Supports128BitHostId" Type="Edm.Boolean">
396 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
397 <Annotation Term="OData.Description" String="Indicates whether or not the controller supports a 128-bit Host Identifier."/>
398 <Annotation Term="OData.LongDescription" String="This property shall indicate whether or not the controller supports a 128-bit Host Identifier."/>
399 </Property>
400 </ComplexType>
401
402 <ComplexType Name="NVMeSMARTCriticalWarnings">
403 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
404 <Annotation Term="OData.Description" String="The NVMe SMART Critical Warnings for a storage controller."/>
405 <Annotation Term="OData.LongDescription" String="This type shall contain the NVMe SMART Critical Warnings for a storage controller."/>
406 <Property Name="PMRUnreliable" Type="Edm.Boolean">
407 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
408 <Annotation Term="OData.Description" String="The Persistent Memory Region has become unreliable."/>
409 <Annotation Term="OData.LongDescription" String="This property shall indicate that the Persistent Memory Region has become unreliable. PCIe memory reads might return invalid data or generate poisoned PCIe TLP(s). Persistent Memory Region memory writes might not update memory or might update memory with undefined data. The Persistent Memory Region might also have become non-persistent."/>
410 </Property>
411 <Property Name="PowerBackupFailed" Type="Edm.Boolean">
412 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
413 <Annotation Term="OData.Description" String="Indicates that the volatile memory backup device has failed."/>
414 <Annotation Term="OData.LongDescription" String="This property shall indicate that the volatile memory backup device has failed."/>
415 </Property>
416 <Property Name="MediaInReadOnly" Type="Edm.Boolean">
417 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
418 <Annotation Term="OData.Description" String="Indicates the media has been placed in read only mode."/>
419 <Annotation Term="OData.LongDescription" String="This property shall indicate the media has been placed in read only mode. This is not set when the read-only condition on the media is a result of a change in the write protection state of a namespace."/>
420 </Property>
421 <Property Name="OverallSubsystemDegraded" Type="Edm.Boolean">
422 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
423 <Annotation Term="OData.Description" String="Indicates that the NVM subsystem reliability has been compromised."/>
424 <Annotation Term="OData.LongDescription" String="This property shall indicate that the NVM subsystem reliability has been compromised."/>
425 </Property>
426 <Property Name="SpareCapacityWornOut" Type="Edm.Boolean">
427 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
428 <Annotation Term="OData.Description" String="Indicates that the available spare capacity has fallen below the threshold."/>
429 <Annotation Term="OData.LongDescription" String="This property shall indicate that the available spare capacity has fallen below the threshold."/>
430 </Property>
431 </ComplexType>
432
433 <EnumType Name="NVMeControllerType">
434 <Member Name="Admin">
435 <Annotation Term="OData.Description" String="The NVMe controller is an admin controller."/>
436 </Member>
437 <Member Name="Discovery">
438 <Annotation Term="OData.Description" String="The NVMe controller is a discovery controller."/>
439 </Member>
440 <Member Name="IO">
441 <Annotation Term="OData.Description" String="The NVMe controller is an IO controller."/>
442 </Member>
443 </EnumType>
444
445 <EnumType Name="ANAAccessState">
446 <Member Name="Optimized">
447 <Annotation Term="OData.Description" String="Commands processed by a controller provide optimized access to any namespace in the ANA group."/>
448 </Member>
449 <Member Name="NonOptimized">
450 <Annotation Term="OData.Description" String="Commands processed by a controller that reports this state for an ANA Group provide non-optimized access characteristics, such as lower performance or non-optimal use of subsystem resources, to any namespace in the ANA Group."/>
451 </Member>
Gunnar Mills262d7d42021-01-20 16:28:41 -0600[diff] [blame^]452 <Member Name="Inaccessible">
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]453 <Annotation Term="OData.Description" String="Namespaces in this group are inaccessible. Commands are not able to access user data of namespaces in the ANA Group."/>
454 </Member>
455 <Member Name="PersistentLoss">
456 <Annotation Term="OData.Description" String="The group is persistently inaccessible. Commands are persistently not able to access user data of namespaces in the ANA Group."/>
457 </Member>
458 </EnumType>
459 </Schema>
460
Gunnar Mills262d7d42021-01-20 16:28:41 -0600[diff] [blame^]461 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="StorageController.v1_0_1">
462 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
463 <Annotation Term="OData.Description" String="This version was created to correct various typographical errors. It was also created to correct the spelling of the enumeration value `Inaccessible`."/>
464 <EntityType Name="StorageController" BaseType="StorageController.v1_0_0.StorageController"/>
465 </Schema>
466
467 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="StorageController.v1_1_0">
468 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
469 <Annotation Term="Redfish.Release" String="2020.4"/>
470 <Annotation Term="OData.Description" String="This version was created to add Certificates and Measurements to devices for attestation and identity management."/>
471
472 <EntityType Name="StorageController" BaseType="StorageController.v1_0_1.StorageController">
473 <NavigationProperty Name="Certificates" Type="CertificateCollection.CertificateCollection" ContainsTarget="true" Nullable="false">
474 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
475 <Annotation Term="OData.Description" String="The link to a collection of certificates for device identity and attestation."/>
476 <Annotation Term="OData.LongDescription" String="This property shall contain a link to a resource collection of type CertificateCollection that contains certificates for device identity and attestation."/>
477 <Annotation Term="OData.AutoExpandReferences"/>
478 </NavigationProperty>
479 <Property Name="Measurements" Type="Collection(SoftwareInventory.MeasurementBlock)" Nullable="false">
480 <Annotation Term="OData.Description" String="An array of DSP0274-defined measurement blocks."/>
481 <Annotation Term="OData.LongDescription" String="This property shall contain an array of DSP0274-defined measurement blocks."/>
482 </Property>
483 </EntityType>
484 </Schema>
485
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]486 </edmx:DataServices>
487</edmx:Edmx>