summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/object.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/cli/command-objects/object.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-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/object.rst')
-rw-r--r--doc/source/cli/command-objects/object.rst195
1 files changed, 195 insertions, 0 deletions
diff --git a/doc/source/cli/command-objects/object.rst b/doc/source/cli/command-objects/object.rst
new file mode 100644
index 00000000..6323c4ed
--- /dev/null
+++ b/doc/source/cli/command-objects/object.rst
@@ -0,0 +1,195 @@
+======
+object
+======
+
+Object Storage v1
+
+object create
+-------------
+
+Upload object to container
+
+.. program:: object create
+.. code:: bash
+
+ openstack object create
+ [--name <name>]
+ <container>
+ <filename> [<filename> ...]
+
+.. option:: --name <name>
+
+ Upload a file and rename it. Can only be used when uploading a single object
+
+.. describe:: <container>
+
+ Container for new object
+
+.. describe:: <filename>
+
+ Local filename(s) to upload
+
+object delete
+-------------
+
+Delete object from container
+
+.. program:: object delete
+.. code:: bash
+
+ openstack object delete
+ <container>
+ <object> [<object> ...]
+
+.. describe:: <container>
+
+ Delete object(s) from <container>
+
+.. describe:: <object>
+
+ Object(s) to delete
+
+object list
+-----------
+
+List objects
+
+.. program object list
+.. code:: bash
+
+ openstack object list
+ [--prefix <prefix>]
+ [--delimiter <delimiter>]
+ [--marker <marker>]
+ [--end-marker <end-marker>]
+ [--limit <num-objects>]
+ [--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 <num-objects>
+
+ Limit number of objects returned
+
+.. option:: --long
+
+ List additional fields in output
+
+.. option:: --all
+
+ List all objects in <container> (default is 10000)
+
+.. describe:: <container>
+
+ Container to list
+
+object save
+-----------
+
+Save object locally
+
+.. program:: object save
+.. code:: bash
+
+ openstack object save
+ [--file <filename>]
+ <container>
+ <object>
+
+.. option:: --file <filename>
+
+ Destination filename (defaults to object name)
+
+.. describe:: <container>
+
+ Download <object> from <container>
+
+.. describe:: <object>
+
+ Object to save
+
+object set
+----------
+
+Set object properties
+
+.. program:: object set
+.. code:: bash
+
+ openstack object set
+ [--property <key=value> [...] ]
+ <container>
+ <object>
+
+.. option:: --property <key=value>
+
+ Set a property on this object (repeat option to set multiple properties)
+
+.. describe:: <container>
+
+ Modify <object> from <container>
+
+.. describe:: <object>
+
+ Object to modify
+
+object show
+-----------
+
+Display object details
+
+.. program:: object show
+.. code:: bash
+
+ openstack object show
+ <container>
+ <object>
+
+.. describe:: <container>
+
+ Display <object> from <container>
+
+.. describe:: <object>
+
+ Object to display
+
+object unset
+------------
+
+Unset object properties
+
+.. program:: object unset
+.. code:: bash
+
+ openstack object unset
+ [--property <key>]
+ <container>
+ <object>
+
+.. option:: --property <key>
+
+ Property to remove from object (repeat option to remove multiple properties)
+
+.. describe:: <container>
+
+ Modify <object> from <container>
+
+.. describe:: <object>
+
+ Object to modify