This API has a deprecated equivalent from v7.0U1.
Rollback Library Items Versions
Rollbacks a library item containing a virtual machine template to a previous version. The virtual machine template at the specified version becomes the latest virtual machine template with a new version identifier. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckInTemplate. - The resource com.vmware.content.library.item.Version referenced by the parameter version requires System.Read.
Request
URLURL
https://{api_host}/api/vcenter/vm-template/library-items/{template_library_item}/versions/{version}?action=rollback
Path Parameters
Path Parameters
string
template_library_item
Required
Identifier of the VM template library item. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.
string
version
Required
Version of the library item to rollback. The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version.
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
VmTemplateLibraryItemsVersionsRollbackSpec of mimetype application/json
Required
Specification to rollback the library item. This parameter is currently required. In the future, if this parameter is unset, the system will apply suitable defaults.
{
"message": "string"
}
string
message
Required
Message describing the reason for the rollback.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
string
of type application/json
The new version of the library item. The result will be an identifier for the resource type: com.vmware.content.library.item.Version.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the specified version is the latest version of the library item. if the library item does not contain a virtual machine template. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if a virtual machine is checked out of the library item.
401
com.vmware.vapi.std.errors.unauthenticated : if the user that requested the operation cannot be authenticated.
403
com.vmware.vapi.std.errors.unauthorized : if the user that requested the operation is not authorized to perform the operation.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
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
$VmTemplateLibraryItemsVersionsRollbackSpec = Initialize-VmTemplateLibraryItemsVersionsRollbackSpec -Message "MyMessage"
Invoke-RollbackTemplateLibraryItemVersion -TemplateLibraryItem "MyTemplateLibraryItem" -Version "MyVersion" -VmTemplateLibraryItemsVersionsRollbackSpec $VmTemplateLibraryItemsVersionsRollbackSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"message":"string"}' https://{api_host}/api/vcenter/vm-template/library-items/{template_library_item}/versions/{version}?action=rollback
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/vcenter/vm-template/library-items/{template_library_item}/versions/{version}?action=rollback
x-vmw-doc-operation: rollback
Availability
Added in 7.0U2
