REST API - stop

vcenter vm power: stop

Powers off a powered-on or suspended virtual machine.

Request:

HTTP request

POST https://{server}/rest/vcenter/vm/{vm}/power/stop

Path Parameters

Name Type Description
Required
vm string Virtual machine identifier.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
404 not_found if the virtual machine is not found.
400 already_in_desired_state if the virtual machine is already powered off.
500 resource_busy if the virtual machine is performing another operation.
503 service_unavailable if the system is unable to communicate with a service to complete the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user doesn't have the required privileges.