This API has a deprecated equivalent from v7.0U1.
Update Configuration
DescriptionUpdates the configuration. The update is incremental. Any field in the ConfigurationModel structure that is unset will not be modified. Note that this update operation doesn’t guarantee an atomic change of all the properties. In the case of a system crash or failure, some of the properties could be left unchanged while others may be updated. if you do not have all of the privileges described as follows: - Operation execution requires ContentLibrary.UpdateConfiguration.
Request
URLURL
https://{api_host}/api/content/configuration
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
ConfigurationModel of mimetype application/json
Required
The ConfigurationModel specifying the settings to update.
{
"automatic_sync_enabled": false,
"automatic_sync_start_hour": 0,
"automatic_sync_stop_hour": 0,
"maximum_concurrent_item_syncs": 0
}
boolean
automatic_sync_enabled
Optional
Whether automatic synchronization is enabled. When automatic synchronization is enabled, the Content Library Service will automatically synchronize all subscribed libraries on a daily basis. Subscribed libraries with the SubscriptionInfo.automatic-sync-enabled flag turned on will be synchronized every hour between ConfigurationModel.automatic-sync-start-hour and ConfigurationModel.automatic-sync-stop-hour.
This field is not used for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.
integer
automatic_sync_start_hour
Optional
The hour at which the automatic synchronization will start. This value is between 0 (midnight) and 23 inclusive. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.
integer
automatic_sync_stop_hour
Optional
The hour at which the automatic synchronization will stop. Any active synchronization operation will continue to run, however no new synchronization operations will be triggered after the stop hour. This value is between 0 (midnight) and 23 inclusive. This field is not used for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.
integer
maximum_concurrent_item_syncs
Optional
The maximum allowed number of library items to synchronize concurrently from remote libraries. This must be a positive number. The service may not be able to guarantee the requested concurrency if there is no available capacity. This setting is global across all subscribed libraries.
This field is not used for the create operation. It will always be present in the result of the get or list operations. It is optional for the update operation.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if one of the configuration properties is not within the proper range.
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
$ConfigurationModel = Initialize-ConfigurationModel -AutomaticSyncEnabled $false -AutomaticSyncStartHour 0 -AutomaticSyncStopHour 0 -MaximumConcurrentItemSyncs 0
Invoke-UpdateContentConfiguration -ConfigurationModel $ConfigurationModel
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"automatic_sync_enabled":false,"automatic_sync_start_hour":0,"automatic_sync_stop_hour":0,"maximum_concurrent_item_syncs":0}' https://{api_host}/api/content/configuration
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: patch
x-vmw-doc-deprecated-path: /rest/com/vmware/content/configuration
x-vmw-doc-operation: update
Availability
Added in 7.0U2
On This Page
Configuration Operations
patch
