diff options
Diffstat (limited to 'doc/source/command-objects/container.rst')
| -rw-r--r-- | doc/source/command-objects/container.rst | 105 |
1 files changed, 105 insertions, 0 deletions
diff --git a/doc/source/command-objects/container.rst b/doc/source/command-objects/container.rst new file mode 100644 index 00000000..3afaeb92 --- /dev/null +++ b/doc/source/command-objects/container.rst @@ -0,0 +1,105 @@ +========= +container +========= + +Object Store v1 + +container create +---------------- + +Create new container + +.. program:: container create +.. code:: bash + + os container create + <container-name> [<container-name> ...] + +.. option:: <container-name> + + New container name(s) + +container delete +---------------- + +Delete container + +.. program:: container delete +.. code:: bash + + os container delete + <container> [<container> ...] + +.. option:: <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 + +.. options:: --all + + List all containers (default is 10000) + +container save +-------------- + +Save container contents locally + +.. program:: container save +.. code:: bash + + os container save + <container> + +.. option:: <container> + + Container to save + +container show +-------------- + +Show container details + +.. program:: container show +.. code:: bash + + os container show + [<container>] + +.. option:: <container> + + Container to display |
