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

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

File diff suppressed because it is too large Load Diff

2
v1.0/samples/att-put-req.xml
View File

@ -1,2 +1,2 @@
<attachment <attachment
id="test_interface_identifier"/> id="test_interface_identifier"/>

8
v1.0/samples/network-get-detail-res.xml
View File

@ -3,11 +3,11 @@
name="test_network"> name="test_network">
<ports> <ports>
<port <port
id="98017ddc-efc8-4c25-a915-774b2a633855" id="98017ddc-efc8-4c25-a915-774b2a633855"
status="DOWN"/> status="DOWN"/>
<port <port
id="b832be00-6553-4f69-af33-acd554e36d08" id="b832be00-6553-4f69-af33-acd554e36d08"
status="ACTIVE"> status="ACTIVE">
<attachment id="test_interface_identifier"/> <attachment id="test_interface_identifier"/>
</port> </port>
</ports> </ports>

4
v1.0/samples/networks-get-detail-res.xml
View File

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

2
v1.0/samples/port-get-detail-res.xml
View File

@ -2,5 +2,5 @@
id="98017ddc-efc8-4c25-a915-774b2a633855" id="98017ddc-efc8-4c25-a915-774b2a633855"
state="DOWN"> state="DOWN">
<attachment <attachment
id="test_interface_identifier"/> id="test_interface_identifier"/>
</port> </port>

2
v1.0/samples/port-post-req.xml
View File

@ -1,2 +1,2 @@
<port <port
state="ACTIVE"/> state="ACTIVE"/>

2
v1.0/samples/port-post-res.xml
View File

@ -1,2 +1,2 @@
<port <port
id="98017ddc-efc8-4c25-a915-774b2a633855"/> id="98017ddc-efc8-4c25-a915-774b2a633855"/>

4
v1.0/samples/ports-get-detail-res.xml
View File

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

4
v1.0/samples/ports-get-res.xml
View File

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

2
v2.0/api_samples/subnet-get-detail-res.xml
View File

@ -2,5 +2,5 @@
id="98017ddc-efc8-4c25-a915-774b2a633855" id="98017ddc-efc8-4c25-a915-774b2a633855"
state="DOWN"> state="DOWN">
<attachment <attachment
id="test_interface_identifier"/> id="test_interface_identifier"/>
</port> </port>

2
v2.0/api_samples/subnet-post-req.xml
View File

@ -1,2 +1,2 @@
<port <port
state="ACTIVE"/> state="ACTIVE"/>

2
v2.0/api_samples/subnet-post-res.xml
View File

@ -1,2 +1,2 @@
<port <port
id="98017ddc-efc8-4c25-a915-774b2a633855"/> id="98017ddc-efc8-4c25-a915-774b2a633855"/>

4
v2.0/api_samples/subnets-get-detail-res.xml
View File

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

4
v2.0/api_samples/subnets-get-res.xml
View File

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

6
v2.0/ch_neutron_overview.xml
View File

@ -44,7 +44,7 @@
>Quantum API v1.1</link> with some essential Internet >Quantum API v1.1</link> with some essential Internet
Protocol Address Management (IPAM) capabilities from the <link Protocol Address Management (IPAM) capabilities from the <link
xlink:href="http://melange.readthedocs.org/en/latest/apidoc.html" 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> <para>These IPAM capabilities enable you to:</para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
@ -115,7 +115,7 @@
<td colspan="4">A virtual Ethernet network that is <td colspan="4">A virtual Ethernet network that is
managed by the OpenStack Networking service. managed by the OpenStack Networking service.
Currently, OpenStack Networking manages only Currently, OpenStack Networking manages only
Ethernet networks. </td> Ethernet networks.</td>
</tr> </tr>
<tr> <tr>
<td align="left">network</td> <td align="left">network</td>
@ -145,7 +145,7 @@
port, this also implies the port is associated port, this also implies the port is associated
with a subnet, as the IP address was taken with a subnet, as the IP address was taken
from the allocation pool for a specific from the allocation pool for a specific
subnet. </td> subnet.</td>
</tr> </tr>
<tr> <tr>
<td align="left">subnet</td> <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 <para>The OpenStack Networking project provides virtual networking services
among devices managed by the <link among devices managed by the <link
xlink:href="http://wiki.openstack.org/OpenStack">OpenStack</link> xlink:href="http://wiki.openstack.org/OpenStack">OpenStack</link>
compute service. </para> compute service.</para>
<para>This document describes the <para>This document describes the
&APIv2; features.</para> &APIv2; features.</para>
<para>We welcome feedback, comments, and bug reports at <link <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%"/> <col width="25%"/>
<thead> <thead>
<tr> <tr>
<th>Attribute </th> <th>Attribute</th>
<th>Type </th> <th>Type</th>
<th>Required </th> <th>Required</th>
<th>CRUD<footnote xml:id="crud_ext_net"> <th>CRUD<footnote xml:id="crud_ext_net">
<para> <para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><emphasis role="bold" <para><emphasis role="bold"
>C</emphasis>. Use the attribute in >C</emphasis>. Use the attribute in
create operations. </para> create operations.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis role="bold" <para><emphasis role="bold"
>R</emphasis>. This attribute is >R</emphasis>. This attribute is
returned in response to show and returned in response to show and
list operations. </para> list operations.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis role="bold" <para><emphasis role="bold"
@ -81,13 +81,13 @@
<listitem> <listitem>
<para><emphasis role="bold" <para><emphasis role="bold"
>D</emphasis>. You can delete the >D</emphasis>. You can delete the
value of this attribute. </para> value of this attribute.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</footnote></th> </footnote></th>
<th>Default Value </th> <th>Default Value</th>
<th>Validation Constraints </th> <th>Validation Constraints</th>
<th>Notes</th> <th>Notes</th>
</tr> </tr>
</thead> </thead>

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

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

