Create Temporary Guest Filesystem Files
Creates a temporary file. Creates a new unique temporary file for the user to use as needed. The user is responsible for removing it when it is no longer needed.
The new file name will be created in a guest-specific format using prefix, a guest generated string and suffix in parentPath.
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=createTemporary
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
VmGuestFilesystemFilesCreateTemporaryRequestBody 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"
},
"prefix": "string",
"suffix": "string"
}
string
prefix
Required
The prefix to be given to the new temporary file.
string
suffix
Required
The suffix to be given to the new temporary file.
string
parent_path
Optional
The complete path to the directory in which to create the file. Directory to use if specified, otherwise a guest-specific default will be used.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
string
of type application/json
The absolute path of the temporary file that is created.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if parentPath is set and is not a directory. 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 parentPath 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 is 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 parentPath cannot be accessed. if a file cannot be created because the guest authentication will not allow the operation.
404
com.vmware.vapi.std.errors.not_found : if parentPath is set and 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 virtual machine is not found.
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"
$VmGuestFilesystemFilesCreateTemporaryRequestBody = Initialize-VmGuestFilesystemFilesCreateTemporaryRequestBody -Credentials $VmGuestCredentials -Prefix "MyPrefix" -Suffix "MySuffix"
Invoke-CreateTemporaryVmFilesystemFiles -Vm "MyVm" -VmGuestFilesystemFilesCreateTemporaryRequestBody $VmGuestFilesystemFilesCreateTemporaryRequestBody
PowerCLI Client SDK All Parameters Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD" -UserName "MyUserName" -Password "MyPassword" -SamlToken "MySamlToken"
$VmGuestFilesystemFilesCreateTemporaryRequestBody = Initialize-VmGuestFilesystemFilesCreateTemporaryRequestBody -Credentials $VmGuestCredentials -Prefix "MyPrefix" -Suffix "MySuffix" -ParentPath "MyParentPath"
Invoke-CreateTemporaryVmFilesystemFiles -Vm "MyVm" -VmGuestFilesystemFilesCreateTemporaryRequestBody $VmGuestFilesystemFilesCreateTemporaryRequestBody
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"},"parent_path":"string","prefix":"string","suffix":"string"}' https://{api_host}/api/vcenter/vm/{vm}/guest/filesystem/files?action=createTemporary
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create_temporary
Availability
Added in 7.0.2.0
