Add Shared File Systems API Extensions
Added the documentation of the extensions API of the Shared File Systems [1] API v1 and v2. [1] https://wiki.openstack.org/wiki/Manila Change-Id: I76e2f6f49891eaa1c635fb231e7b90adb8e76bd8 Partial-Bug: #1498053
This commit is contained in:
sslypushenko
Diane Fleming
parent
ce88859726
commit
d947b882e2
|
|
@ -33,4 +33,5 @@
|
|||
</legalnotice>
|
||||
</info>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_share-v2.xml"/>
|
||||
<xi:include href="../../api-ref/src/docbkx/ch_share-v2-experimental.xml"/>
|
||||
</book>
|
||||
|
|
|
|||
|
|
@ -18,9 +18,9 @@
|
|||
File Systems API without maintaining backward compatibility.
|
||||
</para>
|
||||
<section xml:id="migrate-share">
|
||||
<title>Share actions</title>
|
||||
<title>Share actions (since API v2.5)</title>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#action">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#action">
|
||||
<wadl:method href="#migrateShare"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
|
|
@ -42,19 +42,19 @@
|
|||
these actions to other roles.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#consistency-groups">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#consistency-groups">
|
||||
<wadl:method href="#createConsistencyGroup"/>
|
||||
<wadl:method href="#getConsistencyGroups"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#detail-consistency-groups">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#detail-consistency-groups">
|
||||
<wadl:method href="#getConsistencyGroupsDetails"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#consistency_group_id">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#consistency_group_id">
|
||||
<wadl:method href="#getConsistencyGroup"/>
|
||||
<wadl:method href="#updateConsistencyGroup"/>
|
||||
<wadl:method href="#deleteConsistencyGroup"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#consistency-groups-action">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#consistency-groups-action">
|
||||
<wadl:method href="#resetConsistencyGroupState"/>
|
||||
<wadl:method href="#force-deleteConsistencyGroup"/>
|
||||
</wadl:resource>
|
||||
|
|
@ -85,24 +85,24 @@
|
|||
</para>
|
||||
<para></para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#cgsnapshots">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#cgsnapshots">
|
||||
<wadl:method href="#createConsistencyGroupSnapshot"/>
|
||||
<wadl:method href="#getConsistencyGroupSnapshots"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#detail-cgsnapshots">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#detail-cgsnapshots">
|
||||
<wadl:method href="#getConsistencyGroupSnapshotsDetails"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#cgsnapshot_id">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#cgsnapshot_id">
|
||||
<wadl:method href="#getConsistencyGroupSnapshot"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#cgsnapshot-members">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#cgsnapshot-members">
|
||||
<wadl:method href="#getConsistencyGroupSnapshotMembers"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#cgsnapshot_id">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#cgsnapshot_id">
|
||||
<wadl:method href="#updateConsistencyGroupSnapshot"/>
|
||||
<wadl:method href="#deleteConsistencyGroupSnapshot"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2-experimental.wadl#cgsnapshots-action">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/experimental/os-share-v2-experimental.wadl#cgsnapshots-action">
|
||||
<wadl:method href="#resetConsistencyGroupSnapshotState"/>
|
||||
<wadl:method href="#force-deleteConsistencyGroupSnapshot"/>
|
||||
</wadl:resource>
|
||||
|
|
|
|||
|
|
@ -318,12 +318,11 @@
|
|||
<section xml:id="share-actions">
|
||||
<title>Share actions</title>
|
||||
<para>
|
||||
Use share actions to grant or deny access to a specified share,
|
||||
list the permissions for a specified share, and explicitly update
|
||||
the state of a share.
|
||||
Grants or revokes share access, lists the permissions for a
|
||||
specified share, and explicitly updates the state of a share.
|
||||
</para>
|
||||
<para>
|
||||
To grant or deny access to a share, specify one of these supported
|
||||
To grant or revoke share access, specify one of these supported
|
||||
share access levels:
|
||||
</para>
|
||||
<itemizedlist>
|
||||
|
|
@ -400,13 +399,13 @@
|
|||
</itemizedlist>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#action">
|
||||
<wadl:method href="#allowAccess"/>
|
||||
<wadl:method href="#denyAccess"/>
|
||||
<wadl:method href="#listAccessRules"/>
|
||||
<wadl:method href="#resetShareState"/>
|
||||
<wadl:method href="#force-deleteShare"/>
|
||||
<wadl:method href="#extendShare"/>
|
||||
<wadl:method href="#shrinkShare"/>
|
||||
<wadl:method href="#grantAccess" />
|
||||
<wadl:method href="#revokeAccess" />
|
||||
<wadl:method href="#listAccessRules" />
|
||||
<wadl:method href="#resetShareState" />
|
||||
<wadl:method href="#force-deleteShare" />
|
||||
<wadl:method href="#extendShare" />
|
||||
<wadl:method href="#shrinkShare" />
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
|
|
@ -492,7 +491,8 @@
|
|||
</itemizedlist>
|
||||
<para>
|
||||
For more information about supported plug-ins for share networks, see <link
|
||||
xlink:type="simple" xlink:href="http://docs.openstack.org/developer/manila/adminref/network_plugins.html">Manila
|
||||
xlink:type="simple"
|
||||
xlink:href="http://docs.openstack.org/developer/manila/adminref/network_plugins.html">Manila
|
||||
Network Plugins</link>.
|
||||
</para>
|
||||
<para>
|
||||
|
|
@ -818,7 +818,7 @@
|
|||
<para>
|
||||
The scheduler uses the special <code>capabilities</code> prefix
|
||||
for filtering. The scheduler can only create a share on a back end
|
||||
that reports capabilities that match the un-scoped extra-spec keys
|
||||
that reports capabilities that match the unscoped extra-spec keys
|
||||
for the share type. For details, see <link
|
||||
xlink:type="simple" xlink:href="http://docs.openstack.org/developer/manila/devref/capabilities_and_extra_specs.html">Capabilities and Extra-Specs</link>.
|
||||
</para>
|
||||
|
|
@ -873,4 +873,95 @@
|
|||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="share-services" xmlns="http://docbook.org/ns/docbook">
|
||||
<title>Services</title>
|
||||
<para>
|
||||
Lists services. Services include <code>manila-share</code> and <code
|
||||
>manila-scheduler</code> and their binaries, hosts, availability
|
||||
zones, current statuses, and states (<code>up</code> or
|
||||
<code>down</code>).
|
||||
</para>
|
||||
<para>
|
||||
Administrators can also enable or disable a specified service.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#os-services">
|
||||
<wadl:method href="#getServices"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#enable-service">
|
||||
<wadl:method href="#enableService"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#disable-service">
|
||||
<wadl:method href="#disableService"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="share-os-availability-zone" xmlns="http://docbook.org/ns/docbook">
|
||||
<title>Availability zones</title>
|
||||
<para>
|
||||
Describes availability zones.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#os-availability-zone">
|
||||
<wadl:method href="#getAvailabilityZones"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="share-os-share-manage" xmlns="http://docbook.org/ns/docbook">
|
||||
<title>Manage share</title>
|
||||
<para>
|
||||
Configures Shared File Systems to manage a specified share.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#os-share-manage">
|
||||
<wadl:method href="#manageShare"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="share-os-share-unmanage" xmlns="http://docbook.org/ns/docbook">
|
||||
<title>Unmanage share</title>
|
||||
<para>
|
||||
Configures Shared File Systems to unmanage a specified share.
|
||||
</para>
|
||||
<para>
|
||||
The share unmanage operation is not supported for shares that are
|
||||
created on top of share servers (created with share networks).
|
||||
</para>
|
||||
<para>
|
||||
You can unmanage a share that has no dependent snapshots.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#unmanage">
|
||||
<wadl:method href="#unmanageShare"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="share-os-quota-sets" xmlns="http://docbook.org/ns/docbook">
|
||||
<title>Quota sets</title>
|
||||
<para>
|
||||
Provides quotas management support.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#tenant_id_quota">
|
||||
<wadl:method href="#getQuota"/>
|
||||
<wadl:method href="#share-updateQuota"/>
|
||||
<wadl:method href="#share-deleteQuotas"/>
|
||||
</wadl:resource>
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#quota-defaults">
|
||||
<wadl:method href="#getDefaultQuotas"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
<section xml:id="share-os-quota-class-sets" xmlns="http://docbook.org/ns/docbook">
|
||||
<title>Quota classes</title>
|
||||
<para>
|
||||
Provides quota classes management support.
|
||||
</para>
|
||||
<wadl:resources xmlns:wadl="http://wadl.dev.java.net/2009/02">
|
||||
<wadl:resource href="../wadls/share-api/src/v2/os-share-v2.wadl#quota-class_name">
|
||||
<wadl:method href="#getQuotaClassQuotas"/>
|
||||
<wadl:method href="#updateQuotaClassQuotas"/>
|
||||
</wadl:resource>
|
||||
</wadl:resources>
|
||||
</section>
|
||||
</chapter>
|
||||
|
|
|
|||
|
|
@ -460,7 +460,10 @@
|
|||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
(Since API v2.6.) The share type ID.
|
||||
(Since API v2.6.) The share type ID.
|
||||
</para>
|
||||
<para>
|
||||
In minor versions, this parameter is a share type name, as a string.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
|
|
@ -941,6 +944,193 @@
|
|||
&sourceCgsnapshotMemberIdParameter;
|
||||
&isPublicParameter;
|
||||
&shareMetadataResponseParameter;'>
|
||||
<!ENTITY getSharesResponseParameters '
|
||||
<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 share ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&shareNameParameter;'>
|
||||
<!ENTITY manageShareResponseParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="links" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The share links.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&availabilityZoneRequiredParameter;
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share_network_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 share network ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="export_locations" style="plain" required="false"
|
||||
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 export locations. For example, when a share server has more
|
||||
than one network interface, it can have multiple export locations.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share_server_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 ID of the share server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="snapshot_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 snapshot ID.
|
||||
</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 share ID.
|
||||
</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 share size, in GBs.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share_type" 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>
|
||||
(Since API v2.6.) The share type ID.
|
||||
</para>
|
||||
<para>
|
||||
In minor versions, this parameter is a share type name, as a string.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share_type_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>
|
||||
(Since API v2.6.) The share type name.
|
||||
</para>
|
||||
<para>
|
||||
Minor versions support only the <code>share_type</code> parameter
|
||||
where the share type name is expected.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="export_location" 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 export location.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&consistencyGroupIdParameter;
|
||||
<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 ID of the project in which the share was created.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&shareMetadataResponseParameter;
|
||||
<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 share status, which is <code>available</code>,
|
||||
<code>manage_starting</code>, or <code>manage_error</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&shareDescriptionParameter;
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="host" 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 share host name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&isPublicParameter;
|
||||
&snapshotSupportParameter;
|
||||
&shareNameParameter;
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="created_at" style="plain" required="true"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time stamp when the share was created.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&fileSystemProtocolParameter;
|
||||
&volumeTypeParameter;
|
||||
&sourceCgsnapshotMemberIdParameter;'>
|
||||
<!ENTITY updateShareRequestParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="display_name" style="plain" required="false"
|
||||
|
|
@ -1010,7 +1200,7 @@
|
|||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY allowAccessRequestParameters '
|
||||
<!ENTITY grantAccessRequestParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="access_level" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
|
|
@ -1116,7 +1306,7 @@
|
|||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY allowAccessResponseParameters '
|
||||
<!ENTITY grantAccessResponseParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="id" style="plain" required="true"
|
||||
type="csapi:UUID">
|
||||
|
|
@ -1224,7 +1414,7 @@
|
|||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY denyAccessRequestParameters '
|
||||
<!ENTITY revokeAccessRequestParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="access_id" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
|
|
@ -2914,7 +3104,7 @@
|
|||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The service binary. Default is the base name of the executable.
|
||||
The service binary name. Default is the base name of the executable.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
|
|
@ -2963,6 +3153,116 @@
|
|||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY enableServiceRequestParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="binary" 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 service binary that you want to enable. Typically, this
|
||||
name is the base name of the executable.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="host" 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 host name of the service that you want to enable.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY enableServiceResponseParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="binary" 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 enabled service binary. Typically, this name is the base
|
||||
name of the executable.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="host" 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 host name of enabled service.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&disabledServiceParameter;'>
|
||||
<!ENTITY disabledServiceParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="disabled" style="plain" required="true"
|
||||
type="xsd:bool">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Indicates whether the service is disabled.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY disableServiceRequestParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="binary" 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 service binary that you want to disable. Typically, this
|
||||
name is the base name of the executable.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="host" 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 host name of the service that you want to disable.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY disableServiceResponseParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="binary" 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 disabled service binary. Typically, this name is the
|
||||
base name of the executable.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="host" 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 host name of disabled service.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&disabledServiceParameter;'>
|
||||
<!ENTITY share-createShareTypeRequestParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="extra_specs" style="plain" required="true"
|
||||
|
|
@ -3462,17 +3762,7 @@
|
|||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share_server_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 ID of the share server.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="host" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
|
|
@ -3650,8 +3940,8 @@
|
|||
</para>
|
||||
<itemizedlist>
|
||||
<listitem><para><code>host</code>. The host name for the back end.</para></listitem>
|
||||
<listitem><para><code>POOL</code>. The pool name for the back end.</para></listitem>
|
||||
<listitem><para><code>backend</code>. The name of the back end.</para></listitem>
|
||||
<listitem><para><code>POOL</code>. The pool name for the back end.</para></listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
|
|
@ -3878,4 +4168,485 @@
|
|||
New size of the share, in GBs.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
</param>'>
|
||||
<!ENTITY migrateShareRequestParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="host" 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 host pool of the destination back end, in this format:
|
||||
<code>host@backend#POOL</code>.
|
||||
</para>
|
||||
<itemizedlist>
|
||||
<listitem><para><code>host</code>. The host name for the destination back end.</para></listitem>
|
||||
<listitem><para><code>backend</code>. The name of the destination back end.</para></listitem>
|
||||
<listitem><para><code>POOL</code>. The pool name for the destination back end.</para></listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="force_host_copy" style="plain" required="true"
|
||||
type="xsd:bool">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Enables or disables generic host-based forced migrations, which bypasses
|
||||
driver optimizations. Default is <code>false</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!-- extensions -->
|
||||
<!ENTITY getServicesResponseParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="id" style="plain" required="true"
|
||||
type="xsd:int">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The service ID.
|
||||
</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 service status, which is <code>enabled</code>
|
||||
or <code>disabled</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="binary" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The service binary name. Default is the base name of the executable.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="zone" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The availability zone.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="host" 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 host name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="state" 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 current state of the service, which is <code>up</code> or
|
||||
<code>down</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="updated_at" style="plain" required="true"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time stamp when the service was updated.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY QuotaResponseParameters '
|
||||
<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="shares" 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 shares allowed for each tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="snapshot_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 for the snapshots allowed for each tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="share_networks" 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 share networks allowed for each tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY getQuotaResponseParameters '
|
||||
<param name="id" style="plain" required="true"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
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 tenant for which you manage quotas.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&QuotaResponseParameters;'>
|
||||
<!ENTITY updateQuotaRequestParameters '
|
||||
<param name="gigabytes" 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 gigabytes for the tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="snapshots" 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 snapshots for the tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="shares" 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 shares for the tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="snapshot_gigabytes" 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 gigabytes for the snapshots for the tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="share_networks" 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 share networks for the tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="force" style="plain" required="false"
|
||||
xmlns="http://wadl.dev.java.net/2009/02"
|
||||
type="xsd:bool">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
Indicates whether to permit or deny the force-update of a quota
|
||||
that is already used and the requested value exceeds the configured
|
||||
quota.
|
||||
</para>
|
||||
<para>
|
||||
Set to <code>True</code> to permit the force-update of the quota.
|
||||
</para>
|
||||
<para>
|
||||
Set to <code>False</code> to deny the force-update of the quota.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY getQuotaClassQuotasResponseParameters '
|
||||
<param name="id" 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 quota class ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&QuotaResponseParameters;'>
|
||||
<!ENTITY updateQuotaClassQuotasRequestParameters '
|
||||
<param name="class_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 a quota class for which you
|
||||
want to update the quotas.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="gigabytes" 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 gigabytes for the tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="snapshots" 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 snapshots for the tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="shares" 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 shares for the tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="snapshot_gigabytes" 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 gigabytes for the snapshots for the tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="share_networks" 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 share networks for the tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY manageShareRequestParameters '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="protocol" 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 Shared File Systems protocol of the share to manage.
|
||||
A valid value is <code>NFS</code>, <code>CIFS</code>,
|
||||
<code>GlusterFS</code>, or <code>HDFS</code>.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&shareNameParameter;
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share_type" 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 share type name.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="driver_options" 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>
|
||||
A set of one or more key and value pairs, as a dictionary of strings,
|
||||
that describe driver options.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="export_path" 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 share export path in the format appropriate for the protocol:
|
||||
</para>
|
||||
<itemizedlist>
|
||||
<listitem><para>
|
||||
NFS protocol. <code>10.0.0.1:/foo_path</code>. For example,
|
||||
<code>10.254.0.5:/shares/share-42033c24-0261-424f-abda
|
||||
-4fef2f6dbfd5</code>.
|
||||
</para></listitem>
|
||||
<listitem><para>
|
||||
CIFS protocol. <code>\\10.0.0.1\foo_name_of_cifs_share</code>.
|
||||
</para></listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="service_host" 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 manage-share service host in this format: <code>host@backend#POOL</code>.
|
||||
</para>
|
||||
<itemizedlist>
|
||||
<listitem><para><code>host</code>. The host name for the back end.</para></listitem>
|
||||
<listitem><para><code>backend</code>. The name of the back end.</para></listitem>
|
||||
<listitem><para><code>POOL</code>. The pool name for the back end.</para></listitem>
|
||||
</itemizedlist>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
&shareDescriptionParameter;'>
|
||||
<!ENTITY getAvailabilityZonesResponseParameters '
|
||||
<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 availability zone.
|
||||
</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 availability zone ID.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="created_at" style="plain" required="true"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time stamp when the availability zone was created.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="updated_at" style="plain" required="true"
|
||||
type="xsd:dateTime">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
The date and time stamp when the availability zone was updated.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY shareObjectParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="share" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A <code>share</code> object.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
<!ENTITY sharesObjectParameter '
|
||||
<param xmlns="http://wadl.dev.java.net/2009/02"
|
||||
name="shares" style="plain" required="true"
|
||||
type="xsd:string">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook"
|
||||
xmlns:wadl="http://wadl.dev.java.net/2009/02"
|
||||
xml:lang="EN">
|
||||
<para>
|
||||
A <code>shares</code> object.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>'>
|
||||
|
|
|
|||
|
|
@ -3,9 +3,7 @@
|
|||
<!DOCTYPE application[
|
||||
<!ENTITY % common SYSTEM "common.ent">
|
||||
%common;
|
||||
<!ENTITY % experimental SYSTEM "experimental.ent">
|
||||
%experimental;
|
||||
<!ENTITY % common_project SYSTEM "../../../common_project.ent">
|
||||
<!ENTITY % common_project SYSTEM "../../../../common_project.ent">
|
||||
%common_project;
|
||||
]>
|
||||
<application xmlns="http://wadl.dev.java.net/2009/02"
|
||||
|
|
@ -53,7 +51,9 @@
|
|||
<resource path="{share_id}" id="share_id">
|
||||
<param name="share_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The ID of an existing share.</para>
|
||||
<para>
|
||||
The ID of the share.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource id="action" path="action">
|
||||
|
|
@ -113,7 +113,8 @@
|
|||
<method name="POST" id="migrateShare">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Migrate share">
|
||||
<para role="shortdesc">
|
||||
Migrates a specified share from one back end to another. (Since API v2.5.)</para>
|
||||
Migrates a specified share from one back end to another.
|
||||
</para>
|
||||
<para>
|
||||
You can migrate a specified share from one back end to another but
|
||||
both back ends must set the
|
||||
|
|
@ -126,7 +127,7 @@
|
|||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-share-actions-mirate-request.json" />
|
||||
<xsdxt:code href="samples/manila-share-actions-migrate-request.json" />
|
||||
</wadl:doc>
|
||||
&migrateShareRequestParameters;
|
||||
</representation>
|
||||
|
|
@ -56,15 +56,17 @@
|
|||
<resource path="{share_id}" id="share_id">
|
||||
<param name="share_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The ID of an existing share.</para>
|
||||
<para>
|
||||
The ID of the share.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getShare" />
|
||||
<method href="#updateShare" />
|
||||
<method href="#deleteShare" />
|
||||
<resource id="action" path="action">
|
||||
<method href="#allowAccess" />
|
||||
<method href="#denyAccess" />
|
||||
<method href="#grantAccess" />
|
||||
<method href="#revokeAccess" />
|
||||
<method href="#listAccessRules" />
|
||||
<method href="#resetShareState" />
|
||||
<method href="#force-deleteShare" />
|
||||
|
|
@ -95,7 +97,9 @@
|
|||
<resource path="{snapshot_id}" id="snapshot_id">
|
||||
<param name="snapshot_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The ID of an existing snapshot.</para>
|
||||
<para>
|
||||
The ID of the snapshot.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#share-getSnapshot" />
|
||||
|
|
@ -116,7 +120,9 @@
|
|||
<resource path="{share_network_id}" id="share_network_id">
|
||||
<param name="share_network_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The ID of an existing share network.</para>
|
||||
<para>
|
||||
The ID of the share network.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getShareNetwork" />
|
||||
|
|
@ -137,7 +143,7 @@
|
|||
<resource path="{security_service_id}" id="security_service_id">
|
||||
<param name="security_service_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The ID of an existing security service.</para>
|
||||
<para>The ID of the security service.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getSecurityService" />
|
||||
|
|
@ -150,7 +156,7 @@
|
|||
<resource path="{share_server_id}" id="share_server_id">
|
||||
<param name="share_server_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The ID of an existing share server.</para>
|
||||
<para>The ID of the share server.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getShareServer" />
|
||||
|
|
@ -169,7 +175,7 @@
|
|||
<resource path="{share_type_id}" id="share_type_id">
|
||||
<param name="share_type_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The ID of an existing share type.</para>
|
||||
<para>The ID of the share type.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#share-deleteShareType" />
|
||||
|
|
@ -199,7 +205,7 @@
|
|||
<resource path="{share_instance_id}" id="share_instance_id">
|
||||
<param name="share_instance_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The ID of an existing share instance.</para>
|
||||
<para>The ID of the share instance.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getShareInstance" />
|
||||
|
|
@ -209,6 +215,86 @@
|
|||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="os-services" path="os-services">
|
||||
<method href="#getServices" />
|
||||
<resource id="enable-service" path="enable">
|
||||
<method href="#enableService" />
|
||||
</resource>
|
||||
<resource id="disable-service" path="disable">
|
||||
<method href="#disableService" />
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="os-share-manage" path="os-share-manage">
|
||||
<method href="#manageShare" />
|
||||
</resource>
|
||||
<resource id="os-share-unmanage" path="os-share-unmanage">
|
||||
<resource id="_share_id" path="{share_id}">
|
||||
<param name="share_id" style="template" type="csapi:UUID">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<para>The ID of a share.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<resource id="unmanage" path="unmanage">
|
||||
<method href="#unmanageShare" />
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="os-quota-sets" path="os-quota-sets">
|
||||
<resource id="tenant_id_quota" path="{tenant_id}" >
|
||||
<param name="tenant_id" style="template"
|
||||
type="csapi:UUID" required="true">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Project ID">
|
||||
<para>
|
||||
The ID for the tenant for which you want to
|
||||
show, update, or delete quotas. This ID is
|
||||
different from the first tenant ID that you
|
||||
specify in the URI: That ID is for the admin
|
||||
tenant.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<param name="user_id" style="query"
|
||||
type="csapi:UUID" required="false">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Project ID">
|
||||
<para>
|
||||
The user ID. If you specify this query
|
||||
parameter, you update the quotas for this
|
||||
user in the specified tenant. If you omit
|
||||
this parameter, you update the quotas for
|
||||
the specified project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getQuota"/>
|
||||
<method href="#share-updateQuota"/>
|
||||
<method href="#share-deleteQuotas"/>
|
||||
<resource path="defaults" id="quota-defaults">
|
||||
<method href="#getDefaultQuotas"/>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="os-quota-class-sets" path="os-quota-class-sets">
|
||||
<resource path="{class_name}" id="quota-class_name">
|
||||
<param name="class_name" style="template"
|
||||
type="xsd:string" required="true">
|
||||
<wadl:doc
|
||||
xmlns="http://docbook.org/ns/docbook"
|
||||
xml:lang="EN" title="Project ID">
|
||||
<para>The name of the quota class for which you
|
||||
want to manage quotas.</para>
|
||||
</wadl:doc>
|
||||
</param>
|
||||
<method href="#getQuotaClassQuotas" />
|
||||
<method href="#updateQuotaClassQuotas" />
|
||||
</resource>
|
||||
</resource>
|
||||
<resource id="os-availability-zone" path="os-availability-zone">
|
||||
<method href="#getAvailabilityZones" />
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
</resource>
|
||||
|
|
@ -302,14 +388,14 @@
|
|||
<itemizedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>display_name</code>, which also changes the
|
||||
<code>name</code> of the share.
|
||||
<code>display_name</code>, which also changes the
|
||||
<code>name</code> of the share.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
<code>display_description</code>, which also changes the
|
||||
<code>description</code> of the share.
|
||||
<code>display_description</code>, which also changes the
|
||||
<code>description</code> of the share.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
|
|
@ -318,8 +404,10 @@
|
|||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
<para>If you try to update other attributes, they retain their
|
||||
previous values.</para>
|
||||
<para>
|
||||
If you try to update other attributes, they retain their
|
||||
previous values.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
|
@ -412,37 +500,37 @@
|
|||
</wadl:doc>
|
||||
<response status="200" />
|
||||
</method>
|
||||
<method name="POST" id="allowAccess">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Allow access">
|
||||
<method name="POST" id="grantAccess">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Grant access">
|
||||
<para role="shortdesc">Grants access to a specified share.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-share-actions-allow-access-request.json" />
|
||||
<xsdxt:code href="samples/manila-share-actions-grant-access-request.json" />
|
||||
</wadl:doc>
|
||||
&allowAccessRequestParameters;
|
||||
&grantAccessRequestParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-share-actions-allow-access-response.json" />
|
||||
<xsdxt:code href="samples/manila-share-actions-grant-access-response.json" />
|
||||
</wadl:doc>
|
||||
&allowAccessResponseParameters;
|
||||
&grantAccessResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="POST" id="denyAccess">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Deny access">
|
||||
<para role="shortdesc">Denies access to a specified share.</para>
|
||||
<method name="POST" id="revokeAccess">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Revoke access">
|
||||
<para role="shortdesc">Revokes access from a specified share.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-share-actions-deny-access-request.json" />
|
||||
<xsdxt:code href="samples/manila-share-actions-revoke-access-request.json" />
|
||||
</wadl:doc>
|
||||
&denyAccessRequestParameters;
|
||||
&revokeAccessRequestParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="202" />
|
||||
|
|
@ -470,8 +558,14 @@
|
|||
</method>
|
||||
<method name="POST" id="resetShareState">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Reset share state">
|
||||
<para role="shortdesc">Administrator only. Explicitly updates the state of a specified share.</para>
|
||||
<para>Use the <code>policy.json</code> file to grant permissions for this action to other roles.</para>
|
||||
<para role="shortdesc">
|
||||
Administrator only. Explicitly updates the state of a specified
|
||||
share.
|
||||
</para>
|
||||
<para>
|
||||
Use the <code>policy.json</code> file to grant permissions for this
|
||||
action to other roles.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
|
@ -485,8 +579,13 @@
|
|||
</method>
|
||||
<method name="POST" id="force-deleteShare">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Force-delete share">
|
||||
<para role="shortdesc">Administrator only. Force-deletes a specified share in any state.</para>
|
||||
<para>Use the <code>policy.json</code> file to grant permissions for this action to other roles.</para>
|
||||
<para role="shortdesc">
|
||||
Administrator only. Force-deletes a specified share in any state.
|
||||
</para>
|
||||
<para>
|
||||
Use the <code>policy.json</code> file to grant permissions for this
|
||||
action to other roles.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
|
|
@ -1076,7 +1175,7 @@
|
|||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-share-type-access-add-request.json" />
|
||||
<xsdxt:code href="samples/manila-share-type-grant-access-request.json" />
|
||||
</wadl:doc>
|
||||
&addShareTypeAccessRequestParameter;
|
||||
</representation>
|
||||
|
|
@ -1091,7 +1190,7 @@
|
|||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-share-type-access-remove-request.json" />
|
||||
<xsdxt:code href="samples/manila-share-type-revoke-access-request.json" />
|
||||
</wadl:doc>
|
||||
&removeShareTypeAccessRequestParameter;
|
||||
</representation>
|
||||
|
|
@ -1194,4 +1293,206 @@
|
|||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getServices">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List services">
|
||||
<para role="shortdesc">Lists services.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-services-list-response.json" />
|
||||
</wadl:doc>
|
||||
&getServicesResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="PUT" id="enableService">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Enable service">
|
||||
<para role="shortdesc">Enables a specified service.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-services-enable-request.json" />
|
||||
</wadl:doc>
|
||||
&enableServiceRequestParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-services-enable-response.json" />
|
||||
</wadl:doc>
|
||||
&enableServiceResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="PUT" id="disableService">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Disable service">
|
||||
<para role="shortdesc">Disables a specified service.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-services-disable-request.json" />
|
||||
</wadl:doc>
|
||||
&disableServiceRequestParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-services-disable-response.json" />
|
||||
</wadl:doc>
|
||||
&disableServiceResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getAvailabilityZones">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="List availability zones">
|
||||
<para role="shortdesc">Lists all availability zones.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-availability-zones-list-response.json" />
|
||||
</wadl:doc>
|
||||
&getAvailabilityZonesResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="POST" id="manageShare">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Manage share">
|
||||
<para role="shortdesc">Configures Shared File Systems to manage a specified share.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-share-manage-request.json" />
|
||||
</wadl:doc>
|
||||
&shareObjectParameter;
|
||||
&manageShareRequestParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-share-manage-response.json" />
|
||||
</wadl:doc>
|
||||
&shareObjectParameter;
|
||||
&manageShareResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="POST" id="unmanageShare">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Unmanage share">
|
||||
<para role="shortdesc">Configures Shared File Systems to stop managing a specified share.</para>
|
||||
</wadl:doc>
|
||||
<response status="202" />
|
||||
</method>
|
||||
<method name="GET" id="getQuota">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show quotas">
|
||||
<para role="shortdesc">Shows quotas for a specified tenant.</para>
|
||||
<para>
|
||||
If you specify the optional <code>user_id</code> query parameter,
|
||||
you get the quotas for this user in the specified tenant. If you
|
||||
omit this parameter, you get the quotas for the specified project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-quota-show-response.json" />
|
||||
</wadl:doc>
|
||||
&getQuotaResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="GET" id="getDefaultQuotas">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show default quotas">
|
||||
<para role="shortdesc">Shows default quotas for a specified tenant.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-quota-show-response.json" />
|
||||
</wadl:doc>
|
||||
&getQuotaResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="PUT" id="share-updateQuota">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update quotas">
|
||||
<para role="shortdesc">Updates quotas for a specified tenant.</para>
|
||||
<para>
|
||||
If you specify the optional <code>user_id</code> query parameter,
|
||||
you update the quotas for this user in the specified tenant. If you
|
||||
omit this parameter, you update the quotas for the specified project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-quota-update-request.json" />
|
||||
</wadl:doc>
|
||||
&updateQuotaRequestParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-quota-update-response.json" />
|
||||
</wadl:doc>
|
||||
&QuotaResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="DELETE" id="share-deleteQuotas">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Delete quotas">
|
||||
<para role="shortdesc">
|
||||
Deletes quotas for a specified tenant.
|
||||
The quota will revert back to default.
|
||||
</para>
|
||||
<para>
|
||||
If you specify the optional <code>user_id</code> query parameter,
|
||||
you delete the quotas for this user in the specified tenant. If you
|
||||
omit this parameter, you delete the quotas for the specified project.
|
||||
</para>
|
||||
</wadl:doc>
|
||||
<response status="202" />
|
||||
</method>
|
||||
<method name="GET" id="getQuotaClassQuotas">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Show quotas for a quota class">
|
||||
<para role="shortdesc">Shows the quotas for a specified quota class.</para>
|
||||
</wadl:doc>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-quota-class-quota-show-response.json" />
|
||||
</wadl:doc>
|
||||
&getQuotaClassQuotasResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
<method name="PUT" id="updateQuotaClassQuotas">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN" title="Update quotas for a quota class">
|
||||
<para role="shortdesc">Updates the quotas for a specified for a quota class.</para>
|
||||
</wadl:doc>
|
||||
<request>
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-quota-class-quota-update-request.json" />
|
||||
</wadl:doc>
|
||||
&updateQuotaClassQuotasRequestParameters;
|
||||
</representation>
|
||||
</request>
|
||||
<response status="200">
|
||||
<representation mediaType="application/json">
|
||||
<wadl:doc xmlns="http://docbook.org/ns/docbook" xml:lang="EN">
|
||||
<xsdxt:code href="samples/manila-quota-class-quota-update-response.json" />
|
||||
</wadl:doc>
|
||||
&QuotaResponseParameters;
|
||||
</representation>
|
||||
</response>
|
||||
</method>
|
||||
</application>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,10 @@
|
|||
{
|
||||
"availability_zones": [
|
||||
{
|
||||
"name": "nova",
|
||||
"created_at": "2015-09-18T09:50:55.000000",
|
||||
"updated_at": null,
|
||||
"id": "388c983d-258e-4a0e-b1ba-10da37d766db"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
{
|
||||
"quota_class_set": {
|
||||
"gigabytes": 1000,
|
||||
"shares": 50,
|
||||
"snapshot_gigabytes": 1000,
|
||||
"snapshots": 50,
|
||||
"id": "abc",
|
||||
"share_networks": 10
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
{
|
||||
"quota_class_set": {
|
||||
"class_name": "abc",
|
||||
"shares": 49
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"quota_class_set": {
|
||||
"gigabytes": 1000,
|
||||
"snapshot_gigabytes": 1000,
|
||||
"snapshots": 50,
|
||||
"shares": 49,
|
||||
"share_networks": 10
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
{
|
||||
"quota_set": {
|
||||
"gigabytes": 1000,
|
||||
"shares": 50,
|
||||
"snapshot_gigabytes": 1000,
|
||||
"snapshots": 50,
|
||||
"id": "16e1ab15c35a457e9c2b2aa189f544e1",
|
||||
"share_networks": 10
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"quota_set": {
|
||||
"tenant_id": "16e1ab15c35a457e9c2b2aa189f544e1",
|
||||
"snapshot_gigabytes": 999,
|
||||
"snapshots": 49,
|
||||
"share_networks": 9
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,9 @@
|
|||
{
|
||||
"quota_set": {
|
||||
"gigabytes": 1000,
|
||||
"snapshot_gigabytes": 999,
|
||||
"shares": 50,
|
||||
"snapshots": 49,
|
||||
"share_networks": 9
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
{
|
||||
"binary": "manila-share",
|
||||
"host": "openstack@cmode"
|
||||
}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"disabled": true,
|
||||
"binary": "manila-share",
|
||||
"host": "openstack@cmode"
|
||||
}
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
{
|
||||
"binary": "manila-share",
|
||||
"host": "openstack@cmode"
|
||||
}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"disabled": false,
|
||||
"binary": "manila-share",
|
||||
"host": "openstack@cmode"
|
||||
}
|
||||
|
|
@ -0,0 +1,14 @@
|
|||
{
|
||||
"share": {
|
||||
"protocol": "nfs",
|
||||
"name": "share_texas1",
|
||||
"share_type": "d",
|
||||
"driver_options": {
|
||||
"opt1": "opt1",
|
||||
"opt2": "opt2"
|
||||
},
|
||||
"export_path": "10.254.0.5:/shares/share-42033c24-0261-424f-abda-4fef2f6dbfd5",
|
||||
"service_host": "manila2@unmanage1#UNMANAGE1",
|
||||
"description": "Lets manage share."
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,37 @@
|
|||
{
|
||||
"share": {
|
||||
"links": [
|
||||
{
|
||||
"href": "http://172.18.198.54:8786/v2/16e1ab15c35a457e9c2b2aa189f544e1/shares/00137b40-ca06-4ae8-83a3-2c5989eebcce",
|
||||
"rel": "self"
|
||||
},
|
||||
{
|
||||
"href": "http://172.18.198.54:8786/16e1ab15c35a457e9c2b2aa189f544e1/shares/00137b40-ca06-4ae8-83a3-2c5989eebcce",
|
||||
"rel": "bookmark"
|
||||
}
|
||||
],
|
||||
"availability_zone": null,
|
||||
"share_network_id": null,
|
||||
"export_locations": [],
|
||||
"share_server_id": null,
|
||||
"snapshot_id": null,
|
||||
"id": "00137b40-ca06-4ae8-83a3-2c5989eebcce",
|
||||
"size": null,
|
||||
"share_type": "14747856-08e5-494f-ab40-a64b9d20d8f7",
|
||||
"share_type_name": "d",
|
||||
"export_location": "10.254.0.5:/shares/share-42033c24-0261-424f-abda-4fef2f6dbfd5",
|
||||
"consistency_group_id": null,
|
||||
"project_id": "16e1ab15c35a457e9c2b2aa189f544e1",
|
||||
"metadata": {},
|
||||
"status": "manage_starting",
|
||||
"description": "Lets manage share.",
|
||||
"host": "manila2@unmanage1#UNMANAGE1",
|
||||
"is_public": false,
|
||||
"snapshot_support": true,
|
||||
"name": "share_texas1",
|
||||
"created_at": "2015-09-17T16:21:12.000000",
|
||||
"share_proto": "NFS",
|
||||
"volume_type": "d",
|
||||
"source_cgsnapshot_member_id": null
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue