Supported Target Versions
Zerto local site version 9.0.41
Zerto local site version 10.0.30

Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
3.0.1Provided fix for VPGs Discovery.
3.0.0
  • Support given to Zerto local site version 10.0.30
  • Support for native type wise discovery.
2.0.1
  • Metric label support.
  • Missing component alert support.
  • Display Order and Resource Grouping Support.
  • subcategory Updated from Data Protection to Backup and Recovery.
Click here to view the earlier version updates
Application VersionBug fixes / Enhancements
2.0.0
  • Added new metric support on “Zerto Virtual Protection Group” resource
    • "zerto_vpg_Needs_Configuration"
    • "zerto_vpg_Error"
    • "zerto_vpg_EmptyProtectionGroup"
    • "zerto_vpg_DisconnectedFromPeer"
    • "zerto_vpg_RecoveryStorageError"
    • "zerto_vpg_JournalStorageError"
    • "zerto_vpg_ReplicationPaused"
  • Added a new field -“helpIdentifier” in the app configuration for event/alert polling.
  • Changed alert description and summary for the metrics.
  • Added full discovery support.
  • Bulk API enhancements and Handled API exceptions.
1.0.1Bug fix.
1.0.0Resource discovery and monitoring implementations.

Introduction

In a virtual environment, Zerto, a Hewlett Packard Enterprise company is a ransomware resilience, disaster recovery (DR), and multi-cloud mobility solution that offers write-order fidelity near-synchronous replication with no impact on product workloads. Workloads may be secured, moved, and recovered either inside the same hypervisor environment, across hypervisor environments, and/ or to and from public cloud sites like Azure. Both the protected and the recovery locations have Zerto installed. A browser-based user interface controls the catastrophe recovery across various sites. Zerto may also be managed programmatically through a Swagger (REST API) interface.

Built for enterprise scale, Zerto’s simple, software only solution uses continuous data protection (CDP) to eliminate the risks and complexity of modernization and cloud adoption by empowering companies to run an always-on business by simplifying the protection, recovery, and mobility of on-premises and cloud applications.

Except for the actual replication of data, Zerto Virtual Manager Appliance (ZMVA) is a Linux-based service that controls everything needed for replication across protection and recovery locations. The Zerto User Interface maintains this protection once the ZVMA communicates with the hypervisor administration user interface, such as vCenter Server or Microsoft SCVMM, to obtain the inventory of VMs, discs, networks, hosts, etc. Moreover, the ZVMA keeps track of modifications to the hypervisor environment and reacts appropriately.

Prerequisites

  • OpsRamp Classic Gateway 14.0.0 and above.
  • OpsRamp NextGen Gateway 14.0.0 and above.
    Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.

Hierarchy of Zerto resources

     - Zerto Virtual Manager Local Site

               - Zerto Virtual Machine
               - Zerto Volume
               - Zerto Virtual Protection Group
               - Zerto Virtual Replication Appliance

Supported Metrics

Click here to view the supported metrics
Native TypeMetric NameDisplay NameMetric LabelUnitApplication VersionDescription
Zerto Virtual Manager Local Sitezerto_alert_statisticsZerto Alert StatisticsAvailability1.0.0Provides Zerto Alert Statistics
zerto_localsite_BandwidthThrottlingZerto LocalSite Bandwidth ThrottlingUsageMB1.0.0Zerto local site bandwidth throttling
zerto_localsite_PeersitePairingStatusZerto PeerSite Pairing StatusAvailability1.0.0Zerto peer site pairing status. Possible values are - Paired: 0, Pairing: 1, Unpaired: 2
zerto_resource_APIStatsZerto Resource API StatisticsUsage2.0.0Provides the number of API calls made within the frequency and resources.
Zerto Volumezerto_volume_SizeUsageZerto Volume Size UsageUsageGB1.0.0The used size of the volume.
Zerto Virtual Protection Groupzerto_vpg_StatusZerto VPG StatusAvailability1.0.0The status of the VPG. Possible values are - Initializing: 0,MeetingSLA: 1,NotMeetingSLA: 2,RpoNotMeetingSLA: 3,HistoryNotMeetingSLA: 4,FailingOver: 5,Moving: 6,Deleting:7,Recovered: 8
zerto_vpg_SubStatusZerto VPG SubstatusAvailability1.0.0The substatus of the VPG. Possible values are- None: 0 InitialSync: 1 Creating: 2 VolumeInitialSync: 3 Sync: 4 RecoveryPossible: 5 DeltaSync: 6 NeedsConfiguration: 7 Error: 8 EmptyProtectionGroup: 9 DisconnectedFromPeerNoRecoveryPoints: 10 FullSync: 11 VolumeDeltaSync: 12 VolumeFullSync: 13 FailingOverCommitting: 14 FailingOverBeforeCommit: 15 FailingOverRollingBack: 16 Promoting: 17 MovingCommitting: 18 MovingBeforeCommit: 19 MovingRollingBack: 20 Deleting 21 PendingRemove: 22 BitmapSync: 23 DisconnectedFromPeer: 24 ReplicationPausedUserInitiated: 25 ReplicationPausedSystemInitiated: 26 RecoveryStoragePolicyError: 27 Backup: 28 RollingBack: 29 RecoveryStorageError: 30 JournalStorageError: 31 VmNotProtectedError: 32 JournalOrRecoveryMissingError: 33 AddedVmsInInitialSync: 34 ReplicationPausedForMissingVolume: 35 StoppingFotFailure: 36 RollingBackFailOverLiveFailure: 37 RollingBackMoveFailure: 38 SplittingCommitting: 39 PreparePreseed: 40 JournalVmRestore: 41
zerto_vpg_ActualRPOZerto VPG Actual RPOPerformance1.0.0zerto VPG actual RPO. A value of -1 means that the RPO has not been calculated.
zerto_vpg_ThroughputZerto VPG ThroughputPerformanceMBps1.0.0The MBs for all the applications running on the virtual machines being protected in the VPG.
zerto_vpg_IOPSZerto VPG IOPSPerformanceIOPS1.0.0The IO per second between all the applications running on the virtual machines in the VPG and the VRAs that sends a copy to the remote site for replication.
zerto_vpg_PriorityZerto VPG PriorityAvailability1.0.0Priority specified for the VPG. Possible values are- Low: 0, Medium: 1, High: 2
zerto_vpg_StorageUsedZerto VPG Storage UsedUsageMB1.0.0The storage used by the virtual machines in the VPG at the recovery site.
zerto_vpg_DaysSinceFailoverLastTestZerto VPG DaysSinceLastFailoverTestAvailabilityDays1.0.0Days since the last failover test occurred.
zerto_vpg_HistorySLACriticalZerto VPG HistorySLACriticalAvailability1.0.0VPG status history SLA critical. Possible values are: other: 0, HistoryNotMeetingSLA: 4
zerto_vpg_RPOSLACriticalZerto VPG RPOSLACriticalAvailability1.0.0VPG status RPO SLA critical. Possible values are: other: 0, RpoNotMeetingSLA: 3
zerto_vpg_Needs_ConfigurationZerto VPG Needs ConfigurationNo category2.0.0VPG needs configuration as one or more configuration settings are missing. Possible values are: other : 0, NeedsConfiguration : 7
zerto_vpg_ErrorZerto VPG ErrorAvailability2.0.0VPG substatus error. Possible values are: other : 0, Error : 8
zerto_vpg_EmptyProtectionGroupZerto VPG EmptyProtectionGroupAvailability2.0.0VPG substatus empty protection group. Possible values are: other : 0, EmptyProtectionGroup : 9
zerto_vpg_DisconnectedFromPeerZerto VPG DisconnectedFromPeerAvailability2.0.0VPG is disconnected from peer. Possible values are: other : 0, DisconnectedFromPeerNoRecoveryPoints:10, DisconnectedFromPeer:24
zerto_vpg_RecoveryStorageErrorZerto VPG RecoveryStorageErrorAvailability2.0.0There was an I/O error to the recovery storage. Possible values are: other : 0, RecoveryStorageProfileError : 27,RecoveryStorageError:30
zerto_vpg_JournalStorageErrorZerto VPG JournalStorageErrorAvailability2.0.0There was an I/O error in the journal. Possible values are: other : 0, JournalStorageError : 31,JournalOrRecoveryMissingError:33
zerto_vpg_ReplicationPausedZerto VPG ReplicationPausedAvailability2.0.0VPG replication paused. Possible values are: other : 0 ,ReplicationPausedUserInitiated : 25,ReplicationPausedSystemInitiated:26
Zerto Virtual Machinezerto_vm_StorageUsedZerto VM Storage UsedUsageMB1.0.0Virtual machine in current site space usage
zerto_vm_JournalStorageUsedZerto VM Journal Storage UsedUsageMb1.0.0Virtual machine in current site journal storage space usage
zerto_vm_ActualRPOZerto VM Actual RPOPerformance1.0.0Virtual machine in current site actual RPO
zerto_vm_IOPSZerto VM IOPSPerformanceIOPS1.0.0Virtual machine in current site IOPS
zerto_vm_ThroughputZerto VM ThroughputPerformanceMBps1.0.0Virtual machine in current site throughput
zerto_vm_OutgoingBandwidthZerto VM Outgoing BandwidthPerformanceMbps1.0.0Virtual machine in current site outgoing bandwidth
Zerto Virtual Replication Appliancezerto_vra_StatusZerto VRA StatusAvailability1.0.0-Zerto VRA status. Possible values are: Installed: 0 UnsupportedEsxVersion: 1 NotInstalled: 2 Installing: 3 Removing: 4 InstallationError: 5 HostPasswordChanged: 6 UpdatingIpSettings: 7 DuringChangeHost: 8 HostInMaintenanceMode: 9 HostEnteringMaintenanceMode: 10

