Jump to: navigation, search

Neutron/APIv2-specification

< Neutron
Revision as of 04:21, 14 August 2012 by AkihiroMotoki (talk)

Quantum v2 API

<<TableOfContents()>>

Overview

Quantum is a project to provide virtual networking services between devices managed by the OpenStack compute service. This document presents and discusses version 2.0 of the Quantum API. For more information on the Quantum project, and additional documentation, please visit http://wiki.openstack.org/Quantum, and docs.openstack.org. We welcome feedback, comments, and bug reports at https://bugs.launchpad.net/quantum.

The v2.0 API represents a combination of the Quantum v1.1 API with some of the most essential IPAM capabilities from the Melange API . These IPAM capabilities focus on being able to associate IP address blocks and other network configuration required by a network device (e.g., default gateway, dns-servers) with a Quantum Network, and then being able to allocate an IP address out of such a block and associate it with a device that is attached to the network via a Quantum Port.

The v2.0 API does this by introducing a new entity, called a Subnet. Subnets can represent either a v4 or v6 address block, and each Quantum Network commonly has one or more subnets. When a port is created on the network, by default it will be allocated an available fixed IP address out of one the designated subnets for each IP version. When the Port is destroyed, the allocated addresses return to the pool of available IPs on the subnet. Users of the Quantum API can either choose a specific IP address from the block, or let Quantum choose the first available IP address.

Please note that version 1.x of the Quantum API has been removed from the source code tree. In order to use v1.x API, an earlier release of Quantum should be installed.

High-level flow

  • Tenant creates a network (e.g., "net1")
  • Tenant associates a subnet with that network (e.g., "10.0.0.0/24")
  • Tenant boots a VM, specifying a single NIC connected to "net1" (e.g.: nova boot --image <image_name> --nic net-id=<id_of_net1> <server_name>)
  • Nova contacts Quantum and creates a port1 on net1.
  • Quantum assigns an Ip to port1 is assigned IP. (The IP is chosen by Quantum)
  • Tenant destroys VM.
  • Nova contacts Quantum and destroys port1. Allocated IP is returned to the pool of available IP address.

The Plugin

While the Quantum API represents the interface of the virtual network service to users and other services, these network services are implemented by a component called "Plugin". Plugin may adopt different techniques and technologies for providing isolated virtual networks to tenant, as well as providing other services such as IP address management. User should not be concerned about the particular plugin employed as far as the API discussed in this document is concerned, as every plugin will implement all the operations included in the Quantum v2 API.

However, some plugins might expose additional capabilities through API extensions, discussed later in this document. For more information about the extensions exposed by a particular plugin, please refer to the plugin documentation.

Concepts

The Quantum v2 API manages three kind of entities:

  • Network, representing isolated virtual Layer-2 domains; a network can als regarded as a virtual (or logical) switch;
  • Subnet, representing IPv4 or IPv6 address blocks from which IPs to be assigned to VMs on a given network are selected.
  • Port, representing virtual (or logical) switch ports on a given network.

All entities, discussed in detail in the rest of this chapter, support the basic CRUD operations with POST/GET/PUT/DELETE verbs, and have an auto-generated unique identifier.

Network

A network is a virtual isolated layer-2 broadcast domain which is typically reserved to the tenant who created it, unless the network has been explicitly configured to be shared. Tenants can create multiple networks, until they reach the thresholds specified by per-tenant Quotas (see next chapter for more details). The network is the principal entity for the Quantum API. Ports and subnets must always be associated with a network. The following table describes the attributes of network objects. For each attribute, the CRUD column should be read as follows:

  • C - the attribute can be used in create operations;
  • R - the attribute is returned in the response for show or list operations;
  • U - the value of attribute can be updated;
  • D - the value of the attribute can be removed;
Attribute Type Required CRUD Default Value Validation Constraints
id uuid-str N/A R generated N/A
name String No CRU None N/A
admin_state_up Bool No CRU True False }
status String N/A R N/A N/A
subnets list(uuid-str) No R Empty List N/A
permissions octal(3) No CR** rw- --- --- 3-octal digit string or permission string in the rwxrwxrwx form***
tenant_id uuid-str No* CR N/A UUID_PATTERN

