extraroute extension is not documented in the API reference

Bug #1408722 reported by Anne Gentle
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-api-site
Fix Released
High
Diane Fleming

Bug Description

For Networking API v 2.0, there's an extraroute extension that's undocumented in the API reference. Heres' the information.

This extension adds extra routes to the router resource.

You can specify a set of nexthop IPs and destination CIDRs.

Note
The nexthop IP must be a part of one of the subnets to which the router interfaces are connected. You can configure the routes attribute on only update operations.
Attribute=routes Type=list of dict Required=false

List should be in this form. [{'nexthop':IPAddress, 'destination':CIDR}]

PUT /routers/router_id Updates logical router with routes attribute.
Normal Response Code: 200

Error Response Codes: Unauthorized (401), Bad Request (400), Not Found (404), Conflict (409)

This operation configures extra routes on the router. The nexthop IP must be a part of one of the subnets to which the router interfaces are connected. Otherwise, the server responds with 400 Bad Request error code. When a validation error is detected, such as a format error of IP address or CIDR, the server responds with 400 Bad Request. When Networking receives a request to delete the router interface for subnets that are used by one or more routes, it responds with 409 Conflict.

Update routes: JSON request

{
   "router":{
      "routes":[
         {
            "nexthop":"10.1.0.10",
            "destination":"40.0.1.0/24"
         }
      ]
   }
}

Update routes: JSON response

{"router":
    {"status": "ACTIVE",
     "external_gateway_info": {"network_id": "5c26e0bb-a9a9-429c-9703-5c417a221096"},
     "name": "router1",
     "admin_state_up": true,
     "tenant_id": "936fa220b2c24a87af51026439af7a3e",
     "routes": [{"nexthop": "10.1.0.10", "destination": "40.0.1.0/24"}],
     "id": "babc8173-46f6-4b6f-8b95-38c1683a4e22"}
}

Changed in openstack-api-site:
assignee: nobody → Takanori Miyagishi (miyagishi-t)
Anne Gentle (annegentle)
Changed in openstack-api-site:
importance: Undecided → High
Changed in openstack-api-site:
assignee: Takanori Miyagishi (miyagishi-t) → Diane Fleming (diane-fleming)
milestone: none → kilo
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to api-site (master)

Fix proposed to branch: master
Review: https://review.openstack.org/169379

Changed in openstack-api-site:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/169379
Committed: https://git.openstack.org/cgit/openstack/api-site/commit/?id=8fac3e27f0c90fb785753aa03ab2d3501de1f8fe
Submitter: Jenkins
Branch: master

commit 8fac3e27f0c90fb785753aa03ab2d3501de1f8fe
Author: Diane Fleming <email address hidden>
Date: Tue Mar 31 10:21:38 2015 -0500

    Add Extra Routes extension to Networking v2.0

    Also, moved some entities to the common_project.ent file, which
    required that I update the Networking WADLs with new file ref.

    Change-Id: I67850593d48af6f7de790074cb97b12073da3b57
    Closes-Bug: #1408722

Changed in openstack-api-site:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.