Skip to main content
Glama
vbr-write-mcp

vbr-write-mcp

by Aquatick

vbr-write-mcp

Veeam Backup & Replication (VBR) REST API'sinin yazma ve yönetim işlemlerini MCP tool'ları olarak sunan sunucu. Veeam'in resmi vbr-mcp sunucusunu tamamlamak için yazıldı: vbr-mcp okuma ağırlıklıdır (49 tool'dan 29'u okuma), bu sunucu ise onun kapsamadığı yazma işlemlerini ekler. İkisi yan yana çalışacak şekilde tasarlandı. Aynı .env değişkenlerini kullanırlar ve tool adları çakışmaz.

vbr-mcp (Veeam)

vbr-write-mcp (bu proje)

VBR 1.3-rev2 yazma endpoint'i (POST/PUT/DELETE, 336 adet)

~20

Tamamı: 68 tool'un ~150 endpoint'i doğrudan, geri kalanını api_write karşılar

Onay

Yalnızca istemciye ipucu (annotation)

Sunucu tarafında zorunlu: elicitation veya tek kullanımlık token

Dry-run / audit log / erişim seviyesi

Yok

Var

Düzenleme (PUT)

Yok

Patch mantığı: yalnızca değişen alanlar gönderilir, onay planında alan bazında diff gösterilir

İstek gövdesi şeması

Elle yazılmış modeller

Paketle gelen API kataloğu (519 endpoint, 1425 model): describe_endpoint / describe_model

Test durumu: 98 otomatik test ve uçtan uca demo testi geçiyor. Bunlar sahte (mock) bir VBR'a karşı çalışıyor ve gönderilen her isteğin gerçek bir 1.3-rev2 endpoint'i olduğunu, gövdedeki her alanın Veeam'in resmi modelinde bulunduğunu doğruluyor. Canlı bir VBR 13'e karşı henüz denenmedi. Önce lab ortamında VBRW_DRY_RUN=true ile deneyin.

Tool'lar

Seviye: read hiçbir şeyi değiştirmez. write ekleme yapar ya da geri alınabilir bir değişiklik yapar; varsayılan olarak onay istemez. destructive veri kaybına, kesintiye ya da korumanın durmasına yol açabilir; sunucu çalıştırmadan önce onay ister. mixed tool'larda zararsız varyant write, tehlikeli varyant destructive kabul edilir. Örneğin set_protection_group_enabled için enable write, disable destructive'tir.

Çekirdek (her zaman açık)

Tool

Seviye

Ne yapar

describe_endpoint

read

API referansı: yol + method ile şema, ya da kelimeyle arama ("failover", "add repository")

describe_model

read

Bir modelin alanları, zorunlular, enum'lar ve polimorfik alt tipler (x-subtypes)

api_read

read

Herhangi bir GET isteği (id bulma, aksiyon sonrası kontrol)

get_session_result

read

Bir session'ın durumu ve sonucu. wait_seconds ile bitene kadar bekler, hata ve uyarıda log'ları da getirir

api_write

destructive

Kataloğdaki herhangi bir POST/PUT/DELETE isteği (Azure IR, Entra ID, HA cluster, KMS, Data Integration API...)

Nesne yönetimi: 4 tool ile ~60 endpoint

Tool

Seviye

Ne yapar

create_object

write

Nesne oluşturur: job, managed_server, repository, scale_out_repository, proxy, mount_server, credentials, cloud_credentials, encryption_password, kms_server, protection_group, recovery_token, unstructured_data_server, entra_id_tenant, ad_domain, global_vm_exclusion, role, user, datastore_latency

update_object

destructive

Yukarıdaki nesneleri patch mantığıyla düzenler: nesneyi okur, değişiklikleri derin birleştirir, tam modeli PUT eder. Planda diff görünür

delete_object

destructive

Siler. deleteBackups ve uninstallEverything seçenekleri planda ayrıca uyarı olarak gösterilir

update_settings

destructive

Sunucu ayarları (patch + diff): config_backup, general_options, email, notifications, event_forwarding, host_authentication, storage_latency, traffic_rules, malware_*, security_mfa, security_analyzer_schedule, repository_access_permissions, ...

Job'lar, session'lar, backup'lar

Tool

Seviye

Ne yapar

clone_job

write

Job'u klonlar

start_quick_backup

write

Quick Backup: vSphere, Cloud Director, Hyper-V ya da agent makinesinin anlık incremental'i

apply_job_configuration

write

Agent politikasının konfigürasyonunu agent'lara uygular

clear_job_cache

destructive

Agent politikasının backup cache'ini temizler

stop_session / stop_task / stop_automation_session

destructive

Restore, rescan, IR, import gibi herhangi bir session'ı ya da task'ı durdurur

delete_backup / delete_backup_object

destructive

Backup'ın tamamını ya da tek bir makinenin restore point'lerini siler. GFS dahil edilebilir, yalnızca konfigürasyondan kaldırma seçeneği de var

move_backup

destructive

Backup'ı başka bir repository'ye taşır

copy_backups

write

Backup'ı başka bir repository'ye ya da klasöre kopyalar

move_backup_objects_to_job

destructive

Makinelerin backup'larını başka bir job'a bağlar

run_backup_health_check

mixed

Sağlık kontrolü yapar. repair=true ise destructive sayılır

set_backup_file_malware_state

mixed

Backup dosyasını clean ya da infected olarak işaretler

manage_move_copy_session

mixed

Bekleyen move/copy session'ı için Retry, ForgetFailed ya da StopAndUndo

create_recovery_media

write

Agent backup'ı için bare-metal recovery ISO'su üretir

Restore ve DR

Tool

Seviye

