gns3-server/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeid.rst
Julien Duponchelle b5cb625169
Rebuild doc
2016-07-14 15:33:09 +02:00

7.1 KiB

/v2/compute/projects/{project_id}/vpcs/nodes/{node_id}

GET /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}

Get a VPCS instance

Parameters

  • node_id: Node UUID
  • project_id: Project 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
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

../../../examples/compute_get_projectsprojectidvpcsnodesnodeid.txt

PUT /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}

Update a VPCS instance

Parameters

  • node_id: Node UUID
  • project_id: Project 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
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

../../../examples/compute_put_projectsprojectidvpcsnodesnodeid.txt

DELETE /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}

Delete a VPCS instance

Parameters

  • node_id: Node UUID
  • project_id: Project UUID

Response status codes

  • 400: Invalid request
  • 404: Instance doesn't exist
  • 204: Instance deleted

Sample session

../../../examples/compute_delete_projectsprojectidvpcsnodesnodeid.txt