openstack/python-openstackclient
Code Issues Proposed changes
Files
6425fc305911c307e73cacb3066f15a186e61db9
python-openstackclient/doc/source/command-objects/object.rst
Dean Troyer 1686dc54f0 Help/docs cleanups: marker, limit, ip-address metavars 
Cleanup help strings and docs for clarity and to keep things consistent:
* --limit metavar should be <num-resource> to indicate what is being counted
* --marker metavar should be <resource> or <resource-id> to indicate the
  type of value being specified
* <*-ip-address> metavars should be just <ip-address> as there is no difference
  in format between fixed and floating IPs
* Move all occurances of '(name or ID)' to end of help text

Change-Id: I2c31746ed6ded3845244e03e57d809f8bc0e6b9d
2017-04-04 03:56:19 +00:00

3.0 KiB
Raw Blame History

object

Object Storage v1

object create

Upload object to container

object create

openstack object create
    [--name <name>]
    <container>
    <filename> [<filename> ...]

--name <name>

Upload a file and rename it. Can only be used when uploading a single object

<container>

Container for new object

<filename>

Local filename(s) to upload

object delete

Delete object from container

object delete

openstack object delete
    <container>
    <object> [<object> ...]

<container>

Delete object(s) from <container>

<object>

Object(s) to delete

object list

List objects

openstack object list
    [--prefix <prefix>]
    [--delimiter <delimiter>]
    [--marker <marker>]
    [--end-marker <end-marker>]
    [--limit <num-objects>]
    [--long]
    [--all]
    <container>

--prefix <prefix>

Filter list using <prefix>

--delimiter <delimiter>

Roll up items with <delimiter>

--marker <marker>

Anchor for paging

--end-marker <end-marker>

End anchor for paging

--limit <num-objects>

Limit number of objects returned

--long

List additional fields in output

--all

List all objects in <container> (default is 10000)

<container>

Container to list

object save

Save object locally

object save

openstack object save
    [--file <filename>]
    <container>
    <object>

--file <filename>

Destination filename (defaults to object name)

<container>

Download <object> from <container>

<object>

Object to save

object set

Set object properties

object set

openstack object set
    [--property <key=value> [...] ]
    <container>
    <object>

--property <key=value>

Set a property on this object (repeat option to set multiple properties)

<container>

Modify <object> from <container>

<object>

Object to modify

object show

Display object details

object show

openstack object show
    <container>
    <object>

<container>

Display <object> from <container>

<object>

Object to display

object unset

Unset object properties

object unset

openstack object unset
    [--property <key>]
    <container>
    <object>

--property <key>

Property to remove from object (repeat option to remove multiple properties)

<container>

Modify <object> from <container>

<object>

Object to modify