Ne yapar

restore_cloud_director_vm

destructive

vCD VM'inin tam restore'u: orijinal konuma ya da başka bir vApp'e, yeni ad, network ve storage policy ile

restore_hyperv_vm

destructive

Hyper-V VM'inin tam restore'u

start_instant_recovery_hyperv_vm / finish_instant_recovery_hyperv_vm

destructive

Hyper-V Instant Recovery (OtherPlatform dahil), ardından migrate ya da unmount

start_file_level_restore → browse_file_level_restore → restore_files → unmount_file_level_restore

write / read / mixed / write

Guest dosya restore akışı: mount, gez ya da ara, geri yükle (Keep, Overwrite ya da PermissionOnly; orijinal ya da başka konum), unmount

list_replicas

read

Replica'lar ve restore point'leri

failover_replicas

destructive

Failover: now, planned, permanent ya da undo

failback_replicas

destructive

Failback: start, commit, undo, switch_to_production ya da change_switchover_time

rescan_replicas

write

Replica'ları yeniden tarar

Agent, malware, lisans, güvenlik, altyapı, sistem

Tool

Seviye

Ne yapar

set_protection_group_enabled, rescan_protection_group

mixed / write

Protection group'u açar, kapatır ya da tarar

manage_discovered_computers

mixed

Agent ya da CBT kur, yükselt ya da kaldır; rescan, trust, reboot, gruptan çıkarma

set_agent_backup_attachment, reboot_recovery_appliances

mixed / write

Backup'ı agent'a bağlar ya da ayırır; recovery appliance'ı yeniden başlatır

mark_backup_objects_clean, manage_malware_exclusions, set_ioc_monitoring

destructive / mixed

False positive temizliği, istisnalar, IoC izleme

start_encryption_analysis, report_malware_event

write

Şifreleme analizi; EDR, XDR ya da SIEM'den malware olayı bildirme

install_license, refresh_license, set_license_options, manage_instance_license, remove_installed_license

karışık

Lisans yaşam döngüsü

change_credentials_secret, change_encryption_password, verify_encryption_password

destructive / read

Parola, SSH anahtarı ve cloud secret rotasyonu

manage_user_security, clone_role, security_analyzer

destructive / write / mixed

MFA reset, service account, rol klonlama, Security & Compliance Analyzer

rescan_managed_servers, rescan_inventory, set_default_mount_server

write

Altyapı rescan'leri, varsayılan mount server

get_server_certificate, discover_cloud_director_vcenters

read

Sunucu eklemeden önce TLS ya da SSH parmak izi; vCD'ye bağlı vCenter'lar

export_configuration, import_configuration

mixed / destructive

Job, sunucu, repo, proxy, credentials ve şifre export/import (sunucu taşıma, dokümantasyon)

export_support_logs, send_test_email, high_availability_cluster

write / write / destructive

Destek log paketi, test e-postası, HA switchover ve failover

Related MCP server: Veeam AIops

