Sync Depots Task
Syncs the metadata from the currently configured online or umds depots. If any umds depot is set, then metadata is downloaded from that depot else metadata is downloaded from the online depots. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
Request
URLURL
https://{api_host}/api/esx/settings/depots?action=sync&vmw-task=true
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists.
PowerCLI Client SDK Example
Invoke-SyncDepotsAsync
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depots?action=sync&vmw-task=true
Errors
500
com.vmware.vapi.std.errors.timed_out : if the service is timed out. | com.vmware.vapi.std.errors.error : if there is some unknown internal error. The accompanying error message will give more details about the failure.
Vendor Extensions
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: sync_task
Availability
Added in 7.0.0
