/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 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
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/ba38f0b3-b87d-4f60-a2b8-47fef0cf9ab7'

GET /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/ba38f0b3-b87d-4f60-a2b8-47fef0cf9ab7 HTTP/1.1



HTTP/1.1 200
Connection: close
Content-Length: 428
Content-Type: application/json
Date: Mon, 08 Jan 2018 08:16:11 GMT
Server: Python/3.6 GNS3/2.1.2dev1
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/qy/g6blgc5n7y93pzg61zyt7cmr0000gn/T/tmpk__by17a/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/ba38f0b3-b87d-4f60-a2b8-47fef0cf9ab7",
    "node_id": "ba38f0b3-b87d-4f60-a2b8-47fef0cf9ab7",
    "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
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 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
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/892a8c7f-fd53-4721-a1f8-5fde82beb037' -d '{"console": 5006, "name": "test"}'

PUT /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/892a8c7f-fd53-4721-a1f8-5fde82beb037 HTTP/1.1
{
    "console": 5006,
    "name": "test"
}


HTTP/1.1 200
Connection: close
Content-Length: 423
Content-Type: application/json
Date: Mon, 08 Jan 2018 08:16:11 GMT
Server: Python/3.6 GNS3/2.1.2dev1
X-Route: /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}

{
    "command_line": "",
    "console": 5006,
    "console_type": "telnet",
    "name": "test",
    "node_directory": "/var/folders/qy/g6blgc5n7y93pzg61zyt7cmr0000gn/T/tmpk__by17a/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/892a8c7f-fd53-4721-a1f8-5fde82beb037",
    "node_id": "892a8c7f-fd53-4721-a1f8-5fde82beb037",
    "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/8b556295-efa1-46ae-ad46-8f9e38ed879e'

DELETE /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/8b556295-efa1-46ae-ad46-8f9e38ed879e HTTP/1.1



HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Mon, 08 Jan 2018 08:16:11 GMT
Server: Python/3.6 GNS3/2.1.2dev1
X-Route: /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}