Swordfish NVMe Model Overview and Mapping Guide

Version 1.2.4a

ABSTRACT: The Swordfish NVMe Model Overview and Mapping Guide defines the model to manage NVMe and NVMe-oF storage systems with Redfish and Swordfish. It provides the detailed mapping information between the NVMe, NVMe-oF specifications and the Redfish and Swordfish specifications.

SNIA Approved Publication

Last Updated 12 July 2022

USAGE

Copyright (c) 2020 - 2022 SNIA. All rights reserved. All other trademarks or registered trademarks are the property of their respective owners.

The SNIA hereby grants permission for individuals to use this document for personal use only, and for corporations and other business entities to use this document for internal use only (including internal copying, distribution, and display) provided that:

1. Any text, diagram, chart, table or definition reproduced must be reproduced in its entirety with no alteration, and,

2. Any document, printed or electronic, in which material from this document (or any portion hereof) is reproduced must acknowledge the SNIA copyright on that material, and must credit the SNIA for granting permission for its reuse.

Other than as explicitly provided above, you may not make any commercial use of this document, or any portion thereof, or distribute this document to third parties. All rights not explicitly granted are expressly reserved to SNIA.

Permission to use this document for purposes other than those enumerated above may be requested by emailing tcmd@snia.org. Please include the identity of the requesting individual and/or company and a brief description of the purpose, nature, and scope of the requested use.

All code fragments, scripts, data tables, and sample code in this SNIA document are made available under the following license:

BSD 3-Clause Software License

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of The Storage Networking Industry Association (SNIA) nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

DISCLAIMER

The information contained in this publication is subject to change without notice. The SNIA makes no warranty of any kind with regard to this publication, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. The SNIA shall not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance, or use.

Suggestions for revisions should be directed to http://www.snia.org/feedback/.

Current Revision

SNIA is actively engaged in expanding and refining the Swordfish documentation. The most current revision can be found on the SNIA web site at https://www.snia.org/tech_activities/standards/curr_standards/swordfish.

Contact SNIA

Current SNIA practice is to make updates and other information available through their web site at http://www.snia.org.

FEEDBACK AND INTERPRETATIONS

Requests for interpretation, suggestions for improvement and addenda, or defect reports are welcome. They should be sent via the SNIA Feedback Portal at http://www.snia.org/feedback/ or by mail to the Storage Networking Industry Association, 4360 ArrowsWest Drive, Colorado Springs, Colorado 80907, U.S.A.

INTENDED AUDIENCE

This document is intended for use by individuals and companies engaged in storage management.

VERSIONING POLICY

This document is versioned material. Versioned material shall have a three-level revision identifier, comprised of a version number ‘v’, a release number ‘r’ and an errata number ‘e’. Future publications of this document are subject to specific constraints on the scope of change that is permissible from one revision to the next and the degree of interoperability and backward compatibility that should be assumed between products designed to this standard. This versioning policy applies to all SNIA Swordfish versioned materials.

Version Number: Versioned material having version number ‘v’ shall be backwards compatible with all of revisions of that material that have the same version number ‘v’. There is no assurance of interoperability or backward compatibility between revisions of a versioned material with different version numbers.

Release Number: Versioned material with a version number ‘v’ and release number ‘r’ shall be backwards compatible with previous revisions of the material with the same version number, and a lower release number. A minor revision represents a technical change to existing content or an adjustment to the scope of the versioned material. Each minor revision causes the release number to be increased by one.

Errata Number: Versioned material having version number ‘v’, a release number ‘r’, and an errata number ‘e’ should be backwards compatible with previous revisions of the material with the same version number and release number (“errata versions”). An errata revision of versioned material is limited to minor corrections or clarifications of existing versioned material. An errata revision may be backwards incompatible, if the incompatibility is necessary for correct operation of implementations of the versioned material.

Revision History

Revisions to this document are summarized in Table .

About SNIA

The Storage Networking Industry Association (SNIA) is a non-profit organization made up of member companies spanning information technology. A globally recognized and trusted authority, SNIA’s mission is to lead the storage industry in developing and promoting vendor-neutral architectures, standards and educational services that facilitate the efficient management, movement and security of information.

Acknowledgements

The SNIA Scalable Storage Management Technical Work Group, which developed and reviewed this work in progress, would like to recognize the significant contributions made by the members listed in Table .

Table of Contents