Subnet

A subnet represent an IP address block that can be used for assigning IP address to virtual instances. Each subnet must have a CIDR and must be associated with a network. IPs can be either selected from the whole subnet CIDR, or from "allocation pools" that can be specified by the user.

A subnet can also optionally have a gateway, a list of dns name servers, and host routes. All this information will then be pushed to instances whose interfaces are associated with the subnet.

attribute Type Required CRUD Default Validation Constraints
id uuid-str N/A R generated N/A
network_id uuid-str Yes CR N/A
ip_version int Yes CR 4 6 }
cidr string Yes CR N/A valid cidr in the form <network_address>/<prefix>
gateway_ip string or null No CRUD first address in cidr Valid IP address or null
dns_nameservers list(str) No CRU None No constraint
allocation_pools list(dict) No CR Every address in cidr, excluding gateway_ip if configured star/end of range must be valid ip
host_routes list(dict) No CRU default route to gateway_ip TBD
tenant_id uuid-str No* CR N/A UUID_PATTERN

Port

A port represents a virtual switch port on a logical network switch. Virtual instances attach their interfaces into ports. The logical port also defines the MAC address and the IP address(es) to be assigned to the interfaces plugged into them. When IP addresses are associated to a port, this also implies the port is associated with a subnet, as the IP address was taken from the allocation pool for a specific subnet.

Attribute Type Required CRU Default Validation Constraints
id uuid-str N/A R generated N/A
network_id uuid-str Yes CR N/A existing network identifier
admin_state_up bool No CRU True False }
status string N/A R N/A N/A
mac_address string No CR generated valid MAC in 6-octet form separated by colons
fixed_ips list(dict) No CRU automatically allocated from pool Valid IP address and existing subnet identifier
host_routes list(dict) No CR Empty list TBD
device_id str No CRUD None No constraint
tenant_id uuid-str No* CR N/A UUID_PATTERN
  • The tenant_id attribute is mandatory if Quantum is not running with the Keystone Identity service
  • * The Quantum API currently ignores group permissions, and executable bits. Write access to world, even if granted by the user, is currently ignored by the Quantum API. The full permission mask has been provided for compatibility with future implementations.
  • ** Quantum API also allows the symbolic string private and public for the permissions string. Private corresponds to 0600 or rw- --- ---, whereas Public corresponds to 0644 or rw-r--r--.

General API information

Authentication and authorization

Quantum uses the Keystone identity service (openstack.keystone.org) as the default authentication service. When keystone is enabled Users submitting requests to the Quantum service must provide an authentication token in X-Auth-Token request header. The aforementioned token should have been obtained by authenticating with the keystone endpoint. For more information concerning authentication with Keystone, please refer to the Keystone documentation. When keystone is enabled, it is not mandatory to specify tenant_id for resources in create requests, as the tenant identifier will be derived from the Authentication token. Please note that the default authorization settings only allow administrative users to create resources on behalf of a different tenant.

Quantum uses information received from Keystone to authorize user requests. Quantum handles two kind of authorization policies:

  • Operation-based: policy specify access criteria for specific operations, possibly with fine-grained control over specific attributes;
  • Resource-based: where access to specific resource might be granted or not according to the permissions configured for the resource (currently available only for the network resource)

The actual authorization policies enforced in Quantum might vary from deployment to deployment.

Request and Response types

TBD Once we sort out XML support for Quantum.

Filtering and Column Selection

The Quantum API supports filtering based on all top level attributes of a resource. Filters are applicable to all list requests. For instance: 


GET /v2.0/networks?name=foobar


will return all the networks whose name is foobar. When multiple filters are specified, the Quantum API will return only objects that satisfy all the filters, this applying an AND condition among filters. Quantum does not offer a mechanisms for ORing filters. To this aim, the user can submit a distinct request for each filters, and then build a set on the client-side from received responses.

