openstack
/
api-site
Code Issues Proposed changes
api-site/api-ref/src/wadls/volume-api/src/common.ent

3451 lines
110 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>
<response status="413" xmlns="http://wadl.dev.java.net/2009/02">
<representation mediaType="application/xml" element="csapi:overLimit"/>
<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>'>
<!-- ******************************** -->
<!-- TEMPLATE PARAMETERS -->
<!-- ******************************** -->
<!ENTITY aliasTemplateParameter '
<param required="true"
xmlns="http://wadl.dev.java.net/2009/02"
name="alias" style="template"
type="xsd:string">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
An alias, which is a name for a pointer to a resource. For example, a
named extension.
</para>
</wadl:doc>
</param>'>
<!ENTITY backup_idTemplateParameter '
<param name="backup_id" style="template"
required="true" type="csapi:UUID" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID for a backup.
</para>
</wadl:doc>
</param>'>
<!ENTITY cgsnapshot_idTemplateParameter '
<param name="cgsnapshot_id" style="template"
type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The ID of the consistency group snapshot.
</para>
</wadl:doc>
</param>'>
<!ENTITY consistencygroup_idTemplateParameter '
<param name="consistencygroup_id" style="template"
type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The ID of the consistency group.
</para>
</wadl:doc>
</param>'>
<!ENTITY hostnameTemplateParameter '
<param name="hostname" style="template"
type="xsd:string" xmlns="http://wadl.dev.java.net/2009/02">
<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 host that hosts the storage back end.
</para>
</wadl:doc>
</param>'>
<!ENTITY interface_idTemplateParameter '
<param name="attachment_id"
style="plain" type="csapi:UUID" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The interface ID.
</para>
</wadl:doc>
</param>'>
<!ENTITY qos_idTemplateParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="qos_id" style="template"
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 ID of the QoS specification.
</para>
</wadl:doc>
</param>'>
<!ENTITY server_idTemplateParameter '
<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"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the server.
</para>
</wadl:doc>
</param>'>
<!ENTITY snapshot_idTemplateParameter '
<param name="snapshot_id" style="template"
required="true" type="csapi:UUID" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the snapshot.
</para>
</wadl:doc>
</param>'>
<!ENTITY tenant_idTemplateParameter '
<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"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the tenant in a multi-tenancy cloud.
</para>
</wadl:doc>
</param>'>
<!ENTITY admin_tenant_idTemplateParameter '
<param name="admin_tenant_id" style="template" type="csapi:UUID"
xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the administrative tenant.
</para>
</wadl:doc>
</param>'>
<!ENTITY tenant_idTemplateParameter2 '
<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"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID for the tenant for which you want to show, update, or delete
quotas. This UUID is different from the first tenant ID that you specify
in the URI: That UUID is for the administrative tenant.
</para>
</wadl:doc>
</param>'>
<!ENTITY user_idTemplateParameter '
<param name="user_id" style="template"
type="xsd:string" required="true" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The user ID. Specify in the URI as <code>user_id={user_id}</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY volume_idTemplateParameter '
<param name="volume_id" style="template"
required="true" type="csapi:UUID" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the volume.
</para>
</wadl:doc>
</param>'>
<!ENTITY volume_type_idTemplateParameter '
<param name="volume_type_id" style="template"
required="true" type="csapi:UUID" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID for an existing volume type.
</para>
</wadl:doc>
</param>'>
<!-- ************************ -->
<!-- QUERY PARAMETERS -->
<!-- ************************ -->
<!ENTITY sortQueryParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="sort"
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>
Comma-separated list of sort keys and optional sort directions in the
form of &lt;key&gt;[:&lt;direction&gt;]. A valid direction is
<code>asc</code> (ascending) or <code>desc</code> (descending).
</para>
</wadl:doc>
</param>'>
<!ENTITY sort_dirQueryParameter '
<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>
Sorts by one or more sets of attribute and sort direction combinations.
If you omit the sort direction in a set, default is <code>desc</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY sort_keyQueryParameter '
<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 an attribute. A valid value is <code>name</code>,
<code>status</code>, <code>container_format</code>,
<code>disk_format</code>, <code>size</code>, <code>id</code>,
<code>created_at</code>, or <code>updated_at</code>. Default is
<code>created_at</code>. The API uses the natural sorting direction of
the <code>sort_key</code> attribute value.
</para>
</wadl:doc>
</param>'>
<!ENTITY usageQueryParameter '
<param name="usage" style="query" required="false"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Set to <code>usage=true</code> to show quota usage. Default is
<code>false</code>.
</para>
</wadl:doc>
</param>'>
<!-- ******************************** -->
<!-- OBJECTS -->
<!-- ******************************** -->
<!ENTITY getExtensionsResponseParameters '
<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 name of the extension. For example, "Fox In Socks."
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="description" 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 extension description.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="namespace" 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>
Link associated to the extension.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="alias" 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 alias for the extension. For example, "FOXNSOX",
"os-availability-zone", "os-extended-quotas",
"os-share-unmanage" or "os-used-limits."
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="links" style="plain" type="xsd:list">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
List of links related to the extension.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" required="true"
name="updated" style="plain" type="xsd:dateTime">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The date and time stamp when the extension was last updated.
</para>
</wadl:doc>
</param>'>
<!ENTITY absoluteObjectParameter '
<param name="absolute" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
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>
An <code>absolute</code> limits object.
</para>
</wadl:doc>
</param>'>
<!ENTITY connectorObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="connector" style="plain"
type="xsd:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The <code>connector</code> object.
</para>
</wadl:doc>
</param>'>
<!ENTITY limitsObjectParameter '
<param name="limits" style="plain"
xmlns="http://wadl.dev.java.net/2009/02"
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 <code>limit</code> objects.
</para>
</wadl:doc>
</param>'>
<!ENTITY metadataObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="metadata" style="plain" type="xsd:dict" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A <code>metadata</code> object. Contains one or more metadata key and
value pairs that are associated with the volume.
</para>
</wadl:doc>
</param>'>
<!ENTITY qos_specsObjectParameter '
<param name="qos_specs" style="plain"
type="xsd:dict" required="true" xmlns="http://wadl.dev.java.net/2009/02">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
A <code>qos_specs</code> object.
</para>
</wadl:doc>
</param>'>
<!ENTITY quota_setObjectParameter '
<param name="quota_set" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
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 <code>quota_set</code> object.
</para>
</wadl:doc>
</param>'>
<!ENTITY snapshotObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="snapshot" style="plain" type="xsd:dict"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
A <code>snapshot</code> object.
</para>
</wadl:doc>
</param>'>
<!ENTITY snapshotsObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="snapshots" style="plain" type="xsd:list"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
A list of <code>snapshot</code> objects.
</para>
</wadl:doc>
</param>'>
<!ENTITY volumeObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume" style="plain"
type="xsd:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
A <code>volume</code> object.
</para>
</wadl:doc>
</param>'>
<!ENTITY volumesObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volumes" style="plain" type="xsd:list" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
A list of <code>volume</code> objects.
</para>
</wadl:doc>
</param>'>
<!ENTITY volume_typeObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_type" style="plain" 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 <code>volume_type</code> object.
</para>
</wadl:doc>
</param>'>
<!ENTITY volume_typesObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_type" style="plain" required="true"
type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
A list of <code>volume_type</code> objects.
</para>
</wadl:doc>
</param>'>
<!ENTITY volume_backupObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="backup" style="plain" 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 <code>backup</code> object.
</para>
</wadl:doc>
</param>'>
<!ENTITY volume_backupsObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="backups" style="plain" required="true"
type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
A list of <code>backup</code> objects.
</para>
</wadl:doc>
</param>'>
<!ENTITY volume_restoreObjectParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="restore" style="plain" 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 <code>restore</code> object.
</para>
</wadl:doc>
</param>'>
<!-- ******************************** -->
<!-- LIMITS RESPONSE PARAMETERS -->
<!-- ******************************** -->
<!ENTITY limitsResponseParameters '
&limitsObjectParameter;
&absoluteObjectParameter;
<param name="rate" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Rate-limit volume copy bandwidth, used to mitigate slow down of data
access from the instances.
</para>
</wadl:doc>
</param>
<param name="totalSnapshotsUsed" 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 total number of snapshots used.
</para>
</wadl:doc>
</param>
<param name="maxTotalBackups" 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 maximum number of backups.
</para>
</wadl:doc>
</param>
<param name="maxTotalVolumeGigabytes" 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 maximum total amount of volumes, in gibibytes (GiB).
</para>
</wadl:doc>
</param>
<param name="maxTotalSnapshots" 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 maximum number of snapshots.
</para>
</wadl:doc>
</param>
<param name="maxTotalBackupGigabytes" 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 maximum total amount of backups, in gibibytes (GiB).
</para>
</wadl:doc>
</param>
<param name="totalBackupGigabytesUsed" 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 total number of backups gibibytes (GiB) used.
</para>
</wadl:doc>
</param>
<param name="maxTotalVolumes" 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 maximum number of volumes.
</para>
</wadl:doc>
</param>
<param name="totalVolumesUsed" 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 total number of volumes used.
</para>
</wadl:doc>
</param>
<param name="totalBackupsUsed" 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 total number of backups used.
</para>
</wadl:doc>
</param>
<param name="totalGigabytesUsed" 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 total number of gibibytes (GiB) used.
</para>
</wadl:doc>
</param>'>
<!-- ******************************** -->
<!-- QUOTA SETS -->
<!-- ******************************** -->
<!-- QUOTA SETS REQUEST PARAMETERS -->
<!-- ******************************** -->
<!ENTITY quotaSetsRequestParameters '
&quota_setObjectParameter;
<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 that are 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 that are 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 that are 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 that are 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 that are 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 that are 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 that are 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 that are 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 that are 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 that are 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 that are 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 that are allowed for each tenant.
</para>
</wadl:doc>
</param>'>
<!-- ******************************** -->
<!-- QUOTA SETS RESPONSE PARAMETERS -->
<!-- ******************************** -->
<!ENTITY quotaSetsResponseParameters '
&quota_setObjectParameter;
<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 that are 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 that are 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 that are 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 that are 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 that are 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 that are 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 that are 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 that are 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 that are 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 that are 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 that are 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 that are allowed for each tenant.
</para>
</wadl:doc>
</param>
<param name="in_use" style="plain" required="false"
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>
The in use data size. Visible only if you set the
<code>usage=true</code> query parameter.
</para>
</wadl:doc>
</param>
<param name="reserved" 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>
Reserved volume size. Visible only if you set the
<code>usage=true</code> query parameter.
</para>
</wadl:doc>
</param>'>
<!ENTITY volumeSimpleResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The volume name.
</para>
</wadl:doc>
</param>
<param 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">
<para>
The UUID of the volume.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="links" style="plain" type="xsd:list" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The volume links.
</para>
</wadl:doc>
</param>'>
<!ENTITY volumeDetailResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="migration_status" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The volume migration status.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="attachments" style="plain" type="xsd:list" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Instance attachment information.
</para>
<para>
If this volume is attached to a server instance, the attachments list
includes the UUID of the attached server, an attachment UUID, the name
of the attached host, if any, the volume UUID, the device, and the
device UUID.
</para>
<para>
Otherwise, this list is empty.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="links" style="plain" type="xsd:list" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The volume links.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="availability_zone" 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 availability zone.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-vol-host-attr: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>
Current back-end of the volume.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="encrypted" style="plain" type="xsd:boolean" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
If true, this volume is encrypted.
</para>
</wadl:doc>
</param>
&updated_at-ResponseParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-volume-replication:extended_status" 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>
The volume replication status managed by the driver of backend storage.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="replication_status" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The volume replication status.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="snapshot_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">
<para>
The UUID of the source volume snapshot.
</para>
</wadl:doc>
</param>
<param 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">
<para>
The UUID of the volume.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="size"
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">
<para>
The size of the volume, in gibibytes (GiB).
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="user_id" style="plain" type="csapi:UUID" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The UUID of the user.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-vol-tenant-attr:tenant_id" style="plain" type="csapi:UUID" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The tenant ID which the volume belongs to.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-vol-mig-status-attr:migstat" 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 status of this volume migration
(None means that a migration is not currently in progress).
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="metadata"
style="plain" type="xsd:dict"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
One or more metadata key and value pairs that are associated with the
volume.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="status"
style="plain" type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The volume status.
</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">
<para>
The volume description.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="multiattach" style="plain" type="xsd:boolean" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
If true, this volume can attach to more than one instance.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-volume-replication:driver_data" 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>
The name of the volume replication driver.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="source_volid" 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">
<para>
The UUID of the source volume.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="consistencygroup_id" style="plain" type="csapi:UUID" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The UUID of the consistency group.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-vol-mig-status-attr:name_id" style="plain" type="csapi:UUID" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The volume ID that this volume name on the back-end is based on.
</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:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The volume name.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="bootable" style="plain" type="xsd:boolean" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Enables or disables the bootable attribute.
You can boot an instance from a bootable volume.
</para>
</wadl:doc>
</param>
&created_at-ResponseParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_type" 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 volume type. In an environment with multiple-storage back ends, the
scheduler determines where to send the volume based on the volume
type.
</para>
<para>
For information about how to use volume types to create multiple-
storage back ends, see <link
xlink:href="http://docs.openstack.org/admin-guide/blockstorage_multi_backend.html">Configure
multiple-storage back ends</link>.
</para>
</wadl:doc>
</param> '>
<!ENTITY quotasResponse '
&quota_setObjectParameter;
<param name="gigabytes" 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 gigabytes that are allowed for each tenant.
</para>
</wadl:doc>
</param>
<param name="snapshots" 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 snapshots that are allowed for each tenant.
</para>
</wadl:doc>
</param>
<param name="volumes" 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 volumes that are allowed for each tenant.
</para>
</wadl:doc>
</param>'>
<!ENTITY os-extendRequestParameter '
<param name="os-extend" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
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 <code>os-extend</code> action.
</para>
</wadl:doc>
</param>
<param name="new_size" 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 new size of the volume, in gibibytes (GiB).
</para>
</wadl:doc>
</param>'>
<!ENTITY os-reset_statusRequestParameter '
<param name="os-reset_status" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
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 <code>os-reset_status</code> action.
</para>
</wadl:doc>
</param>
<param name="status" style="plain" required="false"
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>
The volume status.
</para>
</wadl:doc>
</param>
<param name="attach_status" style="plain" required="false"
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>
The volume attach status.
</para>
</wadl:doc>
</param>
<param name="migration_status" style="plain" required="false"
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>
The volume migration status.
</para>
</wadl:doc>
</param>'>
<!ENTITY os-set_image_metadataRequestParameter '
<param name="os-set_image_metadata" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
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 <code>os-set_image_metadata</code> action.
</para>
</wadl:doc>
</param>
<param name="metadata" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
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 image metadata to add to the volume as a set
of metadata key and value pairs.
</para>
</wadl:doc>
</param>'>
<!ENTITY os-unset_image_metadataRequestParameter '
<param name="os-unset_image_metadata" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
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 <code>os-unset_image_metadata</code> action.
This action removes the key-value pairs from the image metadata.
</para>
</wadl:doc>
</param>
<param name="key" 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>
The metadata key name for the metadata that you want to remove.
</para>
</wadl:doc>
</param>'>
<!ENTITY os-unmanageRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="os-unmanage" style="plain"
type="xsd:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The <code>os-unmanage</code> action.
This action removes the specified volume from Cinder management.
</para>
</wadl:doc>
</param>'>
<!ENTITY os-force_detachRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="os-force_detach" style="plain"
type="xsd:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The <code>os-force_detach</code> action.
</para>
</wadl:doc>
</param>
&connectorObjectParameter;
&interface_idTemplateParameter;
'>
<!ENTITY attachVolumeReqParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="os-attach" style="plain"
type="xsd:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The <code>os-attach</code> action.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="instance_uuid" style="plain"
type="csapi:UUID" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the attaching instance.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="host_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>
The name of the attaching host.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="mountpoint" 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>
The attaching mount point.
</para>
</wadl:doc>
</param>'>
<!ENTITY os-promote-replicaRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-promote-replica" style="plain"
type="xsd:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The <code>os-promote-replica</code> action.
</para>
</wadl:doc>
</param>'>
<!ENTITY os-reenable-replicaRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-reenable-replica" style="plain"
type="xsd:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The <code>os-reenable-replica</code> action.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="size"
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">
<para>The size of the volume, in gibibytes (GiB).</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-volume-replication:driver_data" 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>The name of the volume replication driver.</para></wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-volume-replication:extended_status" 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>The status of the volume replication.</para></wadl:doc>
</param>'>
<!ENTITY quotasResponse '
<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 <code>quota_set</code> object.
</para>
</wadl:doc>
</param>
<param name="gigabytes" 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 gigabytes allowed for each tenant.
</para>
</wadl:doc>
</param>
<param name="snapshots" 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 snapshots allowed for each tenant.
</para>
</wadl:doc>
</param>
<param name="volumes" 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 volumes allowed for each tenant.
</para>
</wadl:doc>
</param>'>
<!ENTITY sortReqParameter '
<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 an image attribute. A valid value is <code>name</code>,
<code>status</code>, <code>container_format</code>,
<code>disk_format</code>, <code>size</code>, <code>id</code>,
<code>created_at</code>, or <code>updated_at</code>. Default is
<code>created_at</code>. The API uses the natural sorting direction of
the <code>sort_key</code> attribute value.
</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>
Sorts by one or more sets of attribute and sort direction combinations.
If you omit the sort direction in a set, default is <code>desc</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY backendResponseParameters '
<param name="pool_name" 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>
The name of the storage pool.
</para>
</wadl:doc>
</param>
<param name="visibility" 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>
The volume type access.
</para>
</wadl:doc>
</param>
<param name="description" 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>
The capabilities description.
</para>
</wadl:doc>
</param>
<param name="driver_version" 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>
The driver version.
</para>
</wadl:doc>
</param>
<param name="volume_backend_name" 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>
The name of the back-end volume.
</para>
</wadl:doc>
</param>
<param name="vendor_name" 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>
The name of the vendor.
</para>
</wadl:doc>
</param>
<param name="namespace" 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>
The storage namespace, such as
<code>OS::Storage::Capabilities::foo</code>.
</para>
</wadl:doc>
</param>
<param name="properties" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
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 backend volume capabilities list, which is consisted of
cinder standard capabilities and vendor unique properties.
</para>
</wadl:doc>
</param>
<param name="storage_protocol" 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>
The storage protocol, such as Fibre Channel, iSCSI, NFS, and so on.
</para>
</wadl:doc>
</param>'>
<!ENTITY quotasResponse '
<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 <code>quota_set</code> object.
</para>
</wadl:doc>
</param>
<param name="gigabytes" 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 gigabytes allowed for each tenant.
</para>
</wadl:doc>
</param>
<param name="snapshots" 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 snapshots allowed for each tenant.
</para>
</wadl:doc>
</param>
<param name="volumes" 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 volumes allowed for each tenant.
</para>
</wadl:doc>
</param>'>
<!ENTITY sortReqParameter '
&sort_keyQueryParameter;
&sort_dirQueryParameter;'>
<!ENTITY attachVolumeReqParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="os-attach" style="plain"
type="xsd:dict" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The action.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="instance_uuid" style="plain"
type="csapi:UUID" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The storage namespace, such as
<code>OS::Storage::Capabilities::foo</code>.
</para>
</wadl:doc>
</param>
<param name="vendor_name" 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>
The vendor name.
</para>
</wadl:doc>
</param>
<param name="volume_backend_name" 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>
Volume back-end storage name.
</para>
</wadl:doc>
</param>
<param name="pool_name" 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>
The pool name.
</para>
</wadl:doc>
</param>
<param name="driver_version" 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>
The driver version.
</para>
</wadl:doc>
</param>
<param name="storage_protocol" 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>
The storage protocol, such as Fibre Channel, iSCSI, NFS, and so on.
</para>
</wadl:doc>
</param>
<param name="display_name" 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>
The display name.
</para>
</wadl:doc>
</param>
<param name="description" 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>
The storage description.
</para>
</wadl:doc>
</param>
<param name="visibility" 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>
Enables public or private visibility. Set to <code>true</code> to
make the back end publicly visible.
</para>
</wadl:doc>
</param>
<param name="properties" style="plain" required="true"
xmlns="http://wadl.dev.java.net/2009/02"
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 set of storage properties, such as QoS, IOPS, and so on.
</para>
</wadl:doc>
</param>'>
<!ENTITY consistencyGroupResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" 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 UUID of the consistency group.
</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 consistency group name.
</para>
</wadl:doc>
</param>'>
<!-- ******************************************* -->
<!-- CONSISTENCY GROUPS -->
<!-- ******************************************* -->
<!-- CONSISTENCY GROUP REQUEST PARAMETERS -->
<!-- ******************************************* -->
<!ENTITY consistencyGroupCreateRequestParameters '
<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 name of the consistency group.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" 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 description of the consistency group.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_types" style="plain" required="true"
type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The list of volume types.
</para>
<para>
In an environment with multiple-storage back ends, the scheduler
determines where to send the volume based on the volume type.
</para>
<para>
For information about how to use volume types to create multiple-storage
back ends, see <link
xlink:href="http://docs.openstack.org/admin-guide/blockstorage_multi_backend.html">Configure
multiple-storage back ends</link>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="user_id" style="plain" 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 UUID of the user.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="project_id" style="plain" 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 UUID of the project.
</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 name of the availability zone.
</para>
</wadl:doc>
</param>
<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 status of the consistency group.
</para>
</wadl:doc>
</param>'>
<!ENTITY consistencyGroupCreateFromSourceRequestParameters '
<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 name of the consistency group.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" 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 description of the consistency group.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="cgsnapshot_id" style="plain" 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 of the consistency group snapshot.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="source_cgid" style="plain" 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 of the source consistency group.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="user_id" style="plain" 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 UUID of the user.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="project_id" style="plain" 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 UUID of the project.
</para>
</wadl:doc>
</param>
<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 status of the consistency group.
</para>
</wadl:doc>
</param>'>
<!-- ******************************************* -->
<!-- CONSISTENCY GROUP RESPONSE PARAMETERS -->
<!-- ******************************************* -->
<!ENTITY consistencyGroupDetailResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" 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 UUID of the consistency group.
</para>
</wadl:doc>
</param>
<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 consistency group status. A valid value is <code>creating</code>,
<code>available</code>, <code>error</code>, <code>deleting</code>,
<code>updating</code>, or <code>invalid</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="availability_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 name.
</para>
</wadl:doc>
</param>
&created_at-ResponseParameter;
<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 consistency group name.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" 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 consistency group description.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_types" style="plain" required="true"
type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The list of volume type IDs.
</para>
</wadl:doc>
</param>'>
<!ENTITY forceRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="force" 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>
If set to <code>true</code>, forces deletion of a consistency group
that has a registered volume.
</para>
</wadl:doc>
</param>'>
<!ENTITY consistencyGroupUpdateParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" 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 consistency group name.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" 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 consistency group description.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="add_volumes" 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 volume UUIDs, separated by commas, to add to the volume
consistency group.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="remove_volumes" 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 volume UUIDs, separated by commas, to remove from the
volume consistency group.
</para>
</wadl:doc>
</param>'>
<!ENTITY consistencyGroupSnapshotsResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" 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 UUID of the consistency group snapshot.
</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 consistency group snapshot name.
</para>
</wadl:doc>
</param>'>
<!ENTITY consistencyGroupSnapshotCreateRequestParameters '
<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 consistency group snapshot name.
</para>
</wadl:doc>
</param>'>
<!ENTITY consistencyGroupSnapshotsResponseDetailParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" 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 UUID of the consistency group snapshot.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="consistencygroup_id" style="plain" 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 UUID of the consistency group.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="status" 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 <code>status</code> of the consistency group snapshot.
</para>
</wadl:doc>
</param>
&created_at-ResponseParameter;
<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 consistency group snapshot name.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" 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 consistency group snapshot description.
</para>
</wadl:doc>
</param>'>
<!ENTITY postCGsnapshotsCreateRequestParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="consistencygroup_id" style="plain" 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 UUID of the consistency group.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" 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 consistency group snapshot name.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" 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 consistency group snapshot description.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="user_id" style="plain" 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 of the user.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="project_id" style="plain" 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 of the project.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="status" 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 <code>status</code> of the consistency group snapshot.
</para>
</wadl:doc>
</param>'>
<!ENTITY snapshotResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02" name="status" 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 status for the snapshot.
</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">
<para>
A description for the snapshot.
</para>
</wadl:doc>
</param>
&created_at-ResponseParameter;
<param xmlns="http://wadl.dev.java.net/2009/02" name="metadata"
style="plain" type="xsd:dict"
required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
One or more metadata key and value pairs for the snapshot, if any.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="volume_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">
<para>
If the snapshot was created from a volume, the volume ID.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02" name="size" 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">
<para>
The size of the volume, in gibibytes (GiB).
</para>
</wadl:doc>
</param>
<param 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">
<para>
The snapshot UUID.
</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">
<para>
The name of the snapshot.
</para>
</wadl:doc>
</param>'>
<!ENTITY VolTypeResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_type" style="plain" 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 set of key and value pairs that contains the properties for a volume
type.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" 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 UUID for the volume type.
</para>
</wadl:doc>
</param>
&availability_zoneResponseParameter;
&created_at-ResponseParameter;
<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 name of the volume type.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="extra_specs" style="plain" 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 set of key and value pairs that contains the specifications for a
volume type.
</para>
</wadl:doc>
</param>'>
<!-- **************************************** -->
<!-- SNAPSHOTS -->
<!-- **************************************** -->
<!-- SNAPSHOT REQUEST PARAMETERS -->
<!-- **************************************** -->
<!ENTITY snapshot-metadataRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02" name="metadata"
style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
One or more metadata key and value pairs for the snapshot.
</para>
</wadl:doc>
</param>'>
<!-- **************************************** -->
<!-- VOLUMES -->
<!-- **************************************** -->
<!-- VOLUME REQUEST PARAMETERS -->
<!-- **************************************** -->
<!ENTITY createVolumeRequestParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="size" 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">
<para>
The size of the volume, in gibibytes (GiB).
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="availability_zone" 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>
The availability zone.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="source_volid" style="plain"
type="csapi:UUID" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the source volume. The API creates a new volume with the
same size as the source volume.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" 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>
The volume description.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="multiattach" 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>
To enable this volume to attach to more than one server, set this
value to <code>true</code>. Default is <code>false</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="snapshot_id" style="plain"
type="csapi:UUID" required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
To create a volume from an existing snapshot, specify the UUID of the
volume snapshot. The volume is created in same availability zone and
with same size as the snapshot.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="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>
The volume name.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="imageRef" style="plain" type="csapi:UUID"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the image from which you want to create the volume. Required
to create a bootable volume.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_type" 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>
The volume type. To create an environment with multiple-storage back
ends, you must specify a volume type. Block Storage volume back ends are
spawned as children to <code>cinder-volume</code>, and they are keyed
from a unique queue. They are named <code>cinder-
volume.HOST.BACKEND</code>. For example, <code>cinder-
volume.ubuntu.lvmdriver</code>. When a volume is created, the scheduler
chooses an appropriate back end to handle the request based on the
volume type.
</para>
<para>
Default is <code>None</code>.
</para>
<para>
For information about how to use volume types to create multiple-storage
back ends, see <link
xlink:href="http://docs.openstack.org/admin-guide/blockstorage_multi_backend.html">Configure
multiple-storage back ends</link>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="metadata" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
One or more metadata key and value pairs that are associated with the
volume.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="source_replica" style="plain" type="csapi:UUID"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the primary volume to clone.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="consistencygroup_id" style="plain" type="csapi:UUID"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The UUID of the consistency group.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="scheduler_hints" style="plain" type="xsd:dict"
required="false">
<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.
</para>
</wadl:doc>
</param>'>
<!ENTITY updateVolumeRequestParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="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>
The volume name.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" 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>
The volume description.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="metadata" style="plain" type="xsd:dict"
required="false">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
One or more metadata key and value pairs that are associated with the
volume.
</para>
</wadl:doc>
</param>'>
<!-- **************************************** -->
<!-- VOLUME RESPONSE PARAMETERS -->
<!-- **************************************** -->
<!ENTITY createVolumeResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="availability_zone" 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 availability zone.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="source_volid" 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">
<para>
The UUID of the source volume, if any.
</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">
<para>
The volume description.
</para>
</wadl:doc>
</param>
&created_at-ResponseParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="multiattach" style="plain"
type="xsd:boolean" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
If <code>true</code>, this volume can attach to more than one instance.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="snapshot_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">
<para>
The UUID of the source snapshot, if any.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="size" 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">
<para>
The size of the volume, in gibibytes (GiB).
</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">
<para>
The volume name.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="imageRef" 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">
<para>
The UUID of the source image, if any.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_type" 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 associated volume type.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="metadata" style="plain" type="xsd:dict"
required="true">
<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 that are associated with the
volume.
</para>
</wadl:doc>
</param>'>
<!ENTITY volumeResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="status" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The volume status.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="migration_status" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The volume migration status.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="user_id" style="plain" type="csapi:UUID" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The UUID of the user.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="attachments" style="plain" type="xsd:list" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Instance attachment information.
</para>
<para>
If this volume is attached to a server instance, the attachments list
includes the UUID of the attached server, an attachment UUID, the name
of the attached host, if any, the volume UUID, the device, and the
device UUID.
</para>
<para>
Otherwise, this list is empty.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="links" style="plain" type="xsd:list" required="true">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The volume links.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="availability_zone" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The availability zone.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="bootable" style="plain" type="xsd:boolean" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
Enables or disables the bootable attribute.
You can boot an instance from a bootable volume.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="encrypted" style="plain" type="xsd:boolean" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
If true, this volume is encrypted.
</para>
</wadl:doc>
</param>
&created_at-ResponseParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The volume description.
</para>
</wadl:doc>
</param>
&updated_at-ResponseParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_type" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The volume type. In an environment with multiple-storage back ends, the
scheduler determines where to send the volume based on the volume
type.
</para>
<para>
For information about how to use volume types to create multiple-storage
back ends, see <link
xlink:href="http://docs.openstack.org/admin-guide/blockstorage_multi_backend.html">Configure
multiple-storage back ends</link>.
</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:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The volume name.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="replication_status" style="plain" type="xsd:string" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The volume replication status.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="consistencygroup_id" style="plain" type="csapi:UUID" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The UUID of the consistency group.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="source_volid" style="plain" type="csapi:UUID" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The UUID of the source volume.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="snapshot_id" style="plain" type="csapi:UUID" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The UUID of the source volume snapshot. The API creates a new volume
snapshot with the same size as the source volume snapshot.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="multiattach" style="plain" type="xsd:boolean" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
If true, this volume can attach to more than one instance.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="metadata" style="plain" type="xsd:dict" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
One or more metadata key and value pairs that are associated with the
volume.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" type="csapi:UUID" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The UUID of the volume.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="size" style="plain" type="xsd:int" required="true">
<wadl:doc xmlns:wadl="http://wadl.dev.java.net/2009/02"
xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
<para>
The size of the volume, in gibibytes (GiB).
</para>
</wadl:doc>
</param>'>
<!-- **************************************** -->
<!-- VOLUME TYPES -->
<!-- **************************************** -->
<!-- VOLUME TYPE REQUEST PARAMETERS -->
<!-- **************************************** -->
<!ENTITY volume_typeRequestParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_type" style="plain" 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>
The <code>volume_type</code> object.
</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 name of the volume type.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="extra_specs" style="plain" 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 set of key and value pairs that contains the specifications for a
volume type.
</para>
</wadl:doc>
</param>'>
<!ENTITY VolumeTypeAccessIDRequestParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_type" style="template" 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 of Volume Type to be accessed by project.
</para>
</wadl:doc>
</param>'>
<!ENTITY volumeTypeAccessProjectIdRequestParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="tenant_id" style="template" 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 of the project. Volume Type access to be added to this
project ID.
</para>
</wadl:doc>
</param>'>
<!ENTITY VolumeTypeAccessRequestParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_type_id" style="template" 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 of Volume Type.
</para>
</wadl:doc>
</param>'>
<!ENTITY projectRequestParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="project" 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 ID of the project. Volume Type access to be added to this
project ID.
</para>
</wadl:doc>
</param>'>
<!ENTITY projectIdRequestParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="project_id" 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 Project ID having access to this volume type.
</para>
</wadl:doc>
</param>'>
<!-- **************************************** -->
<!-- VOLUME TYPE RESPONSE PARAMETERS -->
<!-- **************************************** -->
<!ENTITY volume_typeResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_type" style="plain" 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>
The <code>volume_type</code> object.
</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 name of the volume type.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="extra_specs" style="plain" 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 set of key and value pairs that contains the specifications for a
volume type.
</para>
</wadl:doc>
</param>'>
<!ENTITY is_publicRequestParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-volume-type-access:is_public" 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>
The volume type access. Set to <code>true</code> if access is public.
Set to <code>false</code> if access is private. Default is
<code>true</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY is_publicResponseParameter '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="os-volume-type-access:is_public" style="plain" required="true"
type="xsd:boolean">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
The volume type access. If set to <code>true</code>, access is public.
If set to <code>false</code>, access is private.
</para>
</wadl:doc>
</param>'>
<!-- **************************************** -->
<!-- VOLUME BACKUP -->
<!-- **************************************** -->
<!-- VOLUME BACKUP REQUEST PARAMETERS -->
<!-- **************************************** -->
<!ENTITY volume_backupCreateRequestParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="container" 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 container name or null.
</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 backup name.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" 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 backup description or null.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_id" style="plain" 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 UUID of the volume that you want to back up.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="incremental" 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>
The backup mode. A valid value is
<code>true</code> for incremental backup mode or
<code>false</code> for full backup mode.
Default is <code>false</code>.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="force" 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 to backup, even if the volume is attached.
Default is <code>false</code>.
</para>
</wadl:doc>
</param>'>
<!ENTITY volume_restoreRequestParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_id" style="plain" 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 of the volume to which you want to restore a backup.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="name" 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 name of the volume to which you want to restore a backup.
</para>
</wadl:doc>
</param>'>
<!-- **************************************** -->
<!-- VOLUME BACKUP RESPONSE PARAMETERS -->
<!-- **************************************** -->
<!ENTITY volume_backupCreateResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="id" style="plain" 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 UUID of the backup.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="links" style="plain" required="true"
type="xsd:list">
<wadl:doc xmlns="http://docbook.org/ns/docbook"
xmlns:wadl="http://wadl.dev.java.net/2009/02"
xml:lang="EN">
<para>
Links for the backup.
</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 backup name.
</para>
</wadl:doc>
</param>'>
<!ENTITY volume_restoreResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="backup_id" style="plain" 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 UUID of the backup.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_id" style="plain" 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 UUID of the volume to which the backup was restored.
</para>
</wadl:doc>
</param>'>
<!ENTITY volume_backupResponseParameters '
<param xmlns="http://wadl.dev.java.net/2009/02"
name="availability_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.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="container" 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 container name or null.
</para>
</wadl:doc>
</param>
&created_at-ResponseParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="description" 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 backup description or null.
</para>
</wadl:doc>
</param>
&updated_at-ResponseParameter;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="fail_reason" 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>
If the backup failed, the reason for the failure. Otherwise, null.
</para>
</wadl:doc>
</param>
&volume_backupCreateResponseParameters;
<param xmlns="http://wadl.dev.java.net/2009/02"
name="object_count" 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 number of objects in the backup.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="size" 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 size of the backup, in GB.
</para>
</wadl:doc>
</param>
<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 backup status. Refer to Backup statuses table for the possible status value.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="volume_id" style="plain" 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 UUID of the volume from which the backup was created.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="is_incremental" 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 backup mode is incremental.
If this value is <code>true</code>, the backup mode is incremental.
If this value is <code>false</code>, the backup mode is full.
</para>
</wadl:doc>
</param>
<param xmlns="http://wadl.dev.java.net/2009/02"
name="has_dependent_backups" 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>
If this value is <code>true</code>, the backup depends on other backups.
</para>
</wadl:doc>
</param>'>
View Git Blame Copy Permalink