com.vmware.vcenter.vm.guest

Interface Processes

All Superinterfaces:

ProcessesTypes, Service

All Known Implementing Classes:

ProcessesStub

public interface Processes
extends Service, ProcessesTypes

The Processes interface provides methods to manage processes in the guest operating system. This interface was added in vSphere API 7.0.2.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm.guest.ProcessesTypes

ProcessesTypes.CreateSpec, ProcessesTypes.Info, ProcessesTypes.ProcessErrorDetails, ProcessesTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.vm.guest.ProcessesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
long	create(java.lang.String vm, Credentials credentials, ProcessesTypes.CreateSpec spec) Starts a program in the guest operating system.
void	create(java.lang.String vm, Credentials credentials, ProcessesTypes.CreateSpec spec, AsyncCallback<java.lang.Long> asyncCallback) Starts a program in the guest operating system.
void	create(java.lang.String vm, Credentials credentials, ProcessesTypes.CreateSpec spec, AsyncCallback<java.lang.Long> asyncCallback, InvocationConfig invocationConfig) Starts a program in the guest operating system.
long	create(java.lang.String vm, Credentials credentials, ProcessesTypes.CreateSpec spec, InvocationConfig invocationConfig) Starts a program in the guest operating system.
void	delete(java.lang.String vm, Credentials credentials, long pid) Terminates a process in the guest OS.
void	delete(java.lang.String vm, Credentials credentials, long pid, AsyncCallback<java.lang.Void> asyncCallback) Terminates a process in the guest OS.
void	delete(java.lang.String vm, Credentials credentials, long pid, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Terminates a process in the guest OS.
void	delete(java.lang.String vm, Credentials credentials, long pid, InvocationConfig invocationConfig) Terminates a process in the guest OS.
ProcessesTypes.Info	get(java.lang.String vm, Credentials credentials, long pid) Returns the status of a process running in the guest operating system, including those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that may have recently completed.
void	get(java.lang.String vm, Credentials credentials, long pid, AsyncCallback<ProcessesTypes.Info> asyncCallback) Returns the status of a process running in the guest operating system, including those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that may have recently completed.
void	get(java.lang.String vm, Credentials credentials, long pid, AsyncCallback<ProcessesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the status of a process running in the guest operating system, including those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that may have recently completed.
ProcessesTypes.Info	get(java.lang.String vm, Credentials credentials, long pid, InvocationConfig invocationConfig) Returns the status of a process running in the guest operating system, including those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that may have recently completed.
java.util.List<ProcessesTypes.Summary>	list(java.lang.String vm, Credentials credentials) List the processes running in the guest operating system, plus those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that have recently completed.
void	list(java.lang.String vm, Credentials credentials, AsyncCallback<java.util.List<ProcessesTypes.Summary>> asyncCallback) List the processes running in the guest operating system, plus those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that have recently completed.
void	list(java.lang.String vm, Credentials credentials, AsyncCallback<java.util.List<ProcessesTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) List the processes running in the guest operating system, plus those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that have recently completed.
java.util.List<ProcessesTypes.Summary>	list(java.lang.String vm, Credentials credentials, InvocationConfig invocationConfig) List the processes running in the guest operating system, plus those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that have recently completed.

Method Detail

create

long create(java.lang.String vm,
            Credentials credentials,
            ProcessesTypes.CreateSpec spec)

Starts a program in the guest operating system.

A process started this way can have its status queried with list(java.lang.String, com.vmware.vcenter.vm.guest.Credentials) or get(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, long). When the process completes, its exit code and end time will be available for 5 minutes after completion.

. This method was added in vSphere API 7.0.2.0.

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

Parameters:

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

credentials - The guest authentication data. See Credentials. The program will be run as the user associated with this data.

spec - The arguments describing the program to be started.

Returns:

The process id of the program started.

Throws:

InvalidArgument - if the ProcessesTypes.CreateSpec.getStartMinimized() property is set and the guest is not a Windows operating system.

InvalidArgument - if the program path is not a valid path. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.

InvalidArgument - if the working directory is not a valid directory. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.

NotAllowedInCurrentState - if the virtual machine vm is not running.

NotFound - if the virtual machine vm is not found.

NotFound - if the program path does not exist. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.

ResourceBusy - if the virtual machine is busy.

ServiceUnavailable - if the VMware tools are not running.

UnableToAllocateResource - if the program fails to start.

Unauthenticated - if the credentials was not valid.

Unauthorized - if the getPath() property of spec cannot be accessed.

Unauthorized - if the getPath() property of spec cannot be run because credentials will not allow the operation.

Unsupported - if the operation is not supported by the VMware tools in the guest OS.

Unsupported - if the operation is disabled by the VMware tools in the guest OS.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.

create

long create(java.lang.String vm,
            Credentials credentials,
            ProcessesTypes.CreateSpec spec,
            InvocationConfig invocationConfig)

Starts a program in the guest operating system.

A process started this way can have its status queried with list(java.lang.String, com.vmware.vcenter.vm.guest.Credentials) or get(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, long). When the process completes, its exit code and end time will be available for 5 minutes after completion.

. This method was added in vSphere API 7.0.2.0.

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 to perform the operation on. The parameter must be an identifier for the resource type: VirtualMachine.

credentials - The guest authentication data. See Credentials. The program will be run as the user associated with this data.

spec - The arguments describing the program to be started.

invocationConfig - Configuration for the method invocation.

Returns:

The process id of the program started.

Throws:

InvalidArgument - if the ProcessesTypes.CreateSpec.getStartMinimized() property is set and the guest is not a Windows operating system.

InvalidArgument - if the program path is not a valid path. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.

InvalidArgument - if the working directory is not a valid directory. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.

NotAllowedInCurrentState - if the virtual machine vm is not running.

NotFound - if the virtual machine vm is not found.

NotFound - if the program path does not exist. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.

ResourceBusy - if the virtual machine is busy.

ServiceUnavailable - if the VMware tools are not running.

UnableToAllocateResource - if the program fails to start.

Unauthenticated - if the credentials was not valid.

Unauthorized - if the getPath() property of spec cannot be accessed.

Unauthorized - if the getPath() property of spec cannot be run because credentials will not allow the operation.

Unsupported - if the operation is not supported by the VMware tools in the guest OS.

Unsupported - if the operation is disabled by the VMware tools in the guest OS.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.

create

void create(java.lang.String vm,
            Credentials credentials,
            ProcessesTypes.CreateSpec spec,
            AsyncCallback<java.lang.Long> asyncCallback)

Starts a program in the guest operating system.

A process started this way can have its status queried with list(java.lang.String, com.vmware.vcenter.vm.guest.Credentials) or get(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, long). When the process completes, its exit code and end time will be available for 5 minutes after completion.

. This method was added in vSphere API 7.0.2.0.

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

Invocation Result:
The process id of the program started.

Operation Errors:
InvalidArgument - if the ProcessesTypes.CreateSpec.getStartMinimized() property is set and the guest is not a Windows operating system.
InvalidArgument - if the program path is not a valid path. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.
InvalidArgument - if the working directory is not a valid directory. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.
NotAllowedInCurrentState - if the virtual machine vm is not running.
NotFound - if the virtual machine vm is not found.
NotFound - if the program path does not exist. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.
ResourceBusy - if the virtual machine is busy.
ServiceUnavailable - if the VMware tools are not running.
UnableToAllocateResource - if the program fails to start.
Unauthenticated - if the credentials was not valid.
Unauthorized - if the getPath() property of spec cannot be accessed.
Unauthorized - if the getPath() property of spec cannot be run because credentials will not allow the operation.
Unsupported - if the operation is not supported by the VMware tools in the guest OS.
Unsupported - if the operation is disabled by the VMware tools in the guest OS.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.

Parameters:

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

credentials - The guest authentication data. See Credentials. The program will be run as the user associated with this data.

spec - The arguments describing the program to be started.

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

create

void create(java.lang.String vm,
            Credentials credentials,
            ProcessesTypes.CreateSpec spec,
            AsyncCallback<java.lang.Long> asyncCallback,
            InvocationConfig invocationConfig)

Starts a program in the guest operating system.

A process started this way can have its status queried with list(java.lang.String, com.vmware.vcenter.vm.guest.Credentials) or get(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, long). When the process completes, its exit code and end time will be available for 5 minutes after completion.

. This method was added in vSphere API 7.0.2.0.

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 process id of the program started.

Operation Errors:
InvalidArgument - if the ProcessesTypes.CreateSpec.getStartMinimized() property is set and the guest is not a Windows operating system.
InvalidArgument - if the program path is not a valid path. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.
InvalidArgument - if the working directory is not a valid directory. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.
NotAllowedInCurrentState - if the virtual machine vm is not running.
NotFound - if the virtual machine vm is not found.
NotFound - if the program path does not exist. The value of Error.getData() will contain all the properties defined in the FileErrorDetails providing additional information about the failure.
ResourceBusy - if the virtual machine is busy.
ServiceUnavailable - if the VMware tools are not running.
UnableToAllocateResource - if the program fails to start.
Unauthenticated - if the credentials was not valid.
Unauthorized - if the getPath() property of spec cannot be accessed.
Unauthorized - if the getPath() property of spec cannot be run because credentials will not allow the operation.
Unsupported - if the operation is not supported by the VMware tools in the guest OS.
Unsupported - if the operation is disabled by the VMware tools in the guest OS.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.

Parameters:

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

credentials - The guest authentication data. See Credentials. The program will be run as the user associated with this data.

spec - The arguments describing the program to be started.

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

invocationConfig - Configuration for the method invocation.

get

ProcessesTypes.Info get(java.lang.String vm,
                        Credentials credentials,
                        long pid)

Returns the status of a process running in the guest operating system, including those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that may have recently completed.

. This method was added in vSphere API 7.0.2.0.

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

Parameters:

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

credentials - The guest authentication data. See Credentials.

pid - Specifies the process to query.

Returns:

The com.vmware.vcenter.vm.guest.Processes#Info for the process with id pid.

Throws:

NotAllowedInCurrentState - if the virtual machine vm is not running.

NotFound - if the virtual machine vm is not found.

NotFound - if the process pid is not found. The value of Error.getData() will contain all the properties defined in the ProcessesTypes.ProcessErrorDetails providing additional information about the failure.

ResourceBusy - if the virtual machine is busy.

ServiceUnavailable - if the VMware tools are not running.

Unauthenticated - if the credentials is not valid.

Unsupported - if the operation is not supported by the VMware tools in the guest OS.

Unsupported - if the operation is disabled by the VMware tools in the guest OS.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.

get

ProcessesTypes.Info get(java.lang.String vm,
                        Credentials credentials,
                        long pid,
                        InvocationConfig invocationConfig)

Returns the status of a process running in the guest operating system, including those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that may have recently completed.

. This method was added in vSphere API 7.0.2.0.

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 to perform the operation on. The parameter must be an identifier for the resource type: VirtualMachine.

credentials - The guest authentication data. See Credentials.

pid - Specifies the process to query.

invocationConfig - Configuration for the method invocation.

Returns:

The com.vmware.vcenter.vm.guest.Processes#Info for the process with id pid.

Throws:

NotAllowedInCurrentState - if the virtual machine vm is not running.

NotFound - if the virtual machine vm is not found.

NotFound - if the process pid is not found. The value of Error.getData() will contain all the properties defined in the ProcessesTypes.ProcessErrorDetails providing additional information about the failure.

ResourceBusy - if the virtual machine is busy.

ServiceUnavailable - if the VMware tools are not running.

Unauthenticated - if the credentials is not valid.

Unsupported - if the operation is not supported by the VMware tools in the guest OS.

Unsupported - if the operation is disabled by the VMware tools in the guest OS.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.

get

void get(java.lang.String vm,
         Credentials credentials,
         long pid,
         AsyncCallback<ProcessesTypes.Info> asyncCallback)

Returns the status of a process running in the guest operating system, including those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that may have recently completed.

. This method was added in vSphere API 7.0.2.0.

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

Invocation Result:
The com.vmware.vcenter.vm.guest.Processes#Info for the process with id pid.

Operation Errors:
NotAllowedInCurrentState - if the virtual machine vm is not running.
NotFound - if the virtual machine vm is not found.
NotFound - if the process pid is not found. The value of Error.getData() will contain all the properties defined in the ProcessesTypes.ProcessErrorDetails providing additional information about the failure.
ResourceBusy - if the virtual machine is busy.
ServiceUnavailable - if the VMware tools are not running.
Unauthenticated - if the credentials is not valid.
Unsupported - if the operation is not supported by the VMware tools in the guest OS.
Unsupported - if the operation is disabled by the VMware tools in the guest OS.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.

Parameters:

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

credentials - The guest authentication data. See Credentials.

pid - Specifies the process to query.

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

get

void get(java.lang.String vm,
         Credentials credentials,
         long pid,
         AsyncCallback<ProcessesTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns the status of a process running in the guest operating system, including those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that may have recently completed.

. This method was added in vSphere API 7.0.2.0.

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 com.vmware.vcenter.vm.guest.Processes#Info for the process with id pid.

Operation Errors:
NotAllowedInCurrentState - if the virtual machine vm is not running.
NotFound - if the virtual machine vm is not found.
NotFound - if the process pid is not found. The value of Error.getData() will contain all the properties defined in the ProcessesTypes.ProcessErrorDetails providing additional information about the failure.
ResourceBusy - if the virtual machine is busy.
ServiceUnavailable - if the VMware tools are not running.
Unauthenticated - if the credentials is not valid.
Unsupported - if the operation is not supported by the VMware tools in the guest OS.
Unsupported - if the operation is disabled by the VMware tools in the guest OS.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.

Parameters:

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

credentials - The guest authentication data. See Credentials.

pid - Specifies the process to query.

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

invocationConfig - Configuration for the method invocation.

list

java.util.List<ProcessesTypes.Summary> list(java.lang.String vm,
                                            Credentials credentials)

List the processes running in the guest operating system, plus those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that have recently completed.

. This method was added in vSphere API 7.0.2.0.

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

Parameters:

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

credentials - The guest authentication data. See Credentials.

Returns:

The list of running processes is returned in an array of com.vmware.vcenter.vm.guest.Processes#Summary classes.

Throws:

NotAllowedInCurrentState - if the virtual machine vm is not running.

NotFound - if the virtual machine vm is not found.

ResourceBusy - if the virtual machine is busy.

ServiceUnavailable - if the VMware tools are not running.

Unauthenticated - if the credentials is not valid.

Unsupported - if the operation is not supported by the VMware tools in the guest OS.

Unsupported - if the operation is disabled by the VMware tools in the guest OS.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.

list

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

List the processes running in the guest operating system, plus those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that have recently completed.

. This method was added in vSphere API 7.0.2.0.

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 to perform the operation on. The parameter must be an identifier for the resource type: VirtualMachine.

credentials - The guest authentication data. See Credentials.

invocationConfig - Configuration for the method invocation.

Returns:

The list of running processes is returned in an array of com.vmware.vcenter.vm.guest.Processes#Summary classes.

Throws:

NotAllowedInCurrentState - if the virtual machine vm is not running.

NotFound - if the virtual machine vm is not found.

ResourceBusy - if the virtual machine is busy.

ServiceUnavailable - if the VMware tools are not running.

Unauthenticated - if the credentials is not valid.

Unsupported - if the operation is not supported by the VMware tools in the guest OS.

Unsupported - if the operation is disabled by the VMware tools in the guest OS.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.

list

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

List the processes running in the guest operating system, plus those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that have recently completed.

. This method was added in vSphere API 7.0.2.0.

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

Invocation Result:
The list of running processes is returned in an array of com.vmware.vcenter.vm.guest.Processes#Summary classes.

Operation Errors:
NotAllowedInCurrentState - if the virtual machine vm is not running.
NotFound - if the virtual machine vm is not found.
ResourceBusy - if the virtual machine is busy.
ServiceUnavailable - if the VMware tools are not running.
Unauthenticated - if the credentials is not valid.
Unsupported - if the operation is not supported by the VMware tools in the guest OS.
Unsupported - if the operation is disabled by the VMware tools in the guest OS.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.

Parameters:

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

credentials - The guest authentication data. See Credentials.

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

list

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

List the processes running in the guest operating system, plus those started by create(java.lang.String, com.vmware.vcenter.vm.guest.Credentials, com.vmware.vcenter.vm.guest.ProcessesTypes.CreateSpec) that have recently completed.

. This method was added in vSphere API 7.0.2.0.

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 list of running processes is returned in an array of com.vmware.vcenter.vm.guest.Processes#Summary classes.

Operation Errors:
NotAllowedInCurrentState - if the virtual machine vm is not running.
NotFound - if the virtual machine vm is not found.
ResourceBusy - if the virtual machine is busy.
ServiceUnavailable - if the VMware tools are not running.
Unauthenticated - if the credentials is not valid.
Unsupported - if the operation is not supported by the VMware tools in the guest OS.
Unsupported - if the operation is disabled by the VMware tools in the guest OS.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Query.

Parameters:

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

credentials - The guest authentication data. See Credentials.

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,
            Credentials credentials,
            long pid)

Terminates a process in the guest OS.

On Posix guests, the process is sent a SIGTERM signal. If that doesn't terminate the process, a SIGKILL signal is sent. A process may still be running if it's stuck.

. This method was added in vSphere API 7.0.2.0.

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

Parameters:

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

credentials - The guest authentication data. See Credentials.

pid - Process ID of the process to be terminated

Throws:

NotAllowedInCurrentState - if the virtual machine vm is not running.

NotFound - if the virtual machine vm is not found.

NotFound - if the pid is not found. The value of Error.getData() will contain all the properties defined in the ProcessesTypes.ProcessErrorDetails providing additional information about the failure.

ResourceBusy - if the virtual machine is busy.

ServiceUnavailable - if the VMware tools are not running.

Unauthenticated - if credentials is not valid.

Unauthorized - if credentials does not have permission to terminate the process.

Unsupported - if the operation is not supported by the VMware tools in the guest OS.

Unsupported - if the operation is disabled by the VMware tools in the guest OS.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.

delete

void delete(java.lang.String vm,
            Credentials credentials,
            long pid,
            InvocationConfig invocationConfig)

Terminates a process in the guest OS.

On Posix guests, the process is sent a SIGTERM signal. If that doesn't terminate the process, a SIGKILL signal is sent. A process may still be running if it's stuck.

. This method was added in vSphere API 7.0.2.0.

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 to perform the operation on. The parameter must be an identifier for the resource type: VirtualMachine.

credentials - The guest authentication data. See Credentials.

pid - Process ID of the process to be terminated

invocationConfig - Configuration for the method invocation.

Throws:

NotAllowedInCurrentState - if the virtual machine vm is not running.

NotFound - if the virtual machine vm is not found.

NotFound - if the pid is not found. The value of Error.getData() will contain all the properties defined in the ProcessesTypes.ProcessErrorDetails providing additional information about the failure.

ResourceBusy - if the virtual machine is busy.

ServiceUnavailable - if the VMware tools are not running.

Unauthenticated - if credentials is not valid.

Unauthorized - if credentials does not have permission to terminate the process.

Unsupported - if the operation is not supported by the VMware tools in the guest OS.

Unsupported - if the operation is disabled by the VMware tools in the guest OS.

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.

delete

void delete(java.lang.String vm,
            Credentials credentials,
            long pid,
            AsyncCallback<java.lang.Void> asyncCallback)

Terminates a process in the guest OS.

On Posix guests, the process is sent a SIGTERM signal. If that doesn't terminate the process, a SIGKILL signal is sent. A process may still be running if it's stuck.

. This method was added in vSphere API 7.0.2.0.

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

Operation Errors:
NotAllowedInCurrentState - if the virtual machine vm is not running.
NotFound - if the virtual machine vm is not found.
NotFound - if the pid is not found. The value of Error.getData() will contain all the properties defined in the ProcessesTypes.ProcessErrorDetails providing additional information about the failure.
ResourceBusy - if the virtual machine is busy.
ServiceUnavailable - if the VMware tools are not running.
Unauthenticated - if credentials is not valid.
Unauthorized - if credentials does not have permission to terminate the process.
Unsupported - if the operation is not supported by the VMware tools in the guest OS.
Unsupported - if the operation is disabled by the VMware tools in the guest OS.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.

Parameters:

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

credentials - The guest authentication data. See Credentials.

pid - Process ID of the process to be terminated

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

delete

void delete(java.lang.String vm,
            Credentials credentials,
            long pid,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Terminates a process in the guest OS.

On Posix guests, the process is sent a SIGTERM signal. If that doesn't terminate the process, a SIGKILL signal is sent. A process may still be running if it's stuck.

. This method was added in vSphere API 7.0.2.0.

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:
NotAllowedInCurrentState - if the virtual machine vm is not running.
NotFound - if the virtual machine vm is not found.
NotFound - if the pid is not found. The value of Error.getData() will contain all the properties defined in the ProcessesTypes.ProcessErrorDetails providing additional information about the failure.
ResourceBusy - if the virtual machine is busy.
ServiceUnavailable - if the VMware tools are not running.
Unauthenticated - if credentials is not valid.
Unauthorized - if credentials does not have permission to terminate the process.
Unsupported - if the operation is not supported by the VMware tools in the guest OS.
Unsupported - if the operation is disabled by the VMware tools in the guest OS.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.

Parameters:

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

credentials - The guest authentication data. See Credentials.

pid - Process ID of the process to be terminated

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

invocationConfig - Configuration for the method invocation.