NgTech-LTD/gns3-server
2
0
Fork 0
mirror of https://github.com/GNS3/gns3-server.git synced 2024-11-16 16:54:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add missing files for API documentation.

Browse Source
This commit is contained in:
grossmj 2018-11-20 15:19:44 +07:00
parent 53928b884f
commit 1289d20a14
38 changed files with 927 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/api/examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt Normal file
View File

@ -0,0 +1,20 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/cloud/nodes/e6bc5a49-d2ce-4799-a65b-f118646eca13/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/cloud/nodes/e6bc5a49-d2ce-4799-a65b-f118646eca13/adapters/0/ports/0/start_capture HTTP/1.1
{
"capture_file_name": "test.pcap",
"data_link_type": "DLT_EN10MB"
}
HTTP/1.1 200
Connection: close
Content-Length: 104
Content-Type: application/json
Date: Tue, 20 Nov 2018 05:59:53 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/cloud/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
{
"pcap_file_path": "/tmp/pytest-of-grossmj/pytest-36/test_json4/project-files/captures/test.pcap"
}

14
docs/api/examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt Normal file
View File

@ -0,0 +1,14 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/cloud/nodes/abfd8d3a-3c56-4b15-95d8-1da6c1c8faf3/adapters/0/ports/0/stop_capture' -d '{}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/cloud/nodes/abfd8d3a-3c56-4b15-95d8-1da6c1c8faf3/adapters/0/ports/0/stop_capture HTTP/1.1
{}
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Tue, 20 Nov 2018 05:59:53 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/cloud/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture

20
docs/api/examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt Normal file
View File

@ -0,0 +1,20 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/nat/nodes/2edccb95-7fae-4448-bd31-16994adbadac/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/nat/nodes/2edccb95-7fae-4448-bd31-16994adbadac/adapters/0/ports/0/start_capture HTTP/1.1
{
"capture_file_name": "test.pcap",
"data_link_type": "DLT_EN10MB"
}
HTTP/1.1 200
Connection: close
Content-Length: 104
Content-Type: application/json
Date: Tue, 20 Nov 2018 06:00:01 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/nat/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
{
"pcap_file_path": "/tmp/pytest-of-grossmj/pytest-36/test_json4/project-files/captures/test.pcap"
}

14
docs/api/examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt Normal file
View File

@ -0,0 +1,14 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/nat/nodes/7971dba5-3e69-4171-a2eb-4d536306de70/adapters/0/ports/0/stop_capture' -d '{}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/nat/nodes/7971dba5-3e69-4171-a2eb-4d536306de70/adapters/0/ports/0/stop_capture HTTP/1.1
{}
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Tue, 20 Nov 2018 06:00:01 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/nat/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture

20
docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt Normal file
View File

@ -0,0 +1,20 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/3cccca4a-df04-435b-9005-d5958ad2313e/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/3cccca4a-df04-435b-9005-d5958ad2313e/adapters/0/ports/0/start_capture HTTP/1.1
{
"capture_file_name": "test.pcap",
"data_link_type": "DLT_EN10MB"
}
HTTP/1.1 200
Connection: close
Content-Length: 123
Content-Type: application/json
Date: Tue, 20 Nov 2018 06:00:37 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/qemu/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
{
"pcap_file_path": "/tmp/tmph4dpdlx_/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
}

14
docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt Normal file
View File

@ -0,0 +1,14 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/8550cc69-3698-4397-a0f6-4fde1152de95/adapters/0/ports/0/stop_capture' -d '{}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/qemu/nodes/8550cc69-3698-4397-a0f6-4fde1152de95/adapters/0/ports/0/stop_capture HTTP/1.1
{}
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Tue, 20 Nov 2018 06:00:37 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/qemu/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture

20
docs/api/examples/compute_post_projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt Normal file
View File

@ -0,0 +1,20 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/traceng/nodes/837982bc-0f0c-4869-b121-fb59ee30bc85/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/traceng/nodes/837982bc-0f0c-4869-b121-fb59ee30bc85/adapters/0/ports/0/start_capture HTTP/1.1
{
"capture_file_name": "test.pcap",
"data_link_type": "DLT_EN10MB"
}
HTTP/1.1 200
Connection: close
Content-Length: 123
Content-Type: application/json
Date: Tue, 20 Nov 2018 06:00:39 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/traceng/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
{
"pcap_file_path": "/tmp/tmph4dpdlx_/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
}

14
docs/api/examples/compute_post_projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt Normal file
View File

