Using Workstation REST API Service to Manage Power Options of Encrypted Virtual Machines

You can power on, power off, suspend, pause, unpause, or retrieve the state of an encrypted virtual machine using the REST API service.

Note: To view the Workstation Player API online, search VMware API Explorer for the appropriate version of the Workstation Player API.

Prerequisites

You must perform the following steps before using the Workstation Player REST API services:

• Connect to the IP address from which you can access the HTTP/HTTPS services of Workstation Player REST API. The default IP address is 127.0.0.1:8697.
• Authenticate using the credentials you configured for the API service.

For more information on how to set the credentials for the Workstation Player REST API service, see

Procedure

1. After you log in to the Workstation Player API service page, click VM Power Management from the list of API services.
2. To retrieve the power state of the encrypted virtual machine, click the GET operation, and then perform the following steps:
   1. Under the Parameters section, enter the ID and the encryption password of the virtual machine.
   2. Click Try it Out!
      The Workstation Player REST API service returns the power state of the encrypted virtual machine.
3. To manage the power options of the encrypted virtual machine, click the PUT operation, and then perform the following steps:
   1. Under the Parameters section, enter the ID and the encryption password of the virtual machine.
   2. Enter one of the following options in the operation field:
      • on
      • off
      • shutdown
      • suspend
      • pause
      • unpause
   1. Click Try it Out!
      The Workstation Player REST API service performs the operation you choose for the encrypted virtual machine.