`orca backup` — backup (Freezer)¶

Manage backups, jobs, sessions & clients (Freezer).

action-create¶

Create a standalone backup action.

orca backup action-create [OPTIONS]

Option	Description
`--action [backup\|restore\|admin]`
`--path TEXT`	Path to back up or restore. [required]
`--container TEXT`	Swift container name.
`--storage [swift\|local\|ssh\|s3]`	[default: swift]
`--mode [fs\|mysql\|mongo\|mssql\|cinder\|nova]`
`--backup-name TEXT`	Name for the backup.
`--max-level INTEGER`	Max incremental backup level.
`--help`	Show this message and exit.

action-delete¶

Delete a backup action.

orca backup action-delete [OPTIONS]

Option	Description
`-y, --yes`	Skip confirmation.
`--help`	Show this message and exit.

action-list¶

List backup actions.

orca backup action-list [OPTIONS]

Option	Description
`--limit INTEGER`	Max results.
`--noindent`	Disable JSON indentation.
`--max-width INTEGER`	Maximum table width (0 = unlimited).
`--fit-width`	Fit table to terminal width.
`-c, --column TEXT`	Column to include (repeatable). Shows all if
`-f, --format [table\|json\|value]`
`--help`	Show this message and exit.

action-show¶

Show backup action details.

orca backup action-show [OPTIONS]

Option	Description
`--noindent`	Disable JSON indentation.
`--max-width INTEGER`	Maximum table width (0 = unlimited).
`--fit-width`	Fit table to terminal width.
`-c, --column TEXT`	Column to include (repeatable). Shows all if
`-f, --format [table\|json\|value]`
`--help`	Show this message and exit.

client-delete¶

Unregister a backup client.

orca backup client-delete [OPTIONS]

Option	Description
`-y, --yes`	Skip confirmation.
`--help`	Show this message and exit.

client-list¶

List registered backup clients (agents).

orca backup client-list [OPTIONS]

Option	Description
`--limit INTEGER`	Max results.
`--noindent`	Disable JSON indentation.
`--max-width INTEGER`	Maximum table width (0 = unlimited).
`--fit-width`	Fit table to terminal width.
`-c, --column TEXT`	Column to include (repeatable). Shows all if
`-f, --format [table\|json\|value]`
`--help`	Show this message and exit.

client-register¶

Register a new backup client.

orca backup client-register [OPTIONS]

Option	Description
`--description TEXT`	Client description.
`--help`	Show this message and exit.

client-show¶

Show backup client details.

orca backup client-show [OPTIONS]

Option	Description
`--noindent`	Disable JSON indentation.
`--max-width INTEGER`	Maximum table width (0 = unlimited).
`--fit-width`	Fit table to terminal width.
`-c, --column TEXT`	Column to include (repeatable). Shows all if
`-f, --format [table\|json\|value]`
`--help`	Show this message and exit.

delete¶

Delete a backup.

orca backup delete [OPTIONS]

Option	Description
`-y, --yes`	Skip confirmation.
`--help`	Show this message and exit.

job-create¶

Create a backup job.

orca backup job-create [OPTIONS]

Option	Description
`--description TEXT`	Job description.
`--client-id TEXT`	Freezer client ID. [required]
`--action [backup\|restore\|admin]`
`--path TEXT`	Path to back up or restore. [required]
`--container TEXT`	Swift container name for storage.
`--storage [swift\|local\|ssh\|s3]`	Storage backend. [default: swift]
`--mode [fs\|mysql\|mongo\|mssql\|cinder\|nova]`
`--schedule-interval TEXT`	Schedule interval (e.g. '24 hours', '7
`--help`	Show this message and exit.

job-delete¶

Delete a backup job.

orca backup job-delete [OPTIONS]

Option	Description
`-y, --yes`	Skip confirmation.
`--help`	Show this message and exit.

job-list¶

List backup jobs.

orca backup job-list [OPTIONS]

Option	Description
`--limit INTEGER`	Max results.
`--noindent`	Disable JSON indentation.
`--max-width INTEGER`	Maximum table width (0 = unlimited).
`--fit-width`	Fit table to terminal width.
`-c, --column TEXT`	Column to include (repeatable). Shows all if
`-f, --format [table\|json\|value]`
`--help`	Show this message and exit.

job-show¶

Show backup job details.

orca backup job-show [OPTIONS]

Option	Description
`--noindent`	Disable JSON indentation.
`--max-width INTEGER`	Maximum table width (0 = unlimited).
`--fit-width`	Fit table to terminal width.
`-c, --column TEXT`	Column to include (repeatable). Shows all if
`-f, --format [table\|json\|value]`
`--help`	Show this message and exit.

job-start¶

Start (trigger) a backup job.

orca backup job-start [OPTIONS]

Option	Description

job-stop¶

Stop a running backup job.

orca backup job-stop [OPTIONS]

Option	Description

list¶

List backups.

orca backup list [OPTIONS]

Option	Description
`--limit INTEGER`	Max results.
`--offset INTEGER`	Offset for pagination.
`--noindent`	Disable JSON indentation.
`--max-width INTEGER`	Maximum table width (0 = unlimited).
`--fit-width`	Fit table to terminal width.
`-c, --column TEXT`	Column to include (repeatable). Shows all if
`-f, --format [table\|json\|value]`
`--help`	Show this message and exit.

session-add-job¶

JOB_ID

orca backup session-add-job [OPTIONS]

Option	Description

session-create¶

Create a backup session.

orca backup session-create [OPTIONS]

Option	Description
`--description TEXT`	Session description.
`--schedule-interval TEXT`	Schedule interval (e.g. '24 hours').
`--help`	Show this message and exit.

session-delete¶

Delete a backup session.

orca backup session-delete [OPTIONS]

Option	Description
`-y, --yes`	Skip confirmation.
`--help`	Show this message and exit.

session-list¶

List backup sessions.

orca backup session-list [OPTIONS]

Option	Description
`--limit INTEGER`	Max results.
`--noindent`	Disable JSON indentation.
`--max-width INTEGER`	Maximum table width (0 = unlimited).
`--fit-width`	Fit table to terminal width.
`-c, --column TEXT`	Column to include (repeatable). Shows all if
`-f, --format [table\|json\|value]`
`--help`	Show this message and exit.

session-remove-job¶