Search
Plugins > vCenter Server 5.5.3 > VcGuestFileManager > initiateFileTransferToGuest

Method initiateFileTransferToGuest(VcVirtualMachine vm, VcGuestAuthentication auth, String guestFilePath, VcGuestFileAttributes fileAttributes, Number fileSize, boolean overwrite)

Initiates an operation to transfer a file to the guest.

Obtains a URL to the file inside the guest to be transferred from the client. The user should send a HTTP PUT request specifying the file content in the body of the request. Multiple PUT request cannot be sent to the URL simultaneously. URL will be invalidated after a successful PUT request is sent. If the power state of the Virtual Machine is changed when the file transfer is in progress, or the Virtual Machine is migrated, then the transfer operation is aborted.

In order to ensure a secure connection to the host when transferring a file using HTTPS, the X.509 certificate for the host must be used to authenticate the remote end of the connection. The certificate of the host that the virtual machine is running on can be retrieved using the following fields: vm (VcVirtualMachine) -> runtime (VcVirtualMachineRuntimeInfo) -> host (VcHostSystem) -> config (VcHostConfigInfo) -> certificate.

Returns

String

Arguments

Name Type Description
vm VcVirtualMachine Virtual Machine to perform the operation on.
auth VcGuestAuthentication The guest authentication data. See <a href="VcGuestAuthentication.html">VcGuestAuthentication</a>.
guestFilePath String The complete destination path in the guest to transfer the file from the client. It cannot be a path to a directory or a symbolic link.
fileAttributes VcGuestFileAttributes File attributes of the file that has to be created in the guest. See <a href="VcGuestFileAttributes.html">VcGuestFileAttributes</a>. If any file attribute is not specified, then the default value of that property will be set for the file.
fileSize Number Size of the file to transfer to the guest in bytes.
overwrite boolean If set, the destination file is clobbered.