Skip to Content
ConfigurationAgent Config (Windows)

Save this configuration as C:\ProgramData\xreplicator\agent.yaml. The MSI installs the agent as the XReplicatorAgent service. Use an elevated PowerShell session.

Filesystem-aware full backup is enabled in the Windows package defaults. It reads allocated NTFS ranges and reconciles dirty ranges captured during the full backup.

daemon.pipeline.fixed_block_size_mb must match the server’s server.fixed_block_size_mb.

device: paths: - "C:" - "D:" sync_wait_ms: 500 storage: type: "grpc" grpc: server_address: "YOUR_SERVER_IP:50051" timeout: 5m max_retries: 0 tls: enabled: true cert_file: "C:\\ProgramData\\xreplicator\\tls\\client.crt" key_file: "C:\\ProgramData\\xreplicator\\tls\\client.key" ca_file: "C:\\ProgramData\\xreplicator\\tls\\ca.crt" server_name: "backup-server.example.com" insecure_skip_verify: false windows: vss: application_aware: false workload_profile: "crash_consistent" usn: enabled: true block_size_kb: 64 state_persist_path: "C:\\ProgramData\\xreplicator\\usn_state.json" fallback_on_error: true auto_create: true journal_max_mb: 32 journal_alloc_mb: 16 full_scan: false schedule: full_backup: enabled: true frequency: "weekly" day_of_week: "sunday" time: "02:00" force_if_missing: true max_age_days: 30 filesystem_aware: true reconcile_after_full: true incremental_backup: enabled: true frequency: "custom" interval: "30m" skip_if_no_changes: true

SQL Server application-aware backups

For volumes containing SQL Server data, log, or system databases, use the SQL Server workload profile. SQL Server VSS Writer must be installed and running.

windows: vss: application_aware: true workload_profile: "sql_server"

This coordinates a writer-consistent VSS snapshot across the selected volumes. The backup engine is workload-independent; additional workload profiles will be added over time. Database placement, recovery-model choices, and post-restore attach or recovery actions remain administrator tasks.

Get-Service VSS,SQLWriter

Verification and troubleshooting

Get-Service XReplicatorAgent Test-NetConnection <BACKUP_SERVER> -Port 50051 Get-Content C:\ProgramData\xreplicator\logs\XReplicatorAgent.err.log -Tail 100 Restart-Service XReplicatorAgent

If the log reports USN continuity broken, the agent performs a safe full reconciliation. This can follow a volume change, journal recreation, or unclean shutdown. It scans the logical device but deduplication limits data transferred. Ensure every protected volume has sufficient VSS shadow-copy space for writes during the backup.

Last updated on