`orca share`¶

Manila shared file systems (shares, snapshots, access rules).

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

Manage Manila shared file systems (shares, access rules, snapshots).

Manila is a multi-tenant NFS/CIFS/CephFS-as-a-service. Use orca share create to allocate a share, orca share access allow to expose it to a client IP, then mount the export location.

Usage:

orca share [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

access: Manage share access rules (NFS IP allow, CIFS user, CephFS x509).
create: Create a share.
delete: Delete a share.
extend: Extend a share (grow only).
list: List shares.
set: Update a share's name / description / visibility.
show: Show share details + export locations.
shrink: Shrink a share (only allowed if the backend supports it).
snapshot: Manage share snapshots.
type: Inspect share types (admin defines, users select).

Manage share access rules (NFS IP allow, CIFS user, CephFS x509).

Usage:

orca share access [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

allow: Grant access to a share.
deny: Revoke an access rule from a share.
list: List access rules attached to a share.

Grant access to a share.

Examples: orca share access allow --access-type ip --access-to 10.0.0.0/24 orca share access allow --access-type ip --access-to 1.2.3.4 --access-level ro orca share access allow --access-type cephx --access-to client.foo

Usage:

orca share access allow [OPTIONS] SHARE_ID

Options:

Name	Type	Description	Default
`--access-type`	choice (`ip` \| `user` \| `cert` \| `cephx`)	ip (NFS)	user (CIFS)
`--access-to`	text	The principal: IP/CIDR for ip, username for user, CN for cert, client name for cephx.	`Sentinel.UNSET`
`--access-level`	choice (`rw` \| `ro`)	N/A	`rw`
`--help`	boolean	Show this message and exit.	`False`

Revoke an access rule from a share.

Usage:

orca share access deny [OPTIONS] SHARE_ID ACCESS_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

List access rules attached to a share.

Usage:

orca share access list [OPTIONS] SHARE_ID

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`

Create a share.

Examples: orca share create my-nfs --size 50 orca share create scratch --size 100 --protocol CEPHFS --availability-zone az1 orca share create from-snap --size 10 --snapshot-id

Usage:

orca share create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--size`	integer	Share size in GB.	`Sentinel.UNSET`
`--protocol`	choice (`NFS` \| `CIFS` \| `GLUSTERFS` \| `HDFS` \| `CEPHFS` \| `MAPRFS`)	Share protocol.	`NFS`
`--description`	text	Free-text description.	None
`--share-type`	text	Share type name or ID (omit for the operator default).	None
`--share-network`	text	Share network ID for multi-tenant deployments.	None
`--snapshot-id`	text	Create from an existing snapshot.	None
`--availability-zone`	text	Target AZ.	None
`--public` / `--private`	boolean	Share visibility (default: private).	`False`
`--help`	boolean	Show this message and exit.	`False`

Delete a share.

Usage:

orca share delete [OPTIONS] SHARE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

Extend a share (grow only).

Usage:

orca share extend [OPTIONS] SHARE_ID

Options:

Name	Type	Description	Default
`--size`	integer	New total size in GB.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

List shares.

Usage:

orca share 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`

Update a share's name / description / visibility.

Usage:

orca share set [OPTIONS] SHARE_ID

Options:

Name	Type	Description	Default
`--name`	text	New display name.	None
`--description`	text	New description.	None
`--public` / `--private`	boolean	Switch visibility.	None
`--help`	boolean	Show this message and exit.	`False`

Show share details + export locations.

Usage:

orca share show [OPTIONS] SHARE_ID

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`

Shrink a share (only allowed if the backend supports it).

Usage:

orca share shrink [OPTIONS] SHARE_ID

Options:

Name	Type	Description	Default
`--size`	integer	New total size in GB.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

Manage share snapshots.

Usage:

orca share snapshot [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

create: Snapshot a share.
delete: Delete a snapshot.
list: List share snapshots.
show: Show snapshot details.

Snapshot a share.

Usage:

orca share snapshot create [OPTIONS] SHARE_ID

Options:

Name	Type	Description	Default
`--name`	text	Snapshot name.	None
`--description`	text	Snapshot description.	None
`--help`	boolean	Show this message and exit.	`False`

Delete a snapshot.

Usage:

orca share snapshot delete [OPTIONS] SNAPSHOT_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

List share snapshots.

Usage:

orca share snapshot 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`

Show snapshot details.

Usage:

orca share snapshot show [OPTIONS] SNAPSHOT_ID

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`

Inspect share types (admin defines, users select).

Usage:

orca share type [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

list: List share types defined by the operator.
show: Show a share type.

List share types defined by the operator.

Usage:

orca share type 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`

Show a share type.

Usage:

orca share type show [OPTIONS] TYPE_ID

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 share¶

orca share¶

orca share access¶

orca share access allow¶

orca share access deny¶

orca share access list¶

orca share create¶

orca share delete¶

orca share extend¶

orca share list¶

orca share set¶

orca share show¶

orca share shrink¶

orca share snapshot¶

orca share snapshot create¶

orca share snapshot delete¶

orca share snapshot list¶

orca share snapshot show¶

orca share type¶

orca share type list¶

orca share type show¶

`orca share`¶