Esx. Settings. Depots. Sync Schedule Set

Esx. Settings. Depots. Sync Schedule Set

Sets the software depot sync schedule.

This operation was added in vSphere API 7.0.0.0.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires VcIntegrity.lifecycleSettings.Write.
Request
URI
PUT
https://{api_host}/esx/settings/depots/sync-schedule
COPY
Request Body

Information of the software depot sync schedule.

If missing or null, it will be reset to the default schedule, which is daily at a random hour chosen when this API is called.

Esx.Settings.Depots.SyncSchedule.Spec of type(s) application/json
Optional
"Esx.Settings.Depots.SyncSchedule.Spec Object"
Authentication
This operation uses the following authentication methods.
Responses
204

Success!

Operation doesn't return any data structure

400

If Esx.Settings.Depots.SyncSchedule.Spec.schedule is unset while Esx.Settings.Depots.SyncSchedule.Spec.enabled is set to true or if any of the values is not within valid range.

Returns Vapi.Std.Errors.InvalidArgument of type(s) application/json
"Vapi.Std.Errors.InvalidArgument Object"

401

if the caller is not authenticated.

Returns Vapi.Std.Errors.Unauthenticated of type(s) application/json
"Vapi.Std.Errors.Unauthenticated Object"

500

If there is some unknown error. The accompanying error message will give more details about the failure.

Returns Vapi.Std.Errors.Error of type(s) application/json
"Vapi.Std.Errors.Error Object"

503

If the service is not available.

Returns Vapi.Std.Errors.ServiceUnavailable of type(s) application/json
"Vapi.Std.Errors.ServiceUnavailable Object"

Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/esx/settings/depots/sync-schedule