Swordfish NVMe Model Overview and Mapping Guide

Version 1.2.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.

Publication of this Working Draft for review and comment has been approved by the Scalable Storage Management Technical Work Group. This draft represents a ‘best effort’ attempt by the Scalable Storage Management Technical Work Group to reach preliminary consensus, and it may be updated, replaced, or made obsolete at any time. This document should not be used as reference material or cited as other than a ‘work in progress.’ Suggestions for revision should be directed to http://www.snia.org/feedback.

Working Draft

Last Updated 18 August 2020

USAGE

Copyright (c) 2020 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 specification, 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/.

Revision History

Revisions to this document are summarized in Table 1.

Current Revision

SNIA is actively engaged in expanding and refining the Swordfish specification. 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.

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 2.

Table of Contents

1. Abstract
2. Scope
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
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. NVM Subsystem Model
4.2.3. NVMe-oF Subsystem Model
5. Example Instances
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
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
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
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. Name
6.3.2.2. Description
6.3.2.3. Status.State
6.3.2.4. Status.Health
6.3.2.5. Status.HealthRollup
6.3.2.6. Controllers
6.3.2.7. Identifiers
6.3.2.8. Identifiers.DurableNameFormat
6.3.2.9. Identifiers.DurableName
6.3.2.10. Volumes
6.4. NVM Controllers
6.4.1. Admin Controller
6.4.1.1. Mockup
6.4.1.2. Property Mapping
6.4.1.2.1. Name
6.4.1.2.2. Description
6.4.1.2.3. Status.State
6.4.1.2.4. Status.Health
6.4.1.2.5. SupportControllerProtocols
6.4.1.2.6. NVMeControllerProperties.ControllerType
6.4.1.2.7. NVMeControllerProperties.NVMeVersion
6.4.1.2.8. NVMeControllerProperties.NVMeControllerAttributes.SupportsSQAssociations
6.4.1.2.9. NVMeControllerProperties.NVMeControllerAttributes.SupportsTrafficBasedKeepAlive
6.4.1.2.10. NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState
6.4.1.2.11. NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId
6.4.1.2.12. NVMeControllerProperties.MaxQueueSize
6.4.1.2.13. NVMeControllerProperties.MaxQueueSize
6.4.1.2.14. NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSystemDegraded
6.4.2. Discovery Controller
6.4.2.1. Mockup
6.4.2.2. Property Mapping
6.4.2.2.1. Name
6.4.2.2.2. Description
6.4.2.2.3. Status.State
6.4.2.2.4. Status.Health
6.4.2.2.5. SupportControllerProtocols
6.4.2.2.6. NVMeControllerProperties.ControllerType
6.4.2.2.7. NVMeControllerProperties.NVMeVersion
6.4.2.2.8. NVMeControllerProperties.NVMeControllerAttributes.SupportsTrafficBasedKeepAlive
6.4.2.2.9. NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState
6.4.2.2.10. NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId
6.4.2.2.11. NVMeControllerProperties.MaxQueueSize
6.4.2.2.12. NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSystemDegraded
6.4.2.2.13. NVMeControllerProperties.NVMeSMARTCriticalWarnings.SpareCapacityWornOut
6.4.2.2.14. Links.AttchedVolumes
6.4.2.2.15. Links.Endpoints
6.4.2.2.16. Links.Connections
6.4.3. IO Controller
6.4.3.1. Mockup
6.4.3.2. Property Mapping
6.4.3.2.1. Name
6.4.3.2.2. Description
6.4.3.2.3. Status.State
6.4.3.2.4. Status.Health
6.4.3.2.5. SupportControllerProtocols
6.4.3.2.6. NVMeControllerProperties.ControllerType
6.4.3.2.7. NVMeControllerProperties.NVMeVersion
6.4.3.2.8. NVMeControllerProperties.NVMeControllerAttributes.ReportsUUIDList
6.4.3.2.9. NVMeControllerProperties.NVMeControllerAttributes.SupportsSQAssociations
6.4.3.2.10. NVMeControllerProperties.NVMeControllerAttributes.ReportsNamespaceGranularity
6.4.3.2.11. NVMeControllerProperties.NVMeControllerAttributes.SupportsTrafficBasedKeepAlive
6.4.3.2.12. NVMeControllerProperties.NVMeControllerAttributes.SupportsPredictableLatencyMode
6.4.3.2.13. NVMeControllerProperties.NVMeControllerAttributes.SupportsEnduranceGroups
6.4.3.2.14. NVMeControllerProperties.NVMeControllerAttributes.SupportsReadRecoveryLevels
6.4.3.2.15. NVMeControllerProperties.NVMeControllerAttributes.SupportsNVMSets
6.4.3.2.16. NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState
6.4.3.2.17. NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId
6.4.3.2.18. NVMeControllerProperties.MaxQueueSize
6.4.3.2.19. NVMeControllerProperties.MaxQueueSize
6.4.3.2.20. NVMeControllerProperties.ANACharacteristics.AccessState
6.4.3.2.21. NVMeControllerProperties.ANACharacteristics.Volume
6.4.3.2.22. NVMeControllerProperties.NVMeSMARTCriticalWarnings.PRMUnreliable
6.4.3.2.23. NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed
6.4.3.2.24. NVMeControllerProperties.NVMeSMARTCriticalWarnings.MediaInReadOnly
6.4.3.2.25. NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSystemDegraded
6.4.3.2.26. NVMeControllerProperties.NVMeSMARTCriticalWarnings.SpareCapacityWornOut
6.4.3.2.27. Links.AttchedVolumes
6.4.3.2.28. Links.Endpoints
6.4.3.2.29. Links.Connections
6.5. Namespace
6.5.1. Mockup
6.5.2. Property Mapping
6.6. Endurance Group
6.6.1. Mockup
6.6.2. Property Mapping
6.6.2.1. Name
6.6.2.2. Description
6.6.2.3. Status.State
6.6.2.4. Status.Health
6.6.2.5. Capacity.Data.ConsumedBytes
6.6.2.6. Capacity.Data.AllocatedBytes
6.6.2.7. CapacitySources
6.6.2.8. NVMeEnduranceGroupProperties.PredictedMediaLifeLeftPercent
6.6.2.9. NVMeEnduranceGroupProperties.EndGrpLifetime.PercentUsed
6.6.2.10. NVMeEnduranceGroupProperties.EndGrpLifetime.EnduranceEstimate
6.6.2.11. NVMeEnduranceGroupProperties.EndGrpLifetime.DataUnitsRead
6.6.2.12. NVMeEnduranceGroupProperties.EndGrpLifetime.DataUnitsWritten
6.6.2.13. NVMeEnduranceGroupProperties.EndGrpLifetime.MediaUnitsWritten
6.6.2.14. NVMeEnduranceGroupProperties.EndGrpLifetime.HostReadCommandCount
6.6.2.15. NVMeEnduranceGroupProperties.EndGrpLifetime.HostWriteCommandCount
6.6.2.16. NVMeEnduranceGroupProperties.EndGrpLifetime.MediaAndDataIntegrityErrorCount
6.6.2.17. NVMeEnduranceGroupProperties.EndGrpLifetime.ErrorInformationLogEntryCount
6.7. NVM Set
6.7.1. Mockup
6.7.2. Property Mapping

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 3 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. 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 1.

