• QuantumAPISpec

Quantum API Specification

Introduction

Quantum is a project to provide "network connectivity as a service" between devices managed by other Openstack services such as nova. For more information on Quantum and the other network-related projects please check the Quantum home page and the Network projects home page.

As Quantum provides “network connectivity as a service”, this API specification defines Layer-2 operations only.

This document contains the specification for the version 1.0 of the core API for the Quantum service.
For each operation this document specifies:

• Request method (e.g.: GET, PUT, POST, DELETE)
• Request relative URI
• Request format
• Response format

Quantum core API allows for both JSON and XML format to be used.

This specification document is structured as follows:

• Glossary: introduces the terminology used throughout the document;
• Theory of operation: discusses how the Quantum service works in principle;
• Concepts: describes the resources managed by the Quantum API;
• Operation List: detailed described of the operation exposed by the Quantum API.

Glossary

Theory of Operation

This section presents the objects and semantics of Quantum’s logical model.

Quantum abstracts the physical implementation of the network, allowing plugins to configure and manage physical resources.Quantum is a standalone service, in that it requires no other projects within Openstack to function correctly. Further Quantum is agnostic to the entities it allows to connect.

While we anticipate Nova created instances will be a heavy user of quantum, any entity can make use of any quantum created network so long as it provides an appropriate interfaces for exposing VIFs to Quantum itself.

Virtual Interfaces(VIF) in the logical model are analogous to physical network interface cards (NIC). VIFs are typycally owned a managed by an external service; for instance when Quantum is used for building Openstack networks, VIFs would be created, owned, and managed in Nova.

VIFs are connected to Quantum networks via logical ports. A logical port is analogous to a port on a network switch, and it has an administrative state and an operational state. Quantum API allows for controlling the administrative state of the port, which can be either 'DOWN' or 'ACTIVE'.

When a VIF is attached to a logical port the Quantum API creates an attachment object, which specifies the fact that a VIF with a given identifier is plugged into the logical port. The plugin is responsible for creating the attachment object, as well as performing all required operations on physical and virtual appliances.

VIFs attached to ACTIVE ports are required to have access to the L2 broadcast domain defined by the network where they are attached. Each VIF shall be capable of exchanging traffic with all other entities attached through ACTIVE ports.

Concepts

Network

Each tenant can define one or more networks. A network is a virtual isolated layer-2 broadcast domain reserved to the tenant. A tenant can create several logical ports for a network, and plug virtual interfaces into these ports.

Port

A logical port represents a virtual switch port on an ideal network switch where all the interfaces attached to a given network are connected. A port has an administrative state which is either 'DOWN' or 'ACTIVE'. Ports which are administratively down will not be able to receive/send traffic.

Attachment

An attachment resources represents the act of plugging an interface into a logical port. Each logical port has one optional attachment; the attachment is required to express the identifier of the network interface plugged in it. Netowrk interfaces are tipycally defined outside of Quantum.

Operation List

List of error response codes:

Some operations accept input parameters into the request body. See the complete operation list for information concerning the format of the request body.

Quantum API is able to parse request and generate responses both in JSON and XML. The format is chosen according to the following criteria:

1. Suffix on request URI
   .json for JSON format, .xml for XML format

2. Content-Type request header
   "application/json" for JSON format, "application/xml" for XML format

3. Accept-* request headers
   "application/json" for JSON format, "application/xml" for XML format

---

List networks

---

Request Body:

This operation does not require a request body.

Description:

This operation returns the list of all networks currently defined in Quantum; returned list includes at least the network’s unique identifier.

Sample Request/Response:

XML

Request:

GET /tenants/XYZ/networks.xml

Response:

<networks>
    <network id="8bec1293-16bd-4568-ba75-1f58bec0b4c3"/>
    <network id="2a39409c-7146-4501-8429-3579e03e9b56"/>
</networks>

JSON

Request:

GET /tenants/XYZ/networks.json

Response:

{
    "networks":
         [
          {"id": "8bec1293-16bd-4568-ba75-1f58bec0b4c3"},
          {"id": "2a39409c-7146-4501-8429-3579e03e9b56"}
         ]
}

Response Codes:

Normal Response code: 200

Error response code(s): #470-ServiceUnavailable, #401-Unauthorized

