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

4.2.4 NVMe-oF Subsystem Model

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://simple-ssd-mockups.swordfishmockups.com/redfish/v1/.

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://simple-ssd-eg-set-mockups.swordfishmockups.com/redfish/v1/.

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, 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://ethernet-attach-drive-mockups.swordfishmockups.com/redfish/v1/.

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://nvme-jbof-mockups.swordfishmockups.com/redfish/v1/

5.6 EBOF

5.6.1 Overview

This example covers a representation of a EBOF (“Ethernet bunch of flash”) enclosure and contained drives. This mockup reflects a Ethernet front-end attach enclosure configuration containing a set of Ethernet-attach drives.

Figure 12 shows the combined object representations for the EBOF system, with both the EBOF controller and Ethernet-attach drives (using the Simple SSD with IP drives) represented in the system. Note that the full mockup represented has multiple drives, while this diagram only represents one for the sake of visual clarity.

5.6.2 Explanation of Object use

This type of EBOF system uses the Storage and Controller objects to reflect component modeling of the NVMe Subsystem and controller functionality.

Connectivity is represented through the Chassis model’s NetworkAdapter, NetworkPort, NetworkDeviceFunction and EthernetInterface objects, the Fabric model’s Switch and Port objects, as well as the Manager model’s EthernetInterface and ManagerProtocol. In-band management capability is also modeled via Admin controllers, consistent with other NVMe devices.

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://nvme-ebof-mockups.swordfishmockups.com/redfish/v1/

5.7 Opaque Array / NVMe Front End Device

5.7.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 14 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.7.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.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://nvme-opaque-array-mockups.swordfishmockups.com/redfish/v1/.

5.8 Subsystem (Fabric) Model - NVMe-oF: Fabric Attach Subsystem

5.8.1 Overview

Figure 16 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.

5.8.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.8.3 Redfish / Swordfish Object Representation

Figure 17 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.8.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://nvmeof-mockups.swordfishmockups.com/redfish/v1/.

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

5.9 NVMe Domain Model

5.9.1 Overview

Figure 18 shows a representation of a simple domain representation, with a single IO controller and namespace in a domain.

Note that as this configuration only has a single domain, it could be represented as an implicit domain.

5.9.2 Explanation of Object use

NVMeDomains contain a collection of domain members; these can be NVM controllers, endurance groups, NVM sets, or namespaces. Domains can constrain the set of firmware images available to apply to like members. Other domain-level properties include ALUA (asymmetric logical unit access) group definitions, indicating common access characteristics and path prioritization behaviors across the namespaces in the domain.

5.9.2.1 Implicit or Default Domains

In an NVM subsystem that does not support multiple domains, there is, by definition, a single domain. For single domain configurations, it is up to the Swordfish service implementer to determine whether or not to instrument the NVMe Domain objects.

5.9.3 Redfish / Swordfish Object Representation

Figure 19 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.

Note that as this configuration only has a single domain, it could be represented as an implicit domain.

5.9.4 Mockup

A mockup for this configuration using NVMe Domains can be found at http://nvme-domains-mockups.swordfishmockups.com/redfish/v1/.

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

