Change Power State
Changes the VM power state
Request
URI
PUT
https://{api_host}/api/vms/{id}/power
COPY
Path Parameters
string
id
Required
ID of VM
Request Body
VM power operation: on, off, shutdown, suspend
string
of type(s)
application/vnd.vmware.vmw.rest-v1+json
Required
Responses
200
VM power state
Returns
VMPowerState
of type(s)
application/vnd.vmware.vmw.rest-v1+json
"VMPowerState Object"
string
power_state
Required
power_state
Possible values are :
poweredOn,
poweredOff,
suspended,
400
Invalid parameters
Returns
ErrorModel
of type(s)
application/vnd.vmware.vmw.rest-v1+json
"ErrorModel Object"
integer As int32
As int32
code
Required
code
string
message
Required
message
401
Authentication failed
Returns
ErrorModel
of type(s)
application/vnd.vmware.vmw.rest-v1+json
"ErrorModel Object"
integer As int32
As int32
code
Required
code
string
message
Required
message
403
Permission denied
Returns
ErrorModel
of type(s)
application/vnd.vmware.vmw.rest-v1+json
"ErrorModel Object"
integer As int32
As int32
code
Required
code
string
message
Required
message
404
No such resource
Returns
ErrorModel
of type(s)
application/vnd.vmware.vmw.rest-v1+json
"ErrorModel Object"
integer As int32
As int32
code
Required
code
string
message
Required
message
406
Content type was not supported
Returns
ErrorModel
of type(s)
application/vnd.vmware.vmw.rest-v1+json
"ErrorModel Object"
integer As int32
As int32
code
Required
code
string
message
Required
message
409
Resource state conflicts
Returns
ErrorModel
of type(s)
application/vnd.vmware.vmw.rest-v1+json
"ErrorModel Object"
integer As int32
As int32
code
Required
code
string
message
Required
message
500
Server error
Returns
ErrorModel
of type(s)
application/vnd.vmware.vmw.rest-v1+json
"ErrorModel Object"
integer As int32
As int32
code
Required
code
string
message
Required
message
default
Unexpected error
Returns
ErrorModel
of type(s)
application/vnd.vmware.vmw.rest-v1+json
"ErrorModel Object"
integer As int32
As int32
code
Required
code
string
message
Required
message
Code Samples
COPY
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/vnd.vmware.vmw.rest-v1+json' -d '[{}]' https://{api_host}/api/vms/{id}/power