@ -0,0 +1,14 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/traceng/nodes/d49396d8-b927-4a55-a99b-b5f858e60cf5/adapters/0/ports/0/stop_capture' -d '{}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/traceng/nodes/d49396d8-b927-4a55-a99b-b5f858e60cf5/adapters/0/ports/0/stop_capture HTTP/1.1
{}
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Tue, 20 Nov 2018 06:00:39 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/traceng/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture

20
docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt Normal file
View File

@ -0,0 +1,20 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/a8bd1f77-0840-47ab-9cfa-895ce462d3fc/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/a8bd1f77-0840-47ab-9cfa-895ce462d3fc/adapters/0/ports/0/start_capture HTTP/1.1
{
"capture_file_name": "test.pcap",
"data_link_type": "DLT_EN10MB"
}
HTTP/1.1 200
Connection: close
Content-Length: 123
Content-Type: application/json
Date: Tue, 20 Nov 2018 06:00:40 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/virtualbox/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
{
"pcap_file_path": "/tmp/tmph4dpdlx_/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
}

14
docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt Normal file
View File

@ -0,0 +1,14 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/452ccaf9-fc46-47ae-b36d-30370ce380c6/adapters/0/ports/0/stop_capture' -d '{}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/virtualbox/nodes/452ccaf9-fc46-47ae-b36d-30370ce380c6/adapters/0/ports/0/stop_capture HTTP/1.1
{}
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Tue, 20 Nov 2018 06:00:40 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/virtualbox/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture

20
docs/api/examples/compute_post_projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt Normal file
View File

@ -0,0 +1,20 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vmware/nodes/a860e414-f9c6-4135-a72b-465eb93eb898/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vmware/nodes/a860e414-f9c6-4135-a72b-465eb93eb898/adapters/0/ports/0/start_capture HTTP/1.1
{
"capture_file_name": "test.pcap",
"data_link_type": "DLT_EN10MB"
}
HTTP/1.1 200
Connection: close
Content-Length: 123
Content-Type: application/json
Date: Tue, 20 Nov 2018 06:00:54 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/vmware/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
{
"pcap_file_path": "/tmp/tmph4dpdlx_/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
}

14
docs/api/examples/compute_post_projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt Normal file
View File

@ -0,0 +1,14 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vmware/nodes/246d16ac-c644-4ad5-8614-b0edc0a954c5/adapters/0/ports/0/stop_capture' -d '{}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vmware/nodes/246d16ac-c644-4ad5-8614-b0edc0a954c5/adapters/0/ports/0/stop_capture HTTP/1.1
{}
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Tue, 20 Nov 2018 06:00:55 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/vmware/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture

20
docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt Normal file
View File

@ -0,0 +1,20 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/05aec68c-9d56-48cb-aa00-7a693aede93e/adapters/0/ports/0/start_capture' -d '{"capture_file_name": "test.pcap", "data_link_type": "DLT_EN10MB"}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/05aec68c-9d56-48cb-aa00-7a693aede93e/adapters/0/ports/0/start_capture HTTP/1.1
{
"capture_file_name": "test.pcap",
"data_link_type": "DLT_EN10MB"
}
HTTP/1.1 200
Connection: close
Content-Length: 123
Content-Type: application/json
Date: Tue, 20 Nov 2018 06:00:59 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/start_capture
{
"pcap_file_path": "/tmp/tmph4dpdlx_/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/project-files/captures/test.pcap"
}

14
docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt Normal file
View File

@ -0,0 +1,14 @@
curl -i -X POST 'http://localhost:3080/v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/96e6d109-d260-4bbb-9765-149098ac4fb3/adapters/0/ports/0/stop_capture' -d '{}'
POST /v2/compute/projects/a1e920ca-338a-4e9f-b363-aa607b09dd80/vpcs/nodes/96e6d109-d260-4bbb-9765-149098ac4fb3/adapters/0/ports/0/stop_capture HTTP/1.1
{}
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Tue, 20 Nov 2018 06:00:59 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/compute/projects/{project_id}/vpcs/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/stop_capture

14
docs/api/examples/controller_delete_appliancesapplianceid.txt Normal file
View File

@ -0,0 +1,14 @@
curl -i -X DELETE 'http://localhost:3080/v2/appliances/259b41b8-d70a-4882-8ba3-017ee11ecd99'
DELETE /v2/appliances/259b41b8-d70a-4882-8ba3-017ee11ecd99 HTTP/1.1
HTTP/1.1 204
Connection: close
Content-Length: 0
Content-Type: application/octet-stream
Date: Tue, 20 Nov 2018 06:01:00 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/appliances/{appliance_id}

