hudson.plugins.vmware.vix
Interface Vix

All Superinterfaces:

com.sun.jna.Library

public interface Vix
extends com.sun.jna.Library

Nested Class Summary

static class	Vix.Error The error codes are returned by all public VIX routines.
static class	Vix.EventType These are events that may be signalled by calling a procedure of type VixEventProc.
static class	Vix.FileAttributes These are the property flags for each file.
static class	Vix.Find VM Search
static class	Vix.Handle
static class	Vix.HandleType These are the types of handles.
static class	Vix.HostOption
static class	Vix.PowerState This is the state of an individual VM.
static class	Vix.Property VIX Property ID's
static class	Vix.PropertyType VIX Property Type
static class	Vix.PumpEventsOption Event pump
static class	Vix.RunProgram Guest Process functions
static class	Vix.ServiceProvider
static class	Vix.Snapshot
static class	Vix.ToolsState
static class	Vix.UserName These are special names for an anonymous user and the system administrator.
static interface	Vix.VixEventProc Procedures of this type are called when an event happens on a handle.
static class	Vix.VMDeleteOptions
static class	Vix.VMPPowerOp
static class	Vix.VMSupport These flags describe optional functions supported by different types of VM.

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields inherited from interface com.sun.jna.Library

OPTION_FUNCTION_MAPPER, OPTION_INVOKING_METHOD, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Method Summary

