arno/gns3-server
1
0
Fork 0
mirror of https://github.com/GNS3/gns3-server synced 2024-11-13 20:08:55 +00:00
Code Issues Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
Julien Duponchelle 2016-03-11 15:21:21 +01:00
parent be4aa41dda
commit 7d0b780dcc
No known key found for this signature in database
GPG Key ID: F1E2485547D4595D
135 changed files with 623 additions and 295 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/api/examples/controller_delete_projectsprojectid.txt Normal file
View File

@ -0,0 +1,13 @@
curl -i -X DELETE 'http://localhost:8000/v2/projects/b8b6fbd9-95e2-4efb-8c24-c4233f106bcf'
DELETE /v2/projects/b8b6fbd9-95e2-4efb-8c24-c4233f106bcf HTTP/1.1
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/controller/projects/{project_id}

12
docs/api/examples/controller_post_servers.txt → docs/api/examples/controller_post_hypervisors.txt
View File

@ -1,30 +1,30 @@
curl -i -X POST 'http://localhost:8000/v2/servers' -d '{"host": "example.com", "password": "secure", "port": 84, "protocol": "http", "server_id": "my_server_id", "user": "julien"}'
curl -i -X POST 'http://localhost:8000/v2/hypervisors' -d '{"host": "example.com", "hypervisor_id": "my_hypervisor_id", "password": "secure", "port": 84, "protocol": "http", "user": "julien"}'
POST /v2/servers HTTP/1.1
POST /v2/hypervisors HTTP/1.1
{
"host": "example.com",
"hypervisor_id": "my_hypervisor_id",
"password": "secure",
"port": 84,
"protocol": "http",
"server_id": "my_server_id",
"user": "julien"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 176
CONTENT-LENGTH: 184
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/controller/servers
X-ROUTE: /v2/controller/hypervisors
{
"connected": false,
"host": "example.com",
"hypervisor_id": "my_hypervisor_id",
"port": 84,
"protocol": "http",
"server_id": "my_server_id",
"user": "julien",
"version": "1.5.0dev1"
}

23
docs/api/examples/controller_post_projects.txt Normal file
View File

@ -0,0 +1,23 @@
curl -i -X POST 'http://localhost:8000/v2/projects' -d '{"name": "test", "project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f"}'
POST /v2/projects HTTP/1.1
{
"name": "test",
"project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 122
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/controller/projects
{
"name": "test",
"path": null,
"project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f",
"temporary": false
}

13
docs/api/examples/controller_post_projectsprojectidclose.txt Normal file
View File

@ -0,0 +1,13 @@
curl -i -X POST 'http://localhost:8000/v2/projects/d290ff87-4145-401f-aa94-7ac637aa4381/close' -d '{}'
POST /v2/projects/d290ff87-4145-401f-aa94-7ac637aa4381/close HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/controller/projects/{project_id}/close

13
docs/api/examples/controller_post_projectsprojectidcommit.txt Normal file
View File

@ -0,0 +1,13 @@
curl -i -X POST 'http://localhost:8000/v2/projects/02eac428-0bf5-442e-9f53-3b9af544d057/commit' -d '{}'
POST /v2/projects/02eac428-0bf5-442e-9f53-3b9af544d057/commit HTTP/1.1
{}
HTTP/1.1 204
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 0
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/controller/projects/{project_id}/commit

37
docs/api/examples/controller_post_projectsprojectidvms.txt Normal file
View File

@ -0,0 +1,37 @@
curl -i -X POST 'http://localhost:8000/v2/projects/4eed4d28-791f-46c1-8177-6ae1c0450a20/vms' -d '{"hypervisor_id": "example.com", "name": "test", "properties": {"startup_script": "echo test"}, "vm_type": "vpcs"}'
POST /v2/projects/4eed4d28-791f-46c1-8177-6ae1c0450a20/vms HTTP/1.1
{
"hypervisor_id": "example.com",
"name": "test",
"properties": {
"startup_script": "echo test"
},
"vm_type": "vpcs"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 448
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/controller/projects/{project_id}/vms
{
"console": null,
"console_type": "telnet",
"hypervisor_id": "example.com",
"name": "test",
"project_id": "4eed4d28-791f-46c1-8177-6ae1c0450a20",
"properties": {
"console": null,
"console_type": "telnet",
"name": "test",
"startup_script": "echo test",
"vm_id": "ca8bd33c-fd32-4252-90f6-47b4a2b5a115"
},
"vm_id": "ca8bd33c-fd32-4252-90f6-47b4a2b5a115",
"vm_type": "vpcs"
}

4
docs/api/examples/hypervisor_delete_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt
View File

@ -1,6 +1,6 @@
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/ea050c4a-695b-4135-bbda-907a1bafbb2e/adapters/0/ports/0/nio'
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/1d92dce7-dd78-41a0-898f-fbc1d7eceac8/adapters/0/ports/0/nio'
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/ea050c4a-695b-4135-bbda-907a1bafbb2e/adapters/0/ports/0/nio HTTP/1.1
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/1d92dce7-dd78-41a0-898f-fbc1d7eceac8/adapters/0/ports/0/nio HTTP/1.1

4
docs/api/examples/hypervisor_delete_projectsprojectidiouvmsvmid.txt
View File

@ -1,6 +1,6 @@
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/85bf8018-891e-4a8f-97b0-efc3046aab36'
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/b2bc705e-6878-4700-bb18-28bb200cdb64'
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/85bf8018-891e-4a8f-97b0-efc3046aab36 HTTP/1.1
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/b2bc705e-6878-4700-bb18-28bb200cdb64 HTTP/1.1

4
docs/api/examples/hypervisor_delete_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt
View File

@ -1,6 +1,6 @@
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/9a5ad4df-3231-4f25-9f6d-9a55e2680f42/adapters/1/ports/0/nio'
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/e8556670-86b1-4934-8ddf-fb177513cc35/adapters/1/ports/0/nio'
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/9a5ad4df-3231-4f25-9f6d-9a55e2680f42/adapters/1/ports/0/nio HTTP/1.1
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/e8556670-86b1-4934-8ddf-fb177513cc35/adapters/1/ports/0/nio HTTP/1.1

4
docs/api/examples/hypervisor_delete_projectsprojectidqemuvmsvmid.txt
View File

@ -1,6 +1,6 @@
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/9ae4aaa3-ffc0-4695-8216-fbd82d67e428'
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/5a926562-f7fb-4139-871c-cddddea810fd'
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/9ae4aaa3-ffc0-4695-8216-fbd82d67e428 HTTP/1.1
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/5a926562-f7fb-4139-871c-cddddea810fd HTTP/1.1

4
docs/api/examples/hypervisor_delete_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt
View File

@ -1,6 +1,6 @@
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/f2e60e4e-cc85-4821-96a5-a429b3143eb1/adapters/1/ports/0/nio'
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/5f7f906b-1ea7-442f-9160-1623c5f05703/adapters/1/ports/0/nio'
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/f2e60e4e-cc85-4821-96a5-a429b3143eb1/adapters/1/ports/0/nio HTTP/1.1
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/5f7f906b-1ea7-442f-9160-1623c5f05703/adapters/1/ports/0/nio HTTP/1.1

4
docs/api/examples/hypervisor_delete_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt
View File

@ -1,6 +1,6 @@
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/272af52d-3b76-47f8-a8b9-49be2c779afa/adapters/0/ports/0/nio'
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/d3ee21d2-e9f6-4af6-8122-debeacf49d6b/adapters/0/ports/0/nio'
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/272af52d-3b76-47f8-a8b9-49be2c779afa/adapters/0/ports/0/nio HTTP/1.1
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/d3ee21d2-e9f6-4af6-8122-debeacf49d6b/adapters/0/ports/0/nio HTTP/1.1

4
docs/api/examples/hypervisor_delete_projectsprojectidvpcsvmsvmid.txt
View File

@ -1,6 +1,6 @@
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/a96b0be9-0632-4e08-aa5c-2da20e33aafd'
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/646a162c-e483-409f-bd3c-c0f0a780b029'
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/a96b0be9-0632-4e08-aa5c-2da20e33aafd HTTP/1.1
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/646a162c-e483-409f-bd3c-c0f0a780b029 HTTP/1.1

4
docs/api/examples/hypervisor_delete_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt
View File

@ -1,6 +1,6 @@
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/696826a1-e02f-41da-993a-24e119235ad0/adapters/0/ports/0/nio'
curl -i -X DELETE 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/c00cc4b7-0292-47df-a13f-f840b719278e/adapters/0/ports/0/nio'
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/696826a1-e02f-41da-993a-24e119235ad0/adapters/0/ports/0/nio HTTP/1.1
DELETE /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/c00cc4b7-0292-47df-a13f-f840b719278e/adapters/0/ports/0/nio HTTP/1.1

10
docs/api/examples/hypervisor_get_projects.txt
View File

@ -6,7 +6,7 @@ GET /v2/projects HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 692
CONTENT-LENGTH: 254
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
@ -14,17 +14,13 @@ X-ROUTE: /v2/hypervisor/projects
[
{
"location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpzdacjj9u/projects",
"name": "test",
"path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpzdacjj9u/projects/00010203-0405-0607-0809-0a0b0c0d0e0b",
"project_id": "00010203-0405-0607-0809-0a0b0c0d0e0b",
"project_id": "52010203-0405-0607-0809-0a0b0c0d0e0b",
"temporary": false
},
{
"location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpzdacjj9u/projects",
"name": "test",
"path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpzdacjj9u/projects/00010203-0405-0607-0809-0a0b0c0d0e0f",
"project_id": "00010203-0405-0607-0809-0a0b0c0d0e0f",
"project_id": "51010203-0405-0607-0809-0a0b0c0d0e0f",
"temporary": false
}
]

10
docs/api/examples/hypervisor_get_projectsprojectid.txt
View File

@ -1,21 +1,19 @@
curl -i -X GET 'http://localhost:8000/v2/projects/00010203-0405-0607-0809-0a0b0c0d0e02'
curl -i -X GET 'http://localhost:8000/v2/projects/40010203-0405-0607-0809-0a0b0c0d0e02'
GET /v2/projects/00010203-0405-0607-0809-0a0b0c0d0e02 HTTP/1.1
GET /v2/projects/40010203-0405-0607-0809-0a0b0c0d0e02 HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 315
CONTENT-LENGTH: 104
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}
{
"location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpblilnlks/projects",
"name": "test",
"path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpblilnlks/projects/00010203-0405-0607-0809-0a0b0c0d0e02",
"project_id": "00010203-0405-0607-0809-0a0b0c0d0e02",
"project_id": "40010203-0405-0607-0809-0a0b0c0d0e02",
"temporary": false
}

8
docs/api/examples/hypervisor_get_projectsprojectidiouvmsvmid.txt
View File

@ -1,6 +1,6 @@
curl -i -X GET 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/d3b40654-aac9-4482-ae7f-b17585452f47'
curl -i -X GET 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/e24dae90-93ea-4929-99aa-5a822abb84b3'
GET /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/d3b40654-aac9-4482-ae7f-b17585452f47 HTTP/1.1
GET /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/e24dae90-93ea-4929-99aa-5a822abb84b3 HTTP/1.1
@ -28,6 +28,6 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}
"serial_adapters": 2,
"startup_config": null,
"use_default_iou_values": true,
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i_9npri/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/d3b40654-aac9-4482-ae7f-b17585452f47",
"vm_id": "d3b40654-aac9-4482-ae7f-b17585452f47"
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i5ppgsq/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/e24dae90-93ea-4929-99aa-5a822abb84b3",
"vm_id": "e24dae90-93ea-4929-99aa-5a822abb84b3"
}