28
docs/api/examples/controller_get_appliancesapplianceid.txt Normal file
View File

@ -0,0 +1,28 @@
curl -i -X GET 'http://localhost:3080/v2/appliances/0579a18f-77c6-4da6-b410-a9a1ab790606'
GET /v2/appliances/0579a18f-77c6-4da6-b410-a9a1ab790606 HTTP/1.1
HTTP/1.1 200
Connection: close
Content-Length: 380
Content-Type: application/json
Date: Tue, 20 Nov 2018 06:01:00 GMT
ETag: "80cc9ad2c2b83a9f439433f47ad78f62"
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/appliances/{appliance_id}
{
"appliance_id": "0579a18f-77c6-4da6-b410-a9a1ab790606",
"appliance_type": "vpcs",
"base_script_file": "vpcs_base_config.txt",
"builtin": false,
"category": "guest",
"compute_id": "local",
"console_auto_start": false,
"console_type": "telnet",
"default_name_format": "PC{0}",
"name": "VPCS_TEST",
"symbol": ":/symbols/vpcs_guest.svg"
}

62
docs/api/examples/controller_post_appliances.txt Normal file
View File

@ -0,0 +1,62 @@
curl -i -X POST 'http://localhost:3080/v2/appliances' -d '{"appliance_type": "ethernet_hub", "compute_id": "local", "name": "Ethernet hub appliance"}'
POST /v2/appliances HTTP/1.1
{
"appliance_type": "ethernet_hub",
"compute_id": "local",
"name": "Ethernet hub appliance"
}
HTTP/1.1 201
Connection: close
Content-Length: 978
Content-Type: application/json
Date: Tue, 20 Nov 2018 06:01:01 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/appliances
{
"appliance_id": "a5ee20d1-1217-4c2f-93d8-eefc1fba7a92",
"appliance_type": "ethernet_hub",
"builtin": false,
"category": "switch",
"compute_id": "local",
"default_name_format": "Hub{0}",
"name": "Ethernet hub appliance",
"ports_mapping": [
{
"name": "Ethernet0",
"port_number": 0
},
{
"name": "Ethernet1",
"port_number": 1
},
{
"name": "Ethernet2",
"port_number": 2
},
{
"name": "Ethernet3",
"port_number": 3
},
{
"name": "Ethernet4",
"port_number": 4
},
{
"name": "Ethernet5",
"port_number": 5
},
{
"name": "Ethernet6",
"port_number": 6
},
{
"name": "Ethernet7",
"port_number": 7
}
],
"symbol": ":/symbols/hub.svg"
}

27
docs/api/examples/controller_post_appliancesapplianceidduplicate.txt Normal file
View File

@ -0,0 +1,27 @@
curl -i -X POST 'http://localhost:3080/v2/appliances/226095d7-c228-46d7-a7d6-dd488a9027a4/duplicate' -d '{}'
POST /v2/appliances/226095d7-c228-46d7-a7d6-dd488a9027a4/duplicate HTTP/1.1
{}
HTTP/1.1 201
Connection: close
Content-Length: 380
Content-Type: application/json
Date: Tue, 20 Nov 2018 06:01:00 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/appliances/{appliance_id}/duplicate
{
"appliance_id": "79876d13-3e21-434e-9b4c-3ace1c88493c",
"appliance_type": "vpcs",
"base_script_file": "vpcs_base_config.txt",
"builtin": false,
"category": "guest",
"compute_id": "local",
"console_auto_start": false,
"console_type": "telnet",
"default_name_format": "PC{0}",
"name": "VPCS_TEST",
"symbol": ":/symbols/vpcs_guest.svg"
}

38
docs/api/examples/controller_put_appliancesapplianceid.txt Normal file
View File

