`orca object`¶

Manage Swift objects.

The reference below is generated from the live CLI by mkdocs-click. It always reflects the version installed.

orca object¶

Manage object storage containers & objects (Swift).

Usage:

orca object [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

account: Manage Swift account-level metadata.
account-set: [deprecated, use 'object account set' instead]
account-unset: [deprecated, use 'object account unset' instead]
container: Manage Swift containers.
container-create: [deprecated, use 'object container create' instead]
container-delete: [deprecated, use 'object container delete' instead]
container-list: [deprecated, use 'object container list' instead]
container-save: [deprecated, use 'object container save' instead]
container-set: [deprecated, use 'object container set' instead]
container-show: [deprecated, use 'object container show' instead]
delete: Delete one or more objects from a container.
download: Download an object from a container.
download: Download an object from a container.
list: List objects in a container.
set: Set metadata on an object.
show: Show object metadata.
stats: Show account-level storage statistics.
tree: Show containers and objects as a tree.
unset: Remove metadata from an object.
upload: Upload file(s) to a container.
upload: Upload file(s) to a container.

orca object account¶

Manage Swift account-level metadata.

Usage:

orca object account [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

set: Set account-level metadata.
show: Show Swift account-level metadata and counters.
unset: Remove account-level metadata.

orca object account set¶

Set account-level metadata.

Usage:

orca object account set [OPTIONS]

Options:

Name	Type	Description	Default
`--property`	text	Metadata key=value pair (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca object account show¶

Show Swift account-level metadata and counters.

Equivalent to openstack object store account show.

Usage:

orca object account show [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca object account unset¶

Remove account-level metadata.

Usage:

orca object account unset [OPTIONS]

Options:

Name	Type	Description	Default
`--property`	text	Metadata key to remove (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca object account-set¶

Set account-level metadata.

Usage:

orca object account-set [OPTIONS]

Options:

Name	Type	Description	Default
`--property`	text	Metadata key=value pair (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca object account-unset¶

Remove account-level metadata.

Usage:

orca object account-unset [OPTIONS]

Options:

Name	Type	Description	Default
`--property`	text	Metadata key to remove (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca object container¶

Manage Swift containers.

Usage:

orca object container [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a container.
delete: Delete a container.
list: List containers.
save: Download all objects in a container to a local directory.
set: Set metadata on a container.
show: Show container metadata.

orca object container create¶

Create a container.

Usage:

orca object container create [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca object container delete¶

Delete a container.

Use --recursive to delete all objects in the container first.

Usage:

orca object container delete [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--recursive`	boolean	Delete all objects before deleting the container.	`False`
`--yes`, `-y`	boolean	Skip confirmation prompt.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca object container list¶

List containers.

Usage:

orca object container list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca object container save¶

Download all objects in a container to a local directory.

Usage:

orca object container save [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--output-dir`	text	Local directory to save objects into.	`.`
`--help`	boolean	Show this message and exit.	`False`

orca object container set¶

Set metadata on a container.

Usage:

orca object container set [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--property`	text	Metadata key=value pair (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca object container show¶

Show container metadata.

Usage:

orca object container show [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca object container-create¶

Create a container.

Usage:

orca object container-create [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca object container-delete¶

Delete a container.

Use --recursive to delete all objects in the container first.

Usage:

orca object container-delete [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--recursive`	boolean	Delete all objects before deleting the container.	`False`
`--yes`, `-y`	boolean	Skip confirmation prompt.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca object container-list¶

List containers.

Usage:

orca object container-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca object container-save¶

Download all objects in a container to a local directory.

Usage:

orca object container-save [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--output-dir`	text	Local directory to save objects into.	`.`
`--help`	boolean	Show this message and exit.	`False`

orca object container-set¶

Set metadata on a container.

Usage:

orca object container-set [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--property`	text	Metadata key=value pair (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca object container-show¶

Show container metadata.

Usage:

orca object container-show [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca object delete¶

Delete one or more objects from a container.

Usage:

orca object delete [OPTIONS] CONTAINER OBJECT...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca object download¶

Download an object from a container.

Usage:

orca object download [OPTIONS] CONTAINER OBJECT

Options:

Name	Type	Description	Default
`--file`	text	Local filename to save to (defaults to object name).	None
`--help`	boolean	Show this message and exit.	`False`

orca object download¶

Download an object from a container.

Usage:

orca object download [OPTIONS] CONTAINER OBJECT

Options:

Name	Type	Description	Default
`--file`	text	Local filename to save to (defaults to object name).	None
`--help`	boolean	Show this message and exit.	`False`

orca object list¶

List objects in a container.

Usage:

orca object list [OPTIONS] CONTAINER

Options:

Name	Type	Description	Default
`--prefix`	text	Only list objects with this prefix.	None
`--delimiter`	text	Delimiter for pseudo-folder grouping.	None
`--long`	boolean	Show hash and content type.	`False`
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca object set¶

Set metadata on an object.

Usage:

orca object set [OPTIONS] CONTAINER OBJECT

Options:

Name	Type	Description	Default
`--property`	text	Metadata key=value pair (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca object show¶

Show object metadata.

Usage:

orca object show [OPTIONS] CONTAINER OBJECT

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca object stats¶

Show account-level storage statistics.

Usage:

orca object stats [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca object tree¶

Show containers and objects as a tree.

Without a container argument, shows all containers. With a container, shows the pseudo-folder structure of objects within it.

Usage:

orca object tree [OPTIONS] [CONTAINER]

Options:

Name	Type	Description	Default
`--delimiter`	text	Delimiter for pseudo-folder hierarchy.	`/`
`--help`	boolean	Show this message and exit.	`False`

orca object unset¶

Remove metadata from an object.

Usage:

orca object unset [OPTIONS] CONTAINER OBJECT

Options:

Name	Type	Description	Default
`--property`	text	Metadata key to remove (repeatable).	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca object upload¶

Upload file(s) to a container.

Files larger than 5 GB are automatically split into segments using Swift SLO (Static Large Object).

Usage:

orca object upload [OPTIONS] CONTAINER FILES...

Options:

Name	Type	Description	Default
`--name`	text	Override the object name (only valid for single file upload).	None
`--segment-size`	integer	Segment size in MB for large files (default: 4096 MB).	None
`--help`	boolean	Show this message and exit.	`False`

orca object upload¶

Upload file(s) to a container.

Files larger than 5 GB are automatically split into segments using Swift SLO (Static Large Object).

Usage:

orca object upload [OPTIONS] CONTAINER FILES...

Options:

Name	Type	Description	Default
`--name`	text	Override the object name (only valid for single file upload).	None
`--segment-size`	integer	Segment size in MB for large files (default: 4096 MB).	None
`--help`	boolean	Show this message and exit.	`False`