legalHold

Set Legal Hold using PowerShell

Warning: this code is provided on a best effort basis and is not in any way officially supported or sanctioned by Cohesity. The code is intentionally kept simple to retain value as example code. The code in this repository is provided as-is and the author accepts no liability for damages resulting from its use.

This script add or remove legal hold from a protection run.

Runs or objects placed on legal hold will not expire when their retention end date is reached. Instead, they will be rertained until the legal hold is removed. Note that the user adding or removeing leegal hosd much have the Data Security role assigned to their account.

Download the script

Run these commands from PowerShell to download the script(s) into your current directory

# Download Commands
$scriptName = 'legalHold'
$repoURL = 'https://raw.githubusercontent.com/bseltz-cohesity/scripts/master/powershell'
(Invoke-WebRequest -Uri "$repoUrl/$scriptName/$scriptName.ps1").content | Out-File "$scriptName.ps1"; (Get-Content "$scriptName.ps1") | Set-Content "$scriptName.ps1"
(Invoke-WebRequest -Uri "$repoUrl/cohesity-api/cohesity-api.ps1").content | Out-File cohesity-api.ps1; (Get-Content cohesity-api.ps1) | Set-Content cohesity-api.ps1
# End Download Commands

Components

• legalHold.ps1: the main powershell script
• cohesity-api.ps1: the Cohesity REST API helper module

Place both files in a folder together, then we can run the script.

First, run the script with the -listRuns to show the runIds and dates you have to work with:e -commit parameter.

./legalHold.ps1 -vip mycluster `
                -username myusername `
                -domain mydomain.net `
                -jobName 'my job' `
                -listRuns

Connected!

 RunId RunDate
 ----- -------
163093 10/1/20 10:30:01 PM
162563 9/30/20 10:30:01 PM
162019 9/29/20 10:30:01 PM
161493 9/28/20 10:30:01 PM
160965 9/27/20 10:30:00 PM

The choose a runId to work with:

Check the hold status of the run:

./legalHold.ps1 -vip mycluster `
                -username myusername `
                -domain mydomain.net `
                -jobName 'my job' `
                -runId 163093

Or use the latest run:

./legalHold.ps1 -vip mycluster `
                -username myusername `
                -domain mydomain.net `
                -jobName 'my job' `
                -latest

Add legal hold:

./legalHold.ps1 -vip mycluster `
                -username myusername `
                -domain mydomain.net `
                -jobName 'my job' `
                -runId 163093 `
                -addHold

Remove legal hold:

./legalHold.ps1 -vip mycluster `
                -username myusername `
                -domain mydomain.net `
                -jobName 'my job' `
                -runId 163093 `
                -removeHold

Remove legal hold on a range of dates:

./legalHold.ps1 -vip mycluster `
                -username myusername `
                -domain mydomain.net `
                -jobName 'my job' `
                -startDate '2020-10-22' `
                -endDate '2020-10-27' `
                -removeHold

Parameters

• -vip: Cohesity Cluster to connect to
• -username: Cohesity username
• -domain: (optional) Active Directory domain of user (defaults to local)
• -jobName: name of the protection job
• -listRuns: (optional) show available runs
• -runId: (optional) use specific runId
• -latest: (optional) use latest run
• -startDate: (optional) use range of dates starting with (e.g. '2020-10-22')
• -endDate: (optional) use range of dates ending with (e.g. '2020-10-27')
• -addHold: (optional) add legal hold to the run
• -removeHold: (optional) remove legal host from the run