Data Object - HostNvmeController(vim.host.NvmeController)

Property of
HostNvmeTopologyInterface
Extends
DynamicData
See also
HostHostBusAdapter, HostNvmeNamespace
Since
vSphere API 7.0

Data Object Description

This data object represents an NVME controller.

Some terminology is borrowed from the NVM Express over Fabrics and the NVM Express 1.3 specifications, which are available at the following address: https://nvmexpress.org/resources/specifications/

Properties

Name Type Description
associatedAdapterxsd:string

Associated NVME over Fabrics host bus adapter.

A controller is associated with exactly one host at a time through an NVME over Fabrics host bus adapter.

attachedNamespace*HostNvmeNamespace[]

List of NVME namespaces attached to the controller.

Namespaces provide access to a non-volatile storage medium which is part of the NVM subsystem. For an overview, see:

  • "NVM Express over Fabrics 1.0", Section 1.5.2, "NVM Subsystem".
  • "NVM Express 1.3", section 6.1, "Namespaces".

controllerNumberxsd:int

The controller number uniquely identifies the NVME Controller within its HostSystem.

This should not be confused with Controller ID (see "NVM Express over Fabrics 1.0", Section 4.2, "Controller model" for details), which only serves as an identifier within a particular NVME subsystem.

firmwareVersion*xsd:string

The firmware version of the controller, if available.
fusedOperationSupportedxsd:boolean

Indicates whether fused operations are supported by the controller.

An NVME controller may support fused operations. This is required to support shared storage, otherwise data corruption may occur. For more details, see:

  • "NVM Express 1.3", Section 6.2, "Fused Operations".

keyxsd:string

The linkable identifier.
model*xsd:string

The model name of the controller, if available.
namexsd:string

Name of the controller.

Each controller has a name. For NVME over Fabrics controllers, it is generated when the controller is connected to an NVME over Fabrics adapter.

numberOfQueuesxsd:int

The number of I/O queues allocated for the controller.
queueSizexsd:int

The size of each of the I/O queues.

This will not be greater than the Maximum Queue Entries Supported (mqes) value for the controller. For more information, see:

  • "NVM Express 1.3", section 3.1, "Register definition".

serialNumber*xsd:string

The serial number of the controller, if available.
subnqnxsd:string

The NVME subsystem qualified name.

Each NVME controller is associated with an NVME subsystem which can present a collection of controllers to the adapter. For more details, refer to:

  • "NVM Express over Fabrics 1.0", Section 1.5.2, "NVM Subsystem".

transportTypexsd:string

The transport type supported by the controller.

The set of possible values is described in HostNvmeTransportType. For details, see:

  • "NVM Express over Fabrics 1.0", Section 1.5.1, "Fabrics and Transports".

vendorId*xsd:string

The vendor ID of the controller, if available.
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition