openstack-attic/netconn-api
Code Issues Proposed changes

Remove extra whitespace

Browse Source 
Remove extra whitespace like whitespace at end of line or
before a closing </para>. Also, change tabs to spaces.

Change-Id: I43d5418cc6c21736a29921e88774cdfdadc09b28
This commit is contained in:
Andreas Jaeger 2013-12-26 18:17:41 +01:00
parent 42b5116e5c
commit b51a471b55
57 changed files with 640 additions and 642 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

156
v1.0/neutron-api-guide.xml
View File

@ -60,7 +60,7 @@
<abstract>
<para>This document is intended for software developers interested in developing
applications using the OpenStack Quantum Layer-2 Networking Service
(<abbrev>API</abbrev>). </para>
(<abbrev>API</abbrev>).</para>
</abstract>
<revhistory>
<revision>
@ -82,7 +82,7 @@
<listitem>
<para>Fixed incorrect mention of &PUT;
verb in <xref linkend="Delete_Network"
/>. Verb changed to &DELETE;. </para>
/>. Verb changed to &DELETE;.</para>
</listitem>
<listitem>
<para>Fixed formatting issues in request
@ -95,7 +95,7 @@
<revdescription>
<itemizedlist spacing="compact">
<listitem>
<para>Initial release. </para>
<para>Initial release.</para>
</listitem>
<listitem>
<para>First edition of this document.</para>
@ -114,10 +114,10 @@
home page (<link
xlink:href="http://wiki.openstack.org/Quantum"/>) and
the NetStack home page (<link
xlink:href="http://wiki.openstack.org/Network"/>). </para>
xlink:href="http://wiki.openstack.org/Network"/>).</para>
<para>We welcome feedback, comments, and bug reports at <link
xlink:href="http://bugs.launchpad.net/Quantum"
>bugs.launchpad.net/Quantum</link>. </para>
>bugs.launchpad.net/Quantum</link>.</para>
<section xml:id="Intended_Audience-d1e85">
<title>Intended Audience</title>
<para>This guide is intended to assist software developers
@ -128,7 +128,7 @@
(Nova), and the integration between the two. The user
should also have access to a plugin providing the
implementation for the API described in this document.
Two plugins are included in the Quantum distribution: </para>
Two plugins are included in the Quantum distribution:</para>
<itemizedlist spacing="compact">
<listitem>
<para>Openvswitch - Implementing Quantum API with Open vSwitch</para>
@ -178,7 +178,7 @@
<listitem>
<para>Corrected verb in
delete networks API operation to
DELETE from PUT. </para>
DELETE from PUT.</para>
</listitem>
<listitem>
<para>
@ -221,7 +221,7 @@
software that wants to connect to the
network services provided by Quantum. An
entity can use Quantum network services by
implementing a VIF. </td>
implementing a VIF.</td>
</tr>
<tr>
<!-- <td colspan="1" align="center" bgcolor="#4F91BD"> --> <td colspan="1" align="center">Layer-2 network
@ -230,7 +230,7 @@
virtual Ethernet network managed by the
Quantum service. For the time being,
Quantum will manage only Ethernet
networks. </td>
networks.</td>
</tr>
<tr>
<td align="center">
@ -241,7 +241,7 @@
such as, a collection of virtual ports
sharing network connectivity. In the
Quantum terminology, a network is always a
Layer-2 network. </td>
Layer-2 network.</td>
</tr>
<tr>
<!-- <td align="center" bgcolor="#4F91BD"> --> <td align="center">
@ -250,7 +250,7 @@
<!-- <td colspan="4" bgcolor="#4F91BD"> -->
<td colspan="4">Software component that
provides the actual implementation for
Quantum APIs. </td>
Quantum APIs.</td>
</tr>
<tr>
<td align="center">
@ -258,7 +258,7 @@
</td>
<td colspan="4">A port on the virtual
network switch represented by a Quantum
virtual Layer-2 network. </td>
virtual Layer-2 network.</td>
</tr>
<tr>
<!-- <td align="center" bgcolor="#4F91BD"> -->
@ -276,7 +276,7 @@
<td colspan="4">The association of an
interface identifier to a logical port,
which represents 'plugging' an interface
into a port. </td>
into a port.</td>
</tr>
</tbody>
</informaltable>
@ -285,17 +285,17 @@
<section xml:id="Theory">
<title>Theory of Operation</title>
<para>This section presents the objects and semantics of
Quantum’s logical model. </para><para>Quantum abstracts the physical implementation of the network,
Quantum’s logical model.</para><para>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 project within OpenStack to function
correctly. </para><para>
correctly.</para><para>
Further Quantum is agnostic to the entities it allows to connect.
While we anticipate Nova 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.
</para><para> Virtual Interfaces (VIF) in the logical model are analogous to
</para><para>Virtual Interfaces (VIF) in the logical model are analogous to
physical network interface cards (NICs). VIFs are
typically owned a managed by an external service; for
instance when Quantum is used for building OpenStack
@ -304,7 +304,7 @@
ports. A port is analogous to a port on a network
switch, and it has an administrative state. Quantum
API allows for controlling the administrative state of
the port, which can be either 'DOWN' or 'ACTIVE'. </para><para>
the port, which can be either 'DOWN' or 'ACTIVE'.</para><para>
When a VIF is attached to a port the Quantum API creates
an attachment object, which specifies the fact that a VIF with a
given identifier is plugged into the port.
@ -351,10 +351,10 @@
<section xml:id="Attachment"><title>Attachment</title>
<para>An attachment represents an interface plugged into a
logical port. At any time at most one attachment can
be plugged into a given port. </para><para>An attachment typically identified a virtual network interface.
be plugged into a given port.</para><para>An attachment typically identified a virtual network interface.
Network interfaces are typically defined in an
external services which uses Quantum, for instance the
OpenStack Compute service, Nova. </para>
OpenStack Compute service, Nova.</para>
</section>
</chapter>
<chapter xml:id="General_API_Information-d1e436">
@ -370,24 +370,24 @@
Additionally, providers may offer support for conditional
&GET; requests using ETags, or they may send a redirect in
response to a &GET; request. Clients should be written to
account for these differences. </para>
account for these differences.</para>
<section xml:id="Authentication-d1e444">
<title>Authentication</title>
<para>The current version of the OpenStack Quantum service
does not require that each request will include the
credentials of the user submitting the request. </para><para>However, Quantum deployments can support several authentication
credentials of the user submitting the request.</para><para>However, Quantum deployments can support several authentication
schemes (OAuth, Basic Auth, Token). The authentication
scheme used is determined by the provider of the
Quantum service. Please contact your provider to
determine the best way to authenticate against this
API. </para><para>
API.</para><para>
Ideally, middleware modules for Authentication and/or Authorization
should be inserted in the first stages of the Quantum pipeline
(available in <code>etc/quantum.conf</code>).
</para>
<note>
<para>Some authentication schemes may require that the
API operate using SSL over HTTP (HTTPS). </para>
API operate using SSL over HTTP (HTTPS).</para>
</note>
</section>
<?hard-pagebreak?>
@ -424,10 +424,10 @@
using the <code>Content-Type</code> header, the
<code>Accept</code> header or adding an
<code>.xml</code> or <code>.json</code> extension
to the request URI. </para><para>If conflicting formats are specified in headers and/or format
to the request URI.</para><para>If conflicting formats are specified in headers and/or format
extensions, the latter takes precedence. XML is
currently the default format for both requests and
responses. </para>
responses.</para>
<table rules="all">
<caption>JSON and XML Response Formats</caption>
<thead>
@ -476,7 +476,7 @@ Content-Length 59
<code>Content-Type</code> header always takes
precedence over the <code>Accept</code> header. The
value of the latter header is therefore ignored in the
example above. </para>
example above.</para>
<example>
<title>Request/Response with Headers: XML</title>
<para>Request:</para> <literallayout class="monospaced">
@ -586,7 +586,6 @@ Content-Type application/xml
</example>
<?hard-pagebreak?>
<example>
<title>Version List Request/Response: JSON</title>
<literallayout class="monospaced">
@ -663,7 +662,7 @@ Content-Type application/json
response data that contains extension elements.
Applications should also verify that an extension
is available before submitting an extended
request. </para>
request.</para>
</important>
</section>
<?hard-pagebreak?>
@ -685,7 +684,7 @@ Content-Type application/json
<title>"Network not found" fault Response (XML)</title>
<programlisting language="json"><xi:include href="samples/fault.json" parse="text"/> </programlisting>
</example>
<para> The error code is returned in the body of the response for convenience. The
<para>The error code is returned in the body of the response for convenience. The
message section returns a human-readable message that is appropriate for display to
the end user. The detail section is optional and may contain information&mdash;for example, a stack trace&mdash;to
assist in tracking down an error.
@ -711,7 +710,7 @@ Content-Type application/json
<!-- <td bgcolor="#4F91BD"> --><td>BadRequest</td>
<!-- <td bgcolor="#4F91BD"> --><td>400</td>
<!-- <td bgcolor="#4F91BD" colspan="2"> --><td colspan="2">Malformed request body. The Quantum service is unable
to parse the contents of the request body. </td>
to parse the contents of the request body.</td>
</tr>
<tr>
<td>Unauthorized</td>
@ -722,57 +721,57 @@ Content-Type application/json
identity service, this might mean that
either no authentication token has been
supplied in the request, or that the token
itself is either invalid or expired. </td>
itself is either invalid or expired.</td>
</tr>
<tr>
<!-- <td bgcolor="#4F91BD"> --><td>Forbidden</td>
<!-- <td bgcolor="#4F91BD"> --> <td>403</td>
<!-- <td bgcolor="#4F91BD" colspan="2"> --> <td colspan="2">The user does not have the necessary rights to
execute the requested operation. </td>
execute the requested operation.</td>
</tr>
<tr>
<td>ItemNotFound</td>
<td>404</td>
<td colspan="2">The requested resource
does not exist on the Quantum API server. </td>
does not exist on the Quantum API server.</td>
</tr>
<tr>
<!-- <td bgcolor="#4F91BD"> --><td>NetworkNotFound</td>
<!-- <td bgcolor="#4F91BD"> --><td>420</td>
<!-- <td bgcolor="#4F91BD" colspan="2"> --> <td colspan="2">The specified network has not been created or has
been removed. </td>
been removed.</td>
</tr>
<tr>
<td>NetworkInUse</td>
<td>421</td>
<td colspan="2">The specified network has
attachments plugged into one or more of
its ports. </td>
its ports.</td>
</tr>
<tr>
<!-- <td bgcolor="#4F91BD"> --><td>PortNotFound</td>
<!-- <td bgcolor="#4F91BD"> --><td>430</td>
<!-- <td bgcolor="#4F91BD" colspan="2"> --><td colspan="2">The specified port has not been created or has been
removed. </td>
removed.</td>
</tr>
<tr>
<td>RequestedStateInvalid</td>
<td>431</td>
<td colspan="2">Indicates a request to
change port to an administrative state not
currently supported. </td>
currently supported.</td>
</tr>
<tr>
<!-- <td bgcolor="#4F91BD"> --> <td>PortInUse</td>
<!--> <td bgcolor="#4F91BD"> --> <td>432</td>
<!-- <td bgcolor="#4F91BD" colspan="2"> --><td colspan="2">The specified port cannot be removed as there is an
attachment plugged in it. </td>
attachment plugged in it.</td>
</tr>
<tr>
<td>AlreadyAttached</td>
<td>440</td>
<td colspan="2">Attachment is already
plugged into another port. </td>
plugged into another port.</td>
</tr>
</tbody>
</table>
@ -824,7 +823,7 @@ Content-Type application/json
currently defined in Quantum for the tenant
specified in the request URI. The list provides
the unique identifier of each network configured
for the tenant specified in the resource URI. </para>
for the tenant specified in the resource URI.</para>
<note>
<para>
<property>TenantId</property> is a unique tenant
@ -867,7 +866,7 @@ Content-Type application/json
<td colspan="3">Lists more detailed
information about networks configured
in Quantum for a given tenant,
identified by <parameter>tenant-id</parameter>. </td>
identified by <parameter>tenant-id</parameter>.</td>
</tr>
</tbody>
</informaltable>
@ -923,7 +922,7 @@ Content-Type application/json
specific network, identified by
<parameter>network-id</parameter>,
for a given tenant, identified by
<parameter>tenant-id</parameter>. </td>
<parameter>tenant-id</parameter>.</td>
</tr>
</tbody>
</informaltable>
@ -974,7 +973,7 @@ Content-Type application/json
for a specific network, identified by
<parameter>network-id</parameter>,
for a given tenant, identified by
<parameter>tenant-id</parameter>. </td>
<parameter>tenant-id</parameter>.</td>
</tr>
</tbody>
</informaltable>
@ -1189,14 +1188,14 @@ Content-Type application/json
is at least one port on the network with
attachments plugged in it. If all ports on the
networks are unattached, they will be destroyed
together with the network itself. </para>
together with the network itself.</para>
<para>As for the create operation there is no guarantee that the
plugin will have completely removed the network
when the call returns. Quantum forwards the
request to the plugin, which will then destroy the
network. </para>
<note><para>This operation cannot be undone. </para></note>
<para>This operation does not require a request body. </para>
network.</para>
<note><para>This operation cannot be undone.</para></note>
<para>This operation does not require a request body.</para>
<example>
<title>Delete Network Request (XML)</title>
<para>Request:</para>
@ -1254,7 +1253,7 @@ Content-Type application/json
configured for a network. For each port the
response reports its unique identifier. If no
ports have been created on the network an empty
list will be returned. </para>
list will be returned.</para>
<para>This operation does not require a request body.</para>
<example>
<title>Port List Request/Response (XML)</title>
@ -1306,7 +1305,7 @@ Content-Type application/json
Response for each port includes its identifier and
the current administrative state. If no ports have
been created on the network an empty list will be
returned. </para>
returned.</para>
<para>This operation does not require a request body.</para>
<example>
<title>Port List Details Request/Response (XML)</title>
@ -1346,7 +1345,7 @@ Content-Type application/json
configured for the network
<parameter>network-id</parameter>
belonging to the tenant
<parameter>tenant-id</parameter>. </td>
<parameter>tenant-id</parameter>.</td>
</tr>
</tbody>
</informaltable>
@ -1361,7 +1360,7 @@ Content-Type application/json
<para>This operation returns the unique identifier and
the current administrative state for a specific
port configured for the network specified in the
request URI. </para>
request URI.</para>
<para>This operation does not require a request body.</para>
<example>
<title>Show Port Request/Response (XML)</title>
@ -1401,7 +1400,7 @@ Content-Type application/json
configured for the network
<parameter>network-id</parameter>
belonging to the tenant
<parameter>tenant-id</parameter>. </td>
<parameter>tenant-id</parameter>.</td>
</tr>
</tbody>
</informaltable>
@ -1416,8 +1415,8 @@ Content-Type application/json
</simpara>
<para>This operation provides at least the identifier
and the current administrative state for specific
port configured for a given network. </para><para>If an attachment is plugged into the port, this operation will
return the identifier of the attachment as well. </para>
port configured for a given network.</para><para>If an attachment is plugged into the port, this operation will
return the identifier of the attachment as well.</para>
<para>This operation does not require a request body.</para>
<example>
<title>Show Port Details Request/Response
@ -1473,27 +1472,27 @@ Content-Type application/json
request body. Quantum validates the request, and
dispatches the request to the plugin, which
creates the port and attaches it to the
appropriate network. </para><para>This operation could not be implemented for some plugins as the
appropriate network.</para><para>This operation could not be implemented for some plugins as the
number of ports available might be fixed when the
network is created. </para><para>If the validation phase fails, the port object is not created at
network is created.</para><para>If the validation phase fails, the port object is not created at
all, and a <code>BadRequest</code> error is
returned to the caller. </para><para>The operation returns a port with an identifier, and set its
returned to the caller.</para><para>The operation returns a port with an identifier, and set its
administrative state set to <code>DOWN</code>,
unless a state has been explicitly specified in
the request body. </para>
the request body.</para>
<note><para>This operation does not guarantee that the port
has been actually created when the calls returns,
as the plugin might still be performing the
necessary operations on the network
infrastructure. However, the port entity can be
immediately used for API operations. </para></note>
immediately used for API operations.</para></note>
<para>The request body is not required for this operation, but it can
optionally contain the administrative state for
the port being created, which can be either
<code>DOWN</code> or <code>ACTIVE</code>. The
administrative state should be encapsulated into a
Port object within the request body, as shown in
the example below. </para>
the example below.</para>
<example>
<title>Create Port Request/Response (XML)</title>
<para>Request:</para>
@ -1604,7 +1603,7 @@ Content-Type application/json
identified by
<parameter>port-id</parameter> on
the network identified by
<parameter>network-id</parameter>. </td>
<parameter>network-id</parameter>.</td>
</tr>
</tbody>
</informaltable>
@ -1679,7 +1678,7 @@ Content-Type application/json
<td colspan="3">Returns the identifier of
the attachment plugged into the
specified port, identified by
<parameter>port-id</parameter>. </td>
<parameter>port-id</parameter>.</td>
</tr>
</tbody>
</informaltable>
@ -1694,11 +1693,11 @@ Content-Type application/json
<para>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. </para><para>If no attachment is currently plugged into the port, the
to a virtual interface identifier.</para><para>If no attachment is currently plugged into the port, the
operation does not return any attachment
identifier in the response. The response will
contain an empty <code>attachment</code> element
with no <code>id</code> attribute set. </para>
with no <code>id</code> attribute set.</para>
<para>This operation does not require a request body.</para>
<example>
<title>Show Attachment Request/Response
@ -1742,7 +1741,7 @@ Content-Type application/json
<td colspan="3">Plugs a resource, such as
a virtual network interface, into the
port identified by
<parameter>port-id</parameter>. </td>
<parameter>port-id</parameter>.</td>
</tr>
</tbody>
</informaltable>
@ -1757,27 +1756,28 @@ Content-Type application/json
(<errorcode>432</errorcode>), AlreadyAttached
(<errorcode>440</errorcode>) </simpara>
<para>This operation plugs an attachment into the port
specified in the request URL. </para><para>Quantum validates the request and dispatches the request to the
specified in the request URL.</para><para>Quantum validates the request and dispatches the request to the
plugin. It is not guaranteed that the attached
resource will be available as soon as the
operation returns. </para><para>The validation can fail if: </para>
operation returns.</para>
<para>The validation can fail if:</para>
<itemizedlist spacing="compact">
<listitem>
<para> An attachment with the same identifier is
already plugged in somewhere else. </para>
<para>An attachment with the same identifier is
already plugged in somewhere else.</para>
</listitem>
<listitem>
<para> Another attachment is already plugged into
the specified port. </para>
<para>Another attachment is already plugged into
the specified port.</para>
</listitem>
</itemizedlist>
<para>If validation fails, the attachment is not created at all,
and the appropriate error code is returned to the
caller. </para>
caller.</para>
<para>If no attachment is currently plugged into the
port, the operation does not return any attachment
identifier in the response. The response will
contain an empty <code>attachment</code> element. </para>
contain an empty <code>attachment</code> element.</para>
<para>
The request body for this network should contain a reference
to the attachment to plug into the port.
@ -1819,7 +1819,7 @@ Content-Type application/json
<td colspan="3">Removes the attachment
currently plugged into the port
identified by
<parameter>port-id</parameter>. </td>
<parameter>port-id</parameter>.</td>
</tr>
</tbody>
</informaltable>
@ -1832,14 +1832,14 @@ Content-Type application/json
(<errorcode>420</errorcode>), PortNotFound
(<errorcode>430</errorcode>) </simpara>
<para>This operation removes the specified attachment
from the port specified in the request URI. </para>
from the port specified in the request URI.</para>
<para>If no attachment is currently plugged into the port, this
operation has no effect. </para>
<para>This operation does not require a request body. </para>
operation has no effect.</para>
<para>This operation does not require a request body.</para>
<example>
<title>Delete Attachment Request (XML)</title>
<para>Request:</para>
<literallayout class="monospaced">DELETE /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/b832be00-6553-4f69-af33-acd554e36d08/attachment.xml </literallayout>
<literallayout class="monospaced">DELETE /tenants/XYZ/networks/158233b0-ca9a-40b4-8614-54a4a99d47d1/ports/b832be00-6553-4f69-af33-acd554e36d08/attachment.xml</literallayout>
<para>Response:</para>
<para><emphasis role="italic">No data is returned
in the response body.</emphasis></para>

