From 1289d20a14a57b9d7007df4b3a51bb861c27fdd0 Mon Sep 17 00:00:00 2001 From: grossmj Date: Tue, 20 Nov 2018 15:19:44 +0700 Subject: [PATCH] Add missing files for API documentation. --- ...ternumberdportsportnumberdstartcapture.txt | 20 ++++ ...pternumberdportsportnumberdstopcapture.txt | 14 +++ ...ternumberdportsportnumberdstartcapture.txt | 20 ++++ ...pternumberdportsportnumberdstopcapture.txt | 14 +++ ...ternumberdportsportnumberdstartcapture.txt | 20 ++++ ...pternumberdportsportnumberdstopcapture.txt | 14 +++ ...ternumberdportsportnumberdstartcapture.txt | 20 ++++ ...pternumberdportsportnumberdstopcapture.txt | 14 +++ ...ternumberdportsportnumberdstartcapture.txt | 20 ++++ ...pternumberdportsportnumberdstopcapture.txt | 14 +++ ...ternumberdportsportnumberdstartcapture.txt | 20 ++++ ...pternumberdportsportnumberdstopcapture.txt | 14 +++ ...ternumberdportsportnumberdstartcapture.txt | 20 ++++ ...pternumberdportsportnumberdstopcapture.txt | 14 +++ ...ontroller_delete_appliancesapplianceid.txt | 14 +++ .../controller_get_appliancesapplianceid.txt | 28 +++++ .../examples/controller_post_appliances.txt | 62 ++++++++++ ...er_post_appliancesapplianceidduplicate.txt | 27 +++++ .../controller_put_appliancesapplianceid.txt | 38 +++++++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ docs/api/v2/compute/network/networkports.rst | 13 +++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ ...tersadapternumberdportsportnumberdpcap.rst | 22 ++++ .../appliance/appliancesapplianceid.rst | 107 ++++++++++++++++++ .../appliancesapplianceidduplicate.rst | 41 +++++++ docs/api/v2/controller/compute/sidports.rst | 29 +++++ docs/api/v2/controller/server/ioulicense.rst | 22 ++++ 38 files changed, 927 insertions(+) create mode 100644 docs/api/examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt create mode 100644 docs/api/examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt create mode 100644 docs/api/examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt create mode 100644 docs/api/examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt create mode 100644 docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt create mode 100644 docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt create mode 100644 docs/api/examples/compute_post_projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt create mode 100644 docs/api/examples/compute_post_projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt create mode 100644 docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt create mode 100644 docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt create mode 100644 docs/api/examples/compute_post_projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt create mode 100644 docs/api/examples/compute_post_projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt create mode 100644 docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt create mode 100644 docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt create mode 100644 docs/api/examples/controller_delete_appliancesapplianceid.txt create mode 100644 docs/api/examples/controller_get_appliancesapplianceid.txt create mode 100644 docs/api/examples/controller_post_appliances.txt create mode 100644 docs/api/examples/controller_post_appliancesapplianceidduplicate.txt create mode 100644 docs/api/examples/controller_put_appliancesapplianceid.txt create mode 100644 docs/api/v2/compute/atm_switch/projectsprojectidatmrelayswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/compute/network/networkports.rst create mode 100644 docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst create mode 100644 docs/api/v2/controller/appliance/appliancesapplianceid.rst create mode 100644 docs/api/v2/controller/appliance/appliancesapplianceidduplicate.rst create mode 100644 docs/api/v2/controller/compute/sidports.rst create mode 100644 docs/api/v2/controller/server/ioulicense.rst diff --git a/docs/api/examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt new file mode 100644 index 00000000..abfc64cc --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt @@ -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" +} diff --git a/docs/api/examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt new file mode 100644 index 00000000..e0d2e110 --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt @@ -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 + diff --git a/docs/api/examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt new file mode 100644 index 00000000..fc12dc53 --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt @@ -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" +} diff --git a/docs/api/examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt new file mode 100644 index 00000000..91657555 --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt @@ -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 + diff --git a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt new file mode 100644 index 00000000..6879682e --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt @@ -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" +} diff --git a/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt new file mode 100644 index 00000000..f05bd718 --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt @@ -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 + diff --git a/docs/api/examples/compute_post_projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/compute_post_projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt new file mode 100644 index 00000000..86e55122 --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt @@ -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" +} diff --git a/docs/api/examples/compute_post_projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/compute_post_projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt new file mode 100644 index 00000000..953e2926 --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt @@ -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 + diff --git a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt new file mode 100644 index 00000000..befe91fd --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt @@ -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" +} diff --git a/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt new file mode 100644 index 00000000..878ba5f3 --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt @@ -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 + diff --git a/docs/api/examples/compute_post_projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/compute_post_projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt new file mode 100644 index 00000000..43bbbfb8 --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt @@ -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" +} diff --git a/docs/api/examples/compute_post_projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/compute_post_projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt new file mode 100644 index 00000000..464b5667 --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt @@ -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 + diff --git a/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt b/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt new file mode 100644 index 00000000..d44abf4a --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstartcapture.txt @@ -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" +} diff --git a/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt b/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt new file mode 100644 index 00000000..64ad7965 --- /dev/null +++ b/docs/api/examples/compute_post_projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdstopcapture.txt @@ -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 + diff --git a/docs/api/examples/controller_delete_appliancesapplianceid.txt b/docs/api/examples/controller_delete_appliancesapplianceid.txt new file mode 100644 index 00000000..02eb26a4 --- /dev/null +++ b/docs/api/examples/controller_delete_appliancesapplianceid.txt @@ -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} + diff --git a/docs/api/examples/controller_get_appliancesapplianceid.txt b/docs/api/examples/controller_get_appliancesapplianceid.txt new file mode 100644 index 00000000..ddb1c8dc --- /dev/null +++ b/docs/api/examples/controller_get_appliancesapplianceid.txt @@ -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" +} diff --git a/docs/api/examples/controller_post_appliances.txt b/docs/api/examples/controller_post_appliances.txt new file mode 100644 index 00000000..957d540c --- /dev/null +++ b/docs/api/examples/controller_post_appliances.txt @@ -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" +} diff --git a/docs/api/examples/controller_post_appliancesapplianceidduplicate.txt b/docs/api/examples/controller_post_appliancesapplianceidduplicate.txt new file mode 100644 index 00000000..3edc0cec --- /dev/null +++ b/docs/api/examples/controller_post_appliancesapplianceidduplicate.txt @@ -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" +} diff --git a/docs/api/examples/controller_put_appliancesapplianceid.txt b/docs/api/examples/controller_put_appliancesapplianceid.txt new file mode 100644 index 00000000..bcdfeddc --- /dev/null +++ b/docs/api/examples/controller_put_appliancesapplianceid.txt @@ -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" +} diff --git a/docs/api/v2/compute/atm_switch/projectsprojectidatmrelayswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/atm_switch/projectsprojectidatmrelayswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..c1cbb7c0 --- /dev/null +++ b/docs/api/v2/compute/atm_switch/projectsprojectidatmrelayswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..c9d8b64c --- /dev/null +++ b/docs/api/v2/compute/cloud/projectsprojectidcloudnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..c52514dc --- /dev/null +++ b/docs/api/v2/compute/docker/projectsprojectiddockernodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..19695b66 --- /dev/null +++ b/docs/api/v2/compute/dynamips_vm/projectsprojectiddynamipsnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..cd880412 --- /dev/null +++ b/docs/api/v2/compute/ethernet_hub/projectsprojectidethernethubnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..e1d349d5 --- /dev/null +++ b/docs/api/v2/compute/ethernet_switch/projectsprojectidethernetswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..03856bed --- /dev/null +++ b/docs/api/v2/compute/frame_relay_switch/projectsprojectidframerelayswitchnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..2fdd89d9 --- /dev/null +++ b/docs/api/v2/compute/iou/projectsprojectidiounodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..b70f35fc --- /dev/null +++ b/docs/api/v2/compute/nat/projectsprojectidnatnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/compute/network/networkports.rst b/docs/api/v2/compute/network/networkports.rst new file mode 100644 index 00000000..7e7a4c14 --- /dev/null +++ b/docs/api/v2/compute/network/networkports.rst @@ -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 + diff --git a/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..b5dc1803 --- /dev/null +++ b/docs/api/v2/compute/qemu/projectsprojectidqemunodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..b4651830 --- /dev/null +++ b/docs/api/v2/compute/traceng/projectsprojectidtracengnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..6bfa6198 --- /dev/null +++ b/docs/api/v2/compute/virtualbox/projectsprojectidvirtualboxnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..05c91f74 --- /dev/null +++ b/docs/api/v2/compute/vmware/projectsprojectidvmwarenodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst new file mode 100644 index 00000000..2d2d191b --- /dev/null +++ b/docs/api/v2/compute/vpcs/projectsprojectidvpcsnodesnodeidadaptersadapternumberdportsportnumberdpcap.rst @@ -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 + diff --git a/docs/api/v2/controller/appliance/appliancesapplianceid.rst b/docs/api/v2/controller/appliance/appliancesapplianceid.rst new file mode 100644 index 00000000..953bd936 --- /dev/null +++ b/docs/api/v2/controller/appliance/appliancesapplianceid.rst @@ -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 + + + + + + + + + + + +
Name Mandatory Type Description
appliance_id ✔ string Appliance UUID from which the node has been created. Read only
appliance_type ✔ enum Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu
builtin ✔ boolean Appliance is builtin
category ✔ Appliance category
compute_id ✔ string Compute identifier
default_name_format ✔ string Default name format
name ✔ string Appliance name
symbol ✔ string Symbol of the appliance
+ +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 + + + + + + + + + + + +
Name Mandatory Type Description
appliance_id string Appliance UUID from which the node has been created. Read only
appliance_type enum Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu
builtin boolean Appliance is builtin
category Appliance category
compute_id string Compute identifier
default_name_format string Default name format
name string Appliance name
symbol string Symbol of the appliance
+ +Output +******* +.. raw:: html + + + + + + + + + + + +
Name Mandatory Type Description
appliance_id ✔ string Appliance UUID from which the node has been created. Read only
appliance_type ✔ enum Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu
builtin ✔ boolean Appliance is builtin
category ✔ Appliance category
compute_id ✔ string Compute identifier
default_name_format ✔ string Default name format
name ✔ string Appliance name
symbol ✔ string Symbol of the appliance
+ +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 + diff --git a/docs/api/v2/controller/appliance/appliancesapplianceidduplicate.rst b/docs/api/v2/controller/appliance/appliancesapplianceidduplicate.rst new file mode 100644 index 00000000..0a82fedf --- /dev/null +++ b/docs/api/v2/controller/appliance/appliancesapplianceidduplicate.rst @@ -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 + + + + + + + + + + + +
Name Mandatory Type Description
appliance_id ✔ string Appliance UUID from which the node has been created. Read only
appliance_type ✔ enum Possible values: cloud, ethernet_hub, ethernet_switch, docker, dynamips, vpcs, traceng, virtualbox, vmware, iou, qemu
builtin ✔ boolean Appliance is builtin
category ✔ Appliance category
compute_id ✔ string Compute identifier
default_name_format ✔ string Default name format
name ✔ string Appliance name
symbol ✔ string Symbol of the appliance
+ +Sample session +*************** + + +.. literalinclude:: ../../../examples/controller_post_appliancesapplianceidduplicate.txt + diff --git a/docs/api/v2/controller/compute/sidports.rst b/docs/api/v2/controller/compute/sidports.rst new file mode 100644 index 00000000..d3be0075 --- /dev/null +++ b/docs/api/v2/controller/compute/sidports.rst @@ -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 + + + + + + + +
Name Mandatory Type Description
console_port_range array Console port range
console_ports array Console ports used by the compute
udp_port_range array UDP port range
udp_ports array UDP ports used by the compute
+ diff --git a/docs/api/v2/controller/server/ioulicense.rst b/docs/api/v2/controller/server/ioulicense.rst new file mode 100644 index 00000000..d1981d80 --- /dev/null +++ b/docs/api/v2/controller/server/ioulicense.rst @@ -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 +