Logo
stable
  • User Guides
  • Commands
    • Profile
    • Security Data
    • Audit Logs
    • Alerts
    • Alert Rules
    • Departing Employee
    • Devices
    • High Risk Employee
    • Legal Hold
      • add-user
      • bulk
        • add
        • generate-template
        • remove
      • list
      • remove-user
      • show
    • Cases
code42cli
  • Docs »
  • Commands »
  • legal-hold
  • Edit on GitHub

legal-hold¶

Add and remove custodians from legal hold matters.

legal-hold [OPTIONS] COMMAND [ARGS]...

add-user¶

Add a custodian to a legal hold matter.

legal-hold add-user [OPTIONS]

Options

-m, --matter-id <matter_id>¶

Required Identification number of the legal hold matter the custodian will be added to.

-u, --username <username>¶

Required The username of the custodian to add to the matter.

-d, --debug¶

Turn on debug logging.

--profile <profile>¶

The name of the Code42 CLI profile to use when executing this command.

bulk¶

Tools for executing bulk legal hold actions.

legal-hold bulk [OPTIONS] COMMAND [ARGS]...

add¶

Bulk add custodians to legal hold matters using a CSV file. CSV file format: matter_id,username

legal-hold bulk add [OPTIONS] CSV_FILE

Options

-d, --debug¶

Turn on debug logging.

--profile <profile>¶

The name of the Code42 CLI profile to use when executing this command.

Arguments

CSV_FILE¶

Required argument

generate-template¶

Generate the CSV template needed for bulk adding/removing users.

legal-hold bulk generate-template [OPTIONS] [add|remove]

Options

-p, --path <path>¶

Write template file to specific file path/name.

Arguments

CMD¶

Required argument

remove¶

Bulk release custodians from legal hold matters using a CSV file. CSV file format: matter_id,username

legal-hold bulk remove [OPTIONS] CSV_FILE

Options

-d, --debug¶

Turn on debug logging.

--profile <profile>¶

The name of the Code42 CLI profile to use when executing this command.

Arguments

CSV_FILE¶

Required argument

list¶

Fetch existing legal hold matters.

legal-hold list [OPTIONS]

Options

-f, --format <format>¶

The output format of the result. Defaults to table format.

Options:TABLE|CSV|JSON|RAW-JSON
-d, --debug¶

Turn on debug logging.

--profile <profile>¶

The name of the Code42 CLI profile to use when executing this command.

remove-user¶

Release a custodian from a legal hold matter.

legal-hold remove-user [OPTIONS]

Options

-m, --matter-id <matter_id>¶

Required Identification number of the legal hold matter the custodian will be added to.

-u, --username <username>¶

Required The username of the custodian to add to the matter.

-d, --debug¶

Turn on debug logging.

--profile <profile>¶

The name of the Code42 CLI profile to use when executing this command.

show¶

Display details of a given legal hold matter.

legal-hold show [OPTIONS] MATTER_ID

Options

--include-inactive¶

View all custodians associated with the legal hold matter, including inactive custodians.

--include-policy¶

View details of the preservation policy associated with the legal hold matter.

-d, --debug¶

Turn on debug logging.

--profile <profile>¶

The name of the Code42 CLI profile to use when executing this command.

Arguments

MATTER_ID¶

Required argument

Next Previous

© Copyright 2020, Code42 Software Revision adf3f444.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: stable
Versions
latest
stable
v1.3.1
v1.3.0
v1.2.0
v1.1.0
v1.0.0
Downloads
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.