6
v2.0/ch_neutron_overview.xml
View File

@ -44,7 +44,7 @@
>Quantum API v1.1</link> with some essential Internet
Protocol Address Management (IPAM) capabilities from the <link
xlink:href="http://melange.readthedocs.org/en/latest/apidoc.html"
>Melange API</link>. </para>
>Melange API</link>.</para>
<para>These IPAM capabilities enable you to:</para>
<itemizedlist>
<listitem>
@ -115,7 +115,7 @@
<td colspan="4">A virtual Ethernet network that is
managed by the OpenStack Networking service.
Currently, OpenStack Networking manages only
Ethernet networks. </td>
Ethernet networks.</td>
</tr>
<tr>
<td align="left">network</td>
@ -145,7 +145,7 @@
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. </td>
subnet.</td>
</tr>
<tr>
<td align="left">subnet</td>

2
v2.0/ch_neutron_preface.xml
View File

@ -36,7 +36,7 @@ format="SVG" scale="60"/>
<para>The OpenStack Networking project provides virtual networking services
among devices managed by the <link
xlink:href="http://wiki.openstack.org/OpenStack">OpenStack</link>
compute service. </para>
compute service.</para>
<para>This document describes the
&APIv2; features.</para>
<para>We welcome feedback, comments, and bug reports at <link

