/v2/compute/projects/{project_id}/vpcs/nodes/{node_id}¶
GET /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}¶
Get a VPCS instance
Parameters¶
project_id: Project UUID
node_id: Node UUID
Response status codes¶
200: Success
400: Invalid request
404: Instance doesn’t exist
Output¶
Name | Mandatory | Type | Description |
---|---|---|---|
command_line | ✔ | string | Last command line used by GNS3 to start VPCS |
console | ✔ | ['integer', 'null'] | Console TCP port |
console_type | ✔ | enum | Possible values: telnet, none |
name | ✔ | string | VPCS VM name |
node_directory | string | Path to the VM working directory | |
node_id | ✔ | string | Node UUID |
project_id | ✔ | string | Project UUID |
status | ✔ | enum | Possible values: started, stopped, suspended |
Sample session¶
curl -i -X GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/aa44ff6f-52fa-4bf9-9b93-2e73c9eb8071'
GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/aa44ff6f-52fa-4bf9-9b93-2e73c9eb8071 HTTP/1.1
HTTP/1.1 200
Connection: close
Content-Length: 384
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:27:47 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}
{
"command_line": "",
"console": 5004,
"console_type": "telnet",
"name": "PC TEST 1",
"node_directory": "/tmp/tmp3gc2avyo/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/aa44ff6f-52fa-4bf9-9b93-2e73c9eb8071",
"node_id": "aa44ff6f-52fa-4bf9-9b93-2e73c9eb8071",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"status": "stopped"
}
PUT /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}¶
Update a VPCS instance
Parameters¶
project_id: Project UUID
node_id: Node UUID
Response status codes¶
200: Instance updated
400: Invalid request
404: Instance doesn’t exist
409: Conflict
Input¶
Name | Mandatory | Type | Description |
---|---|---|---|
console | ['integer', 'null'] | Console TCP port | |
console_type | enum | Possible values: telnet, none | |
name | ['string', 'null'] | VPCS VM name |
Output¶
Name | Mandatory | Type | Description |
---|---|---|---|
command_line | ✔ | string | Last command line used by GNS3 to start VPCS |
console | ✔ | ['integer', 'null'] | Console TCP port |
console_type | ✔ | enum | Possible values: telnet, none |
name | ✔ | string | VPCS VM name |
node_directory | string | Path to the VM working directory | |
node_id | ✔ | string | Node UUID |
project_id | ✔ | string | Project UUID |
status | ✔ | enum | Possible values: started, stopped, suspended |
Sample session¶
curl -i -X PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/bc3d9b26-82b7-411b-8f1c-201c782d08fe' -d '{"console": 5006, "name": "test"}'
PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/bc3d9b26-82b7-411b-8f1c-201c782d08fe HTTP/1.1
{
"console": 5006,
"name": "test"
}
HTTP/1.1 200
Connection: close
Content-Length: 379
Content-Type: application/json
Date: Wed, 08 Jan 2020 02:27:48 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}
{
"command_line": "",
"console": 5006,
"console_type": "telnet",
"name": "test",
"node_directory": "/tmp/tmp3gc2avyo/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/bc3d9b26-82b7-411b-8f1c-201c782d08fe",
"node_id": "bc3d9b26-82b7-411b-8f1c-201c782d08fe",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"status": "stopped"
}
DELETE /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}¶
Delete a VPCS instance
Parameters¶
project_id: Project UUID
node_id: Node UUID
Response status codes¶
204: Instance deleted
400: Invalid request
404: Instance doesn’t exist
Sample session¶
curl -i -X DELETE 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/f84fd457-cc5c-4eb9-88b8-3ac691d1fe52'
DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/f84fd457-cc5c-4eb9-88b8-3ac691d1fe52 HTTP/1.1
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Wed, 08 Jan 2020 02:27:48 GMT
Server: Python/3.6 GNS3/2.2.4dev1
X-Route: /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}