summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorChris Yeoh <cyeoh@au1.ibm.com>2012-11-01 10:49:53 +1030
committerChris Yeoh <cyeoh@au1.ibm.com>2012-11-21 19:38:55 +1030
commit576ada198aa659fd6a0a50fe8ba1ce7d60633089 (patch)
treeb4b271b35b67cf3f87ae13d8edca669e20730988 /doc
parent9dfb4b420f9d15d348f9fa9a2a0cb1a57f4e5771 (diff)
downloadnova-576ada198aa659fd6a0a50fe8ba1ce7d60633089.tar.gz
nova-576ada198aa659fd6a0a50fe8ba1ce7d60633089.tar.xz
nova-576ada198aa659fd6a0a50fe8ba1ce7d60633089.zip
Adds API for bulk creation/deletion of floating IPs
This adds an extension that provides a REST API for the bulk creation, deletion and listing of floating IPs. The interface is accessed via /v2/{tenant_id}/os-floating-ips-bulk This forms part of the work to provide APIs for functionality currently implemented by nova-manage that needs direct db access so nova-manage can eventually be removed Implements: blueprint apis-for-nova-manage DocImpact Change-Id: I621e2b070a896f7230cdf3f26f78ded85e72cf16
Diffstat (limited to 'doc')
-rw-r--r--doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.json8
-rw-r--r--doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.xml6
-rw-r--r--doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.json7
-rw-r--r--doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.xml6
-rw-r--r--doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-req.json3
-rw-r--r--doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-req.xml2
-rw-r--r--doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.json3
-rw-r--r--doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.xml2
-rw-r--r--doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.json11
-rw-r--r--doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.xml10
-rw-r--r--doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.json25
-rw-r--r--doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.xml24
12 files changed, 107 insertions, 0 deletions
diff --git a/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.json b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.json
new file mode 100644
index 000000000..d174bad5a
--- /dev/null
+++ b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.json
@@ -0,0 +1,8 @@
+{
+ "floating_ips_bulk_create" :
+ {
+ "ip_range": "192.168.1.0/24",
+ "pool": "nova",
+ "interface": "eth0"
+ }
+} \ No newline at end of file
diff --git a/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.xml b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.xml
new file mode 100644
index 000000000..1fc730509
--- /dev/null
+++ b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.xml
@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<floating_ips_bulk_create>
+<ip_range>192.168.1.0/24</ip_range>
+<pool>nova</pool>
+<interface>eth0</interface>
+</floating_ips_bulk_create> \ No newline at end of file
diff --git a/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.json b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.json
new file mode 100644
index 000000000..ef1cbfb17
--- /dev/null
+++ b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.json
@@ -0,0 +1,7 @@
+{
+ "floating_ips_bulk_create": {
+ "interface": "eth0",
+ "ip_range": "192.168.1.0/24",
+ "pool": "nova"
+ }
+} \ No newline at end of file
diff --git a/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.xml b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.xml
new file mode 100644
index 000000000..db80bbfc1
--- /dev/null
+++ b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.xml
@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<floating_ips_bulk_create>
+ <interface>eth0</interface>
+ <ip_range>192.168.1.0/24</ip_range>
+ <pool>nova</pool>
+</floating_ips_bulk_create> \ No newline at end of file
diff --git a/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-req.json b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-req.json
new file mode 100644
index 000000000..df59c1a73
--- /dev/null
+++ b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-req.json
@@ -0,0 +1,3 @@
+{
+ "ip_range": "192.168.1.0/24"
+} \ No newline at end of file
diff --git a/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-req.xml b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-req.xml
new file mode 100644
index 000000000..c40f28dc3
--- /dev/null
+++ b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-req.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<ip_range>192.168.1.0/24</ip_range> \ No newline at end of file
diff --git a/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.json b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.json
new file mode 100644
index 000000000..166984b24
--- /dev/null
+++ b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.json
@@ -0,0 +1,3 @@
+{
+ "floating_ips_bulk_delete": "192.168.1.0/24"
+} \ No newline at end of file
diff --git a/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.xml b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.xml
new file mode 100644
index 000000000..3d77af334
--- /dev/null
+++ b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.xml
@@ -0,0 +1,2 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<floating_ips_bulk_delete>192.168.1.0/24</floating_ips_bulk_delete> \ No newline at end of file
diff --git a/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.json b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.json
new file mode 100644
index 000000000..0eaaf75ae
--- /dev/null
+++ b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.json
@@ -0,0 +1,11 @@
+{
+ "floating_ip_info": [
+ {
+ "address": "10.10.10.3",
+ "instance_uuid": null,
+ "interface": "eth0",
+ "pool": "nova",
+ "project_id": null
+ }
+ ]
+} \ No newline at end of file
diff --git a/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.xml b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.xml
new file mode 100644
index 000000000..4c3c8cd9c
--- /dev/null
+++ b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.xml
@@ -0,0 +1,10 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<floating_ip_info>
+ <item>
+ <interface>eth0</interface>
+ <instance_uuid>None</instance_uuid>
+ <project_id>None</project_id>
+ <pool>nova</pool>
+ <address>10.10.10.3</address>
+ </item>
+</floating_ip_info> \ No newline at end of file
diff --git a/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.json b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.json
new file mode 100644
index 000000000..de1e622bb
--- /dev/null
+++ b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.json
@@ -0,0 +1,25 @@
+{
+ "floating_ip_info": [
+ {
+ "address": "10.10.10.1",
+ "instance_uuid": null,
+ "interface": "eth0",
+ "pool": "nova",
+ "project_id": null
+ },
+ {
+ "address": "10.10.10.2",
+ "instance_uuid": null,
+ "interface": "eth0",
+ "pool": "nova",
+ "project_id": null
+ },
+ {
+ "address": "10.10.10.3",
+ "instance_uuid": null,
+ "interface": "eth0",
+ "pool": "nova",
+ "project_id": null
+ }
+ ]
+} \ No newline at end of file
diff --git a/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.xml b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.xml
new file mode 100644
index 000000000..6ef85bd87
--- /dev/null
+++ b/doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.xml
@@ -0,0 +1,24 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<floating_ip_info>
+ <item>
+ <interface>eth0</interface>
+ <instance_uuid>None</instance_uuid>
+ <project_id>None</project_id>
+ <pool>nova</pool>
+ <address>10.10.10.1</address>
+ </item>
+ <item>
+ <interface>eth0</interface>
+ <instance_uuid>None</instance_uuid>
+ <project_id>None</project_id>
+ <pool>nova</pool>
+ <address>10.10.10.2</address>
+ </item>
+ <item>
+ <interface>eth0</interface>
+ <instance_uuid>None</instance_uuid>
+ <project_id>None</project_id>
+ <pool>nova</pool>
+ <address>10.10.10.3</address>
+ </item>
+</floating_ip_info> \ No newline at end of file