`orca backup`¶

Trilio Freezer backup management.

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

orca backup¶

Manage Freezer backups, jobs, sessions & clients.

For Cinder volume backups see orca volume backup-list etc.

Usage:

orca backup [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

action: Manage backup actions.
action-create: [deprecated, use 'backup action create' instead]
action-delete: [deprecated, use 'backup action delete' instead]
action-list: [deprecated, use 'backup action list' instead]
action-show: [deprecated, use 'backup action show' instead]
client: Manage backup clients (agents).
client-delete: [deprecated, use 'backup client delete' instead]
client-list: [deprecated, use 'backup client list' instead]
client-register: [deprecated, use 'backup client register' instead]
client-show: [deprecated, use 'backup client show' instead]
delete: Delete a backup.
job: Manage backup jobs.
job-create: [deprecated, use 'backup job create' instead]
job-delete: [deprecated, use 'backup job delete' instead]
job-list: [deprecated, use 'backup job list' instead]
job-show: [deprecated, use 'backup job show' instead]
job-start: [deprecated, use 'backup job start' instead]
job-stop: [deprecated, use 'backup job stop' instead]
list: List backups.
session: Manage backup sessions.
session-add-job: [deprecated, use 'backup session add-job' instead]
session-create: [deprecated, use 'backup session create' instead]
session-delete: [deprecated, use 'backup session delete' instead]
session-list: [deprecated, use 'backup session list' instead]
session-remove-job: [deprecated, use 'backup session remove-job' instead]
session-show: [deprecated, use 'backup session show' instead]
session-start: [deprecated, use 'backup session start' instead]
show: Show backup details.

orca backup action¶

Manage backup actions.

Usage:

orca backup action [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

create: Create a standalone backup action.
delete: Delete a backup action.
list: List backup actions.
show: Show backup action details.

orca backup action create¶

Create a standalone backup action.

Examples: orca backup action create --path /var/data --container my-backups orca backup action create --action restore --path /var/data --container my-backups orca backup action create --path /var/lib/mysql --mode mysql --backup-name daily-mysql

Usage:

orca backup action create [OPTIONS]

Options:

Name	Type	Description	Default
`--action`	choice (`backup` \| `restore` \| `admin`)	N/A	`backup`
`--path`	text	Path to back up or restore.	`Sentinel.UNSET`
`--container`	text	Swift container name.	None
`--storage`	choice (`swift` \| `local` \| `ssh` \| `s3`)	N/A	`swift`
`--mode`	choice (`fs` \| `mysql` \| `mongo` \| `mssql` \| `cinder` \| `nova`)	N/A	`fs`
`--backup-name`	text	Name for the backup.	None
`--max-level`	integer	Max incremental backup level.	None
`--help`	boolean	Show this message and exit.	`False`

orca backup action delete¶

Delete a backup action.

Usage:

orca backup action delete [OPTIONS] ACTION_ID

Options:

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

orca backup action list¶

List backup actions.

Usage:

orca backup action list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	None
`--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 backup action show¶

Show backup action details.

Usage:

orca backup action show [OPTIONS] ACTION_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 backup action-create¶

Create a standalone backup action.

Examples: orca backup action create --path /var/data --container my-backups orca backup action create --action restore --path /var/data --container my-backups orca backup action create --path /var/lib/mysql --mode mysql --backup-name daily-mysql

Usage:

orca backup action-create [OPTIONS]

Options:

Name	Type	Description	Default
`--action`	choice (`backup` \| `restore` \| `admin`)	N/A	`backup`
`--path`	text	Path to back up or restore.	`Sentinel.UNSET`
`--container`	text	Swift container name.	None
`--storage`	choice (`swift` \| `local` \| `ssh` \| `s3`)	N/A	`swift`
`--mode`	choice (`fs` \| `mysql` \| `mongo` \| `mssql` \| `cinder` \| `nova`)	N/A	`fs`
`--backup-name`	text	Name for the backup.	None
`--max-level`	integer	Max incremental backup level.	None
`--help`	boolean	Show this message and exit.	`False`

orca backup action-delete¶

Delete a backup action.

Usage:

orca backup action-delete [OPTIONS] ACTION_ID

Options:

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

orca backup action-list¶

List backup actions.

Usage:

orca backup action-list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	None
`--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 backup action-show¶

Show backup action details.

Usage:

orca backup action-show [OPTIONS] ACTION_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 backup client¶

Manage backup clients (agents).

Usage:

orca backup client [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

delete: Unregister a backup client.
list: List registered backup clients (agents).
register: Register a new backup client.
show: Show backup client details.

orca backup client delete¶

Unregister a backup client.

Usage:

orca backup client delete [OPTIONS] CLIENT_ID

Options:

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

orca backup client list¶

List registered backup clients (agents).

Usage:

orca backup client list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	None
`--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 backup client register¶

Register a new backup client.

Usage:

orca backup client register [OPTIONS] HOSTNAME

Options:

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

orca backup client show¶

Show backup client details.

Usage:

orca backup client show [OPTIONS] CLIENT_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 backup client-delete¶

Unregister a backup client.

Usage:

orca backup client-delete [OPTIONS] CLIENT_ID

Options:

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

orca backup client-list¶

List registered backup clients (agents).

Usage:

orca backup client-list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	None
`--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 backup client-register¶

Register a new backup client.

Usage:

orca backup client-register [OPTIONS] HOSTNAME

Options:

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

orca backup client-show¶

Show backup client details.

Usage:

orca backup client-show [OPTIONS] CLIENT_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 backup delete¶

Delete a backup.

Usage:

orca backup delete [OPTIONS] BACKUP_ID

Options:

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

orca backup job¶

Manage backup jobs.

Usage:

orca backup job [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

create: Create a backup job.
delete: Delete a backup job.
list: List backup jobs.
show: Show backup job details.
start: Start (trigger) a backup job.
stop: Stop a running backup job.

orca backup job create¶

Create a backup job.

Examples: orca backup job create --client-id --path /var/data --container my-backups orca backup job create --client-id --path /var/lib/mysql --mode mysql --storage swift orca backup job create --client-id --action restore --path /var/data --container my-backups

Usage:

orca backup job create [OPTIONS]

Options:

Name	Type	Description	Default
`--description`	text	Job description.	``
`--client-id`	text	Freezer client ID.	`Sentinel.UNSET`
`--action`	choice (`backup` \| `restore` \| `admin`)	Action type.	`backup`
`--path`	text	Path to back up or restore.	`Sentinel.UNSET`
`--container`	text	Swift container name for storage.	None
`--storage`	choice (`swift` \| `local` \| `ssh` \| `s3`)	Storage backend.	`swift`
`--mode`	choice (`fs` \| `mysql` \| `mongo` \| `mssql` \| `cinder` \| `nova`)	Backup mode.	`fs`
`--schedule-interval`	text	Schedule interval (e.g. '24 hours', '7 days').	None
`--help`	boolean	Show this message and exit.	`False`

orca backup job delete¶

Delete a backup job.

Usage:

orca backup job delete [OPTIONS] JOB_ID

Options:

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

orca backup job list¶

List backup jobs.

Usage:

orca backup job list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	None
`--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 backup job show¶

Show backup job details.

Usage:

orca backup job show [OPTIONS] JOB_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 backup job start¶

Start (trigger) a backup job.

Usage:

orca backup job start [OPTIONS] JOB_ID

Options:

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

orca backup job stop¶

Stop a running backup job.

Usage:

orca backup job stop [OPTIONS] JOB_ID

Options:

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

orca backup job-create¶

Create a backup job.

Examples: orca backup job create --client-id --path /var/data --container my-backups orca backup job create --client-id --path /var/lib/mysql --mode mysql --storage swift orca backup job create --client-id --action restore --path /var/data --container my-backups

Usage:

orca backup job-create [OPTIONS]

Options:

Name	Type	Description	Default
`--description`	text	Job description.	``
`--client-id`	text	Freezer client ID.	`Sentinel.UNSET`
`--action`	choice (`backup` \| `restore` \| `admin`)	Action type.	`backup`
`--path`	text	Path to back up or restore.	`Sentinel.UNSET`
`--container`	text	Swift container name for storage.	None
`--storage`	choice (`swift` \| `local` \| `ssh` \| `s3`)	Storage backend.	`swift`
`--mode`	choice (`fs` \| `mysql` \| `mongo` \| `mssql` \| `cinder` \| `nova`)	Backup mode.	`fs`
`--schedule-interval`	text	Schedule interval (e.g. '24 hours', '7 days').	None
`--help`	boolean	Show this message and exit.	`False`

orca backup job-delete¶

Delete a backup job.

Usage:

orca backup job-delete [OPTIONS] JOB_ID

Options:

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

orca backup job-list¶

List backup jobs.

Usage:

orca backup job-list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	None
`--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 backup job-show¶

Show backup job details.

Usage:

orca backup job-show [OPTIONS] JOB_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 backup job-start¶

Start (trigger) a backup job.

Usage:

orca backup job-start [OPTIONS] JOB_ID

Options:

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

orca backup job-stop¶

Stop a running backup job.

Usage:

orca backup job-stop [OPTIONS] JOB_ID

Options:

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

orca backup list¶

List backups.

Usage:

orca backup list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	None
`--offset`	integer	Offset for pagination.	None
`--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 backup session¶

Manage backup sessions.

Usage:

orca backup session [OPTIONS] COMMAND [ARGS]...

Options:

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

Subcommands

add-job: Add a job to a session.
create: Create a backup session.
delete: Delete a backup session.
list: List backup sessions.
remove-job: Remove a job from a session.
show: Show backup session details.
start: Start a backup session (triggers all its jobs).

orca backup session add-job¶

Add a job to a session.

Usage:

orca backup session add-job [OPTIONS] SESSION_ID JOB_ID

Options:

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

orca backup session create¶

Create a backup session.

Usage:

orca backup session create [OPTIONS]

Options:

Name	Type	Description	Default
`--description`	text	Session description.	``
`--schedule-interval`	text	Schedule interval (e.g. '24 hours').	None
`--help`	boolean	Show this message and exit.	`False`

orca backup session delete¶

Delete a backup session.

Usage:

orca backup session delete [OPTIONS] SESSION_ID

Options:

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

orca backup session list¶

List backup sessions.

Usage:

orca backup session list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	None
`--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 backup session remove-job¶

Remove a job from a session.

Usage:

orca backup session remove-job [OPTIONS] SESSION_ID JOB_ID

Options:

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

orca backup session show¶

Show backup session details.

Usage:

orca backup session show [OPTIONS] SESSION_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 backup session start¶

Start a backup session (triggers all its jobs).

Usage:

orca backup session start [OPTIONS] SESSION_ID

Options:

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

orca backup session-add-job¶

Add a job to a session.

Usage:

orca backup session-add-job [OPTIONS] SESSION_ID JOB_ID

Options:

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

orca backup session-create¶

Create a backup session.

Usage:

orca backup session-create [OPTIONS]

Options:

Name	Type	Description	Default
`--description`	text	Session description.	``
`--schedule-interval`	text	Schedule interval (e.g. '24 hours').	None
`--help`	boolean	Show this message and exit.	`False`

orca backup session-delete¶

Delete a backup session.

Usage:

orca backup session-delete [OPTIONS] SESSION_ID

Options:

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

orca backup session-list¶

List backup sessions.

Usage:

orca backup session-list [OPTIONS]

Options:

Name	Type	Description	Default
`--limit`	integer	Max results.	None
`--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 backup session-remove-job¶

Remove a job from a session.

Usage:

orca backup session-remove-job [OPTIONS] SESSION_ID JOB_ID

Options:

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

orca backup session-show¶

Show backup session details.

Usage:

orca backup session-show [OPTIONS] SESSION_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 backup session-start¶

Start a backup session (triggers all its jobs).

Usage:

orca backup session-start [OPTIONS] SESSION_ID

Options:

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

orca backup show¶

Show backup details.

Usage:

orca backup show [OPTIONS] BACKUP_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`