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 removed from.
-
-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.
search-events¶
Tools for getting legal hold event data.
legal-hold search-events [OPTIONS]
Options
-
-m,--matter-id<matter_id>¶ Filter results by legal hold UID.
-
--event-type<event_type>¶ Filter results by event types.
Options: MembershipCreated|MembershipReactivated|MembershipDeactivated|HoldCreated|HoldDeactivated|HoldReactivated|Restore
-
--begin<begin>¶ The beginning of the date range in which to look for legal hold events. Accepts a date/time in yyyy-MM-dd (UTC) or yyyy-MM-dd HH:MM:SS (UTC+24-hr time) format where the ‘time’ portion of the string can be partial (e.g. ‘2020-01-01 12’ or ‘2020-01-01 01:15’) or a ‘short time’ value representing days (30d), hours (24h) or minutes (15m) from the current time.
-
--end<end>¶ The end of the date range in which to look for legal hold events, argument format options are the same as –begin.
-
-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.
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