Güvenlik modeli

  1. Sunucu tarafında onay (VBRW_CONFIRMATION_MODE, varsayılan auto)

    • elicit: Sunucu, MCP istemcisi üzerinden kullanıcıya doğrudan sorar. Ajan kullanıcı yerine "evet" diyemez. Hem eski (2025-xx) hem yeni (2026-07-28, çok turlu "input required") protokolde çalışır.

    • token: İlk çağrı hiçbir şey göndermez. Geriye bir plan (hedef, gönderilecek istekler, etkisi, diff) ve 5 dakika geçerli, tek kullanımlık bir confirm_token döner. Token aynı tool'a ve aynı argümanlara bağlıdır. Düzenleme işlemlerinde nesnenin o anki haline de bağlıdır: plan çıkarıldıktan sonra biri nesneyi değiştirirse token geçersiz olur.

    • auto: İstemci elicitation destekliyorsa elicit, desteklemiyorsa token kullanılır. none onayı kapatır; önerilmez.

  2. Erişim seviyesi (VBRW_ACCESS_LEVEL): write ayarında destructive tool'lar listelenmez, mixed tool'ların tehlikeli varyantları da reddedilir. Production için önerilen ayar budur.

  3. Dry-run (VBRW_DRY_RUN=true): Hiçbir yazma isteği gönderilmez, gönderilecek istek gösterilir.

  4. Audit log (VBRW_AUDIT_LOG): Her deneme JSONL olarak kaydedilir: plan, onay türü, sonuç, hata, istemci. Parola, anahtar, secret ve lisans gibi alanlar hem planda hem log'da *** olarak maskelenir.

  5. Kapsam daraltma: VBRW_TOOL_GROUPS, VBRW_DISABLED_TOOLS, VBRW_BLOCKED_PATHS (api_write için ek yasaklar). /api/oauth2/* ve registerVbr her zaman yasaktır.

  6. En az yetki: Sunucu, VBR_USERNAME hesabının tüm yetkileriyle çalışır. Ayrı bir servis hesabı açın ve rolünü ihtiyaca göre seçin (ör. yalnızca restore yapacaksanız Restore Operator).

Kurulum

cd vbr-write-mcp
cp .env.example .env        # VBR_BASE_URL, VBR_USERNAME, VBR_PASSWORD
uv sync
npx @modelcontextprotocol/inspector uv run vbr-write-mcp   # istemcisiz deneme

Docker ile:

docker build -f docker/Dockerfile -t vbr-write-mcp .
docker run -i --rm --env-file /abs/yol/vbr-write-mcp/.env -v vbrw-audit:/audit vbr-write-mcp

Gereksinimler: VBR 13 (REST API 1.3-rev2, port 9419), Python 3.12+ ya da uv/Docker.

Claude Desktop: vbr-mcp ile yan yana

{
  "mcpServers": {
    "vbr": {
      "command": "uv",
      "args": ["run", "--project", "/abs/yol/veeam-mcp-server/servers/vbr-mcp", "vbr-mcp"]
    },
    "vbr-write": {
      "command": "uv",
      "args": ["run", "--project", "/abs/yol/vbr-write-mcp", "vbr-write-mcp"],
      "env": { "VBRW_ACCESS_LEVEL": "write" }
    }
  }
}

Claude Code

claude mcp add vbr-write -- uv run --project /abs/yol/vbr-write-mcp vbr-write-mcp

HTTP (paylaşımlı kullanım)

VBRW_TRANSPORT=http, VBRW_HTTP_PORT=8001, MCP_TOKENS={"<uzun-rastgele-token>": "ekip"}. İstemciler Authorization: Bearer <token> ile bağlanır. Sunucuyu yalnızca güvenilir bir ağda ya da bir reverse proxy arkasında açın.

Örnek akışlar

vCD VM'ini yeni bir vApp'e restore etmek

  1. vbr-mcp: list_protected_objects → list_restore_points ile restore point id'sini bulun. browse_inventory ile hedef vApp nesnesini alın.

  2. restore_cloud_director_vm(restore_point_id, mode="Customized", new_name="web-01-restored", vapp={...})

  3. Planı onaylayın, ardından get_session_result(session_id, wait_seconds=600) ile takip edin.

Job retention'ını değiştirmek: update_object(kind="job", id=..., changes={"storage": {"retentionPolicy": {"quantity": 14}}}) çağrısı planda storage.retentionPolicy.quantity: 7 → 14 diff'ini gösterir.

Planlı DR testi: list_replicas → failover_replicas(mode="planned", ...) → test → failback_replicas(action="start", target="OriginalVM", switchover={"type": "Manual"}) → failback_replicas(action="switch_to_production") → failback_replicas(action="commit").

Dedicated tool'u olmayan bir işlem: describe_endpoint("instant recovery azure") ile endpoint'i bulun, describe_endpoint("/api/v1/restore/instantRecovery/azure/vm", "POST") ile gövdeyi görün, ardından api_write("POST", "/api/v1/restore/instantRecovery/azure/vm", body={...}) çağırın.

Demo: gerçek VBR olmadan deneme

demo/demo_vbr.py, Veeam'in vbr-mcp entegrasyon testlerindeki VBR standını (Daily-VMs, SQL-Prod, SQL-Dev, Repo-Main, Repo-Linux-01, malware olayları, lisans ...) sunan sahte bir VBR'dır. VBR 1.3-rev2'nin her yazma endpoint'ini kabul eder, kaydeder ve VBR gibi cevap verir: aksiyon session döner, PUT nesneyi değiştirir, DELETE siler.

uv sync --all-groups
uv run python demo/demo_vbr.py            # http://127.0.0.1:9419 - giriş demo/demo
# başka bir terminalde: MCP Inspector ile tool'ları elle çağırın
VBR_BASE_URL=http://127.0.0.1:9419 VBR_USERNAME=demo VBR_PASSWORD=demo VBRW_CONFIRMATION_MODE=token \
  npx @modelcontextprotocol/inspector uv run vbr-write-mcp

Windows'ta: zip'i açın ve start-demo.cmd dosyasına çift tıklayın. Betik .venv kurar, demo VBR'ı başlatır, /_demo sayfasını ve MCP Inspector'ı açar (Python 3.12+ ve Node.js gerekir).

http://127.0.0.1:9419/_demo sayfası VBR'a ulaşan her yazma isteğini canlı gösterir. scripts/e2e_demo.py, Veeam'in vbr-mcp'si ile bu sunucuyu yan yana bu demo VBR'a bağlayıp senaryoları ve tüm tool'ları gerçek stdio + HTTP üzerinden çalıştırır.

Sınırlamalar

  • Sunucu tek bir VBR'a bağlanır. Birden fazla VBR için her biri kendi env'iyle ayrı istemci girdisi ekleyin.

  • vSphere replica failover ve failback API'si yalnızca snapshot replica içindir. CDP ve diğer platformlar VBR REST API'sinde yok.

  • x-subtypes (polimorfik model alt tipleri), Veeam'in OpenAPI'sinden üretilmiş istemci modellerinden sezgisel olarak çıkarılıyor. Liste eksik ya da fazla olabilir. Şüphede kalırsanız describe_model ile alt tipe bakın.

  • copy_backups(kind="machines") gövdesinin şeması Veeam tarafından yayımlanmıyor.

  • ACL, diskManagement (bare-metal disk düzeni), Entra ID item restore ve Azure IR gibi nadir akışlar yalnızca api_write ile yapılabiliyor.

Geliştirme

uv sync --all-groups
uv run --group test pytest -q tests                      # 98 test, VBR gerektirmez
uv run python scripts/stdio_legacy_check.py .venv/bin/vbr-write-mcp   # eski protokol elicitation e2e
  • tests/test_endpoints.py: Her yazma tool'unu MCP protokolü üzerinden çalıştırır. Gönderilen her isteğin gerçek bir 1.3-rev2 endpoint'i olduğunu ve gövdedeki her alanın Veeam modelinde bulunduğunu doğrular. Yeni bir tool eklenip test durumu yazılmazsa test kırılır.

  • tests/test_safety.py: Onay token'ı (tek kullanım, argümana ve nesne durumuna bağlılık), elicitation (kabul ve ret), dry-run, erişim seviyesi, redaction, audit, diff ve VBR hata mesajlarının iletilmesi.

  • API kataloğunu yeni bir revizyona güncellemek için: scripts/build_catalog.py.

Lisans: MIT. vbr_client.py, auth.py ve pagination.py Veeam'in vbr-mcp kodundan alınmıştır (MIT, LICENSE.vbr-mcp).

Available Tools

68 tools
api_readApi ReadA
Read-onlyIdempotent

Send a GET request to the VBR REST API (read-only), e.g. to find ids or check state after an action.

path has its ids filled in (e.g. /api/v1/jobs/{id}); params holds query parameters (filters, skip/limit, orderColumn/orderAsc). If Veeam's vbr-mcp is connected too, its dedicated list tools give richer answers.

Inputs: path (required), params.

api_writeApi WriteA
Destructive

Send any state-changing request to the VBR REST API - for write endpoints no dedicated tool covers.

Examples: High Availability cluster switchover, Azure / file-share / FCD Instant Recovery, Entra ID restores, disk publishing (Data Integration API), helper appliances, KMS servers. Look the endpoint up with describe_endpoint first and build body from its schema. Only endpoints of the VBR 1.3-rev2 API are accepted. Always treated as destructive: the server asks for confirmation before sending. reason is recorded in the audit log.

Inputs: path (required), method (required), body, params, +2 more. Returns: object

apply_job_configurationApply Job ConfigurationB

Push a Veeam Agent backup policy's current configuration to the agents it manages ("Apply configuration").

Only for agent backup policies (*AgentBackupServerPolicy / *WorkstationPolicy job types).

Inputs: job_id (required), confirm_token. Returns: object

browse_file_level_restoreBrowse File Level RestoreC
Read-onlyIdempotent

List a folder (or search) in a file-level-restore mount. Read-only.

Inputs: path (required), session_id (required), skip, limit, +2 more.

change_credentials_secretChange Credentials SecretA
Destructive

Rotate the secret of a stored credentials record used by VBR to reach servers, guests or cloud accounts.

password (standard or Linux account), linux_root_password, linux_private_key (secret = the key, optional passphrase), cloud_secret_key (secret key of a cloud credentials record). Every job and server using the record uses the new secret from the next connection - a wrong value breaks them.

Inputs: what (required), secret (required), credentials_id (required), passphrase, +1 more. Returns: object

change_encryption_passwordChange Encryption PasswordA
Destructive

Change an encryption password (and its hint). Jobs using it encrypt new backups with the new password; existing backups still need the old one to restore - keep it safe.

Inputs: new_hint (required), new_password (required), encryption_password_id (required), confirm_token. Returns: object

clear_job_cacheClear Job CacheA
Destructive

Clear the backup cache of a Veeam Agent backup policy (the local cache agents write to while the repository is unreachable). Make sure cached restore points were uploaded first.

Inputs: job_id (required), confirm_token. Returns: object

clone_jobClone JobA

Clone a job. VBR creates the copy under a derived name; rename or adjust it afterwards with update_object(kind='job', ...) and check its schedule before it first runs.

Supported job types: VSphereBackup, HyperVBackup, CloudDirectorBackup, BackupCopy, WindowsAgentBackup, LinuxAgentBackup. Returns the new job's model.

Inputs: job_id (required), confirm_token. Returns: object

clone_roleClone RoleB

Clone a custom role; adjust the copy with update_object(kind='role', ...).

Inputs: role_id (required), confirm_token. Returns: object

copy_backupsCopy BackupsA

Copy backups to another repository (or, for machine backups, a folder) - the source stays as it is.

spec is the request body: for unstructured_data a CopyBackupSpec (see describe_model); for machines VBR does not publish the schema - typically backupIds and a target repository or folder. Check describe_endpoint('/api/v1/backups/machines/copyTo', 'POST').

Inputs: spec (required), kind, confirm_token. Returns: object

create_objectCreate ObjectA

Create a VBR object from a full spec (the POST body of its collection).

Kinds: job, managed_server, repository, scale_out_repository, proxy, mount_server, credentials, cloud_credentials, encryption_password, kms_server, protection_group, recovery_token, unstructured_data_server, entra_id_tenant, ad_domain, global_vm_exclusion, role, user, datastore_latency. Look the body up first with describe_endpoint('<collection path>', 'POST'); most specs are polymorphic on type (see x-subtypes, e.g. VSphereBackupJobSpec/BackupJobSpec for job, WindowsLocalStorageSpec/LinuxHardenedStorageSpec/SmbStorageSpec for repository, ViHostSpec/CloudDirectorHostSpec for managed_server, StandardCredentialsSpec/LinuxCredentialsSpec for credentials). Additive, so no confirmation is needed by default; adding servers and repositories runs as a session.

Inputs: kind (required), spec (required), confirm_token. Returns: object

create_recovery_mediaCreate Recovery MediaC

Create Veeam Recovery Media (bare-metal recovery ISO) for an agent backup object.

Inputs: backup_object_id (required), spec, confirm_token. Returns: object

delete_backupDelete BackupA
Destructive

Delete a whole backup (all restore points of every machine in it) from disk.

include_gfs=True also deletes GFS (weekly/monthly/yearly) restore points - without it they are kept. from_configuration_only=True removes the backup only from the VBR configuration (fromDB) and leaves the files on the repository (they can be imported again). Immutable restore points cannot be deleted before their immutability expires; VBR then reports an error. Irreversible.

Inputs: backup_id (required), include_gfs, confirm_token, from_configuration_only. Returns: object

delete_backup_objectDelete Backup ObjectA
Destructive

Delete one machine's restore points from a backup ("Delete from disk" for a single VM/computer).

object_id is the backup object id from vbr-mcp get_backup_details(include objects). Irreversible.

Inputs: backup_id (required), object_id (required), include_gfs, confirm_token. Returns: object

delete_objectDelete ObjectA
Destructive

Remove a VBR object.

Kinds: job, managed_server, repository, scale_out_repository, proxy, mount_server, credentials, cloud_credentials, encryption_password, kms_server, protection_group, recovery_token, unstructured_data_server, entra_id_tenant, ad_domain, global_vm_exclusion, role, user, datastore_latency (not mount_server). Optional options are the DELETE query parameters: deleteBackups (repository, scale_out_repository - also deletes the backups stored there), uninstallEverything (protection_group - uninstalls agents). Use delete_backup for backups. Confirmed by the server.

Inputs: id (required), kind (required), options, confirm_token. Returns: object

describe_endpointDescribe EndpointA
Read-onlyIdempotent

Look up the VBR REST API 1.3-rev2 reference bundled with this server.

With a path and method: the endpoint's summary, description, path/query parameters and request-body schema (nested models inlined to depth; deeper ones appear as {"$ref": Model} - expand them with describe_model). A model with x-subtypes is polymorphic: its type field selects one of the listed subtypes, whose extra fields the body must carry. With search words: matching endpoints (method, path, summary).

Inputs: query (required), depth, method.

describe_modelDescribe ModelB
Read-onlyIdempotent

Schema of one VBR API model by name (e.g. EntireCloudDirectorVMCustomizedRestoreSpec, VmwareObjectModel).

Shows fields, which are required, enum values and descriptions; x-subtypes lists the concrete variants of a polymorphic model.

Inputs: name (required), depth.

discover_cloud_director_vcentersDiscover Cloud Director VcentersA
Read-onlyIdempotent

List the vCenter Servers attached to a VMware Cloud Director server, before adding it (CloudDirectorHostDiscoverySpec: see describe_model). Read-only.

Inputs: spec (required).

export_configurationExport ConfigurationA
Destructive

Export VBR configuration objects as JSON import specs - for documentation, review, migration to another VBR server, or as a template for create_object. Exporting credentials / cloud credentials / encryption passwords is confirmed by the server because the output is sensitive.

Inputs: kind (required), filters, confirm_token. Returns: object

export_support_logsExport Support LogsB

Collect a support log bundle (for a Veeam support case) for some jobs or hosts. With date_from/date_to (ISO-8601) only that range is exported, otherwise everything. Returns a log-export session.

Inputs: ids (required), scope (required), date_to, date_from, +2 more. Returns: object

failback_replicasFailback ReplicasA
Destructive

Failback of failed-over vSphere replicas, in steps:

  1. start - sync replica changes back to target (OriginalVM: the original VM, OriginalLocation: re-create it where it was, Customized: elsewhere). switchover decides when production takes over (Auto, Manual then switch_to_production, or Scheduled; change it later with change_switchover_time).

  2. commit - finalize; or undo - return to the failed-over state.

Inputs: action (required), replica_point_ids (required), target, customized, +5 more. Returns: object

failover_replicasFailover ReplicasA
Destructive

VMware vSphere replica failover. Pass one replica point (restore point of a replica) per VM.

  • now: power the replicas on at the DR site (disaster: production is lost).

  • planned: last sync, shut production down, switch to the replicas (migration / expected outage).

  • permanent: make the replicas the permanent production VMs (no failback).

  • undo: discard the failover - replicas are powered off, their changes lost. After now/planned, finish with failback_replicas or failover_replicas(mode='permanent'|'undo').

Inputs: mode (required), replica_point_ids (required), reason, confirm_token. Returns: object

finish_instant_recovery_hyperv_vmFinish Instant Recovery Hyperv VmA
Destructive

Finish a Hyper-V Instant Recovery mount: migrate the running VM to production storage, or unmount (tear it down; changes made inside the recovered VM are lost). Mount ids: api_read('/api/v1/restore/ instantRecovery/hyperV/vm').

Inputs: action (required), mount_id (required), confirm_token. Returns: object

get_server_certificateGet Server CertificateA
Read-onlyIdempotent

Fetch a server's TLS certificate thumbprint or SSH fingerprint - needed in the spec when adding a managed server with create_object(kind='managed_server'). Read-only (changes nothing in VBR).

Inputs: type (required), server_name (required), port, credentials_id.

get_session_resultGet Session ResultA
Read-onlyIdempotent

State and result of a VBR session - the asynchronous run started by almost every action tool.

With wait_seconds, polls every 5 s until the session reaches Stopped or the time is up. When the session stopped with a Warning or Failed result (or include_logs and it is still running), the session log records are included so the reason is visible.

Inputs: session_id (required), include_logs, wait_seconds. Returns: object

high_availability_clusterHigh Availability ClusterA
Destructive

Backup server High Availability cluster: planned switchover to the secondary node (ignore_lag skips the database replication lag check), or failover when the primary node is lost. The REST API and this MCP server reconnect to the new primary only if VBR_BASE_URL points at the cluster's shared name.

Inputs: action (required), ignore_lag, confirm_token. Returns: object

import_configurationImport ConfigurationA
Destructive

Import configuration objects (as produced by export_configuration, e.g. on another VBR server). Objects that exist already may be updated. Returns an automation session; stop it with stop_automation_session. Confirmed by the server.

Inputs: kind (required), collection (required), confirm_token. Returns: object

install_licenseInstall LicenseB
Destructive

Install a license file on the backup server, replacing the installed license. Confirmed by the server.

Inputs: license_base64 (required), confirm_token, force_standalone_mode. Returns: object

list_replicasList ReplicasA
Read-onlyIdempotent

List VM replicas, or - with replica_id - that replica's restore points (newest first), to pick the replicaPointIds for failover/failback. Read-only.

Inputs: max_points, replica_id, name_filter.

manage_discovered_computersManage Discovered ComputersA
Destructive

Act on computers a protection group discovered (ids from vbr-mcp get_protection_group_entities).

Additive actions run directly: install/upgrade agent, install CBT driver, rescan, trust, prepare for remote bare-metal recovery, recreate embedded recovery media. Confirmed by the server: uninstall agent / CBT driver / all components, reboot, remove (removes one computer from the group - pass exactly one id).

Inputs: action (required), entity_ids (required), protection_group_id (required), confirm_token. Returns: object

manage_instance_licenseManage Instance LicenseB
Destructive

Assign an instance license to a workload as Server or Workstation, or remove the workload's instance license (it then needs a license again at the next backup).

Inputs: action (required), instance_id (required), confirm_token. Returns: object

manage_malware_exclusionsManage Malware ExclusionsA
Destructive

Create/update (upsert, with exclusions - a list of MalwareDetectionCommonSpec, see describe_model) or delete (with exclusion_ids) malware-detection exclusions for backup objects. Exclusions weaken detection, so both are confirmed by the server.

Inputs: action (required), exclusions, confirm_token, exclusion_ids. Returns: object

manage_move_copy_sessionManage Move Copy SessionA
Destructive

Resolve a backup move/copy session that is waiting for a decision: Retry the failed part, ForgetFailed (keep what moved, drop the rest) or StopAndUndo (roll back).

Inputs: action (required), session_id (required), confirm_token. Returns: object

manage_user_securityManage User SecurityB
Destructive

Reset a user's MFA (they must enroll again at next login), or switch the service-account mode (service accounts are exempt from MFA - use for automation accounts only). Roles: update_object(kind='user').

Inputs: action (required), user_id (required), confirm_token. Returns: object

mark_backup_objects_cleanMark Backup Objects CleanA
Destructive

Mark backup objects (machines) as clean after a malware investigation - typically a false positive.

mark_restore_points_clean also clears the Suspicious/Infected flags of their restore points, so normal restores are allowed again. exclude_from_detection stops future detection for them (a security exception - use with care). reason is mandatory here and is stored by VBR and in the audit log.

Inputs: reason (required), object_ids (required), confirm_token, note_for_exclusion, +2 more. Returns: object

move_backupMove BackupA
Destructive

Move a backup (whole chain) to another repository; the job is re-pointed to the target.

Runs as a move session and can take long; jobs using the backup cannot run meanwhile. If it stops halfway, manage_move_copy_session decides between retry, forget and undo.

Inputs: backup_id (required), target_repository_id (required), confirm_token. Returns: object

move_backup_objects_to_jobMove Backup Objects To JobB
Destructive

Re-home machines' backups from one job's backup to another job (e.g. after moving VMs between jobs), so the target job continues their chains. Without backup_object_ids all objects of the backup move.

Inputs: backup_id (required), target_job_id (required), confirm_token, backup_object_ids, +1 more. Returns: object

reboot_recovery_appliancesReboot Recovery AppliancesB

Reboot Veeam Agent recovery appliances (one by id, or all when appliance_ids is omitted).

Inputs: appliance_ids, confirm_token. Returns: object

refresh_licenseRefresh LicenseA

renew: download the renewed license from Veeam for the installed one; update: fetch the current license state (e.g. after a contract change) from the Veeam licensing server. Needs internet access on the server.

Inputs: action (required), confirm_token, force_standalone_mode. Returns: object

remove_installed_licenseRemove Installed LicenseB
Destructive

Remove the installed license (or only its Instance or Socket section). Jobs stop processing unlicensed workloads. Confirmed by the server.

Inputs: section, confirm_token, force_standalone_mode. Returns: object

report_malware_eventReport Malware EventB

Create a malware event from an external source (EDR/XDR/SIEM): VBR then flags the machine's restore points.

machine is a SuspiciousActivityMachineSpec (see describe_model; identifies the machine by FQDN/IP/UUID).

Inputs: engine (required), details (required), machine (required), detection_time_utc (required), +2 more. Returns: object

rescan_inventoryRescan InventoryA

Refresh the cached virtualization inventory (VMs, vApps, datastores, networks) of one managed server, e.g. after a VM or vApp was created and does not show up in browse_inventory yet.

Inputs: hostname (required), confirm_token. Returns: object

rescan_managed_serversRescan Managed ServersB

Rescan several managed servers at once, or all of them when managed_server_ids is omitted. Returns a session.

Inputs: confirm_token, managed_server_ids. Returns: object

rescan_protection_groupRescan Protection GroupB

Rescan a protection group now: discover new computers and refresh agent state. Returns a session.

Inputs: protection_group_id (required), confirm_token. Returns: object

rescan_replicasRescan ReplicasB

Rescan replicas to refresh their state in VBR (all replicas when replica_ids is omitted).

Inputs: replica_ids, confirm_token. Returns: object

restore_cloud_director_vmRestore Cloud Director VmA
Destructive

Full restore of a VMware Cloud Director VM from a restore point of a Cloud Director backup job.

OriginalLocation restores the VM into its original vApp, replacing the existing VM if it is still there. Customized restores it into vapp under new_name (required, keeps the original untouched), optionally with network mapping and datastore/storage policy. Inventory objects (vApp, networks, datastores) come from vbr-mcp browse_inventory on the Cloud Director server. proxy_ids pins backup proxies (default: automatic). Returns a restore session.

Inputs: mode (required), restore_point_id (required), vapp, reason, +8 more. Returns: object

restore_filesRestore FilesA
Destructive

Restore files/folders from a file-level-restore mount.

original: back to the same machine and path. restore_type: Keep keeps existing files and writes the restored ones next to them under a RESTORED- name, Overwrite replaces existing files, PermissionOnly restores only permissions. another: to target_host / target_path. credentials_id: guest credentials if VBR cannot use the job's.

Inputs: paths (required), session_id (required), restore_type (required), destination, +4 more. Returns: object

restore_hyperv_vmRestore Hyperv VmA
Destructive

Full restore of a Microsoft Hyper-V VM. OriginalLocation overwrites the VM in place; Customized restores to destination_host (and optionally a new name, storage and network mapping - see describe_model for HvRestoreTargetDatastoresSpec / HvRestoreTargetNetworkSpec / HvRestoreTargetNameSpec).

Inputs: mode (required), restore_point_id (required), reason, network, +6 more. Returns: object

run_backup_health_checkRun Backup Health CheckB
Destructive

Run a storage-level health check (CRC/consistency) on backups, optionally repairing what it finds.

Give backup_ids and/or job_ids. repair=True rewrites corrupted blocks / marks broken points and is confirmed as destructive; repair_options is a HealthCheckRepairOptions object. Returns a session.

Inputs: repair, job_ids, backup_ids, confirm_token, +1 more. Returns: object

security_analyzerSecurity AnalyzerB
Destructive

Security & Compliance Analyzer: start a scan; suppress one best-practice finding (with a note - it stops being reported, so it is confirmed); reset one finding's status or reset_all. Schedule: update_settings(area='security_analyzer_schedule').

Inputs: action (required), note, confirm_token, best_practice_id. Returns: object

send_test_emailSend Test EmailB

Send a test message with the configured email notification settings (update_settings(area='email')).

Inputs: confirm_token. Returns: object

set_agent_backup_attachmentSet Agent Backup AttachmentB
Destructive

Attach existing backups to a managed agent computer (e.g. after reinstalling it), or detach them.

Inputs: attach (required), backup_ids (required), discovered_entity_id (required), confirm_token. Returns: object

set_backup_file_malware_stateSet Backup File Malware StateA
Destructive

Mark one backup file (restore point file) as Clean or Infected for malware detection.

Marking infected blocks normal restores from it (secure restore only); marking clean lifts that, so it is confirmed by the server.

Inputs: state (required), backup_id (required), backup_file_id (required), confirm_token. Returns: object

set_default_mount_serverSet Default Mount ServerC

Make a mount server the default one for its repositories' restores (FLR, Instant Recovery).

Inputs: mount_server_id (required), confirm_token. Returns: object

set_ioc_monitoringSet Ioc MonitoringA
Destructive

Enable or disable monitoring of specific Indicators of Compromise (IoC) in file-level malware detection.

indicators names the IoC entries to switch (as listed by api_read('/api/v1/malwareDetection/settings/fileDetection/indicatorsOfCompromise') or the VBR console). Disabling weakens detection and is confirmed by the server.

Inputs: enabled (required), indicators (required), confirm_token. Returns: object

set_license_optionsSet License OptionsA

Switch license options: automatic license update (with proactive support) and instance consumption by unlicensed agents. Only the options you pass are changed.

Inputs: auto_update, confirm_token, proactive_support, unlicensed_agent_consumption. Returns: object

set_protection_group_enabledSet Protection Group EnabledB
Destructive

Enable or disable a protection group. A disabled group stops discovery and agent deployment for its computers (disabling is confirmed by the server).

Inputs: enabled (required), protection_group_id (required), confirm_token. Returns: object

start_encryption_analysisStart Encryption AnalysisB

Run an encryption analysis for a malware event (checks whether data in the backup was encrypted, e.g. by ransomware). Event ids: vbr-mcp list_malware_events.

Inputs: event_id (required), confirm_token. Returns: object

start_file_level_restoreStart File Level RestoreA

Mount a machine restore point for guest file-level restore (FLR). Returns the mount session; its id is the session_id for browse_file_level_restore, restore_files and unmount_file_level_restore.

Mounting changes nothing in production. Linux FLR uses a helper appliance/host configured in VBR.

Inputs: guest_os (required), restore_point_id (required), reason, confirm_token, +1 more. Returns: object

start_instant_recovery_hyperv_vmStart Instant Recovery Hyperv VmA
Destructive

Instant Recovery to Microsoft Hyper-V: run the VM straight from the backup, without a full data copy.

OriginalLocation publishes it in place of the original; Customized on destination_host; OtherPlatform recovers a VMware/agent/other backup onto Hyper-V (needs destination_host). Finish with finish_instant_recovery_hyperv_vm (migrate to production or unmount).

Inputs: mode (required), restore_point_id (required), reason, network, +7 more. Returns: object

start_quick_backupStart Quick BackupA

Quick Backup: an on-demand incremental of one machine that is already protected by a backup job.

object is the inventory object exactly as VBR returns it: for vsphere/cloud_director a VmwareObjectModel (platform, hostName, name, type: VirtualMachine, objectId) from vbr-mcp browse_inventory; for hyperv a HyperVObjectModel; for agent an AgentObjectModel (id, name, type, protectionGroupId, platform: Agent). The machine must have a backup in a job; VBR uses that job's settings and adds a restore point to its chain. Returns a session.

Inputs: object (required), platform (required), confirm_token. Returns: object

stop_automation_sessionStop Automation SessionB
Destructive

Stop an automation (import/export) session started by import_configuration or export_configuration.

Inputs: session_id (required), confirm_token. Returns: object

stop_sessionStop SessionA
Destructive

Stop a running session of any type: a restore, Instant Recovery, rescan, health check, SureBackup, malware scan, move/copy, etc. (for a backup job run, vbr-mcp stop_job gives graceful-stop control).

What is already done is not rolled back; a stopped restore can leave a partially restored VM or files behind.

Inputs: session_id (required), confirm_token. Returns: object

stop_taskStop TaskC
Destructive

Stop one task (/api/v1/tasks/{id}), e.g. a long-running export, deployment or recovery-media task.

Inputs: task_id (required), confirm_token. Returns: object

unmount_file_level_restoreUnmount File Level RestoreB

Unmount a file-level-restore mount when you are done with it.

Inputs: session_id (required), confirm_token. Returns: object

update_objectUpdate ObjectA
Destructive

Edit an existing VBR object: pass only the fields to change in changes; the tool reads the object, deep-merges changes into it and sends the complete model (VBR PUT replaces the whole object). Nested objects merge field by field; lists are replaced as a whole, so send the full new list. replace=True sends changes as the complete body instead.

Kinds: job, managed_server, repository, scale_out_repository, proxy, mount_server, credentials, cloud_credentials, encryption_password, kms_server, protection_group, recovery_token, unstructured_data_server, entra_id_tenant, ad_domain, global_vm_exclusion, role, user, datastore_latency (not ad_domain). user edits the role list, global_vm_exclusion the note, encryption_password the hint. The confirmation plan shows a field-level diff. Example: disable job encryption -> kind='job', changes={'storage': {'advancedSettings': {'storageData': {'encryption': {'isEnabled': false}}}}}. Edits can change what is protected and how: confirmed by the server.

Inputs: id (required), kind (required), changes (required), replace, +1 more. Returns: object

update_settingsUpdate SettingsA
Destructive

Edit server-wide VBR settings (or a per-object settings block) with patch semantics: pass only the fields to change; the tool reads the current settings, merges and sends the full model, and the confirmation plan shows the diff. Lists are replaced as a whole.

Areas: config_backup, general_options, email, notifications, event_forwarding, host_authentication, storage_latency, node_exporter, vsa_event_forwarding, vsa_event_forwarding_daemon, traffic_rules, malware_general, malware_suspicious_files, security_mfa, security_analyzer_schedule, repository_access_permissions, hyperv_server_volumes, azure_instant_recovery_switchover, file_share_instant_recovery_switchover. Areas whose path has an {id} need id (repository, Hyper-V server or Instant Recovery mount). Look the model up with describe_endpoint('<path>', 'PUT') when unsure of field names. Example: config backup retention -> area='config_backup', changes={'restorePointsToKeep': 30}.

Inputs: area (required), changes (required), id, confirm_token. Returns: object

verify_encryption_passwordVerify Encryption PasswordA
Read-onlyIdempotent

Check whether password matches a stored encryption password (e.g. before a restore). Changes nothing.

Inputs: password (required), encryption_password_id (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    B3.2/5.0

    Scored across 68 tools

    Disambiguation4/5

    Most tools target clearly distinct resource+action pairs (delete_backup vs delete_backup_object vs delete_object, move_backup vs copy_backups vs move_backup_objects_to_job, start/finish Instant Recovery pairs). A few boundaries blur: stop_session vs stop_task vs stop_automation_session, the generic create_object/update_object/delete_object family vs the dedicated create_* tools, and api_write vs any dedicated write tool. Descriptions largely resolve these by explicitly stating scope (api_write is 'for write endpoints no dedicated tool covers').

    Naming Consistency3/5

    All names are snake_case, but verb conventions vary widely (set_, manage_, rescan_, start_, apply_, mark_, clone_, verify_) and a few tools are noun-only or noun-first (api_read, api_write, security_analyzer, high_availability_cluster, describe_endpoint). Patterns are still readable and mostly verb_noun, but not a single predictable scheme across 68 tools.

    Tool Count2/5

    68 tools is far beyond a well-scoped set, driven by exposing granular operations for a very large VBR domain. While many tools are individually justified, the count creates a heavy selection burden, and generic escape hatches (api_write, create_object/update_object) coexist with numerous dedicated variants, which is exactly the strain that pushes this dimension down.

    Completeness4/5

    Coverage is broad: jobs, repositories, protection groups, backup deletion/move/copy, multiple restore types, malware/IoC handling, licensing, settings, security, sessions, HA and config import/export. Minor gaps remain, notably no dedicated vSphere VM full restore (only Cloud Director and Hyper-V restores) and no dedicated job-run tool (only quick backup), but api_write and companion vbr-mcp tools provide workarounds.

    Maintenance

    ActivityMaintained
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      C
      quality
      D
      maintenance
      Enables AI agents to control and monitor Veeam Backup & Replication v13 infrastructure through 328 MCP tools using the official REST API. Supports both stdio mode for local clients like Claude Desktop and streamable HTTP mode for remote integration with platforms like Dify.
      100
      ISC
    • A
      license
      A
      quality
      A
      maintenance
      AI-powered Veeam Backup & Replication operations MCP server with tools for managing jobs, restores, sessions, and repositories, featuring built-in governance, audit logging, and safety controls.
      27
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      Exposes Zerobyte backup platform's REST API as MCP tools, enabling read-only queries on repositories, backups, snapshots, volumes, and system info.
      MIT
    • A
      license
      B
      quality
      C
      maintenance
      Lets MCP clients inspect and change FortiOS configuration through the FortiOS REST API — policies, address and service objects, routes, VIPs, DHCP, VPN, users, security profiles, live sessions and logs — across multiple firewalls from one server. All device-changing tools stay disabled until writes are explicitly enabled, keeping the server read-only by default.
      137
      MIT