4
docs/api/examples/hypervisor_get_projectsprojectidiouvmsvmidconfigs.txt
View File

@ -1,6 +1,6 @@
curl -i -X GET 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/5d06cf86-3c43-43cd-880f-563365da9af9/configs'
curl -i -X GET 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/3d347c9e-cbf2-4d22-801f-1b813790c053/configs'
GET /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/5d06cf86-3c43-43cd-880f-563365da9af9/configs HTTP/1.1
GET /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/3d347c9e-cbf2-4d22-801f-1b813790c053/configs HTTP/1.1

12
docs/api/examples/hypervisor_get_projectsprojectidqemuvmsvmid.txt
View File

@ -1,6 +1,6 @@
curl -i -X GET 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2434ca92-6f86-4791-a37b-16829022c3c3'
curl -i -X GET 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/394d6c3b-793f-429b-abd8-8013c6750c78'
GET /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2434ca92-6f86-4791-a37b-16829022c3c3 HTTP/1.1
GET /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/394d6c3b-793f-429b-abd8-8013c6750c78 HTTP/1.1
@ -42,15 +42,15 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}
"kernel_image": "",
"kernel_image_md5sum": null,
"legacy_networking": false,
"mac_address": "00:00:ab:c3:c3:00",
"mac_address": "00:00:ab:0c:78:00",
"name": "PC TEST 1",
"options": "",
"platform": "x86_64",
"process_priority": "low",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpniqxbosk/qemu-system-x86_64",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph1maw1oo/qemu-system-x86_64",
"ram": 256,
"usage": "",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpwq5ca6jn/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/2434ca92-6f86-4791-a37b-16829022c3c3",
"vm_id": "2434ca92-6f86-4791-a37b-16829022c3c3"
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpnu0jz9hy/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/394d6c3b-793f-429b-abd8-8013c6750c78",
"vm_id": "394d6c3b-793f-429b-abd8-8013c6750c78"
}

6
docs/api/examples/hypervisor_get_projectsprojectidvirtualboxvmsvmid.txt
View File

@ -1,6 +1,6 @@
curl -i -X GET 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/01702d40-34f3-4035-9c26-fe8cdb914ca6'
curl -i -X GET 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/865c5e39-3aa9-4a38-a6cd-72fc78fb15fa'
GET /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/01702d40-34f3-4035-9c26-fe8cdb914ca6 HTTP/1.1
GET /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/865c5e39-3aa9-4a38-a6cd-72fc78fb15fa HTTP/1.1
@ -24,6 +24,6 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}
"ram": 0,
"use_any_adapter": false,
"vm_directory": null,
"vm_id": "01702d40-34f3-4035-9c26-fe8cdb914ca6",
"vm_id": "865c5e39-3aa9-4a38-a6cd-72fc78fb15fa",
"vmname": "VMTEST"
}

