HostNvmeDiscoveryLogEntry

HostNvmeDiscoveryLogEntry
HostNvmeDiscoveryLogEntry

This data object represents a single entry in the Discovery Log returned by a Discovery controller.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "subnqn": "string",
    "subsystemType": "string",
    "subsystemPortId": 0,
    "controllerId": 0,
    "adminQueueMaxSize": 0,
    "transportParameters": {
        "_typeName": "string"
    },
    "transportRequirements": "string",
    "connected": false
}
string
subnqn
Required

NVME Qualified name of the discovered subsystem.

Corresponds to the SUBNQN field in the Discovery Log Page Entry as specified by the NVME over Fabrics spec.

string
subsystemType
Required

NVM Subsystem type.

Corresponds to the SUBTYPE field in the Discovery Log Page Entry as specified by the NVME over Fabrics spec. The set of supported values is described in HostNvmeDiscoveryLogSubsystemTypeEnum.

integer As int32 As int32
subsystemPortId
Required

NVM subsystem port ID.

Corresponds to the PORTID field in the Discovery Log Page Entry as specified by the NVME over Fabrics spec. For an overview, see:

  • "NVM Express over Fabrics 1.0", Section 1.5.2, NVM Subsystem
integer As int32 As int32
controllerId
Required

NVME Controller ID within the NVM subsystem.

Corresponds to the CNTLID field in the Discovery Log Page Entry as specified by the NVME over Fabrics spec. In the static controller model, this field may be set to a specific controller ID which can be used to connect to that particular controller. It could also be set to 0xFFFE (65534 in decimal), in which case the controller ID will be allocated when a connection is established. In the dynamic controller model, this field shall be set to 0xFFFF (65535 in decimal). Note that this is different from the controllerNumber controllerNumber, which is the unique identifier of the NVMe controller within the entire host and is allocated only after a connection is established.

integer As int32 As int32
adminQueueMaxSize
Required

The maximum size of the Admin Submission Queue.

Corresponds to the ASQSZ field in the Discovery Log Page Entry as specified by the NVME over Fabrics spec. This applies to all controllers within the NVM Subsystem. When establishing a connection, the value of adminQueueSize may not exceed this value.

transportParameters
Required

This data object represents the transport specific parameters necessary to establish an NVM Express over Fabrics connection.

For some further information, see:

  • "NVM Express over Fabrics 1.0", Section 1.5.7, "Connection"
string
transportRequirements
Required

The requirements for NVME Transport.

Corresponds to the TREQ field in the Discovery Log Page Entry as specified by the NVME over Fabrics spec The set of possible values is described in HostNvmeDiscoveryLogTransportRequirementsEnum

boolean
connected
Required

Indicates whether the controller represented by this Discovery Log Page Entry is already connected to the adapter through which the discovery is initiated.