summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects
diff options
context:
space:
mode:
authorSean McGinnis <sean.mcginnis@gmail.com>2018-10-23 11:34:07 -0500
committerDean Troyer <dtroyer@gmail.com>2019-05-20 14:05:18 -0500
commite76e10c0bac9cf87c564a7f0201df189f7cd8b52 (patch)
tree08ef97c0f31040490fe0dac26e569cf16903a83c /doc/source/cli/command-objects
parent5a0fc68a87d1c9733c1dd5bb6f68b2e518fe2105 (diff)
downloadpython-openstackclient-e76e10c0bac9cf87c564a7f0201df189f7cd8b52.tar.gz
Remove deprecated volume commands and args
The following were deprecated over two years ago and can now be removed: * Remove ``backup`` commands in favor of ``volume backup`` * Remove ``snapshot`` commands in favor of ``volume snapshot`` * Remove ``volume create`` options ``--project``, ``--user`` and ``--multi-attach`` * Use of an auth-key positional argument in volume transfers * ``volume transfer request`` no longer accepts 'auth_key' as a positional arg, ``--auth-key`` is now required Internal (non-user-visible) * Rename backup.py to volume_backup.py for Volume v1 and v2, update tests These are backwards incompatible changes and will require a major version bump after they are merged. Change-Id: I94aa7a9824e44f9585ffb45e5e7637b9588539b4 Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com> Signed-off-by: Dean Troyer <dtroyer@gmail.com>
Diffstat (limited to 'doc/source/cli/command-objects')
-rw-r--r--doc/source/cli/command-objects/backup.rst137
-rw-r--r--doc/source/cli/command-objects/snapshot.rst176
2 files changed, 0 insertions, 313 deletions
diff --git a/doc/source/cli/command-objects/backup.rst b/doc/source/cli/command-objects/backup.rst
deleted file mode 100644
index f8923276..00000000
--- a/doc/source/cli/command-objects/backup.rst
+++ /dev/null
@@ -1,137 +0,0 @@
-======
-backup
-======
-
-Block Storage v1, v2
-
-backup create
--------------
-
-Create new backup
-(Deprecated, please use ``volume backup create`` instead)
-
-.. program:: backup create
-.. code:: bash
-
- openstack backup create
- [--container <container>]
- [--name <name>]
- [--description <description>]
- [--snapshot <snapshot>]
- [--force]
- [--incremental]
- <volume>
-
-.. option:: --container <container>
-
- Optional backup container name
-
-.. option:: --name <name>
-
- Name of the backup
-
-.. option:: --description <description>
-
- Description of the backup
-
-.. option:: --snapshot <snapshot>
-
- Snapshot to backup (name or ID)
-
- *Volume version 2 only*
-
-.. option:: --force
-
- Allow to back up an in-use volume
-
- *Volume version 2 only*
-
-.. option:: --incremental
-
- Perform an incremental backup
-
- *Volume version 2 only*
-
-.. _backup_create-backup:
-.. describe:: <volume>
-
- Volume to backup (name or ID)
-
-backup delete
--------------
-
-Delete backup(s)
-(Deprecated, please use ``volume backup delete`` instead)
-
-.. program:: backup delete
-.. code:: bash
-
- openstack backup delete
- [--force]
- <backup> [<backup> ...]
-
-.. option:: --force
-
- Allow delete in state other than error or available
-
- *Volume version 2 only*
-
-.. _backup_delete-backup:
-.. describe:: <backup>
-
- Backup(s) to delete (name or ID)
-
-backup list
------------
-
-List backups
-(Deprecated, please use ``volume backup list`` instead)
-
-.. program:: backup list
-.. code:: bash
-
- openstack backup list
-
-.. _backup_list-backup:
-.. option:: --long
-
- List additional fields in output
-
-backup restore
---------------
-
-Restore backup
-(Deprecated, please use ``volume backup restore`` instead)
-
-.. program:: backup restore
-.. code:: bash
-
- openstack backup restore
- <backup>
- <volume>
-
-.. _backup_restore-backup:
-.. describe:: <backup>
-
- Backup to restore (name or ID)
-
-.. describe:: <volume>
-
- Volume to restore to (name or ID)
-
-backup show
------------
-
-Display backup details
-(Deprecated, please use ``volume backup show`` instead)
-
-.. program:: backup show
-.. code:: bash
-
- openstack backup show
- <backup>
-
-.. _backup_show-backup:
-.. describe:: <backup>
-
- Backup to display (name or ID)
diff --git a/doc/source/cli/command-objects/snapshot.rst b/doc/source/cli/command-objects/snapshot.rst
deleted file mode 100644
index fc516067..00000000
--- a/doc/source/cli/command-objects/snapshot.rst
+++ /dev/null
@@ -1,176 +0,0 @@
-========
-snapshot
-========
-
-Block Storage v1, v2
-
-snapshot create
----------------
-
-Create new snapshot
-(Deprecated, please use ``volume snapshot create`` instead)
-
-.. program:: snapshot create
-.. code:: bash
-
- openstack snapshot create
- [--name <name>]
- [--description <description>]
- [--force]
- [--property <key=value> [...] ]
- <volume>
-
-.. option:: --name <name>
-
- Name of the snapshot
-
-.. option:: --description <description>
-
- Description of the snapshot
-
-.. option:: --force
-
- Create a snapshot attached to an instance. Default is False
-
-.. option:: --property <key=value>
-
- Set a property to this snapshot (repeat option to set multiple properties)
-
- *Volume version 2 only*
-
-.. _snapshot_create-snapshot:
-.. describe:: <volume>
-
- Volume to snapshot (name or ID)
-
-snapshot delete
----------------
-
-Delete snapshot(s)
-(Deprecated, please use ``volume snapshot delete`` instead)
-
-.. program:: snapshot delete
-.. code:: bash
-
- openstack snapshot delete
- <snapshot> [<snapshot> ...]
-
-.. _snapshot_delete-snapshot:
-.. describe:: <snapshot>
-
- Snapshot(s) to delete (name or ID)
-
-snapshot list
--------------
-
-List snapshots
-(Deprecated, please use ``volume snapshot list`` instead)
-
-.. program:: snapshot list
-.. code:: bash
-
- openstack snapshot list
- [--all-projects]
- [--long]
- [--limit <num-snapshots>]
- [--marker <snapshot>]
-
-.. option:: --all-projects
-
- Include all projects (admin only)
-
-.. option:: --long
-
- List additional fields in output
-
-.. option:: --limit <num-snapshots>
-
- Maximum number of snapshots to display
-
- *Volume version 2 only*
-
-.. option:: --marker <snapshot>
-
- The last snapshot ID of the previous page
-
- *Volume version 2 only*
-
-snapshot set
-------------
-
-Set snapshot properties
-(Deprecated, please use ``volume snapshot set`` instead)
-
-.. program:: snapshot set
-.. code:: bash
-
- openstack snapshot set
- [--name <name>]
- [--description <description>]
- [--property <key=value> [...] ]
- [--state <state>]
- <snapshot>
-
-.. _snapshot_restore-snapshot:
-.. option:: --name <name>
-
- New snapshot name
-
-.. option:: --description <description>
-
- New snapshot description
-
-.. option:: --property <key=value>
-
- Property to add or modify for this snapshot (repeat option to set multiple properties)
-
-.. option:: --state <state>
-
- New snapshot state.
- ("available", "error", "creating", "deleting", or "error_deleting") (admin only)
- (This option simply changes the state of the snapshot in the database with
- no regard to actual status, exercise caution when using)
-
- *Volume version 2 only*
-
-.. describe:: <snapshot>
-
- Snapshot to modify (name or ID)
-
-snapshot show
--------------
-
-Display snapshot details
-(Deprecated, please use ``volume snapshot show`` instead)
-
-.. program:: snapshot show
-.. code:: bash
-
- openstack snapshot show
- <snapshot>
-
-.. _snapshot_show-snapshot:
-.. describe:: <snapshot>
-
- Snapshot to display (name or ID)
-
-snapshot unset
---------------
-
-Unset snapshot properties
-(Deprecated, please use ``volume snapshot unset`` instead)
-
-.. program:: snapshot unset
-.. code:: bash
-
- openstack snapshot unset
- [--property <key>]
- <snapshot>
-
-.. option:: --property <key>
-
- Property to remove from snapshot (repeat option to remove multiple properties)
-
-.. describe:: <snapshot>
-
- Snapshot to modify (name or ID)