Supported Target Versions
Zerto local site version 9.0.41

Application Version and Upgrade Details

Application VersionBug fixes / Enhancements
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.
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.
Click here to view the earlier version updates
Application VersionBug fixes / Enhancements
1.0.0Resource discovery and monitoring implementations.

Introduction

In a virtual environment, Zerto offers a business continuity (BC) and disaster recovery (DR) solution that offers write-order fidelity replication in close to real time with no impact on product workloads. Workloads may be secured, moved, and recovered either inside the same hypervisor environment or across hypervisor environments thanks to support for various hypervisors like vSphere or Hyper-V and 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 using PowerShell cmdlets or a series of HTTP APIs.

By eliminating the risk and complexity of modernization and cloud adoption, Zerto assists companies in accelerating IT transformation. Zerto is reinventing disaster recovery, retention, and cloud management by swapping out several antiquated technologies with a single IT Resilience PlatformTM. This is accomplished by giving cloud and virtualized infrastructure settings access to enterprise-class disaster recovery and business continuity technologies.

Except for the actual replication of data, ZVM is a Windows service that controls everything needed for replication across protection and recovery locations. The Zerto User Interface maintains this protection once the ZVM 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 ZVM 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

Default Monitoring Configurations

Zerto have default Global Device Management Policies, Global Templates, Global Monitors and Global metrics in OpsRamp. Users can customize these default monitoring configurations as per their business use cases by cloning respective global templates and global Device Management Policies. OpsRamp recommends doing this activity before installing the app to avoid noise alerts and data.

  1. Default Global Device Management Policies

    OpsRamp has a Global Device Management Policy for each Native Type of Zerto. You can find those Device Management Policies at Setup > Resources > Device Management Policies, search with suggested names 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

    OpsRamp has a Global template for each Native Type of Zerto. You can find those templates 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

    OpsRamp has a Global Monitors for each Native Type which has monitoring support. You can find those monitors at Setup > Monitoring > Monitors, search with suggested names 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. Go to Setup > Account.
  3. Select the Integrations and Apps tab.
  4. The Installed Integrations page, where all the installed applications are displayed. Note: If there are no installed applications, it will navigate to the ADD APP page.
  5. Click + ADD on the Installed Integrations page. The Available Integrations and Apps page displays all the available applications along with the newly created application with the version.
    Note: You can even search for the application using the search option available. Also you can use the All Categories option to search.
Zerto
  1. Click ADD in the Zerto application.
  2. In the Configuration page, click + ADD. The Add Configuration page appears.
  3. 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 9669 is added.
CredentialsSelect the credentials from the drop-down list.

Note: Click + Add to create a credential.

Notes:

  • By default the Is Secure checkbox is selected.
  • ZVM IP Address/Host Name and ZVM REST API 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. Click NEXT.
  2. Below are the optional steps you can perform on the Installation page.
  • 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.

Cisco FirePower
  • Click +ADD to create a new collector by providing a name or use the pre-populated name.
Aruba Airwave Integrations
  1. Select an existing registered profile.
Aruba Airwave Integrations
  1. Click FINISH.

The application is now installed and displayed on the Installed Integration page. Use the search field to find the installed application.

Modify the Configuration

View the Zerto Details

The discovered resource(s) are displayed in Infrastructure > Resources > Zerto, with Native Resource Type as Zerto Virtual Manager Local Site. You can navigate to the Attributes tab to view the discovery details, and the Metrics tab to view the metric details for Zerto.

Zerto
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}

Supported Metrics

