diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2017-06-13 15:55:33 -0400 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2017-06-23 11:54:32 +0200 |
| commit | 9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch) | |
| tree | 9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/container.rst | |
| parent | 19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff) | |
| download | python-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz | |
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification.
Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.
Add a few toctrees and index pages for the new directories.
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/cli/command-objects/container.rst')
| -rw-r--r-- | doc/source/cli/command-objects/container.rst | 150 |
1 files changed, 150 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/container.rst b/doc/source/cli/command-objects/container.rst new file mode 100644 index 00000000..e68955ad --- /dev/null +++ b/doc/source/cli/command-objects/container.rst @@ -0,0 +1,150 @@ +========= +container +========= + +Object Storage v1 + +container create +---------------- + +Create new container + +.. program:: container create +.. code:: bash + + openstack container create + <container-name> [<container-name> ...] + +.. describe:: <container-name> + + New container name(s) + +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 |