1. Abstract
2. Scope { .page_break_before }
2.1. Document Goals
2.2. Audience Assumptions
3. Normative References
3.1. Overview
3.2. Approved references
3.3. References under development
3.4. Other references
4. NVMe Model Overview { .page_break_before }
4.1. Introduction
4.1.1. Fundamental Model Design Assertions
4.2. Overall NVMe Subsystem Model
4.2.1. Major NVM Objects Mapped to RF/SF
4.2.1.1. NVM Subsystem
4.2.1.2. NVM Controller (IO, Admin and Discovery)
4.2.1.3. Namespace
4.2.1.4. Endurance Group
4.2.1.5. NVM Set
4.2.1.6. NVM Domain
4.2.2. Unmapped objects
4.2.3. NVM Subsystem Model
4.2.4. NVMe-oF Subsystem Model
5. Example Instances { .page_break_before }
5.1. Introduction
5.2. Simple SSD
5.2.1. Overview
5.2.2. Explanation of Object use
5.2.3. Redfish / Swordfish Object Representation
5.2.4. Mockup
5.3. Complex SSD
5.3.1. Overview
5.3.2. Explanation of Object use
5.3.3. Redfish / Swordfish Object Representation
5.3.3.1. Mockup
5.4. Simple SSD with IP (NVMe-oF) Attach
5.4.1. Overview
5.4.2. Explanation of Object use
5.4.3. Redfish / Swordfish Object Representation
5.4.4. Mockup
5.5. JBOF { .page_break_before }
5.5.1. Overview
5.5.2. Explanation of Object use
5.5.3. Redfish / Swordfish Object Representation
5.5.4. Mockup
5.6. Opaque Array / NVMe Front End Device
5.6.1. Overview
5.6.2. Explanation of Object use
5.6.3. Redfish / Swordfish Object Representation
5.6.4. Mockup
5.7. Subsystem (Fabric) Model - NVMe-oF: Fabric Attach Subsystem
5.7.1. Overview
5.7.2. Explanation of Object use
5.7.3. Redfish / Swordfish Object Representation { .page_break_before }
5.7.4. Mockup
5.8. NVMe Domains
5.8.1. Overview
5.8.2. Explanation of Object use
5.8.3. Mockup
6. Property Mapping
6.1. Introduction
6.2. Property Mapping Template
6.3. NVM subsystem
6.3.1. Mockup
6.3.2. Property Mapping
6.3.2.1. Actions.#StorageController.SetEncryptionKey
6.3.2.2. Controllers
6.3.2.3. Description
6.3.2.4. Drives
6.3.2.5. Identifiers
6.3.2.6. Identifiers.DurableNameFormat
6.3.2.7. Identifiers.DurableName
6.3.2.8. Links.Enclosures
6.3.2.9. Links.Enclosures@odata.count
6.3.2.10. Links.HostingStorageSystems
6.3.2.11. Links.SimpleStorage
6.3.2.12. Name
6.3.2.13. Status.State
6.3.2.14. Status.Health
6.3.2.15. Status.HealthRollup
6.3.2.16. StorageControllers
6.3.2.17. StorageGroups
6.3.2.18. Volumes
6.4. NVM Controllers { .page_break_before }
6.4.1. Admin Controller
6.4.1.1. Mockup
6.4.1.2. Property Mapping
6.4.1.2.1. Assembly
6.4.1.2.2. AssetTag
6.4.1.2.3. CacheSummary
6.4.1.2.4. ControllerRates
6.4.1.2.5. Description
6.4.1.2.6. FirmwareVersion
6.4.1.2.7. Identifiers
6.4.1.2.8. Identifiers.DurableName
6.4.1.2.9. Identifiers.DurableNameFormat
6.4.1.2.10. Links.AttachedVolumes
6.4.1.2.11. Links.NetworkDeviceFunctions
6.4.1.2.12. Location
6.4.1.2.13. Manufacturer
6.4.1.2.14. Model
6.4.1.2.15. Name
6.4.1.2.16. NVMeControllerProperties.ControllerType
6.4.1.2.17. NVMeControllerProperties.NVMeVersion
6.4.1.2.18. NVMeControllerProperties.NVMeControllerAttributes.ReportsNamespaceGranularity
6.4.1.2.19. NVMeControllerProperties.NVMeControllerAttributes.SupportsSQAssociations
6.4.1.2.20. NVMeControllerProperties.NVMeControllerAttributes.SupportsTrafficBasedKeepAlive
6.4.1.2.21. NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState
6.4.1.2.22. NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId
6.4.1.2.23. NVMeControllerProperties.MaxQueueSize
6.4.1.2.24. NVMeControllerProperties.MaxQueueSize
6.4.1.2.25. NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSystemDegraded
6.4.1.2.26. NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed { .page_break_before }
6.4.1.2.27. SKU
6.4.1.2.28. SpeedGbps
6.4.1.2.29. Status.Health
6.4.1.2.30. Status.State
6.4.1.2.31. SupportedControllerProtocols
6.4.1.2.32. SupportedDeviceProtocols
6.4.2. Discovery Controller
6.4.2.1. Mockup
6.4.2.2. Property Mapping
6.4.2.2.1. Assembly
6.4.2.2.2. AssetTag
6.4.2.2.3. CacheSummary
6.4.2.2.4. ControllerRates
6.4.2.2.5. Description
6.4.2.2.6. FirmwareVersion
6.4.2.2.7. Identifiers
6.4.2.2.8. Identifiers.DurableName
6.4.2.2.9. Identifiers.DurableNameFormat
6.4.2.2.10. Links.AttachedVolumes
6.4.2.2.11. Links.Endpoints
6.4.2.2.12. Links.Connections
6.4.2.2.13. Links.NetworkDeviceFunctions { .page_break_before }
6.4.2.2.14. Location
6.4.2.2.15. Manufacturer
6.4.2.2.16. Model
6.4.2.2.17. Name
6.4.2.2.18. NVMeControllerProperties.ControllerType
6.4.2.2.19. NVMeControllerProperties.NVMeVersion
6.4.2.2.20. NVMeControllerProperties.NVMeControllerAttributes.SupportsTrafficBasedKeepAlive
6.4.2.2.21. NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState
6.4.2.2.22. NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId
6.4.2.2.23. NVMeControllerProperties.MaxQueueSize
6.4.2.2.24. NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSubsystemDegraded
6.4.2.2.25. NVMeControllerProperties.NVMeSMARTCriticalWarnings.SpareCapacityWornOut
6.4.2.2.26. NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed
6.4.2.2.27. Status.Health
6.4.2.2.28. Status.State
6.4.2.2.29. SupportedControllerProtocols
6.4.2.2.30. SupportedDeviceProtocols
6.4.3. IO Controller
6.4.3.1. Mockup
6.4.3.2. Property Mapping
6.4.3.2.1. Assembly
6.4.3.2.2. AssetTag
6.4.3.2.3. CacheSummary
6.4.3.2.4. ControllerRates
6.4.3.2.5. Description
6.4.3.2.6. FirmwareVersion
6.4.3.2.7. Identifiers
6.4.3.2.8. Identifiers.DurableName
6.4.3.2.9. Identifiers.DurableNameFormat
6.4.3.2.10. Links.AttachedVolumes
6.4.3.2.11. Links.Endpoints
6.4.3.2.12. Links.Connections
6.4.3.2.13. Links.NetworkDeviceFunctions { .page_break_before }
6.4.3.2.14. Location
6.4.3.2.15. Manufacturer
6.4.3.2.16. Model
6.4.3.2.17. Name
6.4.3.2.18. NVMeControllerProperties.ControllerType
6.4.3.2.19. NVMeControllerProperties.NVMeVersion
6.4.3.2.20. NVMeControllerProperties.NVMeControllerAttributes.ReportsUUIDList
6.4.3.2.21. NVMeControllerProperties.NVMeControllerAttributes.SupportsSQAssociations
6.4.3.2.22. NVMeControllerProperties.NVMeControllerAttributes.ReportsNamespaceGranularity
6.4.3.2.23. NVMeControllerProperties.NVMeControllerAttributes.SupportsReservations
6.4.3.2.24. NVMeControllerProperties.NVMeControllerAttributes.SupportsTrafficBasedKeepAlive
6.4.3.2.25. NVMeControllerProperties.NVMeControllerAttributes.SupportsPredictableLatencyMode
6.4.3.2.26. NVMeControllerProperties.NVMeControllerAttributes.SupportsEnduranceGroups
6.4.3.2.27. NVMeControllerProperties.NVMeControllerAttributes.SupportsReadRecoveryLevels
6.4.3.2.28. NVMeControllerProperties.NVMeControllerAttributes.SupportsNVMSets
6.4.3.2.29. NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState
6.4.3.2.30. NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId
6.4.3.2.31. NVMeControllerProperties.MaxQueueSize
6.4.3.2.32. NVMeControllerProperties.ANACharacteristics
6.4.3.2.33. NVMeControllerProperties.ANACharacteristics.AccessState
6.4.3.2.34. NVMeControllerProperties.ANACharacteristics.Volume
6.4.3.2.35. NVMeControllerProperties.NVMeSMARTCriticalWarnings.PRMUnreliable
6.4.3.2.36. NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed
6.4.3.2.37. NVMeControllerProperties.NVMeSMARTCriticalWarnings.MediaInReadOnly
6.4.3.2.38. NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSystemDegraded
6.4.3.2.39. NVMeControllerProperties.NVMeSMARTCriticalWarnings.SpareCapacityWornOut
6.4.3.2.40. PCIeInterface.PCIeType
6.4.3.2.41. PCIeInterface.MaxPCIeType
6.4.3.2.42. PCIeInterface.LanesInUse
6.4.3.2.43. PCIeInterface.MaxLanes
6.4.3.2.44. Ports
6.4.3.2.45. SKU
6.4.3.2.46. SpeedGbps
6.4.3.2.47. Status.State
6.4.3.2.48. Status.Health
6.4.3.2.49. SupportedControllerProtocols
6.4.3.2.50. SupportedDeviceProtocols
6.5. Namespace
6.5.1. Mockup
6.5.2. Property Mapping
6.5.2.1. BlockSizeBytes
6.5.2.2. Capacity.Data.ConsumedBytes
6.5.2.3. Capacity.Data.ProvisionedBytes
6.5.2.4. Capacity.Data.AllocatedBytes
6.5.2.5. Capacity.Metadata
6.5.2.6. CapacitySources
6.5.2.7. Description
6.5.2.8. DisplayName
6.5.2.9. Identifiers
6.5.2.10. Identifiers.DurableName
6.5.2.11. Identifiers.DurableNameFormat
6.5.2.12. InitializeMethod
6.5.2.13. Links.Drives
6.5.2.14. LogicalUnitNumber
6.5.2.15. MaxBlockSizeBytes
6.5.2.16. Name
6.5.2.17. NVMeNamespaceProperties.NamespaceId
6.5.2.18. NVMeNamespaceProperties.IsShareable
6.5.2.19. NVMeNamespaceProperties.NamespaceFeatures.SupportsThinProvisioning
6.5.2.20. NVMeNamespaceProperties.NamespaceFeatures.SupportsDeallocatedOrUnwrittenLBError
6.5.2.21. NVMeNamespaceProperties.NamespaceFeatures.SupportsNGUIDReuse
6.5.2.22. NVMeNamespaceProperties.NamespaceFeatures.SupportsAtomicTransactionSize
6.5.2.23. NVMeNamespaceProperties.NamespaceFeatures.SupportsIOPerformanceHints
6.5.2.24. NVMeNamespaceProperties.NumberLBAFormats
6.5.2.25. NVMeNamespaceProperties.FormattedLBASize
6.5.2.26. NVMeNamespaceProperties.MetadataTransferredAtEndOfDataLBA
6.5.2.27. NVMeNamespaceProperties.NVMeVersion
6.5.2.28. OptimumIOSizeBytes
6.5.2.29. ProvisioningPolicy
6.5.2.30. Status.State
6.5.2.31. Status.Health
6.5.2.32. Status.HealthRollup
6.5.2.33. StorageGroups
6.5.2.34. WriteCachePolicy
6.6. Endurance Group
6.6.1. Mockup
6.6.2. Property Mapping
6.6.2.1. AllocatedPools
6.6.2.2. Capacity.Data.AllocatedBytes
6.6.2.3. Capacity.Data.ConsumedBytes
6.6.2.4. CapacitySources
6.6.2.5. CapacitySources@odata.count
6.6.2.6. Description
6.6.2.7. Links.OwningStorageResource
6.6.2.8. Name
6.6.2.9. NVMeProperties.NVMePoolType
6.6.2.10. NVMeEnduranceGroupProperties.PredictedMediaLifeLeftPercent
6.6.2.11. NVMeEnduranceGroupProperties.EndGrpLifetime.PercentUsed
6.6.2.12. NVMeEnduranceGroupProperties.EndGrpLifetime.EnduranceEstimate
6.6.2.13. NVMeEnduranceGroupProperties.EndGrpLifetime.DataUnitsRead
6.6.2.14. NVMeEnduranceGroupProperties.EndGrpLifetime.DataUnitsWritten
6.6.2.15. NVMeEnduranceGroupProperties.EndGrpLifetime.MediaUnitsWritten
6.6.2.16. NVMeEnduranceGroupProperties.EndGrpLifetime.HostReadCommandCount
6.6.2.17. NVMeEnduranceGroupProperties.EndGrpLifetime.HostWriteCommandCount
6.6.2.18. NVMeEnduranceGroupProperties.EndGrpLifetime.MediaAndDataIntegrityErrorCount
6.6.2.19. NVMeEnduranceGroupProperties.EndGrpLifetime.ErrorInformationLogEntryCount
6.6.2.20. NVMeSetProperties.SetIdentifier
6.6.2.21. NVMeSetProperties.OptimalWriteSizeBytes
6.6.2.22. NVMeSetProperties.EnduranceGroupIdentifier
6.6.2.23. NVMeSetProperties.Random4kReadTypicalNanoSeconds
6.6.2.24. Status.Health
6.6.2.25. Status.State
6.7. NVM Set
6.7.1. Mockup
6.7.2. Property Mapping
6.7.2.1. AllocatedVolumes
6.7.2.2. Capacity.Data.AllocatedBytes
6.7.2.3. Capacity.Data.ConsumedBytes
6.7.2.4. CapacitySources
6.7.2.5. CapacitySources@odata.count
6.7.2.6. Description
6.7.2.7. Links.OwningStorageResource
6.7.2.8. Name
6.7.2.9. NVMeProperties.NVMePoolType
6.7.2.10. NVMeEnduranceGroupProperties.PredictedMediaLifeLeftPercent
6.7.2.11. NVMeEnduranceGroupProperties.EndGrpLifetime.PercentUsed
6.7.2.12. NVMeEnduranceGroupProperties.EndGrpLifetime.EnduranceEstimate
6.7.2.13. NVMeEnduranceGroupProperties.EndGrpLifetime.DataUnitsRead
6.7.2.14. NVMeEnduranceGroupProperties.EndGrpLifetime.DataUnitsWritten
6.7.2.15. NVMeEnduranceGroupProperties.EndGrpLifetime.MediaUnitsWritten
6.7.2.16. NVMeEnduranceGroupProperties.EndGrpLifetime.HostReadCommandCount
6.7.2.17. NVMeEnduranceGroupProperties.EndGrpLifetime.HostWriteCommandCount
6.7.2.18. NVMeEnduranceGroupProperties.EndGrpLifetime.MediaAndDataIntegrityErrorCount
6.7.2.19. NVMeEnduranceGroupProperties.EndGrpLifetime.ErrorInformationLogEntryCount
6.7.2.20. NVMeSetProperties.SetIdentifier
6.7.2.21. NVMeSetProperties.OptimalWriteSizeBytes
6.7.2.22. NVMeSetProperties.EnduranceGroupIdentifier
6.7.2.23. NVMeSetProperties.Random4kReadTypicalNanoSeconds
6.7.2.24. NVMeSetProperties.UnallocatedNVMNamespaceCapacityBytes
6.7.2.25. Status.State
6.7.2.26. Status.Health
6.8. NVM Set
6.8.1. Mockup
6.8.2. Property Mapping
6.8.2.1. AllocatedVolumes
6.8.2.2. Capacity.Data.AllocatedBytes
6.8.2.3. Capacity.Data.ConsumedBytes
6.8.2.4. CapacitySources
6.8.2.5. CapacitySources@odata.count
6.8.2.6. Description
6.8.2.7. Links.OwningStorageResource
6.8.2.8. Name
6.8.2.9. NVMeProperties.NVMePoolType
6.8.2.10. NVMeEnduranceGroupProperties.PredictedMediaLifeLeftPercent
6.8.2.11. NVMeEnduranceGroupProperties.EndGrpLifetime.PercentUsed
6.8.2.12. NVMeEnduranceGroupProperties.EndGrpLifetime.EnduranceEstimate
6.8.2.13. NVMeEnduranceGroupProperties.EndGrpLifetime.DataUnitsRead
6.8.2.14. NVMeEnduranceGroupProperties.EndGrpLifetime.DataUnitsWritten
6.8.2.15. NVMeEnduranceGroupProperties.EndGrpLifetime.MediaUnitsWritten
6.8.2.16. NVMeEnduranceGroupProperties.EndGrpLifetime.HostReadCommandCount
6.8.2.17. NVMeEnduranceGroupProperties.EndGrpLifetime.HostWriteCommandCount
6.8.2.18. NVMeEnduranceGroupProperties.EndGrpLifetime.MediaAndDataIntegrityErrorCount
6.8.2.19. NVMeEnduranceGroupProperties.EndGrpLifetime.ErrorInformationLogEntryCount
6.8.2.20. NVMeSetProperties.SetIdentifier
6.8.2.21. NVMeSetProperties.OptimalWriteSizeBytes
6.8.2.22. NVMeSetProperties.EnduranceGroupIdentifier
6.8.2.23. NVMeSetProperties.Random4kReadTypicalNanoSeconds
6.8.2.24. NVMeSetProperties.UnallocatedNVMNamespaceCapacityBytes
6.8.2.25. Status.State
6.8.2.26. Status.Health
7. Other Feature Mapping { .page_break_before }
7.1. Introduction
7.2. Firmware Update
7.2.1. Firmware update for NVMe Drives
7.2.1.1. Mapping Images to NVMe Capabilities
8. Appendix A: Objects without a direct mapping to the NVMe model {-}
8.1. A.1: Overview {-}
8.2. A.2: Related Use Cases {-}
9. Annex B: Bibliography {-}
9.1. B.1 Overview {-}
9.2. B.2 Informational references {-}