By default, Quantum returns all attributes for any Show or List call. The Quantum API has a mechanism to limit the set of attributes returned (e.g., return just 'id'). Attributes returned from the Quantum API can be controller using the fields query parameter. For example the following request: 


GET /v2.0/networks.json?fields=id&fields=name


will return only id and name for each network.

Synchronous vs Asynchronous Plugin Behavior

The Quantum API presents a logical model of network connectivity consisting of networks, ports, and subnets. It is up to the Quantum plugin to communicate with the underlying infrastructure to ensure packet forwarding is consistent with the logical model. A plugin might perform these operations asynchronously. This means that when an API client modifies the logical model using an HTTP POST, PUT, or DELETE, the API call may return prior to the plugin performing any modifications to underlying virtual and/or physical switching devices. The only guarantee an API client has is that all subsequent API calls will properly reflect the changed logical model. As a concrete example, consider the case where a client uses an HTTP PUT to set the attachment for a port. There is no guarantee that packets sent by the interface named in the attachment will be forwarded immediately once the HTTP call returns. However, there is a guarantee that a subsequent HTTP GET to view the attachment on that port would return the new attachment value. The "status" attribute, available for network and port resources might be used to understand whether the Quantum plugin has successfully completed the configuration of the interested resource.

Bulk Create Operations

The Quantum API allow for creating several objects of the same type in the same API request. Bulk create operations use exactly the same API as singleton create operations, with the only difference being that a list of objects, rather than a single object, is specified in the request body.

Bulk operations are always performed atomically, meaning that either all or none of the objects in the request body are created. Should the particular plugin does not support atomic operations, Quantum API will emulate the atomic behavior, thus ensuring users might expect the same behavior regardless of the particular plugin running in the backend.

Quantum might be deployed without support for bulk operations. In that case a 400 Bad Request error will be returned when the client attempts a bulk create operation.

For more details concerning how to submit bulk requests to the Quantum API, please refer to create operations discussed in the next chapter.

Quotas

[tbd] Yong to contribute

Notifications

[tbd] Yong to contribute

Extensions

The Quantum API is extensible. Extensions serve several purposes:

  • They allow the introduction of new features in the API without requiring a version change;
  • They allow the introduction of vendor specific niche functionality
  • They act as a proving ground for experimental functionalities which might be included in a future version of the API.

Applications can programmatically determine what extensions are available by performing a GET on the v2.0/extensions URI. Extensions may also be queried individually by their unique alias by performing a GET on the /v2.0/extensions/alias_name. This provides the simplest method of checking if an extension is available as an unavailable extension will issue an itemNotFound (404) response. Existing core API resources can be extended with new actions or extra attributes. Also, new resources can also be added as extensions. Extensions usually have tags that prevent clash with other extensions defining attributes and/or resources with the same name, and with core resources and attributes. As an extension might not be supported by all plugin, availability of an extension will vary with deployments and the specific plugin in use.

Faults

If a failure occurs while processing a request, the Quantum API returns an error response. Quantum uses only standard HTTP error codes. 4xx errors are indicative of problems in the particular request being sent from the client.

Error
400 Bad Request
404 Not Found
409 Conflict
422 Uprocessable Entity
500 Internal server error
503 ServiceUnavailable

Users submitting requests to the Quantum API might also receive the following errors:

  • 401 Unauthorized - if invalid credentials are provided
  • 403 Forbidden - If the user cannot access a specific resource or perform the requested operation.

API Operations

List Networks

Verb URI
GET /networks

Normal Response Code: 200

Error Response Codes: Unauthorized (401), Bad Request (400)

JSON Request and Response sample:

Request 

GET /v2.0/networks

Accept: application/json


Response 

