Create Guest Processes
Starts a program in the guest operating system. A process started this way can have its status queried with Processes.list or Processes.get. When the process completes, its exit code and end time will be available for 5 minutes after completion.
if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.GuestOperations.Execute.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/guest/processes?action=create
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
VmGuestProcessesCreateRequestBody 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"
},
"spec": {
"path": "string"
}
}
credentials
Required
The guest authentication data. See Credentials. The program will be run as the user associated with this data.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
integer
formatted as int64
of type application/json
The process id of the program started.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the Processes.CreateSpec.start-minimized field is set and the guest is not a Windows operating system. if the program path is not a valid path. 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 working directory is not a valid 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. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine vm is not running. | com.vmware.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.
403
com.vmware.vapi.std.errors.unauthorized : if the path field of spec cannot be accessed. if the path field of spec cannot be run because credentials will not allow the operation.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine vm is not found. if the program 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.
500
com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy. | com.vmware.vapi.std.errors.unable_to_allocate_resource : if the program fails to start.
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"
$VmGuestProcessesCreateSpec = Initialize-VmGuestProcessesCreateSpec -Path "MyPath"
$VmGuestProcessesCreateRequestBody = Initialize-VmGuestProcessesCreateRequestBody -Credentials $VmGuestCredentials -Spec $VmGuestProcessesCreateSpec
Invoke-CreateVmGuestProcesses -Vm "MyVm" -VmGuestProcessesCreateRequestBody $VmGuestProcessesCreateRequestBody
PowerCLI Client SDK All Parameters Example
$VmGuestCredentials = Initialize-VmGuestCredentials -InteractiveSession $false -Type "USERNAME_PASSWORD" -UserName "MyUserName" -Password "MyPassword" -SamlToken "MySamlToken"
$VmGuestProcessesCreateSpec = Initialize-VmGuestProcessesCreateSpec -Path "MyPath" -Arguments "MyArguments" -WorkingDirectory "MyWorkingDirectory" -EnvironmentVariables @{ key_example = "MyInner" } -StartMinimized $false
$VmGuestProcessesCreateRequestBody = Initialize-VmGuestProcessesCreateRequestBody -Credentials $VmGuestCredentials -Spec $VmGuestProcessesCreateSpec
Invoke-CreateVmGuestProcesses -Vm "MyVm" -VmGuestProcessesCreateRequestBody $VmGuestProcessesCreateRequestBody
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"},"spec":{"arguments":"string","environment_variables":{"key":"string"},"path":"string","start_minimized":false,"working_directory":"string"}}' https://{api_host}/api/vcenter/vm/{vm}/guest/processes?action=create
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create
Availability
Added in 7.0.2.0
On This Page
Guest Processes Operations
post
post