1. Abstract

The Swordfish NVMe Model Overview and Mapping Guide defines the model to manage NVMe and NVMe-oF storage systems with Redfish and Swordfish. It provides the detailed mapping information between the NVMe, NVMe-oF specifications and the Redfish and Swordfish specifications.

2. Scope

2.1. Document Goals

This document describes how both the NVMe Subsystem model and the NVMe-oF fabric system model should be mapped consistently to Redfish and Swordfish constructs for implementations to be managed within Redfish and Swordfish management environments.

This model and mapping information does not describe or assert any specific implementation recommendation technologies.

This document also provides the mapping information for properties recommended to be implemented in Redfish/Swordfish for NVMe and NVMe-oF devices and the corresponding reference information from the NVMe and NVMe-oF specifications.

2.2. Audience Assumptions

This document assumes that the reader of this document is familiar with NVMe and NVMe-oF technologies and concepts. It also assumes the reader has knowledge of the Redfish and Swordfish concepts.

3. Normative References

3.1. Overview

The documents listed in Table are indispensable for the application of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.

3.2. Approved references

3.3. References under development

None defined in this document.

3.4. Other references

None defined in this document.

4. NVMe Model Overview

4.1. Introduction

In order to manage NVMe and NVMe-oF devices and systems in a large scale environment, a higher level management ecosystem is needed. The Redfish/Swordfish management specifications are designed to manage multi-system environments, including multiple types of fabrics, covering not only multiple technologies, but also inclusive of system management, storage management and fabric management, making it the ideal ecosystem in which to add not only the integration of NVMe devices for system and storage management, but NVMe-oF for fabric management.

This document describes how both the NVMe Subsystem model and the NVMe-oF fabric system model should be mapped consistently to Redfish and Swordfish constructs for implementations to be managed within Redfish and Swordfish management environments. This model and mapping information does not describe or assert any specific implementation recommendation technologies.

Similar implementations will have similar Redfish and Swordfish constructs. Mockups are used to show static examples of sample representations. Requirements and recommendations for implementations are provided separately through the Swordfish NVMe and NVMe-oF profiles. The profiles use the Redfish interoperability profile schema to specify the required, recommended and optional properties and schema for specific configurations and functionality that correspond to classes of implementations.

4.1.1. Fundamental Model Design Assertions

• There shall be a unified model across all types of NVMe devices.

• There shall not be a different model for “drives” vs other types of NVMe devices

• The model will cover an appropriate level of abstraction for all types of NVMe devices based on modeling and mockups reflected in the documented permutations (e.g., from simple drives through to complex fabric virtual systems)

  • Simple NVMe drives; complex NVMe drives; JBOFs/EBOFs; Arrays/RBOFs

• The logical model for NVMe-oF shall leverage the NVMe Subsystem model

• Logical subsystems, controllers, and namespaces are the same objects with the same relationships as in the NVMe Subystem Model. Unneeded objects are not instantiated (e.g., Endurance Groups, sets)

• The NVMe native model should map to the existing Redfish and Swordfish constructs when and where possible

  • Mapping future NVMe / NVMe-oF functionality should follow this principle when and where possible (e.g., firmware update mapping to the RF update service)

4.2. Overall NVMe Subsystem Model

Key Tenets:

• Model reflects a unified view of all NVMe device types.

• Devices will instantiate an appropriate subset of the model

• The model diagrams do not reflect all available schema elements.

• Model leverages and coarsely maps to existing (Redfish and) Swordfish storage model

4.2.1. Major NVM Objects Mapped to RF/SF

4.2.1.1. NVM Subsystem

An NVM subsystem includes one or more controllers, zero or more namespaces, and one or more ports. Examples of NVM subsystems include Enterprise and Client systems that utilize PCI Express based solid state drives and/or fabric connectivity.

4.2.1.2. NVM Controller (IO, Admin and Discovery)

The interface between a host and an NVM subsystem

Admin controller: controller that exposes capabilities that allow a host to manage an NVM subsystem

Discovery: controller that exposes capabilities that allow a host to retrieve a Discovery Log Page

I/O: controller that implements I/O queues and is intended to be used to access a non-volatile memory storage medium

4.2.1.3. Namespace

A quantity of non-volatile memory that may be formatted into logical blocks. When formatted, a namespace of size n is a collection of logical blocks with logical block addresses from 0 to (n-1).

4.2.1.4. Endurance Group

A portion of NVM in the NVM subsystem whose endurance is managed as a group

4.2.1.5. NVM Set

An NVM Set is a collection of NVM that is separate (logically and potentially physically) from NVM in other NVM Sets.

4.2.1.6. NVM Domain

A domain is the smallest indivisible unit that shares state (e.g., power state, capacity information). Domain members can be NVM controllers, endurance groups, sets or namespaces.

4.2.2. Unmapped objects

There are a number of objects that are required for the proper integration of NVMe support within Redfish and Swordfish, but which are not supported by an entity that can be mapped directly from the various NVM Specifications. Information about these related but un-mapped objects are defined elsewhere in the documentation provided with each Swordfish release.

They are summarized in Appendix A.

4.2.3. NVM Subsystem Model

The following diagram reflects the high level mapping of the key NVM objects into Redfish / Swordfish schema objects. These largely follow existing relationships used by the Swordfish storage specification for non-NVMe implementations as well, which provides a great deal of consistency for storage clients, as well as for implementations such as NVMe arrays that may be delivering solutions that combine NVMe and other technologies.

This model covers a wide range of instantiations ranging from individual SSDs, to multi-rack storage systems. All of these can be represented by this NVM Subsystem model, shown in Figure .

4.2.4. NVMe-oF Subsystem Model

Figure shows the high level mapping of the key NVMe-oF objects to Redfish / Swordfish schema objects. Following the tenets described in the model overview section, these extend the mapping used in the NVM Subsystem for the logical versions of the objects.

This model also includes the use of the Redfish Fabric model to cover the connectivity aspects of the fabric.

The grey shaded portion of this diagram reflects the logical / exported portion of the NVMe-oF environment represented in Redfish / Swordfish.

5. Example Instances

5.1. Introduction

This section of the document provides a series of example usages of the model that represent common instantiations of NVMe devices, and how those devices may use the various NVMe, and correspondingly, Redfish and Swordfish objects and schema. This section will not provide comprehensive representations of all potential device types; rather, a representation of several common device types, in order to provide an illustration of the application of the model for those that are unfamiliar with either the NVMe or Redfish / Swordfish ecosystems.

Further, the following sections describe the examples and do not attempt to cover all potential permutations for alternate representations of each device class or possible implementations.

5.2. Simple SSD

5.2.1. Overview

Figure shows a sample representation of a simple NVMe SSD, with a PCIe interface. It is implemented with no endurance group or NVM set functionality; it has only a single namespace capability, and a single IO controller.

5.2.2. Explanation of Object use

Simple SSDs are SSDs that do not use Endurance Groups or sets. Correspondingly, they only use Storage, Controllers, Volumes (Namespaces), and the Drive schema to represent the fundamental components.

Many SSD implementations support exactly one namespace. These are described by this model, and the mockups reflect this configuration.

This model can also support extensions to cover dual-ported configurations, as well as support for multiple IO controllers per port.

5.2.3. Redfish / Swordfish Object Representation

Figure shows the representation, as expressed in the mockup indicated below, of a sample instantiation using Redfish / Swordfish objects.

Note that this mockup does not represent a complete service instantiation; it contains only objects of interest for this context.

5.2.4. Mockup

A corresponding mockup for this configuration can be found at http://swordfishmockups.com/simple-ssd-mockups.

5.3. Complex SSD

5.3.1. Overview

Figure shows a sample representation of a complex NVMe SSD, with a PCIe interface. This example shares many similarities to the simple device model, but adds the representation of NVMe Endurance Groups and NVM Sets using the Swordfish StoragePool schema, with additional NVMe specific properties.

5.3.2. Explanation of Object use

Complex SSDs are SSDs that use Endurance Groups and NVM sets. They also use Storage, Controllers, Volumes (Namespaces), and the Drive schema to represent the fundamental components.

This model can also support extensions to cover dual-ported configurations, as well as support for multiple IO controllers per port.

Endurance Groups divide the media into distinct wear-leveling domains. How this happens is implementation specific.

NVM Sets further subdivide an endurance group in order to limit performance interference within and across these domains.

When this type of device supports dynamic namespace allocation and NVM Sets, the management of the namespaces is done within an NVM Set as the underlying capacity source (e.g., the storage pool).

5.3.3. Redfish / Swordfish Object Representation

Figure shows the representation, as expressed in the mockup indicated below, of a sample instantiation using Redfish / Swordfish objects.

Note that this mockup does not represent a complete service instantiation; it contains only objects of interest for this context.

5.3.3.1. Mockup

A corresponding mockup for this configuration can be found at http://swordfishmockups.com/simple-ssd-eg-set-mockups.

5.4. Simple SSD with IP (NVMe-oF) Attach

5.4.1. Overview

This example reflects an IP-attached drive configuration, with a single ethernet port configured, as illustrated in Figure . It includes a drive configured with a default endurance group and NVM Set, and is instantiated in the Storage Collection off the Service Root.The network configuration is modeled in the Chassis.

