com.vmware.vcenter.vm_template.library_items

Interface CheckOuts

All Superinterfaces:

CheckOutsTypes, Service

All Known Implementing Classes:

CheckOutsStub

public interface CheckOuts
extends Service, CheckOutsTypes

The CheckOuts interface provides methods for managing the checkouts of a library item containing a virtual machine template. This interface provides operations to check out a library item to update the virtual machine template, and to check in the library item when the virtual machine changes are complete. This interface was added in vSphere API 6.9.1.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm_template.library_items.CheckOutsTypes

CheckOutsTypes.CheckInSpec, CheckOutsTypes.CheckOutSpec, CheckOutsTypes.Info, CheckOutsTypes.PlacementSpec, CheckOutsTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.vm_template.library_items.CheckOutsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	checkIn(java.lang.String templateLibraryItem, java.lang.String vm, CheckOutsTypes.CheckInSpec spec) Checks in a virtual machine into the library item.
void	checkIn(java.lang.String templateLibraryItem, java.lang.String vm, CheckOutsTypes.CheckInSpec spec, AsyncCallback<java.lang.String> asyncCallback) Checks in a virtual machine into the library item.
void	checkIn(java.lang.String templateLibraryItem, java.lang.String vm, CheckOutsTypes.CheckInSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Checks in a virtual machine into the library item.
java.lang.String	checkIn(java.lang.String templateLibraryItem, java.lang.String vm, CheckOutsTypes.CheckInSpec spec, InvocationConfig invocationConfig) Checks in a virtual machine into the library item.
java.lang.String	checkOut(java.lang.String templateLibraryItem, CheckOutsTypes.CheckOutSpec spec) Checks out a library item containing a virtual machine template.
void	checkOut(java.lang.String templateLibraryItem, CheckOutsTypes.CheckOutSpec spec, AsyncCallback<java.lang.String> asyncCallback) Checks out a library item containing a virtual machine template.
void	checkOut(java.lang.String templateLibraryItem, CheckOutsTypes.CheckOutSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Checks out a library item containing a virtual machine template.
java.lang.String	checkOut(java.lang.String templateLibraryItem, CheckOutsTypes.CheckOutSpec spec, InvocationConfig invocationConfig) Checks out a library item containing a virtual machine template.
void	delete(java.lang.String templateLibraryItem, java.lang.String vm) Deletes the checked out virtual machine.
void	delete(java.lang.String templateLibraryItem, java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback) Deletes the checked out virtual machine.
void	delete(java.lang.String templateLibraryItem, java.lang.String vm, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Deletes the checked out virtual machine.
void	delete(java.lang.String templateLibraryItem, java.lang.String vm, InvocationConfig invocationConfig) Deletes the checked out virtual machine.
CheckOutsTypes.Info	get(java.lang.String templateLibraryItem, java.lang.String vm) Returns the information about a checked out virtual machine.
void	get(java.lang.String templateLibraryItem, java.lang.String vm, AsyncCallback<CheckOutsTypes.Info> asyncCallback) Returns the information about a checked out virtual machine.
void	get(java.lang.String templateLibraryItem, java.lang.String vm, AsyncCallback<CheckOutsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the information about a checked out virtual machine.
CheckOutsTypes.Info	get(java.lang.String templateLibraryItem, java.lang.String vm, InvocationConfig invocationConfig) Returns the information about a checked out virtual machine.
java.util.List<CheckOutsTypes.Summary>	list(java.lang.String templateLibraryItem) Returns commonly used information about the virtual machines that are checked out of the library item.
void	list(java.lang.String templateLibraryItem, AsyncCallback<java.util.List<CheckOutsTypes.Summary>> asyncCallback) Returns commonly used information about the virtual machines that are checked out of the library item.
void	list(java.lang.String templateLibraryItem, AsyncCallback<java.util.List<CheckOutsTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns commonly used information about the virtual machines that are checked out of the library item.
java.util.List<CheckOutsTypes.Summary>	list(java.lang.String templateLibraryItem, InvocationConfig invocationConfig) Returns commonly used information about the virtual machines that are checked out of the library item.

Method Detail

checkOut

java.lang.String checkOut(java.lang.String templateLibraryItem,
                          CheckOutsTypes.CheckOutSpec spec)

Checks out a library item containing a virtual machine template. This method makes a copy of the source virtual machine template contained in the library item as a virtual machine. The virtual machine is copied with the same storage specification as the source virtual machine template. Changes to the checked out virtual machine do not affect the virtual machine template contained in the library item. To save these changes back into the library item, checkIn(java.lang.String, java.lang.String, com.vmware.vcenter.vm_template.library_items.CheckOutsTypes.CheckInSpec) the virtual machine. To discard the changes, delete(java.lang.String, java.lang.String) the virtual machine. This method was added in vSphere API 6.9.1.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

templateLibraryItem - Identifier of the content library item containing the source virtual machine template to be checked out. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

spec - Specification used to check out the source virtual machine template as a virtual machine. This parameter is currently required. In the future, if this parameter is null, the system will apply suitable defaults.

Returns:

Identifier of the virtual machine that was checked out of the library item. The return value will be an identifier for the resource type: VirtualMachine.

Throws:

AlreadyExists - if a virtual machine with the name specified by CheckOutsTypes.CheckOutSpec.getName() already exists in the folder specified by CheckOutsTypes.PlacementSpec.getFolder().

InvalidArgument - if spec contains invalid arguments.

InvalidArgument - if the library item is a member of a subscribed library.

NotFound - if the library item specified by templateLibraryItem cannot be found.

ResourceInaccessible - if there is an error accessing the files of the source virtual machine template contained in the library item specified by templateLibraryItem.

UnableToAllocateResource - if the limit for the number of virtual machines checked out of a library item (currently 1) has been exceeded.

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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckOutTemplate.
• The resource Folder referenced by the property CheckOutsTypes.PlacementSpec.getFolder() requires System.Read.
• The resource ResourcePool referenced by the property CheckOutsTypes.PlacementSpec.getResourcePool() requires System.Read.
• The resource HostSystem referenced by the property CheckOutsTypes.PlacementSpec.getHost() requires System.Read.
• The resource ClusterComputeResource referenced by the property CheckOutsTypes.PlacementSpec.getCluster() requires System.Read.

checkOut

java.lang.String checkOut(java.lang.String templateLibraryItem,
                          CheckOutsTypes.CheckOutSpec spec,
                          InvocationConfig invocationConfig)

Checks out a library item containing a virtual machine template. This method makes a copy of the source virtual machine template contained in the library item as a virtual machine. The virtual machine is copied with the same storage specification as the source virtual machine template. Changes to the checked out virtual machine do not affect the virtual machine template contained in the library item. To save these changes back into the library item, checkIn(java.lang.String, java.lang.String, com.vmware.vcenter.vm_template.library_items.CheckOutsTypes.CheckInSpec) the virtual machine. To discard the changes, delete(java.lang.String, java.lang.String) the virtual machine. This method was added in vSphere API 6.9.1.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

templateLibraryItem - Identifier of the content library item containing the source virtual machine template to be checked out. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

spec - Specification used to check out the source virtual machine template as a virtual machine. 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.

Returns:

Identifier of the virtual machine that was checked out of the library item. The return value will be an identifier for the resource type: VirtualMachine.

Throws:

AlreadyExists - if a virtual machine with the name specified by CheckOutsTypes.CheckOutSpec.getName() already exists in the folder specified by CheckOutsTypes.PlacementSpec.getFolder().

InvalidArgument - if spec contains invalid arguments.

InvalidArgument - if the library item is a member of a subscribed library.

NotFound - if the library item specified by templateLibraryItem cannot be found.

ResourceInaccessible - if there is an error accessing the files of the source virtual machine template contained in the library item specified by templateLibraryItem.

UnableToAllocateResource - if the limit for the number of virtual machines checked out of a library item (currently 1) has been exceeded.

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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckOutTemplate.
• The resource Folder referenced by the property CheckOutsTypes.PlacementSpec.getFolder() requires System.Read.
• The resource ResourcePool referenced by the property CheckOutsTypes.PlacementSpec.getResourcePool() requires System.Read.
• The resource HostSystem referenced by the property CheckOutsTypes.PlacementSpec.getHost() requires System.Read.
• The resource ClusterComputeResource referenced by the property CheckOutsTypes.PlacementSpec.getCluster() requires System.Read.

checkOut

void checkOut(java.lang.String templateLibraryItem,
              CheckOutsTypes.CheckOutSpec spec,
              AsyncCallback<java.lang.String> asyncCallback)

Checks out a library item containing a virtual machine template. This method makes a copy of the source virtual machine template contained in the library item as a virtual machine. The virtual machine is copied with the same storage specification as the source virtual machine template. Changes to the checked out virtual machine do not affect the virtual machine template contained in the library item. To save these changes back into the library item, checkIn(java.lang.String, java.lang.String, com.vmware.vcenter.vm_template.library_items.CheckOutsTypes.CheckInSpec) the virtual machine. To discard the changes, delete(java.lang.String, java.lang.String) the virtual machine. This method was added in vSphere API 6.9.1.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Identifier of the virtual machine that was checked out of the library item. The return value will be an identifier for the resource type: VirtualMachine.

Operation Errors:
AlreadyExists - if a virtual machine with the name specified by CheckOutsTypes.CheckOutSpec.getName() already exists in the folder specified by CheckOutsTypes.PlacementSpec.getFolder().
InvalidArgument - if spec contains invalid arguments.
InvalidArgument - if the library item is a member of a subscribed library.
NotFound - if the library item specified by templateLibraryItem cannot be found.
ResourceInaccessible - if there is an error accessing the files of the source virtual machine template contained in the library item specified by templateLibraryItem.
UnableToAllocateResource - if the limit for the number of virtual machines checked out of a library item (currently 1) has been exceeded.
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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckOutTemplate.
• The resource Folder referenced by the property CheckOutsTypes.PlacementSpec.getFolder() requires System.Read.
• The resource ResourcePool referenced by the property CheckOutsTypes.PlacementSpec.getResourcePool() requires System.Read.
• The resource HostSystem referenced by the property CheckOutsTypes.PlacementSpec.getHost() requires System.Read.
• The resource ClusterComputeResource referenced by the property CheckOutsTypes.PlacementSpec.getCluster() requires System.Read.

Parameters:

templateLibraryItem - Identifier of the content library item containing the source virtual machine template to be checked out. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

spec - Specification used to check out the source virtual machine template as a virtual machine. 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.

checkOut

void checkOut(java.lang.String templateLibraryItem,
              CheckOutsTypes.CheckOutSpec spec,
              AsyncCallback<java.lang.String> asyncCallback,
              InvocationConfig invocationConfig)

Checks out a library item containing a virtual machine template. This method makes a copy of the source virtual machine template contained in the library item as a virtual machine. The virtual machine is copied with the same storage specification as the source virtual machine template. Changes to the checked out virtual machine do not affect the virtual machine template contained in the library item. To save these changes back into the library item, checkIn(java.lang.String, java.lang.String, com.vmware.vcenter.vm_template.library_items.CheckOutsTypes.CheckInSpec) the virtual machine. To discard the changes, delete(java.lang.String, java.lang.String) the virtual machine. This method was added in vSphere API 6.9.1.

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:
Identifier of the virtual machine that was checked out of the library item. The return value will be an identifier for the resource type: VirtualMachine.

Operation Errors:
AlreadyExists - if a virtual machine with the name specified by CheckOutsTypes.CheckOutSpec.getName() already exists in the folder specified by CheckOutsTypes.PlacementSpec.getFolder().
InvalidArgument - if spec contains invalid arguments.
InvalidArgument - if the library item is a member of a subscribed library.
NotFound - if the library item specified by templateLibraryItem cannot be found.
ResourceInaccessible - if there is an error accessing the files of the source virtual machine template contained in the library item specified by templateLibraryItem.
UnableToAllocateResource - if the limit for the number of virtual machines checked out of a library item (currently 1) has been exceeded.
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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckOutTemplate.
• The resource Folder referenced by the property CheckOutsTypes.PlacementSpec.getFolder() requires System.Read.
• The resource ResourcePool referenced by the property CheckOutsTypes.PlacementSpec.getResourcePool() requires System.Read.
• The resource HostSystem referenced by the property CheckOutsTypes.PlacementSpec.getHost() requires System.Read.
• The resource ClusterComputeResource referenced by the property CheckOutsTypes.PlacementSpec.getCluster() requires System.Read.

Parameters:

templateLibraryItem - Identifier of the content library item containing the source virtual machine template to be checked out. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

spec - Specification used to check out the source virtual machine template as a virtual machine. 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.

checkIn

java.lang.String checkIn(java.lang.String templateLibraryItem,
                         java.lang.String vm,
                         CheckOutsTypes.CheckInSpec spec)

Checks in a virtual machine into the library item. This method updates the library item to contain the virtual machine being checked in as a template. This template becomes the latest version of the library item. The previous virtual machine template contained in the library item is available as a backup and its information can be queried using the Versions interface. At most one previous version of a virtual machine template is retained in the library item. This method was added in vSphere API 6.9.1.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

templateLibraryItem - Identifier of the content library item in which the virtual machine is checked in. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

vm - Identifier of the virtual machine to check into the library item. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification used to check in the virtual machine into the library item. This parameter is currently required. In the future, if this parameter is null, the system will apply suitable defaults.

Returns:

The new version of the library item. The return value will be an identifier for the resource type: com.vmware.content.library.item.Version.

Throws:

InvalidArgument - if any of the specified parameters are invalid.

InvalidArgument - if the virtual machine identified by vm was not checked out of the item specified by templateLibraryItem.

NotAllowedInCurrentState - if the method cannot be performed because of the virtual machine's current state. For example, if the virtual machine is not powered off.

NotFound - if the item specified by templateLibraryItem does not exist.

NotFound - if the virtual machine specified by vm does not exist.

ResourceInaccessible - if there is an error accessing a file from the virtual machine.

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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckInTemplate.
• The resource VirtualMachine referenced by the parameter vm requires System.Read.

checkIn

java.lang.String checkIn(java.lang.String templateLibraryItem,
                         java.lang.String vm,
                         CheckOutsTypes.CheckInSpec spec,
                         InvocationConfig invocationConfig)

Checks in a virtual machine into the library item. This method updates the library item to contain the virtual machine being checked in as a template. This template becomes the latest version of the library item. The previous virtual machine template contained in the library item is available as a backup and its information can be queried using the Versions interface. At most one previous version of a virtual machine template is retained in the library item. This method was added in vSphere API 6.9.1.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

templateLibraryItem - Identifier of the content library item in which the virtual machine is checked in. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

vm - Identifier of the virtual machine to check into the library item. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification used to check in the virtual machine into 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.

Returns:

The new version of the library item. The return value will be an identifier for the resource type: com.vmware.content.library.item.Version.

Throws:

InvalidArgument - if any of the specified parameters are invalid.

InvalidArgument - if the virtual machine identified by vm was not checked out of the item specified by templateLibraryItem.

NotAllowedInCurrentState - if the method cannot be performed because of the virtual machine's current state. For example, if the virtual machine is not powered off.

NotFound - if the item specified by templateLibraryItem does not exist.

NotFound - if the virtual machine specified by vm does not exist.

ResourceInaccessible - if there is an error accessing a file from the virtual machine.

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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckInTemplate.
• The resource VirtualMachine referenced by the parameter vm requires System.Read.

checkIn

void checkIn(java.lang.String templateLibraryItem,
             java.lang.String vm,
             CheckOutsTypes.CheckInSpec spec,
             AsyncCallback<java.lang.String> asyncCallback)

Checks in a virtual machine into the library item. This method updates the library item to contain the virtual machine being checked in as a template. This template becomes the latest version of the library item. The previous virtual machine template contained in the library item is available as a backup and its information can be queried using the Versions interface. At most one previous version of a virtual machine template is retained in the library item. This method was added in vSphere API 6.9.1.

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:
InvalidArgument - if any of the specified parameters are invalid.
InvalidArgument - if the virtual machine identified by vm was not checked out of the item specified by templateLibraryItem.
NotAllowedInCurrentState - if the method cannot be performed because of the virtual machine's current state. For example, if the virtual machine is not powered off.
NotFound - if the item specified by templateLibraryItem does not exist.
NotFound - if the virtual machine specified by vm does not exist.
ResourceInaccessible - if there is an error accessing a file from the virtual machine.
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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckInTemplate.
• The resource VirtualMachine referenced by the parameter vm requires System.Read.

Parameters:

templateLibraryItem - Identifier of the content library item in which the virtual machine is checked in. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

vm - Identifier of the virtual machine to check into the library item. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification used to check in the virtual machine into 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.

checkIn

void checkIn(java.lang.String templateLibraryItem,
             java.lang.String vm,
             CheckOutsTypes.CheckInSpec spec,
             AsyncCallback<java.lang.String> asyncCallback,
             InvocationConfig invocationConfig)

Checks in a virtual machine into the library item. This method updates the library item to contain the virtual machine being checked in as a template. This template becomes the latest version of the library item. The previous virtual machine template contained in the library item is available as a backup and its information can be queried using the Versions interface. At most one previous version of a virtual machine template is retained in the library item. This method was added in vSphere API 6.9.1.

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:
InvalidArgument - if any of the specified parameters are invalid.
InvalidArgument - if the virtual machine identified by vm was not checked out of the item specified by templateLibraryItem.
NotAllowedInCurrentState - if the method cannot be performed because of the virtual machine's current state. For example, if the virtual machine is not powered off.
NotFound - if the item specified by templateLibraryItem does not exist.
NotFound - if the virtual machine specified by vm does not exist.
ResourceInaccessible - if there is an error accessing a file from the virtual machine.
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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires ContentLibrary.CheckInTemplate.
• The resource VirtualMachine referenced by the parameter vm requires System.Read.

Parameters:

templateLibraryItem - Identifier of the content library item in which the virtual machine is checked in. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

vm - Identifier of the virtual machine to check into the library item. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification used to check in the virtual machine into 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.

list

java.util.List<CheckOutsTypes.Summary> list(java.lang.String templateLibraryItem)

Returns commonly used information about the virtual machines that are checked out of the library item. This method was added in vSphere API 6.9.1.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

templateLibraryItem - Identifier of the VM template library item. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

Returns:

List of commonly used information about the check outs.

Throws:

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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.

list

java.util.List<CheckOutsTypes.Summary> list(java.lang.String templateLibraryItem,
                                            InvocationConfig invocationConfig)

Returns commonly used information about the virtual machines that are checked out of the library item. This method was added in vSphere API 6.9.1.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

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.

Returns:

List of commonly used information about the check outs.

Throws:

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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.

list

void list(java.lang.String templateLibraryItem,
          AsyncCallback<java.util.List<CheckOutsTypes.Summary>> asyncCallback)

Returns commonly used information about the virtual machines that are checked out of the library item. This method was added in vSphere API 6.9.1.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
List of commonly used information about the check outs.

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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.

Parameters:

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.

list

void list(java.lang.String templateLibraryItem,
          AsyncCallback<java.util.List<CheckOutsTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns commonly used information about the virtual machines that are checked out of the library item. This method was added in vSphere API 6.9.1.

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 check outs.

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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.

Parameters:

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.

get

CheckOutsTypes.Info get(java.lang.String templateLibraryItem,
                        java.lang.String vm)

Returns the information about a checked out virtual machine. This method was added in vSphere API 6.9.1.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

templateLibraryItem - Identifier of the VM template library item. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

vm - Identifier of the checked out virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

Returns:

Information about a check out.

Throws:

NotFound - if the library item or virtual machine is not found.

InvalidArgument - if the virtual machine is not checked out of the library item.

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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
• The resource VirtualMachine referenced by the parameter vm requires System.Read.

get

CheckOutsTypes.Info get(java.lang.String templateLibraryItem,
                        java.lang.String vm,
                        InvocationConfig invocationConfig)

Returns the information about a checked out virtual machine. This method was added in vSphere API 6.9.1.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

templateLibraryItem - Identifier of the VM template library item. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

vm - Identifier of the checked out virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Returns:

Information about a check out.

Throws:

NotFound - if the library item or virtual machine is not found.

InvalidArgument - if the virtual machine is not checked out of the library item.

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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
• The resource VirtualMachine referenced by the parameter vm requires System.Read.

get

void get(java.lang.String templateLibraryItem,
         java.lang.String vm,
         AsyncCallback<CheckOutsTypes.Info> asyncCallback)

Returns the information about a checked out virtual machine. This method was added in vSphere API 6.9.1.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
Information about a check out.

Operation Errors:
NotFound - if the library item or virtual machine is not found.
InvalidArgument - if the virtual machine is not checked out of the library item.
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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
• The resource VirtualMachine referenced by the parameter vm requires System.Read.

Parameters:

templateLibraryItem - Identifier of the VM template library item. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

vm - Identifier of the checked out virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String templateLibraryItem,
         java.lang.String vm,
         AsyncCallback<CheckOutsTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns the information about a checked out virtual machine. This method was added in vSphere API 6.9.1.

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 a check out.

Operation Errors:
NotFound - if the library item or virtual machine is not found.
InvalidArgument - if the virtual machine is not checked out of the library item.
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:

• Method execution requires System.Read.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.
• The resource VirtualMachine referenced by the parameter vm requires System.Read.

Parameters:

templateLibraryItem - Identifier of the VM template library item. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

vm - Identifier of the checked out virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String templateLibraryItem,
            java.lang.String vm)

Deletes the checked out virtual machine. This method was added in vSphere API 6.9.1.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

templateLibraryItem - Identifier of the VM template library item. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

vm - Identifier of the checked out virtual machine to delete. The parameter must be an identifier for the resource type: VirtualMachine.

Throws:

NotFound - if the library item or virtual machine is not found.

InvalidArgument - if the virtual machine is not checked out of the library item.

NotAllowedInCurrentState - if the virtual machine is running (powered on).

ResourceBusy - if the virtual machine is busy performing another operation.

ResourceInaccessible - if the virtual machine'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:

• Method execution requires System.Read.
• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.

delete

void delete(java.lang.String templateLibraryItem,
            java.lang.String vm,
            InvocationConfig invocationConfig)

Deletes the checked out virtual machine. This method was added in vSphere API 6.9.1.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

templateLibraryItem - Identifier of the VM template library item. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

vm - Identifier of the checked out virtual machine to delete. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Throws:

NotFound - if the library item or virtual machine is not found.

InvalidArgument - if the virtual machine is not checked out of the library item.

NotAllowedInCurrentState - if the virtual machine is running (powered on).

ResourceBusy - if the virtual machine is busy performing another operation.

ResourceInaccessible - if the virtual machine'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:

• Method execution requires System.Read.
• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.

delete

void delete(java.lang.String templateLibraryItem,
            java.lang.String vm,
            AsyncCallback<java.lang.Void> asyncCallback)

Deletes the checked out virtual machine. This method was added in vSphere API 6.9.1.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
NotFound - if the library item or virtual machine is not found.
InvalidArgument - if the virtual machine is not checked out of the library item.
NotAllowedInCurrentState - if the virtual machine is running (powered on).
ResourceBusy - if the virtual machine is busy performing another operation.
ResourceInaccessible - if the virtual machine'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:

• Method execution requires System.Read.
• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.

Parameters:

templateLibraryItem - Identifier of the VM template library item. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

vm - Identifier of the checked out virtual machine to delete. The parameter must be an identifier for the resource type: VirtualMachine.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

delete

void delete(java.lang.String templateLibraryItem,
            java.lang.String vm,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Deletes the checked out virtual machine. This method was added in vSphere API 6.9.1.

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 virtual machine is not found.
InvalidArgument - if the virtual machine is not checked out of the library item.
NotAllowedInCurrentState - if the virtual machine is running (powered on).
ResourceBusy - if the virtual machine is busy performing another operation.
ResourceInaccessible - if the virtual machine'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:

• Method execution requires System.Read.
• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Inventory.Delete.
• The resource com.vmware.content.library.Item referenced by the parameter templateLibraryItem requires System.Read.

Parameters:

templateLibraryItem - Identifier of the VM template library item. The parameter must be an identifier for the resource type: com.vmware.content.library.Item.

vm - Identifier of the checked out virtual machine to delete. The parameter must be an identifier for the resource type: VirtualMachine.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.