Vcenter Vm Guest Filesystem Transfers create
Initiates an operation to transfer a file to or from the guest.
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.
When transferring a file into the guest and overwriting an existing file, the old file attributes are not preserved.
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: XXX insert link to certificate in Host config XXX
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
VirtualMachinereferenced by the parameter vm requiresVirtualMachine.GuestOperations.Modify.
Virtual Machine to perform the operation on.
The parameter must be an identifier for the resource type: VirtualMachine.
Request body for invoking operation: create
Show optional properties
{
"credentials": {
"interactive_session": false,
"type": "string"
},
"spec": "Vcenter Vm Guest Filesystem Transfers CreateSpec Object"
}{
"credentials": {
"interactive_session": false,
"type": "string",
"user_name": "string",
"password": "string",
"saml_token": "string"
},
"spec": "Vcenter Vm Guest Filesystem Transfers CreateSpec Object"
}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.
The Vcenter Vm Guest Filesystem Transfers CreateSpec schema describes the details of a file transfer operation.
This schema was added in vSphere API 7.0.2.0.
The URL to which the user has to send an HTTP request. The URL will become invalid once a successful request is sent. If the file is being transferred from the guest, an HTTP GET should be used. If the file is being transferred to the guest, HTTP PUT should be used.
The URL is valid only for 10 minutes from the time it is generated. The URL becomes invalid whenever the virtual machine is powered off, suspended, unregistered or migrated to a new host. The host part of the URL is returned as * if the hostname to be used is the name of the server to which the call was made. For example, if the call is made to esx-svr-1.domain1.com, and the file is available for download from https://esx-svr-1.domain1.com/guestFile?id=1&token=1234, the URL returned may be https://*/guestFile?id=1&token=1234. The client replaces the asterisk with the server name on which it invoked the call.
Vapi Std Errors AlreadyExists if Vcenter Vm Guest Filesystem Transfers CreateSpec.path in spec exists and Vcenter Vm Guest Filesystem Transfers FileCreationAttributes.overwrite is false when transferring a file to the guest.
Vapi Std Errors InvalidArgument:
- if Vcenter Vm Guest Filesystem Transfers CreateSpec.path in spec 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 Vcenter Vm Guest Filesystem Transfers CreateSpec.path in spec 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 is not running.
Vapi Std Errors Unsupported:
- if the operation is not supported by the VMware Tools in the guest OS.
- if the operation is disabled by the VMware Tools in the guest OS.
"Vapi Std Errors Error Object"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.
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.
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.
if the credentials object was not valid.
"Vapi Std Errors Unauthenticated Object"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.
if Vcenter Vm Guest Filesystem Transfers CreateSpec.path in spec cannot be accessed.
if Vcenter Vm Guest Filesystem Transfers CreateSpec.path in spec cannot be copied because the guest authentication will not allow the operation.
"Vapi Std Errors Unauthorized Object"if the virtual machine is not found.
if Vcenter Vm Guest Filesystem Transfers CreateSpec.path in spec is not found. 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 NotFound Object"Vapi Std Errors ResourceBusy if the virtual machine is busy.
Vapi Std Errors UnableToAllocateResource if is insuffcient space for the new file when transferring a file to the guest.
"Vapi Std Errors Error Object"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.
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.
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.
if the VMware Tools is not running.
"Vapi Std Errors ServiceUnavailable Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"credentials:"object","spec":"{}"}' https://{api_host}/api/vcenter/vm/{vm}/guest/filesystem?action=create