---

List networks (detail)

---

Request Body:

This operation does not require a request body.

Description:

This operation returns the list of all networks currently defined in Quantum; for each network, its identifier and name are returned.

Sample Request/Response:

XML

Request:

GET /tenants/XYZ/networks/detail.xml

Response:

<networks>
    <network id="8bec1293-16bd-4568-ba75-1f58bec0b4c3"
             name="network_1"/>
    <network id="2a39409c-7146-4501-8429-3579e03e9b56"
             name="network_2/>
"/>
</networks>

JSON

Request:

GET /tenants/XYZ/networks/detail.json

Response:

{
    "networks":
         [
          {
           "id": "8bec1293-16bd-4568-ba75-1f58bec0b4c3",
           "name": "network_1"
          },
          {
           "id": "2a39409c-7146-4501-8429-3579e03e9b56",
           "name": "network_2"
          }
         ]
}

Response Codes:

Normal Response code: 200

Error response code(s): #470-ServiceUnavailable, #401-Unauthorized

---

Show network

---

Request Body:

This operation does not require a request body.

Description:

This operation return the identifier and the name for a specific network configured in Quantum.' Details about ports configured for the network and resources attached to can be retrieved using the detail action for this operation:  GET /tenants/{tenant-id}/networks/{network-id}/detail 

Sample Request/Response:

XML

Request:

GET /tenants/XYZ/networks/8bec1293-16bd-4568-ba75-1f58bec0b4c3.xml

Response:

    <network
           id="8bec1293-16bd-4568-ba75-1f58bec0b4c3"
           name="test_network"/>

JSON

Request:

GET /tenants/XYZ/networks/8bec1293-16bd-4568-ba75-1f58bec0b4c3.json

Response:

{
   "network":
       {
           "id": "8bec1293-16bd-4568-ba75-1f58bec0b4c3",
           "name": "test_network"
       }
}

Response Codes:

Normal Response code: 200

Error response code(s): #470-ServiceUnavailable, #401-Unauthorized, #420-NetworkNotFound

---

Show network (details)

---

Request Body:

This operation does not require a request body.

Description:

This operation returns detailed information concerning the network specified in the request URI. Returned data include the full list of ports configured for the network and attachments plugged into such ports.

Sample Request/Response:

XML

Request:

GET /tenants/XYZ/networks/8bec1293-16bd-4568-ba75-1f58bec0b4c3/detail.xml

Response:

    <network
           id="8bec1293-16bd-4568-ba75-1f58bec0b4c3"
           name="test_network">
        <ports>
            <port id="98017ddc-efc8-4c25-a915-774b2a633855" status="DOWN"/>
            <port id="b832be00-6553-4f69-af33-acd554e36d08" status="ACTIVE">
                <attachment id="test_interface_identifier" status="READY"/>
            </port>
        </ports>
    </network>

JSON

Request:

GET /tenants/XYZ/networks/8bec1293-16bd-4568-ba75-1f58bec0b4c3/detail.json

Response:

{
   "network":
       {
           "id": "8bec1293-16bd-4568-ba75-1f58bec0b4c3",
           "name": "test_network"
           "ports":
               [
                {
                    "id": "98017ddc-efc8-4c25-a915-774b2a633855",
                    "state": "DOWN"
                },
                {
                    "id": b832be00-6553-4f69-af33-acd554e36d08",
                    "state": "ACTIVE",
                    "attachment":
                        {
                            "id": "test_interface_identifier"
                        }
                }
               ]
       }
}

Response Codes:

Normal Response code: 200

Error response code(s): #470-ServiceUnavailable, #401-Unauthorized, #420-NetworkNotFound

---

Create Network

---

Request Body:

The body for this request should contain a Network object includind a symbolic name for the network. Note that network names must be unique for each tenant. The unique identifier for the Network will be returned with the response.

Description:

This operation asynchronously creates a Layer-2 network in Quantum based on the information provided in the request body.

Quantum validates the request, and dispatches it to the plugin, and then returns the unique identifier of the network to the caller, who can check the progress of the operation performing a GET on networks/id.

Resources for the new network can be either provided at create time or when virtual interfaces are plugged into this network depending on the particular plugin implementation.