4.2.3. NVMe-oF Subsystem Model

The Figure 2 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 3 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 4 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 5 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 6 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 7. 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, Network 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 8 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 9 shows only the controller object representation for this JBOF configuration. This includes the admin controller function for enclosure management.

Figure 10 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 11 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

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 12 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.

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 13 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 14 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 15 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

A corresponding mockup for this configuration can be found at http://swordfishmockups.com/nvmeof-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 16.

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 4 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. Name

The mapping for Name is summarized in Table 5.

6.3.2.2. Description

The mapping for Description is summarized in Table 6.

6.3.2.3. Status.State

The mapping for Status.State is summarized in Table 7.

6.3.2.4. Status.Health

The mapping for Status.Health is summarized in Table 8.

6.3.2.5. Status.HealthRollup

The mapping for Status.HealthRollup is summarized in Table 9.

6.3.2.6. Controllers

The mapping for Controllers is summarized in Table 10.

6.3.2.7. Identifiers

The mapping for Identifiers is summarized in Table 11.

6.3.2.8. Identifiers.DurableNameFormat

The mapping for Identifiers.DurableNameFormat is summarized in Table 12.

6.3.2.9. Identifiers.DurableName

The mapping for Identifiers.DurableName is summarized in Table 13.

6.3.2.10. Volumes

The mapping for Volumes is summarized in Table 14.

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. Name

The mapping for Name is summarized in Table 15.

6.4.1.2.2. Description

The mapping for Description is summarized in Table 16.

6.4.1.2.3. Status.State

The mapping for Status.State is summarized in Table 17.

6.4.1.2.4. Status.Health

The mapping for Status.Health is summarized in Table 18.

6.4.1.2.5. SupportControllerProtocols

The mapping for SupportControllerProtocols is summarized in Table 19.

6.4.1.2.6. NVMeControllerProperties.ControllerType

