Legal holds

Holding backups against expiry. Operator only.

legal hold create

Hold a point, a plan or a project beyond its retention (operator).

Expiry skips what a hold covers whatever its expiry date says, so "keep everything about this project until the lawyers say otherwise" is one call rather than a policy edit. The same hand lifts it.

openstack backup legal hold create [--point <point>] [--plan <plan>] \
    [--project <project>] --reason <text>

Argument	Description
--point <point>	Hold one backup, by id.
--plan <plan>	Hold every backup of a plan, by name or id.
--project <project>	Hold every backup in a project, by id.
--reason <text>	Recorded on the hold and in the audit log. Required.

legal hold delete

Lift one or more legal holds (operator).

Lifting does not delete anything: the points go back to expiring on the dates their policy gave them, which for a held point may be immediately.

openstack backup legal hold delete <hold> [<hold> ...]

Argument	Description
<hold>	Legal hold id. Takes one or more.

legal hold list

List legal holds (operator).

openstack backup legal hold list [--scope <scope>] [--target <id>] \
    [--project <project>] [--include-lifted] [--limit <limit>]

Argument	Description
--scope <scope>	Point, plan or project. One of point, plan, project.
--target <id>	Holds on this point, plan or project.
--project <project>	Holds whose blast radius is this project.
--include-lifted	Holds already lifted as well; the default is only what is still held.
--limit <limit>	Maximum holds returned.