{
    "@odata.type": "#Storage.v1_16_0.Storage",
    "Id": "1",
    "Name": "NVMe Simple SSD Configuration",
    "Description": "An NVM Express Subsystem is an NVMe device that contains one or more NVM Express controllers and may contain one or more namespaces.",
    "Status": {
        "State": "Enabled",
        "Health": "OK",
        "HealthRollup": "OK"
    },
    "Identifiers": [
        {
            "DurableNameFormat": "NQN",
            "DurableName": "nqn.2014-08.org.nvmexpress:uuid:6c5fe566-10e6-4fb6-aad4-8b4159f50245"
        }
    ],
    "ConfigurationLock": "Partial",
    "TargetConfigurationLockLevel": "Baseline",
    "NVMeSubsystemProperties": {
        "ConfigurationLockState": {
            "FirmwareCommit": "Unlocked",
            "Lockdown": "Locked",
            "SecureSend": "LockdownUnsupported",
            "FirmwareImageDownload": "LockdownUnsupported",
            "VPDWrite": "CommandUnsupported"
        },
        "MaxNamespacesSupported": 2,
        "SharedNamespaceControllerAttachmentSupported": true
    },
    "Controllers": {
        "@odata.id": "/redfish/v1/Systems/Sys-1/Storage/NVMeSSD-EG/Controllers"
    },
    "Drives": [
        {
            "@odata.id": "/redfish/v1/Chassis/Sys-1Chassis/Drives/NVMeDrive1"
        }
    ],
    "Volumes": {
        "@odata.id": "/redfish/v1/Systems/Sys-1/Storage/NVMeSSD-EG/Volumes"
    },
    "StoragePools": {
        "@odata.id": "/redfish/v1/Systems/Sys-1/Storage/NVMeSSD-EG/StoragePools"
    },
    "Links": {
        "Enclosures": [
            {
                "@odata.id": "/redfish/v1/Chassis/Sys-1Chassis"
            }
        ]
    },
    "@odata.id": "/redfish/v1/Systems/Sys-1/Storage/NVMeSSD-EG",
    "@Redfish.Copyright": "Copyright 2015-2025 SNIA. All rights reserved."
}

6.3.2 Property Mapping

6.3.2.1 Actions.#StorageController.SetEncryptionKey

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

6.3.2.2 ConfigurationLock

The mapping for ConfigurationLock is summarized in Table 7.

6.3.2.3 Controllers

The mapping for Controllers is summarized in Table 8.

6.3.2.4 Description

The mapping for Description is summarized in Table 9.

6.3.2.5 Drives

The mapping for Drives is summarized in Table 10.

6.3.2.6 Identifiers

The mapping for Identifiers is summarized in Table 11.

6.3.2.7 Identifiers.DurableNameFormat

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

6.3.2.8 Identifiers.DurableName

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

6.3.2.9 Links.Enclosures

The mapping for Links.Enclosures is summarized in Table 14.

6.3.2.10 Links.Enclosures@odata.count

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

6.3.2.11 Links.HostingStorageSystems

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

6.3.2.12 Links.NVMeoFDiscoverySubsystems

The mapping for Links.NVMeoFDiscoverySubsystems is summarized in +@tbl: Table 17.

6.3.2.13 Links.SimpleStorage

The mapping for Links.SimpleStorage is summarized in Table 18.

6.3.2.14 NVMeSubsystemProperties.NVMeConfigurationLockState

The mapping for NVMeSubsystemProperties.NVMeConfigurationLockState is summarized in Table 19.

6.3.2.15 NVMeSubsystemProperties.NVMeConfigurationLockState.FirmwareCommit

The mapping for NVMeSubsystemProperties.NVMeConfigurationLockState.FirmwareCommit is summarized in Table 20.

6.3.2.16 NVMeSubsystemProperties.NVMeConfigurationLockState.FirmwareImageDownload

The mapping for NVMeSubsystemProperties.NVMeConfigurationLockState.FirmwareImageDownload is summarized in Table 21.

6.3.2.17 NVMeSubsystemProperties.NVMeConfigurationLockState.Lockdown

The mapping for NVMeSubsystemProperties.NVMeConfigurationLockState.Lockdown is summarized in Table 22.

6.3.2.18 NVMeSubsystemProperties.NVMeConfigurationLockState.SecuritySend

The mapping for NVMeSubsystemProperties.NVMeConfigurationLockState.SecuritySend is summarized in Table 23.

6.3.2.19 NVMeSubsystemProperties.NVMeConfigurationLockState.VPDWrite

The mapping for NVMeSubsystemProperties.NVMeConfigurationLockState.VPDWrite is summarized in Table 24.

6.3.2.20 NVMeSubsystemProperties.MaxNamespacesSupported

The mapping for NVMeSubsystemProperties.MaxNamespacesSupported is summarized in Table 25.

6.3.2.21 NVMeSubsystemProperties.SharedNamespaceControllerAttachmentSupported

The mapping for NVMeSubsystemProperties.SharedNamespaceControllerAttachmentSupported is summarized in Table 26.