The mapping for NVMeControllerProperties.ControllerType is summarized in Table 20.

6.4.1.2.7. NVMeControllerProperties.NVMeVersion

The mapping for NVMeControllerProperties.NVMeVersion is summarized in Table 21.

6.4.1.2.8. NVMeControllerProperties.NVMeControllerAttributes.SupportsSQAssociations

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

6.4.1.2.9. NVMeControllerProperties.NVMeControllerAttributes.SupportsTrafficBasedKeepAlive

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

6.4.1.2.10. NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState

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

6.4.1.2.11. NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId

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

6.4.1.2.12. NVMeControllerProperties.MaxQueueSize

The mapping for NVMeControllerProperties.MaxQueueSize is summarized in Table 26.

6.4.1.2.13. NVMeControllerProperties.MaxQueueSize

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

6.4.1.2.14. NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSystemDegraded

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

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. Name

The mapping for Name is summarized in Table 29.

6.4.2.2.2. Description

The mapping for Description is summarized in Table 30.

6.4.2.2.3. Status.State

The mapping for Status.State is summarized in Table 31.

6.4.2.2.4. Status.Health

The mapping for Status.Health is summarized in Table 32.

6.4.2.2.5. SupportControllerProtocols

The mapping for SupportControllerProtocols is summarized in Table 33.

6.4.2.2.6. NVMeControllerProperties.ControllerType

The mapping for NVMeControllerProperties.ControllerType is summarized in Table 34.

6.4.2.2.7. NVMeControllerProperties.NVMeVersion

The mapping for NVMeControllerProperties.NVMeVersion is summarized in Table 35.

6.4.2.2.8. NVMeControllerProperties.NVMeControllerAttributes.SupportsTrafficBasedKeepAlive

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

6.4.2.2.9. NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState

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

6.4.2.2.10. NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId

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

6.4.2.2.11. NVMeControllerProperties.MaxQueueSize

The mapping for NVMeControllerProperties.MaxQueueSize is summarized in Table 39.

6.4.2.2.12. NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSystemDegraded

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

6.4.2.2.13. NVMeControllerProperties.NVMeSMARTCriticalWarnings.SpareCapacityWornOut

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

6.4.2.2.14. Links.AttchedVolumes

The mapping for Links.AttchedVolumes is summarized in Table 42.

6.4.2.2.15. Links.Endpoints

The mapping for Links.Endpoints is summarized in Table 43.

6.4.2.2.16. Links.Connections

The mapping for Links.Connections is summarized in Table 44.

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,
      "SupportsTrafficBasedKeepAlive": false,
      "SupportsPredictableLatencyMode": false,
      "SupportsEnduranceGroups": false,
      "SupportsReadRecoveryLevels": false,
      "SupportsNVMSets": false,
      "SupportsExceedingPowerOfNonOperationalState": false,
      "Supports128BitHostId": false
    },
    "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. Name

The mapping for Name is summarized in Table 45.

6.4.3.2.2. Description

The mapping for Description is summarized in Table 46.

6.4.3.2.3. Status.State

The mapping for Status.State is summarized in Table 47.

6.4.3.2.4. Status.Health

The mapping for Status.Health is summarized in Table 48.

6.4.3.2.5. SupportControllerProtocols

The mapping for SupportControllerProtocols is summarized in Table 49.

6.4.3.2.6. NVMeControllerProperties.ControllerType

The mapping for NVMeControllerProperties.ControllerType is summarized in Table 50.

6.4.3.2.7. NVMeControllerProperties.NVMeVersion

The mapping for NVMeControllerProperties.NVMeVersion is summarized in Table 51.

6.4.3.2.8. NVMeControllerProperties.NVMeControllerAttributes.ReportsUUIDList

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

6.4.3.2.9. NVMeControllerProperties.NVMeControllerAttributes.SupportsSQAssociations

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

6.4.3.2.10. NVMeControllerProperties.NVMeControllerAttributes.ReportsNamespaceGranularity

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

6.4.3.2.11. NVMeControllerProperties.NVMeControllerAttributes.SupportsTrafficBasedKeepAlive

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

6.4.3.2.12. NVMeControllerProperties.NVMeControllerAttributes.SupportsPredictableLatencyMode

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

6.4.3.2.13. NVMeControllerProperties.NVMeControllerAttributes.SupportsEnduranceGroups

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

6.4.3.2.14. NVMeControllerProperties.NVMeControllerAttributes.SupportsReadRecoveryLevels

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

6.4.3.2.15. NVMeControllerProperties.NVMeControllerAttributes.SupportsNVMSets

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

