public class ImageStub extends com.vmware.vapi.internal.bindings.Stub implements Image
Image
API service.
WARNING: Internal API, subject to change in future versions.
Constructor and Description |
---|
ImageStub(ApiProvider apiProvider,
StubConfigurationBase config) |
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.
|
public ImageStub(ApiProvider apiProvider, StubConfigurationBase config)
public String mount(String libraryItem, String vm)
Image
Synchronous method overload. Result of the invocation will be reported as a method return value.
mount
in interface Image
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
.public String mount(String libraryItem, String vm, InvocationConfig invocationConfig)
Image
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
mount
in interface Image
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
.public void mount(String libraryItem, String vm, AsyncCallback<String> asyncCallback)
Image
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.
mount
in interface Image
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.public void mount(String libraryItem, String vm, AsyncCallback<String> asyncCallback, InvocationConfig invocationConfig)
Image
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.
mount
in interface Image
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.public void unmount(String vm, String cdrom)
Image
Synchronous method overload. Result of the invocation will be reported as a method return value.
unmount
in interface Image
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
.public void unmount(String vm, String cdrom, InvocationConfig invocationConfig)
Image
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
unmount
in interface Image
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.public void unmount(String vm, String cdrom, AsyncCallback<Void> asyncCallback)
Image
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.
unmount
in interface Image
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.public void unmount(String vm, String cdrom, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig)
Image
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.
unmount
in interface Image
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.