Vsan Object System Vsan Query Physical Placements
Retrieves the physical disk placement detail for the backing vSAN objects from the specified entities like virtual machine.
This method provides detailed information about the physical placement of vSAN objects deployed on the specified cluster. The results include: - Object details. - Component structures. - Disk placement details. All the given object specs registered within this cluster will be retrieved. This API supports the object query mounted from remote datastores. Calling this API from host level is not supported. If the cluster argument is ignored or the object query specs are empty, the API will return an empty result. Currently, this API only supports single virtual machine.
Required privileges: System.Read
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 VsanObjectSystem/{moId}.
The vSphere release schema. The current specification covers vSphere 9.1.0.0 APIs.
Show optional properties
{
"cluster": {}
}{
"cluster": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"specs": {
"_typeName": "string",
"vms": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
]
}
}The vSAN cluster. This parameter is only applicable for cluster-level API calls.
Required privileges: System.Read
The query specifications for the objects. Multiple object specifications are supported. If unset, the method will return an empty result.
An list containing the physical placement information for the specified entities like virtual machine.
[
{
"_typeName": "string",
"details": [
{
"_typeName": "string",
"uuid": "string",
"type": "string",
"name": "string",
"isRemote": false,
"vm": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"spbmProfileUuid": "string",
"spbmProfileName": "string",
"isLocalPolicy": false,
"remoteDatastoreUuid": "string",
"remoteDatastoreName": "string",
"remoteCluster": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"remoteClusterName": "string",
"remoteVc": "string",
"healthState": "string",
"components": [
{
"_typeName": "string",
"type": "string",
"children": [
{
"_typeName": "string",
"type": "string",
"children": [
"VsanComponentPlacement Object"
],
"basicInfo": {
"_typeName": "string",
"uuid": "string",
"componentState": "string",
"hostName": "string",
"hostNodeUuid": "string",
"faultDomainUuid": "string",
"faultDomainName": "string",
"cacheDiskInfo": {
"_typeName": "string",
"diskUuid": "string",
"diskName": "string",
"isSsd": false
},
"capacityDiskInfo": {
"_typeName": "string",
"diskUuid": "string",
"diskName": "string",
"isSsd": false
}
}
}
],
"basicInfo": {
"_typeName": "string",
"uuid": "string",
"componentState": "string",
"hostName": "string",
"hostNodeUuid": "string",
"faultDomainUuid": "string",
"faultDomainName": "string",
"cacheDiskInfo": {
"_typeName": "string",
"diskUuid": "string",
"diskName": "string",
"isSsd": false
},
"capacityDiskInfo": {
"_typeName": "string",
"diskUuid": "string",
"diskName": "string",
"isSsd": false
}
}
}
]
}
]
}
]Physical placement summary with the details for object.
Within the placement summary, the object UUIDs are listed. The object UUIDs are the same as the object UUIDs in the object placement details. The object placement details are the physical placement details for the object. It contains the placement details for the object components and the disks. If the object is remote, the object placement details will provide the remote placement information like the remote datastore, remote cluster, remote VC IP, and else.
This structure may be used only with operations rendered under /vsan.
NotSupported: If run directly on an ESX Server host.
VsanFault: If run with some faults found. E.g. the VM count of the given specs exceeds the limit, and other faults like no datastore properties found in the given cluster. Details can be found in VsanFault message.
{
"_typeName": "string",
"faultCause": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}Fault which is the cause of this fault.
Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"cluster":"{}"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanObjectSystem/{moId}/VsanQueryPhysicalPlacements