16
v2.0/neutron-external-net.xml
View File

@ -56,22 +56,22 @@
<col width="25%"/>
<thead>
<tr>
<th>Attribute </th>
<th>Type </th>
<th>Required </th>
<th>Attribute</th>
<th>Type</th>
<th>Required</th>
<th>CRUD<footnote xml:id="crud_ext_net">
<para>
<itemizedlist>
<listitem>
<para><emphasis role="bold"
>C</emphasis>. Use the attribute in
create operations. </para>
create operations.</para>
</listitem>
<listitem>
<para><emphasis role="bold"
>R</emphasis>. This attribute is
returned in response to show and
list operations. </para>
list operations.</para>
</listitem>
<listitem>
<para><emphasis role="bold"
@ -81,13 +81,13 @@
<listitem>
<para><emphasis role="bold"
>D</emphasis>. You can delete the
value of this attribute. </para>
value of this attribute.</para>
</listitem>
</itemizedlist>
</para>
</footnote></th>
<th>Default Value </th>
<th>Validation Constraints </th>
<th>Default Value</th>
<th>Validation Constraints</th>
<th>Notes</th>
</tr>
</thead>

2
v2.0/neutron-metering-ext.xml
View File

@ -39,6 +39,6 @@
<title>Metering Labels and Rules</title>
<para>Creates, modifies, and deletes OpenStack Layer3 Metering labels
and rules. </para>
and rules.</para>
<wadl:resources href="wadl/metering-labels.wadl"/>
</section>

