Host Nvdimm System Delete Nvdimm Block Namespaces Task

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

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostNvdimmSystem/{moId}/DeleteNvdimmBlockNamespaces_Task

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case HostNvdimmSystem/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

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

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

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.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Errors

Host Nvdimm System Operations

POST

Host Nvdimm System Create Nvdimm Namespace Task

POST