root / docs / network-api-guide.rst @ c4dccd8a
History | View | Annotate | Download (47.1 kB)
1 | 3df48a3f | Constantinos Venetsanopoulos | .. _network-api-guide: |
---|---|---|---|
2 | 3df48a3f | Constantinos Venetsanopoulos | |
3 | 3df48a3f | Constantinos Venetsanopoulos | Cyclades/Network API Guide |
4 | 3df48a3f | Constantinos Venetsanopoulos | ^^^^^^^^^^^^^^^^^^^^^^^^^^ |
5 | 3df48a3f | Constantinos Venetsanopoulos | |
6 | 3df48a3f | Constantinos Venetsanopoulos | Introduction |
7 | 3df48a3f | Constantinos Venetsanopoulos | ============ |
8 | 3df48a3f | Constantinos Venetsanopoulos | |
9 | a150c9dc | Stavros Sachtouris | The Network Service of `Synnefo <http://www.synnefo.org>`_ is implemented as |
10 | a150c9dc | Stavros Sachtouris | part of Cyclades. It exposes the OpenStack `Networking ("Neutron") API |
11 | a150c9dc | Stavros Sachtouris | <http://api.openstack.org/api-ref-networking.html>`_ and some |
12 | a150c9dc | Stavros Sachtouris | `extensions <file:///home/saxtouri/src/synnefo/docs/_build/html/network-api-guide.html>`_ |
13 | a150c9dc | Stavros Sachtouris | with minor modifications if needed. |
14 | 3df48a3f | Constantinos Venetsanopoulos | |
15 | 3df48a3f | Constantinos Venetsanopoulos | This document's goals are: |
16 | 3df48a3f | Constantinos Venetsanopoulos | |
17 | 3df48a3f | Constantinos Venetsanopoulos | * Define the Cyclades/Network REST API |
18 | 3df48a3f | Constantinos Venetsanopoulos | * Clarify the differences between Cyclades/Network and OpenStack Neutron |
19 | 3df48a3f | Constantinos Venetsanopoulos | |
20 | a150c9dc | Stavros Sachtouris | API Operations |
21 | a150c9dc | Stavros Sachtouris | ============== |
22 | 3df48a3f | Constantinos Venetsanopoulos | |
23 | a150c9dc | Stavros Sachtouris | .. rubric:: Networks |
24 | a150c9dc | Stavros Sachtouris | ===================================== ========================== ====== ======== ======= ========== |
25 | a150c9dc | Stavros Sachtouris | Description URI Method Cyclades/Network OS/Neutron |
26 | a150c9dc | Stavros Sachtouris | ===================================== ========================== ====== ================ ========== |
27 | a150c9dc | Stavros Sachtouris | `List <#list-networks>`_ ``/networks`` GET ✔ ✔ |
28 | a150c9dc | Stavros Sachtouris | `Get details <#get-network-details>`_ ``/networks/<network-id>`` GET ✔ ✔ |
29 | a150c9dc | Stavros Sachtouris | `Create <#create-network>`_ ``/networks`` POST ✔ ✔ |
30 | a150c9dc | Stavros Sachtouris | Bulk creation ``/networks`` POST **✘** ✔ |
31 | a150c9dc | Stavros Sachtouris | `Update <#update-network>`_ ``/networks/<network-id>`` PUT ✔ ✔ |
32 | a150c9dc | Stavros Sachtouris | `Delete <#delete-network>`_ ``/networks/<network id>`` DELETE ✔ ✔ |
33 | a150c9dc | Stavros Sachtouris | ===================================== ========================== ====== ================ ========== |
34 | a150c9dc | Stavros Sachtouris | |
35 | a150c9dc | Stavros Sachtouris | .. rubric:: Subnets |
36 | a150c9dc | Stavros Sachtouris | ==================================== ======================== ====== ======== ======= ========== |
37 | a150c9dc | Stavros Sachtouris | Description URI Method Cyclades/Network OS/Neutron |
38 | a150c9dc | Stavros Sachtouris | ==================================== ======================== ====== ================ ========== |
39 | a150c9dc | Stavros Sachtouris | `List <#list-subnets>`_ ``/subnets`` GET ✔ ✔ |
40 | a150c9dc | Stavros Sachtouris | `Get details <#get-subnet-details>`_ ``/subnets/<subnet-id>`` GET ✔ ✔ |
41 | a150c9dc | Stavros Sachtouris | `Create <#create-subnet>`_ ``/subnets`` POST ✔ ✔ |
42 | a150c9dc | Stavros Sachtouris | Bulk creation ``/subnets`` POST **✘** ✔ |
43 | a150c9dc | Stavros Sachtouris | `Update <#update-subnet>`_ ``/subnets/<subnet-id>`` PUT ✔ ✔ |
44 | a150c9dc | Stavros Sachtouris | Delete ``/subnets/<subnet-id>`` DELETE **✘** ✔ |
45 | a150c9dc | Stavros Sachtouris | ==================================== ======================== ====== ================ ========== |
46 | a150c9dc | Stavros Sachtouris | |
47 | a150c9dc | Stavros Sachtouris | .. rubric:: Ports |
48 | a150c9dc | Stavros Sachtouris | ================================== ==================== ====== ======== ======= ========== |
49 | a150c9dc | Stavros Sachtouris | Description URI Method Cyclades/Network OS/Neutron |
50 | a150c9dc | Stavros Sachtouris | ================================== ==================== ====== ================ ========== |
51 | a150c9dc | Stavros Sachtouris | `List <#list-ports>`_ ``/ports`` GET ✔ ✔ |
52 | a150c9dc | Stavros Sachtouris | `Get details <#get-port-details>`_ ``/ports/<port-id>`` GET ✔ ✔ |
53 | a150c9dc | Stavros Sachtouris | `Create <#create-port>`_ ``/ports`` POST ✔ ✔ |
54 | a150c9dc | Stavros Sachtouris | Bulk creation ``/ports`` POST **✘** ✔ |
55 | a150c9dc | Stavros Sachtouris | `Update <#update-port>`_ ``/ports/<port-id>`` PUT ✔ ✔ |
56 | a150c9dc | Stavros Sachtouris | `Delete <#delete-port>`_ ``/ports/<port id>`` DELETE ✔ ✔ |
57 | a150c9dc | Stavros Sachtouris | ================================== ==================== ====== ================ ========== |
58 | a150c9dc | Stavros Sachtouris | |
59 | a150c9dc | Stavros Sachtouris | .. rubric:: Floating IPs |
60 | a150c9dc | Stavros Sachtouris | ========================================= ================================ ====== ================ ========== |
61 | a150c9dc | Stavros Sachtouris | Description URI Method Cyclades/Network OS/Neutron Extensions |
62 | a150c9dc | Stavros Sachtouris | ========================================= ================================ ====== ================ ========== |
63 | a150c9dc | Stavros Sachtouris | `List <#list-floating-ips>`_ ``/floatingips`` GET ✔ ✔ |
64 | a150c9dc | Stavros Sachtouris | `Get details <#get-floating-ip-details>`_ ``/floatingips/<floatingip-id>`` GET ✔ ✔ |
65 | a150c9dc | Stavros Sachtouris | `Create <#create-floating-ip>`_ ``/floatingips`` POST ✔ ✔ |
66 | a150c9dc | Stavros Sachtouris | Update ``/floatingips/<floatingip-id>`` PUT **✘** ✔ |
67 | a150c9dc | Stavros Sachtouris | `Delete <#delete-floating-ip>`_ ``/floatingips/<floatingip id>`` DELETE ✔ ✔ |
68 | a150c9dc | Stavros Sachtouris | ========================================= ================================ ====== ================ ========== |
69 | a150c9dc | Stavros Sachtouris | |
70 | a150c9dc | Stavros Sachtouris | List networks |
71 | a150c9dc | Stavros Sachtouris | ------------- |
72 | a150c9dc | Stavros Sachtouris | |
73 | a150c9dc | Stavros Sachtouris | List networks accessible by the user |
74 | a150c9dc | Stavros Sachtouris | |
75 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
76 | a150c9dc | Stavros Sachtouris | |
77 | a150c9dc | Stavros Sachtouris | ============= ====== ================ ========== |
78 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
79 | a150c9dc | Stavros Sachtouris | ============= ====== ================ ========== |
80 | a150c9dc | Stavros Sachtouris | ``/networks`` GET ✔ ✔ |
81 | a150c9dc | Stavros Sachtouris | ============= ====== ================ ========== |
82 | a150c9dc | Stavros Sachtouris | |
83 | a150c9dc | Stavros Sachtouris | | |
84 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
85 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
86 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
87 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
88 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
89 | a150c9dc | Stavros Sachtouris | |
90 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
91 | a150c9dc | Stavros Sachtouris | |
92 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
93 | a150c9dc | Stavros Sachtouris | Return Code Description |
94 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
95 | a150c9dc | Stavros Sachtouris | 200 (OK) Request succeeded |
96 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
97 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
98 | a150c9dc | Stavros Sachtouris | |
99 | a150c9dc | Stavros Sachtouris | |
100 | a150c9dc | Stavros Sachtouris | Response body contents:: |
101 | a150c9dc | Stavros Sachtouris | |
102 | a150c9dc | Stavros Sachtouris | networks: [ |
103 | a150c9dc | Stavros Sachtouris | { |
104 | a150c9dc | Stavros Sachtouris | <network attribute>: <value>, |
105 | a150c9dc | Stavros Sachtouris | ... |
106 | a150c9dc | Stavros Sachtouris | }, ... |
107 | a150c9dc | Stavros Sachtouris | ] |
108 | a150c9dc | Stavros Sachtouris | |
109 | a150c9dc | Stavros Sachtouris | The attributes of a network are listed `here <#network-ref>`_ |
110 | a150c9dc | Stavros Sachtouris | |
111 | a150c9dc | Stavros Sachtouris | *Example List Networks: JSON* |
112 | a150c9dc | Stavros Sachtouris | |
113 | a150c9dc | Stavros Sachtouris | .. code-block:: javascript |
114 | a150c9dc | Stavros Sachtouris | |
115 | a3d2b515 | Stavros Sachtouris | GET https://example.org/network/v2.0/networks |
116 | a150c9dc | Stavros Sachtouris | |
117 | a150c9dc | Stavros Sachtouris | |
118 | a150c9dc | Stavros Sachtouris | { |
119 | a150c9dc | Stavros Sachtouris | "networks": [ |
120 | a150c9dc | Stavros Sachtouris | { |
121 | a150c9dc | Stavros Sachtouris | "id": 2718 |
122 | a150c9dc | Stavros Sachtouris | "name": "Public IPv6 Network" |
123 | a150c9dc | Stavros Sachtouris | "status": "ACTIVE" |
124 | a150c9dc | Stavros Sachtouris | "router:externa"l: true |
125 | a150c9dc | Stavros Sachtouris | "updated": "2013-12-18T11:11:12.272389+00:00" |
126 | a150c9dc | Stavros Sachtouris | "user_id": None |
127 | a150c9dc | Stavros Sachtouris | "links":[ |
128 | a150c9dc | Stavros Sachtouris | { |
129 | a3d2b515 | Stavros Sachtouris | "href": "https://example.org/network/v2.0/networks/2718" |
130 | a150c9dc | Stavros Sachtouris | "rel": "self" |
131 | a150c9dc | Stavros Sachtouris | }, { |
132 | a3d2b515 | Stavros Sachtouris | "href": "https://example.org/network/v2.0/networks/2718" |
133 | a150c9dc | Stavros Sachtouris | "rel": "bookmark" |
134 | a150c9dc | Stavros Sachtouris | } |
135 | a150c9dc | Stavros Sachtouris | ] |
136 | a150c9dc | Stavros Sachtouris | "created": "2013-12-17T17:15:48.617049+00:00" |
137 | a3d2b515 | Stavros Sachtouris | "tenant_id": None |
138 | a150c9dc | Stavros Sachtouris | "admin_state_up": true |
139 | a3d2b515 | Stavros Sachtouris | "SNF:floating_ip_pool": false |
140 | a3d2b515 | Stavros Sachtouris | "public": true |
141 | a3d2b515 | Stavros Sachtouris | "subnets":[ |
142 | a150c9dc | Stavros Sachtouris | 28 |
143 | a150c9dc | Stavros Sachtouris | ] |
144 | a150c9dc | Stavros Sachtouris | "type": "IP_LESS_ROUTED", |
145 | a150c9dc | Stavros Sachtouris | "public": true |
146 | a150c9dc | Stavros Sachtouris | }, { |
147 | a150c9dc | Stavros Sachtouris | "id": "3141", |
148 | a150c9dc | Stavros Sachtouris | "name": "My Private Network", |
149 | a150c9dc | Stavros Sachtouris | "status": "ACTIVE", |
150 | a150c9dc | Stavros Sachtouris | "router:external": false, |
151 | a150c9dc | Stavros Sachtouris | "updated": "2014-02-13T09:40:05.195945+00:00", |
152 | a150c9dc | Stavros Sachtouris | "user_id": "s0m3-u5e7-1d", |
153 | a150c9dc | Stavros Sachtouris | "links": [ |
154 | a150c9dc | Stavros Sachtouris | { |
155 | a3d2b515 | Stavros Sachtouris | "href": "https://example.org/network/v2.0/networks/3141", |
156 | a150c9dc | Stavros Sachtouris | "rel": "self" |
157 | a150c9dc | Stavros Sachtouris | }, |
158 | a150c9dc | Stavros Sachtouris | { |
159 | a3d2b515 | Stavros Sachtouris | "href": "https://example.org/network/v2.0/networks/3141", |
160 | a150c9dc | Stavros Sachtouris | "rel": "bookmark" |
161 | a150c9dc | Stavros Sachtouris | } |
162 | a150c9dc | Stavros Sachtouris | ], |
163 | a150c9dc | Stavros Sachtouris | "created": "2014-02-13T09:40:05.101008+00:00", |
164 | a150c9dc | Stavros Sachtouris | "tenant_id": "s0m3-u5e7-1d", |
165 | a150c9dc | Stavros Sachtouris | "admin_state_up": true, |
166 | a150c9dc | Stavros Sachtouris | "type": "MAC_FILTERED", |
167 | a150c9dc | Stavros Sachtouris | "subnets": [], |
168 | a150c9dc | Stavros Sachtouris | "SNF:floating_ip_pool": false, |
169 | a150c9dc | Stavros Sachtouris | "public": false |
170 | a150c9dc | Stavros Sachtouris | } |
171 | a150c9dc | Stavros Sachtouris | ] |
172 | a150c9dc | Stavros Sachtouris | } |
173 | a150c9dc | Stavros Sachtouris | |
174 | a150c9dc | Stavros Sachtouris | |
175 | a150c9dc | Stavros Sachtouris | Get network details |
176 | a150c9dc | Stavros Sachtouris | ------------------- |
177 | a150c9dc | Stavros Sachtouris | |
178 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
179 | a150c9dc | Stavros Sachtouris | |
180 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
181 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
182 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
183 | a150c9dc | Stavros Sachtouris | ``/networks/<network id>`` GET ✔ ✔ |
184 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
185 | a150c9dc | Stavros Sachtouris | |
186 | a150c9dc | Stavros Sachtouris | | |
187 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
188 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
189 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
190 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
191 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
192 | a150c9dc | Stavros Sachtouris | |
193 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
194 | a150c9dc | Stavros Sachtouris | |
195 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
196 | a150c9dc | Stavros Sachtouris | Return Code Description |
197 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
198 | a150c9dc | Stavros Sachtouris | 200 (OK) Request succeeded |
199 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
200 | a150c9dc | Stavros Sachtouris | 404 (itemNoFound) Network not found |
201 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
202 | a150c9dc | Stavros Sachtouris | |
203 | a150c9dc | Stavros Sachtouris | Response body contents:: |
204 | a150c9dc | Stavros Sachtouris | |
205 | a150c9dc | Stavros Sachtouris | network: { |
206 | a150c9dc | Stavros Sachtouris | <network attribute>: <value>, |
207 | a150c9dc | Stavros Sachtouris | ... |
208 | a150c9dc | Stavros Sachtouris | } |
209 | a150c9dc | Stavros Sachtouris | |
210 | a150c9dc | Stavros Sachtouris | The attributes of a network are listed `here <#network-ref>`_ |
211 | a150c9dc | Stavros Sachtouris | |
212 | a150c9dc | Stavros Sachtouris | *Example Get Network Details: JSON* |
213 | a150c9dc | Stavros Sachtouris | |
214 | a150c9dc | Stavros Sachtouris | .. code-block:: javascript |
215 | a150c9dc | Stavros Sachtouris | |
216 | a3d2b515 | Stavros Sachtouris | GET https://example.org/network/v2.0/networks/3141 |
217 | a150c9dc | Stavros Sachtouris | |
218 | a150c9dc | Stavros Sachtouris | |
219 | a150c9dc | Stavros Sachtouris | { |
220 | a150c9dc | Stavros Sachtouris | "network": { |
221 | a150c9dc | Stavros Sachtouris | "id": "3141", |
222 | a150c9dc | Stavros Sachtouris | "name": "My Private Network", |
223 | a150c9dc | Stavros Sachtouris | "status": "ACTIVE", |
224 | a150c9dc | Stavros Sachtouris | "router:external": false, |
225 | a150c9dc | Stavros Sachtouris | "updated": "2014-02-13T09:40:05.195945+00:00", |
226 | a150c9dc | Stavros Sachtouris | "user_id": "s0m3-u5e7-1d", |
227 | a150c9dc | Stavros Sachtouris | "links": [ |
228 | a150c9dc | Stavros Sachtouris | { |
229 | a3d2b515 | Stavros Sachtouris | "href": "https://example.org/network/v2.0/networks/3141", |
230 | a150c9dc | Stavros Sachtouris | "rel": "self" |
231 | a150c9dc | Stavros Sachtouris | }, |
232 | a150c9dc | Stavros Sachtouris | { |
233 | a3d2b515 | Stavros Sachtouris | "href": "https://example.org/network/v2.0/networks/3141", |
234 | a150c9dc | Stavros Sachtouris | "rel": "bookmark" |
235 | a150c9dc | Stavros Sachtouris | } |
236 | a150c9dc | Stavros Sachtouris | ], |
237 | a150c9dc | Stavros Sachtouris | "created": "2014-02-13T09:40:05.101008+00:00", |
238 | a150c9dc | Stavros Sachtouris | "tenant_id": "s0m3-u5e7-1d", |
239 | a150c9dc | Stavros Sachtouris | "admin_state_up": true, |
240 | a150c9dc | Stavros Sachtouris | "type": "MAC_FILTERED", |
241 | a150c9dc | Stavros Sachtouris | "subnets": [], |
242 | a150c9dc | Stavros Sachtouris | "SNF:floating_ip_pool": false, |
243 | a150c9dc | Stavros Sachtouris | "public": false |
244 | a150c9dc | Stavros Sachtouris | } |
245 | a150c9dc | Stavros Sachtouris | } |
246 | a150c9dc | Stavros Sachtouris | |
247 | a150c9dc | Stavros Sachtouris | Create network |
248 | a150c9dc | Stavros Sachtouris | -------------- |
249 | a150c9dc | Stavros Sachtouris | |
250 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
251 | a150c9dc | Stavros Sachtouris | |
252 | a150c9dc | Stavros Sachtouris | ============= ====== ================ ========== |
253 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
254 | a150c9dc | Stavros Sachtouris | ============= ====== ================ ========== |
255 | a150c9dc | Stavros Sachtouris | ``/networks`` POST ✔ ✔ |
256 | a150c9dc | Stavros Sachtouris | ============= ====== ================ ========== |
257 | a150c9dc | Stavros Sachtouris | |
258 | a150c9dc | Stavros Sachtouris | | |
259 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
260 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
261 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
262 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
263 | a150c9dc | Stavros Sachtouris | Content-Type Type or request body required required |
264 | a150c9dc | Stavros Sachtouris | Content-Length Length of request body required required |
265 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
266 | a150c9dc | Stavros Sachtouris | |
267 | a150c9dc | Stavros Sachtouris | Request body contents:: |
268 | a150c9dc | Stavros Sachtouris | |
269 | a150c9dc | Stavros Sachtouris | network: { |
270 | a150c9dc | Stavros Sachtouris | <network attribute>: <value>, |
271 | a150c9dc | Stavros Sachtouris | ... |
272 | a150c9dc | Stavros Sachtouris | } |
273 | a150c9dc | Stavros Sachtouris | |
274 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
275 | a150c9dc | Stavros Sachtouris | Network Attribute Cyclades/Network OS/Neutron |
276 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
277 | a150c9dc | Stavros Sachtouris | type required **✘** |
278 | a150c9dc | Stavros Sachtouris | name ✔ ✔ |
279 | a150c9dc | Stavros Sachtouris | admin_state_up **✘** ✔ |
280 | a150c9dc | Stavros Sachtouris | shared **✘** ✔ |
281 | a150c9dc | Stavros Sachtouris | tenand_id **✘** ✔ |
282 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
283 | a150c9dc | Stavros Sachtouris | |
284 | a150c9dc | Stavros Sachtouris | * **type** Valid values are the same as in ``network_type`` of |
285 | a150c9dc | Stavros Sachtouris | `a network <#network-ref>`_. |
286 | a150c9dc | Stavros Sachtouris | |
287 | a150c9dc | Stavros Sachtouris | * **name** a string |
288 | a150c9dc | Stavros Sachtouris | |
289 | a150c9dc | Stavros Sachtouris | * **admin_state_up**, **shared** and **tenantd_id** are accepted by |
290 | a150c9dc | Stavros Sachtouris | Cyclades/Network, but they are ignored |
291 | a150c9dc | Stavros Sachtouris | |
292 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
293 | a150c9dc | Stavros Sachtouris | |
294 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
295 | a150c9dc | Stavros Sachtouris | Return Code Description |
296 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
297 | a150c9dc | Stavros Sachtouris | 201 (OK) Network created |
298 | a150c9dc | Stavros Sachtouris | 400 (BadRequest) Invalid request body (invalid or missing type) |
299 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
300 | a150c9dc | Stavros Sachtouris | 404 (itemNoFound) Network not found |
301 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
302 | a150c9dc | Stavros Sachtouris | |
303 | a150c9dc | Stavros Sachtouris | In case of success, the response has the same format is in |
304 | a150c9dc | Stavros Sachtouris | `get network details <#get-network-details>`_. |
305 | a150c9dc | Stavros Sachtouris | |
306 | a150c9dc | Stavros Sachtouris | Update network |
307 | a150c9dc | Stavros Sachtouris | -------------- |
308 | a150c9dc | Stavros Sachtouris | |
309 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
310 | a150c9dc | Stavros Sachtouris | |
311 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
312 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
313 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
314 | a150c9dc | Stavros Sachtouris | ``/networks/<network id>`` PUT ✔ ✔ |
315 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
316 | a150c9dc | Stavros Sachtouris | |
317 | a150c9dc | Stavros Sachtouris | | |
318 | a150c9dc | Stavros Sachtouris | |
319 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
320 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
321 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
322 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
323 | a150c9dc | Stavros Sachtouris | Content-Type Type or request body required required |
324 | a150c9dc | Stavros Sachtouris | Content-Length Length of request body required required |
325 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
326 | a150c9dc | Stavros Sachtouris | |
327 | a150c9dc | Stavros Sachtouris | Request body contents:: |
328 | a150c9dc | Stavros Sachtouris | |
329 | a150c9dc | Stavros Sachtouris | network: { |
330 | a150c9dc | Stavros Sachtouris | <network attribute>: <value>, |
331 | a150c9dc | Stavros Sachtouris | ... |
332 | a150c9dc | Stavros Sachtouris | } |
333 | a150c9dc | Stavros Sachtouris | |
334 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
335 | a150c9dc | Stavros Sachtouris | Network Attribute Cyclades/Network OS/Neutron |
336 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
337 | a150c9dc | Stavros Sachtouris | name ✔ ✔ |
338 | a150c9dc | Stavros Sachtouris | network_id **✘** ✔ |
339 | a150c9dc | Stavros Sachtouris | admin_state_up **✘** ✔ |
340 | a150c9dc | Stavros Sachtouris | shared **✘** ✔ |
341 | a150c9dc | Stavros Sachtouris | tenand_id **✘** ✔ |
342 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
343 | a150c9dc | Stavros Sachtouris | |
344 | a150c9dc | Stavros Sachtouris | * **name** a string |
345 | a150c9dc | Stavros Sachtouris | |
346 | a150c9dc | Stavros Sachtouris | * **network_id**, **admin_state_up**, **shared** and **tenantd_id** are |
347 | a150c9dc | Stavros Sachtouris | accepted by Cyclades/Network, but they are ignored |
348 | a150c9dc | Stavros Sachtouris | |
349 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
350 | a150c9dc | Stavros Sachtouris | |
351 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
352 | a150c9dc | Stavros Sachtouris | Return Code Description |
353 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
354 | a150c9dc | Stavros Sachtouris | 200 (OK) Network is updated |
355 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
356 | a150c9dc | Stavros Sachtouris | 403 (Forbidden) You are not the owner of the network |
357 | a150c9dc | Stavros Sachtouris | 404 (itemNoFound) Network not found |
358 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
359 | a150c9dc | Stavros Sachtouris | |
360 | a150c9dc | Stavros Sachtouris | In case of success, the response has the same format is in |
361 | a150c9dc | Stavros Sachtouris | `get network details <#get-network-details>`_ containing the updated values. |
362 | a150c9dc | Stavros Sachtouris | |
363 | a150c9dc | Stavros Sachtouris | Delete network |
364 | a150c9dc | Stavros Sachtouris | -------------- |
365 | a150c9dc | Stavros Sachtouris | |
366 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
367 | a150c9dc | Stavros Sachtouris | |
368 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
369 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
370 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
371 | a150c9dc | Stavros Sachtouris | ``/networks/<network id>`` DELETE ✔ ✔ |
372 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
373 | a150c9dc | Stavros Sachtouris | | |
374 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
375 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
376 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
377 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
378 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
379 | a150c9dc | Stavros Sachtouris | |
380 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
381 | a150c9dc | Stavros Sachtouris | |
382 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
383 | a150c9dc | Stavros Sachtouris | Return Code Description |
384 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
385 | a150c9dc | Stavros Sachtouris | 204 (OK) Network is deleted |
386 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
387 | a150c9dc | Stavros Sachtouris | 404 (itemNoFound) Network not found |
388 | a150c9dc | Stavros Sachtouris | 409 (Conflict) The network is being used |
389 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
390 | a150c9dc | Stavros Sachtouris | |
391 | a150c9dc | Stavros Sachtouris | .. note:: *409 (Confict)* is raised when there are ports connected to the |
392 | a150c9dc | Stavros Sachtouris | network or floating IPs reserved from its pool. The subnets that are |
393 | a150c9dc | Stavros Sachtouris | connected to it, though, are automatically deleted upon network deletion. |
394 | a150c9dc | Stavros Sachtouris | |
395 | a150c9dc | Stavros Sachtouris | List subnets |
396 | a150c9dc | Stavros Sachtouris | ------------ |
397 | a150c9dc | Stavros Sachtouris | |
398 | a150c9dc | Stavros Sachtouris | List subnets of networks accessible by the user |
399 | a150c9dc | Stavros Sachtouris | |
400 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
401 | a150c9dc | Stavros Sachtouris | |
402 | a150c9dc | Stavros Sachtouris | ============ ====== ================ ========== |
403 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
404 | a150c9dc | Stavros Sachtouris | ============ ====== ================ ========== |
405 | a150c9dc | Stavros Sachtouris | ``/subnets`` GET ✔ ✔ |
406 | a150c9dc | Stavros Sachtouris | ============ ====== ================ ========== |
407 | a150c9dc | Stavros Sachtouris | |
408 | a150c9dc | Stavros Sachtouris | | |
409 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
410 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
411 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
412 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
413 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
414 | a150c9dc | Stavros Sachtouris | |
415 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
416 | a150c9dc | Stavros Sachtouris | |
417 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
418 | a150c9dc | Stavros Sachtouris | Return Code Description |
419 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
420 | a150c9dc | Stavros Sachtouris | 200 (OK) Request succeeded |
421 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
422 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
423 | a150c9dc | Stavros Sachtouris | |
424 | a150c9dc | Stavros Sachtouris | Response body contents:: |
425 | a150c9dc | Stavros Sachtouris | |
426 | a150c9dc | Stavros Sachtouris | subnets: [ |
427 | a150c9dc | Stavros Sachtouris | { |
428 | a150c9dc | Stavros Sachtouris | <subnet attribute>: <value>, |
429 | a150c9dc | Stavros Sachtouris | ... |
430 | a150c9dc | Stavros Sachtouris | }, ... |
431 | a150c9dc | Stavros Sachtouris | ] |
432 | a150c9dc | Stavros Sachtouris | |
433 | a150c9dc | Stavros Sachtouris | The attributes of a subnet are listed `here <#subnet-ref>`_ |
434 | a150c9dc | Stavros Sachtouris | |
435 | a150c9dc | Stavros Sachtouris | *Example List subnets: JSON* |
436 | a150c9dc | Stavros Sachtouris | |
437 | a150c9dc | Stavros Sachtouris | .. code-block:: javascript |
438 | a150c9dc | Stavros Sachtouris | |
439 | a3d2b515 | Stavros Sachtouris | GET https://example.org/network/v2.0/subnets |
440 | a150c9dc | Stavros Sachtouris | |
441 | a150c9dc | Stavros Sachtouris | { |
442 | a150c9dc | Stavros Sachtouris | "subnets": [ |
443 | a150c9dc | Stavros Sachtouris | { |
444 | a150c9dc | Stavros Sachtouris | "user_id": null, |
445 | a150c9dc | Stavros Sachtouris | "name": "IPv6 Subnet of Network 2718", |
446 | a150c9dc | Stavros Sachtouris | "links": [ |
447 | a150c9dc | Stavros Sachtouris | { |
448 | a150c9dc | Stavros Sachtouris | "href": "https://example.org/network/v2.0/subnets/8172", |
449 | a150c9dc | Stavros Sachtouris | "rel": "self" |
450 | a150c9dc | Stavros Sachtouris | }, |
451 | a150c9dc | Stavros Sachtouris | { |
452 | a150c9dc | Stavros Sachtouris | "href": "https://example.org/network/v2.0/subnets/8172", |
453 | a150c9dc | Stavros Sachtouris | "rel": "bookmark" |
454 | a150c9dc | Stavros Sachtouris | } |
455 | a150c9dc | Stavros Sachtouris | ], |
456 | a150c9dc | Stavros Sachtouris | "network_id": "2718", |
457 | a150c9dc | Stavros Sachtouris | "tenant_id": null, |
458 | a150c9dc | Stavros Sachtouris | "dns_nameservers": [], |
459 | a150c9dc | Stavros Sachtouris | "enable_slaac": true, |
460 | a150c9dc | Stavros Sachtouris | "public": true, |
461 | a150c9dc | Stavros Sachtouris | "allocation_pools": [], |
462 | a150c9dc | Stavros Sachtouris | "host_routes": [], |
463 | a150c9dc | Stavros Sachtouris | "ip_version": 6, |
464 | a150c9dc | Stavros Sachtouris | "gateway_ip": "2001:123:4abc:5678::9", |
465 | a150c9dc | Stavros Sachtouris | "cidr": "2001:876:5cba:4321::/64", |
466 | a150c9dc | Stavros Sachtouris | "enable_dhcp": true, |
467 | a150c9dc | Stavros Sachtouris | "id": "8172" |
468 | a150c9dc | Stavros Sachtouris | }, { |
469 | a150c9dc | Stavros Sachtouris | "user_id": "s0m3-u5e7-1d", |
470 | a150c9dc | Stavros Sachtouris | "name": "IPv6 Subnet of Network 3141", |
471 | a150c9dc | Stavros Sachtouris | "links": [ |
472 | a150c9dc | Stavros Sachtouris | { |
473 | a150c9dc | Stavros Sachtouris | "href": "https://example.org/network/v2.0/subnets/1413", |
474 | a150c9dc | Stavros Sachtouris | "rel": "self" |
475 | a150c9dc | Stavros Sachtouris | }, |
476 | a150c9dc | Stavros Sachtouris | { |
477 | a150c9dc | Stavros Sachtouris | "href": "https://example.org/network/v2.0/subnets/1413", |
478 | a150c9dc | Stavros Sachtouris | "rel": "bookmark" |
479 | a150c9dc | Stavros Sachtouris | } |
480 | a150c9dc | Stavros Sachtouris | ], |
481 | a150c9dc | Stavros Sachtouris | "network_id": "3141", |
482 | a150c9dc | Stavros Sachtouris | "tenant_id": "s0m3-u5e7-1d", |
483 | a150c9dc | Stavros Sachtouris | "dns_nameservers": [], |
484 | a150c9dc | Stavros Sachtouris | "enable_slaac": false, |
485 | a150c9dc | Stavros Sachtouris | "public": false, |
486 | a150c9dc | Stavros Sachtouris | "allocation_pools": [], |
487 | a150c9dc | Stavros Sachtouris | "host_routes": [], |
488 | a150c9dc | Stavros Sachtouris | "ip_version": 6, |
489 | a150c9dc | Stavros Sachtouris | "gateway_ip": "2001:321:4abc:8765::9", |
490 | a150c9dc | Stavros Sachtouris | "cidr": "2001:678:5cba:1234::/64", |
491 | a150c9dc | Stavros Sachtouris | "enable_dhcp": true, |
492 | a150c9dc | Stavros Sachtouris | "id": "1413" |
493 | a150c9dc | Stavros Sachtouris | } |
494 | a150c9dc | Stavros Sachtouris | ] |
495 | a150c9dc | Stavros Sachtouris | } |
496 | a150c9dc | Stavros Sachtouris | |
497 | a150c9dc | Stavros Sachtouris | |
498 | a150c9dc | Stavros Sachtouris | Get subnet details |
499 | a150c9dc | Stavros Sachtouris | ---------------- |
500 | a150c9dc | Stavros Sachtouris | |
501 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
502 | a150c9dc | Stavros Sachtouris | |
503 | a150c9dc | Stavros Sachtouris | ======================== ====== ================ ========== |
504 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
505 | a150c9dc | Stavros Sachtouris | ======================== ====== ================ ========== |
506 | a150c9dc | Stavros Sachtouris | ``/subnets/<subnet id>`` GET ✔ ✔ |
507 | a150c9dc | Stavros Sachtouris | ======================== ====== ================ ========== |
508 | a150c9dc | Stavros Sachtouris | |
509 | a150c9dc | Stavros Sachtouris | | |
510 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
511 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
512 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
513 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
514 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
515 | a150c9dc | Stavros Sachtouris | |
516 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
517 | a150c9dc | Stavros Sachtouris | |
518 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
519 | a150c9dc | Stavros Sachtouris | Return Code Description |
520 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
521 | a150c9dc | Stavros Sachtouris | 201 (OK) Request succeeded |
522 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
523 | a150c9dc | Stavros Sachtouris | 404 (itemNoFound) Subnet not found |
524 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
525 | a150c9dc | Stavros Sachtouris | |
526 | a150c9dc | Stavros Sachtouris | Response body contents:: |
527 | a150c9dc | Stavros Sachtouris | |
528 | a150c9dc | Stavros Sachtouris | subnet: { |
529 | a150c9dc | Stavros Sachtouris | <subnet attribute>: <value>, |
530 | a150c9dc | Stavros Sachtouris | ... |
531 | a150c9dc | Stavros Sachtouris | } |
532 | a150c9dc | Stavros Sachtouris | |
533 | a150c9dc | Stavros Sachtouris | The attributes of a subnet are listed `here <#subnet-ref>`_ |
534 | a150c9dc | Stavros Sachtouris | |
535 | a150c9dc | Stavros Sachtouris | *Example Get subnet Details: JSON* |
536 | a150c9dc | Stavros Sachtouris | |
537 | a150c9dc | Stavros Sachtouris | .. code-block:: javascript |
538 | a150c9dc | Stavros Sachtouris | |
539 | a3d2b515 | Stavros Sachtouris | GET https://example.org/network/v2.0/subnets/1413 |
540 | a150c9dc | Stavros Sachtouris | |
541 | a150c9dc | Stavros Sachtouris | |
542 | a150c9dc | Stavros Sachtouris | { |
543 | a150c9dc | Stavros Sachtouris | "subnet": { |
544 | a150c9dc | Stavros Sachtouris | "user_id": "s0m3-u5e7-1d", |
545 | a150c9dc | Stavros Sachtouris | "name": "IPv6 Subnet of Network 3141", |
546 | a150c9dc | Stavros Sachtouris | "links": [ |
547 | a150c9dc | Stavros Sachtouris | { |
548 | a150c9dc | Stavros Sachtouris | "href": "https://example.org/network/v2.0/subnets/1413", |
549 | a150c9dc | Stavros Sachtouris | "rel": "self" |
550 | a150c9dc | Stavros Sachtouris | }, |
551 | a150c9dc | Stavros Sachtouris | { |
552 | a150c9dc | Stavros Sachtouris | "href": "https://example.org/network/v2.0/subnets/1413", |
553 | a150c9dc | Stavros Sachtouris | "rel": "bookmark" |
554 | a150c9dc | Stavros Sachtouris | } |
555 | a150c9dc | Stavros Sachtouris | ], |
556 | a150c9dc | Stavros Sachtouris | "network_id": "3141", |
557 | a150c9dc | Stavros Sachtouris | "tenant_id": "s0m3-u5e7-1d", |
558 | a150c9dc | Stavros Sachtouris | "dns_nameservers": [], |
559 | a150c9dc | Stavros Sachtouris | "enable_slaac": false, |
560 | a150c9dc | Stavros Sachtouris | "public": false, |
561 | a150c9dc | Stavros Sachtouris | "allocation_pools": [], |
562 | a150c9dc | Stavros Sachtouris | "host_routes": [], |
563 | a150c9dc | Stavros Sachtouris | "ip_version": 6, |
564 | a150c9dc | Stavros Sachtouris | "gateway_ip": "2001:321:4abc:8765::9", |
565 | a150c9dc | Stavros Sachtouris | "cidr": "2001:678:5cba:1234::/64", |
566 | a150c9dc | Stavros Sachtouris | "enable_dhcp": true, |
567 | a150c9dc | Stavros Sachtouris | "id": "1413" |
568 | a150c9dc | Stavros Sachtouris | } |
569 | a150c9dc | Stavros Sachtouris | } |
570 | a150c9dc | Stavros Sachtouris | |
571 | a150c9dc | Stavros Sachtouris | Create subnet |
572 | a150c9dc | Stavros Sachtouris | -------------- |
573 | a150c9dc | Stavros Sachtouris | |
574 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
575 | a150c9dc | Stavros Sachtouris | |
576 | a150c9dc | Stavros Sachtouris | ========== ====== ================ ========== |
577 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
578 | a150c9dc | Stavros Sachtouris | ========== ====== ================ ========== |
579 | a150c9dc | Stavros Sachtouris | ``/subnets`` POST ✔ ✔ |
580 | a150c9dc | Stavros Sachtouris | ========== ====== ================ ========== |
581 | a150c9dc | Stavros Sachtouris | |
582 | a150c9dc | Stavros Sachtouris | | |
583 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
584 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
585 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
586 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
587 | a150c9dc | Stavros Sachtouris | Content-Type Type or request body required required |
588 | a150c9dc | Stavros Sachtouris | Content-Length Length of request body required required |
589 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
590 | a150c9dc | Stavros Sachtouris | |
591 | a150c9dc | Stavros Sachtouris | Request body contents:: |
592 | a150c9dc | Stavros Sachtouris | |
593 | a150c9dc | Stavros Sachtouris | subnet: { |
594 | a150c9dc | Stavros Sachtouris | <subnet attribute>: <value>, |
595 | a150c9dc | Stavros Sachtouris | ... |
596 | a150c9dc | Stavros Sachtouris | } |
597 | a150c9dc | Stavros Sachtouris | |
598 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
599 | a150c9dc | Stavros Sachtouris | Subnet Attribute Cyclades/Network OS/Neutron |
600 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
601 | a150c9dc | Stavros Sachtouris | network_id required required |
602 | a150c9dc | Stavros Sachtouris | cidr required required |
603 | a150c9dc | Stavros Sachtouris | fixed_ips ✔ ✔ |
604 | a150c9dc | Stavros Sachtouris | name ✔ ✔ |
605 | a150c9dc | Stavros Sachtouris | tenand_id **✘** ✔ |
606 | a150c9dc | Stavros Sachtouris | allocation_pools ✔ ✔ |
607 | a150c9dc | Stavros Sachtouris | gateway_ip ✔ ✔ |
608 | a150c9dc | Stavros Sachtouris | ip_version ✔ ✔ |
609 | a150c9dc | Stavros Sachtouris | id **✘** ✔ |
610 | a150c9dc | Stavros Sachtouris | enable_dhcp ✔ ✔ |
611 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
612 | a150c9dc | Stavros Sachtouris | |
613 | a150c9dc | Stavros Sachtouris | * All the attributes are explained `here <#subnet-ref>`_ |
614 | a150c9dc | Stavros Sachtouris | |
615 | a150c9dc | Stavros Sachtouris | * **ip_version** must be set to 6 if ``cidr`` is an IPc6 subnet |
616 | a150c9dc | Stavros Sachtouris | |
617 | a150c9dc | Stavros Sachtouris | * **tenand_id** and **id** are accepted but ignored |
618 | a150c9dc | Stavros Sachtouris | |
619 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
620 | a150c9dc | Stavros Sachtouris | |
621 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
622 | a150c9dc | Stavros Sachtouris | Return Code Description |
623 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
624 | a150c9dc | Stavros Sachtouris | 201 (OK) Network created |
625 | a150c9dc | Stavros Sachtouris | 400 (BadRequest) Invalid request body (missing network_id or cidr) |
626 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
627 | a150c9dc | Stavros Sachtouris | 403 (Forbidden) Insufficient permissions |
628 | a150c9dc | Stavros Sachtouris | 404 (itemNoFound) Network not found |
629 | a150c9dc | Stavros Sachtouris | 409 (Conflict) Allocation pools overlap with themselves or gateway |
630 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
631 | a150c9dc | Stavros Sachtouris | |
632 | a150c9dc | Stavros Sachtouris | In case of success, the response has the same format is in |
633 | a150c9dc | Stavros Sachtouris | `get subnet details <#get-subnet-details>`_. |
634 | a150c9dc | Stavros Sachtouris | |
635 | a150c9dc | Stavros Sachtouris | Update subnet |
636 | a150c9dc | Stavros Sachtouris | ------------- |
637 | a150c9dc | Stavros Sachtouris | |
638 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
639 | a150c9dc | Stavros Sachtouris | |
640 | a150c9dc | Stavros Sachtouris | ======================== ====== ================ ========== |
641 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
642 | a150c9dc | Stavros Sachtouris | ======================== ====== ================ ========== |
643 | a150c9dc | Stavros Sachtouris | ``/subnets/<subnet id>`` PUT ✔ ✔ |
644 | a150c9dc | Stavros Sachtouris | ======================== ====== ================ ========== |
645 | a150c9dc | Stavros Sachtouris | |
646 | a150c9dc | Stavros Sachtouris | | |
647 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
648 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
649 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
650 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
651 | a150c9dc | Stavros Sachtouris | Content-Type Type or request body required required |
652 | a150c9dc | Stavros Sachtouris | Content-Length Length of request body required required |
653 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
654 | a150c9dc | Stavros Sachtouris | |
655 | a150c9dc | Stavros Sachtouris | Request body contents:: |
656 | a150c9dc | Stavros Sachtouris | |
657 | a150c9dc | Stavros Sachtouris | subnet: { |
658 | a150c9dc | Stavros Sachtouris | <subnet attribute>: <value>, |
659 | a150c9dc | Stavros Sachtouris | ... |
660 | a150c9dc | Stavros Sachtouris | } |
661 | a150c9dc | Stavros Sachtouris | |
662 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
663 | a150c9dc | Stavros Sachtouris | Subnet Attribute Cyclades/Network OS/Neutron |
664 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
665 | a150c9dc | Stavros Sachtouris | network_id **✘** ✔ |
666 | a150c9dc | Stavros Sachtouris | cidr **✘** ✔ |
667 | a150c9dc | Stavros Sachtouris | fixed_ips **✘** ✔ |
668 | a150c9dc | Stavros Sachtouris | name ✔ ✔ |
669 | a150c9dc | Stavros Sachtouris | tenand_id **✘** ✔ |
670 | a150c9dc | Stavros Sachtouris | allocation_pools **✘** ✔ |
671 | a150c9dc | Stavros Sachtouris | gateway_ip **✘** ✔ |
672 | a150c9dc | Stavros Sachtouris | ip_version **✘** ✔ |
673 | a150c9dc | Stavros Sachtouris | id **✘** ✔ |
674 | a150c9dc | Stavros Sachtouris | enable_dhcp **✘** ✔ |
675 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
676 | a150c9dc | Stavros Sachtouris | |
677 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
678 | a150c9dc | Stavros Sachtouris | |
679 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
680 | a150c9dc | Stavros Sachtouris | Return Code Description |
681 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
682 | a150c9dc | Stavros Sachtouris | 200 (OK) Network is updated |
683 | a150c9dc | Stavros Sachtouris | 400 (BadRequest) Field is not modifiable |
684 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
685 | a150c9dc | Stavros Sachtouris | 403 (Forbidden) You are not the owner of this subnet |
686 | a150c9dc | Stavros Sachtouris | 404 (itemNoFound) Subnet not found |
687 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
688 | a150c9dc | Stavros Sachtouris | |
689 | a150c9dc | Stavros Sachtouris | In case of success, the response has the same format as in |
690 | a150c9dc | Stavros Sachtouris | `get subnet details <#get-subnet-details>`_ containing the updated values. |
691 | a150c9dc | Stavros Sachtouris | |
692 | a150c9dc | Stavros Sachtouris | List ports |
693 | a150c9dc | Stavros Sachtouris | ---------- |
694 | a150c9dc | Stavros Sachtouris | |
695 | a150c9dc | Stavros Sachtouris | List ports connected on servers and networks accessible by the user |
696 | a150c9dc | Stavros Sachtouris | |
697 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
698 | a150c9dc | Stavros Sachtouris | |
699 | a150c9dc | Stavros Sachtouris | ========== ====== ================ ========== |
700 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
701 | a150c9dc | Stavros Sachtouris | ========== ====== ================ ========== |
702 | a150c9dc | Stavros Sachtouris | ``/ports`` GET ✔ ✔ |
703 | a150c9dc | Stavros Sachtouris | ========== ====== ================ ========== |
704 | a150c9dc | Stavros Sachtouris | |
705 | a150c9dc | Stavros Sachtouris | | |
706 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
707 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
708 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
709 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
710 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
711 | a150c9dc | Stavros Sachtouris | |
712 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
713 | a150c9dc | Stavros Sachtouris | |
714 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
715 | a150c9dc | Stavros Sachtouris | Return Code Description |
716 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
717 | a150c9dc | Stavros Sachtouris | 200 (OK) Request succeeded |
718 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
719 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
720 | a150c9dc | Stavros Sachtouris | |
721 | a150c9dc | Stavros Sachtouris | |
722 | a150c9dc | Stavros Sachtouris | Response body contents:: |
723 | a150c9dc | Stavros Sachtouris | |
724 | a150c9dc | Stavros Sachtouris | ports: [ |
725 | a150c9dc | Stavros Sachtouris | { |
726 | a150c9dc | Stavros Sachtouris | <port attribute>: <value>, |
727 | a150c9dc | Stavros Sachtouris | ... |
728 | a150c9dc | Stavros Sachtouris | }, ... |
729 | a150c9dc | Stavros Sachtouris | ] |
730 | a150c9dc | Stavros Sachtouris | |
731 | a150c9dc | Stavros Sachtouris | The attributes of a port are listed `here <#port-ref>`_ |
732 | a150c9dc | Stavros Sachtouris | |
733 | a150c9dc | Stavros Sachtouris | *Example List Ports: JSON* |
734 | a150c9dc | Stavros Sachtouris | |
735 | a150c9dc | Stavros Sachtouris | .. code-block:: javascript |
736 | a150c9dc | Stavros Sachtouris | |
737 | a3d2b515 | Stavros Sachtouris | GET https://example.org/network/v2.0/ports |
738 | a150c9dc | Stavros Sachtouris | |
739 | a150c9dc | Stavros Sachtouris | { |
740 | a150c9dc | Stavros Sachtouris | "ports": [ |
741 | a150c9dc | Stavros Sachtouris | { |
742 | a150c9dc | Stavros Sachtouris | "status": "ACTIVE", |
743 | a150c9dc | Stavros Sachtouris | "updated": "2014-02-12T08:32:41.785217+00:00", |
744 | a150c9dc | Stavros Sachtouris | "user_id": "s0m3-u5e7-1d", |
745 | a150c9dc | Stavros Sachtouris | "name": "Port to public network", |
746 | a150c9dc | Stavros Sachtouris | "links": [ |
747 | a150c9dc | Stavros Sachtouris | { |
748 | a3d2b515 | Stavros Sachtouris | "href": "https://example.org/network/v2.0/ports/18", |
749 | a150c9dc | Stavros Sachtouris | "rel": "self" |
750 | a150c9dc | Stavros Sachtouris | }, |
751 | a150c9dc | Stavros Sachtouris | { |
752 | a3d2b515 | Stavros Sachtouris | "href": "https://example.org/network/v2.0/ports/18", |
753 | a150c9dc | Stavros Sachtouris | "rel": "bookmark" |
754 | a150c9dc | Stavros Sachtouris | } |
755 | a150c9dc | Stavros Sachtouris | ], |
756 | a150c9dc | Stavros Sachtouris | "admin_state_up": true, |
757 | a150c9dc | Stavros Sachtouris | "network_id": "2718", |
758 | a150c9dc | Stavros Sachtouris | "tenant_id": "s0m3-u5e7-1d", |
759 | a150c9dc | Stavros Sachtouris | "created": "2014-02-12T08:31:37.782907+00:00", |
760 | a150c9dc | Stavros Sachtouris | "device_owner": "vm", |
761 | a150c9dc | Stavros Sachtouris | "mac_address": "aa:01:02:6c:34:ab", |
762 | a150c9dc | Stavros Sachtouris | "fixed_ips": [ |
763 | a150c9dc | Stavros Sachtouris | { |
764 | a150c9dc | Stavros Sachtouris | "subnet": "28", |
765 | a150c9dc | Stavros Sachtouris | "ip_address": "2001:443:2dfc:1232:a810:3cf:fe9b:21ab" |
766 | a150c9dc | Stavros Sachtouris | } |
767 | a150c9dc | Stavros Sachtouris | ], |
768 | a150c9dc | Stavros Sachtouris | "id": "18", |
769 | a150c9dc | Stavros Sachtouris | "security_groups": [], |
770 | a150c9dc | Stavros Sachtouris | "device_id": "42" |
771 | a150c9dc | Stavros Sachtouris | }, { |
772 | a150c9dc | Stavros Sachtouris | "status": "ACTIVE", |
773 | a150c9dc | Stavros Sachtouris | "updated": "2014-02-15T08:32:41.785217+00:00", |
774 | a150c9dc | Stavros Sachtouris | "user_id": "s0m3-u5e7-1d", |
775 | a150c9dc | Stavros Sachtouris | "name": "Port to public network", |
776 | a150c9dc | Stavros Sachtouris | "links": [ |
777 | a150c9dc | Stavros Sachtouris | { |
778 | a3d2b515 | Stavros Sachtouris | "href": "https://example.org/network/v2.0/ports/19", |
779 | a150c9dc | Stavros Sachtouris | "rel": "self" |
780 | a150c9dc | Stavros Sachtouris | }, |
781 | a150c9dc | Stavros Sachtouris | { |
782 | a3d2b515 | Stavros Sachtouris | "href": "https://example.org/network/v2.0/ports/19", |
783 | a150c9dc | Stavros Sachtouris | "rel": "bookmark" |
784 | a150c9dc | Stavros Sachtouris | } |
785 | a150c9dc | Stavros Sachtouris | ], |
786 | a150c9dc | Stavros Sachtouris | "admin_state_up": true, |
787 | a150c9dc | Stavros Sachtouris | "network_id": "2719", |
788 | a150c9dc | Stavros Sachtouris | "tenant_id": "s0m3-u5e7-1d", |
789 | a150c9dc | Stavros Sachtouris | "created": "2014-02-15T08:31:37.782907+00:00", |
790 | a150c9dc | Stavros Sachtouris | "device_owner": "vm", |
791 | a150c9dc | Stavros Sachtouris | "mac_address": "aa:00:0c:6d:34:bb", |
792 | a150c9dc | Stavros Sachtouris | "fixed_ips": [ |
793 | a150c9dc | Stavros Sachtouris | { |
794 | a150c9dc | Stavros Sachtouris | "subnet": "29", |
795 | a150c9dc | Stavros Sachtouris | "ip_address": "192.168.1.2" |
796 | a150c9dc | Stavros Sachtouris | } |
797 | a150c9dc | Stavros Sachtouris | ], |
798 | a150c9dc | Stavros Sachtouris | "id": "19", |
799 | a150c9dc | Stavros Sachtouris | "security_groups": [], |
800 | a150c9dc | Stavros Sachtouris | "device_id": "42" |
801 | a150c9dc | Stavros Sachtouris | } |
802 | a150c9dc | Stavros Sachtouris | ] |
803 | a150c9dc | Stavros Sachtouris | } |
804 | a150c9dc | Stavros Sachtouris | |
805 | a150c9dc | Stavros Sachtouris | |
806 | a150c9dc | Stavros Sachtouris | Get port details |
807 | a150c9dc | Stavros Sachtouris | ---------------- |
808 | a150c9dc | Stavros Sachtouris | |
809 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
810 | a150c9dc | Stavros Sachtouris | |
811 | a150c9dc | Stavros Sachtouris | ==================== ====== ================ ========== |
812 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
813 | a150c9dc | Stavros Sachtouris | ==================== ====== ================ ========== |
814 | a150c9dc | Stavros Sachtouris | ``/ports/<port id>`` GET ✔ ✔ |
815 | a150c9dc | Stavros Sachtouris | ==================== ====== ================ ========== |
816 | a150c9dc | Stavros Sachtouris | |
817 | a150c9dc | Stavros Sachtouris | | |
818 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
819 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
820 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
821 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
822 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
823 | a150c9dc | Stavros Sachtouris | |
824 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
825 | a150c9dc | Stavros Sachtouris | |
826 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
827 | a150c9dc | Stavros Sachtouris | Return Code Description |
828 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
829 | a150c9dc | Stavros Sachtouris | 200 (OK) Request succeeded |
830 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
831 | a150c9dc | Stavros Sachtouris | 404 (itemNoFound) Port not found |
832 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
833 | a150c9dc | Stavros Sachtouris | |
834 | a150c9dc | Stavros Sachtouris | Response body contents:: |
835 | a150c9dc | Stavros Sachtouris | |
836 | a150c9dc | Stavros Sachtouris | port: { |
837 | a150c9dc | Stavros Sachtouris | <port attribute>: <value>, |
838 | a150c9dc | Stavros Sachtouris | ... |
839 | a150c9dc | Stavros Sachtouris | } |
840 | a150c9dc | Stavros Sachtouris | |
841 | a150c9dc | Stavros Sachtouris | The attributes of a port are listed `here <#port-ref>`_ |
842 | a150c9dc | Stavros Sachtouris | |
843 | a150c9dc | Stavros Sachtouris | *Example Get Port Details: JSON* |
844 | a150c9dc | Stavros Sachtouris | |
845 | a150c9dc | Stavros Sachtouris | .. code-block:: javascript |
846 | a150c9dc | Stavros Sachtouris | |
847 | a3d2b515 | Stavros Sachtouris | GET https://example.org/network/v2.0/ports/18 |
848 | a150c9dc | Stavros Sachtouris | |
849 | a150c9dc | Stavros Sachtouris | |
850 | a150c9dc | Stavros Sachtouris | { |
851 | a150c9dc | Stavros Sachtouris | "port": { |
852 | a150c9dc | Stavros Sachtouris | "status": "ACTIVE", |
853 | a150c9dc | Stavros Sachtouris | "updated": "2014-02-12T08:32:41.785217+00:00", |
854 | a150c9dc | Stavros Sachtouris | "user_id": "s0m3-u5e7-1d", |
855 | a150c9dc | Stavros Sachtouris | "name": "Port to public network", |
856 | a150c9dc | Stavros Sachtouris | "links": [ |
857 | a150c9dc | Stavros Sachtouris | { |
858 | a3d2b515 | Stavros Sachtouris | "href": "https://example.org/network/v2.0/ports/18", |
859 | a150c9dc | Stavros Sachtouris | "rel": "self" |
860 | a150c9dc | Stavros Sachtouris | }, |
861 | a150c9dc | Stavros Sachtouris | { |
862 | a3d2b515 | Stavros Sachtouris | "href": "https://example.org/network/v2.0/ports/18", |
863 | a150c9dc | Stavros Sachtouris | "rel": "bookmark" |
864 | a150c9dc | Stavros Sachtouris | } |
865 | a150c9dc | Stavros Sachtouris | ], |
866 | a150c9dc | Stavros Sachtouris | "admin_state_up": true, |
867 | a150c9dc | Stavros Sachtouris | "network_id": "2718", |
868 | a150c9dc | Stavros Sachtouris | "tenant_id": "s0m3-u5e7-1d", |
869 | a150c9dc | Stavros Sachtouris | "created": "2014-02-12T08:31:37.782907+00:00", |
870 | a150c9dc | Stavros Sachtouris | "device_owner": "vm", |
871 | a150c9dc | Stavros Sachtouris | "mac_address": "aa:01:02:6c:34:ab", |
872 | a150c9dc | Stavros Sachtouris | "fixed_ips": [ |
873 | a150c9dc | Stavros Sachtouris | { |
874 | a150c9dc | Stavros Sachtouris | "subnet": "28", |
875 | a150c9dc | Stavros Sachtouris | "ip_address": "2001:443:2dfc:1232:a810:3cf:fe9b:21ab" |
876 | a150c9dc | Stavros Sachtouris | } |
877 | a150c9dc | Stavros Sachtouris | ], |
878 | a150c9dc | Stavros Sachtouris | "id": "18", |
879 | a150c9dc | Stavros Sachtouris | "security_groups": [], |
880 | a150c9dc | Stavros Sachtouris | "device_id": "42" |
881 | a150c9dc | Stavros Sachtouris | } |
882 | a150c9dc | Stavros Sachtouris | } |
883 | a150c9dc | Stavros Sachtouris | |
884 | a150c9dc | Stavros Sachtouris | Create port |
885 | a150c9dc | Stavros Sachtouris | -------------- |
886 | a150c9dc | Stavros Sachtouris | |
887 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
888 | a150c9dc | Stavros Sachtouris | |
889 | a150c9dc | Stavros Sachtouris | ========== ====== ================ ========== |
890 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
891 | a150c9dc | Stavros Sachtouris | ========== ====== ================ ========== |
892 | a150c9dc | Stavros Sachtouris | ``/ports`` POST ✔ ✔ |
893 | a150c9dc | Stavros Sachtouris | ========== ====== ================ ========== |
894 | a150c9dc | Stavros Sachtouris | |
895 | a150c9dc | Stavros Sachtouris | | |
896 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
897 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
898 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
899 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
900 | a150c9dc | Stavros Sachtouris | Content-Type Type or request body required required |
901 | a150c9dc | Stavros Sachtouris | Content-Length Length of request body required required |
902 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
903 | a150c9dc | Stavros Sachtouris | |
904 | a150c9dc | Stavros Sachtouris | Request body contents:: |
905 | a150c9dc | Stavros Sachtouris | |
906 | a150c9dc | Stavros Sachtouris | port: { |
907 | a150c9dc | Stavros Sachtouris | <port attribute>: <value>, |
908 | a150c9dc | Stavros Sachtouris | ... |
909 | a150c9dc | Stavros Sachtouris | } |
910 | a150c9dc | Stavros Sachtouris | |
911 | a150c9dc | Stavros Sachtouris | =============== ================ ========== |
912 | a150c9dc | Stavros Sachtouris | Port Attribute Cyclades/Network OS/Neutron |
913 | a150c9dc | Stavros Sachtouris | =============== ================ ========== |
914 | a150c9dc | Stavros Sachtouris | network_id required required |
915 | a150c9dc | Stavros Sachtouris | device_id ✔ **✘** |
916 | a150c9dc | Stavros Sachtouris | fixed_ips ✔ ✔ |
917 | a150c9dc | Stavros Sachtouris | name ✔ ✔ |
918 | a150c9dc | Stavros Sachtouris | security_groups ✔ ✔ |
919 | a150c9dc | Stavros Sachtouris | admin_state_up **✘** ✔ |
920 | a150c9dc | Stavros Sachtouris | mac_address **✘** ✔ |
921 | a150c9dc | Stavros Sachtouris | tenand_id **✘** ✔ |
922 | a150c9dc | Stavros Sachtouris | =============== ================ ========== |
923 | a150c9dc | Stavros Sachtouris | |
924 | a150c9dc | Stavros Sachtouris | * **network_id** is the uuid of the network this port is connected to |
925 | a150c9dc | Stavros Sachtouris | |
926 | a150c9dc | Stavros Sachtouris | * **device_id** is the id of the device (i.e. server or router) this port is |
927 | a150c9dc | Stavros Sachtouris | connected to |
928 | a150c9dc | Stavros Sachtouris | |
929 | a150c9dc | Stavros Sachtouris | * **fixed_ips** is a list of IP items. Each IP item is a dictionary containing |
930 | a150c9dc | Stavros Sachtouris | an ``ip_address`` field. The value must be the IPv4 address of a floating IP |
931 | a150c9dc | Stavros Sachtouris | which is reserved from the pool of the network with ``network_id``, for the |
932 | a150c9dc | Stavros Sachtouris | current user |
933 | a150c9dc | Stavros Sachtouris | |
934 | a150c9dc | Stavros Sachtouris | * **name** a string |
935 | a150c9dc | Stavros Sachtouris | |
936 | a150c9dc | Stavros Sachtouris | * **security_groups** is a list of security group IDs |
937 | a150c9dc | Stavros Sachtouris | |
938 | a150c9dc | Stavros Sachtouris | * **admin_state_up**, **mac_address** and **tenantd_id** are accepted by |
939 | a150c9dc | Stavros Sachtouris | Cyclades/Network, but they are ignored |
940 | a150c9dc | Stavros Sachtouris | |
941 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
942 | a150c9dc | Stavros Sachtouris | |
943 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
944 | a150c9dc | Stavros Sachtouris | Return Code Description |
945 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
946 | a150c9dc | Stavros Sachtouris | 201 (OK) Network created |
947 | a150c9dc | Stavros Sachtouris | 400 (BadRequest) Invalid request body (missing network_id) |
948 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
949 | a150c9dc | Stavros Sachtouris | 403 (Forbidden) Insufficient permissions |
950 | a150c9dc | Stavros Sachtouris | 404 (itemNoFound) Network not found |
951 | a150c9dc | Stavros Sachtouris | 503 (macGenerationFailure) Mac address generation failed |
952 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
953 | a150c9dc | Stavros Sachtouris | |
954 | a150c9dc | Stavros Sachtouris | In case of success, the response has the same format is in |
955 | a150c9dc | Stavros Sachtouris | `get port details <#get-port-details>`_. |
956 | a150c9dc | Stavros Sachtouris | |
957 | a150c9dc | Stavros Sachtouris | Update port |
958 | a150c9dc | Stavros Sachtouris | ----------- |
959 | a150c9dc | Stavros Sachtouris | |
960 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
961 | a150c9dc | Stavros Sachtouris | |
962 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
963 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
964 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
965 | a150c9dc | Stavros Sachtouris | ``/ports/<port id>`` PUT ✔ ✔ |
966 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
967 | a150c9dc | Stavros Sachtouris | |
968 | a150c9dc | Stavros Sachtouris | | |
969 | a150c9dc | Stavros Sachtouris | |
970 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
971 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
972 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
973 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
974 | a150c9dc | Stavros Sachtouris | Content-Type Type or request body required required |
975 | a150c9dc | Stavros Sachtouris | Content-Length Length of request body required required |
976 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
977 | a150c9dc | Stavros Sachtouris | |
978 | a150c9dc | Stavros Sachtouris | Request body contents:: |
979 | a150c9dc | Stavros Sachtouris | |
980 | a150c9dc | Stavros Sachtouris | port: { |
981 | a150c9dc | Stavros Sachtouris | <port attribute>: <value>, |
982 | a150c9dc | Stavros Sachtouris | ... |
983 | a150c9dc | Stavros Sachtouris | } |
984 | a150c9dc | Stavros Sachtouris | |
985 | a150c9dc | Stavros Sachtouris | =============== ================ ========== |
986 | a150c9dc | Stavros Sachtouris | Port Attribute Cyclades/Network OS/Neutron |
987 | a150c9dc | Stavros Sachtouris | =============== ================ ========== |
988 | a150c9dc | Stavros Sachtouris | name ✔ ✔ |
989 | a150c9dc | Stavros Sachtouris | network_id **✘** ✔ |
990 | a150c9dc | Stavros Sachtouris | port_id **✘** ✔ |
991 | a150c9dc | Stavros Sachtouris | fixed_ips **✘** ✔ |
992 | a150c9dc | Stavros Sachtouris | security_groups **✘** ✔ |
993 | a150c9dc | Stavros Sachtouris | admin_state_up **✘** ✔ |
994 | a150c9dc | Stavros Sachtouris | mac_address **✘** ✔ |
995 | a150c9dc | Stavros Sachtouris | tenand_id **✘** ✔ |
996 | a150c9dc | Stavros Sachtouris | =============== ================ ========== |
997 | a150c9dc | Stavros Sachtouris | |
998 | a150c9dc | Stavros Sachtouris | |
999 | a150c9dc | Stavros Sachtouris | * **name** a string |
1000 | a150c9dc | Stavros Sachtouris | |
1001 | a150c9dc | Stavros Sachtouris | * all other attributes are accepted but ignored |
1002 | a150c9dc | Stavros Sachtouris | |
1003 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
1004 | a150c9dc | Stavros Sachtouris | |
1005 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1006 | a150c9dc | Stavros Sachtouris | Return Code Description |
1007 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1008 | a150c9dc | Stavros Sachtouris | 200 (OK) Network is updated |
1009 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
1010 | a150c9dc | Stavros Sachtouris | 403 (Forbidden) You are not the owner of the network |
1011 | a150c9dc | Stavros Sachtouris | 404 (itemNoFound) Network not found |
1012 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1013 | a150c9dc | Stavros Sachtouris | |
1014 | a150c9dc | Stavros Sachtouris | In case of success, the response has the same format as in |
1015 | a150c9dc | Stavros Sachtouris | `get port details <#get-port-details>`_ containing the updated values. |
1016 | a150c9dc | Stavros Sachtouris | |
1017 | a150c9dc | Stavros Sachtouris | Delete port |
1018 | a150c9dc | Stavros Sachtouris | ----------- |
1019 | a150c9dc | Stavros Sachtouris | |
1020 | a150c9dc | Stavros Sachtouris | Delete a port |
1021 | a150c9dc | Stavros Sachtouris | |
1022 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
1023 | a150c9dc | Stavros Sachtouris | |
1024 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
1025 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron |
1026 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
1027 | a150c9dc | Stavros Sachtouris | ``/ports/<port id>`` DELETE ✔ ✔ |
1028 | a150c9dc | Stavros Sachtouris | ========================== ====== ================ ========== |
1029 | a150c9dc | Stavros Sachtouris | |
1030 | a150c9dc | Stavros Sachtouris | | |
1031 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
1032 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron |
1033 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
1034 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
1035 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
1036 | a150c9dc | Stavros Sachtouris | |
1037 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
1038 | a150c9dc | Stavros Sachtouris | |
1039 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1040 | a150c9dc | Stavros Sachtouris | Return Code Description |
1041 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1042 | a150c9dc | Stavros Sachtouris | 204 (OK) Port is being deleted |
1043 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
1044 | a150c9dc | Stavros Sachtouris | 404 (itemNoFound) Port not found |
1045 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1046 | a150c9dc | Stavros Sachtouris | |
1047 | a150c9dc | Stavros Sachtouris | List floating ips |
1048 | a150c9dc | Stavros Sachtouris | ----------------- |
1049 | a150c9dc | Stavros Sachtouris | |
1050 | a150c9dc | Stavros Sachtouris | List the floating ips which are reserved by the user |
1051 | a150c9dc | Stavros Sachtouris | |
1052 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
1053 | a150c9dc | Stavros Sachtouris | |
1054 | a150c9dc | Stavros Sachtouris | ================ ====== ================ ========== |
1055 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron Extensions |
1056 | a150c9dc | Stavros Sachtouris | ================ ====== ================ ========== |
1057 | a150c9dc | Stavros Sachtouris | ``/floatingips`` GET ✔ ✔ |
1058 | a150c9dc | Stavros Sachtouris | ================ ====== ================ ========== |
1059 | a150c9dc | Stavros Sachtouris | |
1060 | a150c9dc | Stavros Sachtouris | | |
1061 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
1062 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron Extensions |
1063 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
1064 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
1065 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
1066 | a150c9dc | Stavros Sachtouris | |
1067 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
1068 | a150c9dc | Stavros Sachtouris | |
1069 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1070 | a150c9dc | Stavros Sachtouris | Return Code Description |
1071 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1072 | a150c9dc | Stavros Sachtouris | 200 (OK) Request succeeded |
1073 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
1074 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1075 | a150c9dc | Stavros Sachtouris | |
1076 | a150c9dc | Stavros Sachtouris | Response body contents:: |
1077 | a150c9dc | Stavros Sachtouris | |
1078 | a150c9dc | Stavros Sachtouris | floatingips: [ |
1079 | a150c9dc | Stavros Sachtouris | { |
1080 | a150c9dc | Stavros Sachtouris | <floating ip attribute>: <value>, |
1081 | a150c9dc | Stavros Sachtouris | ... |
1082 | a150c9dc | Stavros Sachtouris | }, ... |
1083 | a150c9dc | Stavros Sachtouris | ] |
1084 | a150c9dc | Stavros Sachtouris | |
1085 | a150c9dc | Stavros Sachtouris | The attributes of a floating ip are listed `here <#floating-ip-ref>`_ |
1086 | a150c9dc | Stavros Sachtouris | |
1087 | a150c9dc | Stavros Sachtouris | *Example List Floating IPs: JSON* |
1088 | a150c9dc | Stavros Sachtouris | |
1089 | a150c9dc | Stavros Sachtouris | .. code-block:: javascript |
1090 | a150c9dc | Stavros Sachtouris | |
1091 | a3d2b515 | Stavros Sachtouris | GET https://example.org/network/v2.0/floatingips |
1092 | a150c9dc | Stavros Sachtouris | |
1093 | a150c9dc | Stavros Sachtouris | { |
1094 | a150c9dc | Stavros Sachtouris | "floatingips": [ |
1095 | a150c9dc | Stavros Sachtouris | { |
1096 | a150c9dc | Stavros Sachtouris | "instance_id": 42 |
1097 | a150c9dc | Stavros Sachtouris | "floating_network_id": 2719 |
1098 | a150c9dc | Stavros Sachtouris | "fixed_ip_address": None |
1099 | a150c9dc | Stavros Sachtouris | "floating_ip_address": "192.168.1.2" |
1100 | a150c9dc | Stavros Sachtouris | "port_id": 19 |
1101 | a150c9dc | Stavros Sachtouris | }, |
1102 | a150c9dc | Stavros Sachtouris | { |
1103 | a150c9dc | Stavros Sachtouris | "instance_id": 84 |
1104 | a150c9dc | Stavros Sachtouris | "floating_network_id": 4178 |
1105 | a150c9dc | Stavros Sachtouris | "fixed_ip_address": None |
1106 | a150c9dc | Stavros Sachtouris | "floating_ip_address": 192.168.1.3 |
1107 | a3d2b515 | Stavros Sachtouris | "port_id": 38 |
1108 | a150c9dc | Stavros Sachtouris | } |
1109 | a150c9dc | Stavros Sachtouris | ] |
1110 | a150c9dc | Stavros Sachtouris | } |
1111 | a150c9dc | Stavros Sachtouris | |
1112 | a150c9dc | Stavros Sachtouris | Get floating ip details |
1113 | a150c9dc | Stavros Sachtouris | ----------------------- |
1114 | a150c9dc | Stavros Sachtouris | |
1115 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
1116 | a150c9dc | Stavros Sachtouris | |
1117 | a150c9dc | Stavros Sachtouris | ======================== ====== ================ ===================== |
1118 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron Extensions |
1119 | a150c9dc | Stavros Sachtouris | ======================== ====== ================ ===================== |
1120 | a150c9dc | Stavros Sachtouris | ``/floatingips/<ip-id>`` GET ✔ ✔ |
1121 | a150c9dc | Stavros Sachtouris | ======================== ====== ================ ===================== |
1122 | a150c9dc | Stavros Sachtouris | |
1123 | a150c9dc | Stavros Sachtouris | | |
1124 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
1125 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron Extensions |
1126 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
1127 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
1128 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
1129 | a150c9dc | Stavros Sachtouris | |
1130 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
1131 | a150c9dc | Stavros Sachtouris | |
1132 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1133 | a150c9dc | Stavros Sachtouris | Return Code Description |
1134 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1135 | a150c9dc | Stavros Sachtouris | 201 (OK) Request succeeded |
1136 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
1137 | a150c9dc | Stavros Sachtouris | 404 (itemNoFound) Floating IP not found |
1138 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1139 | a150c9dc | Stavros Sachtouris | |
1140 | a150c9dc | Stavros Sachtouris | Response body contents:: |
1141 | a150c9dc | Stavros Sachtouris | |
1142 | a150c9dc | Stavros Sachtouris | floatingip: { |
1143 | a150c9dc | Stavros Sachtouris | <floating ip attribute>: <value>, |
1144 | a150c9dc | Stavros Sachtouris | ... |
1145 | a150c9dc | Stavros Sachtouris | } |
1146 | a150c9dc | Stavros Sachtouris | |
1147 | a150c9dc | Stavros Sachtouris | The attributes of a floating ip are listed `here <#floating-ip-ref>`_ |
1148 | a150c9dc | Stavros Sachtouris | |
1149 | a150c9dc | Stavros Sachtouris | *Example Get Floating IP Details: JSON* |
1150 | a150c9dc | Stavros Sachtouris | |
1151 | a150c9dc | Stavros Sachtouris | .. code-block:: javascript |
1152 | a150c9dc | Stavros Sachtouris | |
1153 | a3d2b515 | Stavros Sachtouris | GET https://example.org/network/v2.0/floatingips/19 |
1154 | a150c9dc | Stavros Sachtouris | |
1155 | a150c9dc | Stavros Sachtouris | |
1156 | a150c9dc | Stavros Sachtouris | { |
1157 | a150c9dc | Stavros Sachtouris | "floatingip": { |
1158 | a150c9dc | Stavros Sachtouris | "instance_id": 42 |
1159 | a150c9dc | Stavros Sachtouris | "floating_network_id": 2719 |
1160 | a150c9dc | Stavros Sachtouris | "fixed_ip_address": None |
1161 | a150c9dc | Stavros Sachtouris | "floating_ip_address": "192.168.1.2" |
1162 | a150c9dc | Stavros Sachtouris | "port_i"d: 19 |
1163 | a150c9dc | Stavros Sachtouris | } |
1164 | a150c9dc | Stavros Sachtouris | } |
1165 | a150c9dc | Stavros Sachtouris | |
1166 | a150c9dc | Stavros Sachtouris | Create floating ip |
1167 | a150c9dc | Stavros Sachtouris | ------------------ |
1168 | a150c9dc | Stavros Sachtouris | |
1169 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
1170 | a150c9dc | Stavros Sachtouris | |
1171 | a150c9dc | Stavros Sachtouris | ================ ====== ================ ===================== |
1172 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron Extensions |
1173 | a150c9dc | Stavros Sachtouris | ================ ====== ================ ===================== |
1174 | a150c9dc | Stavros Sachtouris | ``/floatingips`` POST ✔ ✔ |
1175 | a150c9dc | Stavros Sachtouris | ================ ====== ================ ===================== |
1176 | a150c9dc | Stavros Sachtouris | |
1177 | a150c9dc | Stavros Sachtouris | | |
1178 | a150c9dc | Stavros Sachtouris | |
1179 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ===================== |
1180 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron Extensions |
1181 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ===================== |
1182 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
1183 | a150c9dc | Stavros Sachtouris | Content-Type Type or request body required required |
1184 | a150c9dc | Stavros Sachtouris | Content-Length Length of request body required required |
1185 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ===================== |
1186 | a150c9dc | Stavros Sachtouris | |
1187 | a150c9dc | Stavros Sachtouris | Request body contents:: |
1188 | a150c9dc | Stavros Sachtouris | |
1189 | a150c9dc | Stavros Sachtouris | floating ip: { |
1190 | a150c9dc | Stavros Sachtouris | <floating ip attribute>: <value>, |
1191 | a150c9dc | Stavros Sachtouris | ... |
1192 | a150c9dc | Stavros Sachtouris | } |
1193 | a150c9dc | Stavros Sachtouris | |
1194 | a150c9dc | Stavros Sachtouris | ===================== ================ ========== |
1195 | a150c9dc | Stavros Sachtouris | Floating IP Attribute Cyclades/Network OS/Neutron Extensions |
1196 | a150c9dc | Stavros Sachtouris | ===================== ================ ========== |
1197 | a150c9dc | Stavros Sachtouris | floating network_id required required |
1198 | a150c9dc | Stavros Sachtouris | floating_ip_address ✔ ✔ |
1199 | a150c9dc | Stavros Sachtouris | port_id **✘** ✔ |
1200 | a150c9dc | Stavros Sachtouris | fixed_ip_address **✘** ✔ |
1201 | a150c9dc | Stavros Sachtouris | ===================== ================ ========== |
1202 | a150c9dc | Stavros Sachtouris | |
1203 | a150c9dc | Stavros Sachtouris | * All the attributes are explained `here <#floating-ip-ref>`_ |
1204 | a150c9dc | Stavros Sachtouris | |
1205 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
1206 | a150c9dc | Stavros Sachtouris | |
1207 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1208 | a150c9dc | Stavros Sachtouris | Return Code Description |
1209 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1210 | a150c9dc | Stavros Sachtouris | 201 (OK) Network created |
1211 | a150c9dc | Stavros Sachtouris | 400 (BadRequest) Invalid request body (missing floating_network_id) |
1212 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
1213 | a150c9dc | Stavros Sachtouris | 409 (Conflict) Insufficient resources |
1214 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1215 | a150c9dc | Stavros Sachtouris | |
1216 | a150c9dc | Stavros Sachtouris | In case of success, the response has the same format is in |
1217 | a150c9dc | Stavros Sachtouris | `get floating ip details <#get-floating-ip-details>`_. |
1218 | a150c9dc | Stavros Sachtouris | |
1219 | a150c9dc | Stavros Sachtouris | Delete floating ip |
1220 | a150c9dc | Stavros Sachtouris | ------------------ |
1221 | a150c9dc | Stavros Sachtouris | |
1222 | a150c9dc | Stavros Sachtouris | .. rubric:: Request |
1223 | a150c9dc | Stavros Sachtouris | |
1224 | a150c9dc | Stavros Sachtouris | ================================ ====== ================ ===================== |
1225 | a150c9dc | Stavros Sachtouris | URI Method Cyclades/Network OS/Neutron Extensions |
1226 | a150c9dc | Stavros Sachtouris | ================================ ====== ================ ===================== |
1227 | a150c9dc | Stavros Sachtouris | ``/floatingips/<floatingip-id>`` DELETE ✔ ✔ |
1228 | a150c9dc | Stavros Sachtouris | ================================ ====== ================ ===================== |
1229 | a150c9dc | Stavros Sachtouris | |
1230 | a150c9dc | Stavros Sachtouris | | |
1231 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
1232 | a150c9dc | Stavros Sachtouris | Request Header Value Cyclades/Network OS/Neutron Extensions |
1233 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
1234 | a150c9dc | Stavros Sachtouris | X-Auth-Token User authentication token required required |
1235 | a150c9dc | Stavros Sachtouris | ============== ========================= ================ ========== |
1236 | a150c9dc | Stavros Sachtouris | |
1237 | a150c9dc | Stavros Sachtouris | .. rubric:: Response |
1238 | a150c9dc | Stavros Sachtouris | |
1239 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1240 | a150c9dc | Stavros Sachtouris | Return Code Description |
1241 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1242 | a150c9dc | Stavros Sachtouris | 204 (OK) Floating IP is being deleted |
1243 | a150c9dc | Stavros Sachtouris | 401 (Unauthorized) Missing or expired user token |
1244 | a150c9dc | Stavros Sachtouris | 404 (itemNoFound) Floating IP not found |
1245 | a150c9dc | Stavros Sachtouris | =========================== ===================== |
1246 | a150c9dc | Stavros Sachtouris | |
1247 | a150c9dc | Stavros Sachtouris | Index of Attributes |
1248 | a150c9dc | Stavros Sachtouris | ------------------- |
1249 | a150c9dc | Stavros Sachtouris | |
1250 | a150c9dc | Stavros Sachtouris | .. _network-ref: |
1251 | a150c9dc | Stavros Sachtouris | |
1252 | a150c9dc | Stavros Sachtouris | Network attributes |
1253 | a150c9dc | Stavros Sachtouris | .................. |
1254 | a150c9dc | Stavros Sachtouris | |
1255 | a150c9dc | Stavros Sachtouris | ================== ================ ========== |
1256 | a150c9dc | Stavros Sachtouris | Network attributes Cyclades/Network OS/Neutron |
1257 | a150c9dc | Stavros Sachtouris | ================== ================ ========== |
1258 | a150c9dc | Stavros Sachtouris | admin_state_up ✔ ✔ |
1259 | a150c9dc | Stavros Sachtouris | id ✔ ✔ |
1260 | a150c9dc | Stavros Sachtouris | name ✔ ✔ |
1261 | a150c9dc | Stavros Sachtouris | shared ✔ ✔ |
1262 | a150c9dc | Stavros Sachtouris | public ✔ **✘** |
1263 | a150c9dc | Stavros Sachtouris | status ✔ ✔ |
1264 | a150c9dc | Stavros Sachtouris | subnets ✔ ✔ |
1265 | a150c9dc | Stavros Sachtouris | tenant_id ✔ ✔ |
1266 | a150c9dc | Stavros Sachtouris | user_id ✔ **✘** |
1267 | a150c9dc | Stavros Sachtouris | network_type ✔ **✘** |
1268 | a150c9dc | Stavros Sachtouris | router:external ✔ **✘** |
1269 | a150c9dc | Stavros Sachtouris | SNF:floating_ip ✔ **✘** |
1270 | a150c9dc | Stavros Sachtouris | links ✔ **✘** |
1271 | a150c9dc | Stavros Sachtouris | ================== ================ ========== |
1272 | a150c9dc | Stavros Sachtouris | |
1273 | a150c9dc | Stavros Sachtouris | * **admin_state_up** The administrative state of the network (true, false) |
1274 | a150c9dc | Stavros Sachtouris | * **shared** Used for compatibility with OS/Neutron and has the same value as |
1275 | a150c9dc | Stavros Sachtouris | public |
1276 | a150c9dc | Stavros Sachtouris | * **public** If the network is publicly accessible (true, false) |
1277 | a150c9dc | Stavros Sachtouris | * **status** ACTIVE, DOWN, BUILD, ERROR, SNF:DRAINED |
1278 | a150c9dc | Stavros Sachtouris | The later means that no new ports or floating IPs can be created from this |
1279 | a150c9dc | Stavros Sachtouris | network |
1280 | a150c9dc | Stavros Sachtouris | * **tenant_id** Used for compatibility with OS/Neutron and has the same value |
1281 | a150c9dc | Stavros Sachtouris | as user_id |
1282 | a150c9dc | Stavros Sachtouris | * **user_id** The owner of the network if private or None if public |
1283 | a150c9dc | Stavros Sachtouris | * **network_type** MAC_FILTERED, IP_LESS_ROUTED, PHYSICAL_VLAN |
1284 | a150c9dc | Stavros Sachtouris | * **router:external** Whether the network is connected to an external router |
1285 | a150c9dc | Stavros Sachtouris | (true, false) |
1286 | a150c9dc | Stavros Sachtouris | |
1287 | a150c9dc | Stavros Sachtouris | .. _subnet-ref: |
1288 | a150c9dc | Stavros Sachtouris | |
1289 | a150c9dc | Stavros Sachtouris | Subnet attributes |
1290 | a150c9dc | Stavros Sachtouris | ................. |
1291 | a150c9dc | Stavros Sachtouris | |
1292 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
1293 | a150c9dc | Stavros Sachtouris | Subnet attributes Cyclades/Network OS/Neutron |
1294 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
1295 | a150c9dc | Stavros Sachtouris | id ✔ ✔ |
1296 | a150c9dc | Stavros Sachtouris | name ✔ ✔ |
1297 | a150c9dc | Stavros Sachtouris | network_id ✔ ✔ |
1298 | a150c9dc | Stavros Sachtouris | ip_version ✔ ✔ |
1299 | a150c9dc | Stavros Sachtouris | cidr ✔ ✔ |
1300 | a150c9dc | Stavros Sachtouris | gateway_ip ✔ ✔ |
1301 | a150c9dc | Stavros Sachtouris | enable_dhcp ✔ ✔ |
1302 | a150c9dc | Stavros Sachtouris | allocation_pools ✔ ✔ |
1303 | a150c9dc | Stavros Sachtouris | tenant_id ✔ ✔ |
1304 | a150c9dc | Stavros Sachtouris | dns_nameservers ✔ ✔ |
1305 | a150c9dc | Stavros Sachtouris | host_routes ✔ ✔ |
1306 | a150c9dc | Stavros Sachtouris | user_id ✔ **✘** |
1307 | a150c9dc | Stavros Sachtouris | enable_slaac ✔ **✘** |
1308 | a150c9dc | Stavros Sachtouris | links ✔ **✘** |
1309 | a150c9dc | Stavros Sachtouris | ================= ================ ========== |
1310 | a150c9dc | Stavros Sachtouris | |
1311 | a150c9dc | Stavros Sachtouris | * **id** The UUID for the subnet |
1312 | a150c9dc | Stavros Sachtouris | * **name** A human readable name |
1313 | a150c9dc | Stavros Sachtouris | * **network_id** The ID of the network associated with this subnet |
1314 | a150c9dc | Stavros Sachtouris | * **ip_version** The IP version (4, 6) of the subnet (default is 4) |
1315 | a150c9dc | Stavros Sachtouris | * **cidr** CIDR represents IP range for this subnet, based on the IP version |
1316 | a150c9dc | Stavros Sachtouris | * **gateway_ip** Default gateway used by devices in this subnet. If not |
1317 | a150c9dc | Stavros Sachtouris | specified the service will be the first available IP address. Tto get no |
1318 | a150c9dc | Stavros Sachtouris | gateway, set to None |
1319 | a150c9dc | Stavros Sachtouris | * **enable_dhcp** Wheather nfdhcpd is enabled for this subnet (true, false) |
1320 | a150c9dc | Stavros Sachtouris | * **enable_slaac** Whether SLAAC is enabled for this subnet (true, false) |
1321 | a150c9dc | Stavros Sachtouris | * **allocation_pools(CR)** Subranges of cidr available for dynamic allocation. |
1322 | a150c9dc | Stavros Sachtouris | List of dictionaries of the form: |
1323 | a150c9dc | Stavros Sachtouris | [{“start”: “192.168.2.0”, “end”: 192.168.2.10”}, ...] |
1324 | a150c9dc | Stavros Sachtouris | * **user_id** The UUID of the network owner, None if the network is public |
1325 | c4dccd8a | Stavros Sachtouris | * **tenant_id** The UUID of the project that defines this resource |
1326 | a150c9dc | Stavros Sachtouris | * **host_routes** Routes that should be used by devices with IPs from this |
1327 | a150c9dc | Stavros Sachtouris | subnet (list) |
1328 | a150c9dc | Stavros Sachtouris | * **dns_nameservers** Used for compatibility with OpenStack/Neutron |
1329 | a150c9dc | Stavros Sachtouris | |
1330 | a150c9dc | Stavros Sachtouris | .. _port-ref: |
1331 | a150c9dc | Stavros Sachtouris | |
1332 | a150c9dc | Stavros Sachtouris | Port attributes |
1333 | a150c9dc | Stavros Sachtouris | ............... |
1334 | a150c9dc | Stavros Sachtouris | |
1335 | a150c9dc | Stavros Sachtouris | ==================== ================ ========== |
1336 | a150c9dc | Stavros Sachtouris | Port attributes Cyclades/Network OS/Neutron |
1337 | a150c9dc | Stavros Sachtouris | ==================== ================ ========== |
1338 | a150c9dc | Stavros Sachtouris | id ✔ ✔ |
1339 | a150c9dc | Stavros Sachtouris | name ✔ ✔ |
1340 | a150c9dc | Stavros Sachtouris | status ✔ ✔ |
1341 | a150c9dc | Stavros Sachtouris | admin_state_up ✔ ✔ |
1342 | a150c9dc | Stavros Sachtouris | network_id ✔ ✔ |
1343 | a150c9dc | Stavros Sachtouris | tenant_id ✔ ✔ |
1344 | a150c9dc | Stavros Sachtouris | mac_address ✔ ✔ |
1345 | a150c9dc | Stavros Sachtouris | fixed_ips ✔ ✔ |
1346 | a150c9dc | Stavros Sachtouris | device_id ✔ ✔ |
1347 | a150c9dc | Stavros Sachtouris | device_owner ✔ ✔ |
1348 | a150c9dc | Stavros Sachtouris | security_groups ✔ ✔ |
1349 | a150c9dc | Stavros Sachtouris | port_filter **✘** ✔ |
1350 | a150c9dc | Stavros Sachtouris | binding:vif_type **✘** ✔ |
1351 | a150c9dc | Stavros Sachtouris | binding:capabilities **✘** ✔ |
1352 | a150c9dc | Stavros Sachtouris | user_id ✔ **✘** |
1353 | a150c9dc | Stavros Sachtouris | links ✔ **✘** |
1354 | a150c9dc | Stavros Sachtouris | ==================== ================ ========== |
1355 | a150c9dc | Stavros Sachtouris | |
1356 | a150c9dc | Stavros Sachtouris | * **status** ACTIVE, DOWN, BUILD, ERROR |
1357 | a150c9dc | Stavros Sachtouris | * **admin_state_up** The administrative state of the network (true, false). If |
1358 | a150c9dc | Stavros Sachtouris | false, the network does not forward packets |
1359 | a150c9dc | Stavros Sachtouris | * **network_id** UUID of the attached network |
1360 | a150c9dc | Stavros Sachtouris | * **user_id** The UUID of the owner of the network, or None if the network is |
1361 | a150c9dc | Stavros Sachtouris | public |
1362 | c4dccd8a | Stavros Sachtouris | * **tenant_id** The UUID of the project that defines this resource |
1363 | a150c9dc | Stavros Sachtouris | * **device_owner** ID of the entity using this port. e.g., |
1364 | a150c9dc | Stavros Sachtouris | network:router, network:router_gateway |
1365 | a150c9dc | Stavros Sachtouris | * **fixed_ips** IP information for the port (list of dicts). Each IP item |
1366 | a150c9dc | Stavros Sachtouris | (dictionary) consists of a ``subnet`` and an ``ip_address`` field. |
1367 | a150c9dc | Stavros Sachtouris | * **device_id** The ID of the device that uses this port i.e., a virtual server |
1368 | a150c9dc | Stavros Sachtouris | or a router |
1369 | a150c9dc | Stavros Sachtouris | |
1370 | a150c9dc | Stavros Sachtouris | * **security_groups** List of security group IDs associated with this port |
1371 | a150c9dc | Stavros Sachtouris | |
1372 | a150c9dc | Stavros Sachtouris | .. _floating-ip-ref: |
1373 | a150c9dc | Stavros Sachtouris | |
1374 | a150c9dc | Stavros Sachtouris | Floating ip attributes |
1375 | a150c9dc | Stavros Sachtouris | ...................... |
1376 | a150c9dc | Stavros Sachtouris | |
1377 | a150c9dc | Stavros Sachtouris | ====================== ================ ========== |
1378 | a150c9dc | Stavros Sachtouris | Floating ip attributes Cyclades/Network OS/Neutron Extensions |
1379 | a150c9dc | Stavros Sachtouris | ====================== ================ ========== |
1380 | a150c9dc | Stavros Sachtouris | id ✔ ✔ |
1381 | a150c9dc | Stavros Sachtouris | floating_network_id ✔ ✔ |
1382 | a150c9dc | Stavros Sachtouris | floating_ip_address ✔ ✔ |
1383 | a150c9dc | Stavros Sachtouris | fixed_ip_address ✔ ✔ |
1384 | a150c9dc | Stavros Sachtouris | port_id ✔ ✔ |
1385 | a150c9dc | Stavros Sachtouris | user_id ✔ **✘** |
1386 | a150c9dc | Stavros Sachtouris | tenant_id ✔ ✔ |
1387 | a150c9dc | Stavros Sachtouris | instance_id ✔ **✘** |
1388 | a150c9dc | Stavros Sachtouris | router_id ✔ ✔ |
1389 | a150c9dc | Stavros Sachtouris | ====================== ================ ========== |
1390 | a150c9dc | Stavros Sachtouris | |
1391 | a150c9dc | Stavros Sachtouris | |
1392 | a150c9dc | Stavros Sachtouris | * **id** The UUID for the floating IP |
1393 | a150c9dc | Stavros Sachtouris | * **floating_network_id** The UUID of the external network associated to this |
1394 | a150c9dc | Stavros Sachtouris | floating IP is associated. |
1395 | a150c9dc | Stavros Sachtouris | * **floating_ip_address** The IPv4 address of the floating IP |
1396 | a150c9dc | Stavros Sachtouris | * **fixed_ip_address** Used for compatibility, always None |
1397 | a150c9dc | Stavros Sachtouris | * **port_id** The port where this IP is attached, if any |
1398 | a150c9dc | Stavros Sachtouris | * **instance_id** The device using this floating IP, if any |
1399 | a150c9dc | Stavros Sachtouris | * **user_id** The UUID of the owner of the floating IP |
1400 | c4dccd8a | Stavros Sachtouris | * **tenant_id** The UUID of the project that defines this resource |
1401 | a150c9dc | Stavros Sachtouris | * **router_id** The ID of the router, if any |