Chapter 53. object
This chapter describes the commands under the object
command.
53.1. object create
Upload object to container
Usage:
openstack object create [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--name <name>] <container> <filename> [<filename> ...]
Value | Summary |
---|---|
<container> | Container for new object |
<filename> | Local filename(s) to upload |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--name <name> | Upload a file and rename it. can only be used when uploading a single object |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
53.2. object delete
Delete object from container
Usage:
openstack object delete [-h] <container> <object> [<object> ...]
Value | Summary |
---|---|
<container> | Delete object(s) from <container> |
<object> | Object(s) to delete |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
53.3. object list
List objects
Usage:
openstack object list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--prefix <prefix>] [--delimiter <delimiter>] [--marker <marker>] [--end-marker <end-marker>] [--limit <num-objects>] [--long] [--all] <container>
Value | Summary |
---|---|
<container> | Container to list |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--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 the number of objects returned |
--long | List additional fields in output |
--all | List all objects in container (default is 10000) |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
53.4. object save
Save object locally
Usage:
openstack object save [-h] [--file <filename>] <container> <object>
Value | Summary |
---|---|
<container> | Download <object> from <container> |
<object> | Object to save |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--file <filename> | Destination filename (defaults to object name); using - as the filename will print the file to stdout |
53.5. object set
Set object properties
Usage:
openstack object set [-h] --property <key=value> <container> <object>
Value | Summary |
---|---|
<container> | Modify <object> from <container> |
<object> | Object to modify |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--property <key=value> | Set a property on this object (repeat option to set multiple properties) |
53.6. object show
Display object details
Usage:
openstack object show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <container> <object>
Value | Summary |
---|---|
<container> | Display <object> from <container> |
<object> | Object to display |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
53.7. object store account set
Set account properties
Usage:
openstack object store account set [-h] --property <key=value>
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--property <key=value> | Set a property on this account (repeat option to set multiple properties) |
53.8. object store account show
Display account details
Usage:
openstack object store account show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty]
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
53.9. object store account unset
Unset account properties
Usage:
openstack object store account unset [-h] --property <key>
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--property <key> | Property to remove from account (repeat option to remove multiple properties) |
53.10. object unset
Unset object properties
Usage:
openstack object unset [-h] --property <key> <container> <object>
Value | Summary |
---|---|
<container> | Modify <object> from <container> |
<object> | Object to modify |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--property <key> | Property to remove from object (repeat option to remove multiple properties) |