com.vmware.vcenter.vm.hardware

Interface Boot

All Superinterfaces:

BootTypes, Service

All Known Implementing Classes:

BootStub

public interface Boot
extends Service, BootTypes

The Boot interface provides methods for configuring the settings used when booting a virtual machine.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm.hardware.BootTypes

BootTypes.CreateSpec, BootTypes.Info, BootTypes.NetworkProtocol, BootTypes.Type, BootTypes.UpdateSpec

Method Summary

Methods

Modifier and Type	Method and Description
BootTypes.Info	get(String vm) Returns the boot-related settings of a virtual machine.
void	get(String vm, AsyncCallback<BootTypes.Info> asyncCallback) Returns the boot-related settings of a virtual machine.
void	get(String vm, AsyncCallback<BootTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the boot-related settings of a virtual machine.
BootTypes.Info	get(String vm, InvocationConfig invocationConfig) Returns the boot-related settings of a virtual machine.
void	update(String vm, BootTypes.UpdateSpec spec) Updates the boot-related settings of a virtual machine.
void	update(String vm, BootTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback) Updates the boot-related settings of a virtual machine.
void	update(String vm, BootTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Updates the boot-related settings of a virtual machine.
void	update(String vm, BootTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the boot-related settings of a virtual machine.

Method Detail

get

BootTypes.Info get(String vm)

Returns the boot-related settings of a virtual machine.

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

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

Returns:

Boot-related settings of the virtual machine.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

get

BootTypes.Info get(String vm,
                 InvocationConfig invocationConfig)

Returns the boot-related settings of a virtual machine.

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:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Returns:

Boot-related settings of the virtual machine.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

get

void get(String vm,
       AsyncCallback<BootTypes.Info> asyncCallback)

Returns the boot-related settings of a virtual machine.

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

Operation Result:
Boot-related settings of the virtual machine.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

vm - Virtual machine identifier. 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(String vm,
       AsyncCallback<BootTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Returns the boot-related settings of a virtual machine.

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:
Boot-related settings of the virtual machine.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

vm - Virtual machine identifier. 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.

update

void update(String vm,
          BootTypes.UpdateSpec spec)

Updates the boot-related settings of a virtual machine.

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

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification for updating the boot-related settings of the virtual machine.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

InvalidArgument - if one of the provided settings is not permitted; for example, specifying a negative value for getDelay().

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

ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

update

void update(String vm,
          BootTypes.UpdateSpec spec,
          InvocationConfig invocationConfig)

Updates the boot-related settings of a virtual machine.

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:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification for updating the boot-related settings of the virtual machine.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

InvalidArgument - if one of the provided settings is not permitted; for example, specifying a negative value for getDelay().

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

ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

update

void update(String vm,
          BootTypes.UpdateSpec spec,
          AsyncCallback<Void> asyncCallback)

Updates the boot-related settings of a virtual machine.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
InvalidArgument - if one of the provided settings is not permitted; for example, specifying a negative value for getDelay().
ResourceBusy - if the virtual machine is busy performing another operation.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification for updating the boot-related settings of the virtual machine.

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

update

void update(String vm,
          BootTypes.UpdateSpec spec,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Updates the boot-related settings of a virtual machine.

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:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
InvalidArgument - if one of the provided settings is not permitted; for example, specifying a negative value for getDelay().
ResourceBusy - if the virtual machine is busy performing another operation.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

spec - Specification for updating the boot-related settings of the virtual machine.

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

invocationConfig - Configuration for the method invocation.