11
docs/api/examples/hypervisor_get_projectsprojectidvpcsvmsvmid.txt
View File

@ -1,12 +1,12 @@
curl -i -X GET 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/cbe8e7a6-dbc8-45ac-a0b5-85ed524d18a5'
curl -i -X GET 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/3eb77b0a-bd51-465f-941f-f256c78193d6'
GET /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/cbe8e7a6-dbc8-45ac-a0b5-85ed524d18a5 HTTP/1.1
GET /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/3eb77b0a-bd51-465f-941f-f256c78193d6 HTTP/1.1
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 455
CONTENT-LENGTH: 485
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
@ -15,11 +15,12 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}
{
"command_line": "",
"console": 2010,
"console_type": "telnet",
"name": "PC TEST 1",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"startup_script": null,
"startup_script_path": null,
"status": "stopped",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpwq5ca6jn/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/cbe8e7a6-dbc8-45ac-a0b5-85ed524d18a5",
"vm_id": "cbe8e7a6-dbc8-45ac-a0b5-85ed524d18a5"
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpnu0jz9hy/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/3eb77b0a-bd51-465f-941f-f256c78193d6",
"vm_id": "3eb77b0a-bd51-465f-941f-f256c78193d6"
}

11
docs/api/examples/hypervisor_post_projects.txt
View File

@ -1,23 +1,22 @@
curl -i -X POST 'http://localhost:8000/v2/projects' -d '{"name": "test"}'
curl -i -X POST 'http://localhost:8000/v2/projects' -d '{"name": "test", "project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f"}'
POST /v2/projects HTTP/1.1
{
"name": "test"
"name": "test",
"project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f"
}
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 315
CONTENT-LENGTH: 104
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects
{
"location": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpr31cd789/projects",
"name": "test",
"path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpr31cd789/projects/8bae0914-715e-4e8f-8342-7606f012c5af",
"project_id": "8bae0914-715e-4e8f-8342-7606f012c5af",
"project_id": "10010203-0405-0607-0809-0a0b0c0d0e0f",
"temporary": false
}

