/v1/projects/{project_id}/vpcs/vms¶
Contents
POST /v1/projects/{project_id}/vpcs/vms¶
Create a new VPCS instance
Parameters¶
- project_id: UUID for the project
Response status codes¶
- 400: Invalid request
- 201: Instance created
- 409: Conflict
Input¶
Name | Mandatory | Type | Description |
---|---|---|---|
console | ['integer', 'null'] | console TCP port | |
name | ✔ | string | VPCS VM name |
startup_script | ['string', 'null'] | Content of the VPCS startup script | |
vm_id | VPCS VM identifier |
Output¶
Name | Mandatory | Type | Description |
---|---|---|---|
console | ✔ | integer | console TCP port |
name | ✔ | string | VPCS VM name |
project_id | ✔ | string | Project UUID |
startup_script | ['string', 'null'] | Content of the VPCS startup script | |
startup_script_path | ✔ | ['string', 'null'] | Path of the VPCS startup script relative to project directory |
status | ✔ | enum | Possible values: started, stopped |
vm_directory | string | ||
vm_id | ✔ | string | VPCS VM UUID |
Sample session¶
curl -i -X POST 'http://localhost:8000/v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms' -d '{"name": "PC TEST 1"}'
POST /v1/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms HTTP/1.1
{
"name": "PC TEST 1"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONNECTION: keep-alive
CONTENT-LENGTH: 422
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.4.0dev13
X-ROUTE: /v1/projects/{project_id}/vpcs/vms
{
"console": 2010,
"name": "PC TEST 1",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"startup_script": null,
"startup_script_path": null,
"status": "stopped",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpqqnauky9/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/d1808514-893b-4aa5-86c2-c4dea88ff895",
"vm_id": "d1808514-893b-4aa5-86c2-c4dea88ff895"
}