2
v2.0/samples/att-put-req.xml
View File

@ -1,2 +1,2 @@
<attachment <attachment
id="test_interface_identifier"/> id="test_interface_identifier"/>

8
v2.0/samples/network-get-detail-res.xml
View File

@ -3,11 +3,11 @@
name="test_network"> name="test_network">
<ports> <ports>
<port <port
id="98017ddc-efc8-4c25-a915-774b2a633855" id="98017ddc-efc8-4c25-a915-774b2a633855"
status="DOWN"/> status="DOWN"/>
<port <port
id="b832be00-6553-4f69-af33-acd554e36d08" id="b832be00-6553-4f69-af33-acd554e36d08"
status="ACTIVE"> status="ACTIVE">
<attachment id="test_interface_identifier"/> <attachment id="test_interface_identifier"/>
</port> </port>
</ports> </ports>

4
v2.0/samples/networks-get-detail-res.xml
View File

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

2
v2.0/samples/port-get-detail-res.xml
View File

@ -2,5 +2,5 @@
id="98017ddc-efc8-4c25-a915-774b2a633855" id="98017ddc-efc8-4c25-a915-774b2a633855"
state="DOWN"> state="DOWN">
<attachment <attachment
id="test_interface_identifier"/> id="test_interface_identifier"/>
</port> </port>

2
v2.0/samples/port-post-req.xml
View File

@ -1,2 +1,2 @@
<port <port
state="ACTIVE"/> state="ACTIVE"/>

2
v2.0/samples/port-post-res.xml
View File

@ -1,2 +1,2 @@
<port <port
id="98017ddc-efc8-4c25-a915-774b2a633855"/> id="98017ddc-efc8-4c25-a915-774b2a633855"/>

4
v2.0/samples/ports-get-detail-res.xml
View File

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

4
v2.0/samples/ports-get-res.xml
View File

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

2
v2.0/samples/subnet-get-detail-res.xml
View File

@ -2,5 +2,5 @@
id="98017ddc-efc8-4c25-a915-774b2a633855" id="98017ddc-efc8-4c25-a915-774b2a633855"
state="DOWN"> state="DOWN">
<attachment <attachment
id="test_interface_identifier"/> id="test_interface_identifier"/>
</port> </port>

2
v2.0/samples/subnet-post-req.xml
View File

@ -1,2 +1,2 @@
<port <port
state="ACTIVE"/> state="ACTIVE"/>

2
v2.0/samples/subnet-post-res.xml
View File

@ -1,2 +1,2 @@
<port <port
id="98017ddc-efc8-4c25-a915-774b2a633855"/> id="98017ddc-efc8-4c25-a915-774b2a633855"/>

4
v2.0/samples/subnets-get-detail-res.xml
View File

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

4
v2.0/samples/subnets-get-res.xml
View File

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

8
v2.0/section_binding_ext_ports.xml
View File

