Struct HostNvdimmSystem

Source

pub struct HostNvdimmSystem { /* private fields */ }

Expand description

Deprecated as of vSphere 9.0 APIs with no replacement.

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

Implementations§

Source §

impl HostNvdimmSystem

Source

pub fn new(client: Arc<dyn VimClient>, mo_id: &str) -> Self

Source

pub async fn create_nvdimm_namespace_task( &self, create_spec: &NvdimmNamespaceCreateSpec, ) -> Result<ManagedObjectReference>

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:

§create_spec

Parameters to create the required namespace.

§Returns:

This method returns a Task object which is used to monitor this operation. The task result (Task.info.TaskInfo.result) contains a NvdimmGuid object that has the UUID of the newly created namespace.

Refers instance of Task.

§Errors:

InvalidArgument: if an argument to create namespace is invalid.

NotSupported: if no NVDIMMs are found, namespace type is not supported or if operation does not have DSM method.

InvalidHostState: if operation is not allowed as system is not in maintenance mode.

AlreadyExists: if the namespace of type already exists.

SystemError: for other system errors along with localized reason for failure.

HostConfigFault: for any other failure.

Source

pub async fn create_nvdimm_p_mem_namespace_task( &self, create_spec: &NvdimmPMemNamespaceCreateSpec, ) -> Result<ManagedObjectReference>

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

§Parameters:

§create_spec

Parameters to create the required namespace.

§Returns:

This method returns a Task object which is used to monitor this operation. The task result (Task.info.TaskInfo.result) contains a NvdimmGuid object that has the UUID of the newly created namespace.

Refers instance of Task.

§Errors:

InvalidArgument: if an argument to create namespace is invalid.

NotSupported: if no NVDIMMs are found or if operation does not have the supporting DSM method.

InvalidHostState: if operation is not allowed as system is not in maintenance mode.

AlreadyExists: if the namespace of type already exists.

SystemError: for other system errors along with localized reason for failure.

HostConfigFault: for any other failure.

Source

pub async fn delete_nvdimm_block_namespaces_task( &self, ) -> Result<ManagedObjectReference>

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 HostNvdimmSystem.DeleteNvdimmNamespace_Task by passing it the UUID of the block namespace.

Required privileges: Host.Config.Nvdimm

§Returns:

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

Refers instance of Task.

§Errors:

InvalidArgument: if UUID of namespace to be created is invalid.

NotFound: if the namespace to be deleted is not found.

NotSupported: if no NVDIMMs are found and if operation does not have DSM method.

InvalidHostState: if operation is not allowed as system is not in maintenance mode.

SystemError: for any other system error along with localized reason for failure.

HostConfigFault: for any other failure.

Source

pub async fn delete_nvdimm_namespace_task( &self, delete_spec: &NvdimmNamespaceDeleteSpec, ) -> Result<ManagedObjectReference>

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:

§delete_spec

Details of namespace to be deleted.

§Returns:

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

Refers instance of Task.

§Errors:

InvalidArgument: if UUID of namespace to be created is invalid.

NotFound: if the namespace to be deleted is not found.

NotSupported: if no NVDIMMs are found or if operation does not have DSM method.

InvalidHostState: if operation is not allowed as system is not in maintenance mode.

SystemError: for any other system error along with localized reason for failure.

HostConfigFault: for any other failure.

Source

pub async fn nvdimm_system_info(&self) -> Result<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.

Required privileges: Host.Config.Nvdimm