5.4.2. Explanation of Object use

Simple SSDs with IP attach are also SSDs that do not use Endurance Groups or sets, but that have IP-based network interfaces. Correspondingly, they only use Storage, Controllers, Volumes (Namespaces), and the Drive schema to represent the fundamental components. In addition, they use the Redfish Network Adapter, Port and Network Device Function to model the configuration of the IP interface port(s).

As with the Simple SSD configuration, Many SSD with IP-attach implementations support exactly one namespace. These are described by this model, and the mockups reflect this configuration.

This model can also support extensions to cover multi-ported configurations, as well as support for multiple IO controllers per port.

5.4.3. Redfish / Swordfish Object Representation

Figure shows the representation, as expressed in the mockup indicated below, of a sample instantiation using Redfish / Swordfish objects.

Note that this mockup does not represent a complete service instantiation; it contains only objects of interest for this context.

5.4.4. Mockup

A corresponding mockup for this configuration can be found at http://swordfishmockups.com/ethernet-attach-drive-mockups.

5.5. JBOF

5.5.1. Overview

This example covers a representation of a JBOF (“just a bunch of flash”) enclosure and contained drives. This mockup reflects a PCIe front-end attach configuration with a set of drives.

Figure shows only the controller object representation for this JBOF configuration. This includes the admin controller function for enclosure management.

Figure shows the combined object representations for the JBOF system, with both the JBOF controller and NVMe drives (using the Simple SSD style drives) represented in the system. Note that the full mockup represented has 7 drives, while this diagram only represents two for the sake of visual clarity.

5.5.2. Explanation of Object use

This type of JBOF system uses the Chassis, Storage and Controller objects to reflect physical component modeling, Subsystem and Admin Controller functionality.

The Chassis model and Admin controller represent NVM’s SES (SCSI enclosure services) usage.

5.5.3. Redfish / Swordfish Object Representation

Figure shows the representation, as expressed in the mockup indicated below, of a sample instantiation using Redfish / Swordfish objects.

Note that this mockup does not represent a complete service instantiation; it contains only objects of interest for this context.

5.5.4. Mockup

A corresponding mockup for this configuration can be found at http://swordfishmockups.com/nvme-jbof-mockups

5.6. Opaque Array / NVMe Front End Device

5.6.1. Overview

The “opaque” array reflects a system with an NVMe front end, but the internal implementation is vendor specific, and not necessarily presented by the vendor (aka “opaque”). Figure shows a system that presents an NVMe front-end but also exposes a SATA drive backend. This could be done to support both FRU management and volume/namespace creation.

Requirements for the NVMe portion of this type of configuration is documented in the SwordfishNVMeFrontEnd profile; opaque arrays should implement both traditional Swordfish block profiles, in addition to the SwordfishNVMeFrontEnd profile.

5.6.2. Explanation of Object use

The opaque array example presents NVMe specific information in Redfish/Swordfish objects, using the Storage, Controller, and Volume objects.

In addition, device management information is presented through StoragePool and Drive objects, providing internal, non-NVMe implementation specific information to the user, for configuration, diagnosis and other storage management functions. (This set of objects is subject to the standard Swordfish specification and profiles.)

5.6.3. Redfish / Swordfish Object Representation

Figure shows the representation, as expressed in the mockup indicated below, of a sample instantiation using Redfish / Swordfish objects.

Note that this mockup does not represent a complete service instantiation; it contains only objects of interest for this context.

5.6.4. Mockup

A corresponding mockup for this configuration can be found at http://swordfishmockups.com/nvme-opaque-array-mockups.

5.7. Subsystem (Fabric) Model - NVMe-oF: Fabric Attach Subsystem

5.7.1. Overview

Figure shows a logical/exported NVMe-oF subsystem presenting one logical subsystem, one I/O controller, one namespace, one port and representing one allowed host, using the Redfish Fabric model. The fabric model uses the Connection schema to characterize the allowed host information, and Endpoints and Zones to show the network connectivity from the device’s perspective.

This example also includes NVMeDomains. NVMeDomains contain a collection of domain members; these can be NVM controllers, endurance groups, NVM sets, or namespaces.

5.7.2. Explanation of Object use

The fabric attach subsystem example shows the representation of logical, or exported, subsystems, controllers, and namespaces using the Storage, Controller and Volume objects respectively.

It also uses portions of the Redfish fabric model to represent the host attachment information - allowed hosts and logical port - using the Connections and Endpoints objects respectively.

5.7.3. Redfish / Swordfish Object Representation

Figure shows the representation, as expressed in the mockup indicated below, of a sample instantiation using Redfish / Swordfish objects.

Note that this mockup does not represent a complete service instantiation; it contains only objects of interest for this context.

5.7.4. Mockup

There are multiple mockups that show the representation for this configuration:

• A mockup for this configuration using an Ethernet attach front-end can be found at http://swordfishmockups.com/nvmeof-mockups.

• A mockup for this configuration using an RDMA attach front-end can be found at http://swordfishmockups.com/nvmeof-RDMA-mockups.

5.8. NVMe Domains

5.8.1. Overview

This example describes NVMeDomains. NVMeDomains contain a collection of domain members; these can be NVM controllers, endurance groups, NVM sets, namespaces, and ports, as illustrated in Figure .

Domains are used to subdivide an NVM Subsystem. For example, if there are multiple power sources, the domain is used to represent the scope of each power source.

5.8.2. Explanation of Object use

The domain object contains two primary elements: the domain members collection, which contains pointers to the relevant controllers, groups, sets, namespaces, and ports that reflect the appropriate subdivision for the purpose of the domain.

The other primary element includes a set of capacity information properties about this set of domain members.

5.8.3. Mockup

A corresponding mockup for this configuration can be found at http://swordfishmockups.com/nvmeof-mockups.

6. Property Mapping

6.1. Introduction

The property mapping provided defines the preferred translation between the Redfish/Swordfish schema objects and properties, and the corresponding NVMe and NVMe-oF specification properties. The information is ordered within the Redfish/Swordfish objects; each cross-referenced property within the Redfish/Swordfish structure therefore contains a detailed reference to its mapped property in the NVMe ecosystem.

Each section also includes a sample Redfish/Swordfish mockup presenting an example usage for that object.

6.2. Property Mapping Template

Table provides the template and an example for the property mapping provided in the following sections of this document.

For each property (whether a reference, collection, complex type or actual property), there is a comparison between the property in Redfish/Swordfish to the corresponding property in either the NVMe or NVMe-oF specification. The RF/SF property is provided within its schema context; the NVMe/NVMe-oF specification reference is provided within the table, showing both which specification, as well as the section and, if appropriate, the figure in which the property is specified.

Similarly, the type of each property is correspondingly specified. The RF/SF type is specified, and the NVM Spec property type is shown, as well as, where appropriate, any additional identifying information, such as byte offset and data structure.

The Mandatory field is used to specify whether properties are Mandatory or Optional on the NVMe specification side, and in the rare instance where properties are Mandatory in the Redfish/Swordfish schema. (Recommended / required properties for specific implementation types in Redfish/Swordfish will be done separately, through the use of profiles.)

The Notes field can / will be used to include any relevant information about either the purpose of the property, additional context, or other useful information to implementers, such as inter-relationships with other properties.

6.3. NVM subsystem

The Redfish/Swordfish Storage schema is used to represent an NVM Subsystem.

6.3.1. Mockup

The following mockup shows a sample representation of the Storage schema used to represent an NVM Subysystem.

{
  "@Redfish.Copyright": "Copyright 2014-2020 SNIA. All rights reserved.",
  "@odata.id": "/redfish/v1/Storage/NVMe-oF-Subsystem",
  "@odata.type": "#Storage.v1_9_0.Storage",
  "Id": "1",
  "Name": "NVMe-oF Logical NVM Fabric System",
  "Description": "Mockup of NVMe-oF Logical NVM Fabric System with 1 Logical Subsystem, 1 Logical I/O Controller and 1 Logical port and 1 allowed host.",
  "Status": {
    "State": "Enabled",
    "Health": "OK",
    "HealthRollup": "OK"
  },
  "Identifiers": [{
    "DurableNameFormat": "NQN",
    "DurableName": "nqn.2014-08.org.nvmexpress:uuid:6c5fe566-10e6-4fb6-aad4-8b4159f50245"
  }],
  "Controllers": {
    "@odata.id": "/redfish/v1/Storage/NVMe-oF-Subsystem/Controllers"
  },
  "Volumes": {
    "@odata.id": "/redfish/v1/Storage/NVMe-oF-Subsystem/Volumes/LogicalNamespace1"
  }
}

