Vcenter Vm Guest Filesystem Files move

Renames a file in the guest.

This operation was added in vSphere API 7.0.2.0.

Returns an authorization error 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

URI

POST

https://{api_host}/api/vcenter/vm/{vm}/guest/filesystem/files?action=move

COPY

Path Parameters

string

Required

Virtual Machine to perform the operation on.

The parameter must be an identifier for the resource type: VirtualMachine.

Request Body

Request body for invoking operation: move

Show optional properties

{
    "credentials": {
        "interactive_session": false,
        "type": "string"
    },
    "path": "string",
    "new_path": "string"
}

{
    "credentials": {
        "interactive_session": false,
        "type": "string",
        "user_name": "string",
        "password": "string",
        "saml_token": "string"
    },
    "path": "string",
    "new_path": "string",
    "overwrite": false
}

Vcenter Vm Guest Credentials

credentials

Required

The Vcenter Vm Guest Credentials schema defines the guest credentials used for guest operation authentication.

This schema was added in vSphere API 7.0.2.0.

string

path

Required

The complete path to the original file or symbolic link to be moved.

string

new_path

Required

The complete path to the new file. It cannot be a path to an existing directory.

boolean

overwrite

Optional

If true, the destination file is overwritten.

If missing or null, the destination file is not overwritten.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

204

Success!

Operation doesn't return any data structure

400

Vapi Std Errors AlreadyExists if the newPath already exists and overwrite is false.

Vapi Std Errors InvalidArgument:

if path is not a file. The value of Vapi Std Errors Error.data will contain all the properties defined in the Vcenter Vm Guest Filesystem FileErrorDetails providing additional information about the failure.
if path is too long. The value of Vapi Std Errors Error.data will contain all the properties defined in the Vcenter Vm Guest Filesystem FileErrorDetails providing additional information about the failure.
if newPath is too long. The value of Vapi Std Errors Error.data will contain all the properties defined in the Vcenter Vm Guest Filesystem FileErrorDetails providing additional information about the failure.

Vapi Std Errors NotAllowedInCurrentState if the virtual machine not running.

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.

Returns Vapi Std Errors Error of type(s) application/json

"Vapi Std Errors Error Object"

array of object

messages

Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string

error_type

Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.

401

if the credentials object was not valid.

Returns Vapi Std Errors Unauthenticated of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0

"Vapi Std Errors Unauthenticated Object"

string

challenge

Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

403

if a path cannot be accessed.

if a path cannot be renamed because the guest authentication will not allow the operation.

Returns Vapi Std Errors Unauthorized of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthorized0

"Vapi Std Errors Unauthorized Object"

404

if the virtual machine is not found.

if path does not exist. The value of Vapi Std Errors Error.data will contain all the properties defined in the Vcenter Vm Guest Filesystem FileErrorDetails providing additional information about the failure.

if the parent directory of newPath does not exist. The value of Vapi Std Errors Error.data will contain all the properties defined in the Vcenter Vm Guest Filesystem FileErrorDetails providing additional information about the failure.

Returns Vapi Std Errors NotFound of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors NotFound0

"Vapi Std Errors NotFound Object"

500

if the virtual machine is busy.

Returns Vapi Std Errors ResourceBusy of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors ResourceBusy0

"Vapi Std Errors ResourceBusy Object"

503

if the VMware Tools is not running.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0

"Vapi Std Errors ServiceUnavailable Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"credentials:"object","new_path:"string","path:"string"}' https://{api_host}/api/vcenter/vm/{vm}/guest/filesystem/files?action=move

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Vcenter Operations

POST

Vcenter Vm Guest Filesystem Files move