/v2/compute/projects/{project_id}/vpcs/nodes¶
Contents
POST /v2/compute/projects/{project_id}/vpcs/nodes¶
Create a new VPCS instance
Parameters¶
- project_id: Project UUID
Response status codes¶
- 201: Instance created
- 400: Invalid request
- 409: Conflict
Input¶
Name | Mandatory | Type | Description |
---|---|---|---|
console | ['integer', 'null'] | Console TCP port | |
console_type | enum | Possible values: telnet | |
name | ✔ | string | VPCS VM name |
node_id | Node 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 (IGNORED) |
Output¶
Name | Mandatory | Type | Description |
---|---|---|---|
command_line | ✔ | string | Last command line used by GNS3 to start QEMU |
console | ✔ | integer | Console TCP port |
console_type | ✔ | enum | Possible values: telnet |
name | ✔ | string | VPCS VM name |
node_directory | string | Path to the VM working directory | |
node_id | ✔ | string | Node UUID |
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, suspended |
Sample session¶
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes' -d '{"name": "PC TEST 1"}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes HTTP/1.1
{
"name": "PC TEST 1"
}
HTTP/1.1 201
Connection: close
Content-Length: 489
Content-Type: application/json
Date: Tue, 21 Mar 2017 09:31:53 GMT
Server: Python/3.6 GNS3/2.0.0dev11
X-Route: /v2/compute/projects/{project_id}/vpcs/nodes
{
"command_line": "",
"console": 5004,
"console_type": "telnet",
"name": "PC TEST 1",
"node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp0ha7d1aj/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/54184038-3552-4386-8a8d-7c13080fae06",
"node_id": "54184038-3552-4386-8a8d-7c13080fae06",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"startup_script": null,
"startup_script_path": null,
"status": "stopped"
}