6.3.2. Property Mapping

6.3.2.1. Actions.#StorageController.SetEncryptionKey

The mapping for Actions.#StorageController.SetEncryptionKey is summarized in Table .

6.3.2.2. Controllers

The mapping for Controllers is summarized in Table .

6.3.2.3. Description

The mapping for Description is summarized in Table .

6.3.2.4. Drives

The mapping for Drives is summarized in Table .

6.3.2.5. Identifiers

The mapping for Identifiers is summarized in Table .

6.3.2.6. Identifiers.DurableNameFormat

The mapping for Identifiers.DurableNameFormat is summarized in Table .

6.3.2.7. Identifiers.DurableName

The mapping for Identifiers.DurableName is summarized in Table .

6.3.2.8. Links.Enclosures

The mapping for Links.Enclosures is summarized in Table .

6.3.2.9. Links.Enclosures@odata.count

The mapping for Links.Enclosures@odata.count is summarized in Table .

6.3.2.10. Links.HostingStorageSystems

The mapping for Links.HostingStorageSystems is summarized in Table 271.

6.3.2.11. Links.SimpleStorage

The mapping for Links.SimpleStorage is summarized in Table .

6.3.2.12. Name

The mapping for Name is summarized in Table .

6.3.2.13. Status.State

The mapping for Status.State is summarized in Table .

6.3.2.14. Status.Health

The mapping for Status.Health is summarized in Table .

6.3.2.15. Status.HealthRollup

The mapping for Status.HealthRollup is summarized in Table .

6.3.2.16. StorageControllers

The mapping for StorageControllers is summarized in Table .

6.3.2.17. StorageGroups

The mapping for StorageGroups is summarized in Table .

6.3.2.18. Volumes

The mapping for Volumes is summarized in Table .

6.4. NVM Controllers

The Redfish/Swordfish StorageControllers schema is used to represent an NVM Controller.

There are three different types of NVM Controllers: Admin, Discovery, and IO.

6.4.1. Admin Controller

6.4.1.1. Mockup

The following mockup shows a sample representation of the StorageController schema used to represent an Admin Controller.

{
  "@Redfish.Copyright": "Copyright 2014-2020 SNIA. All rights reserved.",
  "@odata.id": "/redfish/v1/Storage/OpaqueArray/Controllers/NVMeAdminController",
  "@odata.type": "#StorageController.v1_0_0.StorageController",

  "Name": "NVMe Admin Controller",
  "Description": "Single NVMe Admin Controller for in-band admin command access.",
  "Status": {
    "State": "Enabled",
    "Health": "OK"
  },
  "Id": "NVMeAdminController",
  "Manufacturer": "Best NVMe Vendor",

  "Model": "NVMe Connect Array",
  "SerialNumber": "NVME123456",
  "PartNumber": "NVM44",
  "FirmwareVersion": "1.0.0",
  "SupportedControllerProtocols": [
    "PCIe"
  ],
  "NVMeControllerProperties": {
    "ControllerType": "Admin",
    "NVMeVersion": "1.3",
    "NVMeControllerAttributes": {
      "SupportsSQAssociations": false,
      "SupportsTrafficBasedKeepAlive": false,
      "SupportsExceedingPowerOfNonOperationalState": false,
      "Supports128BitHostId": false
    }
  }
}

6.4.1.2. Property Mapping

6.4.1.2.1. Assembly

The mapping for Assembly is summarized in Table .

6.4.1.2.2. AssetTag

The mapping for AssetTag is summarized in Table .

6.4.1.2.3. CacheSummary

The mapping for CacheSummary is summarized in Table .

6.4.1.2.4. ControllerRates

The mapping for ControllerRates is summarized in Table .

6.4.1.2.5. Description

The mapping for Description is summarized in Table .

6.4.1.2.6. FirmwareVersion

The mapping for FirmwareVersion is summarized in Table .

6.4.1.2.7. Identifiers

The mapping for Identifiers is summarized in Table .

6.4.1.2.8. Identifiers.DurableName

The mapping for Identifiers.DurableName is summarized in Table .

6.4.1.2.9. Identifiers.DurableNameFormat

The mapping for Identifiers.DurableNameFormat is summarized in Table .

6.4.1.2.10. Links.AttachedVolumes

The mapping for Links.AttachedVolumes is summarized in Table .

6.4.1.2.11. Links.NetworkDeviceFunctions

The mapping for Links.NetworkDeviceFunctions is summarized in Table 290.

6.4.1.2.12. Location

The mapping for Location is summarized in Table .

6.4.1.2.13. Manufacturer

The mapping for Manufacturer is summarized in Table .

6.4.1.2.14. Model

The mapping for Model is summarized in Table .

6.4.1.2.15. Name

The mapping for Name is summarized in Table .

6.4.1.2.16. NVMeControllerProperties.ControllerType

The mapping for NVMeControllerProperties.ControllerType is summarized in Table .

6.4.1.2.17. NVMeControllerProperties.NVMeVersion

The mapping for NVMeControllerProperties.NVMeVersion is summarized in Table .

6.4.1.2.18. NVMeControllerProperties.NVMeControllerAttributes.ReportsNamespaceGranularity

The mapping for NVMeControllerProperties.NVMeControllerAttributes.ReportsNamespaceGranularity is summarized in Table 297.

6.4.1.2.19. NVMeControllerProperties.NVMeControllerAttributes.SupportsSQAssociations

The mapping for NVMeControllerProperties.NVMeControllerAttributes.SupportsSQAssociations is summarized in Table .

6.4.1.2.20. NVMeControllerProperties.NVMeControllerAttributes.SupportsTrafficBasedKeepAlive

The mapping for NVMeControllerProperties.NVMeControllerAttributes.TrafficBasedKeepAlive is summarized in Table .

6.4.1.2.21. NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState

The mapping for NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState is summarized in Table .

6.4.1.2.22. NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId

The mapping for NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId is summarized in Table .

6.4.1.2.23. NVMeControllerProperties.MaxQueueSize

The mapping for NVMeControllerProperties.MaxQueueSize is summarized in Table .

6.4.1.2.24. NVMeControllerProperties.MaxQueueSize

The mapping for NVMeControllerProperties.ANACharacteristics is summarized in Table .

6.4.1.2.25. NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSystemDegraded

The mapping for NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSystemDegraded is summarized in Table .

6.4.1.2.26. NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed

The mapping for NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed is summarized in Table 305.

6.4.1.2.27. SKU

The mapping for SKU is summarized in Table .

6.4.1.2.28. SpeedGbps

The mapping for SpeedGbps is summarized in Table .

6.4.1.2.29. Status.Health

The mapping for Status.Health is summarized in Table .

6.4.1.2.30. Status.State

The mapping for Status.State is summarized in Table .

6.4.1.2.31. SupportedControllerProtocols

The mapping for SupportedControllerProtocols is summarized in Table .

6.4.1.2.32. SupportedDeviceProtocols

The mapping for SupportedDeviceProtocols is summarized in Table .

6.4.2. Discovery Controller

6.4.2.1. Mockup

The following mockup shows a sample representation of the StorageController schema used to represent a Discovery Controller.