{
  "networks": [
  {
    "status": "ACTIVE",
    "subnets": [], 
    "name": "network_1",
    "admin_state_up": true,
    "tenant_id": "c1210485b2424d48804aad5d39c61b8f", 
    "id": "3a06dfc7-d239-4aad-9a57-21cd171c72e5",
    "permissions": "rw-------"
  }, 
  {
    "status": "ACTIVE",
    "subnets": [],
    "name": "network-2",
    "admin_state_up": true,
    "tenant_id": "c1210485b2424d48804aad5d39c61b8f",
    "id": "7db8c5a4-6eb0-478d-856b-7cfda2b25e13",
    "permissions": "rw-------"
  }, 
  {
    "status": "ACTIVE",
    "subnets": ["e12f0c45-46e3-446a-b207-9474b27687a6"],
    "name": "network_3",
    "admin_state_up": true,
    "tenant_id": "ed680f49ff714162ab3612d7876ffce5",
    "id": "afc75773-640e-403c-9fff-62ba98db1f19",
    "permissions": "rw-r--r--"
   }
 ]
}

This operation does not require a request body, unless the Quantum server is running without Keystone integration.

Show Network

Verb URI
GET /networks/<network_id>

Normal Response Code: 200

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

JSON Request and Response sample:

Request: 

GET /v2.0/networks/afc75773-640e-403c-9fff-62ba98db1f19

Accept: application/json


Response: 

{
  "network":
  {
    "status": "ACTIVE",
    "subnets": ["e12f0c45-46e3-446a-b207-9474b27687a6"],
    "name": "network_3",
    "admin_state_up": true,
    "tenant_id": "ed680f49ff714162ab3612d7876ffce5", 
    "id": "afc75773-640e-403c-9fff-62ba98db1f19"
  }
}


Create Network

Verb URI
POST /networks

Normal Response Code: 200

Error Response Codes: Unauthorized (401), Bad Request (400)

JSON Request and Response sample:

Request: 

POST v2.0/networks.json 

Content-Type: application/json
Accept: application/json

{
 "network":
  {
    "name": "sample_network", 
    "admin_state_up": false
  }
}


Response: 

'status': '201'
'content-length': '194'
'content-type': 'application/json;

{
  "network": 
    {
      "status": "ACTIVE",
      "subnets": [], 
      "name": "sample_network", 
      "admin_state_up": false, 
      "tenant_id": "c1210485b2424d48804aad5d39c61b8f", 
       "id": "fc68ea2c-b60b-4b4f-bd82-94ec81110766"
     }
}


Bulk version

This operation allows for creating several networks with a single request. To this aim, a list of networks must be supplied in the request body, as follows:

JSON Request and Response sample:

Request: 

POST v2.0/networks.json 

Content-Type: application/json
Accept: application/json

{
"networks": [
   {
     "name": "sample_network_1", 
     "admin_state_up": false
   },
   {
     "name": "sample_network_2", 
     "admin_state_up": false
   }]
}


The behavior of the bulk create operation is always atomic: either all networks in the request body are created, or none of them is created.

Note about 'public' networks (permissions 0644)

The permissions attribute can be used to create a 'public' network, i.e.: a network which is share with all other tenants. This attribute allows for specifying filesystem-like permissions on Quantum resources. However, the Quantum API currently only supports the option to create networks shared with every other tenant. To this aim the permissions attribute should be set to 0644 or rw- r-- r--.

Moreover, control of the permissions attribute could reserved to particular users only, such as administrators. In this case, regular users trying to create a network with permission setting different from the default value will receive a 403 - Forbidden error.

Update Network

Verb URI
PUT /networks/<network-id>

The update network operation allow users for updating some attributes of a network object, such as name and admin_state_up. Attributes such as tenant_id cannot be updated. If an attempt is made to update such attributes a 422 'Unprocesable Entity' error will be returned.

Note: Update operations in Quantum adopt patch semantics. This implies that the Quantum API does not require the user to send the whole resource to be updated, but just the attributes that the user wishes to update, as reported in the example below.

Normal Response Code: 200 Ok

Error Response Codes: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 422 Unprocessable Entity

JSON Request and Response sample:

Request: 

PUT /v2.0/networks/fc68ea2c-b60b-4b4f-bd82-94ec81110766.json 

Content-Type: application/json
Accept: application/json

{
  "network": 
    {
      "name": "updated_name"
    }
}


