Merge "Correct description of response parameters Some description of response parameters are incorrect for calls of "health monitors"(getlist,show,create,update). "The unique ID for the VIP." should be as below: "The unique ID for the Health Monitor" "The ID of the tenant who owns the VIP..." should be as below: "The ID of the tenant who owns the Health Monitor...""
This commit is contained in:
@@ -173,25 +173,37 @@
|
||||
name="id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The network ID.</para></wadl:doc>
|
||||
<para>
|
||||
The network ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="name" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The network name.</para></wadl:doc>
|
||||
<para>
|
||||
The network name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="shared" style="plain" type="xsd:bool">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Indicates whether this network is shared across all tenants.</para></wadl:doc>
|
||||
<para>
|
||||
Indicates whether this network is shared across all tenants.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="status" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The network status.</para></wadl:doc>
|
||||
<para>
|
||||
The network status.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="subnets" style="plain" type="xsd:dict">
|
||||
@@ -215,7 +227,7 @@
|
||||
name="mtu" style="plain" type="xsd:integer">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>MTU of a network resource.</para></wadl:doc>
|
||||
<para>The MTU of a network resource.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="port_security_enabled" style="plain" type="xsd:bool">
|
||||
@@ -382,8 +394,11 @@
|
||||
name="vlan_transparent" style="plain" type="xsd:bool">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The state of the network, which is VLAN transparent (<code>true</code>)
|
||||
or not VLAN transparent (<code>false</code>).</para></wadl:doc>
|
||||
<para>
|
||||
The state of the network, which is VLAN transparent
|
||||
(<code>true</code>) or not VLAN transparent (<code>false</code>).
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY portObject '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
@@ -691,8 +706,8 @@
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
IP addresses for the port. Includes the IP address and subnet
|
||||
ID.
|
||||
The IP addresses for the port. Includes the IP address and
|
||||
subnet ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@@ -701,7 +716,7 @@
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
Subnet ID of the subnet to which the port is attached.
|
||||
The ID of the subnet to which the port is attached.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@@ -710,7 +725,7 @@
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
IP address.
|
||||
The IP address.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@@ -763,7 +778,7 @@
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>
|
||||
The port status. Value is ACTIVE or DOWN.
|
||||
The port status. Value is <code>ACTIVE</code> or <code>DOWN</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@@ -852,28 +867,22 @@
|
||||
virtual server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
</param>'>
|
||||
<!ENTITY portCreateRequestParams '
|
||||
&portObject;
|
||||
&portCommonRequestParams;
|
||||
'>
|
||||
&portCommonRequestParams;'>
|
||||
<!ENTITY portCreateResponseParams '
|
||||
&portObject;
|
||||
&portCommonResponseParams;
|
||||
'>
|
||||
&portCommonResponseParams;'>
|
||||
<!ENTITY portShowResponseParams '
|
||||
&portObject;
|
||||
&portCommonResponseParams;
|
||||
'>
|
||||
&portCommonResponseParams;'>
|
||||
<!ENTITY portUpdateRequestParams '
|
||||
&portObject;
|
||||
&portCommonRequestParams;
|
||||
'>
|
||||
&portCommonRequestParams;'>
|
||||
<!ENTITY portUpdateResponseParams '
|
||||
&portObject;
|
||||
&portCommonResponseParams;
|
||||
'>
|
||||
&portCommonResponseParams;'>
|
||||
<!ENTITY portBindingRequestParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="binding:host_id" style="plain" type="csapi:uuid">
|
||||
@@ -907,8 +916,7 @@
|
||||
<code>direct</code>, or <code>macvtap</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
</param>'>
|
||||
<!ENTITY portBindingResponseParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="binding:host_id" style="plain" type="csapi:uuid">
|
||||
@@ -1005,8 +1013,7 @@
|
||||
attribute is visible to only port owners and administrative users.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
</param>'>
|
||||
<!-- Subnet Parameters -->
|
||||
<!ENTITY subnetListParameters
|
||||
'<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
@@ -1025,10 +1032,11 @@
|
||||
name="tenant_id" style="plain" type="csapi:uuid">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The ID of the tenant who owns the network. Only
|
||||
administrative users can specify a tenant ID other than their
|
||||
own.</para>
|
||||
</wadl:doc>
|
||||
<para>
|
||||
The ID of the tenant who owns the network. Only administrative
|
||||
users can specify a tenant ID other than their own.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="allocation_pools" style="plain" type="xsd:dict">
|
||||
@@ -1074,19 +1082,24 @@
|
||||
name="enable_dhcp" style="plain" type="xsd:boolean">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Set to true if DHCP is enabled and false if DHCP is disabled.</para></wadl:doc>
|
||||
<para>
|
||||
Set to <code>true</code> if DHCP is enabled and
|
||||
<code>false</code> if DHCP is disabled.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="dns_nameservers" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>DNS server.</para></wadl:doc>
|
||||
<para>The DNS server.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="host_routes" style="plain" type="xsd:list">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>A list of host route dictionaries for the subnet.
|
||||
For example:</para>
|
||||
<programlisting>"host_routes":[
|
||||
<para>
|
||||
A list of host route dictionaries for the subnet. For example:
|
||||
</para>
|
||||
<programlisting>"host_routes":[
|
||||
{
|
||||
"destination":"0.0.0.0/0",
|
||||
"nexthop":"123.456.78.9"
|
||||
@@ -1095,12 +1108,13 @@
|
||||
"destination":"192.168.0.0/24",
|
||||
"nexthop":"192.168.0.1"
|
||||
}
|
||||
]</programlisting></wadl:doc>
|
||||
]</programlisting>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="destination" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Destination for static route.</para></wadl:doc>
|
||||
<para>The destination for static route.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="nexthop" style="plain" type="xsd:string">
|
||||
@@ -1124,12 +1138,12 @@
|
||||
<code>dhcpv6-stateless</code>, or <code>slaac</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
<!ENTITY subnetListQueryParameters '<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
</param>'>
|
||||
<!ENTITY subnetListQueryParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="display_name" style="query" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Name of the network.</para></wadl:doc>
|
||||
<para>The name of the network.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="network_id" style="query" type="csapi:uuid">
|
||||
@@ -1160,19 +1174,34 @@
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="enable_dhcp" style="query" type="xsd:boolean">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>If true, DHCP is enabled and If false, DHCP is disabled.</para></wadl:doc>
|
||||
<para>
|
||||
If <code>true</code>, DHCP is enabled. If <code>false</code>, DHCP
|
||||
is disabled.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="ipv6_ra_mode" style="query" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Choose from (constants.IPV6_SLAAC,constants.DHCPV6_STATEFUL,constants.DHCPV6_STATELESS,name='ipv6_address_modes,null).</para></wadl:doc>
|
||||
<para>
|
||||
Choose from <code>constants.IPV6_SLAAC</code>,
|
||||
<code>constants.DHCPV6_STATEFUL</code>, <code>constants.DHCPV6_STATELESS</code>,
|
||||
<code>name='ipv6_address_modes</code>, or <code>null</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="ipv6_address_mode" style="query" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Choose from (constants.IPV6_SLAAC,constants.DHCPV6_STATEFUL,constants.DHCPV6_STATELESS,name='ipv6_address_modes,null).</para></wadl:doc>
|
||||
<para>
|
||||
Choose from <code>constants.IPV6_SLAAC</code>,
|
||||
<code>constants.DHCPV6_STATEFUL</code>,
|
||||
<code>constants.DHCPV6_STATELESS</code>,
|
||||
<code>name='ipv6_address_modes</code>, or <code>null</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!-- Subnet Create Parameters -->
|
||||
<!-- Subnet Create Parameters -->
|
||||
<!ENTITY subnetCreateParameters '<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="name" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
@@ -1190,7 +1219,7 @@
|
||||
<para>The start and end addresses for the allocation pools.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="start" style="plain" type="xsd:string">
|
||||
name="start" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The start address for the allocation pools.</para></wadl:doc>
|
||||
</param>
|
||||
@@ -1217,7 +1246,7 @@
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="enable_dhcp" style="plain" type="xsd:boolean">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Set to true if DHCP is enabled and false if DHCP is disabled.</para></wadl:doc>
|
||||
<para>Set to <code>true</code> if DHCP is enabled and <code>false</code> if DHCP is disabled.</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="dns_nameservers" style="plain" type="xsd:list">
|
||||
@@ -1242,7 +1271,7 @@
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="destination" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Destination for static route</para></wadl:doc>
|
||||
<para>The destination for static route</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="nexthop" style="plain" type="xsd:string">
|
||||
@@ -1287,12 +1316,16 @@
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="enable_dhcp" style="plain" type="xsd:boolean">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Set to true if DHCP is enabled and false if DHCP is disabled.</para></wadl:doc>
|
||||
<para>
|
||||
Set to <code>true</code> if DHCP is enabled and <code>false</code>
|
||||
if DHCP is disabled.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="dns_nameservers" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>DNS server</para></wadl:doc>
|
||||
<para>The DNS server</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="host_routes" style="plain" type="xsd:list">
|
||||
@@ -1312,7 +1345,7 @@
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="destination" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>Destination for static route</para></wadl:doc>
|
||||
<para>The destination for static route</para></wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="nexthop" style="plain" type="xsd:string">
|
||||
@@ -1917,7 +1950,7 @@ router.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Description for the pool.</para>
|
||||
<para>The description for the pool.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
@@ -2028,7 +2061,7 @@ router.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Description for the pool.</para>
|
||||
<para>The description for the pool.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
@@ -2429,7 +2462,7 @@ router.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Description for the metering label.</para>
|
||||
<para>The description for the metering label.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
@@ -2612,7 +2645,7 @@ router.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The unique ID for the VIP.</para>
|
||||
<para>The unique ID for the health monitor.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
@@ -2621,8 +2654,8 @@ router.</para>
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The ID of the tenant who owns the VIP. Only administrative users can
|
||||
specify a tenant ID other than their own.
|
||||
The ID of the tenant who owns the health monitor. Only
|
||||
administrative users can specify a tenant ID other than their own.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@@ -2662,8 +2695,11 @@ router.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Number of allowed connection failures before changing
|
||||
the status of the member to INACTIVE. A valid value is from 1 to 10.</para>
|
||||
<para>
|
||||
The number of allowed connection failures before changing the status
|
||||
of the member to <code>INACTIVE</code>. A valid value is from 1 to
|
||||
10.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
@@ -2679,7 +2715,10 @@ router.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The HTTP path of the request sent by the monitor to test the health of a member. Must be a string beginning with a forward slash (/).</para>
|
||||
<para>
|
||||
The HTTP path of the request sent by the monitor to test the health
|
||||
of a member. Must be a string beginning with a forward slash (/).
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
@@ -2770,7 +2809,9 @@ router.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Path portion of URI that will be probed if type is HTTP(S).</para>
|
||||
<para>
|
||||
The path portion of URI that is probed if the type is HTTP or HTTPS.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
@@ -2778,7 +2819,9 @@ router.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Expected HTTP codes for a passing HTTP(S) monitor.</para>
|
||||
<para>
|
||||
The expected HTTP codes for a passing HTTP(S) monitor.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
@@ -3262,7 +3305,10 @@ router.</para>
|
||||
name="admin_state_up" style="plain" type="xsd:boolean">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The administrative state of the VIP. A valid value is true (UP) or false (DOWN).</para>
|
||||
<para>
|
||||
The administrative state of the VIP. A valid value is true (UP) or
|
||||
false (DOWN).
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>' >
|
||||
<!ENTITY vipUpdateRequestParams '
|
||||
@@ -3295,13 +3341,16 @@ router.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>
|
||||
Session persistence parameters for the VIP. Omit the
|
||||
<code>session_persistence</code> parameter to prevent session
|
||||
persistence. When no session persistence is used, the
|
||||
<code>session_persistence</code> parameter does not appear in the
|
||||
API response. To clear session persistence for the VIP, set the
|
||||
<code>session_persistence</code> parameter to <code>null</code> in a
|
||||
VIP update request.
|
||||
Session persistence parameters for the VIP. Omit the
|
||||
<code>session_persistence</code> parameter to prevent session
|
||||
persistence. When no session persistence is used, the
|
||||
<code>session_persistence</code> parameter does not appear in the
|
||||
API response.
|
||||
</para>
|
||||
<para>
|
||||
To clear session persistence for the VIP, set the
|
||||
<code>session_persistence</code> parameter to <code>null</code> in a
|
||||
VIP update request.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@@ -3605,7 +3654,10 @@ router.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>The HTTP path of the request sent by the monitor to test the health of a member. Must be a string beginning with a forward slash (/).</para>
|
||||
<para>
|
||||
The HTTP path of the request sent by the monitor to test the health
|
||||
of a member. Must be a string beginning with a forward slash (/).
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
@@ -3630,7 +3682,10 @@ router.</para>
|
||||
name="status" style="plain" type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The status of the health monitor. Indicates whether the health monitor is operational.</para>
|
||||
<para>
|
||||
The status of the health monitor. Indicates whether the health
|
||||
monitor is operational.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>' >
|
||||
<!ENTITY hmCreateRequestParams '
|
||||
@@ -3905,8 +3960,7 @@ router.</para>
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The administrative state of the member. A valid value is true (UP) or false (DOWN).</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY memberUpdateRequestParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="pool_id" style="plain" type="csapi:uuid">
|
||||
@@ -3935,8 +3989,7 @@ router.</para>
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
|
||||
<para>The administrative state of the member. A valid value is true (UP) or false (DOWN).</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY securityGroupParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="security_group" style="plain" type="xsd:dict">
|
||||
@@ -4057,8 +4110,7 @@ router.</para>
|
||||
A <code>security_group_rule</code> object.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
</param>'>
|
||||
<!ENTITY securityGroupRulesParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="security_group_rules" style="plain" type="xsd:dict">
|
||||
@@ -4068,8 +4120,7 @@ router.</para>
|
||||
A <code>security_group_rules</code> object.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
'>
|
||||
</param>'>
|
||||
<!ENTITY securityGroupRuleCommonResponseParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="direction" style="plain" type="xsd:string">
|
||||
@@ -4285,8 +4336,7 @@ router.</para>
|
||||
xml:lang="EN">
|
||||
<para>VPN service objects.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY svcCreateVPNServiceObjectParam '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="vpnservice" style="plain" type="xsd:dict">
|
||||
@@ -4402,8 +4452,7 @@ router.</para>
|
||||
<para>Router ID to which the VPN service is
|
||||
inserted.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY svcRequestParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="vpnservice" style="plain" type="xsd:dict">
|
||||
@@ -4441,8 +4490,7 @@ router.</para>
|
||||
connections on service are not active.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY ikeCreateRequestParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="tenant_id" style="plain" type="csapi:uuid">
|
||||
@@ -4454,8 +4502,7 @@ router.</para>
|
||||
tenant ID other than their own.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY ikeRequestParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="name" style="plain" type="xsd:string">
|
||||
@@ -4562,8 +4609,7 @@ router.</para>
|
||||
Lifetime value, as a positive integer. Default is 3600 seconds.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY ikeListResponseParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="ikepolicies" style="plain" type="xsd:list">
|
||||
@@ -4572,8 +4618,7 @@ router.</para>
|
||||
xml:lang="EN">
|
||||
<para>IKE policy objects.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY ikeResponseParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="id" style="plain" type="csapi:uuid">
|
||||
@@ -4700,8 +4745,7 @@ router.</para>
|
||||
Lifetime value, as a positive integer. Default is 3600 seconds.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY ipsecCreateRequestParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="tenant_id" style="plain" type="csapi:uuid">
|
||||
@@ -4713,8 +4757,7 @@ router.</para>
|
||||
tenant ID other than their own.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY ipsecRequestParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="name" style="plain" type="xsd:string">
|
||||
@@ -4823,8 +4866,7 @@ router.</para>
|
||||
Lifetime value, as a positive integer. Default is 3600 seconds.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY ipsecListResponseParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="ipsecpolicies" style="plain" type="xsd:list">
|
||||
@@ -4833,8 +4875,7 @@ router.</para>
|
||||
xml:lang="EN">
|
||||
<para>IPSec policy objects.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY ipsecResponseParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="id" style="plain" type="csapi:uuid">
|
||||
@@ -4956,8 +4997,7 @@ router.</para>
|
||||
xml:lang="EN">
|
||||
<para>Lifetime value, as a positive integer. Default is 3600 seconds.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY connCreateRequestParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="tenant_id" style="plain" type="csapi:uuid">
|
||||
@@ -5026,8 +5066,7 @@ router.</para>
|
||||
xml:lang="EN">
|
||||
<para>Unique identifier of VPN service.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY connRequestParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="name" style="plain" type="xsd:string">
|
||||
@@ -5119,7 +5158,7 @@ router.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Dictionary with dead peer detection (DPD) protocol controls.</para>
|
||||
<para>A dictionary with dead peer detection (DPD) protocol controls.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
@@ -5155,8 +5194,7 @@ router.</para>
|
||||
is greater than the DPD <code>interval</code> value. Default is 120.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY connListResponseParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="ipsec_site_connections" style="plain" type="xsd:list">
|
||||
@@ -5165,8 +5203,7 @@ router.</para>
|
||||
xml:lang="EN">
|
||||
<para>IPSec site-to-site connection objects.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY connResponseParams '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
name="id" style="plain" type="csapi:uuid">
|
||||
@@ -5337,7 +5374,7 @@ router.</para>
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>Dictionary with Dead Peer Detection protocol controls.</para>
|
||||
<para>A dictionary with Dead Peer Detection protocol controls.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
||||
@@ -5374,8 +5411,7 @@ router.</para>
|
||||
Default is 120.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
' >
|
||||
</param>'>
|
||||
<!ENTITY updateRouterParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
||||
name="routes" style="plain" type="xsd:dict">
|
||||
@@ -5511,9 +5547,8 @@ router.</para>
|
||||
merges adjacent prefixes and treats them as a single prefix.
|
||||
</para>
|
||||
<para>
|
||||
Ensure that each subnet prefix is unique among all subnet prefixes
|
||||
in all subnet pools that are associated with the specified address
|
||||
scope.
|
||||
Each subnet prefix must be unique among all subnet prefixes in all
|
||||
subnet pools that are associated with the specified address scope.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
@@ -5898,4 +5933,3 @@ router.</para>
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user