public interface Image extends Service, ImageTypes
This is an API that will let its client mount or unmount an ISO image on a virtual machine as a CD-ROM.
Modifier and Type | Method and Description |
---|---|
String |
mount(String libraryItem,
String vm)
Mounts an ISO image from a content library on a virtual machine.
|
void |
mount(String libraryItem,
String vm,
AsyncCallback<String> asyncCallback)
Mounts an ISO image from a content library on a virtual machine.
|
void |
mount(String libraryItem,
String vm,
AsyncCallback<String> asyncCallback,
InvocationConfig invocationConfig)
Mounts an ISO image from a content library on a virtual machine.
|
String |
mount(String libraryItem,
String vm,
InvocationConfig invocationConfig)
Mounts an ISO image from a content library on a virtual machine.
|
void |
unmount(String vm,
String cdrom)
Unmounts a previously mounted CD-ROM using an ISO image as a backing.
|
void |
unmount(String vm,
String cdrom,
AsyncCallback<Void> asyncCallback)
Unmounts a previously mounted CD-ROM using an ISO image as a backing.
|
void |
unmount(String vm,
String cdrom,
AsyncCallback<Void> asyncCallback,
InvocationConfig invocationConfig)
Unmounts a previously mounted CD-ROM using an ISO image as a backing.
|
void |
unmount(String vm,
String cdrom,
InvocationConfig invocationConfig)
Unmounts a previously mounted CD-ROM using an ISO image as a backing.
|
String mount(String libraryItem, String vm)
Synchronous method overload. Result of the invocation will be reported as a method return value.
libraryItem
- The identifier of the library item having the ISO image to mount on the virtual
machine.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.vm
- The identifier of the virtual machine where the specified ISO image will be
mounted.
The parameter must be an identifier for the resource type: VirtualMachine
.com.vmware.vcenter.vm.hardware.Cdrom
.NotFound
- If either vm
or the libraryItem
is not found.InvalidArgument
- If no .iso file is present on the library item.NotAllowedInCurrentState
- When the operation is not allowed on the virtual machine in its current state.String mount(String libraryItem, String vm, 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.
libraryItem
- The identifier of the library item having the ISO image to mount on the virtual
machine.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.vm
- The identifier of the virtual machine where the specified ISO image will be
mounted.
The parameter must be an identifier for the resource type: VirtualMachine
.invocationConfig
- Configuration for the method invocation.com.vmware.vcenter.vm.hardware.Cdrom
.NotFound
- If either vm
or the libraryItem
is not found.InvalidArgument
- If no .iso file is present on the library item.NotAllowedInCurrentState
- When the operation is not allowed on the virtual machine in its current state.void mount(String libraryItem, String vm, AsyncCallback<String> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Result:
The identifier of the newly created virtual CD-ROM backed by the specified ISO
image.
The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom
.
Operation Errors:
NotFound
- If either vm
or the libraryItem
is not found.
InvalidArgument
- If no .iso file is present on the library item.
NotAllowedInCurrentState
- When the operation is not allowed on the virtual machine in its current state.
libraryItem
- The identifier of the library item having the ISO image to mount on the virtual
machine.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.vm
- The identifier of the virtual machine where the specified ISO image will be
mounted.
The parameter must be an identifier for the resource type: VirtualMachine
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void mount(String libraryItem, String vm, AsyncCallback<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.
Operation Result:
The identifier of the newly created virtual CD-ROM backed by the specified ISO
image.
The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom
.
Operation Errors:
NotFound
- If either vm
or the libraryItem
is not found.
InvalidArgument
- If no .iso file is present on the library item.
NotAllowedInCurrentState
- When the operation is not allowed on the virtual machine in its current state.
libraryItem
- The identifier of the library item having the ISO image to mount on the virtual
machine.
The parameter must be an identifier for the resource type: com.vmware.content.library.Item
.vm
- The identifier of the virtual machine where the specified ISO image will be
mounted.
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.void unmount(String vm, String cdrom)
Synchronous method overload. Result of the invocation will be reported as a method return value.
vm
- The identifier of the virtual machine from which to unmount the virtual CD-ROM.
The parameter must be an identifier for the resource type: VirtualMachine
.cdrom
- The device identifier of the CD-ROM.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom
.NotFound
- If the virtual machine identified by vm
is not found or the cdrom
does not identify a virtual CD-ROM in the virtual machine.NotAllowedInCurrentState
- When the operation is not allowed on the virtual machine in its current state.void unmount(String vm, String cdrom, 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.
vm
- The identifier of the virtual machine from which to unmount the virtual CD-ROM.
The parameter must be an identifier for the resource type: VirtualMachine
.cdrom
- The device identifier of the CD-ROM.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom
.invocationConfig
- Configuration for the method invocation.NotFound
- If the virtual machine identified by vm
is not found or the cdrom
does not identify a virtual CD-ROM in the virtual machine.NotAllowedInCurrentState
- When the operation is not allowed on the virtual machine in its current state.void unmount(String vm, String cdrom, AsyncCallback<Void> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
NotFound
- If the virtual machine identified by vm
is not found or the cdrom
does not identify a virtual CD-ROM in the virtual machine.
NotAllowedInCurrentState
- When the operation is not allowed on the virtual machine in its current state.
vm
- The identifier of the virtual machine from which to unmount the virtual CD-ROM.
The parameter must be an identifier for the resource type: VirtualMachine
.cdrom
- The device identifier of the CD-ROM.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void unmount(String vm, String cdrom, AsyncCallback<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 virtual machine identified by vm
is not found or the cdrom
does not identify a virtual CD-ROM in the virtual machine.
NotAllowedInCurrentState
- When the operation is not allowed on the virtual machine in its current state.
vm
- The identifier of the virtual machine from which to unmount the virtual CD-ROM.
The parameter must be an identifier for the resource type: VirtualMachine
.cdrom
- The device identifier of the CD-ROM.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom
.asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.Copyright © 2016. All Rights Reserved.