Vsan System Ex Vsan Query Syncing Vsan Objects

Vsan System Ex Vsan Query Syncing Vsan Objects

Query information about vSAN objects that are currently syncing data.

It will retrieve information about syncing objects based on query options.

Required privileges: System.Read

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanSystemEx/{moId}/VsanQuerySyncingVsanObjects
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 VsanSystemEx/{moId}.

string
release
Required

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

Request Body
VsanQuerySyncingVsanObjectsRequestType of type(s) application/json
Required 
"VsanQuerySyncingVsanObjectsRequestType Object"
array of string
uuids
Optional

Restricts the list of object identities to query.

integer As int32 As int32
start
Optional

Indicates the number of objects to be skipped when returns query results. A value less than 0 is illegal. Default: 0.

integer As int32 As int32
limit
Optional

Restricts the max number of objects to return. Valid value is from 0 to 200. A value less than 0 is illegal, 0 is valid only when "includeSummary" is true. Default: 100.

boolean
includeSummary
Optional

Indicates whether to return summary data in query result. Default: True.

Authentication
This operation uses the following authentication methods.
Responses
200

vim.vsan.host.VsanSyncingObjectQueryResult.

Returns VsanHostVsanObjectSyncQueryResult of type(s) application/json 
"VsanHostVsanObjectSyncQueryResult Object"
integer As int64 As int64
totalObjectsToSync
Optional

Total number of vSAN objects that are syncing.

It's returned only when summary data is needed.

integer As int64 As int64
totalBytesToSync
Optional

The amount of data to be re-synced.

It's returned only when summary data is needed.

integer As int64 As int64
totalRecoveryETA
Optional

The estimated time in seconds to recover all vSAN objects of specified types.

It's returned only when summary data is needed.

array of object
objects
Optional

The retrieved objects.

syncingObjectRecoveryDetails
Optional

Details returned from querying vSAN syncing objects for different sync status.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanSystemEx/{moId}/VsanQuerySyncingVsanObjects
On This Page
V San Service Api Operations
POST
Vsan System Ex Vsan Host Abort Wipe Disk
POST
Vsan System Ex Vsan Get About Info Ex
POST
Vsan System Ex Vsan Host Get Runtime Stats
POST
Vsan System Ex Vsan Query Host Drs Stats
POST
Vsan System Ex Vsan Query Host Status Ex
POST
Vsan System Ex Vsan Query Syncing Vsan Objects
POST
Vsan System Ex Vsan Query What If Evacuation Result
POST
Vsan System Ex Vsan Host Query Wipe Disk
POST
Vsan System Ex Vsan Unmount Disk Mapping Ex
POST
Vsan System Ex Vsan Host Wipe Disk