From 821ff9b9efe1ccf94060eff6e95a4ffeb5614ac6 Mon Sep 17 00:00:00 2001 From: Justin Paul Date: Fri, 8 May 2026 14:16:07 -0400 Subject: [PATCH] Add ZVMA pre/post script recipe + env-dump examples Adds a Kubernetes-ZVMA companion to the existing Windows-ZVM recipe: - scripts/examples/zerto-zvma-send.ps1 - Zerto-side sender for both pre and post phases, packages the Zerto* env vars into a structured JSON body and POSTs to a {phase}-templated webhook URL. - scripts/examples/zerto-receiver-notify.ps1 - server-side receiver that posts a Slack/Teams notification, with phase-aware formatting and ZertoForce highlighted on pre. - scripts/examples/zerto-receiver-vm-healthcheck.ps1 - server-side receiver that pings + port-probes each VM in VmDisplayNames after failover and writes a per-run JSON report. - scripts/examples/send-env-vars.ps1 + save-env-vars.ps1 - generic env-dump client/receiver pair (the diagnostic that surfaced what the ZVMA scripts-service container exposes). - docs/recipes/zerto-zvma-pre-post.md - full walkthrough mirroring the existing Windows-ZVM recipe's structure. - README.md and docs/README.md - link the new recipe and examples. Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 5 +- docs/README.md | 5 +- docs/recipes/zerto-zvma-pre-post.md | 277 ++++++++++++++++++ scripts/examples/save-env-vars.ps1 | 46 +++ scripts/examples/send-env-vars.ps1 | 68 +++++ scripts/examples/zerto-receiver-notify.ps1 | 90 ++++++ .../zerto-receiver-vm-healthcheck.ps1 | 140 +++++++++ scripts/examples/zerto-zvma-send.ps1 | 74 +++++ 8 files changed, 701 insertions(+), 4 deletions(-) create mode 100644 docs/recipes/zerto-zvma-pre-post.md create mode 100644 scripts/examples/save-env-vars.ps1 create mode 100644 scripts/examples/send-env-vars.ps1 create mode 100644 scripts/examples/zerto-receiver-notify.ps1 create mode 100644 scripts/examples/zerto-receiver-vm-healthcheck.ps1 create mode 100644 scripts/examples/zerto-zvma-send.ps1 diff --git a/README.md b/README.md index 0d450df..458f761 100644 --- a/README.md +++ b/README.md @@ -61,11 +61,12 @@ Everything you need to operate the server: Recipes: -- [Zerto failover post-script → DNS + service checks](docs/recipes/zerto-pre-post-scripts.md) ← **canonical use case** +- [Zerto failover post-script → DNS + service checks](docs/recipes/zerto-pre-post-scripts.md) ← **canonical use case** (Windows ZVM) +- [Zerto ZVMA (Kubernetes) pre/post → notify + VM health check](docs/recipes/zerto-zvma-pre-post.md) — same pattern for the in-cluster scripts-service - [GitHub-style HMAC-signed webhook](docs/recipes/github-style-hmac.md) - [Pop UI on the user's desktop](docs/recipes/ui-on-desktop.md) -A ready-to-drop-in Zerto-side script is included at [`scripts/examples/zerto-post-failover.ps1`](scripts/examples/zerto-post-failover.ps1). +Ready-to-drop-in Zerto-side scripts are included at [`scripts/examples/zerto-post-failover.ps1`](scripts/examples/zerto-post-failover.ps1) (Windows ZVM) and [`scripts/examples/zerto-zvma-send.ps1`](scripts/examples/zerto-zvma-send.ps1) (ZVMA / Kubernetes); receiver examples for the ZVMA recipe ship as [`zerto-receiver-notify.ps1`](scripts/examples/zerto-receiver-notify.ps1) and [`zerto-receiver-vm-healthcheck.ps1`](scripts/examples/zerto-receiver-vm-healthcheck.ps1). ## Requirements diff --git a/docs/README.md b/docs/README.md index c4e5630..b61338f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,11 +19,12 @@ Webhook Server is a Windows service that runs a script (PowerShell, cmd, or any ## Recipes (cookbook style) -- [Zerto failover post-script → DNS + service checks](recipes/zerto-pre-post-scripts.md) ← canonical use case +- [Zerto failover post-script → DNS + service checks](recipes/zerto-pre-post-scripts.md) ← canonical use case (Windows ZVM) +- [Zerto ZVMA (Kubernetes) pre/post → notify + VM health check](recipes/zerto-zvma-pre-post.md) — same pattern for the in-cluster scripts-service - [GitHub-style HMAC-signed webhook](recipes/github-style-hmac.md) - [Pop UI on the user's desktop](recipes/ui-on-desktop.md) -The flagship Zerto recipe also ships with a **ready-to-use Zerto-side post-script** at [`scripts/examples/zerto-post-failover.ps1`](../scripts/examples/zerto-post-failover.ps1). +The flagship Zerto recipe ships with a ready-to-use Zerto-side post-script at [`scripts/examples/zerto-post-failover.ps1`](../scripts/examples/zerto-post-failover.ps1). The ZVMA recipe ships with [`zerto-zvma-send.ps1`](../scripts/examples/zerto-zvma-send.ps1) (sender) plus [`zerto-receiver-notify.ps1`](../scripts/examples/zerto-receiver-notify.ps1) and [`zerto-receiver-vm-healthcheck.ps1`](../scripts/examples/zerto-receiver-vm-healthcheck.ps1) (receivers). ## Reference diff --git a/docs/recipes/zerto-zvma-pre-post.md b/docs/recipes/zerto-zvma-pre-post.md new file mode 100644 index 0000000..7b8b459 --- /dev/null +++ b/docs/recipes/zerto-zvma-pre-post.md @@ -0,0 +1,277 @@ +# Recipe: Zerto ZVMA (Kubernetes) pre/post scripts → notify + VM health check + +> Companion to [Zerto failover post-script → DNS + service checks](zerto-pre-post-scripts.md). +> That recipe targets the **Windows ZVM** (the older deployment, where the +> Zerto-side script is a `.ps1` calling `curl.exe`). **This** recipe targets +> the **ZVMA on Kubernetes** — the newer deployment, where pre/post scripts +> run inside the in-cluster `scripts-service` container (Linux + pwsh 7). +> The webhook-server side is the same Windows service in both cases; only +> the Zerto-side runtime differs. + +## What we're building + +ZVMA's `scripts-service` pod runs your VPG pre/post scripts inside a Linux +container. It exposes a small set of `Zerto*` environment variables, and we +want to: + +1. POST those variables to a Webhook Server endpoint at the start (pre) and + end (post) of every VPG operation, and +2. On the receiving Windows host, do something useful with them — at minimum + a chat notification, and on `post` a quick health check of the VMs that + just powered on. + +The endpoints are **Async**, so the Zerto VPG sequence is never blocked by +slow downstream actions (notifications, port probes, etc.). + +``` +Zerto VPG operation starts + | + +-- ZVMA scripts-service container runs: + | /app/scripts-files/zerto-zvma-send.ps1 -Phase pre + | -> POST http://webhook.dr/hook/zerto-pre (async, returns 202) + | + +-- VMs come up at recovery site + | + +-- ZVMA scripts-service container runs: + /app/scripts-files/zerto-zvma-send.ps1 -Phase post + -> POST http://webhook.dr/hook/zerto-post (async, returns 202) + +(meanwhile, on the webhook server) + /hook/zerto-pre -> Slack/Teams notification ("Test failover starting...") + /hook/zerto-post -> Slack/Teams notification + ping/port probe each VM, + write a JSON report to disk, exit non-zero on failure. +``` + +## What ZVMA exposes + +Captured from a real Test failover; same set is present in pre and post: + +| Variable | Example | Notes | +|---|---|---| +| `ZertoVPGName` | `ubuntu-2404-local` | The VPG that fired the script | +| `ZertoInternalVpgName` | `ubuntu-2404-local` | Usually identical to `ZertoVPGName` | +| `ZertoOperation` | `Test` | `Test` / `Failover` / `Move` / `FailoverBeforeCommit` / `FailoverDuringCommit` | +| `ZertoForce` | `Yes` (pre) / `No` (post) | Set to `Yes` only during the pre phase when force mode is on; reset to `No` by post | +| `VmDisplayNames` | `ubuntu-2404(1)(1)(1)` | Comma-separated for multi-VM VPGs; Test failovers add `(N)` suffixes | +| `ZertoHypervisorManagerIP` | `192.168.50.20` | The vCenter / Hyper-V manager ZVMA is talking to | +| `ZertoHypervisorManagerPort` | `443` | | +| `ZertoOutputDir` | `/app/scripts-output` | Container-side output dir (written back to ZVMA via PVC) | +| `ZertoWorkingDir` | `/app/scripts-files` | Where script files live in-container | + +Branch on `ZertoOperation` to differentiate Test runs from real failovers. +**`ZertoForce` is only meaningful during the pre phase** — capture it there +if you need it later, because by post it's been reset. + +## 1. The Zerto-side script (sender) + +A ready-to-use script ships in this repo at +[`scripts/examples/zerto-zvma-send.ps1`](../../scripts/examples/zerto-zvma-send.ps1). +Place it where the `scripts-service` pod can read it — typically the +`scripts-service-scripts-files-pvc`, mounted at `/app/scripts-files/` — and +wire it into the VPG twice: + +> **VPG settings → Recovery → Scripts → Pre-Recovery Script** +> Path: `/app/scripts-files/zerto-zvma-send.ps1` +> Parameters: `-Phase pre` +> +> **VPG settings → Recovery → Scripts → Post-Recovery Script** +> Path: `/app/scripts-files/zerto-zvma-send.ps1` +> Parameters: `-Phase post` + +The default `$WebhookUrl` includes `{phase}` so one script + one URL config +serves both phases — `http://webhook.dr/hook/zerto-{phase}` becomes +`/hook/zerto-pre` and `/hook/zerto-post` automatically. Override with +`-WebhookUrl` and `-Bearer` if you'd rather pass them per-VPG. + +The script POSTs a single JSON object: + +```json +{ + "phase": "pre", + "capturedAt": "2026-05-08T17:45:54Z", + "host": "scripts-service-f9b6cb7-4xbxq", + "zerto": { + "vpgName": "ubuntu-2404-local", + "internalVpgName": "ubuntu-2404-local", + "operation": "Test", + "force": "Yes", + "vmDisplayNames": "ubuntu-2404(1)(1)(1)", + "hypervisorManagerIP": "192.168.50.20", + "hypervisorManagerPort": "443", + "outputDir": "/app/scripts-output", + "workingDir": "/app/scripts-files" + } +} +``` + +A webhook outage **does not fail the VPG** — the script catches and exits 0. +Comment in the file shows how to flip that to strict mode if you'd rather a +webhook outage abort the failover. + +## 2. The webhook-server-side scripts (receivers) + +Two examples ship in the repo. Both read the JSON body from stdin (the +webhook server delivers the body to the script's stdin when **JSON body to +stdin** is ticked on the endpoint). + +### a. Slack/Teams notification — both phases + +[`scripts/examples/zerto-receiver-notify.ps1`](../../scripts/examples/zerto-receiver-notify.ps1) +posts a single-line summary to a Slack or Teams Incoming Webhook URL. It +picks an icon based on `ZertoOperation`: + +- `Test` → 🧪 — benign, expected +- `Failover` → 🚨 — real production event +- `Move` → 🚚 — planned migration + +…and highlights `ZertoForce=Yes` on the **pre** message so you can see at +a glance whether the operation was force-flagged. + +Set the destination via `NOTIFY_URL` env var on the webhook host, or +hardcode at the top of the script. + +### b. Post-recovery VM health check — post phase only + +[`scripts/examples/zerto-receiver-vm-healthcheck.ps1`](../../scripts/examples/zerto-receiver-vm-healthcheck.ps1) +runs only on `phase=post` for operations that bring VMs up +(`Test`/`Failover`/`Move`/`FailoverBeforeCommit`/`FailoverDuringCommit`). +For each name in `VmDisplayNames` it: + +1. Strips the trailing `(1)(1)(1)` suffix Zerto adds on Test failovers, so + DNS resolution targets the actual hostname. +2. Pings (`Test-Connection`). +3. Probes a configurable TCP port (`-ProbePort`, default `3389` for RDP; + use `22` for SSH or `443` for the web tier). +4. Writes a JSON report to + `C:\ProgramData\WebhookServer\zerto-healthchecks\--.json`. +5. Exits non-zero if any VM failed either probe — which surfaces in the + webhook server's run history (and outbound callback, if configured). + +Bump the endpoint's **Timeout (sec)** to `120` when wiring this in, since +network probes can take a while. + +## 3. Configure the endpoints in the GUI + +Two endpoints. Identical except for the slug, the script, and (for the +healthcheck) the timeout. + +### `zerto-pre` + +| Section | Setting | Value | +|---|---|---| +| Identity | Slug | `zerto-pre` | +| Identity | Description | "Zerto pre-recovery: chat notification" | +| Auth | Mode | **Bearer** | +| Auth | Bearer secret | generate a 32-byte random string; reuse for `zerto-post` | +| Allowed clients | (one per line) | the IP of the K8s node running `scripts-service` (e.g. `192.168.50.30`) | +| Executor | Type | **Windows PowerShell** (or PowerShell 7) | +| Executor | Script path | `C:\scripts\zerto-receiver-notify.ps1` | +| Data passing | JSON body to stdin | ✓ | +| Run as | Identity | **Service** | +| Response | Mode | **Async** | +| Response | Timeout (sec) | `30` | +| Response | Fail on non-zero exit | unticked *(async hooks have no caller to receive a 502)* | + +### `zerto-post` + +Same as above, except: + +| Setting | Value | +|---|---| +| Slug | `zerto-post` | +| Description | "Zerto post-recovery: notify + VM health check" | +| Script path | a **wrapper** that calls both receiver scripts in turn (see below) | +| Timeout (sec) | `120` | + +Two receivers on one endpoint is easiest with a tiny wrapper that fans +stdin out to both scripts: + +```powershell +# C:\scripts\zerto-post-fanout.ps1 +$body = [Console]::In.ReadToEnd() +$body | & 'C:\scripts\zerto-receiver-notify.ps1' +$body | & 'C:\scripts\zerto-receiver-vm-healthcheck.ps1' +``` + +Or run the two as separate endpoints (`zerto-post-notify` and +`zerto-post-healthcheck`) and have the Zerto-side script POST to both — +either pattern is fine. The fanout wrapper keeps the Zerto config simpler. + +## 4. Wire up the bearer token + +On the ZVMA / scripts-service side, the easiest place to put the token is +a Kubernetes Secret mounted into the pod, but the simplest approach for +testing is to pass it as a parameter to the Zerto-side script: + +> VPG settings → Pre-Recovery Script → Parameters: +> `-Phase pre -Bearer ` +> +> VPG settings → Post-Recovery Script → Parameters: +> `-Phase post -Bearer ` + +For production, mount a Secret at a known path in the pod and have the +sender script read from it (`Get-Content /run/secrets/webhook-token`). + +## 5. Test before going live + +Run a Test failover on a non-critical VPG. Watch: + +- **Slack/Teams**: a `:test_tube: Zerto Test - phase: pre` message arrives, + followed ~30s–several minutes later by a `:test_tube: Zerto Test - phase: + post` message. +- **Webhook Server GUI** → run history: two runs for `zerto-pre` / + `zerto-post`, both green. +- **`C:\ProgramData\WebhookServer\zerto-healthchecks\`**: a fresh JSON + report named `-Test-.json` containing per-VM ping and port + probe results. +- **ZVMA**: the VPG operation completes successfully; nothing in the + pre/post logs blocked on the webhook. + +## Variations + +### Branch on Test vs. real failover in the receivers + +The notifier already styles the message differently. To do something only +on a real failover (e.g. update DNS), guard with: + +```powershell +if ($p.zerto.operation -ne 'Test') { + # do the destructive thing +} +``` + +A `ZertoOperation` of `Test` means "exercise — don't touch production +dependencies." Always check it before doing anything that mutates real +state. + +### Capture `ZertoForce` from pre for use in post + +`ZertoForce` is `Yes` only during the **pre** phase when force mode is on +and is reset to `No` by the **post** phase. If your post-side logic needs +to know the operation was force-flagged, save it during pre (e.g. write a +small marker to the shared `ZertoOutputDir`) and read it back during post. + +### Per-VPG endpoints + +For fine-grained access control or different actions per VPG, create one +endpoint per VPG (`zerto-pre-app01`, `zerto-post-app01`, …) with its own +bearer token. Override `-WebhookUrl` and `-Bearer` on the Zerto side per +VPG. + +### Audit trail + +Every endpoint can have an outbound **Callback** URL. Configure with your +SIEM's HTTP collector + an HMAC secret, and every run produces a JSON +record with runId, exit code, duration, stdout, and stderr — convenient +for compliance. + +## Security note + +The ZVMA `scripts-service` pod runs your scripts inside a Linux container +with broad reach into the management cluster — anything your script does +runs with whatever ServiceAccount that pod uses. Treat the script content +as privileged and make sure pre/post script edit rights are restricted to +trusted operators. If you're unfamiliar with the pod's RBAC posture, check +`Get-ChildItem Env:` from inside the container and look at +`/var/run/secrets/kubernetes.io/serviceaccount/` — that token is what your +scripts (and a malicious script) can use to talk to the K8s API. diff --git a/scripts/examples/save-env-vars.ps1 b/scripts/examples/save-env-vars.ps1 new file mode 100644 index 0000000..91d2d38 --- /dev/null +++ b/scripts/examples/save-env-vars.ps1 @@ -0,0 +1,46 @@ +<# +.SYNOPSIS + Server-side receiver for the env-dump webhook. Reads the JSON body from + stdin and writes it to a timestamped file on disk. + +.DESCRIPTION + Configure a webhook endpoint like this: + Executable: powershell.exe (or pwsh.exe) + Arguments: -NoProfile -ExecutionPolicy Bypass -File C:\path\to\save-env-vars.ps1 + Data passing: [x] Stdin JSON + Run As: Service (or any account that can write to $OutDir) + + Output goes to C:\ProgramData\WebhookServer\env-dumps\-.json + by default; override with -OutDir. +#> + +[CmdletBinding()] +param( + [string] $OutDir = 'C:\ProgramData\WebhookServer\env-dumps' +) + +$ErrorActionPreference = 'Stop' + +if (-not (Test-Path $OutDir)) { + New-Item -ItemType Directory -Path $OutDir -Force | Out-Null +} + +$body = [Console]::In.ReadToEnd() +if ([string]::IsNullOrWhiteSpace($body)) { + Write-Error 'Empty request body on stdin.' + exit 2 +} + +# Parse so we can pull the host name for the filename, and to fail fast on +# malformed JSON before writing it. +$parsed = $body | ConvertFrom-Json +$hostName = if ($parsed.host) { $parsed.host } else { 'unknown' } +$safeHost = ($hostName -replace '[^A-Za-z0-9_.-]', '_') +$stamp = (Get-Date).ToUniversalTime().ToString('yyyyMMddTHHmmssZ') +$path = Join-Path $OutDir "$safeHost-$stamp.json" + +# Persist the original body verbatim - keeps key ordering and avoids any +# round-trip surprises from ConvertTo-Json. +Set-Content -Path $path -Value $body -Encoding utf8 + +Write-Host "Saved $($body.Length) bytes to $path" diff --git a/scripts/examples/send-env-vars.ps1 b/scripts/examples/send-env-vars.ps1 new file mode 100644 index 0000000..ffc6527 --- /dev/null +++ b/scripts/examples/send-env-vars.ps1 @@ -0,0 +1,68 @@ +<# +.SYNOPSIS + Collects env vars from PowerShell and bash, packages them into a single + JSON object, and POSTs the result to a Webhook Server endpoint. + +.DESCRIPTION + Output JSON shape: + { + "host": "", + "capturedAt":"2026-05-08T12:34:56Z", + "pwsh": { "VAR": "value", ... }, + "bash": { "VAR": "value", ... } + } + + Pair this with `save-env-vars.ps1` on the server side - configure an + endpoint with StdinJson enabled and that script as the executable. +#> + +[CmdletBinding()] +param( + [string] $WebhookUrl = 'http://localhost:8080/hook/env-dump', + [string] $Bearer = '', + [string] $BashExe = 'bash' +) + +$ErrorActionPreference = 'Stop' + +# --- pwsh env vars -------------------------------------------------------- +$pwshVars = [ordered]@{} +Get-ChildItem Env: | Sort-Object Name | ForEach-Object { + $pwshVars[$_.Name] = $_.Value +} + +# --- bash env vars -------------------------------------------------------- +$bashVars = [ordered]@{} +$bashCmd = Get-Command $BashExe -ErrorAction SilentlyContinue +if ($null -ne $bashCmd) { + # `env -0` separates entries with NUL so values containing newlines stay intact. + $raw = & $bashCmd.Source -c 'env -0' 2>$null + if ($LASTEXITCODE -eq 0 -and $raw) { + foreach ($entry in ($raw -split "`0")) { + if ([string]::IsNullOrEmpty($entry)) { continue } + $eq = $entry.IndexOf('=') + if ($eq -lt 1) { continue } + $bashVars[$entry.Substring(0, $eq)] = $entry.Substring($eq + 1) + } + } +} else { + Write-Warning "bash not found on PATH (looked for '$BashExe'); 'bash' section will be empty." +} + +# --- assemble payload ----------------------------------------------------- +$payload = [ordered]@{ + host = $env:COMPUTERNAME + capturedAt = (Get-Date).ToUniversalTime().ToString('o') + pwsh = $pwshVars + bash = $bashVars +} + +$json = $payload | ConvertTo-Json -Depth 5 -Compress + +# --- POST ----------------------------------------------------------------- +$headers = @{ 'Content-Type' = 'application/json' } +if ($Bearer) { $headers['Authorization'] = "Bearer $Bearer" } + +Write-Host "POST $WebhookUrl ($($json.Length) bytes; pwsh=$($pwshVars.Count), bash=$($bashVars.Count))" +$response = Invoke-RestMethod -Method Post -Uri $WebhookUrl -Headers $headers -Body $json +$response | ConvertTo-Json -Depth 5 diff --git a/scripts/examples/zerto-receiver-notify.ps1 b/scripts/examples/zerto-receiver-notify.ps1 new file mode 100644 index 0000000..b99b13b --- /dev/null +++ b/scripts/examples/zerto-receiver-notify.ps1 @@ -0,0 +1,90 @@ +<# +.SYNOPSIS + Webhook-server-side receiver: posts a Slack/Teams notification when a VPG + fires its pre or post recovery script. + +.DESCRIPTION + Reads the JSON body from stdin (the payload sent by zerto-zvma-send.ps1), + builds a phase-aware message, and posts it to an Incoming Webhook URL. + + The message highlights: + - VPG name + operation type (Test / Failover / Move / ...) + - Whether ZertoForce was set (only relevant pre) + - VM display names included in the run + - Phase (pre vs post) so you can see the bracketing in chat + + Wire up two endpoints: + /hook/zerto-pre -> this script with -Phase pre (pass via args) + /hook/zerto-post -> this script with -Phase post + + Or one endpoint per phase, each pointing at this script. The script reads + `phase` from the JSON body, so the -Phase param is optional. + +.NOTES + Compatible with: + - Slack Incoming Webhooks (posts {"text": "..."}) + - Teams legacy connector "Incoming Webhook" (same body shape) + - Discord webhooks (use ?wait=true for body, but text is "content" not + "text" - tweak below) + + Endpoint config: + ExecutorType: WindowsPowerShell or PowerShell 7 + ScriptPath: C:\scripts\zerto-receiver-notify.ps1 + DataPassing: [x] Stdin JSON + ResponseMode: async (we don't need to block the VPG on a chat post) +#> + +[CmdletBinding()] +param( + [string] $NotifyUrl = $env:NOTIFY_URL # set on the Webhook Server host, or hardcode below +) + +$ErrorActionPreference = 'Stop' + +if (-not $NotifyUrl) { + # Fall back to a hardcoded URL if NOTIFY_URL env var isn't set. + # Replace with your Slack/Teams Incoming Webhook URL. + $NotifyUrl = 'https://hooks.slack.com/services/REPLACE/ME/HERE' +} + +$body = [Console]::In.ReadToEnd() +if ([string]::IsNullOrWhiteSpace($body)) { + Write-Error 'Empty stdin - expected JSON body from the webhook server.' + exit 2 +} +$p = $body | ConvertFrom-Json + +$z = $p.zerto +$phase = if ($p.phase) { $p.phase } else { 'unknown' } +$op = if ($z.operation) { $z.operation } else { 'unknown' } + +# Pick an icon based on operation. Test is benign; Failover/Move are real. +$icon = switch ($op) { + 'Test' { ':test_tube:' } + 'Failover' { ':rotating_light:' } + 'Move' { ':truck:' } + default { ':information_source:' } +} + +$forceTag = if ($phase -eq 'pre' -and $z.force -eq 'Yes') { ' *(FORCE)*' } else { '' } + +$lines = @( + "$icon *Zerto $op* - phase: ``$phase``$forceTag" + "VPG: ``$($z.vpgName)``" + "VMs: ``$($z.vmDisplayNames)``" + "Hypervisor mgr: ``$($z.hypervisorManagerIP):$($z.hypervisorManagerPort)``" + "Captured: $($p.capturedAt) (from $($p.host))" +) +$text = $lines -join "`n" + +$payload = @{ text = $text } | ConvertTo-Json -Compress + +try { + Invoke-RestMethod -Method Post -Uri $NotifyUrl ` + -ContentType 'application/json' -Body $payload -TimeoutSec 10 | Out-Null + Write-Host "[$phase] notified $op for VPG '$($z.vpgName)'" +} +catch { + Write-Error "Notification post failed: $($_.Exception.Message)" + exit 1 +} diff --git a/scripts/examples/zerto-receiver-vm-healthcheck.ps1 b/scripts/examples/zerto-receiver-vm-healthcheck.ps1 new file mode 100644 index 0000000..5942546 --- /dev/null +++ b/scripts/examples/zerto-receiver-vm-healthcheck.ps1 @@ -0,0 +1,140 @@ +<# +.SYNOPSIS + Webhook-server-side receiver: post-failover VM health check. Pings each + VM in the VPG and probes a configurable TCP port; writes a per-run + report to disk. + +.DESCRIPTION + Intended for the POST-recovery webhook only - on a Test or real Failover, + once the VMs are powered on at the recovery site, we can spot-check that + they responded to ICMP and that a known port is listening (RDP, SSH, + HTTP, etc). + + Skips itself entirely on the pre-recovery phase (nothing's running yet) + and on $z.operation values that don't bring VMs up. + + Wire up one endpoint: + /hook/zerto-post -> this script + DataPassing: [x] Stdin JSON + ResponseMode: async + +.NOTES + VmDisplayNames is a comma-separated list for multi-VM VPGs; some Zerto + versions wrap each name in parentheses (e.g. "vm1(1)(1)(1)") to disambig + after Test failover. We strip the trailing parenthesised suffixes when + resolving DNS so the recovered hostname is what we ping. + + Endpoint config: + ExecutorType: WindowsPowerShell or PowerShell 7 + ScriptPath: C:\scripts\zerto-receiver-vm-healthcheck.ps1 + DataPassing: [x] Stdin JSON + ResponseMode: async + TimeoutSeconds: 120 (this script does network I/O - bump from default) +#> + +[CmdletBinding()] +param( + [int] $ProbePort = 3389, # RDP. Use 22 for Linux, 80/443 for web tier. + [int] $PingTimeout = 2000, # ms + [string] $ReportDir = 'C:\ProgramData\WebhookServer\zerto-healthchecks' +) + +$ErrorActionPreference = 'Stop' + +# --- read + parse payload ------------------------------------------------- +$body = [Console]::In.ReadToEnd() +if ([string]::IsNullOrWhiteSpace($body)) { + Write-Error 'Empty stdin.' + exit 2 +} +$p = $body | ConvertFrom-Json + +$z = $p.zerto +$phase = $p.phase +$op = $z.operation + +# Skip if this isn't a post-phase run for an op that powers VMs on. +if ($phase -ne 'post') { + Write-Host "Phase '$phase' - nothing to check yet, skipping." + exit 0 +} +if ($op -notin @('Test','Failover','Move','FailoverBeforeCommit','FailoverDuringCommit')) { + Write-Host "Operation '$op' doesn't bring VMs up; skipping." + exit 0 +} + +# --- parse VM list -------------------------------------------------------- +function Strip-ZertoSuffix { + param([string] $name) + # "ubuntu-2404(1)(1)(1)" -> "ubuntu-2404" + return ($name -replace '(\([^)]*\))+\s*$','').Trim() +} + +$rawNames = ($z.vmDisplayNames -split '[,;]') | ForEach-Object { $_.Trim() } | + Where-Object { $_ } +if (-not $rawNames) { + Write-Warning 'No VM display names in payload - nothing to check.' + exit 0 +} + +# --- run checks ----------------------------------------------------------- +$results = foreach ($raw in $rawNames) { + $clean = Strip-ZertoSuffix $raw + $pingOk = $false + $portOk = $false + $err = $null + + try { + $pingOk = (Test-Connection -ComputerName $clean -Count 1 -Quiet ` + -TimeoutSeconds ([math]::Max(1, [int]($PingTimeout / 1000))) ` + -ErrorAction Stop) + } catch { $err = "ping: $($_.Exception.Message)" } + + try { + $portOk = (Test-NetConnection -ComputerName $clean -Port $ProbePort ` + -InformationLevel Quiet -WarningAction SilentlyContinue) + } catch { $err = ($err, "port: $($_.Exception.Message)") -ne $null -join '; ' } + + [pscustomobject]@{ + DisplayName = $raw + Resolved = $clean + PingOk = $pingOk + PortOk = $portOk + ProbePort = $ProbePort + Error = $err + } +} + +# --- write report --------------------------------------------------------- +if (-not (Test-Path $ReportDir)) { + New-Item -ItemType Directory -Path $ReportDir -Force | Out-Null +} + +$safeVpg = ($z.vpgName -replace '[^A-Za-z0-9_.-]','_') +$stamp = (Get-Date).ToUniversalTime().ToString('yyyyMMddTHHmmssZ') +$file = Join-Path $ReportDir "$safeVpg-$op-$stamp.json" + +$report = [ordered]@{ + vpgName = $z.vpgName + operation = $op + phase = $phase + capturedAt = $p.capturedAt + completedAt = (Get-Date).ToUniversalTime().ToString('o') + probePort = $ProbePort + vms = $results + summary = @{ + total = $results.Count + pingFailures = ($results | Where-Object { -not $_.PingOk }).Count + portFailures = ($results | Where-Object { -not $_.PortOk }).Count + } +} +$report | ConvertTo-Json -Depth 5 | Set-Content -Path $file -Encoding utf8 + +# Console output goes back via the webhook callback (if configured) so the +# Zerto-side script log shows a quick summary even though the call is async. +$bad = $report.summary.pingFailures + $report.summary.portFailures +Write-Host "[$op/$phase] $($z.vpgName): $($results.Count) VM(s), $bad issue(s). Report: $file" + +# Exit non-zero if anything failed, so the webhook server's failOnNonZeroExit +# turns this into a 502 for the caller (and shows up in the run history). +if ($bad -gt 0) { exit 1 } diff --git a/scripts/examples/zerto-zvma-send.ps1 b/scripts/examples/zerto-zvma-send.ps1 new file mode 100644 index 0000000..cc93e0f --- /dev/null +++ b/scripts/examples/zerto-zvma-send.ps1 @@ -0,0 +1,74 @@ +<# +.SYNOPSIS + Zerto pre/post script (ZVMA / Linux scripts-service edition). Reads the + Zerto-injected environment variables and POSTs them to a Webhook Server + endpoint as a structured JSON payload. + +.DESCRIPTION + Drop into a VPG's Recovery Scripts in the ZVM UI: + VPG settings -> Recovery -> Scripts -> Pre / Post Recovery Script + Path: /app/scripts-files/zerto-zvma-send.ps1 + Parameters: -Phase pre (or -Phase post on the post-recovery slot) + + Configure $WebhookUrl + $Bearer (or use the -WebhookUrl / -Bearer params + so one script file can serve multiple VPGs / endpoints). + + Async by default - the call returns 202 in milliseconds and the actual + work runs in the webhook server's background, so the VPG sequence is + never blocked by slow downstream actions (DNS, notifications, etc.). + +.NOTES + The scripts-service container has pwsh 7 and curl available. This script + uses Invoke-RestMethod to keep things native to PowerShell. +#> + +[CmdletBinding()] +param( + [Parameter(Mandatory)] + [ValidateSet('pre', 'post')] + [string] $Phase, + + [string] $WebhookUrl = 'http://192.168.50.250:8080/hook/zerto-{phase}', + [string] $Bearer = '', + [int] $TimeoutSec = 10 +) + +$ErrorActionPreference = 'Stop' + +# Resolve {phase} placeholder so one URL template can route to /hook/zerto-pre +# and /hook/zerto-post. Plain URLs without the token work too. +$url = $WebhookUrl.Replace('{phase}', $Phase) + +$payload = [ordered]@{ + phase = $Phase + capturedAt = (Get-Date).ToUniversalTime().ToString('o') + host = $env:HOSTNAME # scripts-service pod name + zerto = [ordered]@{ + vpgName = $env:ZertoVPGName + internalVpgName = $env:ZertoInternalVpgName + operation = $env:ZertoOperation # Test / Failover / Move / ... + force = $env:ZertoForce # only meaningful pre + vmDisplayNames = $env:VmDisplayNames # comma-separated for multi-VM VPGs + hypervisorManagerIP = $env:ZertoHypervisorManagerIP + hypervisorManagerPort = $env:ZertoHypervisorManagerPort + outputDir = $env:ZertoOutputDir + workingDir = $env:ZertoWorkingDir + } +} + +$body = $payload | ConvertTo-Json -Depth 4 -Compress + +$headers = @{ 'Content-Type' = 'application/json' } +if ($Bearer) { $headers['Authorization'] = "Bearer $Bearer" } + +try { + $resp = Invoke-RestMethod -Method Post -Uri $url -Headers $headers ` + -Body $body -TimeoutSec $TimeoutSec + Write-Host "[$Phase] webhook accepted: $($resp | ConvertTo-Json -Compress)" +} +catch { + # Pre/post failures should not block the VPG operation. Log loudly and exit 0 + # so Zerto's recovery sequence continues. Flip to `exit 1` if you want a + # webhook outage to fail the failover. + Write-Warning "[$Phase] webhook call failed: $($_.Exception.Message)" +} -- 2.52.0