/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 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 GET 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/8adc20e6-687b-4246-a470-be4a171ebd98'

GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/8adc20e6-687b-4246-a470-be4a171ebd98 HTTP/1.1



HTTP/1.1 200
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/{node_id}

{
    "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/8adc20e6-687b-4246-a470-be4a171ebd98",
    "node_id": "8adc20e6-687b-4246-a470-be4a171ebd98",
    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
    "startup_script": null,
    "startup_script_path": null,
    "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
name ['string', 'null'] VPCS VM name
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 PUT 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/550cc2b9-d124-467d-9407-3754c6bc287d' -d '{"console": 5006, "name": "test"}'

PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/550cc2b9-d124-467d-9407-3754c6bc287d HTTP/1.1
{
    "console": 5006,
    "name": "test"
}


HTTP/1.1 200
Connection: close
Content-Length: 484
Content-Type: application/json
Date: Tue, 21 Mar 2017 09:31:55 GMT
Server: Python/3.6 GNS3/2.0.0dev11
X-Route: /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}

{
    "command_line": "",
    "console": 5006,
    "console_type": "telnet",
    "name": "test",
    "node_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp0ha7d1aj/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/550cc2b9-d124-467d-9407-3754c6bc287d",
    "node_id": "550cc2b9-d124-467d-9407-3754c6bc287d",
    "project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
    "startup_script": null,
    "startup_script_path": null,
    "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/07f5aea7-ca70-4efb-b103-1033630ca889'

DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/07f5aea7-ca70-4efb-b103-1033630ca889 HTTP/1.1



HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Tue, 21 Mar 2017 09:31:55 GMT
Server: Python/3.6 GNS3/2.0.0dev11
X-Route: /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}