python-openstackclient/doc/source/command-objects/container.rst
Steve Martinelli 27b73ac55d Fix doc building errors
Addresses some of the issues that appeared when running tox -edocs

Change-Id: I31133744ee0ddefa72c6590cb381de317e65633e
2015-01-19 13:12:18 -05:00

106 lines
1.5 KiB
ReStructuredText

=========
container
=========
Object Store v1
container create
----------------
Create new container
.. program:: container create
.. code:: bash
os container create
<container-name> [<container-name> ...]
.. describe:: <container-name>
New container name(s)
container delete
----------------
Delete container
.. program:: container delete
.. code:: bash
os container delete
<container> [<container> ...]
.. describe:: <container>
Container(s) to delete
container list
--------------
List containers
.. program:: container list
.. code::bash
os container list
[--prefix <prefix>]
[--marker <marker>]
[--end-marker <end-marker>]
[--limit <limit>]
[--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 <limit>
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
os container save
<container>
.. describe:: <container>
Container to save
container show
--------------
Display container details
.. program:: container show
.. code:: bash
os container show
[<container>]
.. describe:: <container>
Container to display