6.3.2.22 Name

The mapping for Name is summarized in Table 27.

6.3.2.23 Status.State

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

6.3.2.24 Status.Health

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

6.3.2.25 Status.HealthRollup

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

6.3.2.26 StorageControllers

The mapping for StorageControllers is summarized in Table 31.

6.3.2.27 StorageGroups

The mapping for StorageGroups is summarized in Table 32.

6.3.2.28 StoragePools

The mapping for StoragePools is summarized in Table 33.

6.3.2.29 TargetConfigurationLockLevel

The mapping for TargetConfigurationLockLevel is summarized in Table 34.

6.3.2.30 Volumes

The mapping for Volumes is summarized in Table 35.

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.5 Admin Controller

6.5.1 Mockup

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

{
    "@odata.type": "#StorageController.v1_3_0.StorageController",
    "Name": "NVMe Admin Controller",
    "Description": "Single NVMe Admin Controller for in-band admin command access.",
    "Status": {
        "State": "Enabled",
        "Health": "OK"
    },
    "Id": "NVMeAdminController",
    "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,
            "SupportsReservations": false
        },
      "NVMeSMARTCriticalWarnings": {
        "MediaInReadOnly": false,
        "OverallSubsystemDegraded": false,
        "SpareCapacityWornOut": false
      },
      "MaxQueueSize": 1
    },

    "Links": {
        "NetworkDeviceFunctions": [
            {
                "@odata.id": "/redfish/v1/Chassis/NVMeOpaqueArray/NetworkAdapters/OpaqueArrayNetworkAdapter/NetworkDeviceFunctions/11100"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/NVMeOpaqueArray/NetworkAdapters/OpaqueArrayNetworkAdapter/NetworkDeviceFunctions/11101"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/NVMeOpaqueArray/NetworkAdapters/OpaqueArrayNetworkAdapter/NetworkDeviceFunctions/11102"
            },
            {
                "@odata.id": "/redfish/v1/Chassis/NVMeOpaqueArray/NetworkAdapters/OpaqueArrayNetworkAdapter/NetworkDeviceFunctions/11103"
            }
        ]
    },
    "@odata.id": "/redfish/v1/Storage/OpaqueArray/Controllers/NVMeAdminController",
    "@Redfish.Copyright": "Copyright 2015-2025 SNIA. All rights reserved."
}

6.5.2 Property Mapping

6.5.2.1 Actions.#StorageController.RunSelfTest

The mapping for Actions.#StorageController.RunSelfTest is summarized in Table 36.

6.5.2.2 Assembly

The mapping for Assembly is summarized in Table 37.

6.5.2.3 AssetTag

The mapping for AssetTag is summarized in Table 38.

6.5.2.4 CacheSummary

The mapping for CacheSummary is summarized in Table 39.

6.5.2.5 ControllerRates

The mapping for ControllerRates is summarized in Table 40.

6.5.2.6 Description

The mapping for Description is summarized in Table 41.

6.5.2.7 FirmwareVersion

The mapping for FirmwareVersion is summarized in Table 42.

6.5.2.8 Identifiers

The mapping for Identifiers is summarized in Table 43.

6.5.2.9 Identifiers.DurableName

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

6.5.2.10 Identifiers.DurableNameFormat

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

6.5.2.11 Links.AttachedVolumes

The mapping for Links.AttachedVolumes is summarized in Table 46.

6.5.2.12 Links.NetworkDeviceFunctions

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

6.5.2.13 Location

The mapping for Location is summarized in Table 48.

6.5.2.14 Manufacturer

The mapping for Manufacturer is summarized in Table 49.

6.5.2.15 Model

The mapping for Model is summarized in Table 50.

6.5.2.16 Name

The mapping for Name is summarized in Table 51.

6.5.2.17 NVMeControllerProperties.ControllerType

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

6.5.2.18 NVMeControllerProperties.NVMeVersion

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

6.5.2.19 NVMeControllerProperties.NVMeControllerAttributes. ReportsNamespaceGranularity

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

