diff options
| author | Dean Troyer <dtroyer@gmail.com> | 2014-12-23 17:04:12 -0600 |
|---|---|---|
| committer | Steve Martinelli <stevemar@ca.ibm.com> | 2014-12-30 16:09:54 -0500 |
| commit | d5caa6a26baf2fccbf276080fef60c81ed4beae3 (patch) | |
| tree | 560db9a9909a6767b61a53d9b9cba3ab0170b425 /doc | |
| parent | a24d6e7c6f06ccaecefa0a2c6cd2c105f3cd8be5 (diff) | |
| download | python-openstackclient-d5caa6a26baf2fccbf276080fef60c81ed4beae3.tar.gz | |
Command object docs: container, object
Change-Id: Ie3df543a28cbee0cc809310a05f431c97b2c7e70
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/source/command-objects/container.rst | 105 | ||||
| -rw-r--r-- | doc/source/command-objects/object.rst | 140 |
2 files changed, 245 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 diff --git a/doc/source/command-objects/object.rst b/doc/source/command-objects/object.rst new file mode 100644 index 00000000..5cbc95d7 --- /dev/null +++ b/doc/source/command-objects/object.rst @@ -0,0 +1,140 @@ +====== +object +====== + +Object Store v1 + +object create +------------- + +Upload object to container + +.. program:: object create +.. code:: bash + + os object create + <container> + <filename> [<filename> ...] + +.. option:: <container> + + Container for new object + +.. option:: <filename> + + Local filename(s) to upload + +object delete +------------- + +Delete object from container + +.. program:: object delete +.. code:: bash + + os object delete + <container> + <object> [<object> ...] + +.. option:: <container> + + Delete object(s) from <container> + +.. option:: <object> + + Object(s) to delete + +list object +----------- + +List objects + +.. program object list +.. code:: bash + + os object list + [--prefix <prefix>] + [--delimiter <delimiter>] + [--marker <marker>] + [--end-marker <end-marker>] + [--limit <limit>] + [--long] + [--all] + <container>] + +.. option:: --prefix <prefix> + + Filter list using <prefix> + +.. option:: --delimiter <delimiter> + + Roll up items with <delimiter> + +.. option:: --marker <marker> + + Anchor for paging + +.. option:: --end-marker <end-marker> + + End anchor for paging + +.. option:: --limit <limit> + + Limit number of objects returned + +.. option:: --long + + List additional fields in output + +.. options:: --all + + List all objects in <container> (default is 10000) + +.. option:: <container> + + Container to list + +object save +----------- + +Save object locally + +.. program:: object save +.. code:: bash + + os object save + [--file <filename>] + [<container>] + [<object>] + +.. option:: --file <filename> + + Destination filename (defaults to object name) + +.. option:: <container> + + Download <object> from <container> + +.. option:: <object> + + Object to save + +object show +----------- + +Show object details + +.. program:: object show +.. code:: bash + + os object show + <container> + <object> + +.. option:: <container> + + Display <object> from <container> + +.. option:: <object> + + Object to display |
