Get Depots Sync Schedule
Returns the currently configured software depot sync schedule. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
Request
URLURL
https://{api_host}/api/esx/settings/depots/sync-schedule
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
SettingsDepotsSyncScheduleSpec
of type application/json
Currently configured sync schedule.
{
"email_addresses": [
"string"
],
"enabled": false,
"schedule": {
"day_of_month": 0,
"day_of_week": "SUNDAY",
"hour": 0,
"minute": 0,
"skip": 0,
"type": "HOURLY"
}
}
array of
string
email_addresses
Required
Email addresses to which the notification will be sent. If empty, no notification is sent.
boolean
enabled
Required
Flag indicating whether automatic sync is enabled or not
schedule
Optional
The schedule to check for new updates. If unset the schedule must be disabled.
Errors
500
com.vmware.vapi.std.errors.error : If there is some unknown error. The accompanying error message will give more details about the failure.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetDepotsSyncSchedule
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depots/sync-schedule
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.0.0