Response: 

status: 200
content-length: 192
content-type: application/json

{
  "network": 
    {"status": "ACTIVE",
     "subnets": [],
     "name": "updated_name", 
     "admin_state_up": false,
      "tenant_id": "c1210485b2424d48804aad5d39c61b8f", 
      "id": "fc68ea2c-b60b-4b4f-bd82-94ec81110766"}}


Delete Network

Verb URI
DELETE /networks/<network_id>

JSON Request and Response sample:

This operation will remove a Quantum network, and all its associated subnets, provided that no port is currently configured on the network.\\ If ports are still configured on the network being removed, a 409 error will be returned.

Normal Response Code: 204

Error Response Codes: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 409 Network in Use.

Request: 

DELETE /v2.0/networks/fc68ea2c-b60b-4b4f-bd82-94ec81110766

Content-Type: application/json
Accept: application/json


Response: 

status: 204


List Subnets

Verb URI
GET /subnets

Normal Response Code: 200 Ok

Error Response Codes: 401 Unauthorized

This operation will return a list of subnets objects the tenant has access to. Default policy settings will return exclusively subnets owned by the tenant submitting the request, unless the request is submitted by an user with administrative rigths. Users can control which attributes should be returned using the fields query parameter as discussed in the previous chapter. Moreover, results can be filtered using query string parameters as discussed in the previous chapter.

This operation does not require a reques body.

JSON Request and Response sample:

Request: 

GET v2.0/subnets.json

Accept: application/json


Response: 

status: 200
content-length: 607
content-type: application/json

{
  "subnets": [
   {
     "name": "",
     "network_id": "ed2e3c10-2e43-4297-9006-2863a2d1abbc",
     "tenant_id": "c1210485b2424d48804aad5d39c61b8f", 
     "allocation_pools": [{"start": "10.10.0.2", "end": "10.10.0.254"}],
     "gateway_ip": "10.10.0.1",
     "ip_version": 4,
     "cidr": "10.10.0.0/24",
     "id": "4156c7a5-e8c4-4aff-a6e1-8f3c7bc83861"
    }, 
    {
      "name": "", 
      "network_id": "afc75773-640e-403c-9fff-62ba98db1f19",
      "tenant_id": "ed680f49ff714162ab3612d7876ffce5",
      "allocation_pools": [{"start": "10.0.0.2", "end": "10.0.0.254"}],
      "gateway_ip": "10.0.0.1", 
      "ip_version": 4,
      "cidr": "10.0.0.0/24",
       "id": "e12f0c45-46e3-446a-b207-9474b27687a6"
     }]
}


Show Subnet

Verb URI
GET /subnets/<subnet-id>

Normal Response Code: 200 Ok

Error Response Codes: 400 Bad Request, 401 Unauthorized, 404 Not Found

This operation returns data about the subnet specified in the request URI. Users can control which attributes should be returned using the fields query parameter as discussed in the previous chapter.

This operation does not require a request body.

JSON Request and Response sample:

Request: 

GET /v2.0/subnets/4156c7a5-e8c4-4aff-a6e1-8f3c7bc83861

Accept: application/json


Response: 

status: 200
content-length: 309
content-type: application/json

{
  "subnet": 
    {
     "name": "",
     "network_id": "ed2e3c10-2e43-4297-9006-2863a2d1abbc",
     "tenant_id": "c1210485b2424d48804aad5d39c61b8f",
     "allocation_pools": [{"start": "10.10.0.2", "end": "10.10.0.254"}],
     "gateway_ip": "10.10.0.1",
     "ip_version": 4,
     "cidr": "10.10.0.0/24", 
     "id": "4156c7a5-e8c4-4aff-a6e1-8f3c7bc83861"
    }
}


Create Subnet

Verb URI
POST /subnets

Normal Response Code: 201 Created

Error Response Codes: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found

This operation creates a new subnet on a specific network. The identifier of the network, network_id is mandatory. The user must also specify the cidr for the subnet, in the form <network_address>/<prefix>. The remaining parameters are optional.