@ -58,9 +58,9 @@
<col width="20%"/> <col width="20%"/>
<thead> <thead>
<tr> <tr>
<th>Attribute </th> <th>Attribute</th>
<th>Type </th> <th>Type</th>
<th>Required </th> <th>Required</th>
<th>CRUD<footnote xml:id="crud_network"> <th>CRUD<footnote xml:id="crud_network">
<para><itemizedlist> <para><itemizedlist>
<listitem> <listitem>
@ -265,7 +265,7 @@
(<errorcode>401</errorcode>), Not Found (<errorcode>401</errorcode>), Not Found
(<errorcode>404</errorcode>)</simpara> (<errorcode>404</errorcode>)</simpara>
<para>This operation returns information for the port <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 does not require a request body.</para>
<para>This operation returns a response body.</para> <para>This operation returns a response body.</para>
<para>In addition to any fields returned in the <xref <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> <tr>
<td>&GET;</td> <td>&GET;</td>
<td>/agents</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> </tr>
</tbody> </tbody>
</informaltable> </informaltable>
<simpara>Normal Response Code: <simpara>Normal Response Code:
<returnvalue>200</returnvalue> <returnvalue>200</returnvalue>
</simpara> </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>This operation returns a response body.
The default policy behavior is that non-admin user 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> 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>
<simpara>Error Response Codes:NotFound <simpara>Error Response Codes:NotFound
(<errorcode>404</errorcode>) if not authorized or the agent does not exist</simpara> (<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 <para>This operation does not require a request
body.</para> body.</para>
<para>This operation returns a response body. The body contents depend on the agent's type.</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 attribute to allow one to specify arbitrary
mac_address/ip_address(cidr) pairs that are allowed to pass mac_address/ip_address(cidr) pairs that are allowed to pass
through a port regardness of the subnet associated with the through a port regardness of the subnet associated with the
network. </para> network.</para>
<?hard-pagebreak?> <?hard-pagebreak?>
<section xml:id="allowed_address_pair_ext_ops"> <section xml:id="allowed_address_pair_ext_ops">
<title>Port API operations with allowed address pair <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, <para>This is achieved simply by specifying a boolean attribute,
<literal>enable_snat</literal>, in the <literal>enable_snat</literal>, in the
<literal>external_gateway_info</literal> attribute of 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 <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"> <table rules="all">
<caption>external_gateway_info attributes</caption> <caption>external_gateway_info attributes</caption>
<col width="20%"/> <col width="20%"/>
@ -57,11 +57,11 @@
<col width="32%"/> <col width="32%"/>
<thead> <thead>
<tr> <tr>
<th>Attribute </th> <th>Attribute</th>
<th>Type </th> <th>Type</th>
<th>Required </th> <th>Required</th>
<th>Default Value </th> <th>Default Value</th>
<th>Validation Constraints </th> <th>Validation Constraints</th>
<th>Notes</th> <th>Notes</th>
</tr> </tr>
</thead> </thead>
@ -206,7 +206,7 @@
SNAT will be enabled for the new network.</para> SNAT will be enabled for the new network.</para>
<para>It is important to note that whenever updating a <para>It is important to note that whenever updating a
router's external gateway information, the 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 specified always, even if the final goal is just to enable
or disable SNAT for the router on the same external or disable SNAT for the router on the same external
network.</para> 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> 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 <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. 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"> <section xml:id="extra_dhcp_opt-concepts">
<title>Concepts</title> <title>Concepts</title>
<para>The extra-dhcp-opt extension is an attribute extension which adds the following set of <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 <para><emphasis role="italic"> extra-dhcp-opt:opt_value</emphasis> - Identifies
the value associated with the opt_name. These are handled in opt_name, 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 opt_value pairs only. value_opt can be any text string depending upon the
name. </para> name.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
<para>The actual semantics of extra-dhcp-opt attributes depend on the name of the dhcp <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: 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> <para> </para>
</section> </section>
<section xml:id="extra-dhcp-opt-ext-port-ops"> <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> <title>The ExtraRoute Extension</title>
<para>You can set up route configuration on the Router using this <para>You can set up route configuration on the Router using this
extension. This extension augments the 'Router' resource by 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. <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 Note the nexthop IP must be a part of one of the subnets
router interfaces are connected to. This is why configuration 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"> <table rules="all">
<caption>Router Attributes</caption> <caption>Router Attributes</caption>
<col width="20%"/> <col width="20%"/>
@ -53,22 +53,22 @@
<col width="25%"/> <col width="25%"/>
<thead> <thead>
<tr> <tr>
<th>Attribute </th> <th>Attribute</th>
<th>Type </th> <th>Type</th>
<th>Required </th> <th>Required</th>
<th>CRUD<footnote xml:id="crud_extraroute"> <th>CRUD<footnote xml:id="crud_extraroute">
<para> <para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><emphasis role="bold" <para><emphasis role="bold"
>C</emphasis>. Use the attribute in >C</emphasis>. Use the attribute in
create operations. </para> create operations.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis role="bold" <para><emphasis role="bold"
>R</emphasis>. This attribute is >R</emphasis>. This attribute is
returned in response to show and returned in response to show and
list operations. </para> list operations.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis role="bold" <para><emphasis role="bold"
@ -78,13 +78,13 @@
<listitem> <listitem>
<para><emphasis role="bold" <para><emphasis role="bold"
>D</emphasis>. You can delete the >D</emphasis>. You can delete the
value of this attribute. </para> value of this attribute.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</footnote></th> </footnote></th>
<th>Default Value </th> <th>Default Value</th>
<th>Validation Constraints </th> <th>Validation Constraints</th>
<th>Notes</th> <th>Notes</th>
</tr> </tr>
</thead> </thead>
@ -96,7 +96,7 @@
<td>U</td> <td>U</td>
<td>None</td> <td>None</td>
<td>List should be in this form. <td>List should be in this form.
[{'nexthop':IPAddress, 'destination':CIDR}] </td> [{'nexthop':IPAddress, 'destination':CIDR}]</td>
<td>Extra route configuration</td> <td>Extra route configuration</td>
</tr> </tr>
</tbody> </tbody>

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

@ -420,8 +420,8 @@ Accept: application/json
</para> </para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>), <simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara> Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para> <para>This operation requires a request body.</para>
<para>This operation returns a response body. </para> <para>This operation returns a response body.</para>
<example> <example>
<title>Create Firewall Rule: Request</title> <title>Create Firewall Rule: Request</title>
<programlisting> <programlisting>
@ -516,8 +516,8 @@ Content-Type: application/json; charset=UTF-8
(<errorcode>409</errorcode>). The Conflict error response is (<errorcode>409</errorcode>). The Conflict error response is
returned when an operation is performed while the firewall returned when an operation is performed while the firewall
is in a PENDING state.</simpara> is in a PENDING state.</simpara>
<para>This operation does not require a request body. </para> <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 return a response body.</para>
<example> <example>
<title>Delete Firewall Rule: Request</title> <title>Delete Firewall Rule: Request</title>
<programlisting> <programlisting>
@ -783,8 +783,8 @@ Accept: application/json
<para>Normal Response Code: <returnvalue>201</returnvalue> <para>Normal Response Code: <returnvalue>201</returnvalue>
</para> </para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>).</simpara> <simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>).</simpara>
<para>This operation requires a request body. </para> <para>This operation requires a request body.</para>
<para>This operation returns a response body. </para> <para>This operation returns a response body.</para>
<example> <example>
<title>Create Firewall Policy: Request</title> <title>Create Firewall Policy: Request</title>
<programlisting> <programlisting>
@ -878,8 +878,8 @@ Content-Type: application/json; charset=UTF-8
Not Found (<errorcode>404</errorcode>), Conflict (<errorcode>409 Not Found (<errorcode>404</errorcode>), Conflict (<errorcode>409
</errorcode>). Conflict error code is returned the firewall policy </errorcode>). Conflict error code is returned the firewall policy
is in use.</simpara> is in use.</simpara>
<para>This operation does not require a request body. </para> <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 return a response body.</para>
<example> <example>
<title>Delete Firewall Policy: Request</title> <title>Delete Firewall Policy: Request</title>
<programlisting> <programlisting>
@ -1252,8 +1252,8 @@ Accept: application/json
</para> </para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>), <simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara> Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para> <para>This operation requires a request body.</para>
<para>This operation returns a response body. </para> <para>This operation returns a response body.</para>
<example> <example>
<title>Create Firewall: Request</title> <title>Create Firewall: Request</title>
<programlisting> <programlisting>
@ -1345,8 +1345,8 @@ Content-Type: application/json; charset=UTF-8
</para> </para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>), <simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>)</simpara> Not Found (<errorcode>404</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 does not return a response body. </para> <para>This operation does not return a response body.</para>
<example> <example>
<title>Delete Firewall: Request</title> <title>Delete Firewall: Request</title>
<programlisting> <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 <para>A <emphasis role="bold">router </emphasis> is used to
interconnect subnets and forward traffic among them. interconnect subnets and forward traffic among them.
Another feature of the router is to NAT internal traffic 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 <para>A router has an interface for each subnet it is
associated with. By default the IP address of such associated with. By default the IP address of such
interface is the subnet's gateway IP. Also, whenever a interface is the subnet's gateway IP. Also, whenever a
@ -89,22 +89,22 @@
<col width="25%"/> <col width="25%"/>
<thead> <thead>
<tr> <tr>
<th>Attribute </th> <th>Attribute</th>
<th>Type </th> <th>Type</th>
<th>Required </th> <th>Required</th>
<th>CRUD<footnote xml:id="crud1"> <th>CRUD<footnote xml:id="crud1">
<para> <para>
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><emphasis role="bold" <para><emphasis role="bold"
>C</emphasis>. Use the attribute in >C</emphasis>. Use the attribute in
create operations. </para> create operations.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis role="bold" <para><emphasis role="bold"
>R</emphasis>. This attribute is >R</emphasis>. This attribute is
returned in response to show and returned in response to show and
list operations. </para> list operations.</para>
</listitem> </listitem>
<listitem> <listitem>
<para><emphasis role="bold" <para><emphasis role="bold"
@ -114,40 +114,40 @@
<listitem> <listitem>
<para><emphasis role="bold" <para><emphasis role="bold"
>D</emphasis>. You can delete the >D</emphasis>. You can delete the
value of this attribute. </para> value of this attribute.</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</footnote></th> </footnote></th>
<th>Default Value </th> <th>Default Value</th>
<th>Validation Constraints </th> <th>Validation Constraints</th>
<th>Notes</th> <th>Notes</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>id </td> <td>id</td>
<td>uuid-str </td> <td>uuid-str</td>
<td>N/A </td> <td>N/A</td>
<td>R </td> <td>R</td>
<td>generated </td> <td>generated</td>
<td>N/A </td> <td>N/A</td>
<td>Unique identifier for the router.</td> <td>Unique identifier for the router.</td>
</tr> </tr>
<tr> <tr>
<td>name</td> <td>name</td>
<td>String </td> <td>String</td>
<td>No </td> <td>No</td>
<td>CRU</td> <td>CRU</td>
<td>None</td> <td>None</td>
<td>N/A </td> <td>N/A</td>
<td>Human readable name for the router. Does not <td>Human readable name for the router. Does not
have to be unique</td> have to be unique</td>
</tr> </tr>
<tr> <tr>
<td>admin_state_up</td> <td>admin_state_up</td>
<td>Bool </td> <td>Bool</td>
<td>No </td> <td>No</td>
<td>CRU</td> <td>CRU</td>
<td>true</td> <td>true</td>
<td>{true | false }</td> <td>{true | false }</td>
@ -155,8 +155,8 @@
</tr> </tr>
<tr> <tr>
<td>status</td> <td>status</td>
<td>String </td> <td>String</td>
<td>N/A </td> <td>N/A</td>
<td>R</td> <td>R</td>
<td>N/A</td> <td>N/A</td>
<td>N/A</td> <td>N/A</td>
@ -197,30 +197,30 @@
<col width="25%"/> <col width="25%"/>
<thead> <thead>
<tr> <tr>
<th>Attribute </th> <th>Attribute</th>
<th>Type </th> <th>Type</th>
<th>Required </th> <th>Required</th>
<th>CRUD</th> <th>CRUD</th>
<th>Default Value </th> <th>Default Value</th>
<th>Validation Constraints </th> <th>Validation Constraints</th>
<th>Notes</th> <th>Notes</th>
</tr> </tr>
</thead> </thead>
<tbody> <tbody>
<tr> <tr>
<td>id </td> <td>id</td>
<td>uuid-str </td> <td>uuid-str</td>
<td>N/A </td> <td>N/A</td>
<td>R </td> <td>R</td>
<td>generated </td> <td>generated</td>
<td>N/A </td> <td>N/A</td>
<td>Unique identifier for the Floating IP <td>Unique identifier for the Floating IP
instance</td> instance</td>
</tr> </tr>
<tr> <tr>
<td>floating_network_id</td> <td>floating_network_id</td>
<td>uuid-str </td> <td>uuid-str</td>
<td>Yes </td> <td>Yes</td>
<td>CR</td> <td>CR</td>
<td>N/A</td> <td>N/A</td>
<td>UUID Pattern</td> <td>UUID Pattern</td>
@ -229,8 +229,8 @@
</tr> </tr>
<tr> <tr>
<td>port_id</td> <td>port_id</td>
<td>uuid-str </td> <td>uuid-str</td>
<td>Yes </td> <td>Yes</td>
<td>CRU</td> <td>CRU</td>
<td>N/A</td> <td>N/A</td>
<td>UUID Pattern</td> <td>UUID Pattern</td>
@ -240,7 +240,7 @@
</tr> </tr>
<tr> <tr>
<td>fixed_ip_address</td> <td>fixed_ip_address</td>
<td>IP Address </td> <td>IP Address</td>
<td>No</td> <td>No</td>
<td>CRU</td> <td>CRU</td>
<td>None</td> <td>None</td>
@ -251,8 +251,8 @@
</tr> </tr>
<tr> <tr>
<td>floating_ip_address</td> <td>floating_ip_address</td>
<td>IP Address </td> <td>IP Address</td>
<td>N/A </td> <td>N/A</td>
<td>R</td> <td>R</td>
<td>Automatically allocated from pool</td> <td>Automatically allocated from pool</td>
<td>N/A</td> <td>N/A</td>
@ -364,8 +364,8 @@ Accept: application/json</literallayout>
router whose identifier is specified on the request router whose identifier is specified on the request
URI. Users can control which attributes should be URI. Users can control which attributes should be
returned by using the <parameter>fields</parameter> returned by using the <parameter>fields</parameter>
query parameter. </para> query parameter.</para>
<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> <para>This operation returns a response body.</para>
<example> <example>
<title>Show Router: JSON Request</title> <title>Show Router: JSON Request</title>
@ -425,8 +425,8 @@ Accept: application/json</literallayout>
{ {
"network_id": &lt;external_network_uuid&gt; "network_id": &lt;external_network_uuid&gt;
}</programlisting></para> }</programlisting></para>
<para>This operation requires a request body. </para> <para>This operation requires a request body.</para>
<para>This operation returns a response body. </para> <para>This operation returns a response body.</para>
<example> <example>
<title>Create Router: JSON Request</title> <title>Create Router: JSON Request</title>
<programlisting language="json"><xi:include href="samples/routers-post-req.json" parse="text"/></programlisting> <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 interfaces through <link
linkend="router_remove_interface"> remove router linkend="router_remove_interface"> remove router
interface operation</link>. </simpara> interface operation</link>. </simpara>
<para>This operation does not require a request body. </para> <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 return a response body.</para>
<example> <example>
<title>Delete Router: JSON Request</title> <title>Delete Router: JSON Request</title>
<literallayout class="monospaced">DELETE /v2.0/routers/8604a0de-7f6b-409a-a47c-a1cc7bc77b2e <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> the affected router and interface.</para>
<para>A <literal>404 Not Found</literal> error will be <para>A <literal>404 Not Found</literal> error will be
returned either if the router or the subnet/port do 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 <para>As a consequence of this operation, the port
connecting the router with the subnet is removed from connecting the router with the subnet is removed from
the subnet's network.</para> the subnet's network.</para>
@ -771,7 +771,7 @@ Accept: application/json</literallayout>
floating IP whose identifier is specified on the floating IP whose identifier is specified on the
request URI. Users can control which attributes should request URI. Users can control which attributes should
be returned by using the <parameter>fields</parameter> be returned by using the <parameter>fields</parameter>
query parameter. </para> query parameter.</para>
<example> <example>
<title>Show Floating IP: JSON Request</title> <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 <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 the Floating IP must have at least an IP address
configured, otherwise a <errorcode>400</errorcode> configured, otherwise a <errorcode>400</errorcode>
error will be returned.</para> 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 with multiple IP addresses, the particular IP address
to associate with the floating IP can be specified to associate with the floating IP can be specified
using the <literal>fixed_ip_address</literal> request using the <literal>fixed_ip_address</literal> request
@ -861,7 +861,7 @@ Accept: application/json</literallayout>
returned.</para> returned.</para>
<para>If the internal OpenStack Networking port and ip address selected <para>If the internal OpenStack Networking port and ip address selected
for association are already associated to another 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> <example>
<title>Create Floating IP: JSON Request</title> <title>Create Floating IP: JSON Request</title>
<programlisting language="json"><xi:include href="samples/floatingips-post-req.json" parse="text"/></programlisting> <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> </para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>), <simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara> Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para> <para>This operation requires a request body.</para>
<para>This operation returns a response body. </para> <para>This operation returns a response body.</para>
<example> <example>
<title>Create VIP: Request</title> <title>Create VIP: Request</title>
<programlisting> <programlisting>
@ -608,8 +608,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>), <simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara> (<errorcode>409</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 does not return a response body. </para> <para>This operation does not return a response body.</para>
<example> <example>
<title>Delete VIP: Request</title> <title>Delete VIP: Request</title>
<programlisting> <programlisting>
@ -920,8 +920,8 @@ Content-Type: application/json; charset=UTF-8
</para> </para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>), <simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara> Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para> <para>This operation requires a request body.</para>
<para>This operation returns a response body. </para> <para>This operation returns a response body.</para>
<example> <example>
<title>Create Pool: Request</title> <title>Create Pool: Request</title>
<programlisting> <programlisting>
@ -1014,8 +1014,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>), <simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara> (<errorcode>409</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 does not return a response body. </para> <para>This operation does not return a response body.</para>
<example> <example>
<title>Delete Pool: Request</title> <title>Delete Pool: Request</title>
<programlisting> <programlisting>
@ -1290,8 +1290,8 @@ Content-Type: application/json; charset=UTF-8
</para> </para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>), <simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara> Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para> <para>This operation requires a request body.</para>
<para>This operation returns a response body. </para> <para>This operation returns a response body.</para>
<example> <example>
<title>Create Member: Request</title> <title>Create Member: Request</title>
<programlisting> <programlisting>
@ -1384,8 +1384,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>), <simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara> (<errorcode>409</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 does not return a response body. </para> <para>This operation does not return a response body.</para>
<example> <example>
<title>Delete Member: Request</title> <title>Delete Member: Request</title>
<programlisting> <programlisting>
@ -1487,7 +1487,7 @@ Content-Length: 0
<td>CRU</td> <td>CRU</td>
<td>None</td> <td>None</td>
<td>non-negative</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>
<tr> <tr>
<td>timeout</td> <td>timeout</td>
@ -1496,7 +1496,7 @@ Content-Length: 0
<td>CRU</td> <td>CRU</td>
<td>None</td> <td>None</td>
<td>non-negative</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>
<tr> <tr>
<td>max_retries</td> <td>max_retries</td>
@ -1685,8 +1685,8 @@ Content-Type: application/json; charset=UTF-8
</para> </para>
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>), <simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Bad Request (<errorcode>400</errorcode>)</simpara> Bad Request (<errorcode>400</errorcode>)</simpara>
<para>This operation requires a request body. </para> <para>This operation requires a request body.</para>
<para>This operation returns a response body. </para> <para>This operation returns a response body.</para>
<example> <example>
<title>Create Health Monitor: Request</title> <title>Create Health Monitor: Request</title>
<programlisting> <programlisting>
@ -1779,8 +1779,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>), <simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara> (<errorcode>409</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 does not return a response body. </para> <para>This operation does not return a response body.</para>
<example> <example>
<title>Delete Health Monitor: Request</title> <title>Delete Health Monitor: Request</title>
<programlisting> <programlisting>
@ -1870,8 +1870,8 @@ Content-Type: application/json; charset=UTF-8
<simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>), <simpara>Error Response Codes: Unauthorized (<errorcode>401</errorcode>),
Not Found (<errorcode>404</errorcode>), Conflict Not Found (<errorcode>404</errorcode>), Conflict
(<errorcode>409</errorcode>)</simpara> (<errorcode>409</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 does not return a response body. </para> <para>This operation does not return a response body.</para>
<example> <example>
<title>Disassociate Health Monitor: Request</title> <title>Disassociate Health Monitor: Request</title>
<programlisting> <programlisting>

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

@ -121,7 +121,7 @@
<simpara>Error Response Codes: Unauthorized <simpara>Error Response Codes: Unauthorized
(<errorcode>401</errorcode>), Forbidden (<errorcode>401</errorcode>), Forbidden
(<errorcode>403</errorcode>)</simpara> (<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> <para>This operation returns a response body.</para>
<example> <example>
<title>List Networks on DHCP agent: JSON Request</title> <title>List Networks on DHCP agent: JSON Request</title>
@ -354,7 +354,7 @@ X-Auth-Token: 7ae91cde8f504031be5a2cd5b99d4fe9
<simpara>Error Response Codes: Unauthorized <simpara>Error Response Codes: Unauthorized
(<errorcode>401</errorcode>), Forbidden (<errorcode>401</errorcode>), Forbidden
(<errorcode>403</errorcode>)</simpara> (<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> <para>This operation returns a response body.</para>
<example> <example>
<title>List Routers on L3 agent: JSON Request</title> <title>List Routers on L3 agent: JSON Request</title>
@ -580,7 +580,7 @@ X-Auth-Token: 2147ef6fe4444f0299b1c0b6b529ff47
<simpara>Error Response Codes: Unauthorized <simpara>Error Response Codes: Unauthorized
(<errorcode>401</errorcode>), Forbidden (<errorcode>401</errorcode>), Forbidden
(<errorcode>403</errorcode>)</simpara> (<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> <para>This operation returns a response body.</para>
<example> <example>
<title>List Pools on LBaaS agent: JSON Request</title> <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> <title>Security Groups and Rules</title>
<para>Creates, modifies, and deletes OpenStack Networking security groups and <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"/> <wadl:resources href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/netconn-api/src/security-groups.wadl"/>
</section> </section>

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

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

8
v2.0/section_neutron_binding_ext_ports.xml
View File

@ -58,9 +58,9 @@
<col width="20%"/> <col width="20%"/>
<thead> <thead>
<tr> <tr>
<th>Attribute </th> <th>Attribute</th>
<th>Type </th> <th>Type</th>
<th>Required </th> <th>Required</th>
<th>CRUD<footnote xml:id="crud_network"> <th>CRUD<footnote xml:id="crud_network">
<para><itemizedlist> <para><itemizedlist>
<listitem> <listitem>
@ -268,7 +268,7 @@
(<errorcode>401</errorcode>), Not Found (<errorcode>401</errorcode>), Not Found
(<errorcode>404</errorcode>)</simpara> (<errorcode>404</errorcode>)</simpara>
<para>This operation returns information for the port <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 does not require a request body.</para>
<para>This operation returns a response body.</para> <para>This operation returns a response body.</para>
<para>In addition to any fields returned in the show port <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%"/> <col width="20%"/>
<thead> <thead>
<tr> <tr>
<th>Attribute </th> <th>Attribute</th>
<th>Type </th> <th>Type</th>
<th>Required </th> <th>Required</th>
<th>CRUD<footnote xml:id="crud"> <th>CRUD<footnote xml:id="crud">
<para><itemizedlist> <para><itemizedlist>
<listitem> <listitem>
@ -111,8 +111,8 @@
</listitem> </listitem>
</itemizedlist></para> </itemizedlist></para>
</footnote></th> </footnote></th>
<th>Default Value </th> <th>Default Value</th>
<th>Validation Constraints </th> <th>Validation Constraints</th>
<th>Notes</th> <th>Notes</th>
</tr> </tr>
</thead> </thead>
@ -179,7 +179,7 @@
<td>R</td> <td>R</td>
<td>Empty List</td> <td>Empty List</td>
<td>N/A</td> <td>N/A</td>
<td>subnets associated with this network. </td> <td>subnets associated with this network.</td>
</tr> </tr>
<tr> <tr>
<td>shared</td> <td>shared</td>
@ -206,7 +206,7 @@
<td>N/A</td> <td>N/A</td>
<td>No constraint</td> <td>No constraint</td>
<td>Owner of network. Only admin users can specify <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>
</tbody> </tbody>
</table> </table>
@ -236,9 +236,9 @@
<col width="20%"/> <col width="20%"/>
<thead> <thead>
<tr> <tr>
<th>Attribute </th> <th>Attribute</th>
<th>Type </th> <th>Type</th>
<th>Required </th> <th>Required</th>
<th>CRUD<footnote xml:id="crud2"> <th>CRUD<footnote xml:id="crud2">
<para><itemizedlist> <para><itemizedlist>
<listitem> <listitem>
@ -265,8 +265,8 @@
</itemizedlist></para> </itemizedlist></para>
</footnote> </footnote>
</th> </th>
<th>Default Value </th> <th>Default Value</th>
<th>Validation Constraints </th> <th>Validation Constraints</th>
<th>Notes</th> <th>Notes</th>
</tr> </tr>
</thead> </thead>
@ -392,7 +392,7 @@
<td>N/A</td> <td>N/A</td>
<td>No constraint</td> <td>No constraint</td>
<td>Owner of network. Only admin users can specify <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>
</tbody> </tbody>
</table> </table>
@ -420,9 +420,9 @@
<col width="20%"/> <col width="20%"/>
<thead> <thead>
<tr> <tr>
<th>Attribute </th> <th>Attribute</th>
<th>Type </th> <th>Type</th>
<th>Required </th> <th>Required</th>
<th>CRUD<footnote xml:id="crud3"> <th>CRUD<footnote xml:id="crud3">
<para><itemizedlist> <para><itemizedlist>
<listitem> <listitem>
@ -449,8 +449,8 @@
</itemizedlist></para> </itemizedlist></para>
</footnote> </footnote>
</th> </th>
<th>Default Value </th> <th>Default Value</th>
<th>Validation Constraints </th> <th>Validation Constraints</th>
<th>Notes</th> <th>Notes</th>
</tr> </tr>
</thead> </thead>
@ -492,7 +492,7 @@
<td>true</td> <td>true</td>
<td>{true|false}</td> <td>{true|false}</td>
<td>Administrative state of port. If false (down), <td>Administrative state of port. If false (down),
port does not forward packets. </td> port does not forward packets.</td>
</tr> </tr>
<tr> <tr>
<td>status</td> <td>status</td>
@ -576,7 +576,7 @@
<td>N/A</td> <td>N/A</td>
<td>No constraint</td> <td>No constraint</td>
<td>Owner of network. Only admin users can specify <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>
<tr> <tr>
<td>security_groups</td> <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 user submitting the request is authorized to see provider
networks mapping, this operation allows for specifying how networks mapping, this operation allows for specifying how
an existing network should be mapped on the underlying 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 <para>If the user submitting the request is not allowed to set
provider networks attributes, a 403 Forbidden response is provider networks attributes, a 403 Forbidden response is
returned.</para> returned.</para>

2
v2.0/section_provider_extended_attrs.xml
View File

@ -39,7 +39,7 @@
networks enables administrative users to specify how network networks enables administrative users to specify how network
objects map to the underlying networking infrastructure. These objects map to the underlying networking infrastructure. These
extended attributes also appear when administrative users extended attributes also appear when administrative users
query networks. </para> query networks.</para>
<para>The technology back end of the particular plug-in determines <para>The technology back end of the particular plug-in determines
the semantics of these attributes. To understand which values the semantics of these attributes. To understand which values
to specify for each attribute when you deploy &APIv2; with a 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"> title="Create Metering Label">
<para role="shortdesc">Creates a l3 metering label. <para role="shortdesc">Creates a l3 metering label.
</para> </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 <para>The following table describes the required and
optional attributes in the request body:</para> optional attributes in the request body:</para>
<table width="75%" rules="all"><caption>Create Metering Label <table width="75%" rules="all"><caption>Create Metering Label
@ -197,7 +197,7 @@
<para>This operation deletes a l3 metering label. <para>This operation deletes a l3 metering label.
</para> </para>
<para>This operation does not require a request body. This <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> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -239,7 +239,7 @@
<para>The list provides the unique ID for each metering <para>The list provides the unique ID for each metering
label rule.</para> label rule.</para>
<para>This operation does not require a request body. This <para>This operation does not require a request body. This
operation returns a response body. </para> operation returns a response body.</para>
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">
@ -272,7 +272,7 @@
title="Create Metering Label Rule"> title="Create Metering Label Rule">
<para role="shortdesc">Creates a l3 metering label rule. <para role="shortdesc">Creates a l3 metering label rule.
</para> </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 <para>The following table describes the required and
optional attributes in the request body:</para> optional attributes in the request body:</para>
<table width="75%" rules="all"><caption>Create Metering Label <table width="75%" rules="all"><caption>Create Metering Label
@ -302,7 +302,7 @@
remote IP prefix to be associated with remote IP prefix to be associated with
this metering rule. this metering rule.
packet.</para></td></tr></tbody></table> packet.</para></td></tr></tbody></table>
<para>This operation returns a response body. </para> <para>This operation returns a response body.</para>
</wadl:doc> </wadl:doc>
<request> <request>
<representation mediaType="application/json"> <representation mediaType="application/json">

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

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

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

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