4
docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/04c0796b-af7d-44a5-9b58-42454dc078b1/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/a75f2534-aecf-4c8c-b3c8-a9640a97aa9b/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/04c0796b-af7d-44a5-9b58-42454dc078b1/adapters/0/ports/0/nio HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/a75f2534-aecf-4c8c-b3c8-a9640a97aa9b/adapters/0/ports/0/nio HTTP/1.1
{
"lport": 4242,
"rhost": "127.0.0.1",

6
docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/40f56eb3-e579-4368-8db6-904959f9302c/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/743d15b4-f038-4a32-88af-3b19f2225625/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/40f56eb3-e579-4368-8db6-904959f9302c/adapters/0/ports/0/start_capture HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/743d15b4-f038-4a32-88af-3b19f2225625/adapters/0/ports/0/start_capture HTTP/1.1
{
"capture_file_name": "test.pcap",
"data_link_type": "DLT_EN10MB"
@ -16,5 +16,5 @@ SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/docker/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
{
"pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i_9npri/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
"pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i5ppgsq/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
}

4
docs/api/examples/hypervisor_post_projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/c6618f98-06af-4be5-a0b0-172de6a1c95e/adapters/0/ports/0/stop_capture' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/a95e9a97-1f10-4b0e-ae8b-963d5d25d1fb/adapters/0/ports/0/stop_capture' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/c6618f98-06af-4be5-a0b0-172de6a1c95e/adapters/0/ports/0/stop_capture HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/a95e9a97-1f10-4b0e-ae8b-963d5d25d1fb/adapters/0/ports/0/stop_capture HTTP/1.1
{}

8
docs/api/examples/hypervisor_post_projectsprojectidiouvms.txt
View File

@ -1,11 +1,11 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms' -d '{"name": "PC TEST 1", "path": "iou.bin", "startup_config_content": "hostname test", "vm_id": "a01038d7-fd9a-4efc-ae16-d7f60c583f68"}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms' -d '{"name": "PC TEST 1", "path": "iou.bin", "startup_config_content": "hostname test", "vm_id": "c79f8d3b-9968-4f17-94fc-72dae9f81f00"}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms HTTP/1.1
{
"name": "PC TEST 1",
"path": "iou.bin",
"startup_config_content": "hostname test",
"vm_id": "a01038d7-fd9a-4efc-ae16-d7f60c583f68"
"vm_id": "c79f8d3b-9968-4f17-94fc-72dae9f81f00"
}
@ -33,6 +33,6 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms
"serial_adapters": 2,
"startup_config": "startup-config.cfg",
"use_default_iou_values": true,
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i_9npri/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/a01038d7-fd9a-4efc-ae16-d7f60c583f68",
"vm_id": "a01038d7-fd9a-4efc-ae16-d7f60c583f68"
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i5ppgsq/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/c79f8d3b-9968-4f17-94fc-72dae9f81f00",
"vm_id": "c79f8d3b-9968-4f17-94fc-72dae9f81f00"
}

4
docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/aeb0ed3a-49f2-47a6-9deb-c9dadad2128c/adapters/1/ports/0/nio' -d '{"ethernet_device": "bridge0", "type": "nio_generic_ethernet"}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2f84e148-0b7c-402e-b162-ef4429e121c4/adapters/1/ports/0/nio' -d '{"ethernet_device": "bridge0", "type": "nio_generic_ethernet"}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/aeb0ed3a-49f2-47a6-9deb-c9dadad2128c/adapters/1/ports/0/nio HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/2f84e148-0b7c-402e-b162-ef4429e121c4/adapters/1/ports/0/nio HTTP/1.1
{
"ethernet_device": "bridge0",
"type": "nio_generic_ethernet"

6
docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/b86a3780-f2dc-4b65-a32b-40fefcf23c9d/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/775663cc-6fee-42de-8bb9-11cc6a8cb1ab/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/b86a3780-f2dc-4b65-a32b-40fefcf23c9d/adapters/0/ports/0/start_capture HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/775663cc-6fee-42de-8bb9-11cc6a8cb1ab/adapters/0/ports/0/start_capture HTTP/1.1
{
"capture_file_name": "test.pcap",
"data_link_type": "DLT_EN10MB"
@ -16,5 +16,5 @@ SERVER: Python/3.5 GNS3/1.5.0dev1
X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
{
"pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i_9npri/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
"pcap_file_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i5ppgsq/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
}

4
docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/36f9d2a3-fccb-4602-ae5a-ae2166b8a037/adapters/0/ports/0/stop_capture' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/d2ab09de-93e5-4210-b401-fac2e4a33fa2/adapters/0/ports/0/stop_capture' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/36f9d2a3-fccb-4602-ae5a-ae2166b8a037/adapters/0/ports/0/stop_capture HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/d2ab09de-93e5-4210-b401-fac2e4a33fa2/adapters/0/ports/0/stop_capture HTTP/1.1
{}

4
docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidreload.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/b43e13b6-793c-4abe-9a61-558aa5468611/reload' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/eefa54d8-6428-4314-a3ec-b38b1a9f340b/reload' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/b43e13b6-793c-4abe-9a61-558aa5468611/reload HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/eefa54d8-6428-4314-a3ec-b38b1a9f340b/reload HTTP/1.1
{}

10
docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidstart.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6cae9c24-fbc6-485f-b8cf-df8512bb512e/start' -d '{"iourc_content": "test"}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/32f396f4-3ea3-4331-bde4-34ff49d53afe/start' -d '{"iourc_content": "test"}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/6cae9c24-fbc6-485f-b8cf-df8512bb512e/start HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/32f396f4-3ea3-4331-bde4-34ff49d53afe/start HTTP/1.1
{
"iourc_content": "test"
}
@ -18,7 +18,7 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/start
"command_line": "",
"console": 2001,
"ethernet_adapters": 2,
"iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpq6flori0/iourc",
"iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpdz7rj3bb/iourc",
"l1_keepalives": false,
"md5sum": null,
"name": "PC TEST 1",
@ -30,6 +30,6 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}/start
"serial_adapters": 2,
"startup_config": null,
"use_default_iou_values": true,
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i_9npri/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/6cae9c24-fbc6-485f-b8cf-df8512bb512e",
"vm_id": "6cae9c24-fbc6-485f-b8cf-df8512bb512e"
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i5ppgsq/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/32f396f4-3ea3-4331-bde4-34ff49d53afe",
"vm_id": "32f396f4-3ea3-4331-bde4-34ff49d53afe"
}

4
docs/api/examples/hypervisor_post_projectsprojectidiouvmsvmidstop.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ee4a551d-df59-40bf-9de0-571844d80bf7/stop' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/28228572-1e26-4b73-a8b2-5f113742ec3f/stop' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/ee4a551d-df59-40bf-9de0-571844d80bf7/stop HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/28228572-1e26-4b73-a8b2-5f113742ec3f/stop HTTP/1.1
{}

12
docs/api/examples/hypervisor_post_projectsprojectidqemuvms.txt
View File

@ -1,10 +1,10 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms' -d '{"hda_disk_image": "linux\u8f7d.img", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpniqxbosk/qemu-system-x86_64", "ram": 1024}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms' -d '{"hda_disk_image": "linux\u8f7d.img", "name": "PC TEST 1", "qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph1maw1oo/qemu-system-x86_64", "ram": 1024}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms HTTP/1.1
{
"hda_disk_image": "linux\u8f7d.img",
"name": "PC TEST 1",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpniqxbosk/qemu-system-x86_64",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph1maw1oo/qemu-system-x86_64",
"ram": 1024
}
@ -47,15 +47,15 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms
"kernel_image": "",
"kernel_image_md5sum": null,
"legacy_networking": false,
"mac_address": "00:00:ab:a6:43:00",
"mac_address": "00:00:ab:f8:3d:00",
"name": "PC TEST 1",
"options": "",
"platform": "x86_64",
"process_priority": "low",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpniqxbosk/qemu-system-x86_64",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph1maw1oo/qemu-system-x86_64",
"ram": 1024,
"usage": "",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpwq5ca6jn/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/cd7d5a8d-6451-45c1-939c-1207e3baa643",
"vm_id": "cd7d5a8d-6451-45c1-939c-1207e3baa643"
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpnu0jz9hy/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/f597ba60-a3e6-4dea-9df2-b109e265f83d",
"vm_id": "f597ba60-a3e6-4dea-9df2-b109e265f83d"
}

4
docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidadaptersadapternumberdportsportnumberdnio.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/738edd89-4ee0-4291-a09e-a8bcf148d957/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/72c3f09b-552f-4ddf-8af4-47f2971d5293/adapters/1/ports/0/nio' -d '{"ethernet_device": "eth0", "type": "nio_generic_ethernet"}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/738edd89-4ee0-4291-a09e-a8bcf148d957/adapters/1/ports/0/nio HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/72c3f09b-552f-4ddf-8af4-47f2971d5293/adapters/1/ports/0/nio HTTP/1.1
{
"ethernet_device": "eth0",
"type": "nio_generic_ethernet"

4
docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidreload.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/b51edf2b-0448-4ea3-9775-6f55153ec826/reload' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/89bb7280-33aa-4bd1-b438-f333e3941cd4/reload' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/b51edf2b-0448-4ea3-9775-6f55153ec826/reload HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/89bb7280-33aa-4bd1-b438-f333e3941cd4/reload HTTP/1.1
{}

4
docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidresume.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/5b08ab35-71f7-4574-a81a-25e0ba69bb15/resume' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/7f66027b-a7b8-466e-9063-525fa50d4ad5/resume' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/5b08ab35-71f7-4574-a81a-25e0ba69bb15/resume HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/7f66027b-a7b8-466e-9063-525fa50d4ad5/resume HTTP/1.1
{}

12
docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidstart.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/9b3ff5e8-49eb-4f87-b273-f5e62dca8077/start' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/ab7ac3c4-668a-4895-9939-e4f7ae850775/start' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/9b3ff5e8-49eb-4f87-b273-f5e62dca8077/start HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/ab7ac3c4-668a-4895-9939-e4f7ae850775/start HTTP/1.1
{}
@ -42,15 +42,15 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}/start
"kernel_image": "",
"kernel_image_md5sum": null,
"legacy_networking": false,
"mac_address": "00:00:ab:80:77:00",
"mac_address": "00:00:ab:07:75:00",
"name": "PC TEST 1",
"options": "",
"platform": "x86_64",
"process_priority": "low",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpniqxbosk/qemu-system-x86_64",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph1maw1oo/qemu-system-x86_64",
"ram": 256,
"usage": "",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpwq5ca6jn/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/9b3ff5e8-49eb-4f87-b273-f5e62dca8077",
"vm_id": "9b3ff5e8-49eb-4f87-b273-f5e62dca8077"
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpnu0jz9hy/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/ab7ac3c4-668a-4895-9939-e4f7ae850775",
"vm_id": "ab7ac3c4-668a-4895-9939-e4f7ae850775"
}

4
docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidstop.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2f307e0a-1354-4ac7-915b-7fc9a7d17d75/stop' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/7f2aff3d-ce1f-4243-8918-026207271354/stop' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/2f307e0a-1354-4ac7-915b-7fc9a7d17d75/stop HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/7f2aff3d-ce1f-4243-8918-026207271354/stop HTTP/1.1
{}

4
docs/api/examples/hypervisor_post_projectsprojectidqemuvmsvmidsuspend.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/92aca201-d518-425f-8744-46947bab2d02/suspend' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/f2791d75-6147-43ac-94b3-b05e46be0369/suspend' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/92aca201-d518-425f-8744-46947bab2d02/suspend HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/f2791d75-6147-43ac-94b3-b05e46be0369/suspend HTTP/1.1
{}

2
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvms.txt
View File

@ -28,6 +28,6 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/virtualbox/vms
"ram": 0,
"use_any_adapter": false,
"vm_directory": null,
"vm_id": "68c3509a-64f8-43ab-8add-a991029de221",
"vm_id": "6cf43660-0428-4f60-b9f8-3de921abb0ce",
"vmname": "VM1"
}