6.4.3.2.16. NVMeControllerProperties.NVMeControllerAttributes.SupportsExceedingPowerOfNonOperationalState

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

6.4.3.2.17. NVMeControllerProperties.NVMeControllerAttributes.Supports128BitHostId

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

6.4.3.2.18. NVMeControllerProperties.MaxQueueSize

The mapping for NVMeControllerProperties.MaxQueueSize is summarized in Table 62.

6.4.3.2.19. NVMeControllerProperties.MaxQueueSize

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

6.4.3.2.20. NVMeControllerProperties.ANACharacteristics.AccessState

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

6.4.3.2.21. NVMeControllerProperties.ANACharacteristics.Volume

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

6.4.3.2.22. NVMeControllerProperties.NVMeSMARTCriticalWarnings.PRMUnreliable

The mapping for NVMeControllerProperties.NVMeSMARTCriticalWarnings.PRMUnreliable is summarized in Table 66.

6.4.3.2.23. NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed

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

6.4.3.2.24. NVMeControllerProperties.NVMeSMARTCriticalWarnings.MediaInReadOnly

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

6.4.3.2.25. NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSystemDegraded

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

6.4.3.2.26. NVMeControllerProperties.NVMeSMARTCriticalWarnings.SpareCapacityWornOut

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

6.4.3.2.27. Links.AttchedVolumes

The mapping for Links.AttchedVolumes is summarized in Table 71.

6.4.3.2.28. Links.Endpoints

The mapping for Links.Endpoints is summarized in Table 72.

6.4.3.2.29. Links.Connections

The mapping for Links.Connections is summarized in Table 73.

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

The mapping for Name is summarized in Table 74.

The mapping for Description is summarized in Table 75.

The mapping for Status.state is summarized in Table 76.

The mapping for Status.Health is summarized in Table 77.

The mapping for Status.HealthRollup is summarized in Table 78.

The mapping for LogicalUnitNumber is summarized in Table 79.

The mapping for Identifiers is summarized in Table 80.

The mapping for Identifiers.DurableName is summarized in Table 81.

The mapping for Identifiers.DurableNameFormat is summarized in Table 82.

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

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

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

The mapping for Capacity.Metadata is summarized in Table 86.

The mapping for CapacitySources is summarized in Table 87.

The mapping for NVMeNamespaceProperties.NamespaceId is summarized in Table 88.

The mapping for NVMeNamespaceProperties.IsShareable is summarized in Table 89.

The mapping for NVMeNamespaceProperties.NamespaceFeatures.SupportsThinProvisioning is summarized in Table 90.

The mapping for NVMeNamespaceProperties.NamespaceFeatures.SupportsDeallocatedOrUnwrittenLBError is summarized in Table 91.

The mapping for NVMeNamespaceProperties.NamespaceFeatures.SupportsNGUIDReuse is summarized in Table 92.

The mapping for NVMeNamespaceProperties.NamespaceFeatures.SupportsAtomicTransactionSize is summarized in Table 93.

The mapping for NVMeNamespaceProperties.NamespaceFeatures.SupportsIOPerformanceHints is summarized in Table 94.

The mapping for NVMeNamespaceProperties.NumberLBAFormats is summarized in Table 95.

The mapping for NVMeNamespaceProperties.FormattedLBASize is summarized in Table 96.

The mapping for NVMeNamespaceProperties.MetadataTransferredAtEndOfDataLBA is summarized in Table 97.

The mapping for NVMeNamespaceProperties.NVMeVersion is summarized in Table 98.

6.6. Endurance Group

The Redfish/Swordfish Storage Pool schema is used to represent an NVM Endurance Group.

6.6.1. Mockup

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

{
  "@Redfish.Copyright": "Copyright 2015-2020 SNIA. All rights reserved.",
  "@odata.id": "/redfish/v1/Storage/FabricAttachArray/StoragePools/EnduranceGroup1",
  "@odata.type": "#StoragePool.v1_4_0.StoragePool",
  "Id": "1",
  "Name": "Endurance Group 1",
  "Description": "Single Endurance Group",
  "Status": {
    "State": "Enabled",
    "Health": "OK"
  },

  "NVMeEnduranceGroupProperties": {
    "EndGrpLifetime": {
      "PercentUsed": 0,
      "EnduranceEstimate": 0,
      "DataUnitsRead": 0,
      "DataUnitsWritten": 0,
      "MediaUnitsWritten": 0,
      "HostReadCommandCount": 0,
      "HostWriteCommandCount": 0,
      "MediaAndDataIntegrityErrorCount": 0,
      "ErrorInformationLogEntryCount": 0
    }
  },

    "Capacity": {
      "Data": {
        "AllocatedBytes": 10995116277760,
        "ConsumedBytes": 10995116277760
      }
    },

  "CapacitySources": [{
    "@odata.id": "/redfish/v1/Storage/FabricAttachArray/StoragePools/EnduranceGroup1/CapacitySources/Source1"
}]
}

