summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/container.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/cli/command-objects/container.rst')
-rw-r--r--doc/source/cli/command-objects/container.rst154
1 files changed, 15 insertions, 139 deletions
diff --git a/doc/source/cli/command-objects/container.rst b/doc/source/cli/command-objects/container.rst
index e68955ad..83deeb81 100644
--- a/doc/source/cli/command-objects/container.rst
+++ b/doc/source/cli/command-objects/container.rst
@@ -2,149 +2,25 @@
container
=========
-Object Storage v1
+A **container** defines a namespace for **objects**. Applies to Object Storage v1
-container create
-----------------
+.. autoprogram-cliff:: openstack.object_store.v1
+ :command: container create
-Create new container
+.. autoprogram-cliff:: openstack.object_store.v1
+ :command: container delete
-.. program:: container create
-.. code:: bash
+.. autoprogram-cliff:: openstack.object_store.v1
+ :command: container list
- openstack container create
- <container-name> [<container-name> ...]
+.. autoprogram-cliff:: openstack.object_store.v1
+ :command: container save
-.. describe:: <container-name>
+.. autoprogram-cliff:: openstack.object_store.v1
+ :command: container set
- New container name(s)
+.. autoprogram-cliff:: openstack.object_store.v1
+ :command: container show
-container delete
-----------------
-
-Delete container
-
-.. program:: container delete
-.. code:: bash
-
- openstack container delete
- [-r] | [--recursive]
- <container> [<container> ...]
-
-.. option:: --recursive, -r
-
- Recursively delete objects in container before container delete
-
-.. describe:: <container>
-
- Container(s) to delete
-
-container list
---------------
-
-List containers
-
-.. program:: container list
-.. code:: bash
-
- openstack container list
- [--prefix <prefix>]
- [--marker <marker>]
- [--end-marker <end-marker>]
- [--limit <num-containers>]
- [--long]
- [--all]
-
-.. option:: --prefix <prefix>
-
- Filter list using <prefix>
-
-.. option:: --marker <marker>
-
- Anchor for paging
-
-.. option:: --end-marker <end-marker>
-
- End anchor for paging
-
-.. option:: --limit <num-containers>
-
- Limit the number of containers returned
-
-.. option:: --long
-
- List additional fields in output
-
-.. option:: --all
-
- List all containers (default is 10000)
-
-container save
---------------
-
-Save container contents locally
-
-.. program:: container save
-.. code:: bash
-
- openstack container save
- <container>
-
-.. describe:: <container>
-
- Container to save
-
-container set
--------------
-
-Set container properties
-
-.. program:: container set
-.. code:: bash
-
- openstack container set
- [--property <key=value> [...] ]
- <container>
-
-.. option:: --property <key=value>
-
- Set a property on this container (repeat option to set multiple properties)
-
-.. describe:: <container>
-
- Container to modify
-
-container show
---------------
-
-Display container details
-
-.. program:: container show
-.. code:: bash
-
- openstack container show
- <container>
-
-.. describe:: <container>
-
- Container to display
-
-container unset
----------------
-
-Unset container properties
-
-.. program:: container unset
-.. code:: bash
-
- openstack container unset
- [--property <key>]
- <container>
-
-.. option:: --property <key>
-
- Property to remove from container (repeat option to remove multiple properties)
-
-.. describe:: <container>
-
- Container to modify
+.. autoprogram-cliff:: openstack.object_store.v1
+ :command: container unset