| name | run-external-backup |
| description | Freeze the IRIS instance for an external (OS/SAN-level) snapshot backup and thaw it safely afterward — thaw ALWAYS runs, even if the snapshot step failed. |
Run External Backup (Freeze / Snapshot / Thaw)
No server profile specified — omit server (or pass "") to use the default server on every tool call below.
Safety invariant: the instance must NEVER be left frozen. Step 4 (thaw) runs
unconditionally, even if the external snapshot in step 3 failed or was cancelled.
- Pre-check: call
iris_journal_info to confirm journaling is healthy (state, free space) before freezing.
- Call
iris_backup_manage action 'freeze' to quiesce ALL database writes instance-wide (Backup.General.ExternalFreeze). This is DISRUPTIVE — no writes are accepted until thawed. Optionally supply 'logFile' and 'description'.
- Verify the freeze succeeded (the tool result reports success), then PAUSE and ask the user to run (or confirm completion of) the external OS/SAN-level snapshot. Do not proceed until the user confirms the snapshot finished — successfully OR not.
- Always, regardless of whether the snapshot succeeded, call
iris_backup_manage action 'thaw' to resume database writes (Backup.General.ExternalThaw). If 'thaw' itself fails, retry immediately and escalate to the user — the instance must not be left frozen.
- Verify recovery: call
iris_journal_info again and confirm journaling has resumed (state is normal, not frozen).
- Call
iris_backup_manage action 'listHistory' to record/confirm the run in the backup history log.
Report the overall outcome (frozen → snapshot result → thawed → journaling confirmed resumed) to the user.