4
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidadaptersadapternumberdportsportnumberdnio.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/20a29cc5-24a6-4f76-901d-e98ce26bc756/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/a011a5c1-ff45-4824-a1ba-fe728c3ea9ae/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/20a29cc5-24a6-4f76-901d-e98ce26bc756/adapters/0/ports/0/nio HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/a011a5c1-ff45-4824-a1ba-fe728c3ea9ae/adapters/0/ports/0/nio HTTP/1.1
{
"lport": 4242,
"rhost": "127.0.0.1",

4
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidreload.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/804c121d-935d-499e-9c34-4d33b3045dd2/reload' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/c905d5b5-b8a0-4712-807e-6fc810e4ff84/reload' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/804c121d-935d-499e-9c34-4d33b3045dd2/reload HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/c905d5b5-b8a0-4712-807e-6fc810e4ff84/reload HTTP/1.1
{}

4
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidresume.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/b180eae6-a768-4d18-8429-5db71fb14ac9/resume' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/2643c089-7f1a-4c2d-a3e8-ef869cf6fd93/resume' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/b180eae6-a768-4d18-8429-5db71fb14ac9/resume HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/2643c089-7f1a-4c2d-a3e8-ef869cf6fd93/resume HTTP/1.1
{}

4
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidstart.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/06b7a2a5-9510-4ade-808c-0c606d224954/start' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/42741774-fc1a-4703-bdb5-c0068245040b/start' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/06b7a2a5-9510-4ade-808c-0c606d224954/start HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/42741774-fc1a-4703-bdb5-c0068245040b/start HTTP/1.1
{}

4
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidstop.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/de197f04-925d-4bfc-afcb-63506870949f/stop' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/41c758a4-620c-404c-9acb-89327b46347d/stop' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/de197f04-925d-4bfc-afcb-63506870949f/stop HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/41c758a4-620c-404c-9acb-89327b46347d/stop HTTP/1.1
{}

4
docs/api/examples/hypervisor_post_projectsprojectidvirtualboxvmsvmidsuspend.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/4d67ae8d-5ba3-476a-bf5d-860e313fbcac/suspend' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/e2a55701-2bd7-49eb-bf5f-c9a98b67ced1/suspend' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/4d67ae8d-5ba3-476a-bf5d-860e313fbcac/suspend HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/e2a55701-2bd7-49eb-bf5f-c9a98b67ced1/suspend HTTP/1.1
{}

7
docs/api/examples/hypervisor_post_projectsprojectidvpcsvms.txt
View File

@ -8,7 +8,7 @@ POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms HTTP/1.1
HTTP/1.1 201
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 455
CONTENT-LENGTH: 485
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
@ -17,11 +17,12 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/vpcs/vms
{
"command_line": "",
"console": 2010,
"console_type": "telnet",
"name": "PC TEST 1",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"startup_script": null,
"startup_script_path": null,
"status": "stopped",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpwq5ca6jn/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/014a59f3-9906-4060-8bb5-9dec035285da",
"vm_id": "014a59f3-9906-4060-8bb5-9dec035285da"
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpnu0jz9hy/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/f6217596-5a12-485b-822f-4b41a745eac9",
"vm_id": "f6217596-5a12-485b-822f-4b41a745eac9"
}

4
docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidadaptersadapternumberdportsportnumberdnio.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/32d2b974-140e-423b-a1a7-0febadf201b3/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/03d3c4aa-e6f2-48e3-a2d6-459e3b453b5e/adapters/0/ports/0/nio' -d '{"lport": 4242, "rhost": "127.0.0.1", "rport": 4343, "type": "nio_udp"}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/32d2b974-140e-423b-a1a7-0febadf201b3/adapters/0/ports/0/nio HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/03d3c4aa-e6f2-48e3-a2d6-459e3b453b5e/adapters/0/ports/0/nio HTTP/1.1
{
"lport": 4242,
"rhost": "127.0.0.1",

4
docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidreload.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/c72d1bbe-97b0-4711-a372-f472929e3cb5/reload' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/4d0be4c4-d901-4a03-83f9-602847f0e005/reload' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/c72d1bbe-97b0-4711-a372-f472929e3cb5/reload HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/4d0be4c4-d901-4a03-83f9-602847f0e005/reload HTTP/1.1
{}

11
docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidstart.txt
View File

@ -1,12 +1,12 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/a2598c6d-3952-47a1-bdc0-37da99c1e273/start' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/b25c9c43-6d67-4a8d-bab1-00b94c00b3c6/start' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/a2598c6d-3952-47a1-bdc0-37da99c1e273/start HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/b25c9c43-6d67-4a8d-bab1-00b94c00b3c6/start HTTP/1.1
{}
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 455
CONTENT-LENGTH: 485
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
@ -15,11 +15,12 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}/start
{
"command_line": "",
"console": 2010,
"console_type": "telnet",
"name": "PC TEST 1",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"startup_script": null,
"startup_script_path": null,
"status": "stopped",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpwq5ca6jn/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/a2598c6d-3952-47a1-bdc0-37da99c1e273",
"vm_id": "a2598c6d-3952-47a1-bdc0-37da99c1e273"
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpnu0jz9hy/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/b25c9c43-6d67-4a8d-bab1-00b94c00b3c6",
"vm_id": "b25c9c43-6d67-4a8d-bab1-00b94c00b3c6"
}

4
docs/api/examples/hypervisor_post_projectsprojectidvpcsvmsvmidstop.txt
View File

@ -1,6 +1,6 @@
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/a67684f4-59c6-452d-80f6-d22cece832fb/stop' -d '{}'
curl -i -X POST 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/cbf7d7f8-87aa-401d-99c3-ab04348d9aa5/stop' -d '{}'
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/a67684f4-59c6-452d-80f6-d22cece832fb/stop HTTP/1.1
POST /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/cbf7d7f8-87aa-401d-99c3-ab04348d9aa5/stop HTTP/1.1
{}

6
docs/api/examples/hypervisor_put_projectsprojectid.txt
View File

@ -1,9 +1,9 @@
curl -i -X PUT 'http://localhost:8000/v2/projects/a922355c-cb97-411b-879f-d9d09d330005' -d '{"name": "second_name", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-553/test_update_path_project_non_l0"}'
curl -i -X PUT 'http://localhost:8000/v2/projects/90010203-0405-0607-0809-0a0b0c0d0e0b' -d '{"name": "second_name", "path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-296/test_update_path_project_non_l0"}'
PUT /v2/projects/a922355c-cb97-411b-879f-d9d09d330005 HTTP/1.1
PUT /v2/projects/90010203-0405-0607-0809-0a0b0c0d0e0b HTTP/1.1
{
"name": "second_name",
"path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-553/test_update_path_project_non_l0"
"path": "/private/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/pytest-of-noplay/pytest-296/test_update_path_project_non_l0"
}

8
docs/api/examples/hypervisor_put_projectsprojectiddockervmsvmid.txt
View File

@ -1,6 +1,6 @@
curl -i -X PUT 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/289c485c-fe29-4f35-a65c-146cd4854262' -d '{"console": 2003, "environment": "GNS3=1\nGNS4=0", "name": "test", "start_command": "yes"}'
curl -i -X PUT 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/351efb4b-1f7d-4057-bc48-d2563312a88e' -d '{"console": 2003, "environment": "GNS3=1\nGNS4=0", "name": "test", "start_command": "yes"}'
PUT /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/289c485c-fe29-4f35-a65c-146cd4854262 HTTP/1.1
PUT /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/docker/vms/351efb4b-1f7d-4057-bc48-d2563312a88e HTTP/1.1
{
"console": 2003,
"environment": "GNS3=1\nGNS4=0",
@ -28,6 +28,6 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/docker/vms/{vm_id}
"name": "test",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"start_command": "yes",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i_9npri/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/docker/289c485c-fe29-4f35-a65c-146cd4854262",
"vm_id": "289c485c-fe29-4f35-a65c-146cd4854262"
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i5ppgsq/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/docker/351efb4b-1f7d-4057-bc48-d2563312a88e",
"vm_id": "351efb4b-1f7d-4057-bc48-d2563312a88e"
}

10
docs/api/examples/hypervisor_put_projectsprojectidiouvmsvmid.txt
View File

@ -1,6 +1,6 @@
curl -i -X PUT 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/088ce9f5-eda0-403c-9336-c56d2fd18e59' -d '{"console": 2002, "ethernet_adapters": 4, "iourc_content": "test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0, "startup_config_content": "hostname test", "use_default_iou_values": true}'
curl -i -X PUT 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/3009bb17-2141-4148-8aeb-b566cc28fbe8' -d '{"console": 2002, "ethernet_adapters": 4, "iourc_content": "test", "l1_keepalives": true, "name": "test", "nvram": 2048, "ram": 512, "serial_adapters": 0, "startup_config_content": "hostname test", "use_default_iou_values": true}'
PUT /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/088ce9f5-eda0-403c-9336-c56d2fd18e59 HTTP/1.1
PUT /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/iou/vms/3009bb17-2141-4148-8aeb-b566cc28fbe8 HTTP/1.1
{
"console": 2002,
"ethernet_adapters": 4,
@ -27,7 +27,7 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}
"command_line": "",
"console": 2002,
"ethernet_adapters": 4,
"iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmppfz9vhu7/iourc",
"iourc_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp9i8x2e99/iourc",
"l1_keepalives": true,
"md5sum": null,
"name": "test",
@ -39,6 +39,6 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/iou/vms/{vm_id}
"serial_adapters": 0,
"startup_config": "startup-config.cfg",
"use_default_iou_values": true,
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i_9npri/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/088ce9f5-eda0-403c-9336-c56d2fd18e59",
"vm_id": "088ce9f5-eda0-403c-9336-c56d2fd18e59"
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmp_i5ppgsq/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/iou/3009bb17-2141-4148-8aeb-b566cc28fbe8",
"vm_id": "3009bb17-2141-4148-8aeb-b566cc28fbe8"
}

12
docs/api/examples/hypervisor_put_projectsprojectidqemuvmsvmid.txt
View File

@ -1,6 +1,6 @@
curl -i -X PUT 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/d91efeb6-ebae-46b2-ad8c-b0cedaff3058' -d '{"console": 2002, "hdb_disk_image": "linux.img", "name": "test", "ram": 1024}'
curl -i -X PUT 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/efb531e4-b8ad-4472-a4c0-21b69fccb512' -d '{"console": 2002, "hdb_disk_image": "linux.img", "name": "test", "ram": 1024}'
PUT /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/d91efeb6-ebae-46b2-ad8c-b0cedaff3058 HTTP/1.1
PUT /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/vms/efb531e4-b8ad-4472-a4c0-21b69fccb512 HTTP/1.1
{
"console": 2002,
"hdb_disk_image": "linux.img",
@ -47,15 +47,15 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/qemu/vms/{vm_id}
"kernel_image": "",
"kernel_image_md5sum": null,
"legacy_networking": false,
"mac_address": "00:00:ab:30:58:00",
"mac_address": "00:00:ab:b5:12:00",
"name": "test",
"options": "",
"platform": "x86_64",
"process_priority": "low",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpniqxbosk/qemu-system-x86_64",
"qemu_path": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmph1maw1oo/qemu-system-x86_64",
"ram": 1024,
"usage": "",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpwq5ca6jn/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/d91efeb6-ebae-46b2-ad8c-b0cedaff3058",
"vm_id": "d91efeb6-ebae-46b2-ad8c-b0cedaff3058"
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpnu0jz9hy/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/qemu/efb531e4-b8ad-4472-a4c0-21b69fccb512",
"vm_id": "efb531e4-b8ad-4472-a4c0-21b69fccb512"
}

6
docs/api/examples/hypervisor_put_projectsprojectidvirtualboxvmsvmid.txt
View File

@ -1,6 +1,6 @@
curl -i -X PUT 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/53b90f87-4268-4cb7-9526-7897a028ddae' -d '{"console": 2011, "name": "test"}'
curl -i -X PUT 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/bd9b04ab-0915-4057-ad64-8e45446f286a' -d '{"console": 2011, "name": "test"}'
PUT /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/53b90f87-4268-4cb7-9526-7897a028ddae HTTP/1.1
PUT /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/vms/bd9b04ab-0915-4057-ad64-8e45446f286a HTTP/1.1
{
"console": 2011,
"name": "test"
@ -27,6 +27,6 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/virtualbox/vms/{vm_id}
"ram": 0,
"use_any_adapter": false,
"vm_directory": null,
"vm_id": "53b90f87-4268-4cb7-9526-7897a028ddae",
"vm_id": "bd9b04ab-0915-4057-ad64-8e45446f286a",
"vmname": "VMTEST"
}

11
docs/api/examples/hypervisor_put_projectsprojectidvpcsvmsvmid.txt
View File

@ -1,6 +1,6 @@
curl -i -X PUT 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/5f21b010-55dd-450c-a0ed-1fe0706afd2c' -d '{"console": 2012, "name": "test", "startup_script": "ip 192.168.1.1"}'
curl -i -X PUT 'http://localhost:8000/v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/010cb472-2816-4cc7-9b99-799338935706' -d '{"console": 2012, "name": "test", "startup_script": "ip 192.168.1.1"}'
PUT /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/5f21b010-55dd-450c-a0ed-1fe0706afd2c HTTP/1.1
PUT /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/010cb472-2816-4cc7-9b99-799338935706 HTTP/1.1
{
"console": 2012,
"name": "test",
@ -10,7 +10,7 @@ PUT /v2/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/vms/5f21b010-55dd-450
HTTP/1.1 200
ACCESS-CONTROL-ALLOW-ORIGIN: *
CONTENT-LENGTH: 471
CONTENT-LENGTH: 501
CONTENT-TYPE: application/json
DATE: Thu, 08 Jan 2015 16:09:15 GMT
SERVER: Python/3.5 GNS3/1.5.0dev1
@ -19,11 +19,12 @@ X-ROUTE: /v2/hypervisor/projects/{project_id}/vpcs/vms/{vm_id}
{
"command_line": "",
"console": 2012,
"console_type": "telnet",
"name": "test",
"project_id": "a1e920ca-338a-4e9f-b363-aa607b09dd80",
"startup_script": "ip 192.168.1.1",
"startup_script_path": "startup.vpc",
"status": "stopped",
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpwq5ca6jn/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/5f21b010-55dd-450c-a0ed-1fe0706afd2c",
"vm_id": "5f21b010-55dd-450c-a0ed-1fe0706afd2c"
"vm_directory": "/var/folders/3s/r2wbv07n7wg4vrsn874lmxxh0000gn/T/tmpnu0jz9hy/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/vpcs/010cb472-2816-4cc7-9b99-799338935706",
"vm_id": "010cb472-2816-4cc7-9b99-799338935706"
}

8
docs/api/v2/controller/gns3server.handlers.index.rst Normal file
View File

@ -0,0 +1,8 @@
Gns3server.handlers.index
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
gns3server.handlers.index/*

9
docs/api/v2/controller/server/serversshutdown.rst → docs/api/v2/controller/gns3server.handlers.index/.rst
View File

@ -1,14 +1,13 @@
/v2/controller/servers/shutdown
/
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/servers/shutdown
GET /
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Shutdown the local server
Home page for GNS3Server
Response status codes
**********************
- **201**: Server is shutting down
- **403**: Server shutdown refused
- **200**: OK

13
docs/api/v2/controller/gns3server.handlers.index/status.rst Normal file
View File

@ -0,0 +1,13 @@
/status
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /status
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Ressources used by GNS3Server
Response status codes
**********************
- **200**: OK

13
docs/api/v2/controller/gns3server.handlers.index/v1version.rst Normal file
View File

@ -0,0 +1,13 @@
/v1/version
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v1/version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Old API
Response status codes
**********************
- **200**: OK

8
docs/api/v2/controller/hypervisor.rst Normal file
View File

@ -0,0 +1,8 @@
Hypervisor
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
hypervisor/*

22
docs/api/v2/controller/server/servers.rst → docs/api/v2/controller/hypervisor/s.rst
View File

@ -1,15 +1,15 @@
/v2/controller/servers
/v2/controller/hypervisors
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/servers
POST /v2/controller/hypervisors
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Register a server
Register a hypervisor
Response status codes
**********************
- **201**: Server added
- **201**: Hypervisor added
Input
*******
@ -18,10 +18,10 @@ Input
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
<tr><td>hypervisor_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
<tr><td>password</td> <td> </td> <td>string</td> <td>Password for auth</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
<tr><td>server_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
<tr><td>user</td> <td> </td> <td>string</td> <td>User for auth</td> </tr>
</table>
@ -31,18 +31,12 @@ Output
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>True if controller is connected to the server</td> </tr>
<tr><td>connected</td> <td> </td> <td>boolean</td> <td>True if controller is connected to the hypervisor</td> </tr>
<tr><td>host</td> <td>&#10004;</td> <td>string</td> <td>Server host</td> </tr>
<tr><td>hypervisor_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
<tr><td>port</td> <td>&#10004;</td> <td>integer</td> <td>Server port</td> </tr>
<tr><td>protocol</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: http, https</td> </tr>
<tr><td>server_id</td> <td>&#10004;</td> <td>string</td> <td>Server identifier</td> </tr>
<tr><td>user</td> <td> </td> <td>string</td> <td>User for auth</td> </tr>
<tr><td>version</td> <td> </td> <td>['string', 'null']</td> <td>Version of the GNS3 remote server</td> </tr>
<tr><td>version</td> <td> </td> <td>['string', 'null']</td> <td>Version of the GNS3 remote hypervisor</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_servers.txt

14
docs/api/v2/controller/hypervisor/sshutdown.rst Normal file
View File

@ -0,0 +1,14 @@
/v2/controller/hypervisors/shutdown
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/hypervisors/shutdown
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Shutdown the local hypervisor
Response status codes
**********************
- **201**: Hypervisor is shutting down
- **403**: Hypervisor shutdown refused

8
docs/api/v2/controller/project.rst Normal file
View File

@ -0,0 +1,8 @@
Project
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
project/*

44
docs/api/v2/controller/project/projects.rst Normal file
View File

@ -0,0 +1,44 @@
/v2/controller/projects
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/projects
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new project on the server
Response status codes
**********************
- **201**: Project created
- **409**: Project already created
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td> </td> <td>['string', 'null']</td> <td>Project UUID</td> </tr>
<tr><td>temporary</td> <td> </td> <td>boolean</td> <td>If project is a temporary project</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>name</td> <td> </td> <td>['string', 'null']</td> <td>Project name</td> </tr>
<tr><td>path</td> <td> </td> <td>['string', 'null']</td> <td>Project directory</td> </tr>
<tr><td>project_id</td> <td>&#10004;</td> <td>string</td> <td>Project UUID</td> </tr>
<tr><td>temporary</td> <td>&#10004;</td> <td>boolean</td> <td>If project is a temporary project</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projects.txt

24
docs/api/v2/controller/project/projectsprojectid.rst Normal file
View File

@ -0,0 +1,24 @@
/v2/controller/projects/{project_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
DELETE /v2/controller/projects/**{project_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete a project from disk
Parameters
**********
- **project_id**: The UUID of the project
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: Changes have been written on disk
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_projectsprojectid.txt

24
docs/api/v2/controller/project/projectsprojectidclose.rst Normal file
View File

@ -0,0 +1,24 @@
/v2/controller/projects/{project_id}/close
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/projects/**{project_id}**/close
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Close a project
Parameters
**********
- **project_id**: The UUID of the project
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: The project has been closed
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidclose.txt

24
docs/api/v2/controller/project/projectsprojectidcommit.rst Normal file
View File

@ -0,0 +1,24 @@
/v2/controller/projects/{project_id}/commit
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/projects/**{project_id}**/commit
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Write changes on disk
Parameters
**********
- **project_id**: The UUID of the project
Response status codes
**********************
- **404**: The project doesn't exist
- **204**: Changes have been written on disk
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidcommit.txt

4
docs/api/v2/controller/server.rst → docs/api/v2/controller/vm.rst
View File

@ -1,8 +1,8 @@
Server
Vm
-----------------------------
.. toctree::
:glob:
:maxdepth: 2
server/*
vm/*

56
docs/api/v2/controller/vm/projectsprojectidvms.rst Normal file
View File

@ -0,0 +1,56 @@
/v2/controller/projects/{project_id}/vms
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/controller/projects/**{project_id}**/vms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Create a new VM instance
Parameters
**********
- **project_id**: UUID for the project
Response status codes
**********************
- **400**: Invalid request
- **201**: Instance created
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</td> </tr>
<tr><td>hypervisor_id</td> <td>&#10004;</td> <td>string</td> <td>Hypervisor identifier</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VM name</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>VM identifier</td> </tr>
<tr><td>vm_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>console</td> <td> </td> <td>['integer', 'null']</td> <td>Console TCP port</td> </tr>
<tr><td>console_type</td> <td> </td> <td>enum</td> <td>Possible values: serial, vnc, telnet</td> </tr>
<tr><td>hypervisor_id</td> <td>&#10004;</td> <td>string</td> <td>Hypervisor identifier</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>VM name</td> </tr>
<tr><td>project_id</td> <td> </td> <td>string</td> <td>Project identifier</td> </tr>
<tr><td>properties</td> <td> </td> <td>object</td> <td>Properties specific to an emulator</td> </tr>
<tr><td>vm_id</td> <td> </td> <td>string</td> <td>VM identifier</td> </tr>
<tr><td>vm_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: docker, dynamips, vpcs, virtualbox, vmware, iou</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_projectsprojectidvms.txt

2
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsid.rst
View File

@ -9,8 +9,8 @@ Delete a Docker container
Parameters
**********
- **id**: ID for the container
- **project_id**: UUID for the project
- **id**: ID for the container
Response status codes
**********************

2
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidreload.rst
View File

@ -9,8 +9,8 @@ Restart a Docker container
Parameters
**********
- **id**: ID of the container
- **project_id**: UUID of the project
- **id**: ID of the container
Response status codes
**********************

2
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidstart.rst
View File

@ -9,8 +9,8 @@ Start a Docker container
Parameters
**********
- **id**: ID of the container
- **project_id**: UUID of the project
- **id**: ID of the container
Response status codes
**********************

2
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidstop.rst
View File

@ -9,8 +9,8 @@ Stop a Docker container
Parameters
**********
- **id**: ID of the container
- **project_id**: UUID of the project
- **id**: ID of the container
Response status codes
**********************

2
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsidsuspend.rst
View File

@ -9,8 +9,8 @@ Pause a Docker container
Parameters
**********
- **id**: ID of the container
- **project_id**: UUID of the project
- **id**: ID of the container
Response status codes
**********************

2
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmid.rst
View File

@ -9,8 +9,8 @@ Update a Docker instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

4
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdnio.rst
View File

@ -9,9 +9,9 @@ Add a NIO to a Docker container
Parameters
**********
- **project_id**: UUID for the project
- **id**: ID of the container
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **adapter_number**: Adapter where the nio should be added
Response status codes
@ -33,9 +33,9 @@ Remove a NIO from a Docker container
Parameters
**********
- **project_id**: UUID for the project
- **id**: ID of the container
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
- **adapter_number**: Adapter where the nio should be added
Response status codes

4
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
View File

@ -9,10 +9,10 @@ Start a packet capture on a IOU VM instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port on the adapter
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
Response status codes
**********************

4
docs/api/v2/hypervisor/docker/projectsprojectiddockervmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst
View File

@ -9,10 +9,10 @@ Stop a packet capture on a IOU VM instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
Response status codes
**********************

6
docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceid.rst
View File

@ -9,8 +9,8 @@ Get a Dynamips device instance
Parameters
**********
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
Response status codes
**********************
@ -38,8 +38,8 @@ Update a Dynamips device instance
Parameters
**********
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
Response status codes
**********************
@ -96,8 +96,8 @@ Delete a Dynamips device instance
Parameters
**********
- **device_id**: UUID for the instance
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
Response status codes
**********************

4
docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdnio.rst
View File

@ -9,9 +9,9 @@ Add a NIO to a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
- **port_number**: Port on the device
- **project_id**: UUID for the project
Response status codes
**********************
@ -139,9 +139,9 @@ Remove a NIO from a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
- **port_number**: Port on the device
- **project_id**: UUID for the project
Response status codes
**********************

2
docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstartcapture.rst
View File

@ -9,9 +9,9 @@ Start a packet capture on a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
- **port_number**: Port on the device
- **project_id**: UUID for the project
Response status codes
**********************

2
docs/api/v2/hypervisor/dynamips_device/projectsprojectiddynamipsdevicesdeviceidportsportnumberdstopcapture.rst
View File

@ -9,9 +9,9 @@ Stop a packet capture on a Dynamips device instance
Parameters
**********
- **project_id**: UUID for the project
- **device_id**: UUID for the instance
- **port_number**: Port on the device
- **project_id**: UUID for the project
Response status codes
**********************

6
docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmid.rst
View File

@ -9,8 +9,8 @@ Get a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@ -77,8 +77,8 @@ Update a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@ -194,8 +194,8 @@ Delete a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

8
docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdnio.rst
View File

@ -9,10 +9,10 @@ Add a NIO to a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port on the adapter
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter where the nio should be added
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
Response status codes
**********************
@ -27,10 +27,10 @@ Remove a NIO from a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port on the adapter
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter from where the nio should be removed
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
Response status codes
**********************

4
docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
View File

@ -9,10 +9,10 @@ Start a packet capture on a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port on the adapter
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
Response status codes
**********************

4
docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst
View File

@ -9,10 +9,10 @@ Stop a packet capture on a Dynamips VM instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
Response status codes
**********************

2
docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidreload.rst
View File

@ -9,8 +9,8 @@ Reload a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

2
docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidresume.rst
View File

@ -9,8 +9,8 @@ Resume a suspended Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

2
docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidstart.rst
View File

@ -9,8 +9,8 @@ Start a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

2
docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidstop.rst
View File

@ -9,8 +9,8 @@ Stop a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

2
docs/api/v2/hypervisor/dynamips_vm/projectsprojectiddynamipsvmsvmidsuspend.rst
View File

@ -9,8 +9,8 @@ Suspend a Dynamips VM instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

6
docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmid.rst
View File

@ -9,8 +9,8 @@ Get a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@ -56,8 +56,8 @@ Update a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************
@ -125,8 +125,8 @@ Delete a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

8
docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdnio.rst
View File

@ -9,10 +9,10 @@ Add a NIO to a IOU instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port where the nio should be added
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port where the nio should be added
- **project_id**: UUID for the project
Response status codes
**********************
@ -33,10 +33,10 @@ Remove a NIO from a IOU instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port from where the nio should be removed
- **vm_id**: UUID for the instance
- **adapter_number**: Network adapter where the nio is located
- **port_number**: Port from where the nio should be removed
- **project_id**: UUID for the project
Response status codes
**********************

4
docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstartcapture.rst
View File

@ -9,10 +9,10 @@ Start a packet capture on a IOU VM instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port on the adapter
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to start a packet capture
- **port_number**: Port on the adapter
- **project_id**: UUID for the project
Response status codes
**********************

4
docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidadaptersadapternumberdportsportnumberdstopcapture.rst
View File

@ -9,10 +9,10 @@ Stop a packet capture on a IOU VM instance
Parameters
**********
- **project_id**: UUID for the project
- **port_number**: Port on the adapter (always 0)
- **vm_id**: UUID for the instance
- **adapter_number**: Adapter to stop a packet capture
- **port_number**: Port on the adapter (always 0)
- **project_id**: UUID for the project
Response status codes
**********************

2
docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidreload.rst
View File

@ -9,8 +9,8 @@ Reload a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

2
docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidstart.rst
View File

@ -9,8 +9,8 @@ Start a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

2
docs/api/v2/hypervisor/iou/projectsprojectidiouvmsvmidstop.rst
View File

@ -9,8 +9,8 @@ Stop a IOU instance
Parameters
**********
- **vm_id**: UUID for the instance
- **project_id**: UUID for the project
- **vm_id**: UUID for the instance
Response status codes
**********************

Some files were not shown because too many files have changed in this diff Show More