8
v2.0/section_binding_ext_ports.xml
View File

@ -58,9 +58,9 @@
<col width="20%"/>
<thead>
<tr>
<th>Attribute </th>
<th>Type </th>
<th>Required </th>
<th>Attribute</th>
<th>Type</th>
<th>Required</th>
<th>CRUD<footnote xml:id="crud_network">
<para><itemizedlist>
<listitem>
@ -265,7 +265,7 @@
(<errorcode>401</errorcode>), Not Found
(<errorcode>404</errorcode>)</simpara>
<para>This operation returns information for the port
specified in the request URI. </para>
specified in the request URI.</para>
<para>This operation does not require a request body.</para>
<para>This operation returns a response body.</para>
<para>In addition to any fields returned in the <xref

6
v2.0/section_neutron-agent-ext.xml
View File

@ -98,14 +98,14 @@
<tr>
<td>&GET;</td>
<td>/agents</td>
<td> List agents which report their status to OpenStack Networking server.</td>
<td>List agents which report their status to OpenStack Networking server.</td>
</tr>
</tbody>
</informaltable>
<simpara>Normal Response Code:
<returnvalue>200</returnvalue>
</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not require a request body.</para>
<para>This operation returns a response body.
The default policy behavior is that non-admin user
won't be able to see any agent in the response when this call is invoked</para>
@ -153,7 +153,7 @@ X-Auth-Token: c52a1b304fec4ca0ac85dc1741eec6e2
</simpara>
<simpara>Error Response Codes:NotFound
(<errorcode>404</errorcode>) if not authorized or the agent does not exist</simpara>
<para>This operation returns information for the given agent. </para>
<para>This operation returns information for the given agent.</para>
<para>This operation does not require a request
body.</para>
<para>This operation returns a response body. The body contents depend on the agent's type.</para>

2
v2.0/section_neutron-allowed-address-pair-ext.xml
View File

@ -44,7 +44,7 @@
attribute to allow one to specify arbitrary
mac_address/ip_address(cidr) pairs that are allowed to pass
through a port regardness of the subnet associated with the
network. </para>
network.</para>
<?hard-pagebreak?>
<section xml:id="allowed_address_pair_ext_ops">
<title>Port API operations with allowed address pair

16
v2.0/section_neutron-extgwmodes-ext.xml
View File

