public interface Versions extends Service, VersionsTypes
Versions
interface provides methods for managing the live versions
of the virtual machine templates contained in a library item. Live versions
include the latest and previous virtual machine templates that are available on
disk. As new versions of virtual machine templates are checked in, old versions
of virtual machine templates are automatically purged. Currently, at most one
previous virtual machine template version is stored. This interface was added in
vSphere API 6.9.1.VersionsTypes.Info, VersionsTypes.RollbackSpec, VersionsTypes.Summary
_VAPI_SERVICE_ID, RESOURCE_TYPE
Modifier and Type | Method and Description |
---|---|
void |
delete(java.lang.String templateLibraryItem,
java.lang.String version)
Deletes the virtual machine template contained in the library item at the
specified version.
|
void |
delete(java.lang.String templateLibraryItem,
java.lang.String version,
AsyncCallback<java.lang.Void> asyncCallback)
Deletes the virtual machine template contained in the library item at the
specified version.
|
void |
delete(java.lang.String templateLibraryItem,
java.lang.String version,
AsyncCallback<java.lang.Void> asyncCallback,
InvocationConfig invocationConfig)
Deletes the virtual machine template contained in the library item at the
specified version.
|
void |
delete(java.lang.String templateLibraryItem,
java.lang.String version,
InvocationConfig invocationConfig)
Deletes the virtual machine template contained in the library item at the
specified version.
|
VersionsTypes.Info |
get(java.lang.String templateLibraryItem,
java.lang.String version)
Returns information about the live version of a library item containing a
virtual machine template.
|
void |
get(java.lang.String templateLibraryItem,
java.lang.String version,
AsyncCallback<VersionsTypes.Info> asyncCallback)
Returns information about the live version of a library item containing a
virtual machine template.
|
void |
get(java.lang.String templateLibraryItem,
java.lang.String version,
AsyncCallback<VersionsTypes.Info> asyncCallback,
InvocationConfig invocationConfig)
Returns information about the live version of a library item containing a
virtual machine template.
|
VersionsTypes.Info |
get(java.lang.String templateLibraryItem,
java.lang.String version,
InvocationConfig invocationConfig)
Returns information about the live version of a library item containing a
virtual machine template.
|
java.util.List<VersionsTypes.Summary> |
list(java.lang.String templateLibraryItem)
Returns commonly used information about the live versions of a virtual machine
template library item.
|
void |
list(java.lang.String templateLibraryItem,
AsyncCallback<java.util.List<VersionsTypes.Summary>> asyncCallback)
Returns commonly used information about the live versions of a virtual machine
template library item.
|
void |
list(java.lang.String templateLibraryItem,
AsyncCallback<java.util.List<VersionsTypes.Summary>> asyncCallback,
InvocationConfig invocationConfig)
Returns commonly used information about the live versions of a virtual machine
template library item.
|
java.util.List<VersionsTypes.Summary> |
list(java.lang.String templateLibraryItem,
InvocationConfig invocationConfig)
Returns commonly used information about the live versions of a virtual machine
template library item.
|
java.lang.String |
rollback(java.lang.String templateLibraryItem,
java.lang.String version,
VersionsTypes.RollbackSpec spec)
Rollbacks a library item containing a virtual machine template to a previous
version.
|
void |
rollback(java.lang.String templateLibraryItem,
java.lang.String version,
VersionsTypes.RollbackSpec spec,
AsyncCallback<java.lang.String> asyncCallback)
Rollbacks a library item containing a virtual machine template to a previous
version.
|
void |
rollback(java.lang.String templateLibraryItem,
java.lang.String version,
VersionsTypes.RollbackSpec spec,
AsyncCallback<java.lang.String> asyncCallback,
InvocationConfig invocationConfig)
Rollbacks a library item containing a virtual machine template to a previous
version.
|
java.lang.String |
rollback(java.lang.String templateLibraryItem,
java.lang.String version,
VersionsTypes.RollbackSpec spec,
InvocationConfig invocationConfig)
Rollbacks a library item containing a virtual machine template to a previous
version.
|
java.util.List<VersionsTypes.Summary> list(java.lang.String templateLibraryItem)
Synchronous method overload. Result of the invocation will be reported as a method return value.
templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.NotFound
- if the library item is not found.InvalidArgument
- if the library item does not contain a virtual machine template.Unauthenticated
- if the user that requested the method cannot be authenticated.Unauthorized
- if the user that requested the method is not authorized to perform the method.Error
- if the system reports an error while responding to the request.Unauthorized
- if you do not have all of the privileges described as follows: System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires System.Read
. java.util.List<VersionsTypes.Summary> list(java.lang.String templateLibraryItem, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.invocationConfig
- Configuration for the method invocation.NotFound
- if the library item is not found.InvalidArgument
- if the library item does not contain a virtual machine template.Unauthenticated
- if the user that requested the method cannot be authenticated.Unauthorized
- if the user that requested the method is not authorized to perform the method.Error
- if the system reports an error while responding to the request.Unauthorized
- if you do not have all of the privileges described as follows: System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires System.Read
. void list(java.lang.String templateLibraryItem, AsyncCallback<java.util.List<VersionsTypes.Summary>> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
List of commonly used information about the library item versions.
Operation Errors:
NotFound
- if the library item is not found.
InvalidArgument
- if the library item does not contain a virtual machine template.
Unauthenticated
- if the user that requested the method cannot be authenticated.
Unauthorized
- if the user that requested the method is not authorized to perform the method.
Error
- if the system reports an error while responding to the request.
Unauthorized
- if you do not have all of the privileges described as follows:
System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires System.Read
. templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void list(java.lang.String templateLibraryItem, AsyncCallback<java.util.List<VersionsTypes.Summary>> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
List of commonly used information about the library item versions.
Operation Errors:
NotFound
- if the library item is not found.
InvalidArgument
- if the library item does not contain a virtual machine template.
Unauthenticated
- if the user that requested the method cannot be authenticated.
Unauthorized
- if the user that requested the method is not authorized to perform the method.
Error
- if the system reports an error while responding to the request.
Unauthorized
- if you do not have all of the privileges described as follows:
System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires System.Read
. templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.VersionsTypes.Info get(java.lang.String templateLibraryItem, java.lang.String version)
Synchronous method overload. Result of the invocation will be reported as a method return value.
templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.version
- Version of the library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version
.NotFound
- if the library item or version is not found.InvalidArgument
- if the library item does not contain a virtual machine template.Unauthenticated
- if the user that requested the method cannot be authenticated.Unauthorized
- if the user that requested the method is not authorized to perform the method.Error
- if the system reports an error while responding to the request.Unauthorized
- if you do not have all of the privileges described as follows: System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires System.Read
. com.vmware.content.library.item.Version
referenced by the parameter version
requires System.Read
. VersionsTypes.Info get(java.lang.String templateLibraryItem, java.lang.String version, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.version
- Version of the library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version
.invocationConfig
- Configuration for the method invocation.NotFound
- if the library item or version is not found.InvalidArgument
- if the library item does not contain a virtual machine template.Unauthenticated
- if the user that requested the method cannot be authenticated.Unauthorized
- if the user that requested the method is not authorized to perform the method.Error
- if the system reports an error while responding to the request.Unauthorized
- if you do not have all of the privileges described as follows: System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires System.Read
. com.vmware.content.library.item.Version
referenced by the parameter version
requires System.Read
. void get(java.lang.String templateLibraryItem, java.lang.String version, AsyncCallback<VersionsTypes.Info> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
Information about the specified library item version.
Operation Errors:
NotFound
- if the library item or version is not found.
InvalidArgument
- if the library item does not contain a virtual machine template.
Unauthenticated
- if the user that requested the method cannot be authenticated.
Unauthorized
- if the user that requested the method is not authorized to perform the method.
Error
- if the system reports an error while responding to the request.
Unauthorized
- if you do not have all of the privileges described as follows:
System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires System.Read
. com.vmware.content.library.item.Version
referenced by the parameter version
requires System.Read
. templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.version
- Version of the library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void get(java.lang.String templateLibraryItem, java.lang.String version, AsyncCallback<VersionsTypes.Info> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
Information about the specified library item version.
Operation Errors:
NotFound
- if the library item or version is not found.
InvalidArgument
- if the library item does not contain a virtual machine template.
Unauthenticated
- if the user that requested the method cannot be authenticated.
Unauthorized
- if the user that requested the method is not authorized to perform the method.
Error
- if the system reports an error while responding to the request.
Unauthorized
- if you do not have all of the privileges described as follows:
System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires System.Read
. com.vmware.content.library.item.Version
referenced by the parameter version
requires System.Read
. templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.version
- Version of the library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.java.lang.String rollback(java.lang.String templateLibraryItem, java.lang.String version, VersionsTypes.RollbackSpec spec)
Synchronous method overload. Result of the invocation will be reported as a method return value.
templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.version
- Version of the library item to rollback.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version
.spec
- Specification to rollback the library item.
This parameter is currently required. In the future, if this parameter is null
, the system will apply suitable defaults.com.vmware.content.library.item.Version
.NotFound
- if the library item or version is not found.InvalidArgument
- if the specified version is the latest version of the library item.InvalidArgument
- if the library item does not contain a virtual machine template.NotAllowedInCurrentState
- if a virtual machine is checked out of the library item.Unauthenticated
- if the user that requested the method cannot be authenticated.Unauthorized
- if the user that requested the method is not authorized to perform the method.Error
- if the system reports an error while responding to the request.Unauthorized
- if you do not have all of the privileges described as follows: System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires ContentLibrary.CheckInTemplate
. com.vmware.content.library.item.Version
referenced by the
parameter version
requires System.Read
. java.lang.String rollback(java.lang.String templateLibraryItem, java.lang.String version, VersionsTypes.RollbackSpec spec, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.version
- Version of the library item to rollback.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version
.spec
- Specification to rollback the library item.
This parameter is currently required. In the future, if this parameter is null
, the system will apply suitable defaults.invocationConfig
- Configuration for the method invocation.com.vmware.content.library.item.Version
.NotFound
- if the library item or version is not found.InvalidArgument
- if the specified version is the latest version of the library item.InvalidArgument
- if the library item does not contain a virtual machine template.NotAllowedInCurrentState
- if a virtual machine is checked out of the library item.Unauthenticated
- if the user that requested the method cannot be authenticated.Unauthorized
- if the user that requested the method is not authorized to perform the method.Error
- if the system reports an error while responding to the request.Unauthorized
- if you do not have all of the privileges described as follows: System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires ContentLibrary.CheckInTemplate
. com.vmware.content.library.item.Version
referenced by the
parameter version
requires System.Read
. void rollback(java.lang.String templateLibraryItem, java.lang.String version, VersionsTypes.RollbackSpec spec, AsyncCallback<java.lang.String> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
The new version of the library item.
The return value will be an identifier for the resource type: com.vmware.content.library.item.Version
.
Operation Errors:
NotFound
- if the library item or version is not found.
InvalidArgument
- if the specified version is the latest version of the library item.
InvalidArgument
- if the library item does not contain a virtual machine template.
NotAllowedInCurrentState
- if a virtual machine is checked out of the library item.
Unauthenticated
- if the user that requested the method cannot be authenticated.
Unauthorized
- if the user that requested the method is not authorized to perform the method.
Error
- if the system reports an error while responding to the request.
Unauthorized
- if you do not have all of the privileges described as follows:
System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires ContentLibrary.CheckInTemplate
. com.vmware.content.library.item.Version
referenced by the
parameter version
requires System.Read
. templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.version
- Version of the library item to rollback.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version
.spec
- Specification to rollback the library item.
This parameter is currently required. In the future, if this parameter is null
, the system will apply suitable defaults.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void rollback(java.lang.String templateLibraryItem, java.lang.String version, VersionsTypes.RollbackSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Invocation Result:
The new version of the library item.
The return value will be an identifier for the resource type: com.vmware.content.library.item.Version
.
Operation Errors:
NotFound
- if the library item or version is not found.
InvalidArgument
- if the specified version is the latest version of the library item.
InvalidArgument
- if the library item does not contain a virtual machine template.
NotAllowedInCurrentState
- if a virtual machine is checked out of the library item.
Unauthenticated
- if the user that requested the method cannot be authenticated.
Unauthorized
- if the user that requested the method is not authorized to perform the method.
Error
- if the system reports an error while responding to the request.
Unauthorized
- if you do not have all of the privileges described as follows:
System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires ContentLibrary.CheckInTemplate
. com.vmware.content.library.item.Version
referenced by the
parameter version
requires System.Read
. templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.version
- Version of the library item to rollback.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version
.spec
- Specification to rollback the library item.
This parameter is currently required. In the future, if this parameter is null
, the system will apply suitable defaults.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void delete(java.lang.String templateLibraryItem, java.lang.String version)
Synchronous method overload. Result of the invocation will be reported as a method return value.
templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.version
- Version of the library item to delete.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version
.NotFound
- if the library item or version is not found.InvalidArgument
- if the specified version is the latest version of the library item.InvalidArgument
- if the library item does not contain a virtual machine template.ResourceInaccessible
- if the virtual machine template's configuration state cannot be accessed.Unauthenticated
- if the user that requested the method cannot be authenticated.Unauthorized
- if the user that requested the method is not authorized to perform the method.Error
- if the system reports an error while responding to the request.Unauthorized
- if you do not have all of the privileges described as follows: System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires ContentLibrary.DeleteLibraryItem
.
com.vmware.content.library.item.Version
referenced by the parameter version
requires System.Read
.
void delete(java.lang.String templateLibraryItem, java.lang.String version, InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.version
- Version of the library item to delete.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version
.invocationConfig
- Configuration for the method invocation.NotFound
- if the library item or version is not found.InvalidArgument
- if the specified version is the latest version of the library item.InvalidArgument
- if the library item does not contain a virtual machine template.ResourceInaccessible
- if the virtual machine template's configuration state cannot be accessed.Unauthenticated
- if the user that requested the method cannot be authenticated.Unauthorized
- if the user that requested the method is not authorized to perform the method.Error
- if the system reports an error while responding to the request.Unauthorized
- if you do not have all of the privileges described as follows: System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires ContentLibrary.DeleteLibraryItem
.
com.vmware.content.library.item.Version
referenced by the parameter version
requires System.Read
.
void delete(java.lang.String templateLibraryItem, java.lang.String version, AsyncCallback<java.lang.Void> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
NotFound
- if the library item or version is not found.
InvalidArgument
- if the specified version is the latest version of the library item.
InvalidArgument
- if the library item does not contain a virtual machine template.
ResourceInaccessible
- if the virtual machine template's configuration state cannot be accessed.
Unauthenticated
- if the user that requested the method cannot be authenticated.
Unauthorized
- if the user that requested the method is not authorized to perform the method.
Error
- if the system reports an error while responding to the request.
Unauthorized
- if you do not have all of the privileges described as follows:
System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires ContentLibrary.DeleteLibraryItem
.
com.vmware.content.library.item.Version
referenced by the parameter version
requires System.Read
.
templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.version
- Version of the library item to delete.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void delete(java.lang.String templateLibraryItem, java.lang.String version, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Operation Errors:
NotFound
- if the library item or version is not found.
InvalidArgument
- if the specified version is the latest version of the library item.
InvalidArgument
- if the library item does not contain a virtual machine template.
ResourceInaccessible
- if the virtual machine template's configuration state cannot be accessed.
Unauthenticated
- if the user that requested the method cannot be authenticated.
Unauthorized
- if the user that requested the method is not authorized to perform the method.
Error
- if the system reports an error while responding to the request.
Unauthorized
- if you do not have all of the privileges described as follows:
System.Read
. com.vmware.content.library.Item
referenced by the parameter templateLibraryItem
requires ContentLibrary.DeleteLibraryItem
.
com.vmware.content.library.item.Version
referenced by the parameter version
requires System.Read
.
templateLibraryItem
- Identifier of the VM template library item.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.version
- Version of the library item to delete.
The parameter must be an identifier for the resource type: com.vmware.content.library.item.Version
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.