com.vmware.vcenter.vm.hardware

Interface Serial

All Superinterfaces:

SerialTypes, Service

All Known Implementing Classes:

SerialStub

public interface Serial
extends Service, SerialTypes

The Serial interface provides methods for configuring the virtual serial ports of a virtual machine.

Nested Class Summary

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

SerialTypes.BackingInfo, SerialTypes.BackingSpec, SerialTypes.BackingType, SerialTypes.CreateSpec, SerialTypes.Info, SerialTypes.Summary, SerialTypes.UpdateSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.vm.hardware.SerialTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
void	connect(java.lang.String vm, java.lang.String port) Connects a virtual serial port of a powered-on virtual machine to its backing.
void	connect(java.lang.String vm, java.lang.String port, AsyncCallback<java.lang.Void> asyncCallback) Connects a virtual serial port of a powered-on virtual machine to its backing.
void	connect(java.lang.String vm, java.lang.String port, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Connects a virtual serial port of a powered-on virtual machine to its backing.
void	connect(java.lang.String vm, java.lang.String port, InvocationConfig invocationConfig) Connects a virtual serial port of a powered-on virtual machine to its backing.
java.lang.String	create(java.lang.String vm, SerialTypes.CreateSpec spec) Adds a virtual serial port to the virtual machine.
void	create(java.lang.String vm, SerialTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Adds a virtual serial port to the virtual machine.
void	create(java.lang.String vm, SerialTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Adds a virtual serial port to the virtual machine.
java.lang.String	create(java.lang.String vm, SerialTypes.CreateSpec spec, InvocationConfig invocationConfig) Adds a virtual serial port to the virtual machine.
void	delete(java.lang.String vm, java.lang.String port) Removes a virtual serial port from the virtual machine.
void	delete(java.lang.String vm, java.lang.String port, AsyncCallback<java.lang.Void> asyncCallback) Removes a virtual serial port from the virtual machine.
void	delete(java.lang.String vm, java.lang.String port, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Removes a virtual serial port from the virtual machine.
void	delete(java.lang.String vm, java.lang.String port, InvocationConfig invocationConfig) Removes a virtual serial port from the virtual machine.
void	disconnect(java.lang.String vm, java.lang.String port) Disconnects a virtual serial port of a powered-on virtual machine from its backing.
void	disconnect(java.lang.String vm, java.lang.String port, AsyncCallback<java.lang.Void> asyncCallback) Disconnects a virtual serial port of a powered-on virtual machine from its backing.
void	disconnect(java.lang.String vm, java.lang.String port, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Disconnects a virtual serial port of a powered-on virtual machine from its backing.
void	disconnect(java.lang.String vm, java.lang.String port, InvocationConfig invocationConfig) Disconnects a virtual serial port of a powered-on virtual machine from its backing.
SerialTypes.Info	get(java.lang.String vm, java.lang.String port) Returns information about a virtual serial port.
void	get(java.lang.String vm, java.lang.String port, AsyncCallback<SerialTypes.Info> asyncCallback) Returns information about a virtual serial port.
void	get(java.lang.String vm, java.lang.String port, AsyncCallback<SerialTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a virtual serial port.
SerialTypes.Info	get(java.lang.String vm, java.lang.String port, InvocationConfig invocationConfig) Returns information about a virtual serial port.
java.util.List<SerialTypes.Summary>	list(java.lang.String vm) Returns commonly used information about the virtual serial ports belonging to the virtual machine.
void	list(java.lang.String vm, AsyncCallback<java.util.List<SerialTypes.Summary>> asyncCallback) Returns commonly used information about the virtual serial ports belonging to the virtual machine.
void	list(java.lang.String vm, AsyncCallback<java.util.List<SerialTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns commonly used information about the virtual serial ports belonging to the virtual machine.
java.util.List<SerialTypes.Summary>	list(java.lang.String vm, InvocationConfig invocationConfig) Returns commonly used information about the virtual serial ports belonging to the virtual machine.
void	update(java.lang.String vm, java.lang.String port, SerialTypes.UpdateSpec spec) Updates the configuration of a virtual serial port.
void	update(java.lang.String vm, java.lang.String port, SerialTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Updates the configuration of a virtual serial port.
void	update(java.lang.String vm, java.lang.String port, SerialTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Updates the configuration of a virtual serial port.
void	update(java.lang.String vm, java.lang.String port, SerialTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the configuration of a virtual serial port.

Method Detail

list

java.util.List<SerialTypes.Summary> list(java.lang.String vm)

Returns commonly used information about the virtual serial ports belonging to the 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:

List of commonly used information about virtual serial ports.

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.

list

java.util.List<SerialTypes.Summary> list(java.lang.String vm,
                                         InvocationConfig invocationConfig)

Returns commonly used information about the virtual serial ports belonging to the 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:

List of commonly used information about virtual serial ports.

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.

list

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

Returns commonly used information about the virtual serial ports belonging to the virtual machine.

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

Invocation Result:
List of commonly used information about virtual serial ports.

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.

list

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

Returns commonly used information about the virtual serial ports belonging to the 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.

Invocation Result:
List of commonly used information about virtual serial ports.

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.

get

SerialTypes.Info get(java.lang.String vm,
                     java.lang.String port)

Returns information about a virtual serial port.

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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Returns:

Information about the specified virtual serial port.

Throws:

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

NotFound - if the virtual machine or virtual serial port 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

SerialTypes.Info get(java.lang.String vm,
                     java.lang.String port,
                     InvocationConfig invocationConfig)

Returns information about a virtual serial port.

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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the specified virtual serial port.

Throws:

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

NotFound - if the virtual machine or virtual serial port 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(java.lang.String vm,
         java.lang.String port,
         AsyncCallback<SerialTypes.Info> asyncCallback)

Returns information about a virtual serial port.

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

Invocation Result:
Information about the specified virtual serial port.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine or virtual serial port 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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

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

get

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

Returns information about a virtual serial port.

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 virtual serial port.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine or virtual serial port 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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

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

invocationConfig - Configuration for the method invocation.

create

java.lang.String create(java.lang.String vm,
                        SerialTypes.CreateSpec spec)

Adds a virtual serial port to the 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 the new virtual serial port.

Returns:

Virtual serial port identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Throws:

Error - if the system reported that the serial port device was created but was unable to confirm the creation because the identifier of the new device could not be determined.

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

NotFound - if the virtual machine is not found.

NotAllowedInCurrentState - if the virtual machine is not powered off.

UnableToAllocateResource - if the virtual machine already has the maximum number of supported serial ports.

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.

create

java.lang.String create(java.lang.String vm,
                        SerialTypes.CreateSpec spec,
                        InvocationConfig invocationConfig)

Adds a virtual serial port to the 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 the new virtual serial port.

invocationConfig - Configuration for the method invocation.

Returns:

Virtual serial port identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Throws:

Error - if the system reported that the serial port device was created but was unable to confirm the creation because the identifier of the new device could not be determined.

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

NotFound - if the virtual machine is not found.

NotAllowedInCurrentState - if the virtual machine is not powered off.

UnableToAllocateResource - if the virtual machine already has the maximum number of supported serial ports.

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.

create

void create(java.lang.String vm,
            SerialTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback)

Adds a virtual serial port to the virtual machine.

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

Invocation Result:
Virtual serial port identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Operation Errors:
Error - if the system reported that the serial port device was created but was unable to confirm the creation because the identifier of the new device could not be determined.
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
NotAllowedInCurrentState - if the virtual machine is not powered off.
UnableToAllocateResource - if the virtual machine already has the maximum number of supported serial ports.
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 the new virtual serial port.

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

create

void create(java.lang.String vm,
            SerialTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Adds a virtual serial port to the 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.

Invocation Result:
Virtual serial port identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Operation Errors:
Error - if the system reported that the serial port device was created but was unable to confirm the creation because the identifier of the new device could not be determined.
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
NotAllowedInCurrentState - if the virtual machine is not powered off.
UnableToAllocateResource - if the virtual machine already has the maximum number of supported serial ports.
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 the new virtual serial port.

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String vm,
            java.lang.String port,
            SerialTypes.UpdateSpec spec)

Updates the configuration of a virtual serial port.

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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

spec - Specification for updating the virtual serial port.

Throws:

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

NotFound - if the virtual machine or virtual serial port is not found.

NotAllowedInCurrentState - if one or more of the properties specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual serial port.

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(java.lang.String vm,
            java.lang.String port,
            SerialTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Updates the configuration of a virtual serial port.

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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

spec - Specification for updating the virtual serial port.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotFound - if the virtual machine or virtual serial port is not found.

NotAllowedInCurrentState - if one or more of the properties specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual serial port.

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(java.lang.String vm,
            java.lang.String port,
            SerialTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Updates the configuration of a virtual serial port.

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 or virtual serial port is not found.
NotAllowedInCurrentState - if one or more of the properties specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual serial port.
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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

spec - Specification for updating the virtual serial port.

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

update

void update(java.lang.String vm,
            java.lang.String port,
            SerialTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Updates the configuration of a virtual serial port.

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 or virtual serial port is not found.
NotAllowedInCurrentState - if one or more of the properties specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual serial port.
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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

spec - Specification for updating the virtual serial port.

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

invocationConfig - Configuration for the method invocation.

delete

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

Removes a virtual serial port from the 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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Throws:

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

NotFound - if the virtual machine or virtual serial port is not found.

NotAllowedInCurrentState - if the virtual machine is not powered off.

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.

delete

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

Removes a virtual serial port from the 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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotFound - if the virtual machine or virtual serial port is not found.

NotAllowedInCurrentState - if the virtual machine is not powered off.

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.

delete

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

Removes a virtual serial port from the 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 or virtual serial port is not found.
NotAllowedInCurrentState - if the virtual machine is not powered off.
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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

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

delete

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

Removes a virtual serial port from the 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 or virtual serial port is not found.
NotAllowedInCurrentState - if the virtual machine is not powered off.
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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

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

invocationConfig - Configuration for the method invocation.

connect

void connect(java.lang.String vm,
             java.lang.String port)

Connects a virtual serial port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system.

For a powered-off virtual machine, the update(java.lang.String, java.lang.String, com.vmware.vcenter.vm.hardware.SerialTypes.UpdateSpec) method may be used to configure the virtual serial port to start in the connected state when the virtual machine is powered on.

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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Throws:

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

NotFound - if the virtual machine or virtual serial port is not found.

AlreadyInDesiredState - if the virtual serial port is already connected.

NotAllowedInCurrentState - if the virtual machine is not powered on.

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.

connect

void connect(java.lang.String vm,
             java.lang.String port,
             InvocationConfig invocationConfig)

Connects a virtual serial port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system.

For a powered-off virtual machine, the update(java.lang.String, java.lang.String, com.vmware.vcenter.vm.hardware.SerialTypes.UpdateSpec) method may be used to configure the virtual serial port to start in the connected state when the virtual machine is powered on.

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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotFound - if the virtual machine or virtual serial port is not found.

AlreadyInDesiredState - if the virtual serial port is already connected.

NotAllowedInCurrentState - if the virtual machine is not powered on.

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.

connect

void connect(java.lang.String vm,
             java.lang.String port,
             AsyncCallback<java.lang.Void> asyncCallback)

Connects a virtual serial port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system.

For a powered-off virtual machine, the update(java.lang.String, java.lang.String, com.vmware.vcenter.vm.hardware.SerialTypes.UpdateSpec) method may be used to configure the virtual serial port to start in the connected state when the virtual machine is powered on.

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 or virtual serial port is not found.
AlreadyInDesiredState - if the virtual serial port is already connected.
NotAllowedInCurrentState - if the virtual machine is not powered on.
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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

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

connect

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

Connects a virtual serial port of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system.

For a powered-off virtual machine, the update(java.lang.String, java.lang.String, com.vmware.vcenter.vm.hardware.SerialTypes.UpdateSpec) method may be used to configure the virtual serial port to start in the connected state when the virtual machine is powered on.

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 or virtual serial port is not found.
AlreadyInDesiredState - if the virtual serial port is already connected.
NotAllowedInCurrentState - if the virtual machine is not powered on.
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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

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

invocationConfig - Configuration for the method invocation.

disconnect

void disconnect(java.lang.String vm,
                java.lang.String port)

Disconnects a virtual serial port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the serial port is not connected to its backing.

For a powered-off virtual machine, the update(java.lang.String, java.lang.String, com.vmware.vcenter.vm.hardware.SerialTypes.UpdateSpec) method may be used to configure the virtual serial port to start in the disconnected state when the virtual machine is powered on.

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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

Throws:

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

NotFound - if the virtual machine or virtual serial port is not found.

AlreadyInDesiredState - if the virtual serial port is already disconnected.

NotAllowedInCurrentState - if the virtual machine is not powered on.

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.

disconnect

void disconnect(java.lang.String vm,
                java.lang.String port,
                InvocationConfig invocationConfig)

Disconnects a virtual serial port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the serial port is not connected to its backing.

For a powered-off virtual machine, the update(java.lang.String, java.lang.String, com.vmware.vcenter.vm.hardware.SerialTypes.UpdateSpec) method may be used to configure the virtual serial port to start in the disconnected state when the virtual machine is powered on.

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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotFound - if the virtual machine or virtual serial port is not found.

AlreadyInDesiredState - if the virtual serial port is already disconnected.

NotAllowedInCurrentState - if the virtual machine is not powered on.

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.

disconnect

void disconnect(java.lang.String vm,
                java.lang.String port,
                AsyncCallback<java.lang.Void> asyncCallback)

Disconnects a virtual serial port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the serial port is not connected to its backing.

For a powered-off virtual machine, the update(java.lang.String, java.lang.String, com.vmware.vcenter.vm.hardware.SerialTypes.UpdateSpec) method may be used to configure the virtual serial port to start in the disconnected state when the virtual machine is powered on.

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 or virtual serial port is not found.
AlreadyInDesiredState - if the virtual serial port is already disconnected.
NotAllowedInCurrentState - if the virtual machine is not powered on.
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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

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

disconnect

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

Disconnects a virtual serial port of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the serial port is not connected to its backing.

For a powered-off virtual machine, the update(java.lang.String, java.lang.String, com.vmware.vcenter.vm.hardware.SerialTypes.UpdateSpec) method may be used to configure the virtual serial port to start in the disconnected state when the virtual machine is powered on.

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 or virtual serial port is not found.
AlreadyInDesiredState - if the virtual serial port is already disconnected.
NotAllowedInCurrentState - if the virtual machine is not powered on.
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.

port - Virtual serial port identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.

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

invocationConfig - Configuration for the method invocation.