Merge "Remove extra whitespace"
This commit is contained in:
Jenkins
Gerrit Code Review
commit
e111f5dffa
File diff suppressed because it is too large
Load Diff
@ -1,2 +1,2 @@
|
||||
<attachment
|
||||
id="test_interface_identifier"/>
|
||||
id="test_interface_identifier"/>
|
||||
|
||||
@ -3,11 +3,11 @@
|
||||
name="test_network">
|
||||
<ports>
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
status="DOWN"/>
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
status="DOWN"/>
|
||||
<port
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"
|
||||
status="ACTIVE">
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"
|
||||
status="ACTIVE">
|
||||
<attachment id="test_interface_identifier"/>
|
||||
</port>
|
||||
</ports>
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
<networks>
|
||||
<network
|
||||
id="8bec1293-16bd-4568-ba75-1f58bec0b4c3"
|
||||
id="8bec1293-16bd-4568-ba75-1f58bec0b4c3"
|
||||
name="network_1"/>
|
||||
<network
|
||||
id="2a39409c-7146-4501-8429-3579e03e9b56"
|
||||
id="2a39409c-7146-4501-8429-3579e03e9b56"
|
||||
name="network_2"/>
|
||||
</networks>
|
||||
@ -2,5 +2,5 @@
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
state="DOWN">
|
||||
<attachment
|
||||
id="test_interface_identifier"/>
|
||||
id="test_interface_identifier"/>
|
||||
</port>
|
||||
@ -1,2 +1,2 @@
|
||||
<port
|
||||
state="ACTIVE"/>
|
||||
state="ACTIVE"/>
|
||||
|
||||
@ -1,2 +1,2 @@
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
<ports>
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
state="ACTIVE"/>
|
||||
<port
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"
|
||||
state="ACTIVE"/>
|
||||
</ports>
|
||||
@ -1,6 +1,6 @@
|
||||
<ports>
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
<port
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"/>
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"/>
|
||||
</ports>
|
||||
@ -2,5 +2,5 @@
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
state="DOWN">
|
||||
<attachment
|
||||
id="test_interface_identifier"/>
|
||||
id="test_interface_identifier"/>
|
||||
</port>
|
||||
@ -1,2 +1,2 @@
|
||||
<port
|
||||
state="ACTIVE"/>
|
||||
state="ACTIVE"/>
|
||||
|
||||
@ -1,2 +1,2 @@
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
<ports>
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
state="ACTIVE"/>
|
||||
<port
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"
|
||||
state="ACTIVE"/>
|
||||
</ports>
|
||||
@ -1,6 +1,6 @@
|
||||
<ports>
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
<port
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"/>
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"/>
|
||||
</ports>
|
||||
@ -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>
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -1,2 +1,2 @@
|
||||
<attachment
|
||||
id="test_interface_identifier"/>
|
||||
id="test_interface_identifier"/>
|
||||
|
||||
@ -3,11 +3,11 @@
|
||||
name="test_network">
|
||||
<ports>
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
status="DOWN"/>
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
status="DOWN"/>
|
||||
<port
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"
|
||||
status="ACTIVE">
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"
|
||||
status="ACTIVE">
|
||||
<attachment id="test_interface_identifier"/>
|
||||
</port>
|
||||
</ports>
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
<networks>
|
||||
<network
|
||||
id="8bec1293-16bd-4568-ba75-1f58bec0b4c3"
|
||||
id="8bec1293-16bd-4568-ba75-1f58bec0b4c3"
|
||||
name="network_1"/>
|
||||
<network
|
||||
id="2a39409c-7146-4501-8429-3579e03e9b56"
|
||||
id="2a39409c-7146-4501-8429-3579e03e9b56"
|
||||
name="network_2"/>
|
||||
</networks>
|
||||
@ -2,5 +2,5 @@
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
state="DOWN">
|
||||
<attachment
|
||||
id="test_interface_identifier"/>
|
||||
id="test_interface_identifier"/>
|
||||
</port>
|
||||
@ -1,2 +1,2 @@
|
||||
<port
|
||||
state="ACTIVE"/>
|
||||
state="ACTIVE"/>
|
||||
|
||||
@ -1,2 +1,2 @@
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
<ports>
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
state="ACTIVE"/>
|
||||
<port
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"
|
||||
state="ACTIVE"/>
|
||||
</ports>
|
||||
@ -1,6 +1,6 @@
|
||||
<ports>
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
<port
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"/>
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"/>
|
||||
</ports>
|
||||
@ -2,5 +2,5 @@
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
state="DOWN">
|
||||
<attachment
|
||||
id="test_interface_identifier"/>
|
||||
id="test_interface_identifier"/>
|
||||
</port>
|
||||
@ -1,2 +1,2 @@
|
||||
<port
|
||||
state="ACTIVE"/>
|
||||
state="ACTIVE"/>
|
||||
|
||||
@ -1,2 +1,2 @@
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
<ports>
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"
|
||||
state="ACTIVE"/>
|
||||
<port
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"
|
||||
state="ACTIVE"/>
|
||||
</ports>
|
||||
@ -1,6 +1,6 @@
|
||||
<ports>
|
||||
<port
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
id="98017ddc-efc8-4c25-a915-774b2a633855"/>
|
||||
<port
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"/>
|
||||
id="b832be00-6553-4f69-af33-acd554e36d08"/>
|
||||
</ports>
|
||||
@ -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
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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">
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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": <external_network_uuid>
|
||||
}</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&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>
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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>
|
||||
|
||||
@ -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
|
||||
|
||||
@ -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">
|
||||
|
||||
@ -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"
|
||||
|
||||
@ -62,7 +62,6 @@
|
||||
</resource>
|
||||
</resources>
|
||||
|
||||
|
||||
<!--*******************************************************-->
|
||||
<!-- All Methods -->
|
||||
<!--*******************************************************-->
|
||||
|
||||
@ -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.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user