openstack/api-site
Code Issues Proposed changes
api-site/api-ref/src/wadls/compute-api/src/v2.1/common.ent
Kevin_Zheng 4569c31076 Merge scheduler-hints section of compute v2.1 API doc to servers section 
The v2.1 compute API doc now contains servers section,
the scheduler-hints section should be merged into the
servers section.

Change-Id: Ia88b77c8bdc4f06565807bdb91441da121fea29c
Closes-Bug: #1506698
2015-10-16 17:09:11 +00:00

2083 lines
73 KiB
Plaintext
Raw Blame History

<!--
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>
<response status="503" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:serviceUnavailable"/>
<representation mediaType="application/json"/>
</response>
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badRequest"/>
<representation mediaType="application/json"/>
</response>
<response status="401" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:unauthorized"/>
<representation mediaType="application/json"/>
</response>
<response status="403" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:forbidden"/>
<representation mediaType="application/json"/>
</response>
<response status="405" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badMethod"/>
<representation mediaType="application/json"/>
</response>
'>
<!-- Faults on GET -->
<!ENTITY getFaults '
<response status="404" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:itemNotFound"/>
<representation mediaType="application/json"/>
</response>'>
<!-- Faults on POST/PUT -->
<!ENTITY postPutFaults '
<response status="415" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:badMediaType"/>
<representation mediaType="application/json"/>
</response>
<response status="400" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:NetworkNotFound"/>
<representation mediaType="application/json"/>
</response>'>
<!ENTITY rebootFaults '
<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 fault501 '<response status="501" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:notImplemented"/>
<representation mediaType="application/json"/>
</response>'>
<!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 inProgressFault '
<response status="409" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:buildInProgress"/>
<representation mediaType="application/json"/>
</response>'>
<!-- For v2.1 x-openstack-request-id -->
<!ENTITY x-openstack-request-idHeader '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-OpenStack-Request-ID" style="header" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Returns a unique request ID that provides tracking for the
request. Provider must configure middleware to provide the request
ID.
</para>
</wadl:doc>
</param>'>
<!-- Image List Parameters -->
<!ENTITY imageListParameters '
&changes_since-QueryParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="server" style="query" required="false" type="xsd:anyURI">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Filters the results by a specified server name 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="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Filters the results by a specified server name in string format.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="status" style="query" required="false" type="csapi:ImageStatus">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Filters the results by a specified image status. For example,
<code>ACTIVE</code>.
</para>
</wadl:doc>
</param>
&limitMarkerReqParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="type" style="query" required="false" type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Filters the results by a specified image type. For example,
<code>BASE</code>, <code>SERVER</code>, or <code>ALL</code>.
</para>
</wadl:doc>
<option value="BASE"/>
<option value="SERVER"/>
<option value="ALL"/>
</param>'>
<!-- Server Create Parameters -->
<!ENTITY serverCreateParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="security_groups" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
One or more security groups. Specify the name of the security group in
the <code>name</code> attribute. If you omit this attribute, the server
is created in the <code>default</code> security group.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="user_data" style="plain" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Configuration information or scripts to use upon launch. Must be Base64
encoded.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="availability_zone" style="plain"
required="false" 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 availability zone in which
to launch the server.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="server" style="plain" required="true"
type="csapi:ServerForCreate" path="/csapi:server">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>server.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="imageRef" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The image reference for the desired image
for your server instance.
</para>
<para>
Specify as an ID or full URL.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="flavorRef" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The flavor reference for the desired flavor
for your server instance.
</para>
<para>Specify as an ID or full URL.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="networks" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A <code>networks</code> object. By default,
the server instance is provisioned with all
isolated networks for the tenant.
</para>
<para>Optionally, you can create one or more NICs
on the server.
</para>
<para>To provision the server instance with a NIC
for a network, specify the UUID of the network
in the <code>uuid</code> attribute in a
<code>networks</code> object.
</para>
<para>To provision the server instance with a NIC
for an already existing port, specify the
port-id in the <code>port</code> attribute in
a <code>networks</code> object.
</para>
<para>You can specify multiple NICs on the server.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="uuid" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>To provision the server instance with a NIC
for a network, specify the UUID of the network
in the <code>uuid</code> attribute in a
<code>networks</code> object. Required if you
omit the <code>port</code> attribute.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="port" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>To provision the server instance with a NIC
for an already existing port, specify the
port-id in the <code>port</code> attribute in
a <code>networks</code> object. The port
status must be <code>DOWN</code>. Required if
you omit the <code>uuid</code> attribute.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="fixed_ip" style="plain" type="xsd:string"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A fixed IPv4 address for the NIC. Valid with
a <code>neutron</code> or
<code>nova-networks</code> network.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" required="true"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The server name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="metadata" style="plain" required="false"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Metadata key and value pairs. The maximum
size of the metadata key and value is 255
bytes each.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="personality" style="plain" required="false"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>File path and contents (text only) to inject
into the server at launch. The maximum size of
the file path data is 255 bytes. The maximum
limit refers to the number of bytes in the
decoded data and not the number of characters
in the encoded data.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="block_device_mapping_v2" style="plain"
type="csapi:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Enables booting the server from a volume when additional parameters are
given. If specified, the volume status must be <code>available</code>,
and the volume <code>attach_status</code> in the OpenStack Block Storage
database must be <code>detached</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="device_name" style="plain"
type="csapi:string" required="true"
path="$.parameters.block_device_mapping_v2.device_name">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Describes a path to the device for the volume that you want to use to
boot the server.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="source_type" style="plain"
type="csapi:string" required="true"
path="$.parameters.block_device_mapping_v2.source_type">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The source type for the volume. A valid value is <code>blank</code>,
<code>snapshot</code>, <code>volume</code>, or <code>image</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="destination_type" style="plain"
type="csapi:string" required="false"
path="$.parameters.block_device_mapping_v2.destination_type">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Defines where the volume comes from. A valid value is <code>local</code>
or <code>volume</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="delete_on_termination" style="plain"
type="csapi:string" required="true"
path="$.parameters.block_device_mapping_v2.delete_on_termination">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>To delete the boot volume when the server stops, specify
<code>true</code>. Otherwise, specify <code>false</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="guest_format" style="plain"
type="csapi:string" required="true"
path="$.parameters.block_device_mapping_v2.guest_format">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specifies the guest server disk file system format, such as
<code>ephemeral</code> or <code>swap</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="boot_index" style="plain"
type="csapi:string" required="true"
path="$.parameters.block_device_mapping_v2.boot_index">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The boot order of the device. Use <code>-1</code> for the boot volume.
Use <code>0</code> for an attached volume.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="config_drive" style="plain"
type="xsd:boolean" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Enables metadata injection in a server through a configuration drive.
</para>
<para>
Specify <code>true</code> to enable a configuration drive. Otherwise,
specify <code>false</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="key_name" style="plain"
type="xsd:string" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Key pair name.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="os:scheduler_hints"
style="plain" required="false" type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The dictionary of data to send to the scheduler.
Alternatively, you can specify <code>OS-SCH-HNT:scheduler_hints</code>
as the string.
</para>
</wadl:doc>
</param>'>
<!ENTITY imageRefRequestParameter '
<param name="imageRef" style="plain" required="false"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="imageRef">
<para>
Required if you define a block device mapping.
</para>
<para>
The image reference as an ID or full URL for the image for your server
instance.
</para>
</wadl:doc>
</param>'>
<!ENTITY rebuildActionRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="rebuild" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>rebuild</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY serverNameRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" required="true" 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 server name.</para>
</wadl:doc>
</param>'>
<!ENTITY adminPassRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="adminPass" style="plain" required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="adminPass">
<para>The administrative password for the server.</para>
</wadl:doc>
</param>'>
<!ENTITY metadataRequestParameter '
<param name="metadata" style="plain" required="false"
xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="metadata">
<para>
Metadata key and value pairs. The maximum size for each metadata key and
value pair is 255 bytes.
</para>
</wadl:doc>
</param>'>
<!ENTITY personalityRequestParameter '
<param name="personality" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="personality">
<para>
File path and contents (text only) to inject into the server at
launch. The maximum size of the file path data is 255 bytes. The
maximum limit refers to the number of bytes in the decoded data
and not the number of characters in the encoded data.
</para>
</wadl:doc>
</param>'>
<!ENTITY preserve_ephemeralRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="preserve_ephemeral"
style="plain" required="false" type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Indicates whether the server is rebuilt with the preservation of the
ephemeral partition (<code>true</code>).
</para>
</wadl:doc>
</param>'>
<!-- Server List Parameters -->
<!ENTITY serverListQueryParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="changes-since" style="query" required="false"
type="xsd:dateTime">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
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="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The UUID for the image.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="flavor" style="query" required="false"
type="csapi:UUID">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The UUID for the specific flavor, which is a combination
of memory, disk size, and CPUs.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="query" required="false"
type="regexp">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Name of the server as a string. Can be queried with regular expressions.
The regular expression <code>?name=bob</code> returns both bob and bobb.
If you must match on only bob, you can use a regular expression that
matches the syntax of the underlying database server that is implemented
for Compute, such as MySQL or PostgreSQL.
</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="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
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="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Name of the host as a
string.
</para>
</wadl:doc>
</param>'>
<!ENTITY serverCreateResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="server" style="plain" required="true"
type="csapi:ServerForCreate" path="/csapi:server">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="server">
<para>A <code>server</code> object.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="adminPass" style="plain" required="true" type="csapi:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="adminPass">
<para>The administrative password for the server.</para>
</wadl:doc>
</param>
<param name="id" style="plain" type="csapi:UUID" required="true"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The server ID.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="links" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Server links.</para>
</wadl:doc>
</param>'>
<!-- tenantIdRequestParameter -->
<!ENTITY tenantIdRequestParameter '
<param name="tenant_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The tenant ID in a multi-tenancy cloud.</para>
</wadl:doc>
</param>'>
<!-- snapshotIdRequestParameter -->
<!ENTITY snapshotIdRequestParameter '
<param name="snapshot_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the snapshot.</para>
</wadl:doc>
</param>'>
<!-- statusRequestParameter -->
<!ENTITY statusRequestParameter '
<param name="status" style="query" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>Filters the results by a specified server status. For example,
<code>ACTIVE</code>.</para>
</wadl:doc>
</param>'>
<!-- flavorIdRequestParameter -->
<!ENTITY flavorIdRequestParameter '
<param name="flavor_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The flavor ID.</para>
</wadl:doc>
</param>'>
<!-- keypairNameRequestParameter -->
<!ENTITY keypairNameRequestParameter '
<param name="keypair_name" style="template" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The keypair name.</para>
</wadl:doc>
</param>'>
<!ENTITY keypairQueryRequestParameter '
<param name="user_id" style="query" type="xsd:string"
required="false"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>
The user ID of the user who runs the operation.
</para>
</wadl:doc>
</param>'>
<!ENTITY aggregateIdRequestParameter '
<param name="aggregate_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The aggregate ID.</para>
</wadl:doc>
</param>'>
<!ENTITY cellIdRequestParameter '
<param name="cell_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The cell ID.</para>
</wadl:doc>
</param>'>
<!ENTITY agentBuildIdRequestParameter '
<param name="id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The agent build ID.</para>
</wadl:doc>
</param>'>
<!ENTITY dnsEntryRequestParameter '
<param name="name" style="template" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The name of the DNS entry.</para>
</wadl:doc>
</param>'>
<!ENTITY dnsIpRequestParameter '
<param name="ip" style="template" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The IP address.</para>
</wadl:doc>
</param>'>
<!ENTITY floatingIpIdRequestParameter '
<param name="id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the floating IP address.</para>
</wadl:doc>
</param>'>
<!ENTITY instanceIdRequestParameter '
<param name="id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the instance.</para>
</wadl:doc>
</param>'>
<!ENTITY networkIdRequestParameter '
<param name="id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the network.</para>
</wadl:doc>
</param>'>
<!-- networkLabelRequestParameter -->
<!ENTITY networkLabelRequestParameter '
<param name="network_label" style="template" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The network label, such as <code>public</code> or <code>private</code>.</para>
</wadl:doc>
</param>'>
<!ENTITY hostNameRequestParameter '
<param name="host_name" style="template" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The name of the host.</para>
</wadl:doc>
</param>'>
<!ENTITY hypervisorIdRequestParameter '
<param name="hypervisor_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the hypervisor.</para>
</wadl:doc>
</param>'>
<!ENTITY classIdRequestParameter '
<param name="class_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the quota class.</para>
</wadl:doc>
</param>'>
<!ENTITY securityGroupIdRequestParameter '
<param name="security_group_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID of the security group.</para>
</wadl:doc>
</param>'>
<!ENTITY certificateIdRequestParameter '
<param name="certificate_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The certificate ID.</para>
</wadl:doc>
</param>'>
<!ENTITY flavorExtraSpecKeyParameter '
<param name="flavor_extra_spec_key" style="template" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The extra spec key for the flavor.</para>
</wadl:doc>
</param>'>
<!-- serverIdRequestParameter -->
<!ENTITY serverIdRequestParameter '
<param name="server_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The UUID for the server.</para>
</wadl:doc>
</param>'>
<!-- consoleIdRequestParameter -->
<!ENTITY consoleIdRequestParameter '
<param name="console_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The ID for the console.</para>
</wadl:doc>
</param>'>
<!-- keyRequestParameter -->
<!ENTITY keyRequestParameter '
<param name="key" style="template" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The metadata key.</para>
</wadl:doc>
</param>'>
<!-- Server List Parameters -->
<!ENTITY serverListParameters '
&changes_since-QueryParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="image" style="query" required="false"
type="xsd:anyURI">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Filters the results by a specified image name 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="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Filters the results by a specified flavor name 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="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Filters the results by a specified server name in string format.</para>
</wadl:doc>
</param>
&limitMarkerReqParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="status" style="query" required="false" type="csapi:ServerStatus">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Filters the results by a specified server status. For example,
<code>ACTIVE</code>.
</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="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Filters the results by a specified host name in string format.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_key"
style="query" required="false" type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Sorts by the requested server attribute. Default is
<code>created</code>. You can specify multiple pairs of sort key and
sort direction query parameters. If you omit the sort direction in a
pair, the API uses the natural sorting direction of the server attribute
that is provided as the <code>sort_key</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_dir"
style="query" required="false" type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Sort direction. A valid value is <code>asc</code> (ascending) or
<code>desc</code> (descending). Default is <code>desc</code>. You can
specify multiple pairs of sort key and sort direction query parameters. If
you omit the sort direction in a pair, the API uses the natural sorting
direction of the server attribute that is provided as the
<code>sort_key</code>.
</para>
</wadl:doc>
</param>'>
<!-- Server Details Parameters -->
<!ENTITY serverListDetailsParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_key"
style="query" required="false" type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Sorts by the requested server attribute. Default is
<code>created</code>. You can specify multiple pairs of sort key and
sort direction query parameters. If you omit the sort direction in a
pair, the API uses the natural sorting direction of the server attribute
that is provided as the <code>sort_key</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort_dir"
style="query" required="false" type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Sort direction. A valid value is <code>asc</code> (ascending) or
<code>desc</code> (descending). Default is <code>desc</code>. You can
specify multiple pairs of sort key and sort direction query parameters. If
you omit the sort direction in a pair, the API uses the natural sorting
direction of the server attribute that is provided as the
<code>sort_key</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY serverListDetailsResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="locked"
style="plain" required="true" type="xsd:boolean" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
Indicates whether the server is locked (<code>true</code>) or unlocked
(<code>false</code>).
</para>
</wadl:doc>
</param>'>
<!ENTITY serverAddressResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="addresses"
style="plain" required="true" type="xsd:dict" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02" xml:lang="EN">
<para>
The addresses for the server. If <code>osapi_hide_server_address_states</code> is set,
addresses information is hidden for any server in the specified state. By default,
servers in <code>BUILDING</code> state hide their addresses information.
</para>
</wadl:doc>
</param>'>
<!-- Servers Extended Attributes Parameters -->
<!ENTITY GetListServersDetailQueryParameters '
&changes_since-QueryParameter;'>
<!ENTITY DeleteKeypairQueryParameters '
<param name="keypair_name" style="URI" type="xsd:string"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The name to associate with the keypair.</para>
</wadl:doc>
</param>'>
<!ENTITY UpdateBuildQueryParameters '
<param name="id" style="template" type="xsd:int"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The agent ID.</para>
</wadl:doc>
</param>'>
<!ENTITY CreateDomainsQueryParameters '
<param name="domain" style="template"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Registered DNS domain published by the DNS
drivers.
</para>
</wadl:doc>
</param>'>
<!ENTITY DeleteDomainsQueryParameters '
<param name="domain" style="template"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Registered DNS domain published by the DNS
drivers.
</para>
</wadl:doc>
</param>'>
<!ENTITY CreateEntryQueryParameters '
<param name="domain" style="template"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Registered DNS domain published by the DNS
drivers.
</para>
</wadl:doc>
</param>'>
<!ENTITY FindUniqueEntryQueryParameters '
<param name="domain" style="template"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Registered DNS domain published by the DNS
drivers.
</para>
</wadl:doc>
</param>'>
<!ENTITY FindEntriesByIpQueryParameters '
<param name="domain" style="template"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Registered DNS domain published by the DNS
drivers.
</para>
</wadl:doc>
</param>'>
<!ENTITY DeleteEntryQueryParameters '
<param name="domain" style="template"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN">
<para>
Registered DNS domain published by the DNS
drivers.
</para>
</wadl:doc>
</param>'>
<!ENTITY DeallocateFloatingIpQueryParameters '
<param name="id" style="template" type="String"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>
The unique identifier associated with allocated floating IP address.
</para>
</wadl:doc>
</param>'>
<!ENTITY ShowServerGroupQueryParameters '
<param name="server_group_id" style="template" type="String"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The server group ID.</para>
</wadl:doc>
</param>'>
<!ENTITY DeleteServerGroupQueryParameters '
<param name="server_group_id" style="template" type="String"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The server group ID.</para>
</wadl:doc>
</param>'>
<!-- Flavor List Parameters -->
<!ENTITY flavorListParameters '
&changes_since-QueryParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="minDisk" style="query" required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Filters the results by a specified minimum disk space in GB.</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="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Filters the results by a specified minimum RAM in MB.</para>
</wadl:doc>
</param>
&limitMarkerReqParameter;'>
<!ENTITY flavorReqParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="disk" style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Integer value for the minimum disk space in GB.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The flavor ID.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" required="true" 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 flavor name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ram" style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Amount of RAM.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="vcpus" style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Number of VCPUs.</para>
</wadl:doc>
</param>'>
<!ENTITY flavorRespParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="disk" style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Integer value for the minimum disk space in GB.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The flavor ID.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="links" style="plain" required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Flavor links.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" required="true" 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 flavor name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="ram" style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Amount of RAM.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="vcpus" style="plain" required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Number of VCPUs.</para>
</wadl:doc>
</param>'>
<!ENTITY quotaSetsReqParameters '
<param name="quota_set" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A
quota_set object.
</para>
</wadl:doc>
</param>
<param name="cores" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of instance cores allowed for each
tenant.
</para>
</wadl:doc>
</param>
<param name="fixed_ips" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of fixed IP addresses allowed for each
tenant. Must be equal to or greater than the
number of allowed instances.
</para>
</wadl:doc>
</param>
<param name="floating_ips" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of floating IP addresses allowed for
each tenant.
</para>
</wadl:doc>
</param>
<param name="id" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
ID for the quota set.
</para>
</wadl:doc>
</param>
<param name="injected_file_content_bytes" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of bytes of content allowed for each
injected file.
</para>
</wadl:doc>
</param>
<param name="injected_file_path_bytes" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of bytes allowed for each injected file
path.
</para>
</wadl:doc>
</param>
<param name="injected_files" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of injected files allowed for each
tenant.
</para>
</wadl:doc>
</param>
<param name="instances" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of instances allowed for each
tenant.
</para>
</wadl:doc>
</param>
<param name="key_pairs" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of key pairs allowed for each
user.
</para>
</wadl:doc>
</param>
<param name="metadata_items" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of metadata items allowed for each
instance.
</para>
</wadl:doc>
</param>
<param name="ram" style="plain" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
amount of instance RAM in megabytes allowed
for each tenant.
</para>
</wadl:doc>
</param>
<param name="security_group_rules" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of rules allowed for each security
group.
</para>
</wadl:doc>
</param>
<param name="security_groups" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of security groups allowed for each
tenant.
</para>
</wadl:doc>
</param>
<param name="server_groups" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of server groups allowed
for each tenant.
</para>
</wadl:doc>
</param>
<param name="server_group_members" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of members allowed for each
server group.
</para>
</wadl:doc>
</param>'>
<!ENTITY quotaSetsRespParameters '
<param name="quota_set" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A
quota_set object.
</para>
</wadl:doc>
</param>
<param name="cores" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of instance cores allowed for each
tenant.
</para>
</wadl:doc>
</param>
<param name="fixed_ips" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of fixed IP addresses allowed for each
tenant. Must be equal to or greater than the
number of allowed instances.
</para>
</wadl:doc>
</param>
<param name="floating_ips" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of floating IP addresses allowed for
each tenant.
</para>
</wadl:doc>
</param>
<param name="id" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
ID for the quota set.
</para>
</wadl:doc>
</param>
<param name="injected_file_content_bytes" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of bytes of content allowed for each
injected file.
</para>
</wadl:doc>
</param>
<param name="injected_file_path_bytes" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of bytes allowed for each injected file
path.
</para>
</wadl:doc>
</param>
<param name="injected_files" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of injected files allowed for each
tenant.
</para>
</wadl:doc>
</param>
<param name="instances" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of instances allowed for each
tenant.
</para>
</wadl:doc>
</param>
<param name="key_pairs" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of key pairs allowed for each
user.
</para>
</wadl:doc>
</param>
<param name="metadata_items" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of metadata items allowed for each
instance.
</para>
</wadl:doc>
</param>
<param name="ram" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
amount of instance RAM in megabytes allowed
for each tenant.
</para>
</wadl:doc>
</param>
<param name="security_group_rules" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="false" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of rules allowed for each security
group.
</para>
</wadl:doc>
</param>
<param name="security_groups" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The
number of security groups allowed for each
tenant.
</para>
</wadl:doc>
</param>
<param name="server_groups" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of server groups allowed
for each tenant.
</para>
</wadl:doc>
</param>
<param name="server_group_members" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
required="true" type="xsd:int">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The number of members allowed for each
server group.
</para>
</wadl:doc>
</param>'>
<!-- Servers Shelve -->
<!ENTITY shelveAction '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="shelve" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>shelve</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY shelveOffloadAction '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="shelveOffload" style="plain" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>shelveOffload</code>
action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY unshelveAction '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="unshelve"
style="plain"
type="xsd:string"
required="true" id="os-unshelve">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Specify the <code>unshelve</code> action in the request body.
</para>
</wadl:doc>
</param>'>
<!ENTITY serverGroupParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="security_groups" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security groups object">
<para>Security groups object.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="id" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Rules object">
<para>A rules object.</para>
</wadl:doc>
</param>'>
<!ENTITY serverGroupsParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="server_groups" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A <code>server_groups</code> object.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="id" required="true"
type="csapi:uuid">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>The ID for the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="name" required="true"
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 name of the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="policies" required="true"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A list of policies associated with the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="members" required="true"
type="xsd:dict">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>A list of members in the server group.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" style="plain" name="metadata" required="true"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Associated metadata key-and-value pairs.</para>
</wadl:doc>
</param>'>
<!-- For v2.1 x-compute-request-id -->
<!ENTITY x-compute-request-idHeader '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="X-Compute-Request-ID" style="header" required="false"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Returns a unique identifier to provide tracking for the request. The
request ID associated with the request appears in the log lines for that
request. By default, the middleware configuration ensures the request ID
appears in the log files.
</para>
</wadl:doc>
</param>'>
<!ENTITY securityGroupRequestParameters '
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="security_groups" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security groups object">
<para>Security groups object.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="id" style="plain" type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Rules object">
<para>A rules object.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="tenant_id" 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" title="Tenant ID">
<para>The tenant.</para>
</wadl:doc>
</param>'>
<!ENTITY securityGroupsObjectParameter '
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="security_groups" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security groups object">
<para>Security groups object.</para>
</wadl:doc>
</param>'>
<!ENTITY securityGroupObjectParameter '
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="security_group" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group object">
<para>Security group object.</para>
</wadl:doc>
</param>'>
<!ENTITY securityGroupResponseParameters '
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group description">
<para>Security group description.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="id" style="plain" type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group ID">
<para>The security group ID.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group name">
<para>The security group name.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="rules" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Security group rules object">
<para>A security group rules object.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="tenant_id" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Tenant ID">
<para>The tenant.</para>
</wadl:doc>
</param>'>
<!ENTITY virtualinterfacesResponseParameters '
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="virtual_interfaces" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Virtual interface information">
<para>A <code>virtual_interfaces</code> object.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="id" style="plain" type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Virtual interface ID">
<para>The ID of the virtual interface.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="mac_address" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="MAC address">
<para>The MAC address.</para>
</wadl:doc>
</param>
<param xmlns:csapi="http://docs.openstack.org/compute/api/v2"
xmlns="http://wadl.dev.java.net/2009/02" name="net_id" style="plain" type="csapi:UUID" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN" title="Virtual network ID">
<para>The ID of the virtual network.</para>
</wadl:doc>
</param>'>
<!-- Image List Parameters -->
<!ENTITY imageListQueryParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="changes-since" style="query" required="false"
type="xsd:dateTime">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The date and time when the image last changed status.
</para>
<para>
Use this query parameter to check for changes since a previous request
rather than re-downloading and re-parsing the full status at each polling
interval. If data has changed, the call returns only the items changed
since the specified time. If data has not changed since the
<code>changes-since</code> time, the call returns an empty list.
</para>
<para>
To enable you to keep track of changes, this filter also displays images
that were deleted if the <code>changes-since</code> value specifies a date
in the last 30 days. Items deleted more than 30 days ago might be
returned, but it is not guaranteed.
</para>
<para>
The date and time stamp format is <link
xlink:href="https://en.wikipedia.org/wiki/ISO_8601">ISO 8601</link>:
</para>
<programlisting>CCYY-MM-DDThh:mm:ss±hh:mm</programlisting>
<para>
The <code>±hh:mm</code> value, if included, returns the time zone as an
offset from UTC.
</para>
<para>For example, <code>2015-08-27T09:49:58-05:00</code>.</para>
<para>If you omit the time zone, the UTC time zone is assumed.</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="server" style="query" required="false"
type="xsd:anyURI">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Name of the server 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="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Name of the image as a
string.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="status" style="query" required="false"
type="csapi:ImageStatus">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Value of the image statuses.
For example, you can filter on <code>ACTIVE</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="type" style="query" required="false"
type="xsd:string" default="ALL">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>Value of the type of image, such as snapshot
or backup.
</para>
</wadl:doc>
<option value="snapshot"/>
<option value="backup"/>
</param>'>
<!ENTITY hostRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="host" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The host name.
</para>
</wadl:doc>
</param>'>
<!ENTITY binaryRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="binary" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The service name.
</para>
</wadl:doc>
</param>'>
<!ENTITY disabled_reasonRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="disabled_reason" style="plain"
type="xsd:string" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The reason the service was disabled.
</para>
</wadl:doc>
</param>'>
<!ENTITY forced_downRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="forced_down" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Set to <code>true</code> to force down the service. Set to
<code>false</code> to unset a forced down service.
</para>
</wadl:doc>
</param>'>
<!ENTITY forced_downResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="forced_down" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
If the service is forced down, this value is <code>true</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY serviceIdResponseParameter '
<param name="id" style="plain" type="csapi:UUID" required="true"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xml:lang="EN"
xmlns:wadl="http://wadl.dev.java.net/2009/02">
<para>The service ID.</para>
</wadl:doc>
</param>'>
<!ENTITY serviceStateResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="state" style="plain" type="xsd:string"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The service state, which is <code>up</code> or <code>down</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY serviceStatusResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="status" style="plain" required="true" 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 service status, which is <code>enabled</code> or
<code>disabled</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY zoneResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="zone" style="plain"
required="true" 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 availability zone of the host.
</para>
</wadl:doc>
</param>'>
<!ENTITY serviceResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="service" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
A <code>service</code> object.
</para>
</wadl:doc>
</param>'>
<!ENTITY servicesResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="services" style="plain"
required="true" type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
A <code>services</code> object.
</para>
</wadl:doc>
</param>'>
View Git Blame Copy Permalink