By default, Quantum creates IP v4 subnets. In order to create an IP v6 subnet, users must specify the value 6 for the ip_version attribute in the request body. Please note that Quantum does not make any attempt to derive the correct IP version from the provided CIDR. If the parameter for the gateway address, gateway_ip is not specified, then Quantum will allocate an address from the subnet's cidr for the subnet's gateway. In order to specify a subnet without a gateway, users should specify the value none for the gateway_ip attribute in the request body. If allocation pools (attribute allocation_pools) are not specified, Quantum will automatically allocate pools for covering all IP addresses in the CIDR, excluding the address reserved for the subnet gateway. Otherwise users can explicitly specify allocation pools as shown in the example below.

JSON Request and Response sample:

Request: 

POST /v2.0/subnets
Content-Type: application/json
Accept: application/json

{
  "subnet": {
    "network_id": "ed2e3c10-2e43-4297-9006-2863a2d1abbc",
    "ip_version": 4,
    "cidr": "10.0.3.0/24",
    "allocation_pools": [{"start": "10.0.3.20", "end": "10.0.3.150"}]
  }
}
}}

Response:
{{{
status: 201, 
content-length: 306,
content-type: application/json

{
  "subnet": {
    "name": "",
    "network_id": "ed2e3c10-2e43-4297-9006-2863a2d1abbc",
    "tenant_id": "c1210485b2424d48804aad5d39c61b8f",
    "allocation_pools": [{"start": "10.0.3.20", "end": "10.0.3.150"}],
    "gateway_ip": "10.0.3.1",
    "ip_version": 4,
    "cidr": "10.0.3.0/24",
    "id": "9436e561-47bf-436a-b1f1-fe23a926e031"}
}


Bulk version

This operation allows for creating several subnet with a single request. To this aim, a list of subnets must be supplied in the request body.

Request: 

POST /v2.0/subnets
Content-Type: application/json
Accept: application/json

{
  "subnets": [ 
    {
      "network_id": "ed2e3c10-2e43-4297-9006-2863a2d1abbc",
      "ip_version": 4,
       "cidr": "10.0.4.0/24",
    }
    {
      "network_id": "ed2e3c10-2e43-4297-9006-2863a2d1abbc",
      "ip_version": 4,
       "cidr": "10.0.5.0/24",
    }
   ]
}


The behavior of the operation is always atomic, meaning that either all subnets are created, or none is created.

Update Subnet

Verb URI
PUT /subnets/<subnet-id>

Normal Response Code: 200 Ok

Error Response Codes: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 422 Unprocessable Entity

This operation updates information concerning a subnet. Some attributes, such as IP version (ip_version), CIDR (cidr), and IP allocation pools ('allocation_pools) cannot be updated. Attempting to update these attributes will result in a 422 Unprocessable Entity error.

Note: Update operations in Quantum adopt patch semantics. This implies that the Quantum API does not require the user to send the whole resource to be updated, but just the attributes that the user wishes to update, as reported in the example below

JSON Request and Response sample:

Request: 

PUT /v2.0/subnets/9436e561-47bf-436a-b1f1-fe23a926e031

Content-Type: application/json
Accept: application/json

{
  "subnet": 
    {
      "gateway_ip": "10.0.3.254",
      "name": "new_name"
    }
}


Response: 

status: 200
content-length: 316
content-type: application/json

{
  "subnet":
   {
     "name": "new_name",
     "network_id": "ed2e3c10-2e43-4297-9006-2863a2d1abbc",
     "tenant_id": "c1210485b2424d48804aad5d39c61b8f",
     "allocation_pools": [{"start": "10.0.3.20", "end": "10.0.3.150"}],
     "gateway_ip": "10.0.3.254",
     "ip_version": 4,
     "cidr": "10.0.3.0/24",
     "id": "9436e561-47bf-436a-b1f1-fe23a926e031"
   }
}


Delete Subnet

Verb URI
DELETE /subnets/<subnetid>

This operation remove a subnet from a Quantum network. The operation will fail if IPs from the subnet being removed are still allocated.

Normal Response Code: 204

Error Response Codes: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 409 Conflict

JSON Request and Response sample:

Request: 

DELETE /v2.0/subnets/9436e561-47bf-436a-b1f1-fe23a926e031

Accept: application/json


Response: 

Status: 204


List Ports

Verb URI
GET /ports

Normal Response code: 200

Error Response Code: 401 Unauthorized

This operation will return a list of ports objects the tenant has access to. Default policy settings will return exclusively subnets owned by the tenant submitting the request, unless the request is submitted by an user with administrative rigths. Users can control which attributes should be returned using the fields query parameter as discussed in the previous chapter. Moreover, results can be filtered using query string parameters as discussed in the previous chapter.

This operation does not require a reques body.

JSON Request and Response sample:

Request: 

GET /v2.0/ports.json HTTP/1.1
content-type: application/json
accept: application/json


Response: 

Status: 200
Content-Type: application/json
Content-Length: 805

{
    "ports": [
        {
            "admin_state_up": true,
            "device_id": "257614cc-e178-4c92-9c61-3b28d40eca44",
            "fixed_ips": [
                {
                    "ip_address": "192.168.111.3",
                    "subnet_id": "22b44fc2-4ffb-4de4-b0f9-69d58b37ae27"
                }
            ],
            "id": "24e6637e-c521-45fc-8b8b-d7331aa3c99f",
            "mac_address": "fa:16:3e:0f:3f:b5",
            "name": "",
            "network_id": "6aeaf34a-c482-4bd3-9dc3-7faf36412f12",
            "status": "ACTIVE",
            "tenant_id": "cf1a5775e766426cb1968766d0191908"
        },
        {
            "admin_state_up": true,
            "device_id": "d266f9de-fe2c-4705-93b3-9da71168c93b",
            "fixed_ips": [
                {
                    "ip_address": "192.168.111.2",
                    "subnet_id": "22b44fc2-4ffb-4de4-b0f9-69d58b37ae27"
                }
            ],
            "id": "e54dfd9b-ce6e-47f7-af47-1609cfd1cdb0",
            "mac_address": "fa:16:3e:f5:41:7f",
            "name": "",
            "network_id": "6aeaf34a-c482-4bd3-9dc3-7faf36412f12",
            "status": "ACTIVE",
            "tenant_id": "cf1a5775e766426cb1968766d0191908"
        }
    ]
}


Show Port

Verb URI
GET /ports/port-id

Normal Response code: 200

Error Response Code: 400 Bad Request, 401 Unauthorized, 404 Not Found

This operation will return information regarding the port specified in the request URI.

JSON Request and Response sample:

Request: 

GET /v2.0/ports/ebe69f1e-bc26-4db5-bed0-c0afb4afe3db.json
accept: application/json


Response: 

Status: 200
Content-Type: application/json
Content-Length: 410

{
    "port": {
        "admin_state_up": true,
        "device_id": "d6b4d3a5-c700-476f-b609-1493dd9dadc0",
        "fixed_ips": [
            {
                "ip_address": "192.168.111.4",
                "subnet_id": "22b44fc2-4ffb-4de4-b0f9-69d58b37ae27"
            }
        ],
        "id": "ebe69f1e-bc26-4db5-bed0-c0afb4afe3db",
        "mac_address": "fa:16:3e:a6:50:c1",
        "name": "port1",
        "network_id": "6aeaf34a-c482-4bd3-9dc3-7faf36412f12",
        "status": "ACTIVE",
        "tenant_id": "cf1a5775e766426cb1968766d0191908"
    }
}


Create Port

Verb URI
POST /ports

Normal Response code: 201

Error Response Code: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 409 Conflict

This operation creates a new Quantum port. The network where the port shall be created (network_id parameter) in the request body, must be specified. Optionally, user can also specify the following parameters:

  • A symbolic name for the port
  • MAC address
  • Administrative state (True: Up, False: Down)
  • Fixed IPs
    • Specifying just a subnet id, Quantum allocates the first available IP from that subnet to the port
    • Specifying both a subnet id and an IP address, Quantum will try to allocate the specified address to the port
  • Host routes for the port (in addition to the host routes defined for the subnets the port is associated with)

JSON Request and Response sample:

Request: 

POST /v2.0/ports.json HTTP/1.1
Content-Length: 158
content-type: application/json
accept: application/json

{
    "port": {
        "admin_state_up": true,
        "device_id": "d6b4d3a5-c700-476f-b609-1493dd9dadc0",
        "name": "port1",
        "network_id": "6aeaf34a-c482-4bd3-9dc3-7faf36412f12"
    }
}


Response: 

Status: 201
Content-Type: application/json; charset=UTF-8
Content-Length: 410

{
    "port": {
        "admin_state_up": true,
        "device_id": "d6b4d3a5-c700-476f-b609-1493dd9dadc0",
        "fixed_ips": [
            {
                "ip_address": "192.168.111.4",
                "subnet_id": "22b44fc2-4ffb-4de4-b0f9-69d58b37ae27"
            }
        ],
        "id": "ebe69f1e-bc26-4db5-bed0-c0afb4afe3db",
        "mac_address": "fa:16:3e:a6:50:c1",
        "name": "port1",
        "network_id": "6aeaf34a-c482-4bd3-9dc3-7faf36412f12",
        "status": "ACTIVE",
        "tenant_id": "cf1a5775e766426cb1968766d0191908"
    }
}


Bulk version

This operation allows for creating several ports with a single request. To this aim, a list of ports must be supplied in the request body.

Bulk Request example: 





The Quantum API always guarantees the atomic completion of the bulk operation.



Update Port





  Verb

  URI




  UPDATE

  /ports/<port-id>



Normal Response code: 200

Error Response Code: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 409 Conflict, 422 Unprocessable Entity

This operation can be used for updating information on a port, such as the symbolic name and the associated IPs.
When IPs for a port are updated, the previously associated IPs are removed, returned to the respective subnets allocation pools, and replaced by the IPs specified in the body for the UPDATE request. In other words, the behavior of this operation is to replace the fixed_ip attribute when it is specified in the request body. If the new IP addresses are invalid (e.g.: already in use), the operation fail and the existing IP addresses are not disassociated from the port.

JSON Request and Response sample:

Request:



PUT /v2.0/ports/1d8591f4-7b62-428e-857d-e82a15e5a7f1.json HTTP/1.1
Content-Length: 63
content-type: application/json
accept: application/json

{
    "port": {
        "device_id": "37b4f622-5e17-4dca-bf67-7338c5b7dd63"
    }
}





Response:



Status: 200
Content-Type: application/json;
Content-Length: 410

{
    "port": {
        "admin_state_up": true,
        "device_id": "37b4f622-5e17-4dca-bf67-7338c5b7dd63",
        "fixed_ips": [
            {
                "ip_address": "192.168.111.4",
                "subnet_id": "22b44fc2-4ffb-4de4-b0f9-69d58b37ae27"
            }
        ],
        "id": "1d8591f4-7b62-428e-857d-e82a15e5a7f1",
        "mac_address": "fa:16:3e:70:d2:8c",
        "name": "port2",
        "network_id": "6aeaf34a-c482-4bd3-9dc3-7faf36412f12",
        "status": "ACTIVE",
        "tenant_id": "cf1a5775e766426cb1968766d0191908"
    }
}








Delete Port





  Verb

  URI




  DELETE

  /ports/<port-id>



Normal Response code: 204

Error Response Code: 401 Unauthorized, 403 Forbidden, 404 Not Found

This operation removes a port from a Quantum network. If IP addresses are associated with the port, they are returned to the respective subnets allocation pools.

JSON Request and Response sample:

Request:



DELETE /v2.0/ports/ebe69f1e-bc26-4db5-bed0-c0afb4afe3db.json

accept: application/json





Response:



status: 204







          

                

                
        

        Retrieved from "https://wiki.openstack.org/w/index.php?title=Neutron/APIv2-specification&oldid=11891"