6.6.2. Property Mapping

6.6.2.1. Name

The mapping for Name is summarized in Table 99.

6.6.2.2. Description

The mapping for Description is summarized in Table 100.

6.6.2.3. Status.State

The mapping for Status.State is summarized in Table 101.

6.6.2.4. Status.Health

The mapping for Name is summarized in Table 102.

6.6.2.5. Capacity.Data.ConsumedBytes

The mapping for Name is summarized in Table 103.

6.6.2.6. Capacity.Data.AllocatedBytes

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

6.6.2.7. CapacitySources

The mapping for CapacitySources is summarized in Table 105.

6.6.2.8. NVMeEnduranceGroupProperties.PredictedMediaLifeLeftPercent

The mapping for NVMeEnduranceGroupProperties.PredictedMediaLifeLeftPercent is summarized in Table 106.

6.6.2.9. NVMeEnduranceGroupProperties.EndGrpLifetime.PercentUsed

The mapping for NVMeEnduranceGroupProperties.EndGrpLifetime.PercentUsed is summarized in Table 107.

6.6.2.10. NVMeEnduranceGroupProperties.EndGrpLifetime.EnduranceEstimate

The mapping for NVMeEnduranceGroupProperties.EndGrpLifetime.EnduranceEstimate is summarized in Table 108.

6.6.2.11. NVMeEnduranceGroupProperties.EndGrpLifetime.DataUnitsRead

The mapping for NVMeEnduranceGroupProperties.EndGrpLifetime.DataUnitsRead is summarized in Table 109.

6.6.2.12. NVMeEnduranceGroupProperties.EndGrpLifetime.DataUnitsWritten

The mapping for NVMeEnduranceGroupProperties.EndGrpLifetime.DataUnitsWritten is summarized in Table 110.

6.6.2.13. NVMeEnduranceGroupProperties.EndGrpLifetime.MediaUnitsWritten

The mapping for NVMeEnduranceGroupProperties.EndGrpLifetime.MediaUnitsWritten is summarized in Table 111.

6.6.2.14. NVMeEnduranceGroupProperties.EndGrpLifetime.HostReadCommandCount

The mapping for NVMeEnduranceGroupProperties.EndGrpLifetime.HostReadCommandCount is summarized in Table 112.

6.6.2.15. NVMeEnduranceGroupProperties.EndGrpLifetime.HostWriteCommandCount

The mapping for NVMeEnduranceGroupProperties.EndGrpLifetime.HostWriteCommandCount is summarized in Table 113.

6.6.2.16. NVMeEnduranceGroupProperties.EndGrpLifetime.MediaAndDataIntegrityErrorCount

The mapping for NVMeEnduranceGroupProperties.EndGrpLifetime.MediaAndDataIntegrityErrorCount is summarized in Table 114.

6.6.2.17. NVMeEnduranceGroupProperties.EndGrpLifetime.ErrorInformationLogEntryCount

The mapping for NVMeEnduranceGroupProperties.EndGrpLifetime.ErrorInformationLogEntryCount is summarized in Table 115.

6.7. NVM Set

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

6.7.1. Mockup

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

{
  "@Redfish.Copyright": "Copyright 2015-2020 SNIA. All rights reserved.",
  "@odata.id": "/redfish/v1/Storage/FabricAttachArray/StoragePools/NVMeSet1",
  "@odata.type": "#StoragePool.v1_4_0.StoragePool",
  "Id": "1",
  "Name": "Set 1",
  "Description": "First Set",
  "Status": {
    "State": "Enabled",
    "Health": "OK"
  },
  "NVMeSetProperties": {
    "SetIdentifier": "0x1F",
    "EnduranceGroupIdentifier": "0x1",
    "Random4kReadTypicalNanoSeconds": 34534345348,
    "UnallocatedNVMNamespaceCapacityBytes": 5497558138880,
    "OptimalWriteSizeBytes": 512
  },

  "Capacity": {
    "Data": {
      "AllocatedBytes": 10995116277760,
      "ConsumedBytes": 5497558138880
    }
  },

  "AllocatedVolumes": {
    "@odata.id": "/redfish/v1/Storage/FabricAttachArray/StoragePools/NVMeSet1/AllocatedVolumes"
  }
}

6.7.2. Property Mapping