@ -44,9 +44,9 @@
<para>This is achieved simply by specifying a boolean attribute,
<literal>enable_snat</literal>, in the
<literal>external_gateway_info</literal> attribute of the
<literal>router</literal> resource. </para>
<literal>router</literal> resource.</para>
<para>This extension redefines the external_gateway_info attribute
as depicted in the following table. </para>
as depicted in the following table.</para>
<table rules="all">
<caption>external_gateway_info attributes</caption>
<col width="20%"/>
@ -57,11 +57,11 @@
<col width="32%"/>
<thead>
<tr>
<th>Attribute </th>
<th>Type </th>
<th>Required </th>
<th>Default Value </th>
<th>Validation Constraints </th>
<th>Attribute</th>
<th>Type</th>
<th>Required</th>
<th>Default Value</th>
<th>Validation Constraints</th>
<th>Notes</th>
</tr>
</thead>
@ -206,7 +206,7 @@
SNAT will be enabled for the new network.</para>
<para>It is important to note that whenever updating a
router's external gateway information, the
<literal>network_id </literal>parameter must be
<literal>network_id</literal>parameter must be
specified always, even if the final goal is just to enable
or disable SNAT for the router on the same external
network.</para>

6
v2.0/section_neutron-extra-dhcp-opt-ext.xml
View File

@ -42,7 +42,7 @@
tagged data items that are stored in the 'options' field of the DHCP message.</para>
<para>You can specify a DHCP options when defining or updating a Port by specifying the
extra_dhcp_opts tag and providing its options as name value pairs e.g.
opt_name='bootfile-name', opt_value='pxelinux.0'. </para>
opt_name='bootfile-name', opt_value='pxelinux.0'.</para>
<section xml:id="extra_dhcp_opt-concepts">
<title>Concepts</title>
<para>The extra-dhcp-opt extension is an attribute extension which adds the following set of
@ -60,13 +60,13 @@
<para><emphasis role="italic"> extra-dhcp-opt:opt_value</emphasis> - Identifies
the value associated with the opt_name. These are handled in opt_name,
opt_value pairs only. value_opt can be any text string depending upon the
name. </para>
name.</para>
</listitem>
</itemizedlist>
</para>
<para>The actual semantics of extra-dhcp-opt attributes depend on the name of the dhcp
option being used that defines the vendor extension to DHCP. For example reference RFC:
http://tools.ietf.org/html/rfc2132, contains specific detail on BOOTP Vendor Extensions. </para>
http://tools.ietf.org/html/rfc2132, contains specific detail on BOOTP Vendor Extensions.</para>
<para> </para>
</section>
<section xml:id="extra-dhcp-opt-ext-port-ops">

22
v2.0/section_neutron-extraroute-ext.xml
View File

@ -37,11 +37,11 @@
<title>The ExtraRoute Extension</title>
<para>You can set up route configuration on the Router using this
extension. This extension augments the 'Router' resource by
adding a new 'routes' attribute. </para>
adding a new 'routes' attribute.</para>
<para>You can specify a set of nexthop IPs and destination CIDRs.
Note the nexthop IP must be a part of one of the subnets
router interfaces are connected to. This is why configuration
of route property is allowed only update operation on REST. </para>
of route property is allowed only update operation on REST.</para>
<table rules="all">
<caption>Router Attributes</caption>
<col width="20%"/>
@ -53,22 +53,22 @@
<col width="25%"/>
<thead>
<tr>
<th>Attribute </th>
<th>Type </th>
<th>Required </th>
<th>Attribute</th>
<th>Type</th>
<th>Required</th>
<th>CRUD<footnote xml:id="crud_extraroute">
<para>
<itemizedlist>
<listitem>
<para><emphasis role="bold"
>C</emphasis>. Use the attribute in
create operations. </para>
create operations.</para>
</listitem>
<listitem>
<para><emphasis role="bold"
>R</emphasis>. This attribute is
returned in response to show and
list operations. </para>
list operations.</para>
</listitem>
<listitem>
<para><emphasis role="bold"
@ -78,13 +78,13 @@
<listitem>
<para><emphasis role="bold"
>D</emphasis>. You can delete the
value of this attribute. </para>
value of this attribute.</para>
</listitem>
</itemizedlist>
</para>
</footnote></th>
<th>Default Value </th>
<th>Validation Constraints </th>
<th>Default Value</th>
<th>Validation Constraints</th>
<th>Notes</th>
</tr>
</thead>
@ -96,7 +96,7 @@
<td>U</td>
<td>None</td>
<td>List should be in this form.
[{'nexthop':IPAddress, 'destination':CIDR}] </td>
[{'nexthop':IPAddress, 'destination':CIDR}]</td>
<td>Extra route configuration</td>
</tr>
</tbody>

24
v2.0/section_neutron-firewall-ext.xml
View File

@ -420,8 +420,8 @@ Accept: application/json
</para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para>
<para>This operation returns a response body. </para>
<para>This operation requires a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Create Firewall Rule: Request</title>
<programlisting>
@ -516,8 +516,8 @@ Content-Type: application/json; charset=UTF-8
(<errorcode>409</errorcode>). The Conflict error response is
returned when an operation is performed while the firewall
is in a PENDING state.</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not return a response body. </para>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<example>
<title>Delete Firewall Rule: Request</title>
<programlisting>
@ -783,8 +783,8 @@ Accept: application/json
<para>Normal Response Code: <returnvalue>201</returnvalue>
</para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>).</simpara>
<para>This operation requires a request body. </para>
<para>This operation returns a response body. </para>
<para>This operation requires a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Create Firewall Policy: Request</title>
<programlisting>
@ -878,8 +878,8 @@ Content-Type: application/json; charset=UTF-8
Not Found (<errorcode>404</errorcode>), Conflict (<errorcode>409
</errorcode>). Conflict error code is returned the firewall policy
is in use.</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not return a response body. </para>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<example>
<title>Delete Firewall Policy: Request</title>
<programlisting>
@ -1252,8 +1252,8 @@ Accept: application/json
</para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para>
<para>This operation returns a response body. </para>
<para>This operation requires a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Create Firewall: Request</title>
<programlisting>
@ -1345,8 +1345,8 @@ Content-Type: application/json; charset=UTF-8
</para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>)</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not return a response body. </para>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<example>
<title>Delete Firewall: Request</title>
<programlisting>

100
v2.0/section_neutron-l3-ext.xml
View File