Click here to view the supported metrics
Native TypeMetric NameDisplay NameUnitApplication VersionDescription
Zerto Virtual Manager Local Sitezerto_alert_statisticsZerto Alert Statistics1.0.0Provides Zerto Alert Statistics
zerto_localsite_BandwidthThrottlingZerto LocalSite Bandwidth ThrottlingMB1.0.0Zerto local site bandwidth throttling
zerto_localsite_PeersitePairingStatusZerto PeerSite Pairing Status1.0.0Zerto peer site pairing status. Possible values are - Paired: 0, Pairing: 1, Unpaired: 2
zerto_resource_APIStatsZerto Resource API Statistics2.0.0Provides the number of API calls made within the frequency and resources.
Zerto Volumezerto_volume_SizeUsageZerto Volume Size UsageGB1.0.0The used size of the volume.
Zerto Virtual Protection Groupzerto_vpg_StatusZerto VPG Status1.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 Substatus1.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 RPO1.0.0zerto VPG actual RPO. A value of -1 means that the RPO has not been calculated.
zerto_vpg_ThroughputZerto VPG ThroughputMBps1.0.0The MBs for all the applications running on the virtual machines being protected in the VPG.
zerto_vpg_IOPSZerto VPG IOPSIOPS1.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 Priority1.0.0Priority specified for the VPG. Possible values are- Low: 0, Medium: 1, High: 2
zerto_vpg_StorageUsedZerto VPG Storage UsedMB1.0.0The storage used by the virtual machines in the VPG at the recovery site.
zerto_vpg_DaysSinceFailoverLastTestZerto VPG DaysSinceLastFailoverTestDays1.0.0Days since the last failover test occurred.
zerto_vpg_HistorySLACriticalZerto VPG HistorySLACritical1.0.0VPG status history SLA critical. Possible values are: other: 0, HistoryNotMeetingSLA: 4
zerto_vpg_RPOSLACriticalZerto VPG RPOSLACritical1.0.0VPG status RPO SLA critical. Possible values are: other: 0, RpoNotMeetingSLA: 3
zerto_vpg_Needs_ConfigurationZerto VPG Needs Configuration2.0.0VPG needs configuration as one or more configuration settings are missing. Possible values are: other : 0, NeedsConfiguration : 7
zerto_vpg_ErrorZerto VPG Error2.0.0VPG substatus error. Possible values are: other : 0, Error : 8
zerto_vpg_EmptyProtectionGroupZerto VPG EmptyProtectionGroup2.0.0VPG substatus empty protection group. Possible values are: other : 0, EmptyProtectionGroup : 9
zerto_vpg_DisconnectedFromPeerZerto VPG DisconnectedFromPeer2.0.0VPG is disconnected from peer. Possible values are: other : 0, DisconnectedFromPeerNoRecoveryPoints:10, DisconnectedFromPeer:24
zerto_vpg_RecoveryStorageErrorZerto VPG RecoveryStorageError2.0.0There was an I/O error to the recovery storage. Possible values are: other : 0, RecoveryStorageProfileError : 27,RecoveryStorageError:30
zerto_vpg_JournalStorageErrorZerto VPG JournalStorageError2.0.0There was an I/O error in the journal. Possible values are: other : 0, JournalStorageError : 31,JournalOrRecoveryMissingError:33
zerto_vpg_ReplicationPausedZerto VPG ReplicationPaused2.0.0VPG replication paused. Possible values are: other : 0 ,ReplicationPausedUserInitiated : 25,ReplicationPausedSystemInitiated:26
Zerto Virtual Machinezerto_vm_StorageUsedZerto VM Storage UsedMB1.0.0Virtual machine in current site space usage
zerto_vm_JournalStorageUsedZerto VM Journal Storage UsedMb1.0.0Virtual machine in current site journal storage space usage
zerto_vm_ActualRPOZerto VM Actual RPO1.0.0Virtual machine in current site actual RPO
zerto_vm_IOPSZerto VM IOPSIOPS1.0.0Virtual machine in current site IOPS
zerto_vm_ThroughputZerto VM ThroughputMBps1.0.0Virtual machine in current site throughput
zerto_vm_OutgoingBandwidthZerto VM Outgoing BandwidthMbps1.0.0Virtual machine in current site outgoing bandwidth
Zerto Virtual Replication Appliancezerto_vra_StatusZerto VRA Status1.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

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
  • Application will not send any duplicate/repeat failure alert notification until the already existing critical alert is recovered.
  • 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.
  • OpsRamp has provided 9669 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.
  • Possible values of Help Identifier Filter configuration are ZVM0001, ZVM0002, ZVM0003, ZVM0004, etc.
  • OpsRamp has 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 OpsRamp Severities are Critical, Warning, Ok, Info.
  • Opsramp uses the GET /v1/alerts API for alerts polling functionality and below is the flow of execution:
    • For the first poll request, OpsRamp considers 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.
  • Component level thresholds can be configured on each resource level.
  • No support of showing activity log and applied time.
  • 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.