GuestFileManager (VMware VI (vSphere) Java API 5.0.0 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.vmware.vim25.mo
Class GuestFileManager

java.lang.Object
  com.vmware.vim25.mo.ManagedObject
      com.vmware.vim25.mo.GuestFileManager

public class GuestFileManager
extends ManagedObject
extends ManagedObject

provides APIs to manipulate the guest operating system files.

Since:: SDK5.0
Author:: Steve Jin (http://www.doublecloud.org)

Constructor Summary
`GuestFileManager(ServerConnection sc, ManagedObjectReference mor, VirtualMachine vm)`

Method Summary
`void`	`changeFileAttributesInGuest(GuestAuthentication auth, String guestFilePath, GuestFileAttributes fileAttributes)`
`String`	`createTemporaryDirectoryInGuest(GuestAuthentication auth, String prefix, String suffix, String directoryPath)`
`String`	`createTemporaryFileInGuest(GuestAuthentication auth, String prefix, String suffix, String directoryPath)`
`void`	`deleteDirectoryInGuest(GuestAuthentication auth, String directoryPath, boolean recursive)`
`void`	`deleteFileInGuest(GuestAuthentication auth, String filePath)`
`VirtualMachine`	`getVM()`
`FileTransferInformation`	`initiateFileTransferFromGuest(GuestAuthentication auth, String guestFilePath)`
`String`	`initiateFileTransferToGuest(GuestAuthentication auth, String guestFilePath, GuestFileAttributes fileAttributes, long fileSize, boolean overwrite)`
`GuestListFileInfo`	`listFilesInGuest(GuestAuthentication auth, String filePath, int index, int maxResults, String matchPattern)`
`void`	`makeDirectoryInGuest(GuestAuthentication auth, String directoryPath, boolean createParentDirectories)`
`void`	`moveDirectoryInGuest(GuestAuthentication auth, String srcDirectoryPath, String dstDirectoryPath)`
`void`	`moveFileInGuest(GuestAuthentication auth, String srcFilePath, String dstFilePath, boolean overwrite)`

Methods inherited from class com.vmware.vim25.mo.ManagedObject
`convertMors, getCurrentProperty, getDatastores, getFilter, getHosts, getManagedObject, getManagedObjects, getManagedObjects, getMOR, getNetworks, getPropertiesByPaths, getPropertyByPath, getResourcePools, getScheduledTasks, getServerConnection, getTasks, getViews, getVimService, getVms, retrieveObjectProperties, setMOR, setServerConnection, toString, waitForValues`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Constructor Detail

GuestFileManager

public GuestFileManager(ServerConnection sc,
                        ManagedObjectReference mor,
                        VirtualMachine vm)

Method Detail

getVM

public VirtualMachine getVM()

changeFileAttributesInGuest

public void changeFileAttributesInGuest(GuestAuthentication auth,
                                        String guestFilePath,
                                        GuestFileAttributes fileAttributes)
                                 throws GuestOperationsFault,
                                        InvalidState,
                                        TaskInProgress,
                                        FileFault,
                                        RuntimeFault,
                                        RemoteException

Throws:: GuestOperationsFault; InvalidState; TaskInProgress; FileFault; RuntimeFault; RemoteException

createTemporaryDirectoryInGuest

public String createTemporaryDirectoryInGuest(GuestAuthentication auth,
                                              String prefix,
                                              String suffix,
                                              String directoryPath)
                                       throws GuestOperationsFault,
                                              InvalidState,
                                              TaskInProgress,
                                              FileFault,
                                              RuntimeFault,
                                              RemoteException

Throws:: GuestOperationsFault; InvalidState; TaskInProgress; FileFault; RuntimeFault; RemoteException

createTemporaryFileInGuest

public String createTemporaryFileInGuest(GuestAuthentication auth,
                                         String prefix,
                                         String suffix,
                                         String directoryPath)
                                  throws GuestOperationsFault,
                                         InvalidState,
                                         TaskInProgress,
                                         FileFault,
                                         RuntimeFault,
                                         RemoteException

Throws:: GuestOperationsFault; InvalidState; TaskInProgress; FileFault; RuntimeFault; RemoteException

deleteDirectoryInGuest

public void deleteDirectoryInGuest(GuestAuthentication auth,
                                   String directoryPath,
                                   boolean recursive)
                            throws GuestOperationsFault,
                                   InvalidState,
                                   TaskInProgress,
                                   FileFault,
                                   RuntimeFault,
                                   RemoteException

Throws:: GuestOperationsFault; InvalidState; TaskInProgress; FileFault; RuntimeFault; RemoteException

deleteFileInGuest

public void deleteFileInGuest(GuestAuthentication auth,
                              String filePath)
                       throws GuestOperationsFault,
                              InvalidState,
                              TaskInProgress,
                              FileFault,
                              RuntimeFault,
                              RemoteException

Throws:: GuestOperationsFault; InvalidState; TaskInProgress; FileFault; RuntimeFault; RemoteException

initiateFileTransferFromGuest

public FileTransferInformation initiateFileTransferFromGuest(GuestAuthentication auth,
                                                             String guestFilePath)
                                                      throws GuestOperationsFault,
                                                             InvalidState,
                                                             TaskInProgress,
                                                             FileFault,
                                                             RuntimeFault,
                                                             RemoteException

Throws:: GuestOperationsFault; InvalidState; TaskInProgress; FileFault; RuntimeFault; RemoteException

initiateFileTransferToGuest

public String initiateFileTransferToGuest(GuestAuthentication auth,
                                          String guestFilePath,
                                          GuestFileAttributes fileAttributes,
                                          long fileSize,
                                          boolean overwrite)
                                   throws GuestOperationsFault,
                                          InvalidState,
                                          TaskInProgress,
                                          FileFault,
                                          RuntimeFault,
                                          RemoteException

Throws:: GuestOperationsFault; InvalidState; TaskInProgress; FileFault; RuntimeFault; RemoteException

listFilesInGuest

public GuestListFileInfo listFilesInGuest(GuestAuthentication auth,
                                          String filePath,
                                          int index,
                                          int maxResults,
                                          String matchPattern)
                                   throws GuestOperationsFault,
                                          InvalidState,
                                          TaskInProgress,
                                          FileFault,
                                          RuntimeFault,
                                          RemoteException

Throws:: GuestOperationsFault; InvalidState; TaskInProgress; FileFault; RuntimeFault; RemoteException

makeDirectoryInGuest

public void makeDirectoryInGuest(GuestAuthentication auth,
                                 String directoryPath,
                                 boolean createParentDirectories)
                          throws GuestOperationsFault,
                                 InvalidState,
                                 TaskInProgress,
                                 FileFault,
                                 RuntimeFault,
                                 RemoteException

Throws:: GuestOperationsFault; InvalidState; TaskInProgress; FileFault; RuntimeFault; RemoteException

moveDirectoryInGuest

public void moveDirectoryInGuest(GuestAuthentication auth,
                                 String srcDirectoryPath,
                                 String dstDirectoryPath)
                          throws GuestOperationsFault,
                                 InvalidState,
                                 TaskInProgress,
                                 FileFault,
                                 RuntimeFault,
                                 RemoteException

Throws:: GuestOperationsFault; InvalidState; TaskInProgress; FileFault; RuntimeFault; RemoteException

moveFileInGuest

public void moveFileInGuest(GuestAuthentication auth,
                            String srcFilePath,
                            String dstFilePath,
                            boolean overwrite)
                     throws GuestOperationsFault,
                            InvalidState,
                            TaskInProgress,
                            FileFault,
                            RuntimeFault,
                            RemoteException

Throws:: GuestOperationsFault; InvalidState; TaskInProgress; FileFault; RuntimeFault; RemoteException