{
  "@Redfish.Copyright": "Copyright 2014-2020 SNIA. All rights reserved.",
  "@odata.id": "/redfish/v1/Storage/NVMe-oF-Subsystem/Controllers/NVMeIOController",
  "@odata.type": "#StorageController.v1_0_0.StorageController",
  "Id": "9",
  "Name": "NVMe Logical Discovery Controller",
  "Description": "Single NVMe Discovery Controller presented to host.",
  "Status": {
    "State": "Enabled",
    "Health": "OK"
  },
  "Id": "NVMeDiscoveryController",

  "SupportedControllerProtocols": [
    "TCP", "RDMA", "FC"
  ],
  "SupportedDeviceProtocols": [
    "NVMeOverFabrics"
  ],

  "NVMeControllerProperties": {
    "ControllerType": "Discovery",
    "NVMeVersion": "1.3",
    "NVMeControllerAttributes": {
      "SupportsTrafficBasedKeepAlive": false,
      "SupportsExceedingPowerOfNonOperationalState": false,
      "Supports128BitHostId": false
    }
  }
}

6.4.2.2. Property Mapping

6.4.2.2.1. Assembly

The mapping for Assembly is summarized in Table .

6.4.2.2.2. AssetTag

The mapping for AssetTag is summarized in Table .

6.4.2.2.3. CacheSummary

The mapping for CacheSummary is summarized in Table .

6.4.2.2.4. ControllerRates

The mapping for ControllerRates is summarized in Table .

6.4.2.2.5. Description

The mapping for Description is summarized in Table .

6.4.2.2.6. FirmwareVersion

The mapping for FirmwareVersion is summarized in Table .

6.4.2.2.7. Identifiers

The mapping for Identifiers is summarized in Table .

6.4.2.2.8. Identifiers.DurableName

The mapping for Identifiers.DurableName is summarized in Table .

6.4.2.2.9. Identifiers.DurableNameFormat

The mapping for Identifiers.DurableNameFormat is summarized in Table .

6.4.2.2.10. Links.AttachedVolumes

The mapping for Links.AttachedVolumes is summarized in Table .

6.4.2.2.11. Links.Endpoints

The mapping for Links.Endpoints is summarized in Table .

6.4.2.2.12. Links.Connections

The mapping for Links.Connections is summarized in Table .

6.4.2.2.13. Links.NetworkDeviceFunctions

The mapping for Links.NetworkDeviceFunctions is summarized in Table 324.

6.4.2.2.14. Location

The mapping for Location is summarized in Table .

6.4.2.2.15. Manufacturer

The mapping for Manufacturer is summarized in Table .

6.4.2.2.16. Model

The mapping for Model is summarized in Table .

6.4.2.2.17. Name

The mapping for Name is summarized in Table .

6.4.2.2.18. NVMeControllerProperties.ControllerType

The mapping for NVMeControllerProperties.ControllerType is summarized in Table .

6.4.2.2.19. NVMeControllerProperties.NVMeVersion

The mapping for NVMeControllerProperties.NVMeVersion is summarized in Table .

6.4.2.2.20. NVMeControllerProperties.NVMeControllerAttributes.SupportsTrafficBasedKeepAlive

The mapping for NVMeControllerProperties.NVMeControllerAttributes.TrafficBasedKeepAlive is summarized in Table .

6.4.2.2.21. NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState

The mapping for NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState is summarized in Table .

6.4.2.2.22. NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId

The mapping for NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId is summarized in Table .

6.4.2.2.23. NVMeControllerProperties.MaxQueueSize

The mapping for NVMeControllerProperties.MaxQueueSize is summarized in Table .

6.4.2.2.24. NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSubsystemDegraded

The mapping for NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSubsystemDegraded is summarized in Table .

6.4.2.2.25. NVMeControllerProperties.NVMeSMARTCriticalWarnings.SpareCapacityWornOut

The mapping for NVMeControllerProperties.NVMeSMARTCriticalWarnings.SpareCapacityWornOut is summarized in Table .

6.4.2.2.26. NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed

The mapping for NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed is summarized in Table 337.

6.4.2.2.27. Status.Health

The mapping for Status.Health is summarized in Table .

6.4.2.2.28. Status.State

The mapping for Status.State is summarized in Table .

6.4.2.2.29. SupportedControllerProtocols

The mapping for SupportedControllerProtocols is summarized in Table .

6.4.2.2.30. SupportedDeviceProtocols

The mapping for SupportedDeviceProtocols is summarized in Table .

6.4.3. IO Controller

6.4.3.1. Mockup

The following mockup shows a sample representation of the StorageController schema used to represent an IO Controller.

{
  "@Redfish.Copyright": "Copyright 2014-2020 SNIA. All rights reserved.",
  "@odata.id": "/redfish/v1/Storage/NVMe-oF-Subsystem/Controllers/NVMeIOController",
  "@odata.type": "#StorageController.v1_0_0.StorageController",
  "Id": "9",
  "Name": "NVMe Logical I/O Controller",
  "Description": "Single NVMe I/O Controller presented to host.",
  "Status": {
    "State": "Enabled",
    "Health": "OK"
  },
  "Id": "NVMeIOController",

  "SupportedControllerProtocols": [
    "TCP", "RDMA", "FC"
  ],
  "SupportedDeviceProtocols": [
    "NVMeOverFabrics"
  ],

  "NVMeControllerProperties": {
    "NVMeVersion": "1.3",
    "NVMeControllerAttributes": {
      "ReportsUUIDList": false,
      "SupportsSQAssociations": false,
      "ReportsNamespaceGranularity": false,
      "SupportsReservations": true,
      "SupportsTrafficBasedKeepAlive": false,
      "SupportsPredictableLatencyMode": false,
      "SupportsEnduranceGroups": false,
      "SupportsReadRecoveryLevels": false,
      "SupportsNVMSets": false,
      "SupportsExceedingPowerOfNonOperationalState": false,
      "Supports128BitHostId": false,
    },
      
    "MaxQueueSize": 1,
      
    "ANACharacteristics": [{
      "AccessState": "Optimized",
      "Volume": {
        "@odata.id": "/redfish/v1/Systems/Sys-1/Storage/NVMeSSD-EG/Volumes/Namespace1"
      }
    }]
  },
  "Links": {
    "AttachedVolumes": [{
      "@odata.id": "/redfish/v1/Systems/Sys-1/Storage/NVMeSSD-EG/Volumes/Namespace1"
    }],
    "Endpoints": [{
        "@odata.id": "/redfish/v1/Fabrics/NVMe-oF/Endpoints/NVMeEndpoint"
      },
      {
        "@odata.id": "/redfish/v1/Fabrics/NVMe-oF/Endpoints/Host"
      }
    ],
    "Connections": [{
      "@odata.id": "/redfish/v1/Fabrics/NVMe-oF/Connections/Host1"
    }]
  }
}

6.4.3.2. Property Mapping

6.4.3.2.1. Assembly

The mapping for Assembly is summarized in Table .

6.4.3.2.2. AssetTag

The mapping for AssetTag is summarized in Table .

6.4.3.2.3. CacheSummary

The mapping for CacheSummary is summarized in Table .

6.4.3.2.4. ControllerRates

The mapping for ControllerRates is summarized in Table .

6.4.3.2.5. Description

The mapping for Description is summarized in Table .

6.4.3.2.6. FirmwareVersion

The mapping for FirmwareVersion is summarized in Table .

6.4.3.2.7. Identifiers

The mapping for Identifiers is summarized in Table .

6.4.3.2.8. Identifiers.DurableName

The mapping for Identifiers.DurableName is summarized in Table .

6.4.3.2.9. Identifiers.DurableNameFormat

The mapping for Identifiers.DurableNameFormat is summarized in Table .

6.4.3.2.10. Links.AttachedVolumes

The mapping for Links.AttachedVolumes is summarized in Table .

6.4.3.2.11. Links.Endpoints

The mapping for Links.Endpoints is summarized in Table .

6.4.3.2.12. Links.Connections

The mapping for Links.Connections is summarized in Table .

6.4.3.2.13. Links.NetworkDeviceFunctions

The mapping for Links.NetworkDeviceFunctions is summarized in Table 354.

6.4.3.2.14. Location

The mapping for Location is summarized in Table .

6.4.3.2.15. Manufacturer

The mapping for Manufacturer is summarized in Table .

6.4.3.2.16. Model

The mapping for Model is summarized in Table .

6.4.3.2.17. Name

The mapping for Name is summarized in Table .

6.4.3.2.18. NVMeControllerProperties.ControllerType

