Scripting Object - VcGuestFileManager

Scripting-object corresponding to
GuestFileManager
Attribute of
VcGuestOperationsManager

Scripting Object Description

FileManager is the managed object that provides APIs to manipulate the guest operating system files.

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, changeFileAttributesInGuest, createTemporaryDirectoryInGuest, createTemporaryFileInGuest, createTrigger, deleteDirectoryInGuest, deleteFileInGuest, downloadFile, initiateFileTransferFromGuest, initiateFileTransferToGuest, listFilesInGuest, makeDirectoryInGuest, moveDirectoryInGuest, moveFileInGuest, putFile

listFilesInGuest

Returns information about files or directories in the guest.

The results could be extermely large, so to minimize the size of the return value for cases where a UI only needs to show the first N results, the answer is batched. Files are returned in OS-specific (inode) order. If the directory is modified between queries, missing or duplicate results can occur.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2String

arg3Number

arg4Number

arg5String


Return Value

Type Description
VcGuestListFileInfo

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

changeFileAttributesInGuest

Changes the file attributes of a specified file inside the guest.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2String

arg3VcGuestFileAttributes


Return Value

Type Description
None

createTemporaryDirectoryInGuest

Creates a temporary directory.

Creates a new unique temporary directory for the user to use as needed. The user is responsible for removing it when it is no longer needed.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2String

arg3String

arg4String


Return Value

Type Description
String

deleteDirectoryInGuest

Deletes a directory in the guest OS.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2String

arg3Boolean


Return Value

Type Description
None

makeDirectoryInGuest

Creates a directory in the guest OS

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2String

arg3Boolean


Return Value

Type Description
None

putFile

@since Unknown

Parameters

NameTypeDescription
vcoPathString

uriString


Return Value

Type Description
Boolean

initiateFileTransferFromGuest

@since Unknown

Parameters

NameTypeDescription
vmVcVirtualMachine

authVcGuestAuthentication

guestFilePathString


Return Value

Type Description
VcFileTransferInformation

deleteFileInGuest

Deletes a file in the guest OS

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2String


Return Value

Type Description
None

moveFileInGuest

Renames a file in the guest.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2String

arg3String

arg4Boolean


Return Value

Type Description
None

initiateFileTransferToGuest

@since Unknown

Parameters

NameTypeDescription
vmVcVirtualMachine

authVcGuestAuthentication

guestFilePathString

fileAttributesVcGuestFileAttributes

fileSizeNumber

overwriteBoolean


Return Value

Type Description
String

createTemporaryFileInGuest

Creates a temporary file.

Creates a new unique temporary file for the user to use as needed. The user is responsible for removing it when it is no longer needed.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2String

arg3String

arg4String


Return Value

Type Description
String

downloadFile

@since Unknown

Parameters

NameTypeDescription
vcoPathString

fileTransferInformationVcFileTransferInformation


Return Value

Type Description
Boolean

moveDirectoryInGuest

Moves or renames a directory in the guest.

@since vSphere API 5.0

Parameters

NameTypeDescription
arg0VcVirtualMachine

arg1VcGuestAuthentication

arg2String

arg3String


Return Value

Type Description
None