summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.zuul.yaml4
-rw-r--r--api-ref/source/availability-zones.inc8
-rw-r--r--api-ref/source/extensions.inc6
-rw-r--r--api-ref/source/limits.inc4
-rw-r--r--api-ref/source/os-share-manage.inc84
-rw-r--r--api-ref/source/parameters.yaml1414
-rw-r--r--api-ref/source/quota-classes.inc8
-rw-r--r--api-ref/source/quota-sets.inc62
-rw-r--r--api-ref/source/samples/share-instances-list-response.json10
-rw-r--r--api-ref/source/samples/share-manage-request.json3
-rw-r--r--api-ref/source/samples/share-manage-response.json4
-rw-r--r--api-ref/source/samples/share-server-manage-request.json10
-rw-r--r--api-ref/source/samples/share-server-manage-response.json15
-rw-r--r--api-ref/source/samples/share-server-reset-state-request.json5
-rw-r--r--api-ref/source/samples/share-server-unmanage-request.json5
-rw-r--r--api-ref/source/samples/share-show-instance-response.json5
-rw-r--r--api-ref/source/samples/snapshot-create-response.json2
-rw-r--r--api-ref/source/samples/snapshot-manage-response.json2
-rw-r--r--api-ref/source/samples/snapshot-show-response.json2
-rw-r--r--api-ref/source/samples/snapshot-update-response.json2
-rw-r--r--api-ref/source/samples/snapshots-list-detailed-response.json4
-rw-r--r--api-ref/source/scheduler-stats.inc8
-rw-r--r--api-ref/source/security-services.inc89
-rw-r--r--api-ref/source/services.inc14
-rw-r--r--api-ref/source/share-access-rule-metadata.inc16
-rw-r--r--api-ref/source/share-access-rules.inc23
-rw-r--r--api-ref/source/share-actions.inc119
-rw-r--r--api-ref/source/share-export-locations.inc16
-rw-r--r--api-ref/source/share-group-snapshots.inc102
-rw-r--r--api-ref/source/share-group-types.inc71
-rw-r--r--api-ref/source/share-groups.inc75
-rw-r--r--api-ref/source/share-instance-export-locations.inc15
-rw-r--r--api-ref/source/share-instances.inc30
-rw-r--r--api-ref/source/share-metadata.inc22
-rw-r--r--api-ref/source/share-migration.inc36
-rw-r--r--api-ref/source/share-networks.inc110
-rw-r--r--api-ref/source/share-replica-export-locations.inc16
-rw-r--r--api-ref/source/share-replicas.inc86
-rw-r--r--api-ref/source/share-servers.inc193
-rw-r--r--api-ref/source/share-types.inc56
-rw-r--r--api-ref/source/shares.inc185
-rw-r--r--api-ref/source/snapshot-instances.inc32
-rw-r--r--api-ref/source/snapshots.inc142
-rw-r--r--api-ref/source/user-messages.inc18
-rwxr-xr-xcontrib/ci/pre_test_hook.sh5
-rwxr-xr-xdevstack/plugin.sh56
-rw-r--r--devstack/settings17
-rw-r--r--devstack/upgrade/settings8
-rw-r--r--doc/source/admin/cephfs_driver.rst2
-rw-r--r--doc/source/admin/generic_driver.rst9
-rw-r--r--doc/source/admin/index.rst2
-rw-r--r--doc/source/admin/shared-file-systems-share-replication.rst4
-rw-r--r--doc/source/admin/shared-file-systems-snapshots.rst16
-rw-r--r--doc/source/configuration/shared-file-systems/drivers.rst1
-rw-r--r--doc/source/configuration/shared-file-systems/drivers/dell-emc-vmax-driver.rst290
-rw-r--r--doc/source/configuration/shared-file-systems/drivers/generic-driver.rst10
-rw-r--r--doc/source/configuration/shared-file-systems/drivers/windows-smb-driver.rst80
-rw-r--r--doc/source/contributor/development-environment-devstack.rst6
-rw-r--r--doc/source/contributor/gerrit.rst4
-rw-r--r--doc/source/contributor/samples/cephfs_local.conf6
-rw-r--r--doc/source/contributor/samples/container_local.conf4
-rw-r--r--doc/source/contributor/samples/generic_local.conf4
-rw-r--r--doc/source/contributor/samples/lvm_local.conf4
-rw-r--r--doc/source/contributor/samples/zfsonlinux_local.conf4
-rw-r--r--doc/source/user/create-and-manage-shares.rst29
-rw-r--r--manila/api/openstack/rest_api_version_history.rst4
-rw-r--r--manila/api/openstack/wsgi.py25
-rw-r--r--manila/api/v1/security_service.py3
-rw-r--r--manila/api/v2/share_networks.py17
-rw-r--r--manila/db/api.py9
-rw-r--r--manila/db/sqlalchemy/api.py51
-rw-r--r--manila/quota.py4
-rw-r--r--manila/scheduler/filters/driver.py16
-rw-r--r--manila/share/drivers/ganesha/__init__.py75
-rw-r--r--manila/share/drivers/ganesha/utils.py2
-rw-r--r--manila/share/drivers/helpers.py4
-rw-r--r--manila/share/drivers/infinidat/infinibox.py6
-rw-r--r--manila/share/drivers/netapp/dataontap/client/client_cmode.py16
-rw-r--r--manila/share/drivers/qnap/qnap.py14
-rw-r--r--manila/share/manager.py11
-rw-r--r--manila/share_group/share_group_types.py2
-rw-r--r--manila/tests/api/openstack/test_wsgi.py86
-rw-r--r--manila/tests/api/v1/test_security_service.py19
-rw-r--r--manila/tests/api/v2/test_share_group_snapshots.py7
-rw-r--r--manila/tests/api/v2/test_share_groups.py5
-rw-r--r--manila/tests/api/v2/test_share_instances.py5
-rw-r--r--manila/tests/api/v2/test_share_networks.py64
-rw-r--r--manila/tests/api/v2/test_share_replicas.py6
-rw-r--r--manila/tests/api/v2/test_share_snapshot_instances.py6
-rw-r--r--manila/tests/api/v2/test_share_snapshots.py4
-rw-r--r--manila/tests/api/v2/test_shares.py4
-rw-r--r--manila/tests/db/fakes.py3
-rw-r--r--manila/tests/db/migrations/alembic/test_migration.py4
-rw-r--r--manila/tests/db/sqlalchemy/test_api.py156
-rw-r--r--manila/tests/db_utils.py12
-rw-r--r--manila/tests/scheduler/filters/test_driver.py18
-rw-r--r--manila/tests/share/drivers/dummy.py10
-rw-r--r--manila/tests/share/drivers/hdfs/test_hdfs_native.py2
-rw-r--r--manila/tests/share/drivers/test_ganesha.py53
-rw-r--r--manila/tests/test_quota.py4
-rw-r--r--manila/volume/cinder.py10
-rw-r--r--playbooks/legacy/grenade-dsvm-manila/post.yaml2
-rw-r--r--playbooks/legacy/grenade-dsvm-manila/run.yaml4
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-container-scenario-custom-image/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-container-scenario-custom-image/run.yaml4
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-generic-no-share-servers/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-generic-no-share-servers/run.yaml4
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-generic-scenario-custom-image/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-generic-scenario-custom-image/run.yaml4
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-glusterfs-native-heketi/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-glusterfs-native-heketi/run.yaml6
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-glusterfs-native/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-glusterfs-native/run.yaml6
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-glusterfs-nfs-heketi/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-glusterfs-nfs-heketi/run.yaml6
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-glusterfs-nfs/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-glusterfs-nfs/run.yaml6
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-hdfs/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-hdfs/run.yaml6
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-mysql-generic/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-mysql-generic/run.yaml4
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-postgres-container/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-postgres-container/run.yaml4
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-postgres-generic-singlebackend/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-postgres-generic-singlebackend/run.yaml4
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-postgres-zfsonlinux/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-postgres-zfsonlinux/run.yaml4
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-scenario/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-dsvm-scenario/run.yaml4
-rw-r--r--playbooks/legacy/manila-tempest-minimal-dsvm-cephfs-native-centos-7/run.yaml6
-rw-r--r--playbooks/legacy/manila-tempest-minimal-dsvm-cephfs-native/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-minimal-dsvm-cephfs-native/run.yaml6
-rw-r--r--playbooks/legacy/manila-tempest-minimal-dsvm-cephfs-nfs-centos-7/run.yaml6
-rw-r--r--playbooks/legacy/manila-tempest-minimal-dsvm-cephfs-nfs/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-minimal-dsvm-cephfs-nfs/run.yaml6
-rw-r--r--playbooks/legacy/manila-tempest-minimal-dsvm-dummy/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-minimal-dsvm-dummy/run.yaml4
-rw-r--r--playbooks/legacy/manila-tempest-minimal-dsvm-lvm/post.yaml2
-rw-r--r--playbooks/legacy/manila-tempest-minimal-dsvm-lvm/run.yaml8
-rw-r--r--playbooks/legacy/manila-tempest-minimal-py35-dsvm-cephfs-native-centos-7/run.yaml6
-rw-r--r--playbooks/legacy/manila-tempest-minimal-py35-dsvm-cephfs-nfs-centos-7/run.yaml6
-rw-r--r--playbooks/legacy/rally-dsvm-manila-multibackend-no-ss/post.yaml2
-rw-r--r--playbooks/legacy/rally-dsvm-manila-multibackend-no-ss/run.yaml6
-rw-r--r--playbooks/legacy/rally-dsvm-manila-multibackend/post.yaml2
-rw-r--r--playbooks/legacy/rally-dsvm-manila-multibackend/run.yaml6
-rw-r--r--releasenotes/notes/bug-1777551-security-networks-api-all-tenants-fix-a061274afe15180d.yaml8
-rw-r--r--releasenotes/notes/bug-1777551-security-services-api-all-tenants-fix-e820ec370d7df473.yaml8
-rw-r--r--releasenotes/notes/bug-1811680-destroy-quotas-usages-reservations-when-deleting-share-type-a18f2e00a65fe922.yaml7
-rw-r--r--releasenotes/notes/bug-1816420-validate-access-type-for-ganehas-c42ce6f859fa0c8c.yaml8
-rw-r--r--releasenotes/notes/bug-1818081-fix-inferred-script-name-in-case-of-proxy-urls-e33466af856708b4.yaml 7
-rw-r--r--releasenotes/notes/fix-volume-efficiency-status-2102ad630c5407a8.yaml4
-rw-r--r--releasenotes/notes/fixing-driver-filter-14022294c8c04d2d.yaml8
-rw-r--r--releasenotes/source/index.rst1
-rw-r--r--releasenotes/source/stein.rst6
-rw-r--r--setup.cfg2
-rw-r--r--tox.ini2
156 files changed, 2502 insertions, 2156 deletions
diff --git a/.zuul.yaml b/.zuul.yaml
index 2337323..75c34bf 100644
--- a/.zuul.yaml
+++ b/.zuul.yaml
@@ -38,6 +38,7 @@
38 voting: false 38 voting: false
39 - openstack-tox-pylint: 39 - openstack-tox-pylint:
40 voting: false 40 voting: false
41 timeout: 5400
41 - openstack-tox-cover: 42 - openstack-tox-cover:
42 voting: false 43 voting: false
43 gate: 44 gate:
@@ -59,7 +60,6 @@
59- job: 60- job:
60 name: manila-tempest-base 61 name: manila-tempest-base
61 parent: legacy-dsvm-base 62 parent: legacy-dsvm-base
62 nodeset: openstack-single-node-bionic
63 timeout: 7200 63 timeout: 7200
64 irrelevant-files: 64 irrelevant-files:
65 - ^(test-|)requirements.txt$ 65 - ^(test-|)requirements.txt$
@@ -380,7 +380,6 @@
380- job: 380- job:
381 name: manila-rally-multibackend 381 name: manila-rally-multibackend
382 parent: legacy-dsvm-base 382 parent: legacy-dsvm-base
383 nodeset: openstack-single-node-bionic
384 run: playbooks/legacy/rally-dsvm-manila-multibackend/run.yaml 383 run: playbooks/legacy/rally-dsvm-manila-multibackend/run.yaml
385 post-run: playbooks/legacy/rally-dsvm-manila-multibackend/post.yaml 384 post-run: playbooks/legacy/rally-dsvm-manila-multibackend/post.yaml
386 timeout: 4200 385 timeout: 4200
@@ -403,7 +402,6 @@
403- job: 402- job:
404 name: manila-rally-multibackend-no-ss 403 name: manila-rally-multibackend-no-ss
405 parent: legacy-dsvm-base 404 parent: legacy-dsvm-base
406 nodeset: openstack-single-node-bionic
407 run: playbooks/legacy/rally-dsvm-manila-multibackend-no-ss/run.yaml 405 run: playbooks/legacy/rally-dsvm-manila-multibackend-no-ss/run.yaml
408 post-run: playbooks/legacy/rally-dsvm-manila-multibackend-no-ss/post.yaml 406 post-run: playbooks/legacy/rally-dsvm-manila-multibackend-no-ss/post.yaml
409 timeout: 4200 407 timeout: 4200
diff --git a/api-ref/source/availability-zones.inc b/api-ref/source/availability-zones.inc
index a6ab28d..b1ee1da 100644
--- a/api-ref/source/availability-zones.inc
+++ b/api-ref/source/availability-zones.inc
@@ -16,7 +16,7 @@ configured with.
16List availability zones 16List availability zones
17======================= 17=======================
18 18
19.. rest_method:: GET /v2/{tenant_id}/availability-zones 19.. rest_method:: GET /v2/{project_id}/availability-zones
20 20
21Lists all availability zones. 21Lists all availability zones.
22 22
@@ -38,7 +38,7 @@ Request
38 38
39.. rest_parameters:: parameters.yaml 39.. rest_parameters:: parameters.yaml
40 40
41 - tenant_id: tenant_id 41 - project_id: project_id_path
42 42
43Response parameters 43Response parameters
44------------------- 44-------------------
@@ -48,8 +48,8 @@ Response parameters
48 - availability_zones: availability_zones 48 - availability_zones: availability_zones
49 - id: availability_zone_id 49 - id: availability_zone_id
50 - name: availability_zone_name 50 - name: availability_zone_name
51 - created_at: availability_zone_created_at 51 - created_at: created_at
52 - updated_at: availability_zone_updated_at 52 - updated_at: updated_at
53 53
54Response example 54Response example
55---------------- 55----------------
diff --git a/api-ref/source/extensions.inc b/api-ref/source/extensions.inc
index 0cf2bc7..c70b7ab 100644
--- a/api-ref/source/extensions.inc
+++ b/api-ref/source/extensions.inc
@@ -10,7 +10,7 @@ Lists available Shared File Systems API extensions.
10List extensions 10List extensions
11=============== 11===============
12 12
13.. rest_method:: GET /v2/{tenant_id}/extensions 13.. rest_method:: GET /v2/{project_id}/extensions
14 14
15Lists all extensions. 15Lists all extensions.
16 16
@@ -32,7 +32,7 @@ Request
32 32
33.. rest_parameters:: parameters.yaml 33.. rest_parameters:: parameters.yaml
34 34
35 - tenant_id: tenant_id_path 35 - project_id: project_id_path
36 36
37Response parameters 37Response parameters
38------------------- 38-------------------
@@ -43,7 +43,7 @@ Response parameters
43 - links: extension_links 43 - links: extension_links
44 - description: extension_description 44 - description: extension_description
45 - alias: extension_alias 45 - alias: extension_alias
46 - updated: extension_updated 46 - updated: updated_at_extensions
47 47
48Response example 48Response example
49---------------- 49----------------
diff --git a/api-ref/source/limits.inc b/api-ref/source/limits.inc
index 8ece2b9..62ffc2a 100644
--- a/api-ref/source/limits.inc
+++ b/api-ref/source/limits.inc
@@ -33,7 +33,7 @@ GET requests that can be processed during a one-minute period.
33List share limits 33List share limits
34================= 34=================
35 35
36.. rest_method:: GET /v2/{tenant_id}/limits 36.. rest_method:: GET /v2/{project_id}/limits
37 37
38Lists share limits. 38Lists share limits.
39 39
@@ -55,7 +55,7 @@ Request
55 55
56.. rest_parameters:: parameters.yaml 56.. rest_parameters:: parameters.yaml
57 57
58 - tenant_id: tenant_id_path 58 - project_id: project_id_path
59 59
60Response parameters 60Response parameters
61------------------- 61-------------------
diff --git a/api-ref/source/os-share-manage.inc b/api-ref/source/os-share-manage.inc
index 8a25871..97601d0 100644
--- a/api-ref/source/os-share-manage.inc
+++ b/api-ref/source/os-share-manage.inc
@@ -1,29 +1,31 @@
1.. -*- rst -*- 1.. -*- rst -*-
2 2
3========================== 3=======================================
4Manage and unmanage shares 4Manage and unmanage shares (DEPRECATED)
5========================== 5=======================================
6 6
7Configures Shared File Systems to manage or unmanage a share. 7Allows bringing shared file systems under service management.
8 8
9 9
10Manage share 10Manage share (DEPRECATED)
11============ 11=========================
12 12
13.. rest_method:: POST /v2/{tenant_id}/os-share-manage 13.. warning::
14 14
15**Minimum Supported API Version**: 1.0, 2.0 15 This API is deprecated starting with microversion 2.7 and requests to
16**Last supported API Version**: 2.6 16 this API will fail with a 404 starting from microversion 2.7. Use
17 `Share Manage API <#manage-share-since-api-v2-7>`_ instead of this API
18 from version 2.7.
19
20.. rest_method:: POST /v2/{project_id}/os-share-manage
17 21
18Use this API to bring a share under the management of the Shared File 22Use this API to bring a share under the management of the Shared File
19Systems service. 23Systems service. In the service, the share will be represented as a resource
24in the database. It can have a user defined name and description.
20 25
21Administrator only. Use the ``policy.json`` file to grant permissions for this 26Administrator only. Use the ``policy.json`` file to grant permissions for this
22action to other roles. 27action to other roles.
23 28
24This API was removed in API version 2.7; please see share actions for the
25new version of the API to utilize this feature.
26
27Response codes 29Response codes
28-------------- 30--------------
29 31
@@ -44,18 +46,18 @@ Request
44 46
45.. rest_parameters:: parameters.yaml 47.. rest_parameters:: parameters.yaml
46 48
47 - tenant_id: tenant_id_path 49 - project_id: project_id_path
48 - share: share 50 - share: share
49 - protocol: protocol 51 - protocol: protocol
50 - name: name_5 52 - name: name_request
51 - display_name: display_name 53 - display_name: display_name_request
52 - share_type: share_type_2 54 - share_type: share_type_2
53 - driver_options: driver_options 55 - driver_options: driver_options
54 - export_path: export_path 56 - export_path: export_path
55 - service_host: service_host 57 - service_host: service_host
56 - is_public: is_public 58 - is_public: is_public
57 - description: description_5 59 - description: description_request
58 - display_description: display_description 60 - display_description: display_description_request
59 61
60Request example 62Request example
61--------------- 63---------------
@@ -82,15 +84,15 @@ Response parameters
82 - has_replicas: has_replicas 84 - has_replicas: has_replicas
83 - replication_type: replication_type 85 - replication_type: replication_type
84 - export_location: export_location 86 - export_location: export_location
85 - project_id: project_id_8 87 - project_id: project_id
86 - metadata: metadata 88 - metadata: metadata
87 - status: status_8 89 - status: status_8
88 - description: description_5 90 - description: description
89 - host: host_7 91 - host: host_1
90 - is_public: is_public 92 - is_public: is_public
91 - snapshot_support: snapshot_support 93 - snapshot_support: snapshot_support
92 - name: name_5 94 - name: name
93 - created_at: created_at_4 95 - created_at: created_at
94 - share_proto: share_proto 96 - share_proto: share_proto
95 - volume_type: volume_type 97 - volume_type: volume_type
96 98
@@ -101,26 +103,32 @@ Response example
101 :language: javascript 103 :language: javascript
102 104
103 105
104Unmanage share 106Unmanage share (DEPRECATED)
105============== 107===========================
108
109.. warning::
106 110
107.. rest_method:: POST /v2/{tenant_id}/os-share-unmanage/{share_id}/unmanage 111 This API is deprecated starting with microversion 2.7 and requests to
112 this API will fail with a 404 starting from microversion 2.7. Use
113 `Share Unmanage API <#unmanage-share-since-api-v2-7>`_ instead of this
114 API from version 2.7.
108 115
109**Minimum Supported API Version**: 1.0, 2.0 116.. rest_method:: POST /v2/{project_id}/os-share-unmanage/{share_id}/unmanage
110**Last supported API Version**: 2.6
111 117
112Use this API to remove a share from the management of the Shared File 118Use this API to remove a share from the management of the Shared File
113Systems service. 119Systems service without deleting the share.
114 120
115Administrator only. Use the ``policy.json`` file to grant permissions for this 121Administrator only. Use the ``policy.json`` file to grant permissions for this
116action to other roles. 122action to other roles.
117 123
118Share unmanage operation is not supported for shares that are created on top
119of share servers (created with share networks). You should remove any
120snapshots and share replicas before attempting to unmanage a share.
121 124
122This API was removed in API version 2.7; please see share actions for the 125Preconditions:
123new version of the API to utilize this feature. 126
127- This API does not support unmanaging shares that are created on top
128 of share servers (i.e. created with share networks).
129- You should remove any snapshots and share replicas before attempting to
130 unmanage a share.
131
124 132
125Response codes 133Response codes
126-------------- 134--------------
@@ -142,5 +150,11 @@ Request
142 150
143.. rest_parameters:: parameters.yaml 151.. rest_parameters:: parameters.yaml
144 152
145 - tenant_id: tenant_id_path 153 - project_id: project_id_path
146 - share_id: share_id 154 - share_id: share_id
155
156
157Response parameters
158-------------------
159
160There is no body content for the response.
diff --git a/api-ref/source/parameters.yaml b/api-ref/source/parameters.yaml
index 65a23d7..41a7fe3 100644
--- a/api-ref/source/parameters.yaml
+++ b/api-ref/source/parameters.yaml
@@ -20,7 +20,7 @@ export_location_id_path:
20 in: path 20 in: path
21 required: true 21 required: true
22 type: string 22 type: string
23extra-spec-key-path: 23extra_spec_key_path:
24 description: | 24 description: |
25 The extra specification key 25 The extra specification key
26 in: path 26 in: path
@@ -46,6 +46,23 @@ metadata_key_path:
46 in: path 46 in: path
47 required: false 47 required: false
48 type: string 48 type: string
49project_id_path:
50 description: |
51 The project ID of the user or service making the API request.
52 in: path
53 required: true
54 type: string
55project_id_quota_request_path:
56 description: |
57 The ID of the project whose quotas must be acted upon by the API.
58 This ID can be different from the first project ID in the URI.
59 For example, in a multi-tenant cloud, the first ID in the URI is
60 typically the project ID of a privileged user (such as a cloud
61 administrator) that can create, query or delete quotas of other projects
62 in the cloud.
63 in: path
64 required: true
65 type: string
49quota_class_name: 66quota_class_name:
50 description: 67 description:
51 The name of the quota class for which to set quotas. 68 The name of the quota class for which to set quotas.
@@ -121,21 +138,6 @@ snapshot_instance_id_path:
121 in: path 138 in: path
122 required: true 139 required: true
123 type: string 140 type: string
124tenant_id:
125 description: |
126 The UUID for the tenant for which you want to
127 show, update, or delete quotas. This ID is different from the
128 first tenant ID that you specify in the URI: That ID is for the
129 administrative tenant.
130 in: path
131 required: true
132 type: string
133tenant_id_path:
134 description: |
135 The tenant ID in a multi-tenancy cloud.
136 in: path
137 required: true
138 type: string
139 141
140# variables in query 142# variables in query
141action_id: 143action_id:
@@ -144,11 +146,11 @@ action_id:
144 type: string 146 type: string
145 description: > 147 description: >
146 The ID of the action during which the message was created. 148 The ID of the action during which the message was created.
147all_tenants: 149all_tenants_query:
148 description: | 150 description: |
149 (Admin only). Defines whether to list the requested resources for 151 (Admin only). Defines whether to list the requested resources for
150 all projects. Set to ``1`` to list resources for all projects. 152 all projects. Set to ``1`` to list resources for all projects.
151 Set to ``0`` to list resources only for the current tenant. Examples 153 Set to ``0`` to list resources only for the current project. Examples
152 of resources include shares, snapshots, share networks, security services 154 of resources include shares, snapshots, share networks, security services
153 and share groups. 155 and share groups.
154 in: query 156 in: query
@@ -188,8 +190,7 @@ description_inexact_query:
188 min_version: 2.36 190 min_version: 2.36
189description_query: 191description_query:
190 description: | 192 description: |
191 The share group description that can be used to filter 193 The user defined description text that can be used to filter resources.
192 share groups.
193 in: query 194 in: query
194 required: false 195 required: false
195 type: string 196 type: string
@@ -225,20 +226,6 @@ extra_specs_query:
225 required: false 226 required: false
226 type: string 227 type: string
227 min_version: 2.43 228 min_version: 2.43
228group_snapshot_description_query:
229 description: |
230 The share group snapshot description that can be used to filter
231 share group snapshots.
232 in: query
233 required: false
234 type: string
235group_snapshot_name_query:
236 description: |
237 The share group snapshot name that can be used to filter
238 share group snapshots.
239 in: query
240 required: false
241 type: string
242group_snapshot_status_query: 229group_snapshot_status_query:
243 description: | 230 description: |
244 Filters by a share group snapshot status. A valid value is 231 Filters by a share group snapshot status. A valid value is
@@ -247,12 +234,21 @@ group_snapshot_status_query:
247 in: query 234 in: query
248 required: false 235 required: false
249 type: string 236 type: string
250host_7: 237host_query:
251 description: | 238 description: |
252 The share host name. 239 The host name of the resource to query with. Querying by hostname is a
240 privileged operation. If restricted by API policy, this query parameter
241 may be silently ignored by the server.
253 in: query 242 in: query
254 required: false 243 required: false
255 type: string 244 type: string
245is_public_query:
246 description: |
247 A boolean query parameter that, when set to true, allows retrieving
248 public resources that belong to all projects.
249 in: query
250 required: false
251 type: boolean
256limit: 252limit:
257 description: | 253 description: |
258 The maximum number of shares to return. 254 The maximum number of shares to return.
@@ -265,18 +261,19 @@ limit_query:
265 in: query 261 in: query
266 required: false 262 required: false
267 type: integer 263 type: integer
268media_types:
269 description: |
270 Media types supported by the API.
271 in: query
272 required: false
273 type: object
274message_level: 264message_level:
275 in: query 265 in: query
276 required: false 266 required: false
277 type: string 267 type: string
278 description: > 268 description: >
279 The message level. 269 The message level.
270metadata_query:
271 in: query
272 required: false
273 type: object
274 description: |
275 One or more metadata key and value pairs as a
276 url encoded dictionary of strings.
280name_inexact_query: 277name_inexact_query:
281 description: | 278 description: |
282 The name pattern that can be used to filter shares, 279 The name pattern that can be used to filter shares,
@@ -287,7 +284,7 @@ name_inexact_query:
287 min_version: 2.36 284 min_version: 2.36
288name_query: 285name_query:
289 description: | 286 description: |
290 The share group name that can be used to filter share groups. 287 The user defined name of the resource to filter resources by.
291 in: query 288 in: query
292 required: false 289 required: false
293 type: string 290 type: string
@@ -298,22 +295,22 @@ offset:
298 in: query 295 in: query
299 required: false 296 required: false
300 type: integer 297 type: integer
301project_id_6: 298project_id_messages:
302 description: | 299 description: |
303 The UUID of the project in which the share was 300 The ID of the project for which the message was created.
304 created. Useful with ``all_tenants`` parameter.
305 in: query 301 in: query
306 required: false 302 required: false
307 type: string 303 type: string
308project_id_messages: 304project_id_query:
309 description: | 305 description: |
310 The UUID of the project for which the message was created. 306 The ID of the project that owns the resource. This query parameter is
307 useful in conjunction with the ``all_tenants`` parameter.
311 in: query 308 in: query
312 required: false 309 required: false
313 type: string 310 type: string
314request_id: 311request_id:
315 description: | 312 description: |
316 The UUID of the request during which the message was created. 313 The ID of the request during which the message was created.
317 in: query 314 in: query
318 required: false 315 required: false
319 type: string 316 type: string
@@ -383,15 +380,21 @@ share_group_type_id_query:
383 in: query 380 in: query
384 required: false 381 required: false
385 type: string 382 type: string
386share_network_id_5: 383share_id_access_rules_query:
387 description: | 384 description: |
388 The UUID of the share network. 385 The share ID to filter share access rules with.
386 in: query
387 required: true
388 type: string
389share_id_replicas_query:
390 description: |
391 The share ID to filter share replicas with.
389 in: query 392 in: query
390 required: false 393 required: false
391 type: string 394 type: string
392share_network_id_query: 395share_network_id_query:
393 description: | 396 description: |
394 The UUID of the share network. 397 The UUID of the share network to filter resources by.
395 in: query 398 in: query
396 required: false 399 required: false
397 type: string 400 type: string
@@ -401,13 +404,12 @@ share_server_id_query:
401 in: query 404 in: query
402 required: false 405 required: false
403 type: string 406 type: string
404share_type_id_2: 407share_type_id_query:
405 description: | 408 description: |
406 The UUID of the share type. 409 The UUID of a share type to query resources by.
407 in: query 410 in: query
408 required: false 411 required: false
409 type: string 412 type: string
410 min_version: 2.6
411share_type_query: 413share_type_query:
412 description: | 414 description: |
413 The share type name or UUID. Allows filtering back end pools based 415 The share type name or UUID. Allows filtering back end pools based
@@ -415,6 +417,7 @@ share_type_query:
415 in: query 417 in: query
416 required: false 418 required: false
417 type: string 419 type: string
420 min_version: 2.23
418share_types_query: 421share_types_query:
419 description: | 422 description: |
420 A list of one or more share type IDs. Allows filtering share groups. 423 A list of one or more share type IDs. Allows filtering share groups.
@@ -462,26 +465,12 @@ source_share_group_snapshot_id_query:
462 required: false 465 required: false
463 type: string 466 type: string
464 min_version: 2.31 467 min_version: 2.31
465state_2: 468status_query:
466 description: |
467 The current state of the service. A valid value
468 is ``up`` or ``down``.
469 in: query
470 required: false
471 type: string
472status_17:
473 description: |
474 The service status, which is ``enabled`` or
475 ``disabled``.
476 in: query
477 required: false
478 type: string
479status_6:
480 description: | 469 description: |
481 Filters by a share status. A valid value is 470 Filters by a share status. A valid value is
482 ``creating``, ``error``, ``available``, ``deleting``, 471 ``creating``, ``error``, ``available``, ``deleting``,
483 ``error_deleting``, ``manage_starting``, ``manage_error``, 472 ``error_deleting``, ``manage_starting``, ``manage_error``,
484 ``unmanage_starting``, ``unmanage_error``, ``unmanaged``, 473 ``unmanage_starting``, ``unmanage_error``, ``migrating``,
485 ``extending``, ``extending_error``, ``shrinking``, 474 ``extending``, ``extending_error``, ``shrinking``,
486 ``shrinking_error``, or ``shrinking_possible_data_loss_error``. 475 ``shrinking_error``, or ``shrinking_possible_data_loss_error``.
487 in: query 476 in: query
@@ -489,25 +478,19 @@ status_6:
489 type: string 478 type: string
490user_id_query: 479user_id_query:
491 description: | 480 description: |
492 The UUID of the user. If you specify this query parameter, 481 The ID of the user. If you specify this query parameter, you update the
493 you update the quotas for this user in the tenant. 482 quotas for this user in the project. If you omit this parameter, you
494 If you omit this parameter, you update the quotas for the project. 483 update the quotas for the whole project.
495 in: query 484 in: query
496 required: false 485 required: false
497 type: string 486 type: string
498with_count: 487with_count_query:
499 description: | 488 description: |
500 Whether to show ``count`` in API response or not, default is ``False``. 489 Whether to show ``count`` in API response or not, default is ``False``.
501 in: query 490 in: query
502 required: false 491 required: false
503 type: boolean 492 type: boolean
504 min_version: 2.42 493 min_version: 2.42
505zone_1:
506 description: |
507 The availability zone.
508 in: query
509 required: false
510 type: string
511 494
512# variables in body 495# variables in body
513access: 496access:
@@ -553,50 +536,12 @@ access_metadata:
553 in: body 536 in: body
554 required: true 537 required: true
555 type: object 538 type: object
556access_rule_created_at:
557 description: |
558 The date and time stamp when the access rule was created.
559
560 The date and time stamp format is `ISO 8601
561 <https://en.wikipedia.org/wiki/ISO_8601>`_:
562
563 ::
564
565 CCYY-MM-DDThh:mm:ss±hh:mm
566
567 The ``±hh:mm`` value, if included, returns the time zone as an
568 offset from UTC.
569
570 For example, ``2015-08-27T09:49:58-05:00``.
571 in: body
572 required: true
573 type: string
574access_rule_id: 539access_rule_id:
575 description: | 540 description: |
576 The access rule ID. 541 The access rule ID.
577 in: body 542 in: body
578 required: true 543 required: true
579 type: string 544 type: string
580access_rule_updated_at:
581 description: |
582 The date and time stamp when the access rule was updated.
583
584 The date and time stamp format is `ISO 8601
585 <https://en.wikipedia.org/wiki/ISO_8601>`_:
586
587 ::
588
589 CCYY-MM-DDThh:mm:ss±hh:mm
590
591 The ``±hh:mm`` value, if included, returns the time zone as an
592 offset from UTC.
593
594 For example, ``2015-08-27T09:49:58-05:00``.
595
596 If the access rule was never updated, this value is ``null``.
597 in: body
598 required: true
599 type: string
600access_rules_status: 545access_rules_status:
601 description: | 546 description: |
602 The share instance access rules status. A valid value is ``active``, 547 The share instance access rules status. A valid value is ``active``,
@@ -660,14 +605,13 @@ action_id_body:
660 type: string 605 type: string
661 description: > 606 description: >
662 The ID of the action during which the message was created. 607 The ID of the action during which the message was created.
663alias: 608add_project_access:
664 description: | 609 description: |
665 The alias for the extension. For example, 610 An object representing the project resource that access should be
666 "FOXNSOX," "os- availability-zone," "os-extended-quotas," "os- 611 granted to.
667 share-unmanage," or "os-used-limits."
668 in: body 612 in: body
669 required: true 613 required: true
670 type: string 614 type: object
671allow_access: 615allow_access:
672 description: | 616 description: |
673 The object of grant access. 617 The object of grant access.
@@ -687,24 +631,6 @@ availability_zone_1:
687 in: body 631 in: body
688 required: true 632 required: true
689 type: string 633 type: string
690availability_zone_created_at:
691 description: |
692 The date and time stamp when the availability zone was created.
693
694 The date and time stamp format is `ISO 8601
695 <https://en.wikipedia.org/wiki/ISO_8601>`_:
696
697 ::
698
699 CCYY-MM-DDThh:mm:ss±hh:mm
700
701 The ``±hh:mm`` value, if included, returns the time zone as an
702 offset from UTC.
703
704 For example, ``2015-08-27T09:49:58-05:00``.
705 in: body
706 required: true
707 type: string
708availability_zone_id: 634availability_zone_id:
709 description: | 635 description: |
710 The availability zone ID. 636 The availability zone ID.
@@ -724,24 +650,6 @@ availability_zone_name:
724 in: body 650 in: body
725 required: true 651 required: true
726 type: string 652 type: string
727availability_zone_updated_at:
728 description: |
729 The date and time stamp when the availability zone was updated.
730
731 The date and time stamp format is `ISO 8601
732 <https://en.wikipedia.org/wiki/ISO_8601>`_:
733
734 ::
735
736 CCYY-MM-DDThh:mm:ss±hh:mm
737
738 The ``±hh:mm`` value, if included, returns the time zone as an
739 offset from UTC.
740
741 For example, ``2015-08-27T09:49:58-05:00``.
742 in: body
743 required: true
744 type: string
745availability_zones: 653availability_zones:
746 description: | 654 description: |
747 Top level response body element. 655 Top level response body element.
@@ -761,14 +669,6 @@ backend_details:
761 example, the generic back- end driver might store the router ID. 669 example, the generic back- end driver might store the router ID.
762 in: body 670 in: body
763 required: true 671 required: true
764 type: string
765backend_details_1:
766 description: |
767 The back-end details for a server. Each back end
768 can store any key- value information that it requires. For
769 example, the generic back- end driver might store the router ID.
770 in: body
771 required: true
772 type: object 672 type: object
773backend_host: 673backend_host:
774 description: | 674 description: |
@@ -785,41 +685,6 @@ backend_name:
785 in: body 685 in: body
786 required: true 686 required: true
787 type: string 687 type: string
788binary:
789 description: |
790 The name of the service binary that you want to
791 disable. Typically, this name is the base name of the executable.
792 in: body
793 required: true
794 type: string
795binary_1:
796 description: |
797 The name of the service binary that you want to
798 enable. Typically, this name is the base name of the executable.
799 in: body
800 required: true
801 type: string
802binary_2:
803 description: |
804 The service binary name. Default is the base name
805 of the executable.
806 in: body
807 required: true
808 type: string
809binary_4:
810 description: |
811 The name of the disabled service binary.
812 Typically, this name is the base name of the executable.
813 in: body
814 required: true
815 type: string
816binary_5:
817 description: |
818 The name of the enabled service binary.
819 Typically, this name is the base name of the executable.
820 in: body
821 required: true
822 type: string
823capabilities: 688capabilities:
824 description: | 689 description: |
825 The back end capabilities which include ``qos``, ``total_capacity_gb``, 690 The back end capabilities which include ``qos``, ``total_capacity_gb``,
@@ -949,9 +814,10 @@ create_share_from_snapshot_support:
949 required: false 814 required: false
950 type: boolean 815 type: boolean
951 min_version: 2.24 816 min_version: 2.24
952created_at_4: 817created_at:
953 description: | 818 description: |
954 The date and time stamp when the share was created. 819 The date and time stamp when the resource was created within the service's
820 database.
955 821
956 The date and time stamp format is `ISO 8601 822 The date and time stamp format is `ISO 8601
957 <https://en.wikipedia.org/wiki/ISO_8601>`_: 823 <https://en.wikipedia.org/wiki/ISO_8601>`_:
@@ -963,69 +829,7 @@ created_at_4:
963 The ``±hh:mm`` value, if included, returns the time zone as an 829 The ``±hh:mm`` value, if included, returns the time zone as an
964 offset from UTC. 830 offset from UTC.
965 831
966 For example, ``2015-08-27T09:49:58-05:00``. 832 For example, ``2019-03-27T09:49:58-05:00``.
967 in: body
968 required: true
969 type: string
970created_at_5:
971 description: |
972 The date and time stamp when the share instance export location was
973 created.
974
975 The date and time stamp format is `ISO 8601
976 <https://en.wikipedia.org/wiki/ISO_8601>`_:
977
978 ::
979
980 CCYY-MM-DDThh:mm:ss±hh:mm
981
982 The ``±hh:mm`` value, if included, returns the time zone as an
983 offset from UTC.
984
985 For example, ``2016-12-31T13:14:15-05:00``.
986 in: body
987 required: true
988 type: string
989created_at_8:
990 description: |
991 The date and time stamp when the member was
992 created.
993 in: body
994 required: true
995 type: string
996created_at_9:
997 description: |
998 The date and time stamp when the share instance was created.
999
1000 The date and time stamp format is `ISO 8601
1001 <https://en.wikipedia.org/wiki/ISO_8601>`_:
1002
1003 ::
1004
1005 CCYY-MM-DDThh:mm:ss±hh:mm
1006
1007 The ``±hh:mm`` value, if included, returns the time zone as an
1008 offset from UTC.
1009
1010 For example, ``2015-08-27T09:49:58-05:00``.
1011 in: body
1012 required: true
1013 type: string
1014created_at_share_server_body:
1015 description: |
1016 The date and time stamp when the share server was created.
1017
1018 The date and time stamp format is `ISO 8601
1019 <https://en.wikipedia.org/wiki/ISO_8601>`_:
1020
1021 ::
1022
1023 CCYY-MM-DDThh:mm:ss±hh:mm
1024
1025 The ``±hh:mm`` value, if included, returns the time zone as an
1026 offset from UTC.
1027
1028 For example, ``2015-08-27T09:49:58-05:00``.
1029 in: body 833 in: body
1030 required: true 834 required: true
1031 type: string 835 type: string
@@ -1035,110 +839,36 @@ deny_access:
1035 in: body 839 in: body
1036 required: true 840 required: true
1037 type: object 841 type: object
1038description_10: 842description:
1039 description: | 843 description: |
1040 The snapshot description. 844 The user defined description of the resource.
1041 in: body
1042 required: false
1043 type: string
1044description_11:
1045 description: |
1046 The snapshot description.
1047 in: body 845 in: body
1048 required: true 846 required: true
1049 type: string 847 type: string
1050description_3: 848description_request:
1051 description: |
1052 The security service description.
1053 in: body
1054 required: false
1055 type: string
1056description_4:
1057 description: | 849 description: |
1058 The share network description. 850 The user defined description of the resource. The value of this field is
851 limited to 255 characters.
1059 in: body 852 in: body
1060 required: false 853 required: false
1061 type: string 854 type: string
1062description_5:
1063 description: |
1064 The share description.
1065 in: body
1066 required: false
1067 type: string
1068description_8:
1069 description: |
1070 The extension description.
1071 in: body
1072 required: true
1073 type: string
1074description_9:
1075 description: |
1076 The security service description.
1077 in: body
1078 required: true
1079 type: string
1080detail_id_body: 855detail_id_body:
1081 in: body 856 in: body
1082 required: true 857 required: true
1083 type: string 858 type: string
1084 description: > 859 description: >
1085 The ID of the message detail. 860 The ID of the message detail.
1086disabled: 861display_description_request:
1087 description: |
1088 Indicates whether the service is disabled.
1089 in: body
1090 required: true
1091 type: boolean
1092display_description:
1093 description: | 862 description: |
1094 The share description. The Shared File Systems 863 The user defined description of the resource. This field sets the
1095 API supports the use of both ``description`` and 864 ``description`` parameter.
1096 ``display_description`` parameters, which are inherited attributes
1097 from the Block Storage API.
1098 in: body 865 in: body
1099 required: false 866 required: false
1100 type: string 867 type: string
1101display_description_2: 868display_name_request:
1102 description: | 869 description: |
1103 The snapshot description. If you specify this 870 The user defined name of the resource. This field sets the ``name``
1104 attribute, the snapshot ``description`` is updated. 871 parameter.
1105 in: body
1106 required: false
1107 type: string
1108display_description_3:
1109 description: |
1110 The share description. If you specify this
1111 parameter, the share description is updated.
1112 in: body
1113 required: false
1114 type: string
1115display_name:
1116 description: |
1117 The share name. The Shared File Systems API
1118 supports the use of both ``name`` and ``display_name`` attributes,
1119 which are inherited attributes from the Block Storage API.
1120 in: body
1121 required: false
1122 type: string
1123display_name_2:
1124 description: |
1125 The snapshot name. The shared file systems API
1126 supports the use of both ``name`` and ``display_name`` attributes,
1127 which are inherited attributes from the Block Storage API.
1128 in: body
1129 required: false
1130 type: string
1131display_name_3:
1132 description: |
1133 The snapshot name. If you specify this attribute,
1134 the snapshot ``name`` is updated.
1135 in: body
1136 required: false
1137 type: string
1138display_name_4:
1139 description: |
1140 The share name. If you specify this parameter,
1141 the share name is updated.
1142 in: body 872 in: body
1143 required: false 873 required: false
1144 type: string 874 type: string
@@ -1154,28 +884,9 @@ driver_handles_share_servers:
1154 in: body 884 in: body
1155 required: true 885 required: true
1156 type: boolean 886 type: boolean
1157driver_handles_share_servers_1:
1158 description: |
1159 An extra specification that defines the driver
1160 mode for share server, or storage, life cycle management. The
1161 Shared File Systems service creates a share server for the export
1162 of shares. Set to ``true`` when the share driver manages, or
1163 handles, the share server life cycle. Set to ``false`` when an
1164 administrator rather than a share driver manages the storage life
1165 cycle.
1166 in: body
1167 required: true
1168 type: boolean
1169driver_options: 887driver_options:
1170 description: | 888 description: |
1171 A set of one or more key and value pairs, as a 889 A set of one or more key and value pairs, as a
1172 dictionary of strings, that describe driver options.
1173 in: body
1174 required: false
1175 type: object
1176driver_options_1:
1177 description: |
1178 A set of one or more key and value pairs, as a
1179 dictionary of strings, that describe driver options. Details for 890 dictionary of strings, that describe driver options. Details for
1180 driver options should be taken from `appropriate share driver 891 driver options should be taken from `appropriate share driver
1181 documentation <https://docs.openstack.org/manila/latest 892 documentation <https://docs.openstack.org/manila/latest
@@ -1183,12 +894,6 @@ driver_options_1:
1183 in: body 894 in: body
1184 required: false 895 required: false
1185 type: object 896 type: object
1186driver_version:
1187 description: |
1188 The driver version.
1189 in: body
1190 required: true
1191 type: string
1192export_location: 897export_location:
1193 description: | 898 description: |
1194 The export location. For newer API versions it is available in 899 The export location. For newer API versions it is available in
@@ -1205,25 +910,6 @@ export_location_availability_zone:
1205 in: body 910 in: body
1206 required: true 911 required: true
1207 type: string 912 type: string
1208export_location_created_at:
1209 description: |
1210 The date and time stamp when the share export location was
1211 created.
1212
1213 The date and time stamp format is `ISO 8601
1214 <https://en.wikipedia.org/wiki/ISO_8601>`_:
1215
1216 ::
1217
1218 CCYY-MM-DDThh:mm:ss±hh:mm
1219
1220 The ``±hh:mm`` value, if included, returns the time zone as an
1221 offset from UTC.
1222
1223 For example, ``2016-12-31T13:14:15-05:00``.
1224 in: body
1225 required: true
1226 type: string
1227export_location_id: 913export_location_id:
1228 description: | 914 description: |
1229 The share export location UUID. 915 The share export location UUID.
@@ -1272,25 +958,6 @@ export_location_share_instance_id:
1272 in: body 958 in: body
1273 required: true 959 required: true
1274 type: string 960 type: string
1275export_location_updated_at:
1276 description: |
1277 The date and time stamp when the share export location was
1278 updated.
1279
1280 The date and time stamp format is `ISO 8601
1281 <https://en.wikipedia.org/wiki/ISO_8601>`_:
1282
1283 ::
1284
1285 CCYY-MM-DDThh:mm:ss±hh:mm
1286
1287 The ``±hh:mm`` value, if included, returns the time zone as an
1288 offset from UTC.
1289
1290 For example, ``2016-12-31T13:14:15-05:00``.
1291 in: body
1292 required: true
1293 type: string
1294export_locations: 961export_locations:
1295 description: | 962 description: |
1296 A list of export locations. For example, when a share server 963 A list of export locations. For example, when a share server
@@ -1329,7 +996,7 @@ extension_alias:
1329 type: string 996 type: string
1330extension_description: 997extension_description:
1331 description: | 998 description: |
1332 The extension description. 999 The description of the extension API.
1333 in: body 1000 in: body
1334 required: true 1001 required: true
1335 type: string 1002 type: string
@@ -1345,25 +1012,7 @@ extension_name:
1345 in: body 1012 in: body
1346 required: true 1013 required: true
1347 type: string 1014 type: string
1348extension_updated: 1015extra_spec_key:
1349 description: |
1350 The date and time stamp when the extension was last updated.
1351
1352 The date and time stamp format is `ISO 8601
1353 <https://en.wikipedia.org/wiki/ISO_8601>`_:
1354
1355 ::
1356
1357 CCYY-MM-DDThh:mm:ss±hh:mm
1358
1359 The ``±hh:mm`` value, if included, returns the time zone as an
1360 offset from UTC.
1361
1362 For example, ``2015-08-27T09:49:58-05:00``.
1363 in: body
1364 required: true
1365 type: string
1366extra-spec-key:
1367 description: | 1016 description: |
1368 The extra specification key 1017 The extra specification key
1369 in: body 1018 in: body
@@ -1410,44 +1059,6 @@ force_snapshot_request:
1410 in: body 1059 in: body
1411 required: false 1060 required: false
1412 type: boolean 1061 type: boolean
1413free_capacity_gb:
1414 description: |
1415 The amount of free capacity for the back end, in
1416 GBs. A valid value is a string, such as ``unknown``, or an
1417 integer.
1418 in: body
1419 required: true
1420 type: string
1421group_snapshot_created_at:
1422 description: |
1423 The date and time stamp when the share group snapshot was created.
1424
1425 The date and time stamp format is `ISO 8601
1426 <https://en.wikipedia.org/wiki/ISO_8601>`_:
1427
1428 ::
1429
1430 CCYY-MM-DDThh:mm:ss±hh:mm
1431
1432 The ``±hh:mm`` value, if included, returns the time zone as an
1433 offset from UTC.
1434
1435 For example, ``2015-08-27T09:49:58-05:00``.
1436 in: body
1437 required: true
1438 type: string
1439group_snapshot_description:
1440 description: |
1441 The share group snapshot description.
1442 in: body
1443 required: true
1444 type: string
1445group_snapshot_description_option:
1446 description: |
1447 The share group snapshot description.
1448 in: body
1449 required: false
1450 type: string
1451group_snapshot_id: 1062group_snapshot_id:
1452 description: | 1063 description: |
1453 The share group snapshot ID. 1064 The share group snapshot ID.
@@ -1466,18 +1077,6 @@ group_snapshot_members:
1466 in: body 1077 in: body
1467 required: true 1078 required: true
1468 type: string 1079 type: string
1469group_snapshot_name:
1470 description: |
1471 The share group snapshot name.
1472 in: body
1473 required: true
1474 type: string
1475group_snapshot_name_option:
1476 description: |
1477 The share group snapshot name.
1478 in: body
1479 required: false
1480 type: string
1481group_snapshot_status_required: 1080group_snapshot_status_required:
1482 description: | 1081 description: |
1483 Filters by a share group snapshot status. A valid value is 1082 Filters by a share group snapshot status. A valid value is
@@ -1527,39 +1126,6 @@ host_10:
1527 in: body 1126 in: body
1528 required: true 1127 required: true
1529 type: string 1128 type: string
1530host_13:
1531 description: |
1532 The host name of the disabled service.
1533 in: body
1534 required: true
1535 type: string
1536host_14:
1537 description: |
1538 The host name of the enabled service.
1539 enable.
1540 in: body
1541 required: true
1542 type: string
1543host_2:
1544 description: |
1545 The host name of the service that you want to
1546 disable.
1547 in: body
1548 required: true
1549 type: string
1550host_3:
1551 description: |
1552 The host name of the service that you want to
1553 enable.
1554 in: body
1555 required: true
1556 type: string
1557host_5:
1558 description: |
1559 The service host name.
1560 in: body
1561 required: true
1562 type: string
1563host_6: 1129host_6:
1564 description: | 1130 description: |
1565 The share instance host name. 1131 The share instance host name.
@@ -1578,46 +1144,21 @@ host_share_server_body:
1578 in: body 1144 in: body
1579 required: true 1145 required: true
1580 type: string 1146 type: string
1581id_12:
1582 description: |
1583 The service ID.
1584 in: body
1585 required: true
1586 type: integer
1587id_13: 1147id_13:
1588 description: | 1148 description: |
1589 The share instance ID. 1149 The share instance ID.
1590 in: body 1150 in: body
1591 required: true 1151 required: true
1592 type: string 1152 type: string
1593id_16:
1594 description: |
1595 The UUID of the snapshot.
1596 in: body
1597 required: true
1598 type: string
1599id_4: 1153id_4:
1600 description: | 1154 description: |
1601 The UUID of the share. 1155 The UUID of the share.
1602 in: body 1156 in: body
1603 required: true 1157 required: true
1604 type: string 1158 type: string
1605id_5: 1159identifier:
1606 description: |
1607 The share instance export location UUID.
1608 in: body
1609 required: true
1610 type: string
1611id_6:
1612 description: |
1613 The UUID of the export location that belongs to
1614 share instance.
1615 in: body
1616 required: true
1617 type: string
1618id_8:
1619 description: | 1160 description: |
1620 The UUID of the access rule. 1161 The identifier of the share server in the back-end storage system.
1621 in: body 1162 in: body
1622 required: true 1163 required: true
1623 type: string 1164 type: string
@@ -1636,12 +1177,12 @@ ip_version_1:
1636 in: body 1177 in: body
1637 required: true 1178 required: true
1638 type: integer 1179 type: integer
1639is_admin_only: 1180is_auto_deletable:
1640 description: | 1181 description: |
1641 Defines purpose of an export location. If set to 1182 Defines if a share server can be deleted automatically by the service.
1642 ``true``, then it is expected to be used for service needs and by 1183 Share server deletion can be automated with configuration. However, Share
1643 admin only. If it is set to ``false``, then this export location 1184 servers that have ever had a share removed from service management cannot
1644 should be used by end users. 1185 be automatically deleted by the service.
1645 in: body 1186 in: body
1646 required: true 1187 required: true
1647 type: boolean 1188 type: boolean
@@ -1672,30 +1213,27 @@ is_public:
1672 required: false 1213 required: false
1673 type: boolean 1214 type: boolean
1674 min_version: 2.8 1215 min_version: 2.8
1675link_1:
1676 description: |
1677 The share links
1678 in: body
1679 required: true
1680 type: array
1681links: 1216links:
1682 description: | 1217 description: |
1683 The share links 1218 The share links
1684 in: body 1219 in: body
1685 required: true 1220 required: true
1686 type: array 1221 type: array
1687links_1: 1222manage_host:
1688 description: | 1223 description: |
1689 The share links. 1224 The host of the destination back end, in this format: ``host@backend``.
1225 - ``host``. The host name for the destination back end.
1226 - ``backend``. The name of the destination back end.
1690 in: body 1227 in: body
1691 required: true 1228 required: true
1692 type: array 1229 type: string
1693links_2: 1230manage_share_server_id:
1694 description: | 1231 description: |
1695 The extension links. 1232 The UUID of the share server.
1696 in: body 1233 in: body
1697 required: true 1234 required: true
1698 type: array 1235 type: string
1236 min_version: 2.49
1699maxTotalShareGigabytes: 1237maxTotalShareGigabytes:
1700 description: | 1238 description: |
1701 The total maximum number of share gigabytes that 1239 The total maximum number of share gigabytes that
@@ -1861,60 +1399,14 @@ mount_snapshot_support:
1861 min_version: 2.32 1399 min_version: 2.32
1862name: 1400name:
1863 description: | 1401 description: |
1864 The share network name. 1402 The user defined name of the resource.
1865 in: body
1866 required: true
1867 type: string
1868name_10:
1869 description: |
1870 The name of the extension. For example, "Fox In
1871 Socks."
1872 in: body
1873 required: true
1874 type: string
1875name_11:
1876 description: |
1877 The name of the back end in this format:
1878 ``host@backend#POOL``. - ``host``. The host name for the back
1879 end. - ``backend``. The name of the back end. - ``POOL``. The
1880 pool name for the back end.
1881 in: body
1882 required: true
1883 type: string
1884name_14:
1885 description: |
1886 The snapshot name.
1887 in: body
1888 required: false
1889 type: string
1890name_15:
1891 description: |
1892 The snapshot name.
1893 in: body 1403 in: body
1894 required: true 1404 required: true
1895 type: string 1405 type: string
1896name_16: 1406name_request:
1897 description: | 1407 description: |
1898 The security service name. If you specify this 1408 The user defined name of the resource. The value of this field is
1899 value, the name is updated. 1409 limited to 255 characters.
1900 in: body
1901 required: false
1902 type: string
1903name_3:
1904 description: |
1905 The security service name.
1906 in: body
1907 required: false
1908 type: string
1909name_4:
1910 description: |
1911 The share network name.
1912 in: body
1913 required: false
1914 type: string
1915name_5:
1916 description: |
1917 The share name.
1918 in: body 1410 in: body
1919 required: false 1411 required: false
1920 type: string 1412 type: string
@@ -1985,24 +1477,12 @@ notify:
1985 in: body 1477 in: body
1986 required: true 1478 required: true
1987 type: string 1479 type: string
1988os-force_delete:
1989 description: |
1990 The ``force_delete`` object.
1991 in: body
1992 required: true
1993 type: object
1994os-migrate_share: 1480os-migrate_share:
1995 description: | 1481 description: |
1996 The ``migrate_share`` object. 1482 The ``migrate_share`` object.
1997 in: body 1483 in: body
1998 required: true 1484 required: true
1999 type: object 1485 type: object
2000os-reset_status:
2001 description: |
2002 The ``reset_status`` object.
2003 in: body
2004 required: true
2005 type: object
2006os-share-type-access:is_public: 1486os-share-type-access:is_public:
2007 description: | 1487 description: |
2008 Indicates whether a share type is publicly 1488 Indicates whether a share type is publicly
@@ -2011,12 +1491,6 @@ os-share-type-access:is_public:
2011 required: false 1491 required: false
2012 type: boolean 1492 type: boolean
2013 max_version: 2.6 1493 max_version: 2.6
2014path:
2015 description: |
2016 The export location path that should be used for mout operation.
2017 in: body
2018 required: true
2019 type: string
2020pool: 1494pool:
2021 description: | 1495 description: |
2022 The pool name for the back end. 1496 The pool name for the back end.
@@ -2032,15 +1506,6 @@ pools:
2032 in: body 1506 in: body
2033 required: true 1507 required: true
2034 type: string 1508 type: string
2035preferred:
2036 description: |
2037 Drivers may use this field to identify which export locations
2038 are most efficient and should be used preferentially by clients.
2039 By default it is set to ``false`` value.
2040 in: body
2041 required: true
2042 type: boolean
2043 min_version: 2.14
2044progress: 1509progress:
2045 description: | 1510 description: |
2046 The progress of the snapshot creation. 1511 The progress of the snapshot creation.
@@ -2054,50 +1519,33 @@ project:
2054 in: body 1519 in: body
2055 required: true 1520 required: true
2056 type: string 1521 type: string
2057project_1:
2058 description: |
2059 The UUID of the project for which access to the
2060 share type is denied.
2061 in: body
2062 required: true
2063 type: string
2064project_id: 1522project_id:
2065 description: | 1523 description: |
2066 The UUID of the project where the share network 1524 The ID of the project that owns the resource.
2067 was created.
2068 in: body
2069 required: true
2070 type: string
2071project_id_4:
2072 description: |
2073 The UUID of the project in which the share was
2074 created.
2075 in: body 1525 in: body
2076 required: true 1526 required: true
2077 type: string 1527 type: string
2078project_id_8: 1528project_id_messages_body:
2079 description: | 1529 description: |
2080 The UUID of the project where the share was 1530 The ID of the project for which the message was created.
2081 created.
2082 in: body 1531 in: body
2083 required: true 1532 required: true
2084 type: string 1533 type: string
2085project_id_9: 1534project_id_type_access:
2086 description: | 1535 description: |
2087 The UUID of the project for which access to the 1536 The ID of the project that has been granted access to the type resource.
2088 share type is granted.
2089 in: body 1537 in: body
2090 required: true 1538 required: true
2091 type: string 1539 type: string
2092project_id_messages_body: 1540project_id_type_access_grant_request:
2093 description: | 1541 description: |
2094 The UUID of the project for which the message was created. 1542 The ID of the project that needs to have access to the type resource.
2095 in: body 1543 in: body
2096 required: true 1544 required: true
2097 type: string 1545 type: string
2098project_id_share_server_body: 1546project_id_type_access_revoke_request:
2099 description: | 1547 description: |
2100 The project ID. 1548 The ID of the project whose access to the type resource must be revoked.
2101 in: body 1549 in: body
2102 required: true 1550 required: true
2103 type: string 1551 type: string
@@ -2109,12 +1557,6 @@ protocol:
2109 in: body 1557 in: body
2110 required: true 1558 required: true
2111 type: string 1559 type: string
2112qos:
2113 description: |
2114 The quality of service (QoS) support.
2115 in: body
2116 required: true
2117 type: boolean
2118quota_class_id: 1560quota_class_id:
2119 description: | 1561 description: |
2120 A ``quota_class_set`` id. 1562 A ``quota_class_set`` id.
@@ -2129,24 +1571,30 @@ quota_class_set:
2129 type: object 1571 type: object
2130quota_gigabytes: 1572quota_gigabytes:
2131 description: | 1573 description: |
2132 The number of gigabytes allowed for each tenant. 1574 The number of gigabytes allowed for each project.
2133 in: body 1575 in: body
2134 required: true 1576 required: true
2135 type: integer 1577 type: integer
2136quota_gigabytes_detail: 1578quota_gigabytes_detail:
2137 description: | 1579 description: |
2138 The limit, in_use, reserved number of gigabytes allowed 1580 The limit, in_use, reserved number of gigabytes allowed
2139 for each tenant. 1581 for each project.
2140 in: body 1582 in: body
2141 min_version: 2.25 1583 min_version: 2.25
2142 required: true 1584 required: true
2143 type: object 1585 type: object
2144quota_gigabytes_request: 1586quota_gigabytes_request:
2145 description: | 1587 description: |
2146 The number of gigabytes for the tenant. 1588 The number of gigabytes for the project.
2147 in: body 1589 in: body
2148 required: false 1590 required: false
2149 type: integer 1591 type: integer
1592quota_project_id:
1593 description: |
1594 The ID of the project the quota pertains to.
1595 in: body
1596 required: true
1597 type: string
2150quota_set: 1598quota_set:
2151 description: | 1599 description: |
2152 The ``quota_set`` object. 1600 The ``quota_set`` object.
@@ -2155,7 +1603,7 @@ quota_set:
2155 type: object 1603 type: object
2156quota_share_group_snapshots: 1604quota_share_group_snapshots:
2157 description: | 1605 description: |
2158 The number of share group snapshots allowed for each tenant or user. 1606 The number of share group snapshots allowed for each project or user.
2159 in: body 1607 in: body
2160 min_version: 2.40 1608 min_version: 2.40
2161 required: true 1609 required: true
@@ -2163,21 +1611,21 @@ quota_share_group_snapshots:
2163quota_share_group_snapshots_detail: 1611quota_share_group_snapshots_detail:
2164 description: | 1612 description: |
2165 The limit, in_use, reserved number of share group snapshots 1613 The limit, in_use, reserved number of share group snapshots
2166 for each tenant or user. 1614 for each project or user.
2167 in: body 1615 in: body
2168 min_version: 2.40 1616 min_version: 2.40
2169 required: true 1617 required: true
2170 type: object 1618 type: object
2171quota_share_group_snapshots_request: 1619quota_share_group_snapshots_request:
2172 description: | 1620 description: |
2173 The number of share group snapshots allowed for each tenant or user. 1621 The number of share group snapshots allowed for each project or user.
2174 in: body 1622 in: body
2175 min_version: 2.40 1623 min_version: 2.40
2176 required: false 1624 required: false
2177 type: integer 1625 type: integer
2178quota_share_groups: 1626quota_share_groups:
2179 description: | 1627 description: |
2180 The number of share groups allowed for each tenant or user. 1628 The number of share groups allowed for each project or user.
2181 in: body 1629 in: body
2182 min_version: 2.40 1630 min_version: 2.40
2183 required: true 1631 required: true
@@ -2185,14 +1633,14 @@ quota_share_groups:
2185quota_share_groups_detail: 1633quota_share_groups_detail:
2186 description: | 1634 description: |
2187 The limit, in_use, reserved number of share groups 1635 The limit, in_use, reserved number of share groups
2188 for each tenant or user. 1636 for each project or user.
2189 in: body 1637 in: body
2190 min_version: 2.40 1638 min_version: 2.40
2191 required: true 1639 required: true
2192 type: object 1640 type: object
2193quota_share_groups_request: 1641quota_share_groups_request:
2194 description: | 1642 description: |
2195 The number of share groups allowed for each tenant or user. 1643 The number of share groups allowed for each project or user.
2196 in: body 1644 in: body
2197 min_version: 2.40 1645 min_version: 2.40
2198 required: false 1646 required: false
@@ -2206,7 +1654,7 @@ quota_share_networks:
2206 type: integer 1654 type: integer
2207quota_share_networks_default: 1655quota_share_networks_default:
2208 description: | 1656 description: |
2209 The number of share networks allowed for each tenant. 1657 The number of share networks allowed for each project.
2210 in: body 1658 in: body
2211 required: true 1659 required: true
2212 type: integer 1660 type: integer
@@ -2220,41 +1668,40 @@ quota_share_networks_detail:
2220 type: object 1668 type: object
2221quota_share_networks_request: 1669quota_share_networks_request:
2222 description: | 1670 description: |
2223 The number of share networks for the tenant. 1671 The number of share networks for the project.
2224 in: body 1672 in: body
2225 required: false 1673 required: false
2226 type: integer 1674 type: integer
2227quota_shares: 1675quota_shares:
2228 description: | 1676 description: |
2229 The number of shares allowed for each tenant. 1677 The number of shares allowed for each project.
2230 in: body 1678 in: body
2231 required: true 1679 required: true
2232 type: integer 1680 type: integer
2233quota_shares_detail: 1681quota_shares_detail:
2234 description: | 1682 description: |
2235 The limit, in_use, reserved number of shares allowed 1683 The limit, in_use, reserved number of shares allowed
2236 for each tenant. 1684 for each project.
2237 in: body 1685 in: body
2238 min_version: 2.25 1686 min_version: 2.25
2239 required: true 1687 required: true
2240 type: object 1688 type: object
2241quota_shares_request: 1689quota_shares_request:
2242 description: | 1690 description: |
2243 The number of shares for the tenant. 1691 The number of shares for the project.
2244 in: body 1692 in: body
2245 required: false 1693 required: false
2246 type: integer 1694 type: integer
2247quota_snapshot_gigabytes: 1695quota_snapshot_gigabytes:
2248 description: | 1696 description: |
2249 The number of gigabytes for the snapshots allowed 1697 The number of gigabytes for the snapshots allowed for each project.
2250 for each tenant.
2251 in: body 1698 in: body
2252 required: true 1699 required: true
2253 type: integer 1700 type: integer
2254quota_snapshot_gigabytes_detail: 1701quota_snapshot_gigabytes_detail:
2255 description: | 1702 description: |
2256 The limit, in_use, reserved number of gigabytes for the 1703 The limit, in_use, reserved number of gigabytes for the
2257 snapshots allowed for each tenant. 1704 snapshots allowed for each project.
2258 in: body 1705 in: body
2259 min_version: 2.25 1706 min_version: 2.25
2260 required: true 1707 required: true
@@ -2262,37 +1709,30 @@ quota_snapshot_gigabytes_detail:
2262quota_snapshot_gigabytes_request: 1709quota_snapshot_gigabytes_request:
2263 description: | 1710 description: |
2264 The number of gigabytes for the snapshots for the 1711 The number of gigabytes for the snapshots for the
2265 tenant. 1712 project.
2266 in: body 1713 in: body
2267 required: false 1714 required: false
2268 type: integer 1715 type: integer
2269quota_snapshots: 1716quota_snapshots:
2270 description: | 1717 description: |
2271 The number of snapshots allowed for each tenant. 1718 The number of snapshots allowed for each project.
2272 in: body 1719 in: body
2273 required: true 1720 required: true
2274 type: integer 1721 type: integer
2275quota_snapshots_detail: 1722quota_snapshots_detail:
2276 description: | 1723 description: |
2277 The limit, in_use, reserved number of snapshots allowed 1724 The limit, in_use, reserved number of snapshots allowed
2278 for each tenant. 1725 for each project.
2279 in: body 1726 in: body
2280 min_version: 2.25 1727 min_version: 2.25
2281 required: true 1728 required: true
2282 type: object 1729 type: object
2283quota_snapshots_request: 1730quota_snapshots_request:
2284 description: | 1731 description: |
2285 The number of snapshots for the tenant. 1732 The number of snapshots for the project.
2286 in: body 1733 in: body
2287 required: false 1734 required: false
2288 type: integer 1735 type: integer
2289quota_tenant_id:
2290 description: |
2291 The UUID of the tenant for which you manage
2292 quotas.
2293 in: body
2294 required: true
2295 type: string
2296regex: 1736regex:
2297 description: | 1737 description: |
2298 An API regular expression. For example, 1738 An API regular expression. For example,
@@ -2306,6 +1746,13 @@ remaining:
2306 in: body 1746 in: body
2307 required: false 1747 required: false
2308 type: integer 1748 type: integer
1749remove_project_access:
1750 description: |
1751 An object representing the project resource that access should be
1752 revoked from.
1753 in: body
1754 required: true
1755 type: object
2309replica_state: 1756replica_state:
2310 description: | 1757 description: |
2311 The share replica state. Has set value only when replication 1758 The share replica state. Has set value only when replication
@@ -2335,13 +1782,6 @@ required_extra_specs:
2335 in: body 1782 in: body
2336 required: true 1783 required: true
2337 type: object 1784 type: object
2338reserved_percentage:
2339 description: |
2340 The percentage of the total capacity that is
2341 reserved for the internal use by the back end.
2342 in: body
2343 required: true
2344 type: integer
2345reset_status: 1785reset_status:
2346 description: | 1786 description: |
2347 The ``reset_status`` object. 1787 The ``reset_status`` object.
@@ -2368,48 +1808,15 @@ revert_to_snapshot_support:
2368 required: false 1808 required: false
2369 type: boolean 1809 type: boolean
2370 min_version: 2.27 1810 min_version: 2.27
2371security_service_created_at:
2372 description: |
2373 The date and time stamp when the security service was created.
2374
2375 The date and time stamp format is `ISO 8601
2376 <https://en.wikipedia.org/wiki/ISO_8601>`_:
2377
2378 ::
2379
2380 CCYY-MM-DDThh:mm:ss±hh:mm
2381
2382 The ``±hh:mm`` value, if included, returns the time zone as an
2383 offset from UTC.
2384
2385 For example, ``2015-08-27T09:49:58-05:00``.
2386 in: body
2387 required: true
2388 type: string
2389security_service_description:
2390 description: |
2391 Description of the security service in plain text.
2392 in: body
2393 required: true
2394 type: string
2395security_service_description_request:
2396 description: |
2397 The security service description. If you specify
2398 this value, the description is updated.
2399 in: body
2400 required: false
2401 type: string
2402security_service_dns_ip: 1811security_service_dns_ip:
2403 description: | 1812 description: |
2404 The DNS IP address that is used inside the tenant 1813 The DNS IP address that is used inside the project network.
2405 network.
2406 in: body 1814 in: body
2407 required: true 1815 required: true
2408 type: string 1816 type: string
2409security_service_dns_ip_request: 1817security_service_dns_ip_request:
2410 description: | 1818 description: |
2411 The DNS IP address that is used inside the tenant 1819 The DNS IP address that is used inside the project network.
2412 network.
2413 in: body 1820 in: body
2414 required: false 1821 required: false
2415 type: string 1822 type: string
@@ -2431,12 +1838,6 @@ security_service_id:
2431 in: body 1838 in: body
2432 required: true 1839 required: true
2433 type: string 1840 type: string
2434security_service_name:
2435 description: |
2436 The security service name.
2437 in: body
2438 required: true
2439 type: string
2440security_service_ou: 1841security_service_ou:
2441 description: | 1842 description: |
2442 The security service ou. 1843 The security service ou.
@@ -2464,13 +1865,6 @@ security_service_password_request:
2464 in: body 1865 in: body
2465 required: false 1866 required: false
2466 type: string 1867 type: string
2467security_service_project_id:
2468 description: |
2469 The UUID of the project where the security
2470 service was created.
2471 in: body
2472 required: true
2473 type: string
2474security_service_server: 1868security_service_server:
2475 description: | 1869 description: |
2476 The security service host name or IP address. 1870 The security service host name or IP address.
@@ -2503,41 +1897,15 @@ security_service_type_request:
2503 in: body 1897 in: body
2504 required: false 1898 required: false
2505 type: string 1899 type: string
2506security_service_updated_at:
2507 description: |
2508 The date and time stamp when the security service was updated.
2509
2510 The date and time stamp format is `ISO 8601
2511 <https://en.wikipedia.org/wiki/ISO_8601>`_:
2512
2513 ::
2514
2515 CCYY-MM-DDThh:mm:ss±hh:mm
2516
2517 The ``±hh:mm`` value, if included, returns the time zone as an
2518 offset from UTC.
2519
2520 For example, ``2015-08-27T09:49:58-05:00``.
2521 in: body
2522 required: true
2523 type: string
2524security_service_user: 1900security_service_user:
2525 description: | 1901 description: |
2526 The security service user or group name that is 1902 The security service user or group name that is used by the project.
2527 used by the tenant.
2528 in: body 1903 in: body
2529 required: true 1904 required: true
2530 type: string 1905 type: string
2531security_service_user_request: 1906security_service_user_request:
2532 description: | 1907 description: |
2533 The security service user or group name that is 1908 The security service user or group name that is used by the project.
2534 used by the tenant.
2535 in: body
2536 required: false
2537 type: string
2538security_servie_server_request:
2539 description: |
2540 The security service host name or IP address.
2541 in: body 1909 in: body
2542 required: false 1910 required: false
2543 type: string 1911 type: string
@@ -2557,12 +1925,6 @@ segmentation_id_1:
2557 in: body 1925 in: body
2558 required: true 1926 required: true
2559 type: integer 1927 type: integer
2560server_pools_mapping:
2561 description: |
2562 The mapping between servers and pools.
2563 in: body
2564 required: true
2565 type: object
2566service_binary_response: 1928service_binary_response:
2567 description: | 1929 description: |
2568 The service binary name. Default is the base name 1930 The service binary name. Default is the base name
@@ -2610,13 +1972,6 @@ service_enable_binary_request:
2610 in: body 1972 in: body
2611 required: true 1973 required: true
2612 type: string 1974 type: string
2613service_enable_binary_response:
2614 description: |
2615 The name of the enabled service binary.
2616 Typically, this name is the base name of the executable.
2617 in: body
2618 required: true
2619 type: string
2620service_enable_host_request: 1975service_enable_host_request:
2621 description: | 1976 description: |
2622 The host name of the service that you want to 1977 The host name of the service that you want to
@@ -2665,24 +2020,6 @@ service_status_response:
2665 in: body 2020 in: body
2666 required: true 2021 required: true
2667 type: string 2022 type: string
2668service_updated_at:
2669 description: |
2670 The date and time stamp when the service was updated.
2671
2672 The date and time stamp format is `ISO 8601
2673 <https://en.wikipedia.org/wiki/ISO_8601>`_:
2674
2675 ::
2676
2677 CCYY-MM-DDThh:mm:ss±hh:mm
2678
2679 The ``±hh:mm`` value, if included, returns the time zone as an
2680 offset from UTC.
2681
2682 For example, ``2015-08-27T09:49:58-05:00``.
2683 in: body
2684 required: true
2685 type: string
2686service_zone_response: 2023service_zone_response:
2687 description: | 2024 description: |
2688 The service availability zone. 2025 The service availability zone.
@@ -2701,12 +2038,6 @@ share:
2701 in: body 2038 in: body
2702 required: true 2039 required: true
2703 type: object 2040 type: object
2704share_backend_name:
2705 description: |
2706 The name of the share back end.
2707 in: body
2708 required: true
2709 type: string
2710share_force_delete: 2041share_force_delete:
2711 description: | 2042 description: |
2712 To force-delete a share or share group, set this value to 2043 To force-delete a share or share group, set this value to
@@ -2715,37 +2046,6 @@ share_force_delete:
2715 in: body 2046 in: body
2716 required: true 2047 required: true
2717 type: string 2048 type: string
2718share_group_created_at:
2719 description: |
2720 The date and time stamp when the share group was
2721 created.
2722
2723 The date and time stamp format is `ISO 8601
2724 <https://en.wikipedia.org/wiki/ISO_8601>`_:
2725
2726 ::
2727
2728 CCYY-MM-DDThh:mm:ss±hh:mm
2729
2730 The ``±hh:mm`` value, if included, returns the time zone as an
2731 offset from UTC.
2732
2733 For example, ``2016-12-31T13:14:15-05:00``.
2734 in: body
2735 required: true
2736 type: string
2737share_group_description:
2738 description: |
2739 The share group description.
2740 in: body
2741 required: false
2742 type: string
2743share_group_description_response:
2744 description: |
2745 The share group description.
2746 in: body
2747 required: true
2748 type: string
2749share_group_host: 2049share_group_host:
2750 description: | 2050 description: |
2751 The share group host name. 2051 The share group host name.
@@ -2756,14 +2056,14 @@ share_group_id:
2756 description: | 2056 description: |
2757 The UUID of the share group. 2057 The UUID of the share group.
2758 in: body 2058 in: body
2759 required: True 2059 required: true
2760 type: string 2060 type: string
2761 min_version: 2.31 2061 min_version: 2.31
2762share_group_id_request: 2062share_group_id_request:
2763 description: | 2063 description: |
2764 The UUID of the share group. 2064 The UUID of the share group.
2765 in: body 2065 in: body
2766 required: False 2066 required: false
2767 type: string 2067 type: string
2768 min_version: 2.31 2068 min_version: 2.31
2769share_group_links: 2069share_group_links:
@@ -2772,18 +2072,6 @@ share_group_links:
2772 in: body 2072 in: body
2773 required: true 2073 required: true
2774 type: string 2074 type: string
2775share_group_name:
2776 description: |
2777 The share group name.
2778 in: body
2779 required: false
2780 type: string
2781share_group_name_response:
2782 description: |
2783 The share group name.
2784 in: body
2785 required: true
2786 type: string
2787share_group_status: 2075share_group_status:
2788 description: | 2076 description: |
2789 The share group status, which is ``available``, 2077 The share group status, which is ``available``,
@@ -2825,49 +2113,34 @@ share_group_type_name:
2825 in: body 2113 in: body
2826 required: true 2114 required: true
2827 type: string 2115 type: string
2828share_id_2: 2116share_group_type_name_request:
2829 description: | 2117 description: |
2830 The UUID of the share from which the share 2118 The name of the share group type resource. The value of this field is
2831 instance was created. 2119 limited to 255 characters.
2832 in: body 2120 in: body
2833 required: true 2121 required: false
2834 type: string 2122 type: string
2835share_instance_id_1: 2123share_id_2:
2836 description: | 2124 description: |
2837 The UUID of the share instance. 2125 The UUID of the share from which the share
2126 instance was created.
2838 in: body 2127 in: body
2839 required: true 2128 required: true
2840 type: string 2129 type: string
2841share_network_created_at: 2130share_instance_cast_rules_to_readonly:
2842 description: | 2131 description: |
2843 The date and time stamp when the share network was created. 2132 If the share instance has its ``cast_rules_to_readonly`` attribute set to
2844 2133 True, all existing access rules will be cast to read/only.
2845 The date and time stamp format is `ISO 8601
2846 <https://en.wikipedia.org/wiki/ISO_8601>`_:
2847
2848 ::
2849
2850 CCYY-MM-DDThh:mm:ss±hh:mm
2851
2852 The ``±hh:mm`` value, if included, returns the time zone as an
2853 offset from UTC.
2854
2855 For example, ``2015-08-27T09:49:58-05:00``.
2856 in: body 2134 in: body
2857 required: true 2135 required: true
2858 type: string 2136 type: string
2859share_network_description: 2137 min_version: 2.30
2138share_instance_id_1:
2860 description: | 2139 description: |
2861 The share network description. 2140 The UUID of the share instance.
2862 in: body 2141 in: body
2863 required: true 2142 required: true
2864 type: string 2143 type: string
2865share_network_description_request:
2866 description: |
2867 The share network description.
2868 in: body
2869 required: false
2870 type: string
2871share_network_gateway: 2144share_network_gateway:
2872 description: | 2145 description: |
2873 The gateway of a share network. 2146 The gateway of a share network.
@@ -2898,12 +2171,6 @@ share_network_id_2:
2898 in: body 2171 in: body
2899 required: false 2172 required: false
2900 type: string 2173 type: string
2901share_network_id_3:
2902 description: |
2903 The ID of a share network.
2904 in: body
2905 required: true
2906 type: string
2907share_network_id_4: 2174share_network_id_4:
2908 description: | 2175 description: |
2909 The share network ID. 2176 The share network ID.
@@ -2926,16 +2193,11 @@ share_network_mtu:
2926 min_version: 2.20 2193 min_version: 2.20
2927share_network_name: 2194share_network_name:
2928 description: | 2195 description: |
2929 The name of a share network. 2196 The name of a share network that is associated
2197 with the share server.
2930 in: body 2198 in: body
2931 required: true 2199 required: true
2932 type: string 2200 type: string
2933share_network_name_request:
2934 description: |
2935 The name of a share network.
2936 in: body
2937 required: false
2938 type: string
2939share_network_security_service_id: 2201share_network_security_service_id:
2940 description: | 2202 description: |
2941 The UUID of the security service to remove from 2203 The UUID of the security service to remove from
@@ -2943,24 +2205,6 @@ share_network_security_service_id:
2943 in: body 2205 in: body
2944 required: true 2206 required: true
2945 type: string 2207 type: string
2946share_network_updated_at:
2947 description: |
2948 The date and time stamp when the share network was updated.
2949
2950 The date and time stamp format is `ISO 8601
2951 <https://en.wikipedia.org/wiki/ISO_8601>`_:
2952
2953 ::
2954
2955 CCYY-MM-DDThh:mm:ss±hh:mm
2956
2957 The ``±hh:mm`` value, if included, returns the time zone as an
2958 offset from UTC.
2959
2960 For example, ``2015-08-27T09:49:58-05:00``.
2961 in: body
2962 required: true
2963 type: string
2964share_new_size: 2208share_new_size:
2965 description: | 2209 description: |
2966 New size of the share, in GBs. 2210 New size of the share, in GBs.
@@ -2975,14 +2219,6 @@ share_proto:
2975 in: body 2219 in: body
2976 required: true 2220 required: true
2977 type: string 2221 type: string
2978share_protocol:
2979 description: |
2980 The file system protocol of the member, which is
2981 ``NFS``, ``CIFS``, ``GlusterFS``, ``HDFS``, ``CEPHFS`` or
2982 ``MAPRFS``.
2983 in: body
2984 required: true
2985 type: string
2986share_replica_az: 2222share_replica_az:
2987 description: | 2223 description: |
2988 The availability zone. 2224 The availability zone.
@@ -2991,29 +2227,12 @@ share_replica_az:
2991 type: string 2227 type: string
2992share_replica_cast_rules_to_readonly: 2228share_replica_cast_rules_to_readonly:
2993 description: | 2229 description: |
2994 Since the share instance has its ``cast_rules_to_readonly`` attribute 2230 If the share replica has its ``cast_rules_to_readonly`` attribute set to
2995 set to True, existing rules will be cast to read/only. 2231 True, all existing access rules will be cast to read/only.
2996 in: body
2997 required: true
2998 type: string
2999share_replica_created_at:
3000 description: |
3001 The date and time stamp when the share replica was created.
3002
3003 The date and time stamp format is `ISO 8601
3004 <https://en.wikipedia.org/wiki/ISO_8601>`_:
3005
3006 ::
3007
3008 CCYY-MM-DDThh:mm:ss±hh:mm
3009
3010 The ``±hh:mm`` value, if included, returns the time zone as an
3011 offset from UTC.
3012
3013 For example, ``2015-08-27T09:49:58-05:00``.
3014 in: body 2232 in: body
3015 required: true 2233 required: true
3016 type: string 2234 type: string
2235 min_version: 2.30
3017share_replica_force_delete: 2236share_replica_force_delete:
3018 description: | 2237 description: |
3019 To force-delete a share replica, set this value to 2238 To force-delete a share replica, set this value to
@@ -3068,36 +2287,52 @@ share_replica_status:
3068 in: body 2287 in: body
3069 required: true 2288 required: true
3070 type: string 2289 type: string
3071share_replica_updated_at: 2290share_server_id:
3072 description: | 2291 description: |
3073 The date and time stamp when the share replica was updated. 2292 The UUID of the share server.
3074
3075 The date and time stamp format is `ISO 8601
3076 <https://en.wikipedia.org/wiki/ISO_8601>`_:
3077
3078 ::
3079
3080 CCYY-MM-DDThh:mm:ss±hh:mm
3081
3082 The ``±hh:mm`` value, if included, returns the time zone as an
3083 offset from UTC.
3084
3085 For example, ``2015-08-27T09:49:58-05:00``.
3086 in: body 2293 in: body
3087 required: true 2294 required: true
3088 type: string 2295 type: string
3089share_server_id: 2296share_server_show_identifier:
3090 description: | 2297 description: |
3091 The UUID of the share server. 2298 The identifier of the share server in the back-end storage system.
3092 in: body 2299 in: body
3093 required: true 2300 required: true
3094 type: string 2301 type: string
3095share_size_1: 2302 min_version: 2.49
2303share_server_show_is_auto_deletable:
3096 description: | 2304 description: |
3097 The size of a source share, in GBs. 2305 Defines if a share server can be deleted automatically by the service.
2306 Share server deletion can be automated with configuration. However, Share
2307 servers that have ever had a share removed from service management cannot
2308 be automatically deleted by the service.
3098 in: body 2309 in: body
3099 required: true 2310 required: true
3100 type: integer 2311 type: boolean
2312 min_version: 2.49
2313share_server_status:
2314 description: |
2315 The share server status, which can be ``active``,
2316 ``error``, ``creating``, ``deleting``, ``manage_starting``,
2317 ``manage_error``, ``unmanage_starting``, ``unmanage_error`` or
2318 ``error_deleting``.
2319 in: body
2320 required: true
2321 type: string
2322share_server_unmanage:
2323 description: |
2324 To unmanage a share server, either set this value to ``null`` or {}.
2325 Optionally, the ``force`` attribute can be included in this object.
2326 in: body
2327 required: true
2328 type: object
2329share_share_type_name:
2330 description: |
2331 Name of the share type.
2332 in: body
2333 required: true
2334 type: string
2335 min_version: 2.6
3101share_type: 2336share_type:
3102 description: | 2337 description: |
3103 The share type name. If you omit this parameter, 2338 The share type name. If you omit this parameter,
@@ -3139,7 +2374,8 @@ share_type_description:
3139 min_version: 2.41 2374 min_version: 2.41
3140share_type_description_request: 2375share_type_description_request:
3141 description: | 2376 description: |
3142 The description of the share type. 2377 The description of the share type. The value of this field is limited to
2378 255 characters.
3143 in: body 2379 in: body
3144 required: false 2380 required: false
3145 type: string 2381 type: string
@@ -3152,13 +2388,17 @@ share_type_id_body:
3152 type: string 2388 type: string
3153share_type_name: 2389share_type_name:
3154 description: | 2390 description: |
3155 The share type name. Minor versions support only the 2391 Name of the share type.
3156 ``share_type`` parameter where the share type name is
3157 expected.
3158 in: body 2392 in: body
3159 required: true 2393 required: true
3160 type: string 2394 type: string
3161 min_version: 2.6 2395share_type_name_request:
2396 description: |
2397 Name of the share type. The value of this field is limited to 255
2398 characters.
2399 in: body
2400 required: false
2401 type: string
3162share_types: 2402share_types:
3163 description: | 2403 description: |
3164 A list of one or more share type IDs. 2404 A list of one or more share type IDs.
@@ -3191,66 +2431,12 @@ size:
3191 in: body 2431 in: body
3192 required: true 2432 required: true
3193 type: integer 2433 type: integer
3194size_1:
3195 description: |
3196 The member size, in GBs.
3197 in: body
3198 required: true
3199 type: integer
3200size_2: 2434size_2:
3201 description: | 2435 description: |
3202 The share size, in GBs. 2436 The share size, in GBs.
3203 in: body 2437 in: body
3204 required: true 2438 required: true
3205 type: integer 2439 type: integer
3206snapshot_created_at:
3207 description: |
3208 The date and time stamp when the snapshot or snapshot instance was
3209 created.
3210
3211 The date and time stamp format is `ISO 8601
3212 <https://en.wikipedia.org/wiki/ISO_8601>`_:
3213
3214 ::
3215
3216 CCYY-MM-DDThh:mm:ss±hh:mm
3217
3218 The ``±hh:mm`` value, if included, returns the time zone as an
3219 offset from UTC.
3220
3221 For example, ``2015-08-27T09:49:58-05:00``.
3222 in: body
3223 required: true
3224 type: string
3225snapshot_description:
3226 description: |
3227 The snapshot description.
3228 in: body
3229 required: true
3230 type: string
3231snapshot_description_request:
3232 description: |
3233 The snapshot description.
3234 in: body
3235 required: false
3236 type: string
3237snapshot_display_description:
3238 description: |
3239 The snapshot description. The shared file
3240 systems API supports the use of both ``name`` and ``display_name``
3241 attributes, which are inherited attributes from the block storage
3242 API.
3243 in: body
3244 required: false
3245 type: string
3246snapshot_display_name:
3247 description: |
3248 The snapshot name. The Shared File Systems API
3249 supports the use of both ``name`` and ``display_name`` attributes,
3250 which are inherited attributes from the Block Storage API.
3251 in: body
3252 required: false
3253 type: string
3254snapshot_force_delete: 2440snapshot_force_delete:
3255 description: | 2441 description: |
3256 To force-delete a snapshot, include this param and set its value to 2442 To force-delete a snapshot, include this param and set its value to
@@ -3299,25 +2485,6 @@ snapshot_instance_status:
3299 in: body 2485 in: body
3300 required: true 2486 required: true
3301 type: string 2487 type: string
3302snapshot_instance_updated_at:
3303 description: |
3304 The date and time stamp when the snapshot instance was
3305 updated.
3306
3307 The date and time stamp format is `ISO 8601
3308 <https://en.wikipedia.org/wiki/ISO_8601>`_:
3309
3310 ::
3311
3312 CCYY-MM-DDThh:mm:ss±hh:mm
3313
3314 The ``±hh:mm`` value, if included, returns the time zone as an
3315 offset from UTC.
3316
3317 For example, ``2016-12-31T13:14:15-05:00``.
3318 in: body
3319 required: true
3320 type: string
3321snapshot_manage_share_id: 2488snapshot_manage_share_id:
3322 description: | 2489 description: |
3323 The UUID of the share that has snapshot which 2490 The UUID of the share that has snapshot which
@@ -3333,18 +2500,13 @@ snapshot_manage_status:
3333 in: body 2500 in: body
3334 required: true 2501 required: true
3335 type: string 2502 type: string
3336snapshot_name: 2503snapshot_project_id:
3337 description: | 2504 description: |
3338 The snapshot name. 2505 ID of the project that the snapshot belongs to.
3339 in: body 2506 in: body
3340 required: true 2507 required: true
3341 type: string 2508 type: string
3342snapshot_name_request: 2509 min_version: 2.17
3343 description: |
3344 The snapshot name.
3345 in: body
3346 required: false
3347 type: string
3348snapshot_provider_location: 2510snapshot_provider_location:
3349 description: | 2511 description: |
3350 Provider location of the snapshot on the backend. 2512 Provider location of the snapshot on the backend.
@@ -3380,15 +2542,6 @@ snapshot_share_protocol:
3380 in: body 2542 in: body
3381 required: true 2543 required: true
3382 type: string 2544 type: string
3383snapshot_share_protocol_request:
3384 description: |
3385 The file system protocol of a share snapshot. A
3386 valid value is ``NFS``, ``CIFS``, ``GlusterFS``, ``HDFS``,
3387 ``CephFS`` or ``MAPRFS``, ``CephFS`` is supported starting
3388 with API v2.13.
3389 in: body
3390 required: true
3391 type: string
3392snapshot_share_size: 2545snapshot_share_size:
3393 description: | 2546 description: |
3394 The share snapshot size, in GBs. 2547 The share snapshot size, in GBs.
@@ -3434,16 +2587,6 @@ snapshot_support_1:
3434 in: body 2587 in: body
3435 required: false 2588 required: false
3436 type: boolean 2589 type: boolean
3437snapshot_support_3:
3438 description: |
3439 An extra specification that filters back ends by
3440 whether they do or do not support share snapshots. Set to
3441 ``true`` to show back ends that support share snapshots. Set to
3442 ``false`` to show back ends that do not support share snapshots.
3443 Default is ``true``.
3444 in: body
3445 required: false
3446 type: boolean
3447snapshot_unmanage: 2590snapshot_unmanage:
3448 description: | 2591 description: |
3449 To unmanage a share snapshot, include this parameter and set its value to 2592 To unmanage a share snapshot, include this parameter and set its value to
@@ -3451,6 +2594,13 @@ snapshot_unmanage:
3451 in: body 2594 in: body
3452 required: true 2595 required: true
3453 type: string 2596 type: string
2597snapshot_user_id:
2598 description: |
2599 ID of the user that the snapshot was created by.
2600 in: body
2601 required: true
2602 type: string
2603 min_version: 2.17
3454source_share_group_snapshot_id: 2604source_share_group_snapshot_id:
3455 description: | 2605 description: |
3456 The source share group snapshot ID to create the 2606 The source share group snapshot ID to create the
@@ -3477,13 +2627,6 @@ state:
3477 in: body 2627 in: body
3478 required: true 2628 required: true
3479 type: string 2629 type: string
3480state_1:
3481 description: |
3482 The current state of the service. A valid value
3483 is ``up`` or ``down``.
3484 in: body
3485 required: true
3486 type: string
3487status: 2630status:
3488 description: | 2631 description: |
3489 The consistency group snapshot status, which is 2632 The consistency group snapshot status, which is
@@ -3500,14 +2643,6 @@ status_1:
3500 in: body 2643 in: body
3501 required: true 2644 required: true
3502 type: string 2645 type: string
3503status_10:
3504 description: |
3505 The consistency group status. A valid value is
3506 ``creating``, ``error``, ``available``, ``deleting``, or
3507 ``error_deleting``.
3508 in: body
3509 required: true
3510 type: string
3511status_16: 2646status_16:
3512 description: | 2647 description: |
3513 The share status, which is ``creating``, 2648 The share status, which is ``creating``,
@@ -3538,13 +2673,6 @@ status_3:
3538 in: body 2673 in: body
3539 required: true 2674 required: true
3540 type: string 2675 type: string
3541status_4:
3542 description: |
3543 The service status, which is ``enabled`` or
3544 ``disabled``.
3545 in: body
3546 required: true
3547 type: string
3548status_5: 2676status_5:
3549 description: | 2677 description: |
3550 The share instance status. A valid value is 2678 The share instance status. A valid value is
@@ -3553,13 +2681,6 @@ status_5:
3553 in: body 2681 in: body
3554 required: true 2682 required: true
3555 type: string 2683 type: string
3556status_7:
3557 description: |
3558 The share server status, which is ``active``,
3559 ``error``, ``creating``, or ``deleting``.
3560 in: body
3561 required: true
3562 type: string
3563status_8: 2684status_8:
3564 description: | 2685 description: |
3565 The share status, which is ``available``, 2686 The share status, which is ``available``,
@@ -3574,13 +2695,6 @@ status_share_server_body:
3574 in: body 2695 in: body
3575 required: true 2696 required: true
3576 type: string 2697 type: string
3577storage_protocol:
3578 description: |
3579 The storage protocol for the back end. For
3580 example, ``NFS_CIFS``, ``glusterfs``, ``HDFS``, and so on.
3581 in: body
3582 required: true
3583 type: string
3584task_state: 2698task_state:
3585 description: | 2699 description: |
3586 For the share migration, the migration task state. A valid 2700 For the share migration, the migration task state. A valid
@@ -3611,13 +2725,6 @@ timestamp:
3611 in: body 2725 in: body
3612 required: true 2726 required: true
3613 type: string 2727 type: string
3614total_capacity_gb:
3615 description: |
3616 The total capacity for the back end, in GBs. A
3617 valid value is a string, such as ``unknown``, or an integer.
3618 in: body
3619 required: true
3620 type: string
3621totalShareGigabytesUsed: 2728totalShareGigabytesUsed:
3622 description: | 2729 description: |
3623 The total number of gigabytes used in a project 2730 The total number of gigabytes used in a project
@@ -3662,35 +2769,11 @@ unit:
3662 in: body 2769 in: body
3663 required: false 2770 required: false
3664 type: string 2771 type: string
3665unmanage: 2772updated_at:
3666 description: |
3667 To unmanage a share snapshot, set this value to
3668 ``null``.
3669 in: body
3670 required: true
3671 type: string
3672updated:
3673 description: |
3674 The date and time stamp when the extension was last updated.
3675
3676 The date and time stamp format is `ISO 8601
3677 <https://en.wikipedia.org/wiki/ISO_8601>`_:
3678
3679 ::
3680
3681 CCYY-MM-DDThh:mm:ss±hh:mm
3682
3683 The ``±hh:mm`` value, if included, returns the time zone as an
3684 offset from UTC.
3685
3686 For example, ``2015-08-27T09:49:58-05:00``.
3687 in: body
3688 required: true
3689 type: string
3690updated_at_2:
3691 description: | 2773 description: |
3692 The date and time stamp when the share instance export location was 2774 The date and time stamp when the resource was last updated within the
3693 updated. 2775 service's database. If a resource was never updated after it was
2776 created, the value of this parameter is set to ``null``.
3694 2777
3695 The date and time stamp format is `ISO 8601 2778 The date and time stamp format is `ISO 8601
3696 <https://en.wikipedia.org/wiki/ISO_8601>`_: 2779 <https://en.wikipedia.org/wiki/ISO_8601>`_:
@@ -3706,33 +2789,14 @@ updated_at_2:
3706 in: body 2789 in: body
3707 required: true 2790 required: true
3708 type: string 2791 type: string
3709updated_at_5: 2792updated_at_extensions:
3710 description: |
3711 The date and time stamp when the service was updated.
3712
3713 The date and time stamp format is `ISO 8601
3714 <https://en.wikipedia.org/wiki/ISO_8601>`_:
3715
3716 ::
3717
3718 CCYY-MM-DDThh:mm:ss±hh:mm
3719
3720 The ``±hh:mm`` value, if included, returns the time zone as an
3721 offset from UTC.
3722
3723 For example, ``2015-08-27T09:49:58-05:00``.
3724 in: body
3725 required: true
3726 type: string
3727updated_at_share_server_body:
3728 description: | 2793 description: |
3729 The date and time stamp when the share server was updated. 2794 The date and time stamp when the extension API was last updated.
3730 2795
3731 The date and time stamp format is `ISO 8601 2796 The date and time stamp format is `ISO 8601
3732 <https://en.wikipedia.org/wiki/ISO_8601>`_: 2797 <https://en.wikipedia.org/wiki/ISO_8601>`_:
3733 2798
3734 :: 2799 ::
3735
3736 CCYY-MM-DDThh:mm:ss±hh:mm 2800 CCYY-MM-DDThh:mm:ss±hh:mm
3737 2801
3738 The ``±hh:mm`` value, if included, returns the time zone as an 2802 The ``±hh:mm`` value, if included, returns the time zone as an
@@ -3751,7 +2815,7 @@ uri:
3751 type: string 2815 type: string
3752user_id: 2816user_id:
3753 description: | 2817 description: |
3754 ID of the user that is part of a given tenant. 2818 ID of the user that is part of a given project.
3755 in: body 2819 in: body
3756 required: false 2820 required: false
3757 type: string 2821 type: string
@@ -3764,12 +2828,6 @@ value:
3764 in: body 2828 in: body
3765 required: false 2829 required: false
3766 type: integer 2830 type: integer
3767vendor_name:
3768 description: |
3769 The name of the vendor for the back end.
3770 in: body
3771 required: true
3772 type: string
3773verb: 2831verb:
3774 description: | 2832 description: |
3775 The HTTP method for the API request. For example, 2833 The HTTP method for the API request. For example,
@@ -3849,9 +2907,3 @@ volume_type:
3849 in: body 2907 in: body
3850 required: false 2908 required: false
3851 type: string 2909 type: string
3852zone:
3853 description: |
3854 The availability zone.
3855 in: body
3856 required: true
3857 type: string
diff --git a/api-ref/source/quota-classes.inc b/api-ref/source/quota-classes.inc
index cf07f06..7b08855 100644
--- a/api-ref/source/quota-classes.inc
+++ b/api-ref/source/quota-classes.inc
@@ -9,7 +9,7 @@ Quota classes can be shown and updated for a project.
9Show quota classes for a project 9Show quota classes for a project
10================================ 10================================
11 11
12.. rest_method:: GET /v2/{tenant_id}/quota-class-sets/{quota_class_name} 12.. rest_method:: GET /v2/{project_id}/quota-class-sets/{quota_class_name}
13 13
14Shows quota class set for a project. If no specific value for the quota class 14Shows quota class set for a project. If no specific value for the quota class
15resource exists, then the default value will be reported. 15resource exists, then the default value will be reported.
@@ -31,7 +31,7 @@ Request
31 31
32.. rest_parameters:: parameters.yaml 32.. rest_parameters:: parameters.yaml
33 33
34 - tenant_id: tenant_id 34 - project_id: project_id_path
35 - quota_class_name: quota_class_name 35 - quota_class_name: quota_class_name
36 36
37 37
@@ -60,7 +60,7 @@ Response Example
60Update quota classes for a project 60Update quota classes for a project
61================================== 61==================================
62 62
63.. rest_method:: PUT /v2/{tenant_id}/quota-class-sets/{quota_class_name} 63.. rest_method:: PUT /v2/{project_id}/quota-class-sets/{quota_class_name}
64 64
65Updates quota class set for a project. If the ``quota_class_name`` key does not 65Updates quota class set for a project. If the ``quota_class_name`` key does not
66exist, then the API will create one. 66exist, then the API will create one.
@@ -83,7 +83,7 @@ Request
83 83
84.. rest_parameters:: parameters.yaml 84.. rest_parameters:: parameters.yaml
85 85
86 - tenant_id: tenant_id 86 - project_id: project_id_path
87 - quota_class_name: quota_class_name 87 - quota_class_name: quota_class_name
88 - shares: maxTotalSharesOptional 88 - shares: maxTotalSharesOptional
89 - snapshots: maxTotalShareSnapshotsOptional 89 - snapshots: maxTotalShareSnapshotsOptional
diff --git a/api-ref/source/quota-sets.inc b/api-ref/source/quota-sets.inc
index 814e92a..5645d76 100644
--- a/api-ref/source/quota-sets.inc
+++ b/api-ref/source/quota-sets.inc
@@ -26,9 +26,9 @@ Provides quotas management support.
26Show default quota set 26Show default quota set
27====================== 27======================
28 28
29.. rest_method:: GET /v2/{tenant_id}/quota-sets/{tenant_id}/defaults 29.. rest_method:: GET /v2/{project_id}/quota-sets/{project_id}/defaults
30 30
31Shows default quotas for a tenant. 31Shows default quotas for a given project.
32 32
33Response codes 33Response codes
34-------------- 34--------------
@@ -48,8 +48,8 @@ Request
48 48
49.. rest_parameters:: parameters.yaml 49.. rest_parameters:: parameters.yaml
50 50
51 - tenant_id: tenant_id_path 51 - project_id: project_id_path
52 - tenant_id: tenant_id 52 - project_id: project_id_quota_request_path
53 53
54Response parameters 54Response parameters
55------------------- 55-------------------
@@ -57,7 +57,7 @@ Response parameters
57.. rest_parameters:: parameters.yaml 57.. rest_parameters:: parameters.yaml
58 58
59 - quota_set: quota_set 59 - quota_set: quota_set
60 - id: quota_tenant_id 60 - id: quota_project_id
61 - gigabytes: quota_gigabytes 61 - gigabytes: quota_gigabytes
62 - snapshots: quota_snapshots 62 - snapshots: quota_snapshots
63 - shares: quota_shares 63 - shares: quota_shares
@@ -77,12 +77,12 @@ Response example
77Show quota set 77Show quota set
78============== 78==============
79 79
80.. rest_method:: GET /v2/{tenant_id}/quota-sets/{tenant_id}?user_id={user_id} 80.. rest_method:: GET /v2/{project_id}/quota-sets/{project_id}?user_id={user_id}
81 81
82Shows quotas for a tenant. 82Shows quotas for a given project..
83 83
84If you specify the optional ``user_id`` query parameter, you get 84If you specify the optional ``user_id`` query parameter, you get
85the quotas for this user in the tenant. If you omit this parameter, 85the quotas for this user in the project. If you omit this parameter,
86you get the quotas for the project. 86you get the quotas for the project.
87 87
88Response codes 88Response codes
@@ -103,8 +103,8 @@ Request
103 103
104.. rest_parameters:: parameters.yaml 104.. rest_parameters:: parameters.yaml
105 105
106 - tenant_id: tenant_id_path 106 - project_id: project_id_path
107 - tenant_id: tenant_id 107 - project_id: project_id_quota_request_path
108 - user_id: user_id_query 108 - user_id: user_id_query
109 - share_type: share_type_for_quota 109 - share_type: share_type_for_quota
110 110
@@ -114,7 +114,7 @@ Response parameters
114.. rest_parameters:: parameters.yaml 114.. rest_parameters:: parameters.yaml
115 115
116 - quota_set: quota_set 116 - quota_set: quota_set
117 - id: quota_tenant_id 117 - id: quota_project_id
118 - gigabytes: quota_gigabytes 118 - gigabytes: quota_gigabytes
119 - snapshots: quota_snapshots 119 - snapshots: quota_snapshots
120 - shares: quota_shares 120 - shares: quota_shares
@@ -130,15 +130,17 @@ Response example
130 :language: javascript 130 :language: javascript
131 131
132 132
133Show quota set in detail 133Show quota set in detail (since API v2.25)
134======================== 134==========================================
135 135
136.. rest_method:: GET /v2/{tenant_id}/quota-sets/{tenant_id}/detail?user_id={user_id} 136.. rest_method:: GET /v2/{project_id}/quota-sets/{project_id}/detail?user_id={user_id}
137 137
138Shows quotas for a tenant in detail. 138.. versionadded:: 2.25
139
140Shows quotas for a project in detail.
139 141
140If you specify the optional ``user_id`` query parameter, you get 142If you specify the optional ``user_id`` query parameter, you get
141the quotas for this user in the tenant. If you omit this parameter, 143the quotas for this user in the project. If you omit this parameter,
142you get the quotas for the project. 144you get the quotas for the project.
143 145
144Response codes 146Response codes
@@ -159,8 +161,8 @@ Request
159 161
160.. rest_parameters:: parameters.yaml 162.. rest_parameters:: parameters.yaml
161 163
162 - tenant_id: tenant_id_path 164 - project_id: project_id_path
163 - tenant_id: tenant_id 165 - project_id: project_id_quota_request_path
164 - user_id: user_id_query 166 - user_id: user_id_query
165 - share_type: share_type_for_quota 167 - share_type: share_type_for_quota
166 168
@@ -170,7 +172,7 @@ Response parameters
170.. rest_parameters:: parameters.yaml 172.. rest_parameters:: parameters.yaml
171 173
172 - quota_set: quota_set 174 - quota_set: quota_set
173 - id: quota_tenant_id 175 - id: quota_project_id
174 - gigabytes: quota_gigabytes_detail 176 - gigabytes: quota_gigabytes_detail
175 - snapshots: quota_snapshots_detail 177 - snapshots: quota_snapshots_detail
176 - shares: quota_shares_detail 178 - shares: quota_shares_detail
@@ -189,12 +191,12 @@ Response example
189Update quota set 191Update quota set
190================ 192================
191 193
192.. rest_method:: PUT /v2/{tenant_id}/quota-sets/{tenant_id}?user_id={user_id} 194.. rest_method:: PUT /v2/{project_id}/quota-sets/{project_id}?user_id={user_id}
193 195
194Updates quotas for a tenant. 196Updates quotas for a project.
195 197
196If you specify the optional ``user_id`` query parameter, you update 198If you specify the optional ``user_id`` query parameter, you update
197the quotas for this user in the tenant. If you omit this parameter, 199the quotas for this user in the project. If you omit this parameter,
198you update the quotas for the project. 200you update the quotas for the project.
199 201
200Response codes 202Response codes
@@ -215,8 +217,8 @@ Request
215 217
216.. rest_parameters:: parameters.yaml 218.. rest_parameters:: parameters.yaml
217 219
218 - tenant_id: tenant_id_path 220 - project_id: project_id_path
219 - tenant_id: tenant_id 221 - project_id: project_id_quota_request_path
220 - user_id: user_id_query 222 - user_id: user_id_query
221 - quota_set: quota_set 223 - quota_set: quota_set
222 - force: force 224 - force: force
@@ -241,7 +243,7 @@ Response parameters
241.. rest_parameters:: parameters.yaml 243.. rest_parameters:: parameters.yaml
242 244
243 - quota_set: quota_set 245 - quota_set: quota_set
244 - id: quota_tenant_id 246 - id: quota_project_id
245 - gigabytes: quota_gigabytes 247 - gigabytes: quota_gigabytes
246 - snapshots: quota_snapshots 248 - snapshots: quota_snapshots
247 - shares: quota_shares 249 - shares: quota_shares
@@ -260,12 +262,12 @@ Response example
260Delete quota set 262Delete quota set
261================ 263================
262 264
263.. rest_method:: DELETE /v2/{tenant_id}/quota-sets/{tenant_id}?user_id={user_id} 265.. rest_method:: DELETE /v2/{project_id}/quota-sets/{project_id}?user_id={user_id}
264 266
265Deletes quotas for a tenant. The quota reverts to the default quota. 267Deletes quotas for a project. The quota reverts to the default quota.
266 268
267If you specify the optional ``user_id`` query parameter, you delete 269If you specify the optional ``user_id`` query parameter, you delete
268the quotas for this user in the tenant. If you omit this parameter, 270the quotas for this user in the project. If you omit this parameter,
269you delete the quotas for the project. 271you delete the quotas for the project.
270 272
271Response codes 273Response codes
@@ -286,7 +288,7 @@ Request
286 288
287.. rest_parameters:: parameters.yaml 289.. rest_parameters:: parameters.yaml
288 290
289 - tenant_id: tenant_id_path 291 - project_id: project_id_path
290 - tenant_id: tenant_id 292 - project_id: project_id_quota_request_path
291 - user_id: user_id_query 293 - user_id: user_id_query
292 - share_type: share_type_for_quota 294 - share_type: share_type_for_quota
diff --git a/api-ref/source/samples/share-instances-list-response.json b/api-ref/source/samples/share-instances-list-response.json
index 09cc287..408d614 100644
--- a/api-ref/source/samples/share-instances-list-response.json
+++ b/api-ref/source/samples/share-instances-list-response.json
@@ -6,11 +6,8 @@
6 "availability_zone": "nova", 6 "availability_zone": "nova",
7 "replica_state": null, 7 "replica_state": null,
8 "created_at": "2015-09-07T08:41:20.000000", 8 "created_at": "2015-09-07T08:41:20.000000",
9 "export_location": "10.254.0.3:/shares/share-081f7030-c54f-42f5-98ee-93a37393e0f2",
10 "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", 9 "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c",
11 "export_locations": [ 10 "cast_rules_to_readonly": false,
12 "10.254.0.3:/shares/share-081f7030-c54f-42f5-98ee-93a37393e0f2"
13 ],
14 "share_server_id": "ba11930a-bf1a-4aa7-bae4-a8dfbaa3cc73", 11 "share_server_id": "ba11930a-bf1a-4aa7-bae4-a8dfbaa3cc73",
15 "host": "manila2@generic1#GENERIC1", 12 "host": "manila2@generic1#GENERIC1",
16 "id": "081f7030-c54f-42f5-98ee-93a37393e0f2" 13 "id": "081f7030-c54f-42f5-98ee-93a37393e0f2"
@@ -21,11 +18,8 @@
21 "availability_zone": "nova", 18 "availability_zone": "nova",
22 "replica_state": null, 19 "replica_state": null,
23 "created_at": "2015-09-07T08:51:34.000000", 20 "created_at": "2015-09-07T08:51:34.000000",
24 "export_location": "10.254.0.3:/shares/share-75559a8b-c90c-42a7-bda2-edbe86acfb7b",
25 "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", 21 "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c",
26 "export_locations": [ 22 "cast_rules_to_readonly": false,
27 "10.254.0.3:/shares/share-75559a8b-c90c-42a7-bda2-edbe86acfb7b"
28 ],
29 "share_server_id": "ba11930a-bf1a-4aa7-bae4-a8dfbaa3cc73", 23 "share_server_id": "ba11930a-bf1a-4aa7-bae4-a8dfbaa3cc73",
30 "host": "manila2@generic1#GENERIC1", 24 "host": "manila2@generic1#GENERIC1",
31 "id": "75559a8b-c90c-42a7-bda2-edbe86acfb7b" 25 "id": "75559a8b-c90c-42a7-bda2-edbe86acfb7b"
diff --git a/api-ref/source/samples/share-manage-request.json b/api-ref/source/samples/share-manage-request.json
index 291c344..a8220bc 100644
--- a/api-ref/source/samples/share-manage-request.json
+++ b/api-ref/source/samples/share-manage-request.json
@@ -10,6 +10,7 @@
10 "export_path": "192.162.10.6:/shares/share-accounting_p8787", 10 "export_path": "192.162.10.6:/shares/share-accounting_p8787",
11 "service_host": "manila2@openstackstor01#accountingpool", 11 "service_host": "manila2@openstackstor01#accountingpool",
12 "is_public": true, 12 "is_public": true,
13 "description": "Common storage for spreadsheets and presentations. Please contact John Accessman to be added to the users of this drive." 13 "description": "Common storage for spreadsheets and presentations. Please contact John Accessman to be added to the users of this drive.",
14 "share_server_id": "00137b40-ca06-4ae8-83a3-2c5989eebcce"
14 } 15 }
15} 16}
diff --git a/api-ref/source/samples/share-manage-response.json b/api-ref/source/samples/share-manage-response.json
index a3fbbdb..4e65a7f 100644
--- a/api-ref/source/samples/share-manage-response.json
+++ b/api-ref/source/samples/share-manage-response.json
@@ -13,7 +13,7 @@
13 "availability_zone": null, 13 "availability_zone": null,
14 "share_network_id": null, 14 "share_network_id": null,
15 "export_locations": [], 15 "export_locations": [],
16 "share_server_id": null, 16 "share_server_id": "00137b40-ca06-4ae8-83a3-2c5989eebcce",
17 "share_group_id": null, 17 "share_group_id": null,
18 "snapshot_id": null, 18 "snapshot_id": null,
19 "id": "00137b40-ca06-4ae8-83a3-2c5989eebcce", 19 "id": "00137b40-ca06-4ae8-83a3-2c5989eebcce",
@@ -32,7 +32,7 @@
32 "is_public": false, 32 "is_public": false,
33 "snapshot_support": true, 33 "snapshot_support": true,
34 "name": "share_texas1", 34 "name": "share_texas1",
35 "created_at": "2015-09-17T16:21:12.000000", 35 "created_at": "2019-03-05T10:00:00.000000",
36 "share_proto": "NFS", 36 "share_proto": "NFS",
37 "volume_type": "d", 37 "volume_type": "d",
38 } 38 }
diff --git a/api-ref/source/samples/share-server-manage-request.json b/api-ref/source/samples/share-server-manage-request.json
new file mode 100644
index 0000000..8b33332
--- /dev/null
+++ b/api-ref/source/samples/share-server-manage-request.json
@@ -0,0 +1,10 @@
1{
2 "share_server": {
3 "host": "myhost@mybackend",
4 "share_network_id": "78cef6eb-648a-4bbd-9ae1-d2eaaf594cc0",
5 "identifier": "4ef3507e-0513-4140-beda-f619ab30d424",
6 "driver_options": {
7 "opt1": "opt1_value"
8 }
9 }
10} \ No newline at end of file
diff --git a/api-ref/source/samples/share-server-manage-response.json b/api-ref/source/samples/share-server-manage-response.json
new file mode 100644
index 0000000..12ae3d0
--- /dev/null
+++ b/api-ref/source/samples/share-server-manage-response.json
@@ -0,0 +1,15 @@
1{
2 "share_server": {
3 "id": "dd218d97-6b16-45b7-9b23-19681ccdec3a",
4 "project_id": "5b23075b4b504261a5987b18588f86cf",
5 "updated_at": null,
6 "status": "manage_starting",
7 "host": "myhost@mybackend",
8 "share_network_name": "share-net-name",
9 "share_network_id": "78cef6eb-648a-4bbd-9ae1-d2eaaf594cc0",
10 "created_at": "2019-03-06T11:59:41.000000",
11 "backend_details": {},
12 "is_auto_deletable": false,
13 "identifier": "4ef3507e-0513-4140-beda-f619ab30d424"
14 }
15} \ No newline at end of file
diff --git a/api-ref/source/samples/share-server-reset-state-request.json b/api-ref/source/samples/share-server-reset-state-request.json
new file mode 100644
index 0000000..b364293
--- /dev/null
+++ b/api-ref/source/samples/share-server-reset-state-request.json
@@ -0,0 +1,5 @@
1{
2 "reset_status": {
3 "status": "active"
4 }
5} \ No newline at end of file
diff --git a/api-ref/source/samples/share-server-unmanage-request.json b/api-ref/source/samples/share-server-unmanage-request.json
new file mode 100644
index 0000000..2dc4331
--- /dev/null
+++ b/api-ref/source/samples/share-server-unmanage-request.json
@@ -0,0 +1,5 @@
1{
2 "unmanage": {
3 "force": "false"
4 }
5} \ No newline at end of file
diff --git a/api-ref/source/samples/share-show-instance-response.json b/api-ref/source/samples/share-show-instance-response.json
index 0dd4b6d..bc95eb0 100644
--- a/api-ref/source/samples/share-show-instance-response.json
+++ b/api-ref/source/samples/share-show-instance-response.json
@@ -5,11 +5,8 @@
5 "availability_zone": "nova", 5 "availability_zone": "nova",
6 "replica_state": null, 6 "replica_state": null,
7 "created_at": "2015-09-07T08:51:34.000000", 7 "created_at": "2015-09-07T08:51:34.000000",
8 "export_location": "10.254.0.3:/shares/share-75559a8b-c90c-42a7-bda2-edbe86acfb7b", 8 "cast_rules_to_readonly": false,
9 "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c", 9 "share_network_id": "713df749-aac0-4a54-af52-10f6c991e80c",
10 "export_locations": [
11 "10.254.0.3:/shares/share-75559a8b-c90c-42a7-bda2-edbe86acfb7b"
12 ],
13 "share_server_id": "ba11930a-bf1a-4aa7-bae4-a8dfbaa3cc73", 10 "share_server_id": "ba11930a-bf1a-4aa7-bae4-a8dfbaa3cc73",
14 "host": "manila2@generic1#GENERIC1", 11 "host": "manila2@generic1#GENERIC1",
15 "access_rules_status": "active", 12 "access_rules_status": "active",
diff --git a/api-ref/source/samples/snapshot-create-response.json b/api-ref/source/samples/snapshot-create-response.json
index 1723e3e..b22e400 100644
--- a/api-ref/source/samples/snapshot-create-response.json
+++ b/api-ref/source/samples/snapshot-create-response.json
@@ -2,6 +2,7 @@
2 "snapshot": { 2 "snapshot": {
3 "status": "creating", 3 "status": "creating",
4 "share_id": "406ea93b-32e9-4907-a117-148b3945749f", 4 "share_id": "406ea93b-32e9-4907-a117-148b3945749f",
5 "user_id": "5c7bdb6eb0504d54a619acf8375c08ce",
5 "name": "snapshot_share1", 6 "name": "snapshot_share1",
6 "links": [ 7 "links": [
7 { 8 {
@@ -18,6 +19,7 @@
18 "share_proto": "NFS", 19 "share_proto": "NFS",
19 "share_size": 1, 20 "share_size": 1,
20 "id": "6d221c1d-0200-461e-8d20-24b4776b9ddb", 21 "id": "6d221c1d-0200-461e-8d20-24b4776b9ddb",
22 "project_id": "cadd7139bc3148b8973df097c0911016",
21 "size": 1 23 "size": 1
22 } 24 }
23} 25}
diff --git a/api-ref/source/samples/snapshot-manage-response.json b/api-ref/source/samples/snapshot-manage-response.json
index 9978b10..5146e1c 100644
--- a/api-ref/source/samples/snapshot-manage-response.json
+++ b/api-ref/source/samples/snapshot-manage-response.json
@@ -9,6 +9,8 @@
9 "description": "description_of_managed_snapshot", 9 "description": "description_of_managed_snapshot",
10 "size": 1, 10 "size": 1,
11 "share_proto": "NFS", 11 "share_proto": "NFS",
12 "user_id": "5c7bdb6eb0504d54a619acf8375c08ce",
13 "project_id": "cadd7139bc3148b8973df097c0911016",
12 "links": [ 14 "links": [
13 { 15 {
14 "href": "http://127.0.0.1:8786/v2/907004508ef4447397ce6741a8f037c1/snapshots/22de7000-3a32-4fe1-bd0c-38d03f93dec3", 16 "href": "http://127.0.0.1:8786/v2/907004508ef4447397ce6741a8f037c1/snapshots/22de7000-3a32-4fe1-bd0c-38d03f93dec3",
diff --git a/api-ref/source/samples/snapshot-show-response.json b/api-ref/source/samples/snapshot-show-response.json
index d5d9f92..87331d1 100644
--- a/api-ref/source/samples/snapshot-show-response.json
+++ b/api-ref/source/samples/snapshot-show-response.json
@@ -2,6 +2,7 @@
2 "snapshot": { 2 "snapshot": {
3 "status": "available", 3 "status": "available",
4 "share_id": "406ea93b-32e9-4907-a117-148b3945749f", 4 "share_id": "406ea93b-32e9-4907-a117-148b3945749f",
5 "user_id": "5c7bdb6eb0504d54a619acf8375c08ce",
5 "name": "snapshot_share1", 6 "name": "snapshot_share1",
6 "links": [ 7 "links": [
7 { 8 {
@@ -18,6 +19,7 @@
18 "share_proto": "NFS", 19 "share_proto": "NFS",
19 "share_size": 1, 20 "share_size": 1,
20 "id": "6d221c1d-0200-461e-8d20-24b4776b9ddb", 21 "id": "6d221c1d-0200-461e-8d20-24b4776b9ddb",
22 "project_id": "cadd7139bc3148b8973df097c0911016",
21 "size": 1 23 "size": 1
22 } 24 }
23} 25}
diff --git a/api-ref/source/samples/snapshot-update-response.json b/api-ref/source/samples/snapshot-update-response.json
index a888c9c..fb8bc08 100644
--- a/api-ref/source/samples/snapshot-update-response.json
+++ b/api-ref/source/samples/snapshot-update-response.json
@@ -3,6 +3,8 @@
3 "status": "available", 3 "status": "available",
4 "share_id": "406ea93b-32e9-4907-a117-148b3945749f", 4 "share_id": "406ea93b-32e9-4907-a117-148b3945749f",
5 "name": "snapshot_Share1", 5 "name": "snapshot_Share1",
6 "user_id": "5c7bdb6eb0504d54a619acf8375c08ce",
7 "project_id": "cadd7139bc3148b8973df097c0911016",
6 "links": [ 8 "links": [
7 { 9 {
8 "href": "http://172.18.198.54:8786/v1/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/6d221c1d-0200-461e-8d20-24b4776b9ddb", 10 "href": "http://172.18.198.54:8786/v1/16e1ab15c35a457e9c2b2aa189f544e1/snapshots/6d221c1d-0200-461e-8d20-24b4776b9ddb",
diff --git a/api-ref/source/samples/snapshots-list-detailed-response.json b/api-ref/source/samples/snapshots-list-detailed-response.json
index b1360c0..1559d30 100644
--- a/api-ref/source/samples/snapshots-list-detailed-response.json
+++ b/api-ref/source/samples/snapshots-list-detailed-response.json
@@ -3,6 +3,7 @@
3 { 3 {
4 "status": "creating", 4 "status": "creating",
5 "share_id": "d94a8548-2079-4be0-b21c-0a887acd31ca", 5 "share_id": "d94a8548-2079-4be0-b21c-0a887acd31ca",
6 "user_id": "5c7bdb6eb0504d54a619acf8375c08ce",
6 "name": "snapshot_My_share", 7 "name": "snapshot_My_share",
7 "links": [ 8 "links": [
8 { 9 {
@@ -19,11 +20,13 @@
19 "share_proto": "NFS", 20 "share_proto": "NFS",
20 "share_size": 1, 21 "share_size": 1,
21 "id": "086a1aa6-c425-4ecd-9612-391a3b1b9375", 22 "id": "086a1aa6-c425-4ecd-9612-391a3b1b9375",
23 "project_id": "cadd7139bc3148b8973df097c0911016",
22 "size": 1 24 "size": 1
23 }, 25 },
24 { 26 {
25 "status": "available", 27 "status": "available",
26 "share_id": "406ea93b-32e9-4907-a117-148b3945749f", 28 "share_id": "406ea93b-32e9-4907-a117-148b3945749f",
29 "user_id": "5c7bdb6eb0504d54a619acf8375c08ce",
27 "name": "snapshot_share1", 30 "name": "snapshot_share1",
28 "links": [ 31 "links": [
29 { 32 {
@@ -40,6 +43,7 @@
40 "share_proto": "NFS", 43 "share_proto": "NFS",
41 "share_size": 1, 44 "share_size": 1,
42 "id": "6d221c1d-0200-461e-8d20-24b4776b9ddb", 45 "id": "6d221c1d-0200-461e-8d20-24b4776b9ddb",
46 "project_id": "cadd7139bc3148b8973df097c0911016",
43 "size": 1 47 "size": 1
44 } 48 }
45 ] 49 ]
diff --git a/api-ref/source/scheduler-stats.inc b/api-ref/source/scheduler-stats.inc
index d0b5389..a7b2834 100644
--- a/api-ref/source/scheduler-stats.inc
+++ b/api-ref/source/scheduler-stats.inc
@@ -11,7 +11,7 @@ to the scheduler service.
11List back-end storage pools 11List back-end storage pools
12=========================== 12===========================
13 13
14.. rest_method:: GET /v2/{tenant_id}/scheduler-stats/pools?pool={pool_name}&host={host_name}&backend={backend_name}&capabilities={capabilities}&share_type={share_type} 14.. rest_method:: GET /v2/{project_id}/scheduler-stats/pools?pool={pool_name}&host={host_name}&backend={backend_name}&capabilities={capabilities}&share_type={share_type}
15 15
16Lists all back-end storage pools. If search options are provided, the pool 16Lists all back-end storage pools. If search options are provided, the pool
17list that is returned is filtered with these options. 17list that is returned is filtered with these options.
@@ -34,7 +34,7 @@ Request
34 34
35.. rest_parameters:: parameters.yaml 35.. rest_parameters:: parameters.yaml
36 36
37 - tenant_id: tenant_id_path 37 - project_id: project_id_path
38 - pool_name: backend_pool_query 38 - pool_name: backend_pool_query
39 - host_name: backend_host_query 39 - host_name: backend_host_query
40 - backend_name: backend_query 40 - backend_name: backend_query
@@ -61,7 +61,7 @@ Response example
61List back-end storage pools with details 61List back-end storage pools with details
62======================================== 62========================================
63 63
64.. rest_method:: GET /v2/{tenant_id}/scheduler-stats/pools/detail?pool={pool_name}&host={host_name}&backend={backend_name}&capabilities={capabilities}&share_type={share_type} 64.. rest_method:: GET /v2/{project_id}/scheduler-stats/pools/detail?pool={pool_name}&host={host_name}&backend={backend_name}&capabilities={capabilities}&share_type={share_type}
65 65
66Lists all back-end storage pools with details. If search options are provided, 66Lists all back-end storage pools with details. If search options are provided,
67the pool list that is returned is filtered with these options. 67the pool list that is returned is filtered with these options.
@@ -84,7 +84,7 @@ Request