Managed Object - HostNvdimmSystem(vim.host.NvdimmSystem)

Property of: HostConfigManager
See also: NvdimmGuid, NvdimmNamespaceCreateSpec, NvdimmNamespaceDeleteSpec, NvdimmPMemNamespaceCreateSpec, NvdimmSystemInfo
Since: vSphere API 6.7

Managed Object Description

Managed object responsible for reading and configuring Non-Volatile DIMMs.

Properties

Name	Type	Description
nvdimmSystemInfo P	NvdimmSystemInfo	Host NVDIMM information. - Summary of all dimms on the host. - Array of all DIMMs on the host. - Array of DIMM information and health for all dimms on the host. - Array of interleave set for all sets on the host. - Array of interleave set information for all sets on the host. - Array of namespace IDs for all dimms on the host. - Array of namespace details of all dimms on the host.

Name

Type

Description

nvdimmSystemInfo P

NvdimmSystemInfo

Host NVDIMM information. - Summary of all dimms on the host. - Array of all DIMMs on the host. - Array of DIMM information and health for all dimms on the host. - Array of interleave set for all sets on the host. - Array of interleave set information for all sets on the host. - Array of namespace IDs for all dimms on the host. - Array of namespace details of all dimms on the host.

P Required privilege: Host.Config.Nvdimm

Methods

Methods defined in this Managed Object
CreateNvdimmNamespace_Task, CreateNvdimmPMemNamespace_Task, DeleteNvdimmBlockNamespaces_Task, DeleteNvdimmNamespace_Task

CreateNvdimmNamespace_Task(createNamespace)

Deprecated. As of vSphere 6.7u1, use createPMemNamespace Create nvd namespace from information passed in NamespaceCreationSpec.
A new block or persistent namespace can be created on the NVDIMM(s) when the system is in maintenance mode. If all the parameters passed are valid and system is in maintenance mode, then a DSM (Device Specific Method) call is made to create the namespace. DSM calls are blockable and slow operations and hence the use of task.

If a new namespace is created, its UUID is returned.

deprecated As of vSphere 6.7u1, use createPMemNamespace Create nvd namespace from information passed in NamespaceCreationSpec.

A new block or persistent namespace can be created on the NVDIMM(s) when the system is in maintenance mode. If all the parameters passed are valid and system is in maintenance mode, then a DSM (Device Specific Method) call is made to create the namespace. DSM calls are blockable and slow operations and hence the use of task.

If a new namespace is created, its UUID is returned.

Required Privileges: Host.Config.Nvdimm

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostNvdimmSystem used to make the method call.

createSpec P

NvdimmNamespaceCreateSpec

Parameters to create the required namespace.

Since vSphere API 6.7

P Required privilege: createSpec

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object which is used to monitor this operation. The task result (Info.result) contains a Guid object that has the UUID of the newly created namespace.

Faults

Type	Description
AlreadyExists	Thrown if the namespace of type already exists.
HostConfigFault	Thrown for any other failure.
InvalidHostState	Thrown if operation is not allowed as system is not in maintenance mode.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

CreateNvdimmPMemNamespace_Task(createPMemNamespace)

Create persistent memory mode nvd namespace from information passed in PMemNamespaceCreationSpec.

A new persistent namespace can be created on the NVDIMM(s) when the system is in maintenance mode. If all the parameters passed are valid and system is in maintenance mode, then a DSM (Device Specific Method) call is made to create the namespace. DSM calls are blockable and slow operations and hence the use of task.

If a new namespace is created, its UUID is returned.

Required Privileges: Host.Config.Nvdimm
Since: vSphere API 6.7.1

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostNvdimmSystem used to make the method call.

createSpec P

NvdimmPMemNamespaceCreateSpec

Parameters to create the required namespace.

Since vSphere API 6.7.1

P Required privilege: createSpec

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object which is used to monitor this operation. The task result (Info.result) contains a Guid object that has the UUID of the newly created namespace.

Faults

Type	Description
AlreadyExists	Thrown if the namespace of type already exists.
HostConfigFault	Thrown for any other failure.
InvalidHostState	Thrown if operation is not allowed as system is not in maintenance mode.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

DeleteNvdimmBlockNamespaces_Task(deleteBlockNamespaces)

Delete all block mode namespaces in the system.

Existing block namespace(s) can be deleted from all NVDIMMs, if the system is in maintenance mode. If paramters passed are valid and the system is in maintenance mode, then DSM calls are made to delete these namespaces. DSM calls are blockable, slow operations and hence the use of task.

If a particular block namespace is to be deleted, use DeleteNvdimmNamespace_Task by passing it the UUID of the block namespace.

Required Privileges: Host.Config.Nvdimm

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostNvdimmSystem used to make the method call.

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object which is used to monitor this operation.

Faults

Type	Description
HostConfigFault	Thrown for any other failure.
InvalidHostState	Thrown if operation is not allowed as system is not in maintenance mode.
NotFound	Thrown if the namespace to be deleted is not found.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

DeleteNvdimmNamespace_Task(deleteNamespace)

Delete nvd namespace whose uuid matches passed parameter.

An existing namespace of type block or persistent mode can be deleted from NVDIMM(s), if the system is in maintenance mode. If paramters passed are valid and the system is in maintenance mode, then a DSM call is made to delete this namespace. DSM calls are blockable, slow operations and hence the use of task.

Required Privileges: Host.Config.Nvdimm

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostNvdimmSystem used to make the method call.

deleteSpec P

NvdimmNamespaceDeleteSpec

Details of namespace to be deleted.

Since vSphere API 6.7

P Required privilege: deleteSpec

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object which is used to monitor this operation.

Faults

Type	Description
HostConfigFault	Thrown for any other failure.
InvalidHostState	Thrown if operation is not allowed as system is not in maintenance mode.
NotFound	Thrown if the namespace to be deleted is not found.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None