5aae2e5f73
Removed wadl files - the source wadl files are in api-site I'll fix wadl files in api-site Closes-Bug: #1264347 Change-Id: I62db5f663e6e390cce0d7e3cc413cebb7b508bb1 author: diane fleming
619 lines
35 KiB
Plaintext
619 lines
35 KiB
Plaintext
<!--
|
|
A collection of common faults, these are pretty much expected
|
|
in every request.
|
|
-->
|
|
<!ENTITY commonFaults
|
|
'
|
|
<response xmlns="http://wadl.dev.java.net/2009/02">
|
|
|
|
<representation mediaType="application/xml" element="csapi:computeFault"/>
|
|
<representation mediaType="application/json"/>
|
|
</response> '>
|
|
<!ENTITY fault503
|
|
'
|
|
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:serviceUnavailable"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
|
|
<!ENTITY fault503macGeneration
|
|
'
|
|
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:macGenerationFailure"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!ENTITY fault400
|
|
'
|
|
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:badRequest"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!ENTITY fault401
|
|
'
|
|
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:unauthorized"/>
|
|
<representation mediaType="application/json"/>
|
|
</response> '>
|
|
<!ENTITY fault403
|
|
' <response status="403" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:forbidden"/>
|
|
<representation mediaType="application/json"/>
|
|
</response> '>
|
|
<!ENTITY fault404
|
|
'
|
|
<response status="404" xmlns="http://wadl.dev.java.net/2009/02">
|
|
|
|
<representation mediaType="application/xml" element="csapi:itemNotFound"/>
|
|
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!ENTITY fault405
|
|
' <response status="405" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:badMethod"/>
|
|
<representation mediaType="application/json"/>
|
|
</response> '>
|
|
<!ENTITY fault409
|
|
'
|
|
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
|
|
|
|
<representation mediaType="application/xml" element="osapi:buildInProgress"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!ENTITY fault409networkInUse
|
|
'
|
|
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
|
|
|
|
<representation mediaType="application/xml" element="csapi:networkInUse"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!ENTITY fault409conflict
|
|
'
|
|
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
|
|
|
|
<representation mediaType="application/xml" element="csapi:conflict"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!ENTITY fault413
|
|
' <response status="413" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:overLimit"/>
|
|
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
|
|
<!ENTITY fault415
|
|
'
|
|
<response status="415" xmlns="http://wadl.dev.java.net/2009/02">
|
|
|
|
<representation mediaType="application/xml" element="csapi:badMediaType"/>
|
|
<representation mediaType="application/json"/>
|
|
</response>'>
|
|
<!ENTITY fault422
|
|
'<response status="422" xmlns="http://wadl.dev.java.net/2009/02">
|
|
<representation mediaType="application/xml" element="csapi:HTTPUnprocessableEntity"/>
|
|
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!--
|
|
Faults that can occur when we are building servers or images.
|
|
-->
|
|
<!ENTITY buildFaults
|
|
'
|
|
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
|
|
|
|
<representation mediaType="application/xml" element="csapi:serverCapacityUnavailable"/>
|
|
|
|
<representation mediaType="application/json"/>
|
|
</response>
|
|
'>
|
|
<!--
|
|
Holds build in progress which occurs when an operation fails
|
|
because the server is in the process of being built.
|
|
-->
|
|
|
|
|
|
<!ENTITY networkListParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="admin_state_up" 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 administrative state of the network.</para></wadl:doc>
|
|
</param>
|
|
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
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>
|
|
</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>
|
|
</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>
|
|
</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>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="subnets" style="plain" type="xsd:dict">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>The associated subnets.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
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 tenant ID.</para></wadl:doc>
|
|
</param>
|
|
'>
|
|
<!-- Network Create Parameters -->
|
|
<!ENTITY networkCreateParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="admin_state_up" 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 administrative state of the network.</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>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
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>Admin-only. Indicates whether this network is shared across all tenants.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
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 that owns the network. Only administrative users can specify a tenant ID other than their own. You cannot change this value through authorization policies.</para></wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
<!-- Network Provider Parameters -->
|
|
<!ENTITY networkProviderParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="provider:physical_network" 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 physical network where this network object is implemented. The Networking API v2.0 does not provide a way to list available physical networks. For example, the Open vSwitch plug-in configuration file defines a symbolic name that maps to specific bridges on each Compute host.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="provider:network_type" 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 type of physical network that maps to this network resource. Examples are flat, vlan, vxlan, and gre.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="provider:segmentation_id" 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>An isolated segment on the physical network. The network_type attribute defines the segmentation model. For example, if network_type is vlan, this ID is a vlan identifier. If network_type is gre, this ID is a gre key.</para></wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
<!ENTITY portListParameters
|
|
'
|
|
<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 port status. Value is UP or DOWN.</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 port name.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="admin_state_up" 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 administrative state of the router.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="network_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 attached network.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
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>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="binding:vif_type" 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 VIF type.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="device_owner" 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 ID of the entity that uses this port. For example, a dhcp agent.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="binding:capabilities" 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 binding capabilities.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="port_filter" 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 port filter.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="mac_address" 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 MAC address of the port.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="fixed_ips" style="plain" type="xsd:dict">
|
|
<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. </para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
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 ID of the port.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="device_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 device that uses this port. For example, a virtual server.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="security_groups" 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 IDs of any attached security groups.</para></wadl:doc>
|
|
</param>
|
|
'>
|
|
<!-- Port Create Parameters -->
|
|
<!ENTITY portCreateParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
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 status of the port.</para></wadl:doc>
|
|
</param>
|
|
<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">
|
|
<para>A symbolic name for the port.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="admin_state_up" 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 administrative status of the router. Set to true for UP. Set to false for DOWN.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
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>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="mac_address" 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 MAC address. If you specify an address that is not valid, a 400 Bad Request error is returned. If you do not specify a MAC address, OpenStack Networking tries to allocate one. If a failure occurs, a 503 Service Unavailable error is returned.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="fixed_ips" style="plain" type="xsd:dict">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>If you specify only a subnet ID, OpenStack Networking allocates an available IP from that subnet to the port. If you specify both a subnet ID and an IP address, OpenStack Networking tries to allocate the specified address to the port.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="security_groups" 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>Security groups. Specify one or more security group IDs.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="network_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 The network ID.</para></wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
<!-- Port binding Parameters -->
|
|
|
|
<!ENTITY portBindingParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="binding:vif_type" 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>Read-only. The The vif type for the specified port.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="binding:host_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 host where the port is allocated. In some cases, different implementations can run on different hosts.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="binding:profile" style="plain" type="xsd:dict">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>A dictionary the enables the application running on the specified host to pass and receive vif port-specific information to the plug-in.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="binding:capabilities" style="plain" type="xsd:dict">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Read-only. A dictionary that enables the application to pass information about functions that the Networking API povides. Specify the following value: port_filter : Boolean to define whether port filtering features such as security group and anti-MAC/IP spoofing are provided.</para></wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
<!-- Subnet Parameters -->
|
|
|
|
<!ENTITY subnetListParameters
|
|
'
|
|
<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 subnet name.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="network_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 attached network.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
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>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="allocation_pools" style="plain" type="xsd:dict">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>The start and end addresses for the allocation pools.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="gateway_ip" 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 gateway IP address.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="ip_version" 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 IP version, which is 4 or 6.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="cidr" 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 CIDR.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
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 ID of the subnet.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
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>
|
|
</param>
|
|
'>
|
|
|
|
<!-- 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">
|
|
<para>The subnet name.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="network_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 attached network.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
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>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="allocation_pools" style="plain" type="xsd:dict">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<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="gateway_ip" 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 gateway IP address.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
name="ip_version" 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 IP version, which is 4 or 6.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
|
|
name="cidr" 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 CIDR.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" required="false"
|
|
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 ID of the subnet.</para></wadl:doc>
|
|
</param>
|
|
<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>
|
|
</param>
|
|
'>
|
|
|
|
<!-- Server List Parameters -->
|
|
|
|
<!ENTITY serverListParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="changes-since" style="query" required="false" type="xsd:dateTime">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>A time/date stamp for when the server last changed status.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="image" style="query" required="false" type="xsd:anyURI">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Name of the image in URL format.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="flavor" style="query" required="false" type="xsd:anyURI">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Name of the flavor in URL format.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="name" style"query" required="false" 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 server as a string.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="marker" style="query" required="false" type="csapi:UUID">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>UUID of the server at which you want to set a marker.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="limit" style="query" required="false" type="xsd:int">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Integer value for the limit of values to return.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="status" style="query" required="false" type="csapi:ServerStatus">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Value of the status of the server so that you can filter on "ACTIVE" for example.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="host" style"query" required="false" 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 host as a string.</para></wadl:doc>
|
|
</param>
|
|
|
|
'>
|
|
|
|
<!-- Flavor List Parameters -->
|
|
|
|
<!ENTITY flavorListParameters
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="changes-since" style="query" required="false" type="xsd:dateTime">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>A time/date stamp for when the flavor last changed.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="minDisk" style="query" required="false" type="xsd:int">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Integer value for the minimum disk space in GB so you can filter results.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="minRam" style="query" required="false" type="xsd:int">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Integer value for the minimum RAM so you can filter results.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="marker" style="query" required="false" type="csapi:UUID">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>UUID of the flavor at which you want to set a marker.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02"
|
|
name="limit" style="query" required="false" type="xsd:int">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
|
<para>Integer value for the limit of values to return.</para></wadl:doc>
|
|
</param>
|
|
'>
|
|
|
|
<!ENTITY securityGroupRule
|
|
'
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="security_group_rules"
|
|
type="xsd:string" required="true">
|
|
<wadl:doc xml:lang="EN" xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para>Security group rule object.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="direction"
|
|
type="xsd:string" required="true">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para>Either ingress or egress.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="ethertype"
|
|
type="xsd:string" required="true">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para>Either IPv4 or IPv6.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="id"
|
|
type="csapi:uuid" required="true">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para>The ID for the security group rule.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="port_range_max"
|
|
type="xsd:string" required="true">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para>The maximum port ranges. Set to
|
|
null.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="port_range_min"
|
|
type="xsd:string" required="true">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para>The minimum port ranges. Set to
|
|
null.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="protocol"
|
|
type="xsd:string" required="true">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para>The protocol. Set to null.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="remote_group_id"
|
|
type="xsd:string" required="true">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para>The remote group ID. Set to
|
|
null.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="remote_ip_prefix"
|
|
type="xsd:string" required="true">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para>The remote IP prefix. Set to
|
|
null.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="security_group_id"
|
|
type="csapi:uuid" required="true">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para>The security group ID for the security group with
|
|
which the rule is
|
|
associated.</para></wadl:doc>
|
|
</param>
|
|
<param xmlns="http://wadl.dev.java.net/2009/02" name="tenant_id"
|
|
type="xsd:string" required="true">
|
|
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN"
|
|
xmlns="http://docbook.org/ns/docbook">
|
|
<para>The tenant ID.</para></wadl:doc>
|
|
</param>'>
|
|
<!-- Useful for describing APIs -->
|
|
|
|
<!ENTITY GET '<command xmlns="http://docbook.org/ns/docbook">GET</command>'>
|
|
<!ENTITY PUT '<command xmlns="http://docbook.org/ns/docbook">PUT</command>'>
|
|
<!ENTITY POST '<command xmlns="http://docbook.org/ns/docbook">POST</command>'>
|
|
<!ENTITY DELETE '<command xmlns="http://docbook.org/ns/docbook">DELETE</command>'>
|