1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
.. -*- rst -*-
=========================================
Floating IPs bulk (os-floating-ips-bulk)
=========================================
.. warning::
Since these APIs are only implemented for **nova-network**, they are
deprecated. These will fail with a 404 starting from microversion 2.36.
They were removed in the 18.0.0 Rocky release.
Bulk-creates, deletes, and lists floating IPs.
Default pool name is ``nova``.
To view available pools, use the ``os-floating-ip-pools`` extension.
List Floating Ips
=================
.. rest_method:: GET /os-floating-ips-bulk
Lists all floating IPs.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410)
Response
--------
.. rest_parameters:: parameters.yaml
- floating_ip_info : floating_ips_list
- address : floating_ip
- fixed_ip : fixed_ip_address
- instance_uuid : server_id
- interface : virtual_interface
- pool: floating_ip_pool_name
- project_id : project_id_value
**Example List Floating Ips: JSON response**
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-resp.json
:language: javascript
Create Floating Ips
===================
.. rest_method:: POST /os-floating-ips-bulk
Bulk-creates floating IPs.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
conflict(409), gone(410)
Request
-------
.. rest_parameters:: parameters.yaml
- floating_ips_bulk_create : floating_ip_bulk_object
- ip_range : ip_range
- interface : virtual_interface_id_optional
- pool: floating_ip_pool_name_optional
**Example Create Floating Ips: JSON request**
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- floating_ips_bulk_create : floating_ip_bulk_object
- interface : virtual_interface
- ip_range : ip_range
- pool: floating_ip_pool_name
**Example Create Floating Ips: JSON response**
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-create-resp.json
:language: javascript
Bulk-Delete Floating Ips
========================
.. rest_method:: PUT /os-floating-ips-bulk/delete
Bulk-deletes floating IPs.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403),
itemNotFound(404), gone(410)
Request
-------
.. rest_parameters:: parameters.yaml
- ip_range: ip_range_delete
**Example Bulk-Delete Floating Ips: JSON request**
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- floating_ips_bulk_delete : ip_range_delete
**Example Bulk-Delete Floating Ips: JSON response**
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-delete-resp.json
:language: javascript
List Floating Ips By Host
=========================
.. rest_method:: GET /os-floating-ips-bulk/{host_name}
Lists all floating IPs for a host.
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403), itemNotFound(404),
gone(410)
Request
-------
.. rest_parameters:: parameters.yaml
- host_name: host_name
Response
--------
.. rest_parameters:: parameters.yaml
- floating_ip_info : floating_ips_list
- address : floating_ip
- fixed_ip : fixed_ip_address
- instance_uuid : server_id
- interface : virtual_interface
- pool: floating_ip_pool_name
- project_id : project_id_value
**Example List Floating Ips By Host: JSON response**
.. literalinclude:: ../../doc/api_samples/os-floating-ips-bulk/floating-ips-bulk-list-by-host-resp.json
:language: javascript
|