Default Monitoring Configurations

Zerto has default Global Device Management Policies, Global Templates, Global Monitors and Global Metrics in OpsRamp. You can customize these default monitoring configurations as per your business use cases by cloning respective Global Templates and Global Device Management Policies. We recommend doing this activity before installing the application to avoid noise alerts and data.

  1. Default Global Device Management Policies

    You can find the Device Management Policy for each Native Type at Setup > Resources > Device Management Policies. Search with suggested name in global scope. Each Device Management Policy follows below naming convention:

    {appName nativeType - version}

    Ex: zerto Zerto Virtual Manager Local Site - 1 (i.e, appName = zerto, nativeType = Zerto Virtual Manager Local Site, version = 1)

  2. Default Global Templates

    You can find the Global Templates for each Native Type at Setup > Monitoring > Templates. Search with suggested names in global scope. Each template follows below naming convention:

    {appName nativeType 'Template' - version}

    Ex: zerto Zerto Virtual Manager Local Site Template - 1 (i.e, appName = zerto, nativeType = Zerto Virtual Manager Local Site, version = 1)

  3. Default Global Monitors

    You can find the Global Monitors for each Native Type at Setup > Monitoring > Monitors. Search with suggested name in global scope. Each Monitors follows below naming convention:

    {monitorKey appName nativeType - version}

    Ex: Zerto Virtual Manager Local Site Monitor zerto Zerto Virtual Manager Local Site 1 (i.e, monitorKey = Zerto Virtual Manager Local Site Monitor, appName = zerto, nativeType = Zerto Virtual Manager Local Site, version = 1)

Configure and Install the Zerto Integration

  1. From All Clients, select a client.
  2. Navigate to Setup > Account.
  3. Select the Integrations tab.
  4. The Installed Integrations page, where all the installed integrations are displayed. Click + ADD on the Installed Integrations page.
  5. If you do not have any installed applications, you will be navigated to the Available Integrations page. The Available Integrations page displays all the available applications along with the newly created application with the version.
    Note: Search for the application using the search option available. Alternatively, use the All Categories option to search.
  6. Click ADD in the Zerto application.
    Note: Select the latest application version from the dropdown list.
  7. In the Configuration page, click + ADD. The Add Configuration page appears.
  8. Enter the below mentioned BASIC INFORMATION:
FunctionalityDescription
NameEnter the name for the configuration.
ZVM IP Address/Host NameHost name or the IP address provided for the ZVM.
ZVM REST API PortAPI Port information

Note: By default 443 is added.
API Authentication TypeAPI Authentication type is displayed. Select one of the below API Authentication type from the dropdown:
  • Session Token
  • OAUTH2
Notes:
  • By default Session Token is selected.
  • When you select OAUTH2 Client Id, and Grant Type is displayed.
  • By default the Grant Type is Password.
CredentialSelect the Credential from the drop-down list.

(Optional): Click + Add to create a credential. The ADD CREDENTIAL window is displayed. Enter the following information.
  • Name: Credential name.
  • Description: Brief description of the credential.
  • User Name: User name.
  • Password: Password.
  • Confirm Password: Confirm password

Notes:

  • By default the Is Secure checkbox is selected.
  • IP Address/Host Name and Port Should be accessible from Gateway.
  • Select the following:
    • App Failure Notifications: if turned on, you will be notified in case of an application failure that is, Connectivity Exception, Authentication Exception.
    • Event/Alert Polling: enables integrating third party alerts into OpsRamp using further configurations.
      • Below are the default values set for:
        • Alert Severity: Possible values of Alert Severity Filter configuration property are “Error”,“Warning”.
        • Alert Severity Mapping: Possible values of Alert Severity Mapping Filter configuration property are “Error”:“Critical”,“Warning”:“Warning”.
  1. Select the below mentioned Custom Attribute:
FunctionalityDescription
Custom AttributeSelect the custom attribute from the drop down list box.
ValueSelect the value from the drop down list box.

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

  1. In the RESOURCE TYPE section, select:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  2. In the DISCOVERY SCHEDULE section, select Recurrence Pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.
Zerto

Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.

  1. Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.

    Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.

  2. Click NEXT.

  3. (Optional) Click +ADD to create a new collector. You can either use the pre-populated name or give the name to your collector.

Veeam
  1. Select an existing registered profile.
Veeam
  1. Click FINISH.

The integration is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify the Configuration

View the Zerto Details

To discover resources for Zerto:

  1. Navigate to Infrastructure > Search > BACKUP AND RECOVERY > Zerto.
  2. The Zerto page is displayed, select the application name.
  3. The RESOURCE page appears from the right.
  4. Click the ellipsis () on the top right and select View Details.
Zerto
  1. Navigate to the Attributes tab to view the discovery details.
Zerto
  1. Click the Metrics tab to view the metric details for Zerto.

View resource metrics

To confirm Zerto monitoring, review the following:

  • Metric graphs: A graph is plotted for each metric that is enabled in the configuration.
  • Alerts: Alerts are generated for metrics that are configured as defined for integration.
Zerto

Resource Type Filter Keys

Zerto application Resources are filtered and discovered based on below keys.
Note: We can filter the resources with the discoverable keys only.

Click here to view the Supported Input Keys
Resource TypeResource Type
All TypesresourceName
hostName
aliasName
dnsName
ipAddress
macAddress
os
make
model
serialNumber
Zerto Virtual Manager Local SiteLocation
Site Type
Version
Zerto Virtual MachineRoot Resource IPAddress
Root Resource ResourceType
Source Site
Target Site
Vpg Name
Zerto VolumeIs Thin Provisioned
Owning Vm Identifier
Owning Vm Name
Root Resource IPAddress
Root Resource ResourceType
VolumeType
Zerto Virtual Protection GroupActual History InMinutes
Configured History InMinutes
Configured Rpo Seconds
Earliest Checkpoint Identifier
Earliest Checkpoint TimeStamp
Earliest Checkpoint Type
LastTest
Root Resource IPAddress
Target Site
Vms Count
Vpg Type
Zerto Virtual Replication ApplianceHost Version
Root Resource IPAddress
Root Resource ResourceType
Vra Version

Supported Alert Custom Macros

Customize the alert subject and description with below macros then it will generate alert based on customisation.
Supported macros keys:

Click here to view the alert subject and description with macros

                                ${resource.name}

                                ${resource.ip}

                                ${resource.mac}

                                ${resource.aliasname}

                                ${resource.os}

                                ${resource.type}

                                ${resource.dnsname}

                                ${resource.alternateip}

                                ${resource.make}

                                ${resource.model}

                                ${resource.serialnumber}

                                ${resource.systemId}

                                ${Custome Attributes in the resource}

                                ${parent.resource.name}

Risks, Limitations & Assumptions

  • Application can handle Critical/Recovery failure notifications for below two cases when user enables App Failure Notifications in configuration
    • Connectivity Exception
    • Authentication Exception
  • The application will send duplicate/repeat failure alert notifications for every 6 hours.
  • Application cannot control monitoring pause/resume actions based on above alerts Metrics can be used to monitor Zerto resources and can generate alerts based on the threshold values.
  • We have provided 443 as default Port value for processing ZVM Rest APIs. Users can modify this value from the application configuration page at any point of time if required.
  • Zerto Event/Alert polling will start only if the user enables Event/Alert Polling in configuration.
  • Possible values of Alert Severity Filter configuration are Error, Warning.
  • Default values of Help Identifier Filter configuration are ZVM0001, ZVM0002, ZVM0003, ZVM0004, etc.
  • We have provided default mappings to map Zerto Severity with OpsRamp Severities as part of Alert Severity Mapping configuration. Users can modify them as per their use-case at any point of time from the application configuration page. Possible Severities are Critical, Warning, Ok, Info.
  • We use GET /v1/alerts API for alerts polling functionality and below is the flow of execution:
    • For the first poll request, we consider the alerts which have is_dismissed=false and Alert Severity Filter, Help Identifier Filter and Alert Severity Mapping configuration details to parse and publish the critical/warning alerts and store those alert unique identifiers at app level to use them in further monitoring request processings.
    • From second polling onwards, application checks whether previously polled alerts are healed (i., is_dismissed=true) or not using current poll requests API response and create OK alerts for them accordingly.
    • The application checks whether any new alerts with is_dismissed=false are present in the current poll request’s API response and poll those critical/warning alerts and store the unique identifiers accordingly for further processings.
  • No support of showing activity logs.
  • The Template Applied Time will only be displayed if the collector profile (Classic and NextGen Gateway) is version 18.1.0 or higher.
  • The minimum supported version for the option to get Latest snapshot metric is nextgen-14.0.0.
  • Full discovery support requires gateway version 15.0.0 or above.
  • Application is not compatible with Cluster Gateway.