@ -62,7 +62,7 @@
<para>A <emphasis role="bold">router </emphasis> is used to
interconnect subnets and forward traffic among them.
Another feature of the router is to NAT internal traffic
to external networks. </para>
to external networks.</para>
<para>A router has an interface for each subnet it is
associated with. By default the IP address of such
interface is the subnet's gateway IP. Also, whenever a
@ -89,22 +89,22 @@
<col width="25%"/>
<thead>
<tr>
<th>Attribute </th>
<th>Type </th>
<th>Required </th>
<th>Attribute</th>
<th>Type</th>
<th>Required</th>
<th>CRUD<footnote xml:id="crud1">
<para>
<itemizedlist>
<listitem>
<para><emphasis role="bold"
>C</emphasis>. Use the attribute in
create operations. </para>
create operations.</para>
</listitem>
<listitem>
<para><emphasis role="bold"
>R</emphasis>. This attribute is
returned in response to show and
list operations. </para>
list operations.</para>
</listitem>
<listitem>
<para><emphasis role="bold"
@ -114,40 +114,40 @@
<listitem>
<para><emphasis role="bold"
>D</emphasis>. You can delete the
value of this attribute. </para>
value of this attribute.</para>
</listitem>
</itemizedlist>
</para>
</footnote></th>
<th>Default Value </th>
<th>Validation Constraints </th>
<th>Default Value</th>
<th>Validation Constraints</th>
<th>Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td>id </td>
<td>uuid-str </td>
<td>N/A </td>
<td>R </td>
<td>generated </td>
<td>N/A </td>
<td>id</td>
<td>uuid-str</td>
<td>N/A</td>
<td>R</td>
<td>generated</td>
<td>N/A</td>
<td>Unique identifier for the router.</td>
</tr>
<tr>
<td>name</td>
<td>String </td>
<td>No </td>
<td>String</td>
<td>No</td>
<td>CRU</td>
<td>None</td>
<td>N/A </td>
<td>N/A</td>
<td>Human readable name for the router. Does not
have to be unique</td>
</tr>
<tr>
<td>admin_state_up</td>
<td>Bool </td>
<td>No </td>
<td>Bool</td>
<td>No</td>
<td>CRU</td>
<td>true</td>
<td>{true | false }</td>
@ -155,8 +155,8 @@
</tr>
<tr>
<td>status</td>
<td>String </td>
<td>N/A </td>
<td>String</td>
<td>N/A</td>
<td>R</td>
<td>N/A</td>
<td>N/A</td>
@ -197,30 +197,30 @@
<col width="25%"/>
<thead>
<tr>
<th>Attribute </th>
<th>Type </th>
<th>Required </th>
<th>Attribute</th>
<th>Type</th>
<th>Required</th>
<th>CRUD</th>
<th>Default Value </th>
<th>Validation Constraints </th>
<th>Default Value</th>
<th>Validation Constraints</th>
<th>Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td>id </td>
<td>uuid-str </td>
<td>N/A </td>
<td>R </td>
<td>generated </td>
<td>N/A </td>
<td>id</td>
<td>uuid-str</td>
<td>N/A</td>
<td>R</td>
<td>generated</td>
<td>N/A</td>
<td>Unique identifier for the Floating IP
instance</td>
</tr>
<tr>
<td>floating_network_id</td>
<td>uuid-str </td>
<td>Yes </td>
<td>uuid-str</td>
<td>Yes</td>
<td>CR</td>
<td>N/A</td>
<td>UUID Pattern</td>
@ -229,8 +229,8 @@
</tr>
<tr>
<td>port_id</td>
<td>uuid-str </td>
<td>Yes </td>
<td>uuid-str</td>
<td>Yes</td>
<td>CRU</td>
<td>N/A</td>
<td>UUID Pattern</td>
@ -240,7 +240,7 @@
</tr>
<tr>
<td>fixed_ip_address</td>
<td>IP Address </td>
<td>IP Address</td>
<td>No</td>
<td>CRU</td>
<td>None</td>
@ -251,8 +251,8 @@
</tr>
<tr>
<td>floating_ip_address</td>
<td>IP Address </td>
<td>N/A </td>
<td>IP Address</td>
<td>N/A</td>
<td>R</td>
<td>Automatically allocated from pool</td>
<td>N/A</td>
@ -364,8 +364,8 @@ Accept: application/json</literallayout>
router whose identifier is specified on the request
URI. Users can control which attributes should be
returned by using the <parameter>fields</parameter>
query parameter. </para>
<para>This operation does not require a request body. </para>
query parameter.</para>
<para>This operation does not require a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Show Router: JSON Request</title>
@ -425,8 +425,8 @@ Accept: application/json</literallayout>
{
"network_id": &lt;external_network_uuid&gt;
}</programlisting></para>
<para>This operation requires a request body. </para>
<para>This operation returns a response body. </para>
<para>This operation requires a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Create Router: JSON Request</title>
<programlisting language="json"><xi:include href="samples/routers-post-req.json" parse="text"/></programlisting>
@ -528,8 +528,8 @@ Accept: application/json</literallayout>
interfaces through <link
linkend="router_remove_interface"> remove router
interface operation</link>. </simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not return a response body. </para>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<example>
<title>Delete Router: JSON Request</title>
<literallayout class="monospaced">DELETE /v2.0/routers/8604a0de-7f6b-409a-a47c-a1cc7bc77b2e
@ -659,7 +659,7 @@ Accept: application/json
the affected router and interface.</para>
<para>A <literal>404 Not Found</literal> error will be
returned either if the router or the subnet/port do
not exist or are not visible to the user. </para>
not exist or are not visible to the user.</para>
<para>As a consequence of this operation, the port
connecting the router with the subnet is removed from
the subnet's network.</para>
@ -771,7 +771,7 @@ Accept: application/json</literallayout>
floating IP whose identifier is specified on the
request URI. Users can control which attributes should
be returned by using the <parameter>fields</parameter>
query parameter. </para>
query parameter.</para>
<example>
<title>Show Floating IP: JSON Request</title>
<literallayout class="monospaced">GET /v2.0/floatingips/2f245a7b-796b-4f26-9cf9-9e82d248fda7.json?fields=fixed_ip_address&amp;fields=floating_ip_address
@ -846,7 +846,7 @@ Accept: application/json</literallayout>
the Floating IP must have at least an IP address
configured, otherwise a <errorcode>400</errorcode>
error will be returned.</para>
<para> As an OpenStack Networking port might be associated
<para>As an OpenStack Networking port might be associated
with multiple IP addresses, the particular IP address
to associate with the floating IP can be specified
using the <literal>fixed_ip_address</literal> request
@ -861,7 +861,7 @@ Accept: application/json</literallayout>
returned.</para>
<para>If the internal OpenStack Networking port and ip address selected
for association are already associated to another
floating IP, a 409 error will be returned. </para>
floating IP, a 409 error will be returned.</para>
<example>
<title>Create Floating IP: JSON Request</title>
<programlisting language="json"><xi:include href="samples/floatingips-post-req.json" parse="text"/></programlisting>

40
v2.0/section_neutron-loadbalancer-ext.xml
View File

