This API has a deprecated equivalent from v7.0U1.
Evict Subscribed Library
DescriptionEvicts the cached content of an on-demand subscribed library. This operation allows the cached content of a subscribed library to be removed to free up storage capacity. This operation will only work when a subscribed library is synchronized on-demand.
if you do not have all of the privileges described as follows: - The resource com.vmware.content.Library referenced by the parameter libraryId requires ContentLibrary.EvictSubscribedLibrary.
Request
URLURL
https://{api_host}/api/content/subscribed-library/{library_id}?action=evict
Path Parameters
Path Parameters
string
library_id
Required
Identifier of the subscribed library whose content should be evicted. The parameter must be an identifier for the resource type: com.vmware.content.Library.
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.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_element_type : if the library specified by libraryId is not a subscribed library. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the library specified by libraryId does not synchronize on-demand, or if the content of the library specified by libraryId has been deleted from the storage backings (see LibraryModel.storage-backings) associated with it. For instance, this {@term error) is reported on evicting an on-demand subscribed library that was restored from backup, and the library was deleted after the backup was taken, thus resulting in its content being deleted from the associated storage backings. In this scenario, the metadata of the library is present on a restore, while its content has been deleted.
404
com.vmware.vapi.std.errors.not_found : if the library specified by libraryId does not exist.
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-EvictLibraryIdSubscribedLibrary -LibraryId "MyLibraryId"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/content/subscribed-library/{library_id}?action=evict
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/content/subscribed-library/id:{library_id}?~action=evict
x-vmw-doc-operation: evict
Availability
Added in 7.0U2
On This Page
Subscribed Library Operations
delete