void	Vix_FreeBuffer(com.sun.jna.Pointer buffer) When Vix_GetProperties() or Vix_JobWait() returns a string property, it allocates a buffer for the string.
java.lang.String	Vix_GetErrorText(int err, java.lang.String locale) Returns a human-readable string that describes the error.
int	Vix_GetHandleType(int handle) Given a handle, this returns the handle type.
int	Vix_GetProperties(int handle, java.lang.Object... firstPropertyID) This function allows you to get one or more properties from a handle.
int	Vix_GetPropertyType(int handle, int propertyID, com.sun.jna.ptr.IntByReference propertyType) Given a property ID, this function returns the type of that property.
void	Vix_PumpEvents(int hostHandle, int options)
void	Vix_ReleaseHandle(int handle) This function decrements the reference count for a handle and destroys the handle when there are no references.
int	VixHost_Connect(int apiVersion, int hostType, java.lang.String hostName, int hostPort, java.lang.String userName, java.lang.String password, int options, int propertyListHandle, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
void	VixHost_Disconnect(int hostHandle)
int	VixHost_FindItems(int hostHandle, int searchType, int searchCriteria, int timeout, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixHost_RegisterVM(int hostHandle, java.lang.String vmxFilePath, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixHost_UnregisterVM(int hostHandle, java.lang.String vmxFilePath, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixJob_CheckCompletion(int jobHandle, com.sun.jna.ptr.IntByReference complete)
int	VixJob_GetError(int jobHandle)
int	VixJob_GetNthProperties(int jobHandle, int index, java.lang.Object... propertyID)
int	VixJob_GetNumProperties(int jobHandle, int resultPropertyID)
int	VixJob_Wait(int jobHandle, java.lang.Object... firstPropertyID)
int	VixVM_CreateSnapshot(int vmHandle, java.lang.String name, java.lang.String description, int options, int propertyListHandle, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_Delete(int vmHandle, int deleteOptions, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_GetCurrentSnapshot(int vmHandle, com.sun.jna.ptr.IntByReference snapshotHandle)
int	VixVM_GetNamedSnapshot(int vmHandle, java.lang.String name, com.sun.jna.ptr.IntByReference snapshotHandle)
int	VixVM_GetNumRootSnapshots(int vmHandle, com.sun.jna.ptr.IntByReference result)
int	VixVM_GetRootSnapshot(int vmHandle, int index, com.sun.jna.ptr.IntByReference snapshotHandle)
int	VixVM_KillProcessInGuest(int vmHandle, long pid, int options, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_ListProcessesInGuest(int vmHandle, int options, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_LoginInGuest(int vmHandle, java.lang.String userName, java.lang.String password, int options, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_LogoutFromGuest(int vmHandle, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_Open(int hostHandle, java.lang.String vmxFilePathName, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_OpenUrlInGuest(int vmHandle, java.lang.String url, int windowState, int propertyListHandle, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_PowerOff(int vmHandle, int powerOffOptions, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_PowerOn(int vmHandle, int powerOnOptions, int propertyListHandle, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_RemoveSnapshot(int vmHandle, int snapshotHandle, int options, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_Reset(int vmHandle, int powerOnOptions, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_RevertToSnapshot(int vmHandle, int snapshotHandle, int options, int propertyListHandle, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_RunProgramInGuest(int vmHandle, java.lang.String guestProgramName, java.lang.String commandLineArgs, int options, int propertyListHandle, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_RunScriptInGuest(int vmHandle, java.lang.String interpreter, java.lang.String scriptText, int options, int propertyListHandle, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_Suspend(int vmHandle, int powerOffOptions, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)
int	VixVM_WaitForToolsInGuest(int vmHandle, int timeoutInSeconds, Vix.VixEventProc callbackProc, com.sun.jna.Pointer clientData)

Method Detail

Vix_GetErrorText

java.lang.String Vix_GetErrorText(int err,
                                  java.lang.String locale)

Returns a human-readable string that describes the error.

Parameters:

err - A Vix error code returned by any other Vix function.

locale - Must be null.

Returns:

A human-readable string that describes the error.

Vix_ReleaseHandle

void Vix_ReleaseHandle(int handle)

This function decrements the reference count for a handle and destroys the handle when there are no references.

Parameters:

handle - Any handle returned by a Vix function.

Vix_GetHandleType

int Vix_GetHandleType(int handle)

Given a handle, this returns the handle type.

Parameters:

handle - Any handle returned by a Vix function.

Returns:

one of the constants from Vix.HandleType

Vix_GetProperties

int Vix_GetProperties(int handle,
                      java.lang.Object... firstPropertyID)

This function allows you to get one or more properties from a handle.

• This function allows you to get one or more properties from a handle. You may use this function on any type of handle, but only specific properties are defined for each handle.
• This procedure accepts a variable number of parameters, so you can retrieve any number of properties with a single call. The parameters must be in a series of pairs of property IDs and result pointers. Each result pointer will accept the value of the property identified by the property ID in the previous parameter. The type of the pointer depends on the type of the property. You end the variable list of parameters with a single ID value of Vix.Property.NONE.
• When Vix_GetProperties() returns an error, the values of the output parameters are indeterminate.
• If you retrieve a string property, the Programming API allocates space for that string. You are responsible for calling Vix_FreeBuffer() to free the string.
• The value of Vix.Property.VM_TOOLS_STATE is valid only after calling VixVM_WaitForToolsInGuest.

Parameters:

handle - Any handle returned by a Vix function.

firstPropertyID - A property ID.

Returns:

This function returns VIX_OK if it succeeded, otherwise the return value indicates an error.

Vix_GetPropertyType

int Vix_GetPropertyType(int handle,
                        int propertyID,
                        com.sun.jna.ptr.IntByReference propertyType)

Given a property ID, this function returns the type of that property.

Parameters:

handle - Any handle returned by a VIX function.

propertyID - A property ID. See below for valid values.

propertyType - The type of the data stored by the property.

Returns:

This function returns VIX_OK if it succeeded.

Vix_FreeBuffer

void Vix_FreeBuffer(com.sun.jna.Pointer buffer)

When Vix_GetProperties() or Vix_JobWait() returns a string property, it allocates a buffer for the string. Client applications are responsible for calling Vix_FreeBuffer() to free the string buffer when no longer needed. If you pass a null pointer to Vix_FreeBuffer(), the function returns immediately.

Parameters:

buffer - A string pointer returned by a call to Vix_GetProperties() or Vix_JobWait().

VixHost_Connect

int VixHost_Connect(int apiVersion,
                    int hostType,
                    java.lang.String hostName,
                    int hostPort,
                    java.lang.String userName,
                    java.lang.String password,
                    int options,
                    int propertyListHandle,
                    Vix.VixEventProc callbackProc,
                    com.sun.jna.Pointer clientData)

VixHost_Disconnect

void VixHost_Disconnect(int hostHandle)

VixHost_RegisterVM

int VixHost_RegisterVM(int hostHandle,
                       java.lang.String vmxFilePath,
                       Vix.VixEventProc callbackProc,
                       com.sun.jna.Pointer clientData)

VixHost_UnregisterVM

int VixHost_UnregisterVM(int hostHandle,
                         java.lang.String vmxFilePath,
                         Vix.VixEventProc callbackProc,
                         com.sun.jna.Pointer clientData)

VixHost_FindItems

int VixHost_FindItems(int hostHandle,
                      int searchType,
                      int searchCriteria,
                      int timeout,
                      Vix.VixEventProc callbackProc,
                      com.sun.jna.Pointer clientData)

Vix_PumpEvents

void Vix_PumpEvents(int hostHandle,
                    int options)

VixVM_Open

int VixVM_Open(int hostHandle,
               java.lang.String vmxFilePathName,
               Vix.VixEventProc callbackProc,
               com.sun.jna.Pointer clientData)

VixVM_PowerOn

int VixVM_PowerOn(int vmHandle,
                  int powerOnOptions,
                  int propertyListHandle,
                  Vix.VixEventProc callbackProc,
                  com.sun.jna.Pointer clientData)

VixVM_PowerOff

int VixVM_PowerOff(int vmHandle,
                   int powerOffOptions,
                   Vix.VixEventProc callbackProc,
                   com.sun.jna.Pointer clientData)

VixVM_Reset

int VixVM_Reset(int vmHandle,
                int powerOnOptions,
                Vix.VixEventProc callbackProc,
                com.sun.jna.Pointer clientData)

VixVM_Suspend

int VixVM_Suspend(int vmHandle,
                  int powerOffOptions,
                  Vix.VixEventProc callbackProc,
                  com.sun.jna.Pointer clientData)

VixVM_Delete

int VixVM_Delete(int vmHandle,
                 int deleteOptions,
                 Vix.VixEventProc callbackProc,
                 com.sun.jna.Pointer clientData)

VixVM_WaitForToolsInGuest

int VixVM_WaitForToolsInGuest(int vmHandle,
                              int timeoutInSeconds,
                              Vix.VixEventProc callbackProc,
                              com.sun.jna.Pointer clientData)

VixVM_LoginInGuest

int VixVM_LoginInGuest(int vmHandle,
                       java.lang.String userName,
                       java.lang.String password,
                       int options,
                       Vix.VixEventProc callbackProc,
                       com.sun.jna.Pointer clientData)

VixVM_LogoutFromGuest

int VixVM_LogoutFromGuest(int vmHandle,
                          Vix.VixEventProc callbackProc,
                          com.sun.jna.Pointer clientData)

VixVM_RunProgramInGuest

int VixVM_RunProgramInGuest(int vmHandle,
                            java.lang.String guestProgramName,
                            java.lang.String commandLineArgs,
                            int options,
                            int propertyListHandle,
                            Vix.VixEventProc callbackProc,
                            com.sun.jna.Pointer clientData)

VixVM_ListProcessesInGuest

int VixVM_ListProcessesInGuest(int vmHandle,
                               int options,
                               Vix.VixEventProc callbackProc,
                               com.sun.jna.Pointer clientData)

VixVM_KillProcessInGuest

int VixVM_KillProcessInGuest(int vmHandle,
                             long pid,
                             int options,
                             Vix.VixEventProc callbackProc,
                             com.sun.jna.Pointer clientData)

VixVM_RunScriptInGuest

int VixVM_RunScriptInGuest(int vmHandle,
                           java.lang.String interpreter,
                           java.lang.String scriptText,
                           int options,
                           int propertyListHandle,
                           Vix.VixEventProc callbackProc,
                           com.sun.jna.Pointer clientData)

VixVM_OpenUrlInGuest

int VixVM_OpenUrlInGuest(int vmHandle,
                         java.lang.String url,
                         int windowState,
                         int propertyListHandle,
                         Vix.VixEventProc callbackProc,
                         com.sun.jna.Pointer clientData)

VixVM_GetNumRootSnapshots

int VixVM_GetNumRootSnapshots(int vmHandle,
                              com.sun.jna.ptr.IntByReference result)

VixVM_GetRootSnapshot

int VixVM_GetRootSnapshot(int vmHandle,
                          int index,
                          com.sun.jna.ptr.IntByReference snapshotHandle)

VixVM_GetCurrentSnapshot

int VixVM_GetCurrentSnapshot(int vmHandle,
                             com.sun.jna.ptr.IntByReference snapshotHandle)

VixVM_GetNamedSnapshot

int VixVM_GetNamedSnapshot(int vmHandle,
                           java.lang.String name,
                           com.sun.jna.ptr.IntByReference snapshotHandle)

VixVM_RemoveSnapshot

int VixVM_RemoveSnapshot(int vmHandle,
                         int snapshotHandle,
                         int options,
                         Vix.VixEventProc callbackProc,
                         com.sun.jna.Pointer clientData)

VixVM_RevertToSnapshot

int VixVM_RevertToSnapshot(int vmHandle,
                           int snapshotHandle,
                           int options,
                           int propertyListHandle,
                           Vix.VixEventProc callbackProc,
                           com.sun.jna.Pointer clientData)

VixVM_CreateSnapshot

int VixVM_CreateSnapshot(int vmHandle,
                         java.lang.String name,
                         java.lang.String description,
                         int options,
                         int propertyListHandle,
                         Vix.VixEventProc callbackProc,
                         com.sun.jna.Pointer clientData)

VixJob_Wait

int VixJob_Wait(int jobHandle,
                java.lang.Object... firstPropertyID)

VixJob_CheckCompletion

int VixJob_CheckCompletion(int jobHandle,
                           com.sun.jna.ptr.IntByReference complete)

VixJob_GetError

int VixJob_GetError(int jobHandle)

VixJob_GetNumProperties

int VixJob_GetNumProperties(int jobHandle,
                            int resultPropertyID)

VixJob_GetNthProperties

int VixJob_GetNthProperties(int jobHandle,
                            int index,
                            java.lang.Object... propertyID)