Skip to content

Commit 8dc2a7e

Browse files
committed
docs: Update cinderclient comparison doc
Done manually by looking at the help text for the 'cinder' client (version 7.0.0) and identifying gaps. Change-Id: Ib16c7e9dfa47a93d8b077f0e3e5bbd5bf8984ec3 Signed-off-by: Stephen Finucane <sfinucan@redhat.com>
1 parent 82fcf1d commit 8dc2a7e

1 file changed

Lines changed: 146 additions & 104 deletions

File tree

doc/source/cli/data/cinder.csv

Lines changed: 146 additions & 104 deletions
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,146 @@
1-
absolute-limits,limits show --absolute,Lists absolute limits for a user.
2-
availability-zone-list,availability zone list --volume,Lists all availability zones.
3-
backup-create,volume backup create,Creates a volume backup.
4-
backup-delete,volume backup delete,Removes a backup.
5-
backup-export,volume backup record export,Export backup metadata record.
6-
backup-import,volume backup record import,Import backup metadata record.
7-
backup-list,volume backup list,Lists all backups.
8-
backup-reset-state,volume backup set --state,Explicitly updates the backup state.
9-
backup-restore,volume backup restore,Restores a backup.
10-
backup-show,volume backup show,Show backup details.
11-
cgsnapshot-create,consistency group snapshot create,Creates a cgsnapshot.
12-
cgsnapshot-delete,consistency group snapshot delete,Removes one or more cgsnapshots.
13-
cgsnapshot-list,consistency group snapshot list,Lists all cgsnapshots.
14-
cgsnapshot-show,consistency group snapshot show,Shows cgsnapshot details.
15-
consisgroup-create,consistency group create,Creates a consistency group.
16-
consisgroup-create-from-src,consistency group create --consistency-group-snapshot,Creates a consistency group from a cgsnapshot or a source CG
17-
consisgroup-delete,consistency group delete,Removes one or more consistency groups.
18-
consisgroup-list,consistency group list,Lists all consistencygroups.
19-
consisgroup-show,consistency group show,Shows details of a consistency group.
20-
consisgroup-update,consistency group set,Updates a consistencygroup.
21-
create,volume create,Creates a volume.
22-
credentials,WONTFIX,Shows user credentials returned from auth.
23-
delete,volume delete,Removes one or more volumes.
24-
encryption-type-create,volume type create --encryption-provider --enc..,Creates encryption type for a volume type. Admin only.
25-
encryption-type-delete,volume type delete,Deletes encryption type for a volume type. Admin only.
26-
encryption-type-list,volume type list --encryption-type,Shows encryption type details for volume types. Admin only.
27-
encryption-type-show,volume type list --encryption-show,Shows encryption type details for volume type. Admin only.
28-
encryption-type-update,volume type set --encryption-provider --enc..,Update encryption type information for a volume type (Admin Only).
29-
endpoints,catalog list,Discovers endpoints registered by authentication service.
30-
extend,volume set --size,Attempts to extend size of an existing volume.
31-
extra-specs-list,volume type list --long,Lists current volume types and extra specs.
32-
failover-host,volume host failover,Failover a replicating cinder-volume host.
33-
force-delete,volume delete --force,"Attempts force-delete of volume, regardless of state."
34-
freeze-host,volume host set --disable,Freeze and disable the specified cinder-volume host.
35-
get-capabilities,volume backend capability show,Show capabilities of a volume backend. Admin only.
36-
get-pools,volume backend pool list,Show pool information for backends. Admin only.
37-
image-metadata,volume set --image-property,Sets or deletes volume image metadata.
38-
image-metadata-show,volume show,Shows volume image metadata.
39-
list,volume list,Lists all volumes.
40-
manage,volume create --remote-source k=v,Manage an existing volume.
41-
metadata,volume set --property k=v / volume unset --property k,Sets or deletes volume metadata.
42-
metadata-show,volume show,Shows volume metadata.
43-
metadata-update-all,volume set --property k=v,Updates volume metadata.
44-
migrate,volume migrate --host --force-copy --lock-volume <volume>,Migrates volume to a new host.
45-
qos-associate,volume qos associate,Associates qos specs with specified volume type.
46-
qos-create,volume qos create,Creates a qos specs.
47-
qos-delete,volume qos delete,Deletes a specified qos specs.
48-
qos-disassociate,volume qos disassociate,Disassociates qos specs from specified volume type.
49-
qos-disassociate-all,volume qos disassociate --all,Disassociates qos specs from all associations.
50-
qos-get-association,volume qos show,Gets all associations for specified qos specs.
51-
qos-key,volume qos set --property k=v / volume qos unset --property k,Sets or unsets specifications for a qos spec
52-
qos-list,volume qos list,Lists qos specs.
53-
qos-show,volume qos show,Shows a specified qos specs.
54-
quota-class-show,quota show --class,Lists quotas for a quota class.
55-
quota-class-update,quota set --class,Updates quotas for a quota class.
56-
quota-defaults,quota show --default,Lists default quotas for a tenant.
57-
quota-delete,,Delete the quotas for a tenant.
58-
quota-show,quota show,Lists quotas for a tenant.
59-
quota-update,quota set,Updates quotas for a tenant.
60-
quota-usage,,Lists quota usage for a tenant.
61-
rate-limits,limits show --rate,Lists rate limits for a user.
62-
readonly-mode-update,volume set --read-only-mode | --read-write-mode,Updates volume read-only access-mode flag.
63-
rename,volume set --name,Renames a volume.
64-
replication-promote,WONTFIX,Promote a secondary volume to primary for a relationship
65-
replication-reenable,WONTFIX,Sync the secondary volume with primary for a relationship
66-
reset-state,volume set --state,Explicitly updates the volume state.
67-
retype,volume type set --type,Changes the volume type for a volume.
68-
service-disable,volume service set --disable,Disables the service.
69-
service-enable,volume service set --enable,Enables the service.
70-
service-list,volume service list,Lists all services. Filter by host and service binary.
71-
set-bootable,volume set --bootable / --not-bootable,Update bootable status of a volume.
72-
show,volume show,Shows volume details.
73-
snapshot-create,snapshot create,Creates a snapshot.
74-
snapshot-delete,snapshot delete,Remove one or more snapshots.
75-
snapshot-list,snapshot list,Lists all snapshots.
76-
snapshot-manage,volume snapshot create --remote-source <key=value>,Manage an existing snapshot.
77-
snapshot-metadata,snapshot set --property k=v / snapshot unset --property k,Sets or deletes snapshot metadata.
78-
snapshot-metadata-show,snapshot show,Shows snapshot metadata.
79-
snapshot-metadata-update-all,snapshot set --property k=v,Updates snapshot metadata.
80-
snapshot-rename,snapshot set --name,Renames a snapshot.
81-
snapshot-reset-state,snapshot set --state,Explicitly updates the snapshot state.
82-
snapshot-show,snapshot show,Shows snapshot details.
83-
snapshot-unmanage,volume snapshot delete --remote,Stop managing a snapshot.
84-
thaw-host,volume host set --enable,Thaw and enable the specified cinder-volume host.
85-
transfer-accept,volume transfer accept,Accepts a volume transfer.
86-
transfer-create,volume transfer create,Creates a volume transfer.
87-
transfer-delete,volume transfer delete,Undoes a transfer.
88-
transfer-list,volume transfer list,Lists all transfers.
89-
transfer-show,volume transfer show,Show transfer details.
90-
type-access-add,volume type set --project,Adds volume type access for the given project.
91-
type-access-list,volume type show,Print access information about the given volume type.
92-
type-access-remove,volume type unset --project,Removes volume type access for the given project.
93-
type-create,volume type create,Creates a volume type.
94-
type-default,volume type list --default,List the default volume type.
95-
type-delete,volume type delete,Deletes a specified volume type.
96-
type-key,volume type set --property k=v / volume type unset --property k,Sets or unsets extra_spec for a volume type.
97-
type-list,volume type list,Lists available 'volume types'.
98-
type-show,volume type show,Show volume type details.
99-
type-update,volume type set,"Updates volume type name, description, and/or is_public."
100-
unmanage,volume delete --remote,Stop managing a volume.
101-
upload-to-image,image create --volume,Uploads volume to Image Service as an image.
102-
bash-completion,complete,Prints arguments for bash_completion.
103-
help,help,Shows help about this program or one of its subcommands.
104-
list-extensions,extension list --volume,Lists all available os-api extensions.
1+
absolute-limits,limits show --absolute,Lists absolute limits for a user.
2+
api-version,WONTFIX,Display the server API version information.
3+
availability-zone-list,availability zone list --volume,Lists all availability zones.
4+
attachment-complete,,Complete an attachment for a cinder volume. (Supported by API versions 3.44 - 3.latest)
5+
attachment-create,,Create an attachment for a cinder volume. (Supported by API versions 3.27 - 3.latest)
6+
attachment-delete,,Delete an attachment for a cinder volume. (Supported by API versions 3.27 - 3.latest)
7+
attachment-list,,Lists all attachments. (Supported by API versions 3.27 - 3.latest)
8+
attachment-show,,Show detailed information for attachment. (Supported by API versions 3.27 - 3.latest)
9+
attachment-update,,Update an attachment for a cinder volume. (Supported by API versions 3.27 - 3.latest)
10+
backup-create,volume backup create,Creates a volume backup.
11+
backup-delete,volume backup delete,Removes a backup.
12+
backup-export,volume backup record export,Export backup metadata record.
13+
backup-import,volume backup record import,Import backup metadata record.
14+
backup-list,volume backup list,Lists all backups.
15+
backup-reset-state,volume backup set --state,Explicitly updates the backup state.
16+
backup-restore,volume backup restore,Restores a backup.
17+
backup-show,volume backup show,Show backup details.
18+
backup-update,,Updates a backup. (Supported by API versions 3.9 - 3.latest)
19+
cgsnapshot-create,consistency group snapshot create,Creates a cgsnapshot.
20+
cgsnapshot-delete,consistency group snapshot delete,Removes one or more cgsnapshots.
21+
cgsnapshot-list,consistency group snapshot list,Lists all cgsnapshots.
22+
cgsnapshot-show,consistency group snapshot show,Shows cgsnapshot details.
23+
cluster-disable,,Disables clustered services. (Supported by API versions 3.7 - 3.latest)
24+
cluster-enable,,Enables clustered services. (Supported by API versions 3.7 - 3.latest)
25+
cluster-list,,Lists clustered services with optional filtering. (Supported by API versions 3.7 - 3.latest)
26+
cluster-show,,Show detailed information on a clustered service. (Supported by API versions 3.7 - 3.latest)
27+
consisgroup-create,consistency group create,Creates a consistency group.
28+
consisgroup-create-from-src,consistency group create --consistency-group-snapshot,Creates a consistency group from a cgsnapshot or a source CG
29+
consisgroup-delete,consistency group delete,Removes one or more consistency groups.
30+
consisgroup-list,consistency group list,Lists all consistencygroups.
31+
consisgroup-show,consistency group show,Shows details of a consistency group.
32+
consisgroup-update,consistency group set,Updates a consistencygroup.
33+
create,volume create,Creates a volume.
34+
delete,volume delete,Removes one or more volumes.
35+
encryption-type-create,volume type create --encryption-provider --enc..,Creates encryption type for a volume type. Admin only.
36+
encryption-type-delete,volume type delete,Deletes encryption type for a volume type. Admin only.
37+
encryption-type-list,volume type list --encryption-type,Shows encryption type details for volume types. Admin only.
38+
encryption-type-show,volume type list --encryption-show,Shows encryption type details for volume type. Admin only.
39+
encryption-type-update,volume type set --encryption-provider --enc..,Update encryption type information for a volume type (Admin Only).
40+
extend,volume set --size,Attempts to extend size of an existing volume.
41+
extra-specs-list,volume type list --long,Lists current volume types and extra specs.
42+
failover-host,volume host failover,Failover a replicating cinder-volume host.
43+
force-delete,volume delete --force,"Attempts force-delete of volume regardless of state."
44+
freeze-host,volume host set --disable,Freeze and disable the specified cinder-volume host.
45+
get-capabilities,volume backend capability show,Show capabilities of a volume backend. Admin only.
46+
get-pools,volume backend pool list,Show pool information for backends. Admin only.
47+
group-create,,Creates a group. (Supported by API versions 3.13 - 3.latest)
48+
group-create-from-src,,Creates a group from a group snapshot or a source group. (Supported by API versions 3.14 - 3.latest)
49+
group-delete,,Removes one or more groups. (Supported by API versions 3.13 - 3.latest)
50+
group-disable-replication,,Disables replication for group. (Supported by API versions 3.38 - 3.latest)
51+
group-enable-replication,,Enables replication for group. (Supported by API versions 3.38 - 3.latest)
52+
group-failover-replication,,Fails over replication for group. (Supported by API versions 3.38 - 3.latest)
53+
group-list,,Lists all groups. (Supported by API versions 3.13 - 3.latest)
54+
group-list-replication-targets,,Lists replication targets for group. (Supported by API versions 3.38 - 3.latest)
55+
group-show,,Shows details of a group. (Supported by API versions 3.13 - 3.latest)
56+
group-snapshot-create,,Creates a group snapshot. (Supported by API versions 3.14 - 3.latest)
57+
group-snapshot-delete,,Removes one or more group snapshots. (Supported by API versions 3.14 - 3.latest)
58+
group-snapshot-list,,Lists all group snapshots. (Supported by API versions 3.14 - 3.latest)
59+
group-snapshot-show,,Shows group snapshot details. (Supported by API versions 3.14 - 3.latest)
60+
group-specs-list,,Lists current group types and specs. (Supported by API versions 3.11 - 3.latest)
61+
group-type-create,,Creates a group type. (Supported by API versions 3.11 - 3.latest)
62+
group-type-default,,List the default group type. (Supported by API versions 3.11 - 3.latest)
63+
group-type-delete,,Deletes group type or types. (Supported by API versions 3.11 - 3.latest)
64+
group-type-key,,Sets or unsets group_spec for a group type. (Supported by API versions 3.11 - 3.latest)
65+
group-type-list,,Lists available 'group types'. (Admin only will see private types) (Supported by API versions 3.11 - 3.latest)
66+
group-type-show,,Show group type details. (Supported by API versions 3.11 - 3.latest)
67+
group-type-update,,Updates group type name description and/or is_public. (Supported by API versions 3.11 - 3.latest)
68+
group-update,,Updates a group. (Supported by API versions 3.13 - 3.latest)
69+
image-metadata,volume set --image-property,Sets or deletes volume image metadata.
70+
image-metadata-show,volume show,Shows volume image metadata.
71+
list,volume list,Lists all volumes.
72+
list-filters,,List enabled filters. (Supported by API versions 3.33 - 3.latest)
73+
manage,volume create --remote-source k=v,Manage an existing volume.
74+
manageable-list,,Lists all manageable volumes. (Supported by API versions 3.8 - 3.latest)
75+
message-delete,,Removes one or more messages. (Supported by API versions 3.3 - 3.latest)
76+
message-list,,Lists all messages. (Supported by API versions 3.3 - 3.latest)
77+
message-show,,Shows message details. (Supported by API versions 3.3 - 3.latest)
78+
metadata,volume set --property k=v / volume unset --property k,Sets or deletes volume metadata.
79+
metadata-show,volume show,Shows volume metadata.
80+
metadata-update-all,volume set --property k=v,Updates volume metadata.
81+
migrate,volume migrate --host --force-copy --lock-volume <volume>,Migrates volume to a new host.
82+
qos-associate,volume qos associate,Associates qos specs with specified volume type.
83+
qos-create,volume qos create,Creates a qos specs.
84+
qos-delete,volume qos delete,Deletes a specified qos specs.
85+
qos-disassociate,volume qos disassociate,Disassociates qos specs from specified volume type.
86+
qos-disassociate-all,volume qos disassociate --all,Disassociates qos specs from all associations.
87+
qos-get-association,volume qos show,Gets all associations for specified qos specs.
88+
qos-key,volume qos set --property k=v / volume qos unset --property k,Sets or unsets specifications for a qos spec
89+
qos-list,volume qos list,Lists qos specs.
90+
qos-show,volume qos show,Shows a specified qos specs.
91+
quota-class-show,quota show --class,Lists quotas for a quota class.
92+
quota-class-update,quota set --class,Updates quotas for a quota class.
93+
quota-defaults,quota show --default,Lists default quotas for a tenant.
94+
quota-delete,,Delete the quotas for a tenant.
95+
quota-show,quota show,Lists quotas for a tenant.
96+
quota-update,quota set,Updates quotas for a tenant.
97+
quota-usage,,Lists quota usage for a tenant.
98+
rate-limits,limits show --rate,Lists rate limits for a user.
99+
readonly-mode-update,volume set --read-only-mode | --read-write-mode,Updates volume read-only access-mode flag.
100+
rename,volume set --name,Renames a volume.
101+
reset-state,volume set --state,Explicitly updates the volume state.
102+
retype,volume type set --type,Changes the volume type for a volume.
103+
revert-to-snapshot,,Revert a volume to the specified snapshot. (Supported by API versions 3.40 - 3.latest)
104+
service-disable,volume service set --disable,Disables the service.
105+
service-enable,volume service set --enable,Enables the service.
106+
service-get-log,,(Supported by API versions 3.32 - 3.latest)
107+
service-list,volume service list,Lists all services. Filter by host and service binary.
108+
service-set-log,,(Supported by API versions 3.32 - 3.latest)
109+
set-bootable,volume set --bootable / --not-bootable,Update bootable status of a volume.
110+
show,volume show,Shows volume details.
111+
snapshot-create,snapshot create,Creates a snapshot.
112+
snapshot-delete,snapshot delete,Remove one or more snapshots.
113+
snapshot-list,snapshot list,Lists all snapshots.
114+
snapshot-manage,volume snapshot create --remote-source <key=value>,Manage an existing snapshot.
115+
snapshot-manageable-list,,Lists all manageable snapshots. (Supported by API versions 3.8 - 3.latest)
116+
snapshot-metadata,snapshot set --property k=v / snapshot unset --property k,Sets or deletes snapshot metadata.
117+
snapshot-metadata-show,snapshot show,Shows snapshot metadata.
118+
snapshot-metadata-update-all,snapshot set --property k=v,Updates snapshot metadata.
119+
snapshot-rename,snapshot set --name,Renames a snapshot.
120+
snapshot-reset-state,snapshot set --state,Explicitly updates the snapshot state.
121+
snapshot-show,snapshot show,Shows snapshot details.
122+
snapshot-unmanage,volume snapshot delete --remote,Stop managing a snapshot.
123+
summary,,Get volumes summary. (Supported by API versions 3.12 - 3.latest)
124+
thaw-host,volume host set --enable,Thaw and enable the specified cinder-volume host.
125+
transfer-accept,volume transfer accept,Accepts a volume transfer.
126+
transfer-create,volume transfer create,Creates a volume transfer.
127+
transfer-delete,volume transfer delete,Undoes a transfer.
128+
transfer-list,volume transfer list,Lists all transfers.
129+
transfer-show,volume transfer show,Show transfer details.
130+
type-access-add,volume type set --project,Adds volume type access for the given project.
131+
type-access-list,volume type show,Print access information about the given volume type.
132+
type-access-remove,volume type unset --project,Removes volume type access for the given project.
133+
type-create,volume type create,Creates a volume type.
134+
type-default,volume type list --default,List the default volume type.
135+
type-delete,volume type delete,Deletes a specified volume type.
136+
type-key,volume type set --property k=v / volume type unset --property k,Sets or unsets extra_spec for a volume type.
137+
type-list,volume type list,Lists available 'volume types'.
138+
type-show,volume type show,Show volume type details.
139+
type-update,volume type set,"Updates volume type name description and/or is_public."
140+
unmanage,volume delete --remote,Stop managing a volume.
141+
upload-to-image,image create --volume,Uploads volume to Image Service as an image.
142+
version-list,,List all API versions. (Supported by API versions 3.0 - 3.latest)
143+
work-cleanup,,Request cleanup of services with optional filtering. (Supported by API versions 3.24 - 3.latest)
144+
bash-completion,complete,Prints arguments for bash_completion.
145+
help,help,Shows help about this program or one of its subcommands.
146+
list-extensions,extension list --volume,Lists all available os-api extensions.

0 commit comments

Comments
 (0)