Host Diagnostic System Query Partition Create Desc

Host Diagnostic System Query Partition Create Desc

For a disk, query for the diagnostic partition creation description.

The description details how the diagnostic partition will be created on the disk and provides a creation specification that is needed to invoke the create operation.

See also HostScsiDisk, uuid.

Required privileges: Host.Config.Storage

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/HostDiagnosticSystem/{moId}/QueryPartitionCreateDesc
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 HostDiagnosticSystem/{moId}.

string
release
Required

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

Request Body
QueryPartitionCreateDescRequestType of type(s) application/json
Required 
{
    "diskUuid": "string",
    "diagnosticType": "string"
}
string
diskUuid
Required

diskUuid

string
diagnosticType
Required

diagnosticType

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns HostDiagnosticPartitionCreateDescription of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "layout": {
        "total": {
            "blockSize": 0,
            "block": 0
        },
        "partition": [
            {
                "_typeName": "string",
                "partition": 0,
                "type": "string",
                "start": {
                    "blockSize": 0,
                    "block": 0
                },
                "end": {
                    "blockSize": 0,
                    "block": 0
                }
            }
        ]
    },
    "diskUuid": "string",
    "spec": {
        "storageType": "string",
        "diagnosticType": "string",
        "id": {
            "diskName": "string",
            "partition": 0
        },
        "partition": {
            "partitionFormat": "string",
            "chs": {
                "cylinder": 0,
                "head": 0,
                "sector": 0
            },
            "totalSectors": 0,
            "partition": [
                {
                    "_typeName": "string",
                    "partition": 0,
                    "startSector": 0,
                    "endSector": 0,
                    "type": "string",
                    "guid": "string",
                    "logical": false,
                    "attributes": 0,
                    "partitionAlignment": 0
                }
            ]
        },
        "active": false
    }
}
HostDiskPartitionLayout
layout
Required

This data object type describes the disk partition layout specified as a list of ordered BlockRanges.

This view of the disk partitions shows the data on the disk as a contiguous set of BlockRanges.

string
diskUuid
Required

The UUID of the SCSI disk on which to create the diagnostic partition.

This disk UUID will match that found in the identification field of the creation spec.

See also HostScsiDisk, ScsiLun.uuid.

HostDiagnosticPartitionCreateSpec
spec
Required

The diagnostic create specification is used by the system to create a new diagnostic partition on a SCSI disk.


500

NotSupported: if the host is not an ESX Server.

NotFound: if the specified disk cannot be found.

InvalidArgument: if an invalid storage type is specified or the specified disk is unable to accommodate a new diagnostic partition.

HostConfigFault: on some internal failure while trying to query information about the disk.

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
Host Diagnostic System Operations
POST
Host Diagnostic System Create Diagnostic Partition
GET
Host Diagnostic System Get Active Partition
POST
Host Diagnostic System Query Available Partition
POST
Host Diagnostic System Query Partition Create Desc
POST
Host Diagnostic System Query Partition Create Options
POST
Host Diagnostic System Select Active Partition