Move Guest Filesystem Files
Renames a file in the guest.
if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Modify.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/filesystem/files?action=move
Path Parameters
Path Parameters
string
vm
Required
Virtual Machine to perform the operation on. The parameter must be an identifier for the resource type: VirtualMachine.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VmGuestFilesystemFilesMoveRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"credentials": {
"interactive_session": false,
"type": "USERNAME_PASSWORD"
},
"new_path": "string",
"path": "string"
}
string
new_path
Required
The complete path to the new file. It cannot be a path to an existing directory.
string
path
Required
The complete path to the original file or symbolic link to be moved.
boolean
overwrite
Optional
If true, the destination file is overwritten. If unset, the destination file is not overwritten.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.already_exists : if the newPath already exists and overwrite is false. | com.vmware.vapi.std.errors.invalid_argument : if path is not a file. The value of com.vmware.vapi.std.errors.Error#data will contain all the fields defined in the FileErrorDetails providing additional information about the failure. if path is too long. The value of com.vmware.vapi.std.errors.Error#data will contain all the fields defined in the FileErrorDetails providing additional information about the failure. if newPath is too long. The value of com.vmware.vapi.std.errors.Error#data will contain all the fields defined in the FileErrorDetails providing additional information about the failure. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine not running. | com.vmware.vapi.std.errors.unsupported : if the operation is not supported by the VMware Tools in the guest operating system. if the operation is disabled by the VMware Tools in the guest operating system.
403
com.vmware.vapi.std.errors.unauthorized : if a path cannot be accessed. if a path cannot be renamed because the guest authentication will not allow the operation.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine is not found. if path does not exist. The value of com.vmware.vapi.std.errors.Error#data will contain all the fields defined in the FileErrorDetails providing additional information about the failure. if the parent directory of newPath does not exist. The value of com.vmware.vapi.std.errors.Error#data will contain all the fields defined in the FileErrorDetails providing additional information about the failure.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD"
$VmGuestFilesystemFilesMoveRequestBody = Initialize-VmGuestFilesystemFilesMoveRequestBody -Credentials $VmGuestCredentials -Path "MyPath" -NewPath "MyNewPath"
Invoke-MoveVmFilesystemFiles -Vm "MyVm" -VmGuestFilesystemFilesMoveRequestBody $VmGuestFilesystemFilesMoveRequestBody
PowerCLI Client SDK All Parameters Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD" -UserName "MyUserName" -Password "MyPassword" -SamlToken "MySamlToken"
$VmGuestFilesystemFilesMoveRequestBody = Initialize-VmGuestFilesystemFilesMoveRequestBody -Credentials $VmGuestCredentials -Path "MyPath" -NewPath "MyNewPath" -Overwrite $false
Invoke-MoveVmFilesystemFiles -Vm "MyVm" -VmGuestFilesystemFilesMoveRequestBody $VmGuestFilesystemFilesMoveRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"credentials":{"interactive_session":false,"password":"string","saml_token":"string","type":"USERNAME_PASSWORD","user_name":"string"},"new_path":"string","overwrite":false,"path":"string"}' https://{api_host}/api/vcenter/vm/{vm}/guest/filesystem/files?action=move
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: move
Availability
Added in 7.0.2.0
