Managed Object - GuestFileManager

Property of
GuestOperationsManager
See also
FileTransferInformation, GuestAuthentication, GuestFileAttributes, GuestListFileInfo, VirtualMachine
Since
vSphere API 5.0


Managed Object Description

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
ChangeFileAttributesInGuest, CreateTemporaryDirectoryInGuest, CreateTemporaryFileInGuest, DeleteDirectoryInGuest, DeleteFileInGuest, InitiateFileTransferFromGuest, InitiateFileTransferToGuest, ListFilesInGuest, MakeDirectoryInGuest, MoveDirectoryInGuest, MoveFileInGuest

ChangeFileAttributesInGuest

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GuestFileManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 5.0
auth PGuestAuthentication

Since vSphere API 5.0
guestFilePath Pxsd:string

Since vSphere API 5.0
fileAttributes PGuestFileAttributes

Since vSphere API 5.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
FileFault
GuestOperationsFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



CreateTemporaryDirectoryInGuest

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GuestFileManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 5.0
auth PGuestAuthentication

Since vSphere API 5.0
prefix Pxsd:string

Since vSphere API 5.0
suffix Pxsd:string

Since vSphere API 5.0
directoryPath* Pxsd:string

Since vSphere API 5.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:string

Faults

Type Description
FileFault
GuestOperationsFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



CreateTemporaryFileInGuest

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GuestFileManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 5.0
auth PGuestAuthentication

Since vSphere API 5.0
prefix Pxsd:string

Since vSphere API 5.0
suffix Pxsd:string

Since vSphere API 5.0
directoryPath* Pxsd:string

Since vSphere API 5.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:string

Faults

Type Description
FileFault
GuestOperationsFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



DeleteDirectoryInGuest

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GuestFileManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 5.0
auth PGuestAuthentication

Since vSphere API 5.0
directoryPath Pxsd:string

Since vSphere API 5.0
recursive Pxsd:boolean

Since vSphere API 5.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
FileFault
GuestOperationsFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



DeleteFileInGuest

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GuestFileManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 5.0
auth PGuestAuthentication

Since vSphere API 5.0
filePath Pxsd:string

Since vSphere API 5.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
FileFault
GuestOperationsFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



InitiateFileTransferFromGuest

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GuestFileManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 5.0
auth PGuestAuthentication

Since vSphere API 5.0
guestFilePath Pxsd:string

Since vSphere API 5.0
PRequired privilege - see tooltip for details

Return Value

Type Description
FileTransferInformation

Faults

Type Description
FileFault
GuestOperationsFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



InitiateFileTransferToGuest

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GuestFileManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 5.0
auth PGuestAuthentication

Since vSphere API 5.0
guestFilePath Pxsd:string

Since vSphere API 5.0
fileAttributes PGuestFileAttributes

Since vSphere API 5.0
fileSize Pxsd:long

Since vSphere API 5.0
overwrite Pxsd:boolean

Since vSphere API 5.0
PRequired privilege - see tooltip for details

Return Value

Type Description
xsd:string

Faults

Type Description
FileFault
GuestOperationsFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



ListFilesInGuest

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GuestFileManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 5.0
auth PGuestAuthentication

Since vSphere API 5.0
filePath Pxsd:string

Since vSphere API 5.0
index* Pxsd:int

Since vSphere API 5.0
maxResults* Pxsd:int

Since vSphere API 5.0
matchPattern* Pxsd:string

Since vSphere API 5.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
GuestListFileInfo

Faults

Type Description
FileFault
GuestOperationsFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



MakeDirectoryInGuest

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GuestFileManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 5.0
auth PGuestAuthentication

Since vSphere API 5.0
directoryPath Pxsd:string

Since vSphere API 5.0
createParentDirectories Pxsd:boolean

Since vSphere API 5.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
FileFault
GuestOperationsFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



MoveDirectoryInGuest

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GuestFileManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 5.0
auth PGuestAuthentication

Since vSphere API 5.0
srcDirectoryPath Pxsd:string

Since vSphere API 5.0
dstDirectoryPath Pxsd:string

Since vSphere API 5.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
FileFault
GuestOperationsFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



MoveFileInGuest

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the GuestFileManager used to make the method call.
vm PManagedObjectReference
to a VirtualMachine

Since vSphere API 5.0
auth PGuestAuthentication

Since vSphere API 5.0
srcFilePath Pxsd:string

Since vSphere API 5.0
dstFilePath Pxsd:string

Since vSphere API 5.0
overwrite Pxsd:boolean

Since vSphere API 5.0
PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
FileFault
GuestOperationsFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None