@ -514,8 +514,8 @@ Accept: application/json
</para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para>
<para>This operation returns a response body. </para>
<para>This operation requires a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Create VIP: Request</title>
<programlisting>
@ -608,8 +608,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not return a response body. </para>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<example>
<title>Delete VIP: Request</title>
<programlisting>
@ -920,8 +920,8 @@ Content-Type: application/json; charset=UTF-8
</para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para>
<para>This operation returns a response body. </para>
<para>This operation requires a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Create Pool: Request</title>
<programlisting>
@ -1014,8 +1014,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not return a response body. </para>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<example>
<title>Delete Pool: Request</title>
<programlisting>
@ -1290,8 +1290,8 @@ Content-Type: application/json; charset=UTF-8
</para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para>
<para>This operation returns a response body. </para>
<para>This operation requires a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Create Member: Request</title>
<programlisting>
@ -1384,8 +1384,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not return a response body. </para>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<example>
<title>Delete Member: Request</title>
<programlisting>
@ -1487,7 +1487,7 @@ Content-Length: 0
<td>CRU</td>
<td>None</td>
<td>non-negative</td>
<td>The time in seconds between sending probes to members. </td>
<td>The time in seconds between sending probes to members.</td>
</tr>
<tr>
<td>timeout</td>
@ -1496,7 +1496,7 @@ Content-Length: 0
<td>CRU</td>
<td>None</td>
<td>non-negative</td>
<td>The maximum number of seconds for a monitor to wait for a connection to be established before it times out. The value must be less than the delay value. </td>
<td>The maximum number of seconds for a monitor to wait for a connection to be established before it times out. The value must be less than the delay value.</td>
</tr>
<tr>
<td>max_retries</td>
@ -1685,8 +1685,8 @@ Content-Type: application/json; charset=UTF-8
</para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para>
<para>This operation returns a response body. </para>
<para>This operation requires a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Create Health Monitor: Request</title>
<programlisting>
@ -1779,8 +1779,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not return a response body. </para>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<example>
<title>Delete Health Monitor: Request</title>
<programlisting>
@ -1870,8 +1870,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not return a response body. </para>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<example>
<title>Disassociate Health Monitor: Request</title>
<programlisting>

6
v2.0/section_neutron-scheduler-ext.xml
View File

@ -121,7 +121,7 @@
<simpara>Error Response Codes: Unauthorized
(<errorcode>401</errorcode>), Forbidden
(<errorcode>403</errorcode>)</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not require a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>List Networks on DHCP agent: JSON Request</title>
@ -354,7 +354,7 @@ X-Auth-Token: 7ae91cde8f504031be5a2cd5b99d4fe9
<simpara>Error Response Codes: Unauthorized
(<errorcode>401</errorcode>), Forbidden
(<errorcode>403</errorcode>)</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not require a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>List Routers on L3 agent: JSON Request</title>
@ -580,7 +580,7 @@ X-Auth-Token: 2147ef6fe4444f0299b1c0b6b529ff47
<simpara>Error Response Codes: Unauthorized
(<errorcode>401</errorcode>), Forbidden
(<errorcode>403</errorcode>)</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not require a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>List Pools on LBaaS agent: JSON Request</title>

2
v2.0/section_neutron-security-groups-ext.xml
View File

@ -39,6 +39,6 @@
<title>Security Groups and Rules</title>
<para>Creates, modifies, and deletes OpenStack Networking security groups and
rules. </para>
rules.</para>
<wadl:resources href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/netconn-api/src/security-groups.wadl"/>
</section>

32
v2.0/section_neutron-vpn-ext.xml
View File

@ -416,8 +416,8 @@ Accept: application/json
</para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para>
<para>This operation returns a response body. </para>
<para>This operation requires a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Create VPN Service: Request</title>
<programlisting>
@ -511,8 +511,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not return a response body. </para>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<example>
<title>Delete VPN Service: Request</title>
<programlisting>
@ -805,8 +805,8 @@ Content-Type: application/json; charset=UTF-8
</para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para>
<para>This operation returns a response body. </para>
<para>This operation requires a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Create IKE Policy: Request</title>
<programlisting>
@ -899,8 +899,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not return a response body. </para>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<example>
<title>Delete IKE Policy: Request</title>
<programlisting>
@ -1193,8 +1193,8 @@ Content-Type: application/json; charset=UTF-8
</para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para>
<para>This operation returns a response body. </para>
<para>This operation requires a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Create IPSec Policy: Request</title>
<programlisting>
@ -1287,8 +1287,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not return a response body. </para>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<example>
<title>Delete IPSec Policy: Request</title>
<programlisting>
@ -1658,8 +1658,8 @@ Content-Type: application/json; charset=UTF-8
</para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para>
<para>This operation returns a response body. </para>
<para>This operation requires a request body.</para>
<para>This operation returns a response body.</para>
<example>
<title>Create IPSec Site Connection: Request</title>
<programlisting>
@ -1747,8 +1747,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara>
<para>This operation does not require a request body. </para>
<para>This operation does not return a response body. </para>
<para>This operation does not require a request body.</para>
<para>This operation does not return a response body.</para>
<example>
<title>Delete IPSec Site Connection: Request</title>
<programlisting>

8
v2.0/section_neutron_binding_ext_ports.xml
View File

@ -58,9 +58,9 @@
<col width="20%"/>
<thead>
<tr>
<th>Attribute </th>
<th>Type </th>
<th>Required </th>
<th>Attribute</th>
<th>Type</th>
<th>Required</th>
<th>CRUD<footnote xml:id="crud_network">
<para><itemizedlist>
<listitem>
@ -268,7 +268,7 @@
(<errorcode>401</errorcode>), Not Found
(<errorcode>404</errorcode>)</simpara>
<para>This operation returns information for the port
specified in the request URI. </para>
specified in the request URI.</para>
<para>This operation does not require a request body.</para>
<para>This operation returns a response body.</para>
<para>In addition to any fields returned in the show port

40
v2.0/section_neutron_concepts.xml
View File

