Zerto PowerShell Cmdlets Help
Adds SSL certificate check
Add-ZvmSslCheck [<CommonParameters>]
Add session
Connect-Zvm [-HostName] <String> [-Credential] <PSCredential> [-Port <Int32>]
Remove session
Disconnect-Zvm
Get information about Zerto alerts.
You can filter the results with additional parameters.
Get information about Zerto alerts.
You can filter the results with additional parameters.
Get-ZvmAlert [-EndDate <DateTime>] [-Entity <String>] [-HelpId <String>] [-IsDismissed]
[-Level <String>] [-SiteId <String>] [-StartDate <DateTime>] [[-VpgId] <String>] [-ZorgId <String>] Get-ZvmAlert
-AlertId <String>
Get a list of all available alert help identifiers.
Get-ZvmAlertHelpId
Get a list of all available alert levels.
Get-ZvmAlertLevel
Get a list of latest Zerto events.
You can filter the results with additional parameters.
Get-ZvmEvent [-AlertId <String>] [-Category <String>] [-EndDate <DateTime>] [-EntityType <String>]
[-EventCategory <String>] [-EventType <String>] [-SiteId <String>] [-SiteName <String>]
[-StartDate <DateTime>] [-UserName <String>] [[-VpgId] <String>] [-VpgName <String>] [-ZorgId <String>]
Get-ZvmEvent -EventId <String>
Get valid values of event types
Get-ZvmEventType
Add a new license or update an existing one.
Get-ZvmLicense
Get information about the local site
Get-ZvmLocalSite
Generate token for pairing
Get-ZvmPairingToken
Get a list of all peer sites
Get-ZvmPeer [-HostName <String>] [-Location <String>] [-PairingStatus <String>]
[-PeerName <String>] [-Port <Int32>] Get-ZvmPeer [-SiteId] <String>
Get-ZvmTask
Description
Get information about tasks run on this site.
You can filter the results with additional parameters.
Get-ZvmTask [-CompletedAfterDate <DateTime>] [-CompletedBeforeDate <DateTime>]
[-StartedAfterDate <DateTime>] [-StartedBeforeDate <DateTime>] [-Status <String>]
[-Type <String>] Get-ZvmTask [-TaskId] <String>
Get a list of virtual sites (hypervisor/public cloud) connected to this site and all peer sites.
Get-ZvmVirtualizationSite
Get-ZvmVirtualizationSiteDatastore
Get information about datastores at the specified site.
Get-ZvmVirtualizationSiteDatastore
Get information about hosts at the specified site.
Get-ZvmVirtualizationSiteHost
Get-ZvmVirtualizationSiteHost [-HostId] <String>
Get information about protected virtual machines.
You can filter the results with additional parameters.
Get-ZvmVm [[-VmId] <String>] [-OrgName <String>] [-Priority <String>]
[-ProtectedSiteId <String>] [-ProtectedSiteType <String>] [-RecoverySiteId <String>]
[-RecoverySiteType <String>] [-SourceSite <String>] [-SourceType <String>]
[-Status <String>] [-SubStatus <String>] [-TargetSite <String>] [-TargetType <String>]
[-VmName <String>] [-VpgName <String>] Get-ZvmVm
[[-VmId] <String>] [-VpgId <String>]
Get information about all VPGs.
Get-ZvmVpg [-BackupEnabled] [-OrgName <String>] [-Priority <String>] [-ProtectedSiteId <String>]
[-ProtectedSiteType <String>] [-RecoverySiteId <String>] [-RecoverySiteType <String>]
[-ServiceProfile <String>] [-SourceSite <String>] [-SourceType <String>]
[-Status <String>] [-SubStatus <String>] [-TargetSite <String>] [-TargetType <String>]
[-VpgName <String>] [-ZorgId <String>] Get-ZvmVpg [-VpgId] <String>
Get-ZvmVpgCheckpoint
Description
Create a tagged checkpoint for the specified VPG.
Syntax
Get-ZvmVpgCheckpoint [-VpgId] <String> [-EndDate <DateTime>] [-StartDate <DateTime>]
Get-ZvmVpgCheckpoint [-VpgId] <String> [-CheckpointId] <String>
Get-ZvmVra
Description
Get information about all VRAs.
Syntax
Get-ZvmVra [-DatastoreClusterName <String>] [-DatastoreName <String>] [-HostVersion <String>]
[-IPAddress <String>] [-NetworkName <String>] [-Status <String>] [-VraGroup <String>]
[-VraIPConfigurationTypeApi <String>] [-VraName <String>]
[-VraVersion <String>] Get-ZvmVra [-VraId] <String>
Removes SSL certificate check
Syntax
Remove-ZvmSslCheck [<CommonParameters>]
Set-ZvmLicense
Description
Sets the license for a ZVM
Set-ZvmLicense [-LicenseKey] <String>
Set-ZvmLicense -Body <ILicenseKeyApi>
Start-ZvmPair
Description
Starts Pairing to a remote site
Syntax
Start-ZvmPair [-HostName] <String> [-Port] <Int32> [-Token] <String>
Start-ZvmPair -Body <IPairDataApi>
Start-ZvmVpgClone
Description
Start cloning a specified VPG using a specified checkpoint or the latest checkpoint if one is not specified.
Start-ZvmVpgClone [-VpgId] <String> [[-CheckpointId] <String>] [[-DatastoreId] <String>] [-VmIdentifiers <String[]>]
Start-ZvmVpgClone [-VpgId] <String> -Body <ICloneStartDataApi>
Delete the specified VPG
Start-ZvmVpgDelete [-VpgId] <String> [-Force] [-KeepRecoveryVolumes]
Start-ZvmVpgDelete [-VpgId] <String> -Body <IVpgDeleteDataApi>
Start a failover test of the specified VPG with the specified checkpoint or the latest checkpoint
if one is not specified.
Start-ZvmVpgFailoverTest [-VpgId] <String> [-CheckpointId <String>] [-VmIdentifiers <String[]>]
Start-ZvmVpgFailoverTest [-VpgId] <String> -Body <IFailOverTestStartDataApi>
Forces synchronization the specified VPG.
Start-ZvmVpgForceSync [-VpgId] <String>
Pauses the protection of the specified VPG.
Start-ZvmVpgPause [-VpgId] <String>
Resumes the protection of the specified VPG.
Start-ZvmVpgResume [-VpgId] <String>
Start-ZvmVpgTaggedCheckpointInsert
Inserts a tag (text) to a new checkpoint of a specified virtual protection group (VPG).
Returns the task identifier of the operation, which can be used to monitor the operation using the Tasks API.
Start-ZvmVpgTaggedCheckpointInsert [-VpgId] <String> [[-CheckpointName] <String>]
Start-ZvmVpgTaggedCheckpointInsert [-VpgId] <String> -Body <IVpgInsertTagCheckpointDataApi>
Start-ZvmVraChangeRecoveryHost
Start changing the recovery host.
Start-ZvmVraChangeRecoveryHost [-VraId] <String> -Body <IVraChangeRecoveryHostSettingsApi>
Start-ZvmVraChangeRecoveryHost [-VraId] <String> [-VmsAllocations] <IVraVMAllocationApi[]>
Abort cloning of the specified VPG.
Stop-ZvmVpgClone [-VpgId] <String>
Stop-ZvmVpgFailoverTest
Description
Stops a failover test.
Specify if test was successful and provide a summary.
Stop-ZvmVpgFailoverTest [-VpgId] <String> [-FailoverTestSuccess] [[-FailoverTestSummary] <String>]
Stop-ZvmVpgFailoverTest [-VpgId] <String> -Body <IStopFailoverTestDataApi>
Name
Stop-ZvmVpgFailoverTest
Stops a failover test.
Specify if test was successful and provide a summary.
Stop-ZvmVpgFailoverTest [-VpgId] <String> [-FailoverTestSuccess] [[-FailoverTestSummary] <String>]
Stop-ZvmVpgFailoverTest [-VpgId] <String> -Body <IStopFailoverTestDataApi>
-VpgId <String> Required? true
Position? 1
Default value
Accept pipeline input? false
Accept pipeline input? false
-Body <IStopFailoverTestDataApi>To construct, see NOTES section for BODY properties and create a hash table.
Required? true
Position? named
Default value
Accept pipeline input? true (ByValue)
Accept pipeline input? false
-FailoverTestSuccess [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept pipeline input? false
-FailoverTestSummary <String> Required? false
Position? 2
Default value
Accept pipeline input? false
Accept pipeline input? false
Zerto.Zvm.Models.IStopFailoverTestDataApi
System.String
NOTES:
COMPLEX PARAMETER PROPERTIES
To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.
BODY <IStopFailoverTestDataApi>: .
[FailoverTestSuccess <Boolean?>]:
[FailoverTestSummary <String>]: