Zerto PowerShell Cmdlets Help
Add-ZvmSslCheck
Description
Adds SSL certificate check
Syntax
Add-ZvmSslCheck [<CommonParameters>]
Connect-Zvm
Description
Add session
Syntax
Connect-Zvm [-HostName] <String> [-Credential] <PSCredential> [-Port <Int32>]
Disconnect-Zvm
Description
Remove session
Syntax
Disconnect-Zvm
Get-ZvmAlert
Description
Get information about Zerto alerts.
You can filter the results with additional parameters.
Syntax
Get-ZvmAlert [-EndDate <DateTime>] [-Entity <String>] [-HelpId <String>] [-IsDismissed] [-Level <String>] [-SiteId <String>] [-StartDate <DateTime>] [[-VpgId] <String>] [-ZorgId <String>]
Get-ZvmAlert -AlertId <String>
Get-ZvmAlertHelpId
Description
Get a list of all available alert help identifiers.
Syntax
Get-ZvmAlertHelpId
Get-ZvmAlertLevel
Description
Get a list of all available alert levels.
Syntax
Get-ZvmAlertLevel
Get-ZvmEvent
Description
Get a list of latest Zerto events.
You can filter the results with additional parameters.
Syntax
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-ZvmEventType
Description
Get valid values of event types
Syntax
Get-ZvmEventType
Get-ZvmLicense
Description
Add a new license or update an existing one.
Syntax
Get-ZvmLicense
Get-ZvmLocalSite
Description
Get information about the local site
Syntax
Get-ZvmLocalSite
Get-ZvmPairingToken
Description
Generate token for pairing
Syntax
Get-ZvmPairingToken
Get-ZvmPeer
Description
Get a list of all peer sites
Syntax
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.
Syntax
Get-ZvmTask [-CompletedAfterDate <DateTime>] [-CompletedBeforeDate <DateTime>] [-StartedAfterDate <DateTime>] [-StartedBeforeDate <DateTime>] [-Status <String>] [-Type <String>]
Get-ZvmTask [-TaskId] <String>
Get-ZvmVirtualizationSite
Description
Get a list of virtual sites (hypervisor/public cloud) connected to this site and all peer sites.
Syntax
Get-ZvmVirtualizationSite
Get-ZvmVirtualizationSiteDatastore
Description
Get information about datastores at the specified site.
Syntax
Get-ZvmVirtualizationSiteDatastore
Get-ZvmVirtualizationSiteHost
Description
Get information about hosts at the specified site.
Syntax
Get-ZvmVirtualizationSiteHost
Get-ZvmVirtualizationSiteHost [-HostId] <String>
Get-ZvmVm
Description
Get information about protected virtual machines.
You can filter the results with additional parameters.
Syntax
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-ZvmVpg
Description
Get information about all VPGs.
Syntax
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>
Remove-ZvmSslCheck
Description
Removes SSL certificate check
Syntax
Remove-ZvmSslCheck [<CommonParameters>]
Set-ZvmLicense
Description
Sets the license for a ZVM
Syntax
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.
Syntax
Start-ZvmVpgClone [-VpgId] <String> [[-CheckpointId] <String>] [[-DatastoreId] <String>] [-VmIdentifiers <String[]>]
Start-ZvmVpgClone [-VpgId] <String> -Body <ICloneStartDataApi>
Start-ZvmVpgDelete
Description
Delete the specified VPG
Syntax
Start-ZvmVpgDelete [-VpgId] <String> [-Force] [-KeepRecoveryVolumes]
Start-ZvmVpgDelete [-VpgId] <String> -Body <IVpgDeleteDataApi>
Start-ZvmVpgFailoverTest
Description
Start a failover test of the specified VPG with the specified checkpoint or the latest checkpoint if one is not specified.
Syntax
Start-ZvmVpgFailoverTest [-VpgId] <String> [-CheckpointId <String>] [-VmIdentifiers <String[]>]
Start-ZvmVpgFailoverTest [-VpgId] <String> -Body <IFailOverTestStartDataApi>
Start-ZvmVpgForceSync
Description
Forces synchronization the specified VPG.
Syntax
Start-ZvmVpgForceSync [-VpgId] <String>
Start-ZvmVpgPause
Description
Pauses the protection of the specified VPG.
Syntax
Start-ZvmVpgPause [-VpgId] <String>
Start-ZvmVpgResume
Description
Resumes the protection of the specified VPG.
Syntax
Start-ZvmVpgResume [-VpgId] <String>
Start-ZvmVpgTaggedCheckpointInsert
Description
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.
Syntax
Start-ZvmVpgTaggedCheckpointInsert [-VpgId] <String> [[-CheckpointName] <String>]
Start-ZvmVpgTaggedCheckpointInsert [-VpgId] <String> -Body <IVpgInsertTagCheckpointDataApi>
Start-ZvmVraChangeRecoveryHost
Description
Start changing the recovery host.
Syntax
Start-ZvmVraChangeRecoveryHost [-VraId] <String> -Body <IVraChangeRecoveryHostSettingsApi>
Start-ZvmVraChangeRecoveryHost [-VraId] <String> [-VmsAllocations] <IVraVMAllocationApi[]>
Stop-ZvmVpgClone
Description
Abort cloning of the specified VPG.
Syntax
Stop-ZvmVpgClone [-VpgId] <String>
Description
Stops a failover test.
Specify if test was successful and provide a summary.
Syntax
Stop-ZvmVpgFailoverTest [-VpgId] <String> [-FailoverTestSuccess] [[-FailoverTestSummary] <String>]
Stop-ZvmVpgFailoverTest [-VpgId] <String> -Body <IStopFailoverTestDataApi>