Set Depots Sync Schedule
DescriptionSets the software depot sync schedule. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Write.
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"
Request Body
Request Body
SettingsDepotsSyncScheduleSpec of mimetype application/json
Optional
Information of the software depot sync schedule. If unset, it will be reset to the default schedule, which is daily at a random hour chosen when this API is called.
{
"email_addresses": [
"string"
],
"enabled": false
}
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.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If SyncSchedule.Spec.schedule is unset while SyncSchedule.Spec.enabled is set to true or if any of the values is not within valid range.
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-SetDepotsSyncSchedule
PowerCLI Client SDK All Parameters Example
$SettingsDepotsSyncScheduleSchedule = Initialize-SettingsDepotsSyncScheduleSchedule -Type "HOURLY" -Skip 0 -Minute 0 -Hour 0 -DayOfMonth 0 -DayOfWeek "SUNDAY"
$SettingsDepotsSyncScheduleSpec = Initialize-SettingsDepotsSyncScheduleSpec -Enabled $false -Schedule $SettingsDepotsSyncScheduleSchedule -EmailAddresses "MyEmailAddresses"
Invoke-SetDepotsSyncSchedule -SettingsDepotsSyncScheduleSpec $SettingsDepotsSyncScheduleSpec
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"email_addresses":["string"],"enabled":false,"schedule":{"day_of_month":0,"day_of_week":"SUNDAY","hour":0,"minute":0,"skip":0,"type":"HOURLY"}}' 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: set
Availability
Added in 7.0.0.0
