How to pause/resume protected,replicated and clustered agents in one step using PowerShell (4038369)

How to pause/resume protected,replicated and clustered agents in one step using PowerShell

You have a rather complex environment which includes multiple source and target cores, clusters etc. Under the circumstances, pausing and resuming snapshots and replication for maintenance purposes, even while using the Powershell commandlets provided by the AppAssurePowerShellModule is a daunting task, especially if you are scripting some in depth periodic maintenance for the core server in question. You want an easy way to pause and resume protection and replication either for all or a few of the machines and clusters serviced by the core that could be run in conjunction with other scripted maintenance operations.

A PowerShell script to address the issue has been prepared. The script identifies protected servers, replicated servers and clusters. When run with the appropriate parameter, allows pausing/resuming protection and replication for protected servers and clusters and pausing/resuming replication for replicated servers and clusters.
If necessary, the operation can be performed only on the desired agents, by using the interactive parameter. 
The current status of protection/replication may be determined using the -status parameter. Please note that the status information refers to the local core only.
Powershell 3.0 or later is needed. The script works on AppAssure 5.4.x deployments.
The script is fully documented.
The documentation may be generated by running:

PS c:\Scripts>  Get-Help .\pauseresume.3.ps1 -full

The script is included below between horizontal lines and attached to this KB.

___________________________________________________

<#
.Synopsis
Pauses and resumes both protection and replication

.Description
This script gets a list of agent which maybe protected, replicated, clusters etc and pauses protection and/or replication for each. For instance a protected server which is replicated to a remote core is both paused and its replication is paused as well.
The replication of an agent from a remote core is paused as well.
The script compensates for some errors in the AppAssure powershell commandlets that do not allow, for instance, pausing clusters.
The information regarding the status of agents is shown at core level only.
Once the script is run, 

.Parameter pause
pauses prtection & replication for each qualified agent

.Parameter resume
resumes prtection & replication for each qualified agent

.Parameter interactive
allows selecting the agents to process

.Parameter status
list agents and shows their status

.Example
pauseresume.3.ps1 -interactive -pause

.Example
pauseresume.3.ps1 -interactive -resume

.Example
pauseresume.3.ps1 -interactive -status

.Example
pauseresume.3.ps1 -resume

#>