If the validation phase fails, the network object is not created at all, and a 400 error is returned to the caller.

Sample Request/Response:

XML

Request:

POST /tenants/XYZ/networks.xml

<network name="test_create_network"/>

Response:

<network id="158233b0-ca9a-40b4-8614-54a4a99d47d1"/>

JSON

Request:

POST tenants/XYZ/networks.json

{
   "network":
       {
            "name": "test_create_network"
       }
}

Response:

{
   "network":
       {
           "id": "158233b0-ca9a-40b4-8614-54a4a99d47d1",
       }
}

Response Codes:

Normal Response code: 202

Error response code(s): #470-ServiceUnavailable,#401-Unauthorized,#400-BadRequest,#422-NetworkAlreadyExists,

---

Update Network

---

Request Body:

The request body for this operation must contain the new symbolic name for the network. Note that network names must be unique for each tenant.

Description: This operation asynchronously updates a network in Quantum according to the information provided in the request body.

Sample Request/Response:

XML

Request:

PUT /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1.xml

<network name="new_network_name"/>

Response:

No data returned in response body

JSON

Request:

PUT /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1.json

{
   "network":
       {
            "name": "new_network_name"
       }
}

Response:

No data returned in response body

Response Codes:

Normal Response code: 204

Error response code(s): #470-ServiceUnavailable,#401-Unauthorized,#400-BadRequest,#420-NetworkNotFound,#422-NetworkNameExists,

---

Delete Network

---

Request Body:

This operation does not require a request body.

Description:

This operation removes the network specified in the URI. This request will fail as long as there is at least one "active" port on the network. Logical ports will be destroyed together with the network.

The operation is asynchronous. Quantum forwards the request to the plugin, which will then destroy the network. Callers can check the current status of the operation by performing a GET on networks/id. The operation has complete when a #420-NetworkNotFound is returned.

This operation is not recoverable.

Sample Request/Response:

XML

Request:

DELETE /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1.xml

Response:

No data returned in response body

JSON

Request:

DELETE /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1.json

Response:

No data returned in response body

Response Codes:

Normal Response code: 204

Error response code(s): #470-Service Unavailable,#401-Unauthorized,#420-NetworkNotFound,#421-NetworkInUse,

---

List logical ports for network

---

Request Body:

This operation does not require a request body.

Description:

This operation lists all the ports currently configured for a network. Response for each port includes at least its unique identifier. If no logical ports have been created on the network an empty list will be returned.

Sample Request/Response:

XML

Request:

GET /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports.xml

Response:

<ports>
    <port id="98017ddc-efc8-4c25-a915-774b2a633855"/>
    <port id="b832be00-6553-4f69-af33-acd554e36d08"/>
</ports>

JSON

Request:

GET /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports.json

Response:

{
    "ports":
        [
           {"id": "98017ddc-efc8-4c25-a915-774b2a633855"},
           {"id": "b832be00-6553-4f69-af33-acd554e36d08"}
        ]
}

Response Codes:

Normal Response code: 200

Error response code(s): #470-ServiceUnavailable,#401-Unauthorized,#420-NetworkNotFound

---

List logical ports (detail)

---

Request Body:

This operation does not require a request body.

Description:

This operation lists detailed information for all the ports currently configured for a network. Response for each port includes its identifier and the current administrative state. If no logical ports have been created on the network an empty list will be returned.

Sample Request/Response:

XML

Request:

GET /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/detail.xml

Response:

<ports>
    <port id="98017ddc-efc8-4c25-a915-774b2a633855"
          state="ACTIVE"/>
    <port id="b832be00-6553-4f69-af33-acd554e36d08"
          state="ACTIVE"/>
</ports>

JSON

Request:

GET /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/detail.json

Response:

{
    "ports":
        [
           {"id": "98017ddc-efc8-4c25-a915-774b2a633855"},
           {"id": "b832be00-6553-4f69-af33-acd554e36d08"}
        ]
}

Response Codes:

Normal Response code: 200

Error response code(s): #470-ServiceUnavailable,#401-Unauthorized,#420-NetworkNotFound

---

Show port

---

Request Body:

This operation does not require a request body.

Description:

This operation provides the identifier and the current state for specific port configured for a given network.