@ -0,0 +1,38 @@
curl -i -X PUT 'http://localhost:3080/v2/appliances/a96be97e-5ffe-4225-af8b-6347f858a2e5' -d '{"appliance_id": "a96be97e-5ffe-4225-af8b-6347f858a2e5", "appliance_type": "vpcs", "base_script_file": "vpcs_base_config.txt", "category": "guest", "compute_id": "local", "console_auto_start": false, "console_type": "telnet", "default_name_format": "PC{0}", "name": "VPCS_TEST_RENAMED", "symbol": ":/symbols/vpcs_guest.svg"}'
PUT /v2/appliances/a96be97e-5ffe-4225-af8b-6347f858a2e5 HTTP/1.1
{
"appliance_id": "a96be97e-5ffe-4225-af8b-6347f858a2e5",
"appliance_type": "vpcs",
"base_script_file": "vpcs_base_config.txt",
"category": "guest",
"compute_id": "local",
"console_auto_start": false,
"console_type": "telnet",
"default_name_format": "PC{0}",
"name": "VPCS_TEST_RENAMED",
"symbol": ":/symbols/vpcs_guest.svg"
}
HTTP/1.1 200
Connection: close
Content-Length: 388
Content-Type: application/json
Date: Tue, 20 Nov 2018 06:01:00 GMT
Server: Python/3.6 GNS3/2.2.0dev4
X-Route: /v2/appliances/{appliance_id}
{
"appliance_id": "a96be97e-5ffe-4225-af8b-6347f858a2e5",
"appliance_type": "vpcs",
"base_script_file": "vpcs_base_config.txt",
"builtin": false,
"category": "guest",
"compute_id": "local",
"console_auto_start": false,
"console_type": "telnet",
"default_name_format": "PC{0}",
"name": "VPCS_TEST_RENAMED",
"symbol": ":/symbols/vpcs_guest.svg"
}

22
docs/api/v2/compute/atm_switch/projectsprojectidatmrelayswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/atm_relay_switch/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/atm_relay_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

22
docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/cloud/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/cloud/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture (always 0)
- **port_number**: Port on the cloud
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

22
docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/docker/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/docker/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

22
docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/dynamips/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/dynamips/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

22
docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/ethernet_hub/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/ethernet_hub/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture (always 0)
- **port_number**: Port on the hub
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

22
docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/ethernet_switch/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/ethernet_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

22
docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/frame_relay_switch/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/frame_relay_switch/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture (always 0)
- **port_number**: Port on the switch
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

22
docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/iou/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/iou/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

22
docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/nat/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/nat/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture (always 0)
- **port_number**: Port on the nat
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

13
docs/api/v2/compute/network/networkports.rst Normal file
View File

@ -0,0 +1,13 @@
/v2/compute/network/ports
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/network/ports
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
List all the ports used by the server
Response status codes
**********************
- **200**: OK

22
docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/qemu/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/qemu/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

22
docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/traceng/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/traceng/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture
- **port_number**: Port on the adapter
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

22
docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/virtualbox/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/virtualbox/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

22
docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/vmware/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/vmware/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture
- **port_number**: Port on the adapter (always 0)
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

22
docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/compute/projects/{project_id}/vpcs/nodes/{node_id}/adapters/{adapter_number:\d+}/ports/{port_number:\d+}/pcap
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/compute/projects/**{project_id}**/vpcs/nodes/**{node_id}**/adapters/**{adapter_number:\d+}**/ports/**{port_number:\d+}**/pcap
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Stream the pcap capture file
Parameters
**********
- **project_id**: Project UUID
- **node_id**: Node UUID
- **adapter_number**: Adapter to steam a packet capture
- **port_number**: Port on the adapter
Response status codes
**********************
- **200**: File returned
- **403**: Permission denied
- **404**: The file doesn't exist

107
docs/api/v2/controller/appliance/appliancesapplianceid.rst Normal file
View File

