Manage legal hold custodians

Once you create a legal hold matter in the CrashPlan console, you can use the CrashPlan CLI to add or release custodians from the matter.

To see a list of all the users currently in your organization:

Export a list from the Users action menu.
Use the CLI users commands.

Use the legal-hold commands to manage legal hold custodians.

To view a list of legal hold matters for your organization, including the matter ID, use the following command: crashplan legal-hold list
To see a list of all the custodians currently associated with a legal hold matter, enter crashplan legal-hold show <matterID>.

Get CSV template

To add multiple custodians to a legal hold matter:

Generate a CSV template. Below is an example command that generates a template to use when bulk adding custodians to legal hold matter. Once generated, the CSV file is saved to your current working directory.
```
crashplan legal-hold bulk generate-template add
```
To generate a template to use when bulk releasing custodians from a legal hold matter:
```
crashplan legal-hold bulk generate-template remove
```
The CSV templates for add and remove have the same columns, but the commands generate different default filenames.
Use the CSV template to enter the matter ID(s) and CrashPlan usernames for the custodians you want to add to the matters. To get the ID for a matter, enter crashplan legal-hold list.
Save the CSV file.

Add custodians to a legal hold matter

You can add one or more custodians to a legal hold matter using the CrashPlan CLI.

Add multiple custodians

Once you have entered the matter ID and user information in the CSV file, use the bulk add command with the CSV file path to add multiple custodians at once. For example:

crashplan legal-hold bulk add /Users/admin/add_users_to_legal_hold.csv

Add a single custodian

To add a single custodian to a legal hold matter, use the following command as an example:

crashplan legal-hold add-user --matter-id 123456789123456789 --username user@example.com

Options

--matter-id (required): The identification number of the legal hold matter. To get the ID for a matter, run the command crashplan legal-hold list.
--username (required): The CrashPlan username of the custodian to add to the matter.
--profile (optional): The profile to use to execute the command. If not specified, the default profile is used.

Release custodians

You can release one or more custodians from a legal hold matter using the CrashPlan CLI.

Release multiple custodians

To release multiple custodians at once:

Enter the matter ID(s) and CrashPlan usernames to the CSV file template you generated.
Save the file to your current working directory.

Use the bulk remove command with the file path of the CSV you created. For example:

crashplan legal-hold bulk remove /Users/admin/remove_users_from_legal_hold.csv

Release a single custodian

Use remove-user to release a single custodian. For example:

crashplan legal-hold remove-user --matter-id  123456789123456789 --username user@example.com

Options are the same as add-user shown above.

View matters and custodians

You can use the CrashPlan CLI to get a list of all the legal hold matters for your organization, or get full details for a matter.

List legal hold matters

To view a list of legal hold matters for your organization, use the following command:

crashplan legal-hold list

This command produces the matter ID, name, description, creator, and creation date for the legal hold matters.

View matter details

To view active custodians for a legal hold matter, enter

crashplan legal-hold show

with the matter ID, for example:

crashplan legal-hold show 123456789123456789

To view active custodians for a legal hold matter, as well as the details of the preservation policy, enter

crashplan legal-hold show <matterID> --include-policy

To view all custodians (including inactive) for a legal hold matter, enter

crashplan legal-hold show <matterID> --include-inactive

List legal hold events

To view a list of legal hold administrative events, use the following command:

crashplan legal-hold search-events -m <matterID>

This command takes the required filters of a specific matter uid, and optional filters of beginning timestamp, end timestamp, and event type.

Future versions of the crashplancli will allow searching events from all legal holds.

Learn more about the Legal Hold commands.