6.5.2.20 NVMeControllerProperties.NVMeControllerAttributes. SupportsSQAssociations

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

6.5.2.21 NVMeControllerProperties.NVMeControllerAttributes. SupportsTrafficBasedKeepAlive

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

6.5.2.22 NVMeControllerProperties.NVMeControllerAttributes. SupportsExceedingPowerOfNonOperationalState

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

6.5.2.23 NVMeControllerProperties.NVMeControllerAttributes. Supports128BitHostId

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

6.5.2.24 NVMeControllerProperties.MaxQueueSize

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

6.5.2.25 NVMeControllerProperties.ANACharacteristics

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

6.5.2.26 NVMeControllerProperties.NVMeSMARTCriticalWarnings.OverallSystemDegraded

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

6.5.2.27 NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed

The mapping for NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed is summarized in +@tbl: Table 62.

6.5.2.28 SKU

The mapping for SKU is summarized in Table 63.

6.5.2.29 SpeedGbps

The mapping for SpeedGbps is summarized in Table 64.

6.5.2.30 Status.Health

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

6.5.2.31 Status.State

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

6.5.2.32 SupportedControllerProtocols

The mapping for SupportedControllerProtocols is summarized in Table 67.

6.5.2.33 SupportedDeviceProtocols

The mapping for SupportedDeviceProtocols is summarized in Table 68.

6.6 Discovery Controller

6.6.1 Mockup

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

{
  "@odata.id": "/redfish/v1/Storage/NVMeoF-Discovery/Controllers/NVMeDiscoveryController",
  "@odata.type": "#StorageController.v1_7_0.StorageController",
  "Id": "9",
  "Name": "NVMe Discovery Controller",
  "Description": "An NVM IO controller is a general-purpose controller that provides access to logical block data and metadata stored on an NVM subsystem’s non-volatile storage medium. IO Controllers may also support management capabilities.",

  "Status": {
    "State": "Enabled",
    "Health": "OK"
  },
  "Id": "NVMeDiscoveryController",

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

  "NVMeControllerProperties": {
    "DiscoveryTransportServiceId": 8009,
    "NVMeVersion": "20.c",
    "NVMeControllerAttributes": {
      "ReportsUUIDList": false,
      "SupportsSQAssociations": false,
      "ReportsNamespaceGranularity": false,
      "SupportsTrafficBasedKeepAlive": false,
      "SupportsPredictableLatencyMode": false,
      "SupportsEnduranceGroups": false,
      "SupportsReadRecoveryLevels": false,
      "SupportsNVMSets": false,
      "SupportsExceedingPowerOfNonOperationalState": false,
      "Supports128BitHostId": false
    }
  },
  "Links": {
    "Endpoints": [{
      "@odata.id": "/redfish/v1/Fabrics/NVMe-oF/Endpoints/NVMeSubsystemEndpoint1"
    }],
    "NVMeDiscoveredSubsystems": [{
      "@odata.id": "/redfish/v1/Storage/NVMeoF-SS1"
    },
    {
      "@odata.id": "/redfish/v1/Storage/NVMeoF-SS2"
    }
  ]
  },
  "@Redfish.Copyright": "Copyright 2015-2025 SNIA. All rights reserved."
}

6.6.2 Property Mapping

6.6.2.1 Assembly

The mapping for Assembly is summarized in Table 69.

6.6.2.2 AssetTag

The mapping for AssetTag is summarized in Table 70.

6.6.2.3 CacheSummary

The mapping for CacheSummary is summarized in Table 71.

6.6.2.4 ControllerRates

The mapping for ControllerRates is summarized in Table 72.

6.6.2.5 Description

The mapping for Description is summarized in Table 73.

6.6.2.6 FirmwareVersion

The mapping for FirmwareVersion is summarized in Table 74.

6.6.2.7 Identifiers

The mapping for Identifiers is summarized in Table 75.

6.6.2.8 Identifiers.DurableName

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

6.6.2.9 Identifiers.DurableNameFormat

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

6.6.2.10 Links.AttachedVolumes

The mapping for Links.AttachedVolumes is summarized in Table 78.