Sample Request/Response:

XML

Request:

GET /tenants/33/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/98017ddc-efc8-4c25-a915-774b2a633855.xml

Response:

<port
    id="98017ddc-efc8-4c25-a915-774b2a633855"
    state="DOWN"/>

JSON

Request:

GET /tenants/33/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/98017ddc-efc8-4c25-a915-774b2a633855.json

Response:

{
    "port":
        {
            "state": "DOWN",
            "id": "98017ddc-efc8-4c25-a915-774b2a633855"
        }
}

Response Codes:

Normal Response code: 200

Error response code(s): #470-ServiceUnavailable,#401-Unauthorized,#420-NetworkNotFound,#423-NetworkNotReady,#430-PortNotFound

---

Show port (Detail)

---

Request Body:

This operation does not require a request body.

Description:

This operation provides at least the identifier and the current state for specific port configured for a given network. If an attachment is plugged into the port, this operation will return the identifier of the attachment as well.

Sample Request/Response:

XML

Request:

GET /tenants/33/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/98017ddc-efc8-4c25-a915-774b2a633855/detail.xml

Response:

<port
    id="98017ddc-efc8-4c25-a915-774b2a633855"
    state="DOWN">
    <attachment id="test_interface_id"/>
</port>

JSON

Request:

GET /tenants/33/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/98017ddc-efc8-4c25-a915-774b2a633855/detail.json

Response:

{
    "port":
        {
            "state": "DOWN",
            "id": "98017ddc-efc8-4c25-a915-774b2a633855"
            "attachment":
                {
                    "id": "test_interface_id"
                }
        }
}

Response Codes:

Normal Response code: 200

Error response code(s): #470-ServiceUnavailable,#401-Unauthorized,#420-NetworkNotFound,#423-NetworkNotReady,#430-PortNotFound

---

Create Port

---

Request Body:

The request body is not mandatory, but can optionally contain the state of the newly created port, which can be either 'DOWN' or 'ACTIVE'.

Description:

This operation asynchronously creates a port on a Quantum network based on the information provided in the request body. Quantum validates the request, and dispatches the request to the plugin, which creates the logical port and attaches it to the appropriate network. Resources for the new port can be either provided at create time or when virtual interfaces are plugged into this port depending on the particular plugin implementation. Also, this operation could not be implemented for some plugins as the number of ports available might be fixed when the network is created. If the validation phase fails, the port object is not created at all, and a #400-BadRequest error is returned to the caller. The operation returns a port with an identifier, and state set to DOWN.

Sample Request/Response:

XML

Request:

POST /tenants/33/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports.xml

<port state="ACTIVE"/>

Response:

<port id="98017ddc-efc8-4c25-a915-774b2a633855"/>

JSON

Request:

POST /tenants/33/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports.json

{
"port":
    { "state": "ACTIVE" }
}

Response:

{
    "port":
        {
            "id": "98017ddc-efc8-4c25-a915-774b2a633855"
        }
}

Response Codes:

Normal Response code: 202

Error response code(s): #470-ServiceUnavailable,#401-Unauthorized,#400-BadRequest,#420-NetworkNotFound,#431-RequestedStateInvalid

---

Delete Port

---

Request Body: This operation does not require a request body.

Description:

This operation removes a logical port from a Quantum network. This operation might not be available for plugins in which the number of ports is fixed at network creation; in this case ports should not be deleted, just as they cannot be created.

The operation is not recoverable and will fail if an attachment is plugged into the port.

Sample Request/Response:

XML

Request:

DELETE tenants/33/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/98017ddc-efc8-4c25-a915-774b2a633855.xml

Response:

No data returned in response body

JSON

Request:

DELETE tenants/33/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/98017ddc-efc8-4c25-a915-774b2a633855.json

Response:

No data returned in response body

Response Codes:

Normal Response code: 204

Error response code(s): #470-ServiceUnavailable,#401-Unauthorized,#420-NetworkNotFound,#430-PortNotFound,#432-PortInUse

---

Set Port State

---

Request Body: The operation's request body contains the new administrative state for the logical port. Valid values are 'DOWN' and 'ACTIVE'

Description:

This operation attempts to set the state of the logical port. Currently Quantum recognizes two port states: DOWN and ACTIVE. In the DOWN state a port will not provide connectivity to the network.This feature allows the tenant the ability to take entities offline without affecting their logical topology.

The operation will return #431-RequestedStateInvalid if the specified administrative state is not either DOWN or ACTIVE.

Sample Request/Response:

XML

Request:

PUT tenants/33/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/98017ddc-efc8-4c25-a915-774b2a633855.xml

<port state="ACTIVE"/>

Response:

No data returned in response body

JSON

Request:

PUT tenants/33/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/98017ddc-efc8-4c25-a915-774b2a633855.json

{
"port":
    { "state": "ACTIVE" }
}

Response:

No data returned in response body

Response Codes:

Normal Response code: 204

Error response code(s): #470-ServiceUnavailable,#400-BadRequest,#401-Unauthorized,#420-NetworkNotFound,#430-PortNotFound,#431-RequestedStateInvalid

---

Retrieve attachment for port

---

Request Body:

This operation does not require a request body.

Description:

This operation returns configuration details for the attachment plugged into the port specified in the request URI.

This information is a reference to a virtual interface identifier, which could be either:

• A reference to a resource managed by Quantum;

• A reference to an external resource not managed by Quantum (for instance a network interface defined in nova);

If no attachment is currently plugged into the logical port, the operation does not return any attachment identifier in the response. The response will contain an empty 'attachment' element.

Sample Request/Response:

XML

Request:

GET /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/b832be00-6553-4f69-af33-acd554e36d08/attachment.xml

Response:

<attachment id="test_interface_identifier"/>

JSON

Request:

GET /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/b832be00-6553-4f69-af33-acd554e36d08/attachment.json

Response:

{
 "attachment":
     {
         "id": "test_interface_identifier"
     }
}

Response Codes:

Normal Response code: 200

Error response code(s): #470-ServiceUnavailable,#400-MalformedRequest,#401-Unauthorized,#420-NetworkNotFound,#430-PortNotFound

---

Attach resource to port

---

Request Body:

The request body for this network should contain a reference to the resource to plug into the logical port. Plugged resources can either be managed by or external to Quantum. In both cases, the request body will contain an identifier for that resource.

Description:

This operation asynchronously plugs a resource, or attachment, into the logical port specified in the request URL. A resource is typycally a virtual network interface belonging to a VM instance. Different kinds of resources can be defined in the future.

The request will be first validated by Quantum and then dispatched to the plugin. As the request is asynchronous, control is immediately returned to the caller.

The validation can fail if:

• The attachment is already plugged somewhere else;

• There is already another attachment plugged into the specified logical port.

• The port in which the attachment is going to be plugged is administratively down (state = DOWN)

If the validation phase fails, the attachment object is not created at all, and an error is returned to the caller.

Sample Request/Response:

XML

Request:

PUT /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/b832be00-6553-4f69-af33-acd554e36d08/attachment.xml

<attachment id="test_interface_identifier"/>

Response:

No data returned in response body

JSON

Request:

PUT /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/b832be00-6553-4f69-af33-acd554e36d08/attachment.json

{
 "attachment":
     {
         "id": "test_interface_identifier"
     }
}

Response:

No data returned in response body

Response Codes:

Normal Response code: 204

Error response code(s): #470-ServiceUnavailable, #400-BadRequest, #401-Unauthorized,#420-NetworkNotFound,#430-PortNotFound,#432-PortInUse,#433-PortIsDown,#440-AlreadyAttached, #441-AttachmentNotReady

---

Remove attachment from port

---

Request Body:

This operation does not require a request body.

Description:

This operation asynchronously removes an attachment from a logical port. This operation cannot be undone.

Sample Request/Response:

XML

Request:

DELETE /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/b832be00-6553-4f69-af33-acd554e36d08/attachment.xml

Response:

No data returned in response body

JSON

Request:

DELETE /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/b832be00-6553-4f69-af33-acd554e36d08/attachment.json

Response:

No data returned in response body

Response Codes:

Normal Response code: 204

Error response code(s): #470-ServiceUnavailable,#401-Unauthorized,#420-NetworkNotFound,#430-PortNotFound, #433-PortIsDown, #441-AttachmentNotReady