Pause-ProtectionGroup

Pauses protection of a specified VPG.

Syntax

Pause-ProtectionGroup [-ZVMIP] <String> [-ZVMPort] <Int32> [-Username] <String> [-Password] <String> [-VirtualProtectionGroup] <String> [-Wait <int32>] [<Common&RiskParameters>]

Description

The Pause-ProtectionGroup cmdlet pauses protection of a specified VPG, but recovery to the last checkpoint is still possible. A VPG can be paused when the available bandwidth between the protected and recovery sites is needed for other purposes.

Parameters

[-ZVMIP] <String>

The IP address of the machine where the Zerto Virtual Manager is installed that is used to process the cmdlet. The VPG to pause protection can be defined on this Zerto Virtual Manager site or a paired site.

Required? True
Position? 1 or named
Default Value None
Accept Wildcard Characters? False
[-ZVMPort] <Int32>

The HTTP port used for inbound communication with the Zerto Virtual Manager for APIs and cmdlets, specified during the installation. The default port recommended during installation is 9080.

Required? True
Position? 2 or named
Default Value None
Accept Wildcard Characters? False
[-Username] <String>

A username defined in the users.txt file in the Zerto installation folder, for the Zerto Virtual Manager where the cmdlet is run.

Required? True
Position? 3 or named
Default Value None
Accept Wildcard Characters? False
[-Password] <String>

The password for the specified username, in the users.txt file in the Zerto Virtual Replication installation folder, for the Zerto Virtual Manager where the cmdlet is run, encrypted using SHA-1.

Required? True
Position? 4 or named
Default Value None
Accept Wildcard Characters? False
[-VirtualProtectionGroup] <String>

The name of the VPG for which you want to pause protection. The value specified is case-sensitive.

Required? True
Position? 5 or named
Default Value None
Accept Wildcard Characters? False
-Wait <Int32>

The number of seconds to wait before timing out.

Required? False
Position? Named
Default Value None
Accept Wildcard Characters? False
<Common&RiskParameters>

This cmdlet supports the parameters described in Optional PowerShell Parameters.

Inputs and Outputs

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet returns.

Inputs None.
Outputs Pause-ProtectionGroup returns the task identifier for the command and the site identifier.

See Also

Resume-ProtectionGroup

Example 1

PS C:\Windows\SysWOW64\WindowsPowerShell\v1.0> Pause-ProtectionGroup 182.24.123.123 9080 administrator password -VirtualProtectionGroup ’Back Office’

This command pauses protection for the specified VPG. The Zerto Virtual Manager used to process the cmdlet runs on IP 182.24.123.123 and port 9080.

The cmdlet returns the command task identifier and site identifier.

Identifier                               SiteId
----------                               ------
8508c8b7-4da4-43c2-a12c-bbfb4754270d     1bcebc1a-754d-4ab8-a1a0-9b136ee31171