The mapping for NVMeControllerProperties.ControllerType is summarized in Table .

6.4.3.2.19. NVMeControllerProperties.NVMeVersion

The mapping for NVMeControllerProperties.NVMeVersion is summarized in Table .

6.4.3.2.20. NVMeControllerProperties.NVMeControllerAttributes.ReportsUUIDList

The mapping for NVMeControllerProperties.NVMeControllerAttributes.ReportsUUIDList is summarized in Table .

6.4.3.2.21. NVMeControllerProperties.NVMeControllerAttributes.SupportsSQAssociations

The mapping for NVMeControllerProperties.NVMeControllerAttributes.SupportsSQAssociations is summarized in Table .

6.4.3.2.22. NVMeControllerProperties.NVMeControllerAttributes.ReportsNamespaceGranularity

The mapping for NVMeControllerProperties.NVMeControllerAttributes.ReportsNamespaceGranularity is summarized in Table .

6.4.3.2.23. NVMeControllerProperties.NVMeControllerAttributes.SupportsReservations

The mapping for NVMeControllerProperties.NVMeControllerAttributes.SupportsReservations is summarized in Table .

6.4.3.2.24. NVMeControllerProperties.NVMeControllerAttributes.SupportsTrafficBasedKeepAlive

The mapping for NVMeControllerProperties.NVMeControllerAttributes.TrafficBasedKeepAlive is summarized in Table .

6.4.3.2.25. NVMeControllerProperties.NVMeControllerAttributes.SupportsPredictableLatencyMode

The mapping for NVMeControllerProperties.NVMeControllerAttributes.PredictableLatencyMode is summarized in Table .

6.4.3.2.26. NVMeControllerProperties.NVMeControllerAttributes.SupportsEnduranceGroups

The mapping for NVMeControllerProperties.NVMeControllerAttributes.EnduranceGroups is summarized in Table .

6.4.3.2.27. NVMeControllerProperties.NVMeControllerAttributes.SupportsReadRecoveryLevels

The mapping for NVMeControllerProperties.NVMeControllerAttributes.SupportsReadRecoveryLevels is summarized in Table .

6.4.3.2.28. NVMeControllerProperties.NVMeControllerAttributes.SupportsNVMSets

The mapping for NVMeControllerProperties.NVMeControllerAttributes.SupportsNVMSets is summarized in Table .

6.4.3.2.29. NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState

The mapping for NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState is summarized in Table .

6.4.3.2.30. NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId

The mapping for NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId is summarized in Table .

6.4.3.2.31. NVMeControllerProperties.MaxQueueSize

The mapping for NVMeControllerProperties.MaxQueueSize is summarized in Table .

6.4.3.2.32. NVMeControllerProperties.ANACharacteristics

The mapping for NVMeControllerProperties.ANACharacteristics is summarized in Table .

6.4.3.2.33. NVMeControllerProperties.ANACharacteristics.AccessState

The mapping for NVMeControllerProperties.ANACharacteristics.AccessState is summarized in Table .

6.4.3.2.34. NVMeControllerProperties.ANACharacteristics.Volume

The mapping for NVMeControllerProperties.ANACharacteristics.Volume is summarized in Table .

6.4.3.2.35. NVMeControllerProperties.NVMeSMARTCriticalWarnings.PRMUnreliable

The mapping for NVMeControllerProperties.NVMeSMARTCriticalWarnings.PMRUnreliable is summarized in Table .

6.4.3.2.36. NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed

The mapping for NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed is summarized in Table .

6.4.3.2.37. NVMeControllerProperties.NVMeSMARTCriticalWarnings.MediaInReadOnly

The mapping for NVMeControllerProperties.NVMeSMARTCriticalWarnings.MediaInReadOnly is summarized in Table .

6.4.3.2.38. NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSystemDegraded

The mapping for NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSubsystemDegraded is summarized in Table .

6.4.3.2.39. NVMeControllerProperties.NVMeSMARTCriticalWarnings.SpareCapacityWornOut

The mapping for NVMeControllerProperties.NVMeSMARTCriticalWarnings.SpareCapacityWornOut is summarized in Table .

6.4.3.2.40. PCIeInterface.PCIeType

The mapping for PCIeInterface.PCIeType is summarized in Table .

6.4.3.2.41. PCIeInterface.MaxPCIeType

The mapping for PCIeInterface.MaxPCIeType is summarized in Table .

6.4.3.2.42. PCIeInterface.LanesInUse

The mapping for PCIeInterface.LanesInUse is summarized in Table .

6.4.3.2.43. PCIeInterface.MaxLanes

The mapping for PCIeInterface.LanesInUse is summarized in Table .

6.4.3.2.44. Ports

The mapping for Ports is summarized in Table .

6.4.3.2.45. SKU

The mapping for SKU is summarized in Table .

6.4.3.2.46. SpeedGbps

The mapping for SpeedGbps is summarized in Table .

6.4.3.2.47. Status.State

The mapping for Status.State is summarized in Table .

6.4.3.2.48. Status.Health

The mapping for Status.Health is summarized in Table .

6.4.3.2.49. SupportedControllerProtocols

The mapping for SupportedControllerProtocols is summarized in Table .

6.4.3.2.50. SupportedDeviceProtocols

The mapping for SupportedDeviceProtocols is summarized in Table .

6.5. Namespace

The Redfish/Swordfish Volume schema is used to represent an NVM Namespace.

6.5.1. Mockup

The following mockup shows a sample representation of the Volume schema used to represent an NVM Namespace.

{
  "@Redfish.Copyright": "Copyright 2014-2020 SNIA. All rights reserved.",
  "@odata.id": "/redfish/v1/Storage/NVMe-oF-Subsystem/Volumes/LogicalNamespace1",
  "@odata.type": "#Volume.v1_5_0.Volume",
  "Id": "1",
  "Name": "Namespace 1",
  "LogicalUnitNumber": 1,
  "Status": {
    "State": "Enabled",
    "Health": "OK"
  },
  "Identifiers": [{
    "DurableNameFormat": "NGUID",
    "DurableName": "FEDCBA9876543210h"
  }],
  "Capacity": {
    "Data": {
      "ConsumedBytes": 0,
      "AllocatedBytes": 10737418240
    },
    "Metadata": {
      "AllocatedBytes": 536870912
    }
  },
  "CapacitySources": [{
    "@odata.id": "/redfish/v1/Storage/NVMe-oF-Subsystem/Volumes/LogicalNamespace1/CapacitySources/Source1"

  }],
  "NVMeNamespaceProperties": {
    "NamespaceId": "0x014",
    "NamespaceFeatures": {
      "SupportsThinProvisioning": false,
      "SupportsAtomicTransactionSize": false,
      "SupportsDeallocatedOrUnwrittenLBError": false,
      "SupportsNGUIDReuse": false,
      "SupportsIOPerformanceHints": false
    },
    "NumberLBAFormats": 0,
    "FormattedLBASize": "LBAFormat0Support",
    "MetadataTransferredAtEndOfDataLBA": false,

    "NVMeVersion": "1.4"
  }
}

6.5.2. Property Mapping

6.5.2.1. BlockSizeBytes

The mapping for BlockSizeBytes is summarized in Table .

6.5.2.2. Capacity.Data.ConsumedBytes

The mapping for Capacity.Data.ConsumedBytes is summarized in Table .

6.5.2.3. Capacity.Data.ProvisionedBytes

The mapping for Capacity.Data.ProvisionedBytes is summarized in Table .

6.5.2.4. Capacity.Data.AllocatedBytes

The mapping for Capacity.Data.AllocatedBytes is summarized in Table .

6.5.2.5. Capacity.Metadata

The mapping for Capacity.Metadata is summarized in Table .

6.5.2.6. CapacitySources

The mapping for CapacitySources is summarized in Table .

6.5.2.7. Description

The mapping for Description is summarized in Table .

6.5.2.8. DisplayName

The mapping for DisplayName is summarized in Table .

6.5.2.9. Identifiers

The mapping for Identifiers is summarized in Table .

6.5.2.10. Identifiers.DurableName

The mapping for Identifiers.DurableName is summarized in Table .