@ -0,0 +1,107 @@
/v2/appliances/{appliance_id}
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/appliances/**{appliance_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get an appliance
Response status codes
**********************
- **200**: Appliance found
- **400**: Invalid request
- **404**: Appliance doesn't exist
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>appliance_id</td> <td>&#10004;</td> <td>string</td> <td>Appliance UUID from which the node has been created. Read only</td> </tr>
<tr><td>appliance_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>builtin</td> <td>&#10004;</td> <td>boolean</td> <td>Appliance is builtin</td> </tr>
<tr><td>category</td> <td>&#10004;</td> <td></td> <td>Appliance category</td> </tr>
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>default_name_format</td> <td>&#10004;</td> <td>string</td> <td>Default name format</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Appliance name</td> </tr>
<tr><td>symbol</td> <td>&#10004;</td> <td>string</td> <td>Symbol of the appliance</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_get_appliancesapplianceid.txt
PUT /v2/appliances/**{appliance_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update an appliance
Response status codes
**********************
- **200**: Appliance updated
- **400**: Invalid request
- **404**: Appliance doesn't exist
Input
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>appliance_id</td> <td> </td> <td>string</td> <td>Appliance UUID from which the node has been created. Read only</td> </tr>
<tr><td>appliance_type</td> <td> </td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>builtin</td> <td> </td> <td>boolean</td> <td>Appliance is builtin</td> </tr>
<tr><td>category</td> <td> </td> <td></td> <td>Appliance category</td> </tr>
<tr><td>compute_id</td> <td> </td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>default_name_format</td> <td> </td> <td>string</td> <td>Default name format</td> </tr>
<tr><td>name</td> <td> </td> <td>string</td> <td>Appliance name</td> </tr>
<tr><td>symbol</td> <td> </td> <td>string</td> <td>Symbol of the appliance</td> </tr>
</table>
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>appliance_id</td> <td>&#10004;</td> <td>string</td> <td>Appliance UUID from which the node has been created. Read only</td> </tr>
<tr><td>appliance_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>builtin</td> <td>&#10004;</td> <td>boolean</td> <td>Appliance is builtin</td> </tr>
<tr><td>category</td> <td>&#10004;</td> <td></td> <td>Appliance category</td> </tr>
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>default_name_format</td> <td>&#10004;</td> <td>string</td> <td>Default name format</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Appliance name</td> </tr>
<tr><td>symbol</td> <td>&#10004;</td> <td>string</td> <td>Symbol of the appliance</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_put_appliancesapplianceid.txt
DELETE /v2/appliances/**{appliance_id}**
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Delete an appliance
Parameters
**********
- **appliance_id**: appliance UUID
Response status codes
**********************
- **204**: Appliance deleted
- **400**: Invalid request
- **404**: Appliance doesn't exist
Sample session
***************
.. literalinclude:: ../../../examples/controller_delete_appliancesapplianceid.txt

41
docs/api/v2/controller/appliance/appliancesapplianceidduplicate.rst Normal file
View File

@ -0,0 +1,41 @@
/v2/appliances/{appliance_id}/duplicate
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
POST /v2/appliances/**{appliance_id}**/duplicate
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Duplicate an appliance
Parameters
**********
- **appliance_id**: Appliance UUID
Response status codes
**********************
- **201**: Appliance duplicated
- **400**: Invalid request
- **404**: Appliance doesn't exist
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>appliance_id</td> <td>&#10004;</td> <td>string</td> <td>Appliance UUID from which the node has been created. Read only</td> </tr>
<tr><td>appliance_type</td> <td>&#10004;</td> <td>enum</td> <td>Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu</td> </tr>
<tr><td>builtin</td> <td>&#10004;</td> <td>boolean</td> <td>Appliance is builtin</td> </tr>
<tr><td>category</td> <td>&#10004;</td> <td></td> <td>Appliance category</td> </tr>
<tr><td>compute_id</td> <td>&#10004;</td> <td>string</td> <td>Compute identifier</td> </tr>
<tr><td>default_name_format</td> <td>&#10004;</td> <td>string</td> <td>Default name format</td> </tr>
<tr><td>name</td> <td>&#10004;</td> <td>string</td> <td>Appliance name</td> </tr>
<tr><td>symbol</td> <td>&#10004;</td> <td>string</td> <td>Symbol of the appliance</td> </tr>
</table>
Sample session
***************
.. literalinclude:: ../../../examples/controller_post_appliancesapplianceidduplicate.txt

29
docs/api/v2/controller/compute/sidports.rst Normal file
View File

@ -0,0 +1,29 @@
/v2/computes/{compute_id}/ports
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/computes/**{compute_id}**/ports
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get ports used by a compute
Parameters
**********
- **compute_id**: Compute UUID
Response status codes
**********************
- **200**: Ports information returned
Output
*******
.. raw:: html
<table>
<tr> <th>Name</th> <th>Mandatory</th> <th>Type</th> <th>Description</th> </tr>
<tr><td>console_port_range</td> <td> </td> <td>array</td> <td>Console port range</td> </tr>
<tr><td>console_ports</td> <td> </td> <td>array</td> <td>Console ports used by the compute</td> </tr>
<tr><td>udp_port_range</td> <td> </td> <td>array</td> <td>UDP port range</td> </tr>
<tr><td>udp_ports</td> <td> </td> <td>array</td> <td>UDP ports used by the compute</td> </tr>
</table>

22
docs/api/v2/controller/server/ioulicense.rst Normal file
View File

@ -0,0 +1,22 @@
/v2/iou_license
------------------------------------------------------------------------------------------------------------------------------------------
.. contents::
GET /v2/iou_license
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Get the IOU license settings
Response status codes
**********************
- **200**: IOU license settings returned
PUT /v2/iou_license
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Update the IOU license settings
Response status codes
**********************
- **201**: IOU license settings updated