@ -83,9 +83,9 @@
<col width="20%"/>
<thead>
<tr>
<th>Attribute </th>
<th>Type </th>
<th>Required </th>
<th>Attribute</th>
<th>Type</th>
<th>Required</th>
<th>CRUD<footnote xml:id="crud">
<para><itemizedlist>
<listitem>
@ -111,8 +111,8 @@
</listitem>
</itemizedlist></para>
</footnote></th>
<th>Default Value </th>
<th>Validation Constraints </th>
<th>Default Value</th>
<th>Validation Constraints</th>
<th>Notes</th>
</tr>
</thead>
@ -179,7 +179,7 @@
<td>R</td>
<td>Empty List</td>
<td>N/A</td>
<td>subnets associated with this network. </td>
<td>subnets associated with this network.</td>
</tr>
<tr>
<td>shared</td>
@ -206,7 +206,7 @@
<td>N/A</td>
<td>No constraint</td>
<td>Owner of network. Only admin users can specify
a tenant_id other than its own. </td>
a tenant_id other than its own.</td>
</tr>
</tbody>
</table>
@ -236,9 +236,9 @@
<col width="20%"/>
<thead>
<tr>
<th>Attribute </th>
<th>Type </th>
<th>Required </th>
<th>Attribute</th>
<th>Type</th>
<th>Required</th>
<th>CRUD<footnote xml:id="crud2">
<para><itemizedlist>
<listitem>
@ -265,8 +265,8 @@
</itemizedlist></para>
</footnote>
</th>
<th>Default Value </th>
<th>Validation Constraints </th>
<th>Default Value</th>
<th>Validation Constraints</th>
<th>Notes</th>
</tr>
</thead>
@ -392,7 +392,7 @@
<td>N/A</td>
<td>No constraint</td>
<td>Owner of network. Only admin users can specify
a tenant_id other than its own. </td>
a tenant_id other than its own.</td>
</tr>
</tbody>
</table>
@ -420,9 +420,9 @@
<col width="20%"/>
<thead>
<tr>
<th>Attribute </th>
<th>Type </th>
<th>Required </th>
<th>Attribute</th>
<th>Type</th>
<th>Required</th>
<th>CRUD<footnote xml:id="crud3">
<para><itemizedlist>
<listitem>
@ -449,8 +449,8 @@
</itemizedlist></para>
</footnote>
</th>
<th>Default Value </th>
<th>Validation Constraints </th>
<th>Default Value</th>
<th>Validation Constraints</th>
<th>Notes</th>
</tr>
</thead>
@ -492,7 +492,7 @@
<td>true</td>
<td>{true|false}</td>
<td>Administrative state of port. If false (down),
port does not forward packets. </td>
port does not forward packets.</td>
</tr>
<tr>
<td>status</td>
@ -576,7 +576,7 @@
<td>N/A</td>
<td>No constraint</td>
<td>Owner of network. Only admin users can specify
a tenant_id other than its own. </td>
a tenant_id other than its own.</td>
</tr>
<tr>
<td>security_groups</td>

2
v2.0/section_provider_ext_networks.xml
View File

@ -263,7 +263,7 @@
user submitting the request is authorized to see provider
networks mapping, this operation allows for specifying how
an existing network should be mapped on the underlying
network infrastructure. </para>
network infrastructure.</para>
<para>If the user submitting the request is not allowed to set
provider networks attributes, a 403 Forbidden response is
returned.</para>

2
v2.0/section_provider_extended_attrs.xml
View File

@ -39,7 +39,7 @@
networks enables administrative users to specify how network
objects map to the underlying networking infrastructure. These
extended attributes also appear when administrative users
query networks. </para>
query networks.</para>
<para>The technology back end of the particular plug-in determines
the semantics of these attributes. To understand which values
to specify for each attribute when you deploy &APIv2; with a

10
v2.0/wadl/metering-labels.wadl
View File

@ -87,7 +87,7 @@
title="Create Metering Label">
<para role="shortdesc">Creates a l3 metering label.
</para>
<para>This operation requires a request body. </para>
<para>This operation requires a request body.</para>
<para>The following table describes the required and
optional attributes in the request body:</para>
<table width="75%" rules="all"><caption>Create Metering Label
@ -197,7 +197,7 @@
<para>This operation deletes a l3 metering label.
</para>
<para>This operation does not require a request body. This
operation does not return a response body. </para>
operation does not return a response body.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
@ -239,7 +239,7 @@
<para>The list provides the unique ID for each metering
label rule.</para>
<para>This operation does not require a request body. This
operation returns a response body. </para>
operation returns a response body.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
@ -272,7 +272,7 @@
title="Create Metering Label Rule">
<para role="shortdesc">Creates a l3 metering label rule.
</para>
<para>This operation requires a request body. </para>
<para>This operation requires a request body.</para>
<para>The following table describes the required and
optional attributes in the request body:</para>
<table width="75%" rules="all"><caption>Create Metering Label
@ -302,7 +302,7 @@
remote IP prefix to be associated with
this metering rule.
packet.</para></td></tr></tbody></table>
<para>This operation returns a response body. </para>
<para>This operation returns a response body.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">

1
v2.0/wadl/os-networks.wadl
View File

@ -175,7 +175,6 @@
<representation mediaType="application/json"
element="csapi:network">
<!-- <param required="true" name="name" style="plain"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"

1
v2.0/wadl/os-quotas.wadl
View File

@ -62,7 +62,6 @@
</resource>
</resources>
<!--*******************************************************-->
<!-- All Methods -->
<!--*******************************************************-->

16
v2.0/wadl/security-groups.wadl
View File

@ -100,7 +100,7 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create Security Group">
<para role="shortdesc">Creates an OpenStack Networking
security group. </para>
security group.</para>
<para>This operation requires a request body. The request
body must include one or both of the following
attributes:</para>
@ -121,7 +121,7 @@
<listitem><para><code>protocol</code></para></listitem>
<listitem><para><code>remote_group_id</code></para></listitem>
<listitem><para><code>remote_ip_prefix</code></para></listitem></itemizedlist>
<para>This operation returns a response body. </para>
<para>This operation returns a response body.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
@ -207,7 +207,7 @@
rules, provided that a port is not associated with the
security group.</para>
<para>This operation does not require a request body. This
operation does not return a response body. </para>
operation does not return a response body.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
@ -249,7 +249,7 @@
<para>The list provides the unique ID for each security
group rule.</para>
<para>This operation does not require a request body. This
operation returns a response body. </para>
operation returns a response body.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
@ -281,8 +281,8 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Create Security Group Rule">
<para role="shortdesc">Creates an OpenStack Networking
security group rule. </para>
<para>This operation requires a request body. </para>
security group rule.</para>
<para>This operation requires a request body.</para>
<para>The following table describes the required and
optional attributes in the request body:</para>
<table width="75%" rules="all"><caption>Create Security
@ -346,7 +346,7 @@
IP prefix as the source IP address of
the IP
packet.</para></td></tr></tbody></table>
<para>This operation returns a response body. </para>
<para>This operation returns a response body.</para>
</wadl:doc>
<request>
<representation mediaType="application/json">
@ -454,7 +454,7 @@
<wadl:doc xml:lang="EN" xmlns="http://docbook.org/ns/docbook"
title="Delete Security Group Rule">
<para role="shortdesc">Deletes a specified rule from a
OpenStack Networking security group. </para>
OpenStack Networking security group.</para>
<para>This operation does not require a request
body.</para>
<para>This operation does not return a response body.