<back to all web services
PowerCompute
Manage vApp and VM Power actions.
The following routes are available for this service:| POST | /compute/{id}/power/action/{powerStatus} | Change power status a vApp or VM. | |
|---|
PowerCompute Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| userId | body | string | No | |
| typeComputeObject | body | TypeComputeObject | No | Allowable Values |
| datacenterCode | body | DatacenterLocations | No | Allowable Values- ACD
- GMU
- SPA
- LAS
- DEV
- VCD
- AWS
- GCP
- UAT
- AZU
- CNW
- AUV
- ATL
- EXT
|
| app | body | App | No | Allowable Values- Acronis
- AcronisSCS
- Actifio
- AWSEC2
- Billing
- ChargebackManager
- GoogleCloudPlatform
- N3TLoginPortal
- Onboarding
- vCloudDirector
- Zerto
- ZertoCloudManager
- MicrosoftAzure
- ConnectWise
- Auvik
- Veeam
- VROPSMetering
- Keycloak
- N3tApi
|
| id | path | string | No | |
| powerStatus | path | PowerStatus | No | Allowable Values- OFF
- ON
- SHUTDOWN
- SUSPEND
- RESTART
- RESUME
|
| zone | body | string | No | |
| project | body | string | No | |
| sessionId | body | string | No | |
TypeComputeObject Enum:| vm | |
| vapp | |
| vdc | |
| template | |
DatacenterLocations Enum:| ACD | |
| GMU | |
| SPA | |
| LAS | |
| DEV | |
| VCD | |
| AWS | |
| GCP | |
| UAT | |
| AZU | |
| CNW | |
| AUV | |
| ATL | |
| EXT | |
App Enum:| Acronis | |
| AcronisSCS | |
| Actifio | |
| AWSEC2 | |
| Billing | |
| ChargebackManager | |
| GoogleCloudPlatform | |
| N3TLoginPortal | |
| Onboarding | |
| vCloudDirector | |
| Zerto | |
| ZertoCloudManager | |
| MicrosoftAzure | |
| ConnectWise | |
| Auvik | |
| Veeam | |
| VROPSMetering | |
| Keycloak | |
| N3tApi | |
PowerStatus Enum:| Name | Value | |
|---|
| OFF | 0 | |
| ON | 1 | |
| SHUTDOWN | 3 | |
| SUSPEND | 4 | |
| RESTART | 5 | |
| RESUME | 6 | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /compute/{id}/power/action/{powerStatus} HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PowerCompute xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services.DTO">
<app>Acronis</app>
<datacenterCode>ACD</datacenterCode>
<id>String</id>
<powerStatus>OFF</powerStatus>
<project>String</project>
<sessionId>String</sessionId>
<typeComputeObject>vm</typeComputeObject>
<userId>String</userId>
<zone>String</zone>
</PowerCompute>