| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestFileManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Since vSphere API 5.0 |
auth P | GuestAuthentication |
Since vSphere API 5.0 |
guestFilePath P | xsd:string |
Since vSphere API 5.0 |
fileAttributes P | GuestFileAttributes |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
FileFault | |
GuestOperationsFault | |
InvalidState | |
RuntimeFault | Thrown 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestFileManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Since vSphere API 5.0 |
auth P | GuestAuthentication |
Since vSphere API 5.0 |
prefix P | xsd:string |
Since vSphere API 5.0 |
suffix P | xsd:string |
Since vSphere API 5.0 |
directoryPath* P | xsd:string |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
xsd:string |
Faults
Type | Description |
---|---|
FileFault | |
GuestOperationsFault | |
InvalidState | |
RuntimeFault | Thrown 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestFileManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Since vSphere API 5.0 |
auth P | GuestAuthentication |
Since vSphere API 5.0 |
prefix P | xsd:string |
Since vSphere API 5.0 |
suffix P | xsd:string |
Since vSphere API 5.0 |
directoryPath* P | xsd:string |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
xsd:string |
Faults
Type | Description |
---|---|
FileFault | |
GuestOperationsFault | |
InvalidState | |
RuntimeFault | Thrown 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestFileManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Since vSphere API 5.0 |
auth P | GuestAuthentication |
Since vSphere API 5.0 |
directoryPath P | xsd:string |
Since vSphere API 5.0 |
recursive P | xsd:boolean |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
FileFault | |
GuestOperationsFault | |
InvalidState | |
RuntimeFault | Thrown 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestFileManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Since vSphere API 5.0 |
auth P | GuestAuthentication |
Since vSphere API 5.0 |
filePath P | xsd:string |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
FileFault | |
GuestOperationsFault | |
InvalidState | |
RuntimeFault | Thrown 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestFileManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Since vSphere API 5.0 |
auth P | GuestAuthentication |
Since vSphere API 5.0 |
guestFilePath P | xsd:string |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
FileTransferInformation |
Faults
Type | Description |
---|---|
FileFault | |
GuestOperationsFault | |
InvalidState | |
RuntimeFault | Thrown 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestFileManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Since vSphere API 5.0 |
auth P | GuestAuthentication |
Since vSphere API 5.0 |
guestFilePath P | xsd:string |
Since vSphere API 5.0 |
fileAttributes P | GuestFileAttributes |
Since vSphere API 5.0 |
fileSize P | xsd:long |
Since vSphere API 5.0 |
overwrite P | xsd:boolean |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
xsd:string |
Faults
Type | Description |
---|---|
FileFault | |
GuestOperationsFault | |
InvalidState | |
RuntimeFault | Thrown 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestFileManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Since vSphere API 5.0 |
auth P | GuestAuthentication |
Since vSphere API 5.0 |
filePath P | xsd:string |
Since vSphere API 5.0 |
index* P | xsd:int |
Since vSphere API 5.0 |
maxResults* P | xsd:int |
Since vSphere API 5.0 |
matchPattern* P | xsd:string |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
GuestListFileInfo |
Faults
Type | Description |
---|---|
FileFault | |
GuestOperationsFault | |
InvalidState | |
RuntimeFault | Thrown 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestFileManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Since vSphere API 5.0 |
auth P | GuestAuthentication |
Since vSphere API 5.0 |
directoryPath P | xsd:string |
Since vSphere API 5.0 |
createParentDirectories P | xsd:boolean |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
FileFault | |
GuestOperationsFault | |
InvalidState | |
RuntimeFault | Thrown 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestFileManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Since vSphere API 5.0 |
auth P | GuestAuthentication |
Since vSphere API 5.0 |
srcDirectoryPath P | xsd:string |
Since vSphere API 5.0 |
dstDirectoryPath P | xsd:string |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
FileFault | |
GuestOperationsFault | |
InvalidState | |
RuntimeFault | Thrown 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the GuestFileManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
Since vSphere API 5.0 |
auth P | GuestAuthentication |
Since vSphere API 5.0 |
srcFilePath P | xsd:string |
Since vSphere API 5.0 |
dstFilePath P | xsd:string |
Since vSphere API 5.0 |
overwrite P | xsd:boolean |
Since vSphere API 5.0 |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
FileFault | |
GuestOperationsFault | |
InvalidState | |
RuntimeFault | Thrown 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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |