Revision fbb9e526 docs/network-api-guide.rst

b/docs/network-api-guide.rst
1194 1194
===================== ================ ==========
1195 1195
Floating IP Attribute Cyclades/Network OS/Neutron Extensions
1196 1196
===================== ================ ==========
1197
floating network_id   required         required
1197
floating_network_id   ✔                required
1198 1198
floating_ip_address   ✔                ✔
1199 1199
port_id               **✘**            ✔
1200 1200
fixed_ip_address      **✘**            ✔
1201 1201
===================== ================ ==========
1202 1202

  
1203
* In Cyclades/Network, if ``floating_network_id`` is not used, the service
1204
  will automatically pick a public network with a sufficient number of
1205
  available IPs
1206

  
1203 1207
* All the attributes are explained `here <#floating-ip-ref>`_
1204 1208

  
1205 1209
.. rubric:: Response
......
1272 1276

  
1273 1277
* **admin_state_up** The administrative state of the network (true, false)
1274 1278
* **shared** Used for compatibility with OS/Neutron and has the same value as
1275
    public
1279
  public
1276 1280
* **public** If the network is publicly accessible (true, false)
1277 1281
* **status** ACTIVE, DOWN, BUILD, ERROR, SNF:DRAINED
1278
    The later means that no new ports or floating IPs can be created from this
1279
    network
1282
  The later means that no new ports or floating IPs can be created from this
1283
  network
1280 1284
* **tenant_id** Used for compatibility with OS/Neutron and has the same value
1281
    as user_id
1285
  as user_id
1282 1286
* **user_id** The owner of the network if private or None if public
1283 1287
* **network_type** MAC_FILTERED, IP_LESS_ROUTED, PHYSICAL_VLAN
1284 1288
* **router:external**  Whether the network is connected to an external router
1285
    (true, false)
1289
  (true, false)
1286 1290

  
1287 1291
.. _subnet-ref:
1288 1292

  
......
1314 1318
* **ip_version** The IP version (4, 6) of the subnet (default is 4)
1315 1319
* **cidr** CIDR represents IP range for this subnet, based on the IP version
1316 1320
* **gateway_ip** Default gateway used by devices in this subnet. If not
1317
    specified the service will be the first available IP address. Tto get no
1318
    gateway, set to None
1321
  specified the service will be the first available IP address. Tto get no
1322
  gateway, set to None
1319 1323
* **enable_dhcp** Wheather nfdhcpd is enabled for this subnet (true, false)
1320 1324
* **enable_slaac** Whether SLAAC is enabled for this subnet (true, false)
1321 1325
* **allocation_pools(CR)** Subranges of cidr available for dynamic allocation.
1322
    List of dictionaries of the form:
1323
    [{“start”: “192.168.2.0”, “end”: 192.168.2.10”}, ...]
1326
  List of dictionaries of the form:
1327
  [{“start”: “192.168.2.0”, “end”: 192.168.2.10”}, ...]
1324 1328
* **user_id** The UUID of the network owner, None if the network is public
1325 1329
* **tenant_id** The UUID of the project that defines this resource
1326 1330
* **host_routes** Routes that should be used by devices with IPs from this
1327
    subnet (list)
1331
  subnet (list)
1328 1332
* **dns_nameservers** Used for compatibility with OpenStack/Neutron
1329 1333

  
1330 1334
.. _port-ref:
......
1355 1359

  
1356 1360
* **status** ACTIVE, DOWN, BUILD, ERROR
1357 1361
* **admin_state_up** The administrative state of the network (true, false). If
1358
    false, the network does not forward packets
1362
  false, the network does not forward packets
1359 1363
* **network_id**  UUID of the attached network
1360 1364
* **user_id** The UUID of the owner of the network, or None if the network is
1361
    public
1365
  public
1362 1366
* **tenant_id** The UUID of the project that defines this resource
1363 1367
* **device_owner** ID of the entity using this port. e.g.,
1364
    network:router, network:router_gateway
1368
  network:router, network:router_gateway
1365 1369
* **fixed_ips** IP information for the port (list of dicts). Each IP item
1366
    (dictionary) consists of a ``subnet`` and an ``ip_address`` field.
1370
  (dictionary) consists of a ``subnet`` and an ``ip_address`` field.
1367 1371
* **device_id** The ID of the device that uses this port i.e., a virtual server
1368
    or a router
1372
  or a router
1369 1373

  
1370 1374
* **security_groups** List of security group IDs associated with this port
1371 1375

  
......
1391 1395

  
1392 1396
* **id** The UUID for the floating IP
1393 1397
* **floating_network_id** The UUID of the external network associated to this
1394
    floating IP is associated.
1398
  floating IP is associated.
1395 1399
* **floating_ip_address** The IPv4 address of the floating IP
1396 1400
* **fixed_ip_address** Used for compatibility, always None
1397 1401
* **port_id** The port where this IP is attached, if any

Also available in: Unified diff