Guest File Manager Create Temporary File In Guest

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.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/GuestFileManager/{moId}/CreateTemporaryFileInGuest

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case GuestFileManager/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body

CreateTemporaryFileInGuestRequestType of type(s) application/json

Required

{
    "vm": {
        "type": "string",
        "value": "string"
    },
    "auth": {
        "interactiveSession": false
    },
    "prefix": "string",
    "suffix": "string",
    "directoryPath": "string"
}

MoRefVirtualMachine

Required

Reference to an instance of the VirtualMachine managed object.

GuestAuthentication

auth

Required

GuestAuthentication is an abstract base class for authentication in the guest.

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

directoryPath

Optional

The complete path to the directory in which to create the file. If unset, or an empty string, a guest-specific location will be used.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The absolute path of the temporary file that is created.

Returns string of type(s) application/json

Operation doesn't return any data structure

500

GuestOperationsFault: if there is an error processing a guest operation.

GuestOperationsUnavailable: if the VM agent for guest operations is not running.

InvalidPowerState: if the VM is not powered on.

InvalidState: if the operation cannot be performed because of the virtual machine's current state.

TaskInProgress: if the virtual machine is busy.

GuestPermissionDenied: if the operation fails because the guest authentication will not allow the operation.

InvalidGuestLogin: if the the guest authentication information was not accepted.

FileFault: if there is a file error in the guest operating system.

GuestComponentsOutOfDate: if the guest agent is too old to support the operation.

OperationNotSupportedByGuest: if the operation is not supported by the guest OS.

OperationDisabledByGuest: if the operation is not enabled due to guest agent configuration.

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Guest File Manager Operations

POST

Guest File Manager Change File Attributes In Guest