openstack/python-manilaclient
Code Issues Proposed changes
a14eb3adf7
python-manilaclient/doc/source/cli/osc/v2/index.rst

224 lines
4.4 KiB
ReStructuredText
Raw Normal View History

Add initial documentation for OSC This patch creates initial documentation for OSC, with general plugin information and a few examples. New commands, that are implemented, should be then referenced in doc/source/cli/osc/v2/index.rst Change-Id: I6fa9fcb3cf41a2992a4b5c7b38c54825106e9ce5 Partially-implements: bp openstack-client-support
2020-02-04 20:46:56 +00:00
Command Reference
=================
List of released CLI commands available in openstack client. These commands
can be referenced by executing ``openstack help share``.
======
shares
======
.. autoprogram-cliff:: openstack.share.v2
:command: share create
.. autoprogram-cliff:: openstack.share.v2
:command: share list
.. autoprogram-cliff:: openstack.share.v2
:command: share show
.. autoprogram-cliff:: openstack.share.v2
:command: share delete
.. autoprogram-cliff:: openstack.share.v2
:command: share set
.. autoprogram-cliff:: openstack.share.v2
:command: share unset
Implement openstack share properties show command This commit adds openstack share show metadata command, which implements manila metadata-show functionality. Partially implements bp openstack-client-support. Updated with working unit test. Change-Id: Ibde82cf9c36be41403a0e68ecac17cb211725d84
2020-11-16 16:48:35 +00:00
.. autoprogram-cliff:: openstack.share.v2
:command: share properties show
Add initial documentation for OSC This patch creates initial documentation for OSC, with general plugin information and a few examples. New commands, that are implemented, should be then referenced in doc/source/cli/osc/v2/index.rst Change-Id: I6fa9fcb3cf41a2992a4b5c7b38c54825106e9ce5 Partially-implements: bp openstack-client-support
2020-02-04 20:46:56 +00:00
.. autoprogram-cliff:: openstack.share.v2
:command: share resize
[OSC] Implement Share Adopt & Abandon Commands This commit adds 'openstack share adopt' and 'openstack share abandon' commands, that implement the same functionality as 'manila manage' and 'manila unmanage' commands Usage: openstack share adopt <service-host> <protocol> <export-path> openstack share abandon <share> Partially-implements bp openstack-client-support Change-Id: I39919d38854387af21da410849905698ad261e9f
2020-11-14 19:06:05 +00:00
.. autoprogram-cliff:: openstack.share.v2
:command: share adopt
.. autoprogram-cliff:: openstack.share.v2
:command: share abandon
[OSC] Implement Share Export Location Commands This commit implements the following openstack share commands: openstack share export location show <share> <export_location> openstack share export location list <share> Partially-implements bp openstack-client-support Change-Id: Ie65fdd644e7161d94947614a87933f36c1826bed
2020-11-04 20:07:59 +00:00
.. autoprogram-cliff:: openstack.share.v2
:command: share export location show
.. autoprogram-cliff:: openstack.share.v2
:command: share export location list
[OSC] Implement Share Revert Command This patch adds the 'openstack share revert' command, which implements the same functionality as 'manila revert-to-snapshot' and can be used to revert a share to a specified snapshot. Partially-implements bp openstack-client-support Change-Id: I896f2bb4ae256dda637768672f833573f5c2475d
2021-01-25 17:54:36 +00:00
.. autoprogram-cliff:: openstack.share.v2
:command: share revert
Implement openstack share properties show command This commit adds openstack share show metadata command, which implements manila metadata-show functionality. Partially implements bp openstack-client-support. Updated with working unit test. Change-Id: Ibde82cf9c36be41403a0e68ecac17cb211725d84
2020-11-16 16:48:35 +00:00
[OSC] Implement Share Restore Command This patch adds the 'openstack share restore' command, which implements same functionality as 'manila restore' and can be used to restore a share from the recycle bin Partially-implements: bp openstack-client-support Change-Id: I30f3c36c00d41f8321654285e2ca4455e5d0f8f9
2022-06-08 14:24:30 +01:00
.. autoprogram-cliff:: openstack.share.v2
:command: share restore
[OSC] Implement share instance commands Added the implementation of the share instance commands to OSC. Commands are: - openstack share instance delete - openstack share instance list - openstack share instance set - openstack share instance show Co-Authored-By: Luisa Amaral <luisarfamaral@gmail.com> Partially-Implements: bp openstack-client-support Change-Id: I8d29651d4e3a74b9ade67ea0a8f20808ca33bdc8
2021-08-19 13:17:49 -03:00
===============
share instances
===============
.. autoprogram-cliff:: openstack.share.v2
Implement OSC share instance export location commands In this patch we add openstack commands for: - share instance export location show - share instance export location list Co-authored-by: Eduardo Santos <eduardo.experimental@gmail.com> Partially-implements: bp openstack-client-support Change-Id: Ic1b5616a363059a941caa3cce6bd2b24bd379068
2021-08-19 17:48:54 -03:00
:command: share instance [!e]*
[OSC] Implement share instance commands Added the implementation of the share instance commands to OSC. Commands are: - openstack share instance delete - openstack share instance list - openstack share instance set - openstack share instance show Co-Authored-By: Luisa Amaral <luisarfamaral@gmail.com> Partially-Implements: bp openstack-client-support Change-Id: I8d29651d4e3a74b9ade67ea0a8f20808ca33bdc8
2021-08-19 13:17:49 -03:00
Add initial documentation for OSC This patch creates initial documentation for OSC, with general plugin information and a few examples. New commands, that are implemented, should be then referenced in doc/source/cli/osc/v2/index.rst Change-Id: I6fa9fcb3cf41a2992a4b5c7b38c54825106e9ce5 Partially-implements: bp openstack-client-support
2020-02-04 20:46:56 +00:00
==================
share access rules
==================
.. autoprogram-cliff:: openstack.share.v2
:command: share access *
[OSC] Implement Share Migration Start Command This commit adds 'openstack share migration start' command, that implement the same functionality as 'manila migration-start' command. Partially-implements: bp openstack-client-support Change-Id: I3e8a04904ba387161841a677442b00b4a5456c4d
2022-04-03 08:32:11 +00:00
===============
share migration
===============
.. autoprogram-cliff:: openstack.share.v2
:command: share migration start
[OSC] Implement Share Migration Cancel and Complete Command This commit adds 'openstack share migration cancel' and 'openstack share migration complete' command, that implement the same functionality as 'manila migration-cancel'and 'manila migration-complete' command. Partially-implements: bp openstack-client-support Change-Id: I153d3131b591aef599cff87a5dbd85f5db3115dd
2022-04-17 17:20:51 +00:00
.. autoprogram-cliff:: openstack.share.v2
:command: share migration cancel
.. autoprogram-cliff:: openstack.share.v2
:command: share migration complete
[OSC] Implement Share Migration show and add argument to Share Set Command This commit adds 'openstack share migration show' and add argument '--task-state' to 'openstack share set' command, that implement the same functionality as 'manila migration-get-progress'and manila reset-task-state command. Partially-implements: bp openstack-client-support Change-Id: I288661b4294561a1a52411a0cb0fdfd1f82021ed
2022-06-02 16:11:02 +00:00
.. autoprogram-cliff:: openstack.share.v2
:command: share migration show
[OSC] Implement Share Migration Cancel and Complete Command This commit adds 'openstack share migration cancel' and 'openstack share migration complete' command, that implement the same functionality as 'manila migration-cancel'and 'manila migration-complete' command. Partially-implements: bp openstack-client-support Change-Id: I153d3131b591aef599cff87a5dbd85f5db3115dd
2022-04-17 17:20:51 +00:00
OSC Implementation for Share Networks Add the following OSC commands: share network create share network list share network show share network set share network unset share network delete Partially-implements: bp openstack-client-support Change-Id: I6ddb2fec1d9421bfa8b11c82da5379ada80f610b Co-Authored-By: Vida Haririan <vhariria@redhat.com> Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2021-08-18 09:05:22 -07:00
==============
share networks
==============
.. autoprogram-cliff:: openstack.share.v2
[OSC] Implement share network subnet commands This patch adds the following openstack share commands: share network subnet create share network subnet delete share network subnet show Partially-implements: bp openstack-client-support Change-Id: I4e066a982fa40b079f969e7c3ca3276d3a842074
2021-10-30 21:05:32 +00:00
:command: share network [!s]*
.. autoprogram-cliff:: openstack.share.v2
:command: share network show
.. autoprogram-cliff:: openstack.share.v2
:command: share network set
=====================
share network subnets
=====================
.. autoprogram-cliff:: openstack.share.v2
:command: share network subnet *
OSC Implementation for Share Networks Add the following OSC commands: share network create share network list share network show share network set share network unset share network delete Partially-implements: bp openstack-client-support Change-Id: I6ddb2fec1d9421bfa8b11c82da5379ada80f610b Co-Authored-By: Vida Haririan <vhariria@redhat.com> Signed-off-by: Goutham Pacha Ravi <gouthampravi@gmail.com>
2021-08-18 09:05:22 -07:00
Add initial documentation for OSC This patch creates initial documentation for OSC, with general plugin information and a few examples. New commands, that are implemented, should be then referenced in doc/source/cli/osc/v2/index.rst Change-Id: I6fa9fcb3cf41a2992a4b5c7b38c54825106e9ce5 Partially-implements: bp openstack-client-support
2020-02-04 20:46:56 +00:00
===========
share types
===========
.. autoprogram-cliff:: openstack.share.v2
:command: share type *
Implement OSC share quota commands In this patch we add openstack commands for: share quota set share quota show share quota delete Change-Id: I3520feec09a6c491f436809a5f620efce1b1f8c2 Partially-implements: bp openstack-client-support
2020-01-23 13:45:07 +00:00
============
share quotas
============
.. autoprogram-cliff:: openstack.share.v2
:command: share quota *
Implement the first half of OSC share snapshots commands In this patch we add openstack commands for: share snapshot create share snapshot delete share snapshot show share snapshot set share snapshot unset share snapshot list Partially-implements bp openstack-client-support Change-Id: Idfe2033016f333da0169fd032ff95bf868099f70
2020-06-30 20:21:32 +00:00
===============
share snapshots
===============
.. autoprogram-cliff:: openstack.share.v2
[OSC] Add Share Snapshot Instances commands In this patch we add the following openstack share commands: share snapshot instance list share snapshot instance show share snapshot instance set --status share snapshot instance export location list share snapshot instance export location show Partially-implements: bp openstack-client-support Co-Authored-By: Caique Mello <caiquemellosbo@gmail.com> Change-Id: I7feb6219b0c684d2e88d0d077f776bfb331e3955
2021-08-19 14:26:37 -03:00
:command: share snapshot [!i]*
========================
share snapshot instances
========================
.. autoprogram-cliff:: openstack.share.v2
:command: share snapshot instance *
[OSC] Implement user messages commands In this patch the following openstack user messages commands are added: manila message-delete --> openstack share message delete manila message-list --> openstack share message list manila message-show --> openstack share message show Partially-implements bp openstack-client-support Change-Id: Ib1e4cca4f869d4e832e7b1814d48c838f75b42e1
2021-02-01 23:30:55 +06:00
===============
user messages
===============
.. autoprogram-cliff:: openstack.share.v2
:command: share message *
[OSC] Implement Share Replica Commands In this patch we add the following openstack share commands: share replica create share replica delete share replica list share replica show share replica set share replica promote share replica resync Partially-implements: bp openstack-client-support Change-Id: I8d0542faf56e6022e3b265957132f00ce063dcd6
2020-11-29 09:33:32 +00:00
==============
share replicas
==============
.. autoprogram-cliff:: openstack.share.v2
:command: share replica *
[OSC] Implement Availability Zones Command This commit implements the following openstack share command: openstack share availability zone list Change-Id: I75d3c5441b82fb8f16896719544a81dd032cdd15
2021-08-16 17:25:58 +00:00
========================
share availability zones
========================
.. autoprogram-cliff:: openstack.share.v2
:command: share availability zone list
[OSC] Implement Share Services Commands In this patch we add the following openstack share commands: share service list share sevice set manila service-enable command is implemented as: openstack share service set <hostname> <binary> --enable manila service-disable command is implemented as: openstack share service set <hostname> <binary> --disable Partially-implements: bp openstack-client-support Change-Id: I41852e93fce356549ca0600b02d972742a105a38
2021-08-18 15:08:04 +00:00
==============
share services
==============
.. autoprogram-cliff:: openstack.share.v2
:command: share service *
[OSC] Implement Share Pools List command This commit implements the following openstack share command: openstack share pool list Partially-implements: bp openstack-client-support Change-Id: I5be047d6c81556b45773497f55323d1611c1eb48
2021-08-19 10:34:14 +00:00
[OSC] Implement security services commands In this patch we add the following openstack share commands: share security service create share security service delete share security service list share security service show share security service set share security service unset Partially-implements: bp openstack-client-support Change-Id: I24d27a7789f7be4f250b6b4d14a7c03acd2474bb
2021-11-02 19:56:10 +00:00
=======================
share security services
=======================
.. autoprogram-cliff:: openstack.share.v2
:command: share security service *
[OSC] Implement Share Pools List command This commit implements the following openstack share command: openstack share pool list Partially-implements: bp openstack-client-support Change-Id: I5be047d6c81556b45773497f55323d1611c1eb48
2021-08-19 10:34:14 +00:00
===========
share pools
===========
.. autoprogram-cliff:: openstack.share.v2
:command: share pool list
[OSC] Implement Share Limits Show command Adding the following openstack command, share limits show --absolute share limits show --rate Partially-implements: bp openstack-client-support Co-Authored-By: Goutham Pacha Ravi <gouthampravi@gmail.com> Change-Id: I68b98a6c3ee369be1422d2f45e75d034e68da2e0
2021-08-25 08:19:53 -04:00
============
share limits
============
.. autoprogram-cliff:: openstack.share.v2
:command: share limits *
Implement OSC share instance export location commands In this patch we add openstack commands for: - share instance export location show - share instance export location list Co-authored-by: Eduardo Santos <eduardo.experimental@gmail.com> Partially-implements: bp openstack-client-support Change-Id: Ic1b5616a363059a941caa3cce6bd2b24bd379068
2021-08-19 17:48:54 -03:00
==============================
share instance export location
==============================
.. autoprogram-cliff:: openstack.share.v2
:command: share instance export location *
[OSC] Implement Share Group Commands Added the implementation of the share group commands to OSC. Commands are: - openstack share group create - openstack share group delete - openstack share group list - openstack share group show - openstack share group set - openstack share group unset Change-Id: I9eb31449fef4eae73f1db91f2bad133d0fe8df2e
2021-07-22 03:27:00 +00:00
============
share groups
============
.. autoprogram-cliff:: openstack.share.v2
[OSC] Implement Share Group Snapshot Commands In this patch we add the following openstack share group snapshot commands: share group snapshot create share group snapshot delete share group snapshot list share group snapshot show share group snapshot set share group snapshot unset share group snapshot members list Co-Authored-By: Archana Kumari <ak31960466@gmail.com> Maari Tamm <maari.tamm@citynetwork.eu> Change-Id: Iab7298964e71e732b574243222d3f5346428b352
2021-07-28 18:58:31 +00:00
:command: share group [!ts]*
.. autoprogram-cliff:: openstack.share.v2
:command: share group set
[OSC] Implement Share Group Type Commands In this patch we add the following openstack share commands: share group type create share group type delete share group type list share group type set share group type unset share group type show share group type access create share group type access delete share group type access list Partially-implements: bp openstack-client-support Co-Authored-By: Ashley Rodriguez <ashrodri@redhat.com> Change-Id: I31b22013b60560c17bc95c41a51efc5e6c7a80ca
2021-08-18 16:45:20 +00:00
=================
share group types
=================
.. autoprogram-cliff:: openstack.share.v2
[OSC] Implement Share Migration Start Command This commit adds 'openstack share migration start' command, that implement the same functionality as 'manila migration-start' command. Partially-implements: bp openstack-client-support Change-Id: I3e8a04904ba387161841a677442b00b4a5456c4d
2022-04-03 08:32:11 +00:00
:command: share group type *
[OSC] Implement Share Group Snapshot Commands In this patch we add the following openstack share group snapshot commands: share group snapshot create share group snapshot delete share group snapshot list share group snapshot show share group snapshot set share group snapshot unset share group snapshot members list Co-Authored-By: Archana Kumari <ak31960466@gmail.com> Maari Tamm <maari.tamm@citynetwork.eu> Change-Id: Iab7298964e71e732b574243222d3f5346428b352
2021-07-28 18:58:31 +00:00
=====================
share group snapshots
=====================
.. autoprogram-cliff:: openstack.share.v2
:command: share group snapshot *
[OSC] Implement Share Server Commands Added the implementation of the share server commands to OSC. Commands are: - openstack share server delete - openstack share server show - openstack share server list - openstack share server adopt - openstack share server abandon - openstack share server set --status Partially-implements: bp openstack-client-support Co-Authored-By: Carlos da Silva <ces.eduardo98@gmail.com> Change-Id: I01b0ee1a8092002d2c2aa916617b2db75654e8d8
2021-08-19 03:14:11 +00:00
==============
share servers
==============
.. autoprogram-cliff:: openstack.share.v2
:command: share server *
Support for resource locks Add OSC and SDK interfaces to create, view, update and delete resource locks. Depends-On: I146bc09e4e8a39797e22458ff6860346e11e592e Partially-Implements: bp allow-locking-shares-against-deletion Change-Id: Ib8586a4f80aa8c172d876c6745ae73b7bdaf4705
2023-07-07 20:10:15 -07:00
==============
resource locks
==============
.. autoprogram-cliff:: openstack.share.v2
:command: share lock *
Copy Permalink