6.6.2.11 Links.Endpoints

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

6.6.2.12 Links.Connections

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

6.6.2.13 Links.NetworkDeviceFunctions

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

6.6.2.14 Links.NVMeDiscoveredSubsystems

The mapping for Links.NVMeDiscoveredSubsystems is summarized in Table 82.

6.6.2.15 Location

The mapping for Location is summarized in Table 83.

6.6.2.16 Manufacturer

The mapping for Manufacturer is summarized in Table 84.

6.6.2.17 Model

The mapping for Model is summarized in Table 85.

6.6.2.18 Name

The mapping for Name is summarized in Table 86.

6.6.2.19 NVMeControllerProperties.ControllerType

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

6.6.2.20 NVMeControllerProperties.DiscoveryTransportServiceId

The mapping for NVMeControllerProperties.DiscoveryTransportServiceId is summarized in Table 88.

6.6.2.21 NVMeControllerProperties.NVMeVersion

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

6.6.2.22 NVMeControllerProperties.NVMeControllerAttributes. SupportsTrafficBasedKeepAlive

The mapping for NVMeControllerProperties.NVMeControllerAttributes. SupportsTrafficBasedKeepAlive is summarized in Table 90.

6.6.2.23 NVMeControllerProperties.NVMeControllerAttributes. SupportsExceedingPowerOfNonOperationalState

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

6.6.2.24 NVMeControllerProperties.NVMeControllerAttributes. Supports128BitHostId

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

6.6.2.25 NVMeControllerProperties.MaxQueueSize

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

6.6.2.26 NVMeControllerProperties.NVMeSMARTCriticalWarnings. OverallSubsystemDegraded

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

6.6.2.27 NVMeControllerProperties.NVMeSMARTCriticalWarnings. SpareCapacityWornOut

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

6.6.2.28 NVMeControllerProperties.NVMeSMARTCriticalWarnings.PowerBackupFailed

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

6.6.2.29 Status.Health

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

6.6.2.30 Status.State

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

6.6.2.31 SupportedControllerProtocols

The mapping for SupportedControllerProtocols is summarized in Table 99.

6.6.2.32 SupportedDeviceProtocols

The mapping for SupportedDeviceProtocols is summarized in Table 100.

6.7 IO Controller

6.7.1 Mockup

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

{
  "@odata.type": "#StorageController.v1_7_0.StorageController",
  "Id": "NVMeIOController",
  "Name": "NVMe I/O Controller",
  "Description": "An NVM IO controller is a general-purpose controller that provides access to logical block data and metadata stored on an NVM subsystem’s non-volatile storage medium. IO Controllers may also support management capabilities.",
  "Status": {
    "State": "Enabled",
    "Health": "OK"
  },
  "Manufacturer": "Best NVMe Vendor",
  "Model": "Simple NVMe Device",
  "SerialNumber": "NVME123456",
  "PartNumber": "NVM44",
  "FirmwareVersion": "1.0.0",
  "SupportedControllerProtocols": [
    "PCIe"
  ],
  "SupportedDeviceProtocols": [
    "NVMe"
  ],
  "SupportedRAIDTypes": [
    "None"
  ],
  "NVMeControllerProperties": {
    "ControllerType": "IO",
    "NVMeVersion": "1.3",
    "NVMeControllerAttributes": {
      "ReportsUUIDList": false,
      "SupportsSQAssociations": false,
      "ReportsNamespaceGranularity": false,
      "SupportsTrafficBasedKeepAlive": false,
      "SupportsPredictableLatencyMode": false,
      "SupportsEnduranceGroups": false,
      "SupportsReadRecoveryLevels": false,
      "SupportsNVMSets": false,
      "SupportsExceedingPowerOfNonOperationalState": false,
      "Supports128BitHostId": false
    },
    "NVMeSMARTCriticalWarnings": {
      "MediaInReadOnly": false,
      "OverallSubsystemDegraded": false,
      "SpareCapacityWornOut": false
    },
    "MaxQueueSize": 1
  },
  "Links": {
    "AttachedVolumes": [{
      "@odata.id": "/redfish/v1/Systems/Sys-1/Storage/SimplestNVMeSSD/Volumes/SimpleNamespace"
    }]
  },
  "Actions": {
    "#StorageController.SecuritySend": {
      "target": "/redfish/v1/Systems/Sys-1/Storage/SimplestNVMeSSD/Controllers/NVMeIOController/Actions/ StorageController.SecuritySend"
    },
    "#StorageController.SecurityReceive": {
      "target": "/redfish/v1/Systems/Sys-1/Storage/SimplestNVMeSSD/Controllers/NVMeIOController/Actions/ StorageController.SecurityReceive"
    }
  },
  "@odata.id": "/redfish/v1/Systems/Sys-1/Storage/SimplestNVMeSSD/Controllers/NVMeIOController",
  "@Redfish.Copyright": "Copyright 2015-2025 SNIA. All rights reserved."
}

6.7.2 Property Mapping

6.7.2.1 Actions.#StorageController.RunSelfTest

The mapping for Actions.#StorageController.RunSelfTest is summarized in Table 101.

The mapping for Assembly is summarized in Table 102.

6.7.2.2 AssetTag

The mapping for AssetTag is summarized in Table 103.

6.7.2.3 CacheSummary

The mapping for CacheSummary is summarized in Table 104.

6.7.2.4 ControllerRates

The mapping for ControllerRates is summarized in Table 105.

6.7.2.5 Description

The mapping for Description is summarized in Table 106.

6.7.2.6 FirmwareVersion

The mapping for FirmwareVersion is summarized in Table 107.

6.7.2.7 Identifiers

The mapping for Identifiers is summarized in Table 108.

6.7.2.8 Identifiers.DurableName

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

6.7.2.9 Identifiers.DurableNameFormat

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

6.7.2.10 Links.AttachedVolumes

The mapping for Links.AttachedVolumes is summarized in Table 111.

6.7.2.11 Links.Endpoints

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

6.7.2.12 Links.Connections

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

6.7.2.13 Links.NetworkDeviceFunctions

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

6.7.2.14 Location

The mapping for Location is summarized in Table 115.

6.7.2.15 Manufacturer

The mapping for Manufacturer is summarized in Table 116.

6.7.2.16 Model

The mapping for Model is summarized in Table 117.

6.7.2.17 Name

The mapping for Name is summarized in Table 118.

6.7.2.18 NVMeControllerProperties.ControllerType

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

6.7.2.19 NVMeControllerProperties.NVMeVersion

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

6.7.2.20 NVMeControllerProperties.NVMeControllerAttributes.ReportsUUIDList

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

6.7.2.21 NVMeControllerProperties.NVMeControllerAttributes. SupportsSQAssociations

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

6.7.2.22 NVMeControllerProperties.NVMeControllerAttributes. ReportsNamespaceGranularity

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

6.7.2.23 NVMeControllerProperties.NVMeControllerAttributes.SupportsReservations

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

6.7.2.24 NVMeControllerProperties.NVMeControllerAttributes. SupportsTrafficBasedKeepAlive

The mapping for NVMeControllerProperties.NVMeControllerAttributes. SupportsTrafficBasedKeepAlive is summarized in Table 125.

6.7.2.25 NVMeControllerProperties.NVMeControllerAttributes.SupportsPredictableLatencyMode

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

6.7.2.26 NVMeControllerProperties.NVMeControllerAttributes.SupportsEnduranceGroups

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

6.7.2.27 NVMeControllerProperties.NVMeControllerAttributes.SupportsReadRecoveryLevels

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

6.7.2.28 NVMeControllerProperties.NVMeControllerAttributes.SupportsNVMSets

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

6.7.2.29 NVMeControllerProperties.NVMeControllerAttributes. SupportsExceedingPowerOfNonOperationalState

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

6.7.2.30 NVMeControllerProperties.NVMeControllerAttributes. Supports128BitHostId

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

6.7.2.31 NVMeControllerProperties.MaxAttachedNamespaces

6.7.2.32 NVMeControllerProperties.MaxQueueSize

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