param([switch]$resume,[switch]$pause,[switch]$status,[switch]$interactive)
function get-infoobject{
param ($cred=$null,$corename=$env:computername,$uriend)
try{
$url = "https://$($corename):8006/apprecovery/api/core/"
$url = $url + $uriend
$wc = New-Object System.Net.WebClient
if($cred){$wc.Credentials = $cred}else{$wc.usedefaultcredentials=$true}
[System.Net.ServicePointManager]::ServerCertificateValidationCallback = { $true }
[xml]$agentinfo =  $wc.DownloadString($url)
}
catch{Write-Host "Unable to retrieve agents from core $corename" -f red;$agents=$null }
return $agentinfo
}
function get-rawagents{
$rawagentsx = get-infoobject -uriend "agents"
[array]$permissibleagettype="Protected","Replicated","Cluster","Clusternode"
$allagents = $rawagentsx.agents.agent | where {$permissibleagettype -contains $_.agentType} | select-object -Property displayname,agenttype,@{n="IsPaused";e={if($_.agenttype -eq "Replicated"){$_.masterCoreInfo.agents.remotecoreagent.pauseReplication}else{$_.ispaused}}},status,id,@{n="MasterCoreName";e={$_.mastercoreinfo.hostname}},@{n="MasterCoreId";e={$_.mastercoreinfo.id}},@{n="TargetCoreName";e={$_.slavecoreinfoitems.remoteslavecoreinfo.hostname}},@{n="TargetCoreId";e={$_.slavecoreinfoitems.remoteslavecoreinfo.id}}
return $allagents
}
function resume-agent{
param ($agentid)
$regroot="HKEY_LOCAL_MACHINE\SOFTWARE\AppRecovery\Core\Agents\$($agentid)\AgentProtectionConfiguration"
if(Test-Path -Path "Registry::$regroot\PauseConfiguration"){Remove-Item -Path "Registry::$regroot\PauseConfiguration" -force | Out-Null}else{write-warning "Already active" }
}
function pause-agent{
param ($agentid)
$regroot="HKEY_LOCAL_MACHINE\SOFTWARE\AppRecovery\Core\Agents\$($agentid)\AgentProtectionConfiguration"
$default = "Replay.Core.Contracts.Transfer.ProtectionPauseConfiguration"
$pausets = ((get-date).ToUniversalTime()).tostring("yyyy-MM-ddTHH:mm:ssZ")
$pauseinterval="00:00:00"
$PauseType=1
if(Test-Path -Path "Registry::$regroot\PauseConfiguration"){Write-Host "already paused. Updating with current values";Remove-Item -Path "Registry::$regroot\PauseConfiguration" -Force }
if(!(Test-Path -Path "Registry::$regroot\PauseConfiguration")){
new-item -Path "Registry::$regroot\PauseConfiguration" -Force | Out-Null
set-item -Path "Registry::$regroot\PauseConfiguration" -Value $default | Out-Null
new-itemproperty -Path "Registry::$regroot\PauseConfiguration" -name "PausedTimeStamp" -Value $pausets -PropertyType "String" | Out-Null
new-itemproperty -Path "Registry::$regroot\PauseConfiguration" -name "PauseInterval" -Value $pauseinterval -PropertyType "String" | Out-Null
new-itemproperty -Path "Registry::$regroot\PauseConfiguration" -name "PauseType" -Value $PauseType -PropertyType "DWord" | Out-Null
}
}
function pauseresumereplicatedagent {
param($agentid,$coreid=$null,[switch]$resume,[switch]$incoming)

if($coreid){$coreid = "/$($coreid)"}

$op = "true"
if($resume.IsPresent){$op="false"}
$coretype="slaves"
if($incoming.IsPresent){$coretype="masters"}
$body=@"
<?xml version="1.0" ?>
<replicationPauseConfiguration xmlns="http://apprecovery.com/management/api/2010/05">
  <cancelRunningReplicationJobs>$op</cancelRunningReplicationJobs>
  <isPaused>$op</isPaused>
</replicationPauseConfiguration>
"@
invoke-restmethod -URI "https://$($env:computername):8006/apprecovery/api/core/replication/$($coretype)$($coreid)/agents/$($agentId)/pauseConfiguration" -Method "POST" -Body $body -ContentType "application/xml" -UseDefaultCredentials ;
}

function place-check {
param ($color="Green")
$checksign = @{Object=[char]8730;ForeGroundColor=$color;NoNewLine=$true}
Write-Host @checksign
}
cls
Write-Host "Pause or Resume Protected Entities`r`n----------------------------------`r`n" -f Green
if(!($resume.IsPresent -xor $pause.IsPresent -xor $status.IsPresent)){Write-Host "Please use either -resume, -pause or -status as parameters`nUse the -interactive parameter to select the desired agents for processing" -f Yellow; exit}
[array]$agents = get-rawagents
if($interactive.IsPresent){[array]$agents = $agents | Out-GridView -Title "Select Agents to protect" -PassThru
if(!($agents)){Write-Host "Action Cancelled... Exiting" -f Yellow;exit}}
if($status.IsPresent){if(!($interactive.IsPresent)){Write-Host "`r`nPlease use the -interactive parameter`n" -f Yellow}; exit}
foreach ($agent in $agents){
Write-Host "Processing: $($agent.displayname), isPaused=$($agent.isPaused) " -f Yellow -NoNewline;place-check 
if($resume.IsPresent){resume-agent -agentid $agent.id;if($agent.MasterCoreId){pauseresumereplicatedagent -agentid $agent.id -incoming -coreid $agent.MasterCoreId -resume};if($agent.targetcoreid){pauseresumereplicatedagent -agentid $agent.id -resume -coreid $agent.targetcoreid}}
if($pause.IsPresent){pause-agent -agentid $agent.id;if($agent.MasterCoreId){pauseresumereplicatedagent -agentid $agent.id -incoming  -coreid $agent.MasterCoreId };if($agent.targetcoreid){pauseresumereplicatedagent -agentid $agent.id -coreid $agent.targetcoreid}}
Write-Host ""
}

$newresults = (get-rawagents)
foreach ($agent in $agents){[array]$r +=[pscustomobject]@{agentname=$agent.displayname;agenttype= $agent.agenttype;IsPaused=($newresults| where{$_.id -eq $agent.id}).ispaused;Agentid=$agent.id}}
$r | ft -AutoSize

___________________________________________________

PauseResume.3