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://{api_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 9.0.0.0 APIs.

Request Body
QueryPartitionCreateDescRequestType of type(s) application/json
Required 
"QueryPartitionCreateDescRequestType Object"
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 
"HostDiagnosticPartitionCreateDescription Object"
layout
Required

Layout describing the format of the disk In releases after vSphere API 5.0, vSphere Servers might not generate property collector update notifications for this property.

To obtain the latest value of the property, you can use PropertyCollector methods RetrievePropertiesEx or WaitForUpdatesEx. If you use the PropertyCollector.WaitForUpdatesEx method, specify an empty string for the version parameter. Since this property is on a DataObject, an update returned by WaitForUpdatesEx may contain values for this property when some other property on the DataObject changes. If this update is a result of a call to WaitForUpdatesEx with a non-empty version parameter, the value for this property may not be current.

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.

spec
Required

Creation specification for diagnostic partition


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: InlineVimFault0 
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/HostDiagnosticSystem/{moId}/QueryPartitionCreateDesc
On This Page
Virtual Infrastructure Operations
POST
Host Diagnostic System Create Diagnostic 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
GET
Host Diagnostic System Get Active Partition