This article explains the process of creating a backup plan for Hyper-V virtual machines.
General information
One of the key features of Xopero ONE is native Hyper-V backup. It enables you to back up either all virtual machines or selected VMs on both standalone and clustered Hyper-V hosts.
Creating a backup plan
1
Log in to XMS, go to the Plans tab and click the + Add plan button in the top toolbar.
2
Select Hyper-V from the platforms list.
3
Define the name of the backup plan.
4
In the configuration aside, choose the host you want to protect. You can then either:
Back up all virtual machines (VMs) for comprehensive protection.
Select specific VMs by checking the boxes next to the desired entries.
5
Configure options specific to Hyper-V backup.
6
Choose your backup storage location.
7
Configure the by defining when backups should run and which types of backup copies to use.
8
Go to the Advanced settings section to customize additional options, including encryption, compression levels, and deduplication. These settings provide greater flexibility and help optimize the backup process.
9
After completing the configuration, click the Save button. The protection plan will then automatically begin protecting your Hyper-V virtual machines according to the schedule you defined.
Set the retention policy to determine how long backups are stored — any copies exceeding this periodwill be automatically deleted.
Overview of the Xopero Unified Protection storage architecture, including the technologies used, configuration options, and data retention mechanisms.
Xopero Unified Protection (XUP) implements a multi-layered data immutability architecture to mitigate the impact of ransomware attacks and reduce the risk of threat propagation within the storage infrastructure.
General information
The Xopero ONE system compresses and encrypts data, storing it in non-executable formats. The solution uses immutable storage compliant with the WORM standard, preventing accidental or intentional encryption, modification, or deletion of backup data. Authentication mechanisms restrict access to the storage, ensuring that ransomware cannot access stored data, even if the source machine is compromised.
The AirGap data protection method, based on xSAIR (Secure AirGap Immutable Repository) technology, provides an additional layer of security by isolating data within a demilitarized zone (DMZ) and enabling replication to the isolated environment (an additional XUP appliance). As part of Xopero Unified Protection, the AirGap solution helps ensure resilient, threat-resistant data storage systems.
Data retention and protection mechanisms
To ensure the highest level of security, XUP data storage uses advanced protection rules to prevent unauthorized or accidental data deletion. It is based on two key mechanisms: versioning and compliance.
The versioning feature is configured with a 7-day retention period — each modification or overwrite attempt creates a new data iteration, while previous versions are retained for one week. This allows users to restore data from any backup point within that period.
An additional layer of protection is based on the compliance mechanism, configured with a 24-hour retention window. In this mode:
Data can be deleted only after the minimum retention period of 7 days has elapsed.
After this period, an additional 24-hour buffer is activated, preventing final data deletion.
During the compliance lock period, no user (including the root administrator) can delete protected data earlier.
The combination of these mechanisms creates an effective security barrier that significantly extends the time required to execute a destructive attack on the data.
Versioning
Compliance
Restoring a disk from backup
How to restore a disk image from backup using Xopero Sphere Recovery Drive.
Xopero Sphere Recovery Drive enables bare-metal restoration of entire disks from previously created backups, allowing systems to be recovered to a fully operational state after hardware failure, data corruption, or system loss.
Recovery process
The following steps demonstrate how to restore a disk from a backup copy using the Xopero ONE Standalone Agent.
1
Start the computer using the Xopero Sphere Recovery Drive (you may need to change the boot order in the BIOS/UEFI settings to select the USB device as the primary boot option). After the computer starts up, press any key when the following message appears:
2
Once the Xopero Sphere Recovery Drive startup window loads, select Xopero and then choose Xopero ONE Standalone Agent.
3
In the Xopero ONE Standalone Agent backup wizard, select Restore disk and click Next.
4
Select the backup storage directory and click Next.
5
Select the specific backup copy to restore, then click Next.
6
Select the disk you want to restore from the backup copy.
7
The wizard will display the available disks on the connected computer. Select the target disk for the restoration.
8
In Restore settings, you can choose to reset system drivers.
9
Review your configuration and click Run restore to start the recovery process.
10
Once the restore is complete, a confirmation message will appear.
Any existing data on the selected disk will be overwritten.
The drivers reset option should be selected only when restoring a backup to a device with a different hardware configuration.
Overview of the components and architecture of the Xopero Unified Protection appliance, including the management system, data storage, and backup agent communication flow.
Xopero Unified Protection (XUP) integrates hardware and software components into a single appliance designed for comprehensive data protection. The XUP architecture includes an integrated data storage layer, a management interface, and a core system environment, providing centralized backup management, secure data storage, and simplified deployment. This unified design streamlines implementation, reduces infrastructure complexity, and ensures consistent protection across physical, virtual, and cloud environments.
Device architecture
Data storage and disk configuration leverage RAID technology in both software and hardware implementations.
The Xopero Unified Protection (XUP) solution consists of the following components:
Hardware layer based on rack-mounted servers.
XUP software layer — responsible for device initialization, providing S3-compatible storage, monitoring service health, and delivering the device management interface.
Xopero ONE service — enables the creation and execution of backup plans. The solution also includes a built-in backup agent.
The key system components include:
Xopero ONE backup agent, which enables high-speed data processing directly on the device.
Xopero ONE software, which enables execution of backup tasks.
XUP management console, used to monitor device status and modify network settings.
An integrated data storage system based on S3 bucket technology.
A high-performance disk architecture — the system uses storage tiering, with fast NVMe drives for the operating system and high-capacity HDDs (SATA/SAS) for backup storage in a SaaS model.
For the operating model with external network access, the Xopero Unified Protection system updates automatically. Available updates are displayed on the XUP management panel login screen.
The DMZ model, which has no external network access, requires manual updates performed by a dedicated Xopero technical support specialist.
Password reset
Find how to reset the root password in Xopero ONE for on-premise & SaaS deployment models.
1
Login to XMS, open Settings (gear ⚙️ icon in the bottom-left corner) and select Accounts.
2
Find your root account and click the edit (✏️) icon.
System components
The XUP management interface is available only in English.
System updates
For both operating models, the device must be restarted after each system update to ensure it completes successfully.
3
Enter your old password and your new password in the correct fields, then click Change.
Keep in mind that when you're creating a new root account password you have to meet the password complexity requirements.
By default, the system remembers three most recently used passwords, which cannot be used again when creating a new password — the number of previously used passwords that must remain unique can be adjusted in the Unique new passwords section under ⚙️Settings > Advanced.
4
Hit the Save button to finish. Your password should now be successfully changed.
1
Open your XMS login page and click Forgot password? link under credentials fields.
2
Enter the email address associated with your root account and hit Send me a recovery link button.
3
You will see a message confirming the password reset has been initiated. Follow the next steps based on your deployment model (SaaS or on-premise):
If the password reset was initiated correctly you will see the following message:
Open your inbox, find the email from Xopero ONE & GitProtect.io and click the Password reset button.
If you have access to your Xopero Management Service
If you don't have access to your Xopero Management Service
Set a new password for your root account and press Save.
You will receive a confirmation once the password is changed successfully.
Once you see the following message, your root accountpassword is already changed.
You can find it in a .txt file in the following path:
C:\ProgramData\Xopero ONE\Xopero ONE Backup&Recovery Service\pwdreset
email@domain.com.txt
a. For SaaS model:
Keep in mind when you're creating a new root account password you have to meet the password complexity requirements.
By default, the system remembers three most recently used passwords, which cannot be used again when creating a new password — the number of previously used passwords that must remain unique can be adjusted in the Unique new passwords section under ⚙️Settings > Advanced.
b. For on-premise model:
The following steps apply to the on-prem model without a configured SMTP server. When the SMTP server is configured, the on-prem version processes the password reset via email, similarly to the SaaS model.
Użytkownik nie ma dostępu do folderu gdzie zapisuje się hasło po resecie hasła w on-prem na XUP. Dodać ścieżkę działania (albo ustaw serwer SMPT, albo?).
Group mapping
In this article you will learn how to configure group mapping for SAML authentication.
For IdP integration, Xopero ONE uses differentiated login levels (i.e., Admin, Backup Operator, Viewer, etc.). By default, single users are being authenticated with predefined permissions, based on the roles they are assigned. If you require multiple users to log in with consistent security policies, permissions, or access rights, you can implement group mapping.
The configuration process includes specifying two key parameters: claim type and claim value— for example, in Entra ID, the following parameters refer to:
Claim type - name of the custom claim defined for the application on the Entra ID side to identify the group. In this example, claim type value is set to xoperogroup.
Claim value - a unique Entra ID group identifier (ID) to be mapped (not its name).
Xopero AirGap
Overview of the AirGap solution and its functionality.
AirGap solution overview, including the isolated backup repository, security mechanisms, and replication process.
Learn how pre- and post-replication scripts are configured in Xopero ONE Management Service to automate and control replication workflows.
The only account not subject to group mapping permissions is the root admin — logging in using SAML with different group permissions doesn't change the root admin access level; user remains the root admin after signing in, and so do their root admin assigned permissions.
Group mapping configuration.
Xopero ONE on-premises
How to sign up for a free Xopero ONE account in an on-premises management service deployment.
Learn how to register for a free Xopero ONE account with the Xopero ONE Management Service on-premises software.
Installation with an SSL certificate
Learn how to connect to Xopero ONE Management Service (XMS) admin panel via encrypted HTTPS protocol.
Kestrel configuration
Remember that once you modify the XMS settings you must switch the agent's communication protocol to HTTPS for the Xopero ONE Backup&Recovery service to work correctly.
You can find more information about Kestrel configuration .
1
Open appsettings.json file located in Xopero ONE Management Service installation directory.
Modify the following code lines— erase commented_out_ prefix and add the HTTPS configuration as follows:
Path: path to the .pfx file*
Password: certificate password
*IMPORTANT! Remember to use double slash— if you're keeping the certificate in C:\cert.pfx directory, the path should be entered as C:\\cert.pfx instead.
1
Go to your Xopero ONE Agent installation directory and open config.json file.
Default location of the config.json file is:
For Windows:C:\Program Files\Xopero ONE Backup&Recovery Agent
For Linux:/opt/XoperoONEBackupAgent/
2
Change the ServiceUrl value from HTTP to HTTPS.
You can editconfig.json with a simple text editor (i.e., Notepad, Notepad++).
Example of config.json file opened in Notepad++.
3
Once the value is changed, the agent will come back online.
Modifying the IP address or the protocol (http, https) of the Management Service will change the active agent's status to offline. It will reconnect once you switch the agent's protocol to HTTPS.
Overview of the components and architecture of the Xopero Unified Protection appliance, including the management system, data storage, and backup agent communication flow.
Overview of the Xopero Unified Protection storage architecture, including the technologies used, configuration options, and data retention mechanisms.
Planning
Learn more about planning your Hyper-V backup.
General information
Using Xopero ONE, you can protect Hyper-V environments with native support for virtual machine backups, as well as file-level and image-level backups of the physical Hyper-V host.
You can protect virtual machines using the Hyper-V backup type, while the Hyper-V host itself can be secured with file-level or image-level backups.
Backup overview
The performance of the Hyper-V host is a key factor, as it determines how many virtual machines can be secured simultaneously.
You can create backup for all machines on the host and automatically include any new machines created in the future. In the backup plan, under Advanced settings in the Task balancing tab, you can specify how many virtual machines should be backed up simultaneously. Alternatively, you can back them up individually with breaks in between.
When protecting virtual machines, Xopero ONE uses the RCT (Replica Change Tracking) function to detect changes in virtual machine disk blocks, enabling much faster backups. Alternatively, you can choose to use the classic, slower method.
You can configure the backup to bypass virtual machine disks that cannot be included in the system snapshot. This ensures the backup proceeds without those disks when snapshot inclusion isn't possible.
Backup of Hyper-V virtual machines is based on system snapshots. Different levels of support are available, but the goal is always to create application-aware snapshots, as they provide the highest consistency.
With the application-aware option, Hyper-V also creates file-system consistent snapshots. For this reason, it is recommended to keep the application-aware option enabled, especially when protecting various Linux distributions.
Login with SSO
Learn how to log in to Xopero ONE with SSO.
1
Connect to your Xopero ONE Management Service.
Use <ipAddress>:<port> for the on-prem model or your unique login URL for SaaS model.
2
Login with username and password
Simple guide on how to log in to Xopero ONE with a username and password.
1
Use <ipAddress>:<port> for the on-prem model or your unique login URL for SaaS model.
2
Select one of the available SSO options.
To log in to Xopero ONE using SSO, you can choose one of the following providers: Bitbucket, GitHub, GitLab, Google, or Microsoft. If you want to use your private identity provider for quick login, configure your IdP using the SAML protocol. See more in section.
SSO options example for Xopero ONE SaaS.
3
Go through the selected supplier's login process.
4
Once signed in, you will be automatically redirected to your XMS main page.
Application-aware snapshots
Useful links and items
Connect to your Xopero ONE Management Service.
Enter your login and password in the appropriate fields and hit Login.
System components & architecture
System architecture
Xopero ONE system architecture is presented in the following diagram:
Communication between three main Xopero platform components.
Components
Xopero ONE product as a platform consists of three main components: management service, agent, and storage.
Management system
The main component required to run Xopero ONE backup system is called Xopero ONE Management Service (abbr. XMS). It allows you to comprehensively manage your backups and related resources using XMS console with a user-friendly and easy to navigate UI. In on-premise deployment model XMS can be installed on almost any computer with Windows and Linux operating systems or Docker environment (even popular NAS devices). When it comes to SaaS deployment model, the management service runs on provider's cloud infrastructure.
XMS is divided into separate modules, each of them dedicated to a different aspect of backup management:
Dashboard
Devices
Virtual Machines
The second main component is called Xopero ONE Agent and is an application installed on end devices with Windows, Linux, or Mac operating systems. Agent performs all operations requested by XMS including data processing (i.e., encryption, compression), connecting to data storage, sending data directly to the storage, and restoring data.
The last component on the list is storage— Xopero ONE, as a multi-storage system, allows you to store your backup data in the cloud (GitProtect Cloud, AWS, and any S3 compatible public cloud), locally (NFS, SMB, iSCSI network shares, local disk resources), or in a hybrid environment.
Local worker
Worker can manage storage, perform and restore backups; it can be combined with a dedicated Microsoft 365, GitProtect, or Jira license, but it cannot back up its own device.
Installing a worker in your local environment can be crucial and essential in many scenarios. The backup agent is the only component that directly handles data during its transfer to storage.
Using a local worker helps comply with internal policies by keeping data internal and secure. It also allows direct backups to your local infrastructure, which the SaaS agent () does not have access to.
In Xopero ONE Management Service (XMS) go to the Settings, then select Advanced > Workers and click the Download agent button.
Choose your installer based on the system you want to install the worker on.
After downloading the installer, install the agent on your device — you can use the installation guides for different types of operating systems listed in Xopero ONE agent menu under DEPLOYMENT & CONFIGURATION section.
Overview
Under the licensing policy, a worker license is a free license type assigned per agent — feature worker. The only difference between a server/endpoint agent and a feature worker license is, as mentioned above, that a feature worker cannot back up its own data. It serves only as a worker while securing other data.
To back up virtual machines directly from the Hyper-V host, you need to run Windows Server 2016 or newer. Integration with older operating systems is not possible.
In addition to Windows Server editions, Xopero ONE supports the Hyper-V feature in Windows 10.
Host types
Xopero ONE supports both standalone hosts and hosts connected in clusters. In clustered environments, you must install a dedicated Hyper-V agent on each host.
If the hosts are clustered, you cannot add a single host.
Account type
When adding a Hyper-V cluster, you must use an administrator account.
Xopero ONE SaaS
How to sign up for a free Xopero ONE account in a cloud-based management service deployment.
Restoring Microsoft SQL database
This article explains how to restore a Microsoft SQL database from a backup.
The first step in restoring a Microsoft SQL database from backup is to restore the database files from storage to a temporary directory. These files will then be imported into the Microsoft SQL database environment.
To restore files backed up using a file-level backup plan follow . If your database was backed up using an image-level backup, use granular recovery to restore it as described in .
Once the database files are restored, the next step is to import them into the Microsoft SQL environment.
1
Where Xopero ONE Management Service is hosted across different regions.
Learn how to register for a free Xopero ONE account with a cloud-based Xopero ONE Management Service.
In this article, you will learn how to restore data from a file-level backup.
Xopero ONE allows you to easily restore data — an entire backup, selected directories, or individual files — to any location.
Recovery process
1
Open the restore view in Xopero ONE Management Service using one of the following options:
Option A
Go to the Devices tab and click Restore next to the device whose data you want to recover. After selecting the device you want to restore, choose the plan containing the data you want to recover from the Backup plans drop-down menu.
At the bottom of the aside, you can see which agent is being used to access the storage. To change the device, click Change. Ensure the selected device has access to the storage.
Go to the Storages tab, select the storage containing the backup data, and click the folder 📂icon to browse the storage.
Select the device whose data you want to restore. Then, choose the backup plan and review the information about the agent used to connect to the storage.
2
After selecting the appropriate device and backup plan, the system will display the Backup copies section — here, you can choose the backup version you want to restore. Click the desired date, then select Restore.
3
The Select data to restore section displays a tree structure of directories and files. You can select specific directories or individual files to restore by marking the checkboxes next to them. To restore the selected data, click Restore selected. If you want to restore all items included in the backup plan, click Restore all.
4
In the Data to restore section, you can modify the previously selected data that will be included in the restore process. To change or add data, click the Edit button.
5
The Restore to section allows you to define the destination for the restore process—here, you can select any device that is assigned to the Xopero ONE platform as the target location for your restored data.
6
In Restore directory section you can specify the exact location where the data will be restored. You can choose to restore it to the original directory or select a new directory.
7
In Restore settings section, you will find three additional options that can be enabled for the restoration process:
Overwrite existing data — determines whether existing files in the restore directory should be replaced with the restored ones.
Restore files permissions — restores the original file permissions.
8
Double-check your configuration and click the Start now button to begin the recovery process.
Registration
Learn how to register for a free Xopero ONE account with the cloud-based Xopero ONE Management Service.
Registration for a Xopero ONE account in the SaaS deployment model is a simple, self-service process on the Xopero website. To sign up, customers provide basic business contact details, select data residency, and create administrator credentials. After registration, access to the Xopero ONE Management Service (XMS) is granted via a unique SaaS login URL for subsequent provisioning, adding storage or cloud agents, and configuring roles and permissions.
The below steps outline the registration process on the .
1
Open and click the Get started button in the upper-right corner of the screen (or use ).
iDRAC scripts
Learn how pre- and post-replication scripts are configured in Xopero ONE Management Service to automate and control replication workflows.
Xopero Unified Protection (XUP) leverages iDRAC for remote, automated management of the appliance. Integration with iDRAC enables execution of predefined scripts for power management and operational control, supporting reliable execution of replication jobs.
The Xopero AirGap solution is based on a cluster of two Xopero Unified Protection (XUP) devices (offline and online) connected directly in a back-to-back setup.
XUP online operates in a standard configuration: with (or without) an active XUP Management Service, a Xopero ONE backup agent, and data storage. XUP offline contains only the data storage (S3) and, optionally, the backup agent. The redundant device remains powered off and disconnected from the network most of the time, preventing any communication with it, and is powered on only for replication purposes.
Backup and recovery
Backup and recovery guides for Xopero Sphere Recovery Drive.
How to restore a disk from backup using Xopero Sphere Recovery Drive.
Reduce bandwidth — limits network usage during the restore process.
Option B
2
Select the cloud deployment model, enter your business email address, and click Sign up free.
You can also use the Sign up with Google or Sign up with Microsoft options to register with your business account.
3
Enter all required information (name/organization, phone number, and data residency location) and set a strong password for your new account. Once completed, verify that the information is correct and click the Sign up free button.
4
Wait for the system to create your account.
5
Once the account is created, you will be redirected to the Xopero ONE Management Service landing page, where you can immediately add organizations to protect and create backup plans for them.
Xopero ONE uses a simple widget to guide users through the entire onboarding process, including connecting their first resource, configuring the environment, starting and monitoring their first backup, and performing a test restoration.
6
The system will generate a unique Xopero ONE Management Service instance URL for login. For subsequent logins, use this URL or go directly to https://xopero.com/login/.
Your unique Management Service URL will be included in the welcome email.
7
Additionally, you will receive a welcome email from Xopero containing all important information about your account and the Xopero ONE system (including your unique login URL).
Creating an account
Signing up creates a new account with a 14-day free Xopero ONE service trial.
To properly execute the replication job, every XUP device is equipped with an iDRAC to enable communication between two XUP devices. The iDRAC interface remains active at all times, as it is used to power the redundant (offline) device on and off. Predefined iDRAC scripts are responsible for controlling the replication process.
Below is the iDRAC scripts configuration menu in Xopero ONE Management Service (XMS), available during replication plan creation and editing in the Advanced settings section.
The iDRAC Power Up script is executed before the replication process starts and is responsible for powering on the redundant XUP device (XUP offline).
Username: the iDRAC username, which can be configured only during the initial setup by a dedicated Xopero support engineer.
IP address: the iDRAC IP address, which should point to the redundant XUP device. This value can be edited at any time — for example, if the network configuration changes and the iDRAC IP address needs to be updated.
Add new or select password from Password Manager: the iDRAC password, which can be configured only during the initial setup by a dedicated Xopero support engineer.
Script arguments — should remain empty; can be configured only during the initial setup by a dedicated Xopero support engineer.
Additional script options, which include how the replication task execution should be handled in the event of a script failure. These values can be modified at any time; however, changing them is not recommended.
The iDRAC Power Down script is executed after the replication process completes and is responsible for powering off the redundant XUP device (XUP offline).
Username: the iDRAC username, which can be configured only during the initial setup by a dedicated Xopero support engineer.
IP address: the iDRAC IP address, which should point to the redundant XUP device. This value can be edited at any time — for example, if the network configuration changes and the iDRAC IP address needs to be updated.
Add new or select password from Password Manager: the iDRAC password, which can be configured only during the initial setup by a dedicated Xopero support engineer.
Script arguments — should remain empty; can be configured only during the initial setup by a dedicated Xopero support engineer.
Additional script options, which include the ability to configure the script waiting interval before continuing the replication task. These values can be modified at any time; however, changing them is not recommended.
General information
Scripts configuration
The initial AirGap configuration is always performed by a dedicated deployment engineer.
iDRAC Power Up
iDRAC Power Down
Host backup
Learn how to protect a Hyper-V host with Xopero ONE.
Hyper-V, Microsoft’s virtualization platform, allows organizations to run multiple virtual machines efficiently on a single host. Ensuring the protection of both the Hyper-V host and its VMs is essential for maintaining business continuity and safeguarding data. This article outlines a simple guide on how to secure your Hyper-V environment using Xopero ONE, along with recommended best practices and additional resources.
To protect a Hyper-V host, start by installing a dedicated version of the Xopero ONE agent designed for Hyper-V environments. Once installed, the host will automatically appear in the Devices tab of Xopero ONE Management Service (XMS) admin panel.
1
Overview
To integrate VMware hosts with Xopero ONE, you need an administrator account (root is not required). You can use an existing account, but best practice is to create a dedicated VMware user with admin privileges for backup and restore tasks.
Adding VMware hosts is just the first step.
To fully integrate the VMware environment, you can install a virtual appliance (VA) on the VMware host — this enables faster backups using advanced transport methods like HotAdd. Installing the VA is not required for faster backups — you can also use a storage area network (SAN), though this requires proper configuration and a SAN datastore.
If a
vCenter
server exists in your infrastructure, connect
Xopero ONE
to the
vCenter
server rather than an individual
ESXi
host. Connecting directly to an
ESXi
host when a
vCenter
server is present may cause issues.
Account type
Transport methods
Remember that Xopero ONE requires VMware version 6.7 or later and at least an essential license.
ESXi and vCenter servers
Go to the Plans tab in the XMS dashboard and select + Add plan.
2
Select Devices from the platform list.
3
Choose the appropriate backup type based on your requirements and configure the settings to ensure proper protection of your Hyper-V host.
4
Select the Hyper-V host from the list of available devices and specify the type of data you want to back up.
5
Define the name of the backup plan.
6
Choose your backup storage location.
7
Next, set up the backup schedule and retention policy to define how often backups will run and how long they will be kept. In Advanced settings section you can also enable additional options, such as encryption and compression, to enhance data security and optimize storage usage.
8
After completing the configuration, click the Save button. The protection plan will then automatically begin protecting your Hyper-V host according to the schedule you defined.
Learn more about Hyper-V recovery limitations in Xopero ONE.
Depending on the situation, Xopero ONE uses two restoration methods: one that provides higher accuracy and another that is less precise. The system automatically selects the appropriate method based on predefined criteria.
If the configuration version on the host where the restoration is taking place is lower than that of the VM being restored, a warning labeled DW9715 will appear. You can check the host’s configuration version using the following PowerShell command:
If the VM you backed up had the TPM (Trusted Platform Module) enabled, a warning labeled DW9717 will appear during restoration.
Several important settings cannot be restored using the less accurate method. These include:
It’s important to note that this limitation originates from Hyper-V itself.
TPM enabled on the backed-up machine
TPM (Trusted Platform Module) is a hardware-based security feature that protects system integrity and sensitive data by providing cryptographic keys. Restrictions on restoring VMs with TPM enabled stem from limitations inherent to Hyper-V.
Not restored by less accurate method
Keep these limitations in mind when restoring Hyper-V machine settings. If you have any questions or encounter issues, contact Xopero ONE technical support for assistance.
This article describes how to add a Hyper-V server to Xopero ONE.
Adding Hyper-V
In Xopero ONE, the minimum supported Hyper-V server version is Windows Server 2016. Integration requires a Hyper-V per-socket license, based on the number of sockets in the server's motherboard. For example, a server with two CPU sockets needs two licenses (even if there's only one processor).
1
Log in to XMS, open the Virtual Machines tab on the left side of the window, and select Hyper-V from the list.
2
Click the Connect button under Hyper-V.
3
Download and install the agent
on all Hyper-V hosts you want to protect. After installation, the device(s) will appear in the upper-right corner for activation. Once added, it will be listed in the Devices tab and ready to protect physical hardware.
4
Activated devices will now appear in the Available hosts section. Select the host(s) you want to integrate with, and click Save.
5
Specify the frequency at which the Hyper-V server should refresh.
6
Once these steps are complete, you can start planning your Hyper-V backup strategy.
Integrating a Hyper-V cluster in Xopero ONE follows , with one key difference: the agent must be installed on every host in the cluster. When adding the cluster, select all machines to include in the setup and enter the cluster IP address, and administrator’s login credentials.
Deployment
Learn how to install and configure the Xopero Unified Protection appliance.
Overview
Hyper-V virtual machines restoration process overview.
When working with backup software, it’s important to know how to restore your data efficiently. Xopero ONE offers multiple methods to restore virtual machines directly to Hyper-V hosts — select one that best fits your requirements.
The instant restore feature quickly restores a VM’s configuration files to the Hyper-V host and prepares the virtual machine by mounting its disks directly from storage using the iSCSI protocol. This enables the VM to start within minutes. Because the data remains in the backup storage, no actual data is copied or restored elsewhere, allowing fast access without duplicating the backup.
To restore a virtual machine to Hyper-V after an incident, run both the instant restore and whole VM recovery tasks at the same time. This allows you to access and use the VM almost immediately via instant restore. Once the whole VM recovery is finished, you can stop the instant restore
Cloud worker
In this article you will get information about cloud worker - what is it, their usage, and their licensing model.
The cloud worker is a Xopero ONEagent installed in the cloud. It connects to cloud-based environments like Microsoft 365 or cloud storage services to perform backup tasks.
You don't have to assign any licenses to cloud workers — the correct license is assigned automatically by Xopero ONE system.
Cloud worker's installation location depends on the Xopero ONE Management Service installation directory.
Database backup recovery
Rack compatibility
Xopero Unified Protection appliance hardware specifications for standard server environments.
Xopero Unified Protection (XUP) is designed for seamless integration into modern data center environments. The hardware appliance adhere to global industry standards, ensuring compatibility with existing server infrastructure and enabling straightforward deployment in standard rack cabinets.
Server racks are measured in rack units (U), where 1U equals 4.45 cm (1.75 inches) in height. The industry standard for a full-sized cabinet is 42U, which provides space for servers, networking, and storage.
Xopero Unified Protection (XUP) is available in two physical configurations:
Small (1U) — a compact, slim design suitable for both high-density environments and small server rooms.
Backup
Xopero ONE Management Service (XMS)
Recovery
Cloud worker is available only for the Xopero ONE SaaS deployment model.
process and switch to using the fully recovered VM in production.
Whole VM recovery allows you to restore a virtual machine to its original location or to a new one. This is the standard method for VM restoration — Xopero ONE retrieves the VM data directly from storage and restores it to the Hyper-V host.
Instant restore is perfect for immediate disaster recovery, giving rapid access to your virtual machines within minutes.
Whole VM recovery ensures that your VM is fully restored and ready for production use.
Using both methods together allows you to quickly recover Hyper-V virtual machines while minimizing downtime.
General information
Note that these restore options also allow you to transfer VMs between different Hyper-V hosts, as long as they are connected to the Xopero ONE Management Service.
Instant restore
This method is intended for disaster recovery scenarios and should not be used as a standard production restoration process.
Note that this is a non-production restore; any changes or modifications made during the instant restore session are temporary and will not be saved. When you perform another restore, these changes will no longer be visible.
All modifications are written only to the Hyper-V host’s temporary files.
Whole machine restore
Summary
Standard (2U) — a configuration that provides additional physical space for increased storage capacity.
Every XUP appliance ships with sliding rails included in the kit.
The appliance has a chassis depth of approximately 58.42 cm (23 inches), making it compatible with most standard-depth racks and many medium-depth wall-mounted and office cabinets.
Rack form factors
Both XUP device models are designed to fit standard 48.26 cm (19-inch) wide rack rails, ensuring they can be mounted alongside your existing hardware without additional modifications.
Dimensions and clearance
To ensure proper cable management and adequate airflow for the power supplies, a minimum rack depth of 68 cm (26.77 inches) is recommended.
Restoring MySQL database
This article explains how to restore a MySQL database from a backup.
MySQL database can be restored to its original location or to a new temporary directory.
How to restore MySQL database from backup
The first step in restoring a MySQL database from backup is to restore the database files from storage to a temporary directory. These files will then be imported into the MySQL database environment.
To restore files backed up using a file-level backup plan follow this guide. If your database was backed up using an image-level backup, use granular recovery to restore it as described in this article.
Xopero recommends restoring the database files to their original directory to avoid potential permission issues in a different location.
Once the database files are restored, the next step is to import them into the MySQL environment. To restore the database to the MySQL server, use a database management tool.
This guide uses the MySQL command-line utility.
1
To restore the database, log in to the database server using the following command:
SERVER_ADDRESS — the address of the MySQL server where the database will be restored
USER — the username of the database user
2
Next, type:
DATABASE_NAME — the name of the database where the dump file will be restored
‼️ If the corrupted database still exists in MySQL, first drop it and recreate the database using the following command:
3
The database backup is restored using the SOURCE PATH_TO_FILE command, replacing PATH_TO_FILE with the full path to the previously restored database file. The syntax is as follows:
Registration
Learn how to register for a free Xopero ONE account with the Xopero ONE Management Service on-premises software.
The on-premises deployment model for Xopero ONE includes registering on the Xopero website and downloading and installing the Xopero ONE Management Service on a supported Windows, Linux, or Docker host. Complete the first-run setup by creating an administrator account with a valid email address and a password that complies with the product password policy; once the Management Service is operational, configure storages, then download, deploy, and activate agents on the endpoints you intend to protect.
Creating an account
The below steps outline the registration process on the Xopero ONE website.
Signing up creates a new account with a 14-day free Xopero ONE service trial.
Select the on-premises deployment model, enter your business email address, and click Sign up free.
3
Enter all required information (name/organization and phone number). Once completed, verify that the information is correct and click the Sign up free button.
4
If the registration form is submitted correctly, you will be redirected to the Xopero ONE Management Service download page.
5
Wait for the system to create your account. Once it is created, you will receive a welcome email containing your license key.
6
To start using Xopero ONE, install the Management Service on a supported device and complete the initial configuration steps, including creating the root administrator account and entering the license key provided in the email. Once completed, you can proceed with integrating your resources and begin protecting them.
Features
In this article, you will learn more about the Hyper-V backup features.
Application-aware backup
In Xopero ONE, you can enable application-aware backups for Windows Server virtual machines, which allows you to create consistent backups. This functionality is based on Microsoft VSS (Volume Shadow Copy Service), which silences applications and suspends write requests for up to 60 seconds. VSS flushes the file system buffer and freezes the file system, ensuring that metadata is saved and data is written in a consistent order. You can also enable the Continue backup on errors option, which allows the backup to proceed even if application-aware issues occur.
Hyper-V RCT
Definition
Hyper-V RCT (Resilient Change Tracking) is a built-in feature of the Hyper-V architecture that tracks changes in the disk blocks of virtual machines. Similar to VMware’s Changed Block Tracking (CBT), it greatly improves the efficiency of data backup operations. RCT allows incremental and differential backups to run faster and more effectively by providing a direct list of changed blocks since the last backup, eliminating the need to compare current VM disk data with previous backup versions.
RCT works by maintaining a dedicated change tracking log for every virtual disk connected to a VM. This log keeps track of all disk blocks that have been modified since the last backup. When a backup starts, RCT supplies the backup software with a list of these changed blocks, allowing it to copy only the modified data. The tracking log is continuously updated after each backup, ensuring that future backup operations remain fast, incremental, and efficient.
Incremental backups — RCT is highly effective for incremental backups, as it identifies and captures only the data blocks that have changed since the last backup. This approach greatly reduces both the backup duration and storage consumption.
Differential backups —in case of differential backups, which include all changes made since the last full backup, RCT simplifies the process by directly identifying the modified blocks. This makes differential backups faster, more reliable, and easier to manage.
The skip disks feature in Hyper-V allows the backup process to omit certain disks from snapshot creation. This applies to disks where snapshots are not supported or practical, such as shared disks or physical disks directly attached to a virtual machine. By skipping these disks, Hyper-V ensures that the backup operation can continue smoothly without errors or interruptions, maintaining the overall stability and reliability of the backup process.
Skip disks feature highlights Xopero ONE’s adaptability and commitment to delivering a seamless backup experience, even in complex virtualized environments. By leveraging this feature, IT administrators can optimize backup performance, increase flexibility, and ensure reliable protection of their virtual infrastructure against data loss and downtime.
Shared Virtual Hard Disks (VHDX) — when virtual machines use shared VHDX files for clustering, these disks typically cannot be snapshotted. The skip disks feature allows such configurations to be backed up while excluding the shared VHDX, ensuring the process completes successfully.
Physical disks — for VMs that use physical disks through pass-through functionality (directly attached storage), standard snapshot methods do not apply. By skipping these disks, the backup can proceed smoothly, protecting the rest of the environment without interruption.
Virtual machines with Fibre Channel adapters
Supported platforms
Below you can find all supported OS for XMS (Xopero ONE Management Service) and Xopero ONE agent.
Supported operating systems:
Post-installation actions
This article contains information about how to proceed after installing the Xopero ONE Management Service (XMS) component.
To access the on-premise Xopero ONE Management Service, connect to the device which XMS console is installed on, using the following address:
ipAddress- the IP address of the device with XMS installed on
port- port defined during installation process— by default, Xopero ONE uses 28555
Virtual machines
— VMs configured with
Fibre Channel
adapters may encounter backup failures if the
skip disks
option is not enabled. Using this feature prevents such errors and helps maintain the stability and reliability of the backup operation.
DATABASE_NAME — the name of the database to be created for importing the database dump
After creating the new database, use the USE DATABASE_NAME command as described above.
mysql -h SERVER_ADDRESS -u USER -p
USE DATABASE_NAME
CREATE DATABASE DATABASE_NAME
SOURCE PATH_TO_FILE
Useful links and items
If your Management Service opened successfully, you can proceed with the below steps (creating your root account, adding the license code, logging in, running your first setup).
1
Create the administrator account.
When you launch the Management Service for the first time, you will be prompted to create an administrator account. To register a valid admin account you have to provide your login (it has to be a valid email address) and create a password compliant with the Xopero password policy.
Once you complete the form click Register to proceed to the next step.
2
Add the license key.
Having the administrator account registered, you will then be asked to provide a license key (which you should've received via email upon registering for Xopero ONE)— this is the last step before the Xopero ONE system becomes operational and ready to use.
Once done, click Proceed to go to the system setup.
3
In the initial setup you should add your first device which you want to use to set up the storage. Then, you have to install the backup agent and activate it in Xopero system.
Next, add the storage where you want to store your data. As Xopero ONE is a multi-storage system, you can add different storages from different sources and use both local storage (i.e., SMB, NFS) and cloud solutions (i.e., Wasabi, Amazon, etc.).
With all system components initialized, you can start protecting your data and create backup plans.
ipAddress:port
Accessing XMS in on-prem deployment model
Xopero ONE first configuration
Virtual appliance
Learn about virtual appliance and its role in Xopero ONE backup.
Overview
A virtual appliance (VA) is a virtual machine image running on a Linux-based system with the Xopero ONE application pre-installed. It can be deployed through the Xopero ONE Management Service (XMS).
The main purpose of a VA is to act as a backup proxy. It enables the use of SCSI HotAdd, one of the fastest transport methods, which allows attaching devices to a running virtual machine. This capability is especially useful for both backup and restore operations.
The default virtual appliance (VA) configuration parameters are:
2 CPUs
4 GB RAM
100 GB disk space
1
Log in to XMS, open the Virtual Machines tab on the left side of the window, and select Deploy virtual appliance at the top.
2
The system will display the New VMware protection view, where you can select one of the VMware environments available in Xopero ONE
Image-level backup
In this article you will learn how to configure image-level backup using Xopero ONE Management Service.
Image-level backup creates a full snapshot of your system, including the operating system, applications, and data.
Overview
Drive image-level backup (aka disk image backup) by definition creates a complete, byte-for-byte copy of a hard drive, including the operating system, all installed applications, settings, and other data. In case of failure, drive image-level backup allows for a rapid and full restoration of the system to its previous state, either on the original or a new device.
Backups of Linux-based systems are created without snapshot integration (LVM/Btrfs/DMERA).
Backup types example in Xopero ONE Management Service.
Creating a backup plan
Drive image-level backup plan can be applied to multiple devices at once.
1
Log in to Xopero ONE Management Service, go to the Backup tab (Plans > Backup) and click the + Add plan button in the top toolbar.
2
Select Devices from the platforms list.
3
In the next aside, select Whole OS option and choose one or more devices for the plan to apply to (you can also select the plan to include all activated devices, or select device groups for the plan to cover).
4
Define the name of the backup plan.
5
In the Data to protect section, select the data you want to include in the backup plan:
Global rules allow you to define locations that will apply to all selected devices. This method offers the Xopero variable option, which provides a predefined list of variables such as SYSTEM_DISK, ALL_DISKS, and HOMES.
6
Specify the backup location by choosing from the available storage options within your service.
7
Configure the by defining when backups should run and which types of backup copies to use.
8
Go to the Advanced settings section to customize additional options, including encryption, compression levels, and bandwidth limit. These settings provide greater flexibility and help optimize the backup process.
9
After completing the configuration, click the Save button. The protection plan will then automatically begin protecting your devices according to the schedule you defined.
Two-factor authentication (2FA)
Learn how to enable two-factor authentication in Xopero ONE.
Xopero ONE supports two-factor authentication (2FA) based on an authenticator application. To use 2FA with your Xopero ONE account, you must first enable it in the Xopero ONE Management Service (XMS) admin panel and then complete the setup.
1
Click your profile icon in the top-right corner of your XMS panel and select Account.
.
3
The selected environment will be responsible for running the Xopero ONEvirtual appliance. You can choose the specific host or cluster on which the machine will run, as well as the datastore that will store the virtual machine drives.
4
The next section is dedicated to the virtual network, where you can configure the network for your machine, guest OS username and password, as well as the Xopero ONE Management Service (XMS) address, which the application on the virtual appliance will use to establish a connection.
The password for the created virtual appliance on the host can be found in its description (notes). It is recommended to change it to a new, secure password after the machine is created.
Make sure the device used for deployment can communicate with your VMware host or cluster, as it will be responsible for the installation. If communication between the selected device and VMware is unavailable, the process will fail.
Devices with macOS are not supported as deployment devices for virtual appliances in Xopero ONE.
5
In Network settings you can also configure the IP settings by selecting Automatic assignment (DHCP) or Manual setup from the drop-down list. The first option automatically assigns network settings to the virtual machine adapter through the DHCP protocol, while the second option allows you to configure each parameter manually according to your preferences.
6
After making your selection and providing all the required details, click the Save button in Network settings, then click Next to install the virtual appliance. The system will display the progress of the deployment process.
7
Once the process completes successfully, the system will display a success message. You can now use the virtual appliance agent as a worker device in any VMware backup plan.
Xopero recommends using a virtual appliance to achieve the highest backup efficiency.
Deployment
You must have at least one VMware organization added for this option to appear.
Select from device — this method allows you to select disks individually for each device by connecting remotely to its file system.
S3 storages have a buffer limit which is set to 128 MiB by default and allows you to transfer ~1250GiB of data. You can expand your buffer by following the backup optimization guide.
Set the retention policy to determine how long backups are stored — any copies exceeding this period will be automatically deleted.
You can also click Save&Run button to immediately start the backup process, regardless of schedule.
Note that you cannot select specific partitions — the entire disk, including all partitions, is always backed up.
If a disk containing the boot partition is not included in the backup, the operating system cannot be restored from that backup.
2
Toggle Two-factor authentication button and click Save in the bottom-right.
2FA option turned on.
3
You will see the change confirmation in the top-right corner of the screen. Once done, log out of your XMS, then log back in to trigger 2FA setup.
1
Scan the QR code or copy the secret key to your authenticator app.
2
Enter the code from your authenticator app in the designated fields. Once done, click Verify now to finish the application setup.
3
If the verification is successful, you will see a confirmation message.
Below the message you will find your recovery codes — save them before you go to the management console app. If you fail o save the codes right away, you can generate them later in your XMS account settings.
4
Your 2FA setup is now complete. Next time you login to your XMS panel, you will be prompted to verify yourself with 2FA.
If you lose access to your authenticator app, you can log in to Xopero ONE Management Service using one of the recovery codes generated during 2FA setup.
Unused codes do not expire over time; they remain active until used or until new codes are generated, either manually or by re-registering the 2FA.
If you have used several codes or suspect they have been compromised, you can generate a new set by going to ⚙️ Settings > Accounts > Edit account and clicking Generate recovery codes button.
1
Log in to your account (use a recovery code if your authentication device is lost or otherwise unavailable).
2
Go to ⚙️ Settings > Accounts > Edit account.
3
Toggle Two-factor authentication off to disable it and save the change. Then toggle it back on and save the change again.
4
Your 2FA configuration is now reset. During your next sign-in, you will be prompted to complete the authenticator app setup.
2FA (two-factor authentication) is a security method that requires two verification factors to confirm a user’s identity, making accounts much harder to compromise even if a password is stolen.
General information
You can always enable or disable two-factor authentication for your own account. To manage 2FA settings for other users, you must have the UserManagement permission.
Enabling 2FA in Xopero ONE
Account settings in XMS.
2FA setup in Xopero ONE
After you enable 2FA in XMS, you will be prompted to complete the authenticator app setup during your next login. After the setup is complete, all subsequent logins will require successful two-factor verification.
Recovery codes
Each code is valid for a single login only — once used, it expires.
Reconfiguring the authenticator app
Run your first setup.
Browse Xopero ONE agent category to find more information about agent installation.
Learn how to integrate Active Directory with Xopero ONE using LDAP.
Integrating Active Directory (AD) with Xopero ONE enables automated user provisioning upon login, group-to-role mapping, and administrative fallback authentication.
General information
Integrating Active Directory (AD) with Xopero ONE (supporting both LDAP and LDAPS protocols) enables centralized and automated permission management within the backup system.
The automatic provisioning feature eliminates the need to create user accounts manually. Instead, each user's Xopero ONE profile is created automatically during their first login. User information and assigned roles are continuously synchronized and updated based on the Active Directory group structure. Administrators can further control the Xopero ONE environment by limiting authentication to selected AD groups and configuring the system's default language.
Additionally, administrators retain independent emergency access to the system. After each successful authentication, the system stores user's LDAP attributes and group memberships retrieved from Active Directory in its local database, while the user's password is securely managed by the password module. If the Active Directory server becomes unavailable, the system retrieves the required user and group information from the local database. If the provided password matches the securely stored record in the password module, the user is authenticated and granted access as if they had logged in through Active Directory.
The following steps outline how to configure Active Directory (AD) settings in Xopero ONE Management Service.
1
Navigate to ⚙️ Settings > External Identity Providers, then click Add new provider and select Active Directory.
2
Specify the required parameters.
The following steps outline how to configure group mapping settings in Xopero ONE Management Service.
1
Navigate to ⚙️ Settings > External Identity Providers, then click Add new provider > Active Directory or edit an existing one. In the Active Directory configuration aside, scroll down and click Group mapping.
2
In the next aside, click + Add new group mapping (or edit an existing one) and specify the required parameters.
Microsoft SQL database backup
This article explains how to configure the Microsoft SQL database environment using Xopero ONE.
The Microsoft SQL database backup process in Xopero ONE consists of two steps:
Creating a database dump using backup scripts.
Backing up the database dump.
The first step is performed through Xopero ONE
Oracle database backup
This article describes how to configure the Oracle database environment in Xopero ONE.
The Oracle database backup process in Xopero ONE consists of two stages:
Creating a database dump using backup scripts.
Backing up the created dump file.
The first stage is executed through Xopero ONE using the
Instant restore
Instant restore - disaster recovery feature.
Instant restore provides immediate virtual machine recovery— it restores VM’s configuration files to the Hyper-V host, prepares the VM, and mounts its disks directly from the backup. This allows the Xopero ONE administrator to start using the VM almost immediately, without waiting for the full restoration.
1
Open the Hyper-V tab (Virtual Machines > Hyper-V) in XMS, then click the Manage & Restore
Name: custom IdP name.
Server address:Active Directory server address, either IP or FQDN.
Server port: 389 (LDAP) or 636 (LDAPS).
Start point: the starting point in the Active Directory tree (e.g., ou=local-dev,DC=ad,DC=local,DC=dev,DC=organization,DC=com).
Account name: service account name, either UPN (username@domain) or DL (domain\username).
LDAP server certificate: if required by your network infrastructure, upload the server's security certificate (PEM, DER, or CRT format) to verify the server's identity.
Directory synchronization frequency: define how often the user database is refreshed and synchronized with Active Directory.
Add or select password from Password Manager: service account password.
3
Select the preferred language, default role assigned to users, and default user permissions.
4
To define roles for specific user groups, click Group mapping. You can configure group mapping at any time, either during the initial integration or later.
If no group mapping is configured, all users within the specified Active Directory domain inherit the default role and permissions for their Xopero ONE accounts.
5
Before proceeding, you can test the connection by clicking the question mark at the bottom of the configuration panel.
6
Review your settings and click Save. After successfully integrating Active Directory with Xopero ONE, a Xopero ONE account is created for each user upon their first login, with permissions based on the default roles or group mapping.
Users can log in to the Xopero ONE Management Service using either their UPN (username@domain) or DL (domain\username).
Claim type: context for the claim value, in this case http://schemas.microsoft.com/ws/2008/06/identity/claims/role
Claim value: name of the Active Directory (AD) group (for example, Domain Admins).
Role: permission level that will be assigned to all users belonging to the specified AD group.
Permissions: supplementary privileges to grant to the specified AD group beyond their base role (optional).
3
Review your configuration details and click Save. Once done, all users within the specified Active Directory group will automatically inherit the selected roles and permissions.
Access mapping applies dynamically, both during initial user provisioning and as an immediate update to existing Xopero ONE accounts.
Adding Active Directory service to Xopero ONE
Group mapping
Useful links and items
The connection will succeed if the certificate specified in the settings—or located in the certificates directory (matching the server name)—is valid and matches the server's certificate. Otherwise, the system falls back to default verification, meaning self-signed certificates will be automatically rejected and the connection will fail.
using the
backup scripts
feature. The second step is a standard
file-level
or
image-level
backup executed directly by
Xopero ONE
.
1
Log in to XMS, go to the Backup tab (Plans > Backup) and click the + Add plan button in the top toolbar.
2
Select Devices from the platforms list.
3
In the next aside, select one of the available options and choose one or more devices for the plan to apply to (you can also select the plan to include all activated devices).
4
Define the name of the backup plan.
5
Configure your backup plan according to your needs (more information about the backup plan setup can be found in and articles).
6
Go to the Advanced settings section and click Edit to customize additional options.
7
Scroll down to the Backup scripts section and click the Pre-task script toggle to turn it on.
8
Select the script dedicated to backing up the Microsoft SQL database environment (Windows).
9
Type your database username into the Database user field.
10
Choose the user password by opening the Password Manager, where you can either add a new password or select an existing one.
11
Set up the script arguments — it should be entered in the Script arguments field as follows:
copy_type — defines the type of copy to be performed. You can choose one of three options: full_only, full_diff, or copy_only:
12
You can enable the two additional options using the checkboxes:
Wait for the script to continue the task — the application will wait until the dump is ready.
Fail the task if the script fails — if the script fails, the system will notify you of the backup error.
13
Double-check your settings and click Save to close the Advanced settings aside.
14
After completing the configuration, click the Save button. The protection plan will then automatically begin protecting your devices and databases according to the schedule you defined.
15
That’s all you need to do to create the database dump — this file should now be included in the Data to protect section if you are performing a file-level backup (to back up only the database). Alternatively, you can run an image-level backup to protect the entire drive.
In Xopero ONE, you can back up a variety of databases, including Oracle, MySQL, PostgreSQL, and Microsoft SQL.
General information
Backup configuration
If a file-level backup plan has already been created and is running, you can skip directly to step 6.
feature, while the second stage is performed as a standard file-level backup.
Xopero ONE creates a full database copy using the RMAN tool. It does not interfere with other copies performed by RMAN, but the backup created by Xopero ONE will be visible in RMAN.
The Oracle database environment must operate in ARCHIVELOG mode. For instructions on how to change the database mode, refer to this article.
1
Log in to XMS, go to the Backup tab (Plans > Backup) and click the + Add plan button in the top toolbar.
2
Select Devices from the platforms list.
3
In the next aside, select Files & folders option and choose one or more devices for the plan to apply to (you can also select the plan to include all activated devices).
4
Define the name of the backup plan.
5
Configure your backup plan according to your needs (more information about the backup plan setup can be found in ).
6
Go to the Advanced settings section and click Edit to customize additional options.
7
Scroll down to the Backup scripts section and click the Pre-task script toggle to turn it on.
8
Select the script dedicated to backing up the Oracle database environment.
9
Set up the script arguments — it should be entered in the Script arguments field as follows:
ORACLE_SID — the database identifier.
dbuser — the name of the user with backup privileges (for example,
10
You can enable the two additional options using the checkboxes:
Wait for the script to continue the task — the application will wait until the dump is ready.
Fail the task if the script fails — if the script fails, the system will notify you of the backup error.
11
Double-check your settings and click Save to close the Advanced settings aside.
12
After completing the configuration, click the Save button. The protection plan will then automatically begin protecting your devices and databases according to the schedule you defined.
Add a new user (for example, dbuser) to the Linux operating system by executing the following command:
Add the user to the dba group, which has permission to perform backups:
Finally, configure the system environment variables by following the instructions in this article.
In Xopero ONE, you can back up a variety of databases, including MySQL, Microsoft SQL, PostgreSQL, and Oracle.
General information
sudo useradd dbuser
sudo usermod -a -G dba dbuser
The backup reflects the database state at the moment the dump creation task finishes, as Xopero ONE attaches the archive logs to ensure data consistency.
Requirements and limitations
Xopero ONE supports Oracle database environments starting from version 19c.
Xopero ONE supports Oracle database backup only on supported Linux operating systems.
Backup configuration
If a file-level backup plan has already been created and is running, you can skip directly to step 6.
Creating a user to back up Oracle
Oracle tools may require additional permissions, such as access to the file system — in that case, you may need to add the user to other groups depending on your system configuration.
button next to the host whose backup you want to restore.
2
Select the VM you want to restore and click the restore button.
3
After choosing the backup plan and VM version, click Restore under the backup copy you wish to recover and select the Instant restore option from the drop-down list.
4
Specify whether to restore the VM to its original location or a new one. Provide key details, including the restored VM’s name, desired power state (on/off) after restoration, and the iSCSI port to use.
5
Next, select a directory for the VM configuration files, choose a location to store the VM disks, and assign a Hyper-V switch or resource pool for the network adapters.
In Restore settings you can also limit the internet bandwidth.
6
Once configured, click Start now to begin the restoration process.
You can monitor active instant restore tasks in the Tasks tab in XMS. When you're finished working with the VM, you can shut it down by canceling the instant restore job — click the X button and confirm the cancellation.
General information
Instant restore is intended only for disaster recovery and is not suitable for production use — to restore production data, use the whole VM recovery option.
When a VM backup is stored in cloud storage, the instant restore feature may work slower due to the need for random-access read operations.
Restoration process
Monitoring
Hardware deployment
Instructions for deploying Xopero Unified Protection hardware, including appliance installation, network configuration, and initial system setup.
To enable remote deployment of Xopero Unified Protection by a Xopero representative, the appliance must be physically installed in the rack cabinet, connected to the network and power source, and powered on. Hardware deployment includes on-site mounting, initial network and storage configuration, and basic provisioning through the Xopero Unified Protection management interface to prepare the system for further configuration and activation.
Device deployment
The below is a step-by-step guide for deploying a Xopero Unified Protection (XUP) appliance.
In the default configuration, the device requires internet access, at minimum for communication with the endpoints specified by Xopero. Deployment in a DMZ is only possible if this requirement is communicated in advance, prior to the device being shipped.
1
Install the XUP device in a rack-type server cabinet using the included mounting rails.
2
Connect the device to a power source. The device supports redundant power supplies (two independent power units), enabling connection to two separate power lines.
3
Connect the device to the LAN using the Ethernet ports located on the rear panel:
Port 1: eno8303
Port 2: eno8304
4
After connecting the device to the LAN, it is ready to be powered on.
The below is a step-by-step guide for initializing a Xopero Unified Protection device and performing the first login.
1
Connect the device to a monitor to access the Xopero Unified Protection Management Service (XUP Management Service) panel and create a Xopero ONE administrator account.
2
Power on the device using the power button located on the front panel.
3
Restoring PostgreSQL database
This article explains how to restore a PostgreSQL database from a backup.
PostgreSQL database can be restored to its original location or to a new temporary directory.
How to restore PostgreSQL database from backup
The first step in restoring a PostgreSQL database from backup is to restore the database files from storage to a temporary directory. These files will then be imported into the PostgreSQL database environment.
To restore files backed up using a file-level backup plan follow this guide. If your database was backed up using an image-level backup, use granular recovery to restore it as described in this article.
Xopero recommends restoring the database files to their original directory to avoid potential permission issues in a different location.
Once the database files are restored, the next step is to import them into the PostgreSQL environment.
1
Log in to your database server using SSH.
2
Enter the following command:
3
The database has been successfully restored
Bare-metal recovery
Restore the entire system from an image-level backup copy.
Bare-metal recovery (BMR) restores your entire system from an image-level backup, including the operating system, applications, and all associated data.
BMR (bare-metal restore, also known as bare-metal recovery) enables rapid system recovery using a system image created with disk-imaging software. The image file restores the entire operating system and its underlying configurations in minutes, completely bypassing the lengthy process of manual OS and application re-installation. Because BMR allows you to quickly return a physical machine or server to its full operational state following a data-loss event or hardware failure, it serves as a cornerstone of an effective disaster recovery strategy.
In Xopero ONE, the BMR process is streamlined into four primary steps:
Overview
This article provides general information about data protection planning.
To protect your workstations and servers, you can use one of three main types of backups:
File-level — saves individual files and directories.
Similarly to backup types, Xopero ONE offers three methods to restore your data:
File-level backup — allows you to restore files directly from your storage. It can also be used to restore databases protected with file-level backup.
Image-level backup — enables restoring an entire disk, individual files from the backup, or the disk as an image file. You can also use BMR (bare-metal recovery) technology to recover data, allowing restoration between physical devices.
Database recovery — includes methods for restoring previously backed-up databases.
Test the Xopero ONE system to determine when backups are performed and choose the best backup schedule. For example, you can schedule backups to run after working hours and enable automatic device shutdown after the backup in the plan settings.
The backup process typically uses the VSS service and device resources. To reduce resource usage, you don’t need to create multiple backup plans for different storages — instead, you can create a replication plan to copy data to another storage.
With Xopero ONE, you can protect multiple components of your infrastructure, including workstations and servers.
environment. Instructions for creating this user are provided in the
section of this article.
temp_directory — the directory where the Oracle tool will temporarily write backup files. After the backup tasks are complete, these files will be deleted. This directory must also be included in the Data to protect section when creating a file-level backup plan.
You can also click Save&Run button to immediately start the backup process, regardless of schedule.
This command does not create the database. If you want to import the database dump file into a non-existing database, you must create the database first. If you want to restore the dump file to an existing database, you must drop the database, create it again, and then import the dump file.
full_only — always performs a full copy.
full_diff — performs differential copies with periodic full copies.
copy_only — creates a full database copy without affecting the regular backup cycle.
server_name — the name of the Microsoft SQL server along with its instance.
output_dir — the directory where database dumps will be saved. This directory must also be selected as the location to back up.
database1database2 (...) — names of databases to be backed up, separated by spaces. You can leave this parameter empty — if no database is specified, Xopero ONE will automatically back up all databases from the server specified in the database access parameters.
It is strongly recommended to create a dedicated user specifically for database backup operations.
The user entered in the Database user field must use SQL Server authentication.
You can also click Save&Run button to immediately start the backup process, regardless of schedule.
If your operating system runs other backup software or schedulers that perform additional database dumps, use full_only dumps. Using other types (full_diff or copy_only) may cause issues when other processes on the system also create database dumps.
Full copies are executed according to the defined schedule. Differential copies are performed whenever differential or incremental backups are scheduled. If a file containing a differential copy is deleted, the next differential copy will be created based on the most recent full copy.
Selected models may also include SFP+ ports for fiber-optic cables:
SFP+ port 1: eno12399np0
SFP+ port 2: eno12399np1
Once the device initialization is complete, an account setup wizard will appear — enter your email address and set a complex password to create the main administrative account.
4
Enter your license key to activate the service and enable further configuration of the system.
5
After activating the license, the XUP Management Service panel will open. In this panel, you can view the device status and modify network settings.
Initial startup
For the initial startup, an environment with an active DHCP server is required to allow the device to automatically assign a temporary network configuration. If no DHCP server is available and no prior arrangements for a static network configuration have been made with the Xopero team, the device will not start independently (the system will halt at the "Awaiting for service readiness" screen). In this case, contact your Xopero account manager for further instructions.
The XUP Management Service can be accessed only on the XUP device using a connected monitor. To create an administrator account without connecting the appliance to a monitor, open a web browser on a device within the same network and enter the XUP IP address. After completing account creation and providing your license key, you will be automatically redirected and logged in to the Xopero ONE Management Service (XMS) panel.
The iDRAC port is intended solely for remote hardware management and is not used for regular XUP system communication.
This account serves as the local root administrator and is the only account of this type in the system. Once the root admin account is created, additional user accounts can be added.
Create an ISO file that includes the pre-configured
Xopero ONE
backup agent.
Write the ISO file to a USB flash drive—or any alternative bootable media—to create a recovery drive.
Boot the target device (the device you intend to restore the system image to) using the newly created ISO media.
Log in to the Xopero ONE Management Service (XMS) and start the recovery process.
The following steps outline the process of creating an ISO image with a pre-configured backup agent using the SVS Creator utility.
1
Download the SVS Creator utility from the official Xopero website and extract the contents of the ZIP archive to a separate folder.
2
Run SVSCreator.exe to open the creation wizard.
3
In the SVS Creator wizard window, specify the temporary working directory path, which also serves as the output destination where the final ISO image will be created. By default, this path is set to C:\Windows\Temp, but you can modify it to a different directory if needed. Once the path matches your preferences, click Next.
4
Select the appropriate OS architecture (32-bit or 64-bit), then click Next.
5
The wizard will then automatically download and install the required components.
6
Once all required components are successfully installed, you have the option to include specific drivers required for the target system's recovery. Click Add to browse and select the necessary drivers, then click Next to proceed.
7
The wizard will then start generating the final Windows PE-based ISO recovery image.
8
Once the ISO file is successfully created, an "ISO image with Windows PE successfully built" confirmation message will appear, displaying the exact output directory path of the file. You can then safely close the SVS Creator utility.
9
Next, write the ISO image to a USB flash drive—or another bootable medium that fits your environment—to create a recovery drive. Use this bootable medium to boot the target device and initiate the image-level backup restoration.
The following steps outline the process of booting the target device using the previously created recovery drive.
1
Boot the target device using the newly created recovery medium to initialize the image-level backup restoration process.
To launch the SVS recovery environment from a USB flash drive, configure the target device's BIOS/UEFI settings to prioritize USB-HDD in the boot sequence.
2
After the device boots, the SVS application will automatically launch and display the following menu options:
Xopero: opens the Xopero window with additional recovery options.
Shell: opens the command-line interface, which can be used for manual network interface configuration.
Reboot: restarts the device.
Shutdown: shuts down the device.
3
To recover the image-level backup, click the Xopero button.
4
A new menu screen will appear with the following options:
Device app: launches the Xopero ONE backup agent application on the device.
Fix boot problems: resolves issues that prevent the operating system from starting; use this option to fix SVS-related problems.
5
Select Device app to proceed with the recovery process.
6
Enter the service address and the device name to use in Xopero ONE Management Service, then click Connect.
7
On another device, open the Xopero ONE Management Service panel and start the recovery procedure.
The following steps describe the recovery process in Xopero ONE Management Service.
1
Click the 💻 laptop icon in the top-right corner of the management service panel.
2
Find the target device, select it, and click Activate to assign a license to it.
Once the target device successfully establishes a connection, it automatically appears in the Agents without licenses list.
You do not need to select a license manually — Xopero ONE assigns it automatically.
3
Next, locate the device from which you want to restore the system and click the Restore button.
4
Select the backup plan from which you want to restore the backup.
5
Choose the timestamp from which you want to restore the data, click Restore, and select the BMR recovery option from the drop-down menu.
6
Next, select the disk you want to restore and click Restore selected.
7
Verify that the Restore to field correctly displays your intended target device (the machine configured in the previous steps). If you need to modify this destination, click Edit and select the appropriate device. Next, navigate to the Restore directory section and specify the exact destination disk where the image-level backup copy should be restored.
8
Optionally, in the Restore settings section, select the checkbox to reset the system drivers, or leave it unchecked to keep the original driver configuration.
9
Double-check that the restoration data is correct, then click the Start now button in the bottom-right corner of the Restore data aside to begin the recovery process.
General information
Initiating a bare-metal recovery will completely erase all existing partitions and data on the target system disk. The process deletes the current disk structure, recreates the original partition layout from the backup, and then restores the operating system and files onto the machine.
Creating an ISO file (Windows)
SVS Creator relies on the Windows Assessment and Deployment Kit (ADK) to generate recovery images. Please verify that Windows ADK is installed on your machine before starting the configuration wizard — if it's not, you must before proceeding with the media creation process.
Booting the OS from the ISO file
Starting the recovery process
Useful links and items
Installation within a Docker container
This article describes the process of Xopero ONE Management Service (XMS) installation within Docker container for on-premise deployment model.
Deployment
Download Xopero ONE Management Service (XMS) Docker image to your device. Next, open cmd console and pull XMSDocker image using the following command:
docker load -i docker_name.tar
Replace docker_name.tar with the name of your XMS Docker image file.
Once the Docker image is imported, use the following command to create a container:
In the above command, replace drive_location_database with the location to mount the database on (from the container to the local directory) — this is important for upgrading the container later. In place of container_name, enter the name of your container and in place of service_port, enter the service port which will be used by Xopero ONE (by default, XMS port is set to 28555).
Example:
docker run -d \ --name xone \
Next, use the following command to view the list of containers (or view the list in Docker Desktop):
If you see no errors, that means the XMS implementation was done correctly. You can open the Xopero ONE Management Service web panel using the following address:
Before you start using XMS you must create an administrator account and assign a license to your unit.
QNAP with:
x86 or x64 CPU (ARM is not supported)
minimum 2GB of RAM
QNAP with:
Synology must meet the following requirements:
Installation within a Docker container
Deployment
To install the Xopero ONE agent within a Docker container, use the images available on Docker Hub:
docker pull xopero/gitprotect-agent:latest
Create a host directory for the Xopero ONE Management Service container databases (which are located at /app/Xopero inside the container) to store databases outside the container:
mkdir -p /opt/gitprotect-agent/data
Run the container with the correct volume mounting and environment variables using the following command:
Check if the container works correctly by using the following command:
Once all the above steps are completed, the agent will report to the Management Service panel for activation.
QNAP with:
x86 or x64 CPU (ARM is not supported)
minimum 2GB RAM
QNAP with:
x86 or x64 CPU (ARM is not supported)
minimum 2GB RAM
Navigate to the Container tab and click the Create button. Expand the Image section and click Add image, then search for xopero/gitprotect-agent image.
Select the image, click Download, and choose the version tagged as latest. Click Select to confirm.
This article provides information about prerequisites and requirements for VMware integration.
To access all VMware features, including advanced and LAN-free transport methods, Xopero ONE requires VMware version 6.7 or later.
Xopero ONE requires a commercial VMware license.
Xopero ONE works with both ESXi and vSphere.
If you use vSphere, connect Xopero ONE to the vSphere server rather than an individual ESXi host. Connecting directly to an ESXi host when a
Preparing Linux to backup Oracle
This article describes how to prepare a Linux operating system for backing up an Oracle database environment.
1
Using the Linux command line, log in to the account used for backing up your Oracle database and execute the following commands:
2
If these tools are unavailable (example below) you need to configure the environment variables.
VMware
Introduction
Taking your first steps into the world of backup doesn't have to be a challenge. We have prepared the following list of questions to make it easier for you to decide what kind of backup would suit your company best:
Do you want to use the on-premise version (deployed in your infrastructure) or the SaaS (cloud) version?
What is your goal? What results do you want to achieve?
How do you imagine a perfect backup solution? What are your desired essentials for a backup software?
What kind of data do you want to protect? What resources do you have to secure?
Have you already thought about the backup schedule? Is there a specific RTO/RPO you want to achieve?
Are there any policies, requirements or conditions you have to meet?
Do the resources you want to protect have any technological limitations or access restrictions?
What type of storage do you want to use (i.e., on-site, cloud)?
Who will manage your backup service? Would you need several accounts with different levels of permissions?
Do you need to integrate your backup service with an external identity provider (IdP) via SAML protocol?
Having these answered, you can head to Xopero website and check all available backup options to find the one which best suits your needs, or schedule a demo with our sales team to learn more about the Xopero ONE backup system and how it works.
Please note that the SVS Creator will automatically download three required components during this process: Windows PE, the Java Runtime Environment (JRE), and the Xopero ONE backup agent.
If the Windows ADK is not detected on the system, clicking Next will automatically launch the ADK installation wizard. Once the ADK installation is complete, you will be automatically returned to the SVS Creator window to resume the configuration.
This step is optional — you only need to include drivers if your target device utilizes specialized components (such as dedicated RAID controllers or specific network interface cards) that require custom drivers to initialize during boot. Otherwise, you can safely skip this step.
To create the bootable media, you can use a third-party utility, such as Rufus.
You can monitor the restoration progress in the Tasks tab of Xopero ONE Management Service.
Example of the serviceaddress in the on-premises deployment model.
Example of the service address in the SaaS deployment model.
Container Station app from the App Center
Login to your QNAP web panel and open the App Center application. Go to QNAP Store > All Apps and search for Container Station (CS).
Download the Container Station application. Once downloaded, open the app and select the path you'll be using as your Docker container data directory.
Click Start Now to proceed.
In the Container Station application, open the Containers menu option, and click the Create button.
In Image Configuration, choose Advanced mode. For Image type select Docker image, and in the Image field, paste the following:
Ensure Try pulling the image from the registry before creating the container. checkbox is checked, then hit Next.
In the Configure Container tab, configure the Xopero ONE Docker container and hit Next to continue.
Name: set a custom name for the container
Auto start: defines if the container should startup automatically (i.e., in case of QNAP restart)
Publish network ports: enter a port number in the Host field— this will be the port used to connect to Xopero ONE service on the container on port 80 (the recommended host port number is 28555)
Double-check your configuration settings and hit Finish.
Container Station will download the latest Xopero ONE image and create the container based on it.
Once the container creation process is completed, your new container will be available in the Container Station application (under Containers menu option).
Connect to Xopero ONE using your web URL address in the following format (you can find it under Container Details > General > Web URL):
http://QNAPaddress:port
To finish the XMS setup, create a new administrative account, provide the license code, and select data to protect.
Container Station app from the App Center
Login to your QNAP web panel and open the App Center application. Go to QNAP Store > All Apps and search for Container Station (CS).
Download the Container Station application. Once downloaded, open the app and select the path you'll be using as your Docker container data directory.
Click Start Now to proceed.
Open the Container Station application and click ➕ Create in the left-hand side menu.
Copy and paste xopero/xopero-one-service in the search field and hit Enter to search for XMS Docker image (it should be the first search result in Docker Hub tab).
Click the Install button next to the Docker image to start the container creation process.
Select the latest image version and click Next to continue.
In the Create Container window, configure the Xopero ONE Docker container.
Name: set a custom name for the container
Auto start: defines if the container should startup automatically (i.e., in case of QNAP restart)
CPU Limit: allows you to set the CPU percentage usage available for the container
Memory Limit: RAM memory allocated to the container
Scroll down a little and click the ⚙️ Advanced Settings>>
In the ⚙️ Advanced Settings>> go to Network and click the Add button on the right. Enter a port number in the Host field under thePort Forwardingsection— this will be the port used to connect to Xopero ONE service (the recommended, default port number is 28555).
Click the Create button— this will display the setup summary. Double-check your configuration and click OK to create the container.
Once the container creation process is completed, your new container will be available in the Container Station application (under Container menu option).
Connect to Xopero ONE Management Service by launching it via Container Station, or using your web URL address in the following format:
http://QNAPaddress:port
To finish the XMS setup, create a new administrative account, provide the license code, and select data to protect.
Docker app from the Package Center
Open the Docker Hub, navigate to the Container menu, and click Create button.
Expand the Image section and select Add image. Then, search for xopero/xopero-one-service. Once located, select the image, click Download, and choose the version tagged as latest. Confirm the selection to proceed.
Once you download the image, select it from the Image drop-down menu in General Settings. Next, define a name for the container and enter it in the Container Name field. Configure container resource limits if necessary.
Check the Enable auto-restart checkbox to ensure the container automatically restarts when the device reboots, and proceed to the next step.
In Volume Settings, click ➕ Add Folder button. To ensure data persistence during container updates or maintenance operations, mount the management databases to an external directory. The databases are stored in /app/Xopero and should be mapped to a designated location outside the container to prevent data loss or inconsistencies.
In the Environment section, define the required variables:
ASPNETCORE_URLS: management service ports for http and https protocol (i.e., http://+:PORT_NUMBER;https://+:PORT_NUMBER)
Go to Advanced Settings. Select bridge from the Network Name drop-down menu in the Network tab to enable the container to share the same network namespace as the container's host, then select Use the same network as Docker Host checkbox at the bottom.
Confirm the configuration and click Next. In Summary, double-check the settings and hit Done to finish the container creation process.
Once you've created the container, you can connect to your XMS using one of the following addresses:
Example of correctly filled environments variables.
Click Apply to save your changes.
Navigate to Storage tab—here you can mount your QNAP volumes to the Xopero ONE agent docker container.
Next, double-check and confirm your settings, then click Finish to create the container.
Container Station will download the latest Xopero ONE image and create the container based on that image.
Once the container creation process is completed, your new container will be visible under Container tab in Container Station.
You can now connect to your Xopero ONE Management Service admin panel to activate the agent.
Container Station app from AppCenter
Download the Container Station app from the AppCenter.
Login to your QNAP web panel and open the AppCenter application. In QNAP Store, select All Apps and search for the Container Station.
Download and open the application. Select the path that will be used as a directory for your Docker container data, and click Start Now to proceed.
Once done, download the Xopero ONE agent Docker image, which is available on our official server.
Open the Container Station application and navigate the Import tab.
Click the ➕Import button to upload the previously downloaded Docker image file.
In Create Import Task window, select the source type and file path of the Xopero ONE agent Docker image and hit Next to continue.
Within the Create Container tab, the form contains several fields, with the most crucial being:
Name — here you can set a custom name for the container
Auto start — defines if the container will star automatically in case of, for example, QNAP restart
CPU Limit — allows you to specify the percentage of CPU usage allocated for the container
Memory Limit — RAM limit for the container
Click the ⚙️Advanced Settings >> button and navigate to the Environment section.
To add a new environment variable, click the Add button, name it ManagementServiceUrl, and set its value to your Xopero ONE Management Service address*.
‼️*ManagementServiceUrl – your Xopero ONE Management Service (XMS) address in one of the following formats (depending on the XMS deployment model):
a. http://ipaddress:port, i.e., http://192.168.0.1:28555
b. https://XMSID.ads.xopero.com, i.e., https://a00b0dc0-0116-0000-0000-d0000028960e.ads.xopero.com
Go to the Shared Folders section — here you can mount your QNAP volumes to the Xopero ONE agent Docker container.
To back up data from your QNAP device, choose Add under Volume from host section— it lets you specify which data the Xopero ONE container can access. Select a directory from the host in Volume from host field and enter the path visible inside the container in the Mount Point field.
Once you're done with the above steps, click Create to continue.
In the Summary window double-check your settings, then click OK to finish the configuration.
You can now connect to your Xopero ONE Management Service admin panel to activate the agent.
Once the image is downloaded, select it from the Image field drop-down menu.
Next, define a custom name for the container. Additionally, configure container resource limits if needed.
Check the Enable auto-restart option to ensure the container automatically restarts when the device reboots, then click Next to proceed.
In the Volume Settings section, click the ➕Add Folder button, and select directories that require protection. The container needs to have external directories mounted to access them while performing backups.
Additionally, to ensure data persistence during container updates or maintenance operations, mount agent databases to an external directory. These databases are located in /app/Xopero and should be mapped to a designated location outside the container to avoid data loss or inconsistency.
Next, in the Environment section, define the required variables:
ManagementServiceUrl — your Xopero ONE Management Service (XMS) address in one of the following formats (depending on the XMS deployment model):
a. http://ipaddress:port, i.e., http://192.168.0.1:28555
b. https://XMSID.ads.xopero.com, i.e., https://a00b0dc0-0116-0000-0000-d0000028960e.ads.xopero.com
XoperoOverriddenHostName — specify agent's name to facilitate identification
Click Next to confirm the configuration. In Summary window, double-check your settings and if they're all correct, hit Done to finalize the process.
docker ps
Prerequisites
Prerequisites
Deployment
To deploy the Xopero ONE agent on a Synology device using Docker, use the Container Manager application. If it's not installed, download it from the Package Center.
ReplaceXopero ONE Management Service addresswith your Xopero ONE Management Service address*.
You can mount multiple directories to the container using Add Volume button and repeating the operation.
To back up data from your QNAP device, choose Bind Mount Host Path under Add Volume drop-down menu — it lets you specify which data the Xopero ONE container can access. Select a directory from the host and enter the path visible inside the container in the Container field.
Environment setup
Deployment
Selecting a file from a local source enables you to choose files stored on your device. Alternatively, you can use the NAS option to access files directly from QNAP.
You can mount multiple directories to the container using Add button in Volume from host section and repeating the operation.
For instance, if you need to back up a directory named Backup inside a public shared folder, set the Volume from the host field to /Public/Backup. The Mount Point can be different, i.e., /Backup.
To protect data stored in the Public directory, select this folder and specify the same path to ensure consistency between the host and the container's file systems.
You can mount multiple directories to the container by clicking ➕ Add Folder and repeating the operation.
vSphere
server is active may cause backup issues.
Installing a virtual appliance (VA) is optional-- you can protect your infrastructure without it, but deploying a VA is strongly recommended.
To connect VMware to Xopero ONE, you need a VMware administrative account. It is recommended to create a dedicated VMware user account for backup tasks.
MacOS devices are not supported for many VMware operations. You cannot use macOS devices to:
Register the VMware host in Xopero ONE.
Back up VMware virtual machines.
Deploy virtual appliance machines on the VMware host.
VMware version
License
ESXi & vSphere
Virtual appliance
Learn more about virtual appliances in .
Account type
Learn more about the required VMware permissions .
macOS
Edit the /home//.bash_profile file and add the following records:
Example of correctly configured environment variables.
Now, after logging in again, executing the following commands should complete successfully.
3
Once done, your Linux system should now be ready to backup an Oracle environment.
echo 'connect target /; quit' | rman
echo 'SELECT INSTANCE_NAME FROM V$INSTANCE;' | sqlplus / as sysdba
Oracle database backup involves generating a database dump using backup scripts and then backing up the resulting dump file.
Linux preparation process
Xopero ONE agent requires the availability of the rman and sqlplus tools. Before starting, ensure that these tools are installed and accessible.
export ORACLE_SID=<database_ID>
export ORACLE_HOME=database_directory
export PATH=$ORACLE_HOME/bin:$PATH
echo 'connect target /; quit' | rman
echo 'SELECT INSTANCE_NAME FROM V$INSTANCE;' | sqlplus / as sysdba
The database_directory specifies the location of the Oracle database.
Regardless of the deployment model Xopero ONE provides the same functionalities in one user interface.
Xopero ONE is a flexible backup solution that can be deployed in two different models: SaaS and on-premise.
The main difference between SaaS and on-premise models is where Xopero ONE service is installed and running. The first implementation type - SaaS (software as a service, a cloud-based model) is hosted and maintained by us while the other, on-prem model, is hosted in-house (directly on your local infrastructure). Which implementation type works best for your company depends on a variety of factors including your objectives, system limitations, company's budget, security requirements, company policy, and more. Before you decide which solution deployment model to use, you need to evaluate your options and compare it with your infrastructure to figure out which implementation type would be the best fit.
The location where the backup copies are stored is independent of where the management server is running - with a SaaS-based management service you can store data locally and likewise, you can store data in cloud with an on-premise service.
Xopero ONE SaaS
Software as a service (SaaS) is a way of delivering software over the internet. Instead of installing and maintaining software on your computer, you access it online through a subscription with a cloud service provider.
To deploy Xopero ONE SaaS you don't have to allocate any additional devices that could be used as a local server - the service runs in our cloud infrastructure. You don't have to worry about its maintenance or administration, and the continuity of operation is guaranteed by us.
Service installation doesn’t require a local server.
Accessible from anywhere.
Guaranteed business continuity.
On-premises software is installed and runs on local computers within your organization, rather than at a remote facility such as cloud. As it's run locally, the service maintenance and control is up to the housing unit, or to simplify— up to your IT department.
You can install Xopero ONE on-premise service on almost any computer with Windows or Linux— or even on popular NAS devices. This deployment model let's you avoid any issues related to network connectivity— your backup copies are made using the local network, which makes the whole process faster and more efficient.
Implementation on any infrastructure.
No failures related to the lack of network access.
No data transfer outside the company.
Licensing
Learn more about licensing for Xopero Unified Protection.
Xopero Unified Protection (XUP) is an all-in-one backup solution that integrates Xopero ONE software with dedicated storage medium. Unlike standalone Xopero ONE licenses, XUP uses a storage-based licensing model and provides comprehensive protection for the entire local infrastructure.
Licensing model
Xopero Unified Protection (XUP) operates on a licensing model that combines hardware capacity with unlimited protection for local resources. When you purchase a XUP appliance, you receive:
While Xopero Unified Protection provides unlimited protection for all local physical and virtual resources, the license can be extended to include cloud platforms and offsite storage. These are available as separate subscription-based licenses:
Microsoft 365 — protection for mailboxes, OneDrive, contacts, and calendars.
Git platforms (GitHub, GitLab, Bitbucket, Azure DevOps) — protection for repositories and metadata.
Jira — comprehensive backup for Jira spaces.
Xopero Unified Protection provides two primary ways to secure virtual machines, ensuring compatibility regardless of hypervisor:
Host-level (VMware and Hyper-V) — unlimited backup of VMs directly from the hypervisor level.
In-guest agent — by installing a backup agent (worker) directly inside a VM, you can protect the system regardless of the underlying platform. This is the recommended method for securing environments not natively supported at the host level, such as Proxmox, Xen, KVM, or Nutanix.
Adding VMware server to Xopero ONE
This article explains how to add a VMware ESXi or vCenter server to Xopero ONE.
To add a VMware server to Xopero ONE, you must have at least one device on the same network with the Xopero ONE Agent installed. This device will handle the initial communication with VMware.
1
Log in to XMS, open the Virtual Machines tab on the left side of the window, and select VMware from the list.
2
Click the Connect button under vSphere/ESX.
3
Provide the IP address or name of your VMware server, enter a username, and add or select a password from the Password Manager.
4
Select the default VMware agent—the device that can communicate with VMware and will handle adding it to Xopero ONE.
5
Specify the frequency at which the VMware server should refresh.
6
After completing the form, click Next to proceed. Once these steps are complete, you can start planning your VMware backup strategy.
Xopero ONE Agent
Service hosting location
Where Xopero ONE Management Service is hosted across different regions.
Xopero ONE Management Service is available in two deployment models: as a SaaS offering or as an on-premises component. For SaaS customers, the Management Service is hosted in the EMEA region and the US region.
Service deployment
In SaaS model, the Xopero ONE Management Service platform is deployed in two different locations:
This article explains how to use backup scripts to create a MySQL database dump and include it in a backup plan.
The MySQL database backup process in Xopero ONE consists of two steps:
Creating a database dump using backup scripts.
Backing up the database dump.
The first step is performed through Xopero ONE
Whole machine restore
Learn how to restore whole virtual machines in Xopero ONE.
1
Open the Hyper-V tab (Virtual Machines > Hyper-V) in XMS, then click the Manage & Restore button next to the host whose backup you want to restore.
2
Changing the temporary dump folder
This article describes how to change the temporary folder used for database backup dumps.
When creating a backup plan, in the Data to protect section, select the folder where database dumps will be stored. You can choose either Select from device or Select path or variable — switch between these options by clicking on the text in the list.
Create a new temporary folder.
Solution overview
Learn more about the Xopero Unified Protection (XUP) solution designed for backup and data protection.
Xopero Unified Protection (XUP) combines simplicity, cost efficiency, and reliability to meet the needs of even the most demanding virtual, physical, and hybrid environments.
Xopero Unified Protection (XUP) is an advanced hardware–software solution that combines the performance of a physical server with preconfigured Xopero ONE software. It's a "plug-and-forget" solution — the deployment process is straightforward, requiring only mounting the device in a rack cabinet and performing basic network configuration. With these steps completed, the system is fully operational, and users can immediately log in to the management panel.
The XUP device is designed to support diverse network environments and varying IT security requirements. It can be deployed in one of two operating models:
Workstations and servers
Cloud-to-cloud copies.
Automatic updates.
Copies made without internet access.
SaaS main advantages:
Xopero ONE on-premise
On-premise main advantages:
Xopero Cloud Storage — secure offsite data redundancy.
For the EMEA region, Xopero ONE Management Service platform is hosted in Poland.
US
For the US region, Xopero ONE Management Service platform is hosted in the United States.
Go to the Plans tab and edit the plan you want to change or create a new one.
In the Data to protect section, uncheck the old folder and select the new one (if you're creating a new plan, simply select the newly created temporary folder from the list).
Next, go to Advanced settings, then Backup scripts, and update the script arguments to the new database dump location.
Save the changes.
Database backup involves generating a database dump and then backing up the resulting dump file.
Data to protect
If the specified folder is deleted, you will not be able to select it from the list of available folders on the device — in that case, switch to Select path or variable.
Changing the temporary dump folder
If you delete the old directory first, you will not be able to deselect the folder in the Select from device section — switch to Select path or variable and remove the old directory.
Online model — enables full connectivity to external networks, allowing remote management and administration.
DMZ (demilitarized zone) model — places XUP within an isolated zone (local network) with no access to external networks.
XUP emphasizes protecting data against accidental or intentional deletion (for example, as a result of a ransomware attack). The security system is based on two key pillars:
Versioning (7 days) — data must remain in the system for at least one week before it can be permanently deleted.
Compliance mode (24-hour buffer) — an additional layer of protection that delays complete data deletion by 24 hours, giving administrators time to respond in critical situations.
Each Xopero Unified Protection device is equipped with an integrated management system (Xopero Unified Protection Management Service, abbreviated as XUP Management Service), which enables:
Performing basic network configuration.
Monitoring the condition of physical storage medium using SMART (Self-Monitoring, Analysis and Reporting Technology):
The storage health monitoring system (SMART or S.M.A.R.T.) enables active tracking of key operational metrics, such as device status and storage consumption. It continuously reports disk performance parameters and presents the technical condition using clear color-coded indicators:
OK status — marked in blue, indicates proper operation of the storage medium.
Fail status (or no SMART data available) — marked in red, indicates a failure or inability to read diagnostic parameters.
General information
Currently, the XUP solution is delivered exclusively in a rack enclosure form, while support for legacy desktop versions is still maintained for existing users.
Operating models
Xopero Unified Protection (XUP) device.
Data security and retention
Flexibility and monitoring
using the
backup scripts
feature. The second step is a standard
file-level
or
image-level
backup executed directly by
Xopero ONE
.
By using the mysqldump tool, Xopero ONE supports all MySQL versions that are officially supported by Oracle.
1
Log in to XMS, go to the Backup tab (Plans > Backup) and click the + Add plan button in the top toolbar.
2
Select Devices from the platforms list.
3
In the next aside, select one of the available options and choose one or more devices for the plan to apply to (you can also select the plan to include all activated devices).
4
Define the name of the backup plan.
5
Configure your backup plan according to your needs (more information about the backup plan setup can be found in and articles).
6
Go to the Advanced settings section and click Edit to customize additional options.
7
Scroll down to the Backup scripts section and click the Pre-task script toggle to turn it on.
8
Select one of the scripts dedicated to backing up the MySQL database environment (Windows or Linux).
9
Type your database username into the Database user field.
10
Choose the user password by opening the Password Manager, where you can either add a new password or select an existing one.
11
Set up the script arguments — it should be entered in the Script arguments field as follows:
database — the name of the database. To include multiple databases in one backup plan, enter their names in the following format: [database1 database2 database3]. To back up all databases, use the --all parameter instead of specifying a database name.
12
Enable the two additional options using the checkboxes:
Wait for the script to continue the task — the application will wait until the dump is ready.
Fail the task if the script fails — if the script fails, the system will notify you of the backup error.
13
Double-check your settings and click Save to close the Advanced settings aside.
14
After completing the configuration, click the Save button. The protection plan will then automatically begin protecting your devices and databases according to the schedule you defined.
15
That’s all you need to do to create the database dump — this file should now be included in the Data to protect section if you are performing a file-level backup (to back up only the database). Alternatively, you can run an image-level backup to protect the entire drive.
In Xopero ONE, you can back up a variety of databases, including Oracle, Microsoft SQL, PostgreSQL, and MySQL.
General information
Backup configuration
If a file-level backup plan has already been created and is running, you can skip directly to step 6.
Useful links and items
Select the VM you want to restore and click the restore button.
3
After choosing the backup plan and VM version, click Restore under the backup copy you wish to recover and select the Whole machine option from the drop-down list.
4
Specify whether to restore the VM to its original location or a new one. Provide key details, including the restored VM’s name and desired power state (on/off) after restoration.
5
Next, select a directory for the VM configuration files, choose a location to store the VM disks, and assign a Hyper-V switch or resource pool for the network adapters.
In Restore settings you can also limit the internet bandwidth.
6
Once configured, click Start now to begin the restoration process.
Restoration process
Agent configuration
Activation (license assignment)
1
Login to your Xopero ONE Management Service (XMS) console.
2
Click the Activate agent icon in the top menu.
3
A sidebar will appear, showing a list of available agents — you can view basic details like device type, name, IP address, and operating system.
4
Select the device you want to activate (you can select multiple devices if you assign them the same license type) and press the Activate button to proceed.
5
Next, select the license type you want to assign to the chosen device(s) and click Assign license to confirm your selection.
6
Once the license is correctly assigned, your device(s) will be visible in the Devices tab.
The config.json file, by default, is located in the following locations:
For Windows: C:\Program Files\Xopero ONE Backup&Recovery Agent
For Linux: /opt/XoperoONEBackupAgent/
💡You can edit config.json with a simple text editor (i.e., Notepad++).
The Xopero ONEManagement Service (XMS) address to which your agent connects is crucial during both installation and configuration. If the IP address or protocol (http/https) of the Management Service changes, the agent's status will switch to offline. To re-establish the connection, update the ServiceUrl value in the configuration file with the updated address.
By default, the LogLevel value is set to Information. You can change it to:
Trace
Debug
Information
By default, application logs are stored in the following directory: C:\ProgramData\Xopero ONE\Xopero ONE Backup&Recovery Agent\Logs. To change the location, modify the AppDataFolder parameter.
The device name defaults to the system's name. To customize it, modify the OverriddenHostName parameter.
If database backup task ends with error DV0249 - "Unable to read backup data", first address any connection stability issues on your end. If the problem persists, you can increase the retry attempts in the Xopero ONE application— to do this, simply edit the MaxRetriesCount parameter, changing its default value from 2 to a higher value, i.e., 20.
The VMware virtual appliance is a Linux-based machine with an agent service. You can modify its settings by editing the config.json file.
To configure the timeout for snapshot creation, locate the VMware section at the bottom of the file and adjust the SnapshotCreationTimeout parameter to your needs.
Solution overview
AirGap solution overview, including the isolated backup repository, security mechanisms, and replication process.
Xopero Unified Protection includes an AirGap solution designed to enhance data security. This functionality is based on the physical isolation of the backup repository from the network, helping to minimize the risk of data breaches, for example those caused by ransomware attacks. The AirGap architecture ensures that backup data remains inaccessible to entities operating within a compromised IT environment. By combining strict access control with automated backup processes, the solution increases infrastructure resilience and provides a foundation for a secure disaster recovery strategy.
General information
The Xopero AirGap solution is a data protection method that uses xSAIR (Secure AirGap Immutable Repository) technology to create an isolated backup environment and store an additional backup copy fully separated from the primary network.
AirGap is based on a cluster of two Xopero Unified Protection (XUP) appliances connected in a back-to-back configuration, where the second, redundant device remains disconnected from the network most of the time, preventing any communication with it. The redundant device is powered on only for replication purposes.
The replication process is initiated by powering on the inactive XUP appliance via iDRAC (Integrated Dell Remote Access Controller). After data transfer is completed, the system automatically powers the device off, restoring the isolated AirGap state. Due to its physical disconnection from the network, the backup copy stored on the isolated device remains inaccessible to cyber threats, providing effective protection against ransomware attacks.
The AirGap system is based on communication between two interconnected XUP devices — offline and online:
XUP offline device remains powered off most of the time. It includes only data storage and, optionally, a backup agent. The device is equipped with an active iDRAC interface used for remote startup and shutdown.
XUP online device can operate in one of two variants:
Standard — includes an active management interface, a backup agent, and data storage.
The AirGap data replication process is fully automated, eliminating the need for manual intervention to maintain physical separation of resources. The system manages the connection state of the backup repository, enabling access only during data transfer and isolating it immediately afterward.
The AirGap component integration process follows these principles:
The XUP online unit connects its backup agent and data storage to the management service (hosted on a XUP device, external server, or SaaS).
The data storage of the XUP offline unit is then connected to the management service via backup agent installed on the XUP online device.
Data replication is performed through a task executed by the backup agent on the XUP online device.
To ensure unattended communication with the offline device, the process uses event-driven scripts:
PRE script — executed before the data replication process begins. It powers on the XUP offline unit via the iDRAC interface and waits until it is fully operational.
POST script — executed immediately after the replication task is completed. It safely powers off the XUP offline unit using the iDRAC interface.
Changing Oracle database mode
This article describes how to change the Oracle database mode.
Changing the Oracle database mode is crucial for the correct backup execution.
Executing the following operations will temporarily make the Oracle database environment unavailable.
Prerequisites
Before starting the Oracle database backup task, make sure that the database mode is set to ARCHIVELOG. To verify that the mode is configured correctly or to change it, open the command line as the user configured in the backup plan and run the sqlplus tool using the following command:
sqlplus / as sysdba
You can then close this tool using the QUIT; command.
Verifying the settings
To verify that the database mode is correctly set to ARCHIVELOG, run the following command:
SELECT LOG_MODE FROM v$database;
If the database mode is set to NOARCHIVELOG, change it to ARCHIVELOG.
You can switch the database mode from NOARCHIVELOG to ARCHIVELOG using the following commands:
Now, verify that the database mode has been changed successfully by running the following command:
Granular recovery
This article explains how to restore data from an image-level backup.
1
Open the restore view in Xopero ONE Management Service using one of the following options:
Go to the Devices tab and click Restore next to the device whose data you want to recover. After selecting the device you want to restore, choose the plan containing the data you want to recover from the Backup plans drop-down menu.
Limited — does not include the management interface; it contains only the backup agent and data storage.
AirGap solution characteristics
The XUP online device plays a primary role in the communication process, as it is responsible for managing the power state of the XUP offline unit.
Connection architecture and replication process
Component configuration
Power automation (PRE/POST scripts)
output_dir — the directory where the database dump will be saved. This directory must also be selected in the Data to protect section when creating a backup plan.
mysqldump_dir — the path to the mysqldump utility.
port — an optional parameter. Enter the port number only if a non-standard port is used. The default port is 3306.
For example, to back up all databases from the MySQL environment, use the following arguments:
If you want to back up only selected databases from the MySQL environment (for example, two out of seven), use the following arguments:
Windows
database output_dir mysqldump_dir port
Linux
database output_dir port
It is strongly recommended to create a dedicated user specifically for database backup operations.
You can also click Save&Run button to immediately start the backup process, regardless of schedule.
--all C:\MySQLBackup\ "C:\Program Files\MySQL\MySQL Server 8.0\bin"
database1 database2 C:\MySQLBackup\ "C:\Program Files\MySQL\MySQL Server 8.0\bin"
When using the mysqldump utility on Linux, connections to the host named 'localhost' are established through a socket file. If you do not specify a port in the configuration, the tool will connect correctly even when using a non-standard port. However, if you connect via 127.0.0.1, specifying a non-standard port is required.
Important! The mysqldump tool is part of the MySQL server and should be installed by default. If, for any reason, it is not available, you can download the MySQL Utilities package, which includes the mysqldump tool.
Warning
Error
Critical
None
In the Xopero ONE system, the local worker, cloud worker, and feature worker licenses are free. These licenses allow specific operations, except for backing up the device itself — thus, devices with these licenses appear under Settings > Advanced > Workers tab.
Configuration
To modify the config.json file, you must stop the Xopero ONE Backup&Recovery Agent service. After making your changes, restart the service (you might also need to refresh the changes in the Management Service panel).
Management Service address
Log level
Default log path
Please note that the correct AppDataFolder value format includes double slash after the drive letter (i.e., D:\\).
Device name
Please note that the custom name must be in entered with quotation marks (i.e., "TESTNAME").
Number of retries
Virtual appliance
Go to the Storages tab, select the storage containing the backup data, and click the folder 📂icon to browse the storage.
Select the device whose data you want to restore. Then, choose the backup plan and review the information about the agent used to connect to the storage.
2
After selecting the appropriate device and backup plan, the system will display the Backup copies section — here, you can choose the backup version you want to restore. Click the desired date, then select Restore.
3
Choose one of the available granular recovery options to proceed (click one of the following links to continue):
The iSCSI target option allows you to quickly create and share an iSCSI resource over the TCP/IP protocol. You can connect this resource to any device without restoring backup copies to another location. This method is useful for granular restoration and enables easy file copying through the file explorer.
1
Select all disks by clicking Restore all, or choose a specific disk and click Restore selected.
If you want to modify the data to be restored, click the Edit button to return to the selection window.
2
The iSCSI worker section allows you to select the device that will host the iSCSI target. To change the device, click the Edit button.
3
Next, in the iSCSI settings, select the network interface—preferably the same one shown in the iSCSI worker section—and choose the port. You can either accept the default values or specify different ones.
4
Accept the default iSCSI target name or enter a different one. Click Run iSCSI to start the iSCSI service.
5
If the restoration was configured correctly, its details will appear in the Current tasks list in the Tasks tab.
1
Press Win + R simultaneously to open the Run window. Type iscsicpl.exe and click OK (or press Enter) to launch the iSCSI Initiator.
2
In the Targets tab, enter the IP address of the network interface from the Xopero ONE iSCSI configuration in the Target field, then click Quick Connect.
3
The iSCSI Initiator will search for available iSCSI targets and add them to the Discovered Targets list. Click Done to close the window.
4
If the setup is successful, the target’s status will change to Connected.
5
Press Win + R simultaneously to open the Run window. Type compmgmt.msc and click OK (or press Enter) to launch the Computer Management and go to the Disk Management section.
6
Locate the new disk on the list, then right-click it and select Online to initialize the disk.
7
After a moment the disk should be available and ready to use.
1
Select the disk you want to restore and click Restore selected.
If you want to modify the data to be restored, click the Edit button to return to the selection window.
2
Next, choose the image format from the available options:
RAW
VHD
VHDX
VMDK
3
Select the device where you want to restore the data—to change it, click the Edit button.
4
Specify the exact path for restoring the data in the Restore directory section.
5
In Restore settings, there are three checkboxes with additional options you can use:
Overwrite existing data — choose whether to overwrite existing files in the restore directory.
Restore file permissions — restore the original permissions of the files.
6
Double-check your configuration and click Startnow button to start the recovery process.
7
If the restoration was configured correctly, its details will appear in the Current tasks list in the Tasks tab.
In Xopero ONE, there are three recovery options available for image-level backups, allowing you to choose the one that best suits your needs and preferences.
Initiating the recovery process
Option A
At the bottom of the aside, you can see which agent is being used to access the storage. To change the device, click Change. Ensure the selected device has access to the storage.
Option B
iSCSI target
In case of a failure, the iSCSI resource can also be connected as a virtual machine disk.
Download the agent installer (bash script) to your Linux system and grant execute permission to the file owner (user or group) using the following chmod command:
To download the agent installer, login to Xopero ONE Management Service using a web browser, then go to Settings > Advanced > Workers and click Download agent button. The Download agent window will open — click the appropriate agent version to download it.
chmod+xxoperoclient.sh
Next, run the script using the following command:
Accept the END-USER LICENSE AGREEMENT to proceed.
Next, enter the IP address in the Address field (including the protocol and port) and click OK to finish the installation. Your address can be found in Xopero ONE Management Service — the system will display it once you start downloading the agent installer.
Now that Xopero ONE agent is installed, you can activate it in the Xopero ONE Management Service (XMS) web panel and start protecting your data.
Download Xopero ONE agent installation wizard via XMS and run it.
Click Continue to proceed.
To learn how to activate the agent in the Xopero management console, check the Useful links and items section.
Licensing overview
Overview of Xopero ONE licensing models, including license types, usage-based components, and key licensing principles.
Licensing in Xopero ONE defines how product usage rights are assigned and managed within an organization, covering subscription scope, activated instances, and available feature sets depending on the selected plan.
General information
Licenses are required to use Xopero ONE for backup and recovery. They define how data protection is enabled across different environments and workloads and are assigned based on the type and number of protected resources. Depending on the deployment scenario, licenses cover physical endpoints, servers, virtual machines, SaaS platforms, and repositories, ensuring that each protected element is properly accounted for within the licensing model.
To get a license, please contact one of our sales partners or email us directly at .
Pricing
Use the request form on the Xopero ONE website, and one of our representatives will contact you with information on available offers and pricing.
To get a tailored offer for your business, please email .
License types
Below you can find all license types available in Xopero ONE, categorized by protected resource type.
Endpoint Agent — licenses for securing physical endpoints running Windows, Linux, or macOS. One license is required per endpoint.
Server Agent — licenses for securing servers (Windows and Linux), databases (Oracle, MySQL, Microsoft SQL Server, PostgreSQL, etc.), and NAS devices. One license is required per protected resource.
Virtual Agent per VM — licenses for securing virtual machines based on the number of VMs. It enables to secure systems directly from within the guest OS. This licensing model covers native backup for VMware and Hyper-V platforms, while additionally extending protection to virtualization environments not natively supported by Xopero ONE (such as Proxmox, Xen, KVM, or Nutanix).
VMware per socket — licenses for securing VMware environments based on the number of CPU sockets. This licensing model allows backup of unlimited number of virtual machines from the host level. All CPU sockets are counted, regardless of whether they are populated; therefore, both occupied and unoccupied sockets must be included in the total count.
Hyper-V per socket — licenses for securing Hyper-V environments based on the number of CPU sockets. This licensing model allows backup of unlimited number of virtual machines from the host level. All CPU sockets are counted, regardless of whether they are populated; therefore, both occupied and unoccupied sockets must be included in the total count.
Microsoft 365 — licenses for protecting Microsoft Exchange data (including individual mailboxes, shared mailboxes, calendars, contacts) and OneDrive, assigned based on the number of Microsoft 365 user accounts.
Microsoft 365 PRO — licenses for protecting Microsoft Exchange data (including individual mailboxes, shared mailboxes, calendars, contacts), OneDrive, and SharePoint. Assigned based on the number of Microsoft 365 user accounts.
Licenses for protecting Git repositories (Azure DevOps, Bitbucket, GitHub, GitLab), assigned based on the number of repositories:
GitProtect Enterprise (on-premises) — a license type that enables backup of all on-premises systems installed across the entire company.
GitProtect Enterprise (cloud) — a license type that enables backup of all cloud-hosted systems across the entire company.
GitProtect PRO (cloud) — a license type that enables backup of the entire organization. It is designed for individuals, startups, and small teams.
Jira — protection for cloud-hosted Jira instances, assigned based on the number of users; the license must cover all users in the protected Jira instance.
Confluence — protection for cloud-hosted Confluence instances, assigned based on the number of users; the license must cover all users in the protected Confluence instance.
In addition to standard licenses, Xopero ONE provides supplementary free backup agent (worker) licenses used to initiate specific operations and processes within the software, depending on the use case or deployment scenario.
Free worker licenses allow you to manage storage, restore backups, and back up resources locally, when combined with a dedicated Microsoft 365, Git, Jira, or Confluence license:
Cloud worker — agent responsible for running backup tasks in SaaS deployments. Each Xopero ONE environment is assigned one cloud worker.
Local worker — licenses for an agent responsible for running backup tasks in on-premises deployments. It allows the agent to be run on the same host as Xopero ONE Management Service and enables copying its settings. A maximum of one license is available in the license package.
Feature worker — licenses for an agent responsible for running backup tasks for Microsoft 365,
File-level backup
This article provides information about file-level backup in Xopero ONE.
File-level backup protects selected directories and individual files on your device.
Creating a backup plan
1
Log in to Xopero ONE Management Service, go to the Backup tab (Plans > Backup) and click the + Add plan button in the top toolbar.
2
Select Devices from the platforms list.
3
In the next aside, select Files & folders option and choose one or more devices for the plan to apply to (you can also select the plan to include all activated devices).
4
Define the name of the backup plan.
5
In the Data to protect section, select the data you want to include in the backup plan:
Global rules allow you to define locations that will apply to all selected devices. This method offers three options to choose from:
Path — allows you to manually enter the file or folder path.
6
When creating a backup plan, you can use filters to gain better control over the files being backed up.
7
Specify the backup location by choosing from the available storage options within your service.
8
Configure the by defining when backups should run and which types of backup copies to use.
9
Go to the Advanced settings section to customize additional options, including encryption, compression levels, and bandwidth limit. These settings provide greater flexibility and help optimize the backup process.
10
After completing the configuration, click the Save button. The protection plan will then automatically begin protecting your devices according to the schedule you defined.
PostgreSQL database backup
This article explains how to configure the PostgreSQL database environment in Xopero ONE.
To maintain data consistency, Xopero recommends using a dedicated backup type: a file-based backup with a pre-backup script for the PostgreSQL database.
Database backup begins with a script that requests the database server to create a dump in a temporary directory. Once the dump is complete, Xopero ONE backs up the generated dump file.
Xopero ONE uses the pg_dump utility to back up PostgreSQL databases.
1
Creating a disk backup
Learn how to create a disk image backup with Xopero Sphere Recovery Drive.
Creating a disk backup with the Xopero Sphere Recovery Drive enables full data protection for ICS/OT systems, such as Windows Embedded, as well as various Windows and Linux versions. Image-level backups capture the entire structure of a selected drive, supporting comprehensive recovery scenarios such as bare-metal restore, disaster recovery, and system migration across different hardware environments.
The following steps demonstrate how to create a disk backup using the Xopero ONE Standalone Agent.
1
Start the computer using the Xopero Sphere Recovery Drive (you may need to change the boot order in the BIOS/UEFI settings to select the USB device as the primary boot option). After the computer starts up, press any key when the following message appears:
Restoring Oracle database
This article explains how to restore an Oracle database from a backup.
The first step in restoring an Oracle database from backup is to restore the database files from storage to a temporary directory. These files will then be imported into the Oracle database environment.
To restore files backed up using a file-level backup plan follow .
If the database files are restored to a temporary directory, run the following command in the CLI:
/opt/XoperoONEBackupAgent/Xopero.Device.App
Database backup
Unsupported disk types
Learn about virtual disk types that are excluded from backups due to hypervisor snapshot limitations, and how to protect them.
When performing a virtual machine backup (agentless), Xopero ONE relies on the hypervisor's snapshot mechanism to ensure data consistency. Certain disk types are architecturally excluded from snapshots by the hypervisor itself, which means they cannot be included in a standard VM-level backup.
The following disk modes do not support snapshots and cannot be backed up:
Pass-through disks — these disks are directly attached to the physical storage and are bypassed by the Hyper-V checkpoint (snapshot) mechanism.
If you need to protect data on pass-through disks, you can use the following method:
Install the Xopero ONE Backup&Recovery Agent directly within the virtual machine’s guest operating system.
Configure a file or image-level backup task with the installed agent.
By using an in-guest agent, Xopero ONE utilizes the internal VSS (Windows) or live-read (Linux) mechanisms to capture the data, effectively bypassing the hypervisor's snapshot limitations.
Excluded Hyper-V disks
This is not a limitation of Xopero ONE, but a characteristic of how these virtual disks are designed to operate within VMware and Hyper-V environments. Because a snapshot cannot be created, Xopero ONE cannot guarantee data consistency or access data during a host-level task.
Recommended workaround
Git
platforms,
Jira
, and
Confluence
. It is always included in the license package in unlimited quantities.
For information about Xopero Unified Protection (XUP) licensing model, please refer to this article.
Workstations & servers
Virtual machines
If your environment is clustered, a license is required for each individual host, per socket.
If your environment is clustered, a license is required for each individual host, per socket.
Microsoft 365
Shared mailboxes require the same licensing as individual user mailboxes, with each shared mailbox requiring one Microsoft user license.
Git platforms
There is no need to assign a license to all repositories. The license is assigned only to the repositories that are to be protected.
Jira
Confluence
Backup agents (workers)
In an on-premises deployment model, these licenses must be assigned to an installed agent.
Backup agents are used for process management and data restoration (e.g., restoring cloud platform data). A device assigned a free worker license cannot perform backups of its own local resources.
After installation, in a few steps you need to add the necessary permissions for the Xopero file.
Click on the Mac icon in the upper left corner and select System Preferences... from the drop-down menu.
Next, go to Security & Privacy.
Navigate to the Privacy tab, then select Full Disk Access from the menu on the left.
Add Xopero.Device.App.app to the list.
Grant access to Xopero.Device.App.app to finish the configuration.
./xoperoclient.sh or bash xoperoclient.sh
The above script should be initiated using an account with administrative privileges — because of that it might be required to use the sudo command simultaneously (as in the above example).
Installation
To download the agent installer, login to Xopero ONE Management Service using a web browser, then go to Settings > Advanced > Workers and click Download agent button. The Download agent window will open — click the appropriate agent version to download it.
To download the agent installer, login to Xopero ONE Management Service using a web browser, then go to Settings > Advanced > Workers and click Download agent button. The Download agent window will open — click the appropriate agent version to download it.
Permissions configuration
System variable — enables the use of OS variables such as USERPROFILE, ALLUSERSPROFILE, or SystemRoot.
‼️When specifying a variable in Xopero ONE, percent signs %must be omitted.
Xopero variable — provides a predefined list of variables such as SYSTEM_DISK, ALL_DISKS, and HOMES.
Select from device — this method allows you to choose paths individually for each device by connecting remotely to its file system.
All information about filters and how to use them can be found in this article.
Filters are available only in the file-level backup plan.
Set the retention policy to determine how long backups are stored — any copies exceeding this periodwill be automatically deleted.
You can also click Save&Run button to immediately start the backup process, regardless of schedule.
Log in to XMS, go to the Backup tab (Plans > Backup) and click the + Add plan button in the top toolbar.
2
Select Devices from the platforms list.
3
In the next aside, select one of the available options and choose one or more devices for the plan to apply to (you can also select the plan to include all activated devices).
4
Define the name of the backup plan.
5
Configure your backup plan according to your needs (more information about the backup plan setup can be found in File-level backup and Image-level backup articles).
6
Go to the Advanced settings section and click Edit to customize additional options.
7
Scroll down to the Backup scripts section and click the Pre-task script toggle to turn it on.
8
Select the script dedicated to backing up the PostgreSQL database environment.
9
Type your database username into the Database user field.
It is strongly recommended to create a dedicated user specifically for database backup operations.
10
Choose the user password by opening the Password Manager, where you can either add a new password or select an existing one.
11
Set up the script arguments — it should be entered in the Script arguments field as follows:
database output_dir "pg_dump_dir" port_number
database — the name of the database to back up. A backup plan can target a single database or all databases. To back up all databases, use the --all parameter instead of specifying a database name.
output_dir — the directory where the database dump will be created; this is also the folder that Xopero ONE will back up.
pg_dump_dir — the path to the pg_dump utility. This is required only for PostgreSQL databases hosted on Windows.
port_number — required only if your PostgreSQL server uses a non-standard port (other than 5432).
12
You can enable the two additional options using the checkboxes:
Wait for the script to continue the task — the application will wait until the dump is ready.
Fail the task if the script fails — if the script fails, the system will notify you of the backup error.
13
Double-check your settings and click Save to close the Advanced settings aside.
14
After completing the configuration, click the Save button. The protection plan will then automatically begin protecting your devices and databases according to the schedule you defined.
In Xopero ONE, you can back up a variety of databases, including Oracle, MySQL, Microsoft SQL, and PostgreSQL.
Prerequisites
The pre-backup script can also be used to generate a database dump before performing a disk-level backup.
Once the Xopero Sphere Recovery Drive startup window loads, select Xopero and then choose Xopero ONE Standalone Agent.
3
In the Xopero ONE Standalone Agent backup wizard, select Protect disk and click Next.
4
Specify the location where the backup will be stored. Select the dedicated backup directory created earlier, and click Next.
5
Select the disk you want to back up, then click Next.
6
Configure the backup settings as needed.
Backup settings allow you to define parameters such as incremental backup (if a full backup has already been created), compression, deduplication, and the number of read attempts for damaged disk sectors.
7
Review your configuration and click Run backup to start the backup process.
8
Once the backup is complete, a confirmation message will appear.
Backup process
Before using the Xopero Sphere Recovery Drive for the first time, connect it to a computer via USB and create a dedicated backup directory on it (for example, XoperoBackups).
--oracle-restore — parameter used to restore the Oracle database
database_ID — ID of the database to be restored
backupuser — user with permission to restore the database
/home/backupuser/oracle/oracle_database_dump — path to the directory containing the restored database files
If the restore completes successfully, information about the restored database will be displayed on the screen:
If part of the database is currently unavailable (for example, if a user deleted a table), the restoration process described above may fail, as the deletion is a more recent operation in the database.
The solution is to run the modified command:
The last optional parameter, required only when restoring to the source host, should be set to true. This ensures Xopero sets the SCN (System Change Number) to the point immediately after the backup.
Setting this parameter resolves issues with unrestored parts of the database. The restoration method described in the first section of this article will still work, but it may not always produce the expected results.
This article describes the process of Xopero ONE Management Service installation on Windows, Linux, and as a Docker container for on-premise deployment model.
Download and run Xopero ONE installer.
Click Next to start the installation setup.
Specifying the port is optional. If no port is provided, the default port (5432) will be used. Use the port_number parameter only if your PostgreSQL server uses a non-standard port.
Acceptthe End-User License Agreement and hit Next to continue.
Select the installation folder and click Next.
Define the HTTP port for Xopero ONE Management Service. Depending on your needs you can either use a custom HTTP port, or stay with the default XMS HTTP port (28555).
Click Install to start the installation process.
Once the installation is completed successfully, click Finish to close the installation wizard.
Installation process for Linux
Download and run Xopero ONE installer (XoperoONEManagementService.sh).
Add execute permission to the downloaded file using the following command:
chmod +x xoperoserver.sh
Run xoperoserver.sh. Accept the End-User License Agreement to continue.
Once the installation is completed, you can close the software installation window.
To register for a free trial and download the installer visit the Xopero website. If you're already a registered user, download the installer here.
Installation process for Windows
Required permissions
List of the minimum VMware permissions required to use Xopero ONE.
For Xopero ONE to back up and restore VMware environments, the assigned permissions must cover all resources that need protection, ensuring your virtual machines and configurations can be securely accessed and managed.
VMware permissions
Below is a list of all permissions required by Xopero ONE to back up and protect your VMware environment. Click each section to expand it and view the full set of privileges.
The listed permissions represent the minimum required for Xopero ONE to function. It is recommended to use the full set of permissions to ensure optimal operation.
The list is presented in alphabetical order.
DATASTORE
FOLDER
GLOBAL
HOST
NETWORK
RESOURCE
TASKS
vAPP
VIRTUAL MACHINE
Change configuration:
Add new disk
Edit inventory:
Guest operations:
Interaction:
Provisioning:
Snapshot management:
Please note that, by default, the Xopero ONE Management Service installed on Linux uses port 28555.
In this article you will learn how to configure your Xopero ONE login with SAML.
SAML provides secure single sign-on by integrating an identity provider (IdP) with Xopero ONE, allowing users to authenticate with centralized credentials while ensuring controlled access and compliance.
Overview
Xopero ONE integration works via the SAML 2.0 protocol, meaningany platform supporting this protocol can be integrated with Xopero ONE.
The configuration process is straightforward and requires only the entity ID, metadata URL, reply URL, and logout URL (the names may vary depending on the naming conventions used by specific platforms). In some cases, a certificate and a private key are also required.
Configuration
Do not test the integration in the IdP panel (for example, the Azure Portal) as it will initiate login from the IdP panel.
Open your Auth0 admin dashboard, go to Dashboard > Applications > Applications, and hit Create Application button in the top-right corner of the screen.
In Create application window enter a unique, custom application name (in this example we'll be using XoperoAuth0), select Regular Web Applications option, and click Create:
In the newly created application window go to Settings tab, scroll down to the very bottom, and click Advanced Settings collapsible to expand it.
Go to the Endpoints tab and locate SAML section. Copy the SAML Metadata URL and save it for later — it will be needed for Xopero ONE configuration.
Scroll back to top and open the Addons tab, then toggle the SAML2 WEB APP button.
In the window that opens up open the Settings tab and enter the Application Callback URL as follows:
In the same tab, scroll down inside the code input field and uncomment 31st, 32nd and 33rd line, then edit line 32 as follows:
Once done, scroll down to the bottom of the addon window and click Enable button, then close the window to finish app configuration.
Login to your XMS web panel, go to Settings (bottom-left corner in the left-hand side menu) and select External Identity Providers.
Click Add new provider button and fill in the details:
Name: your own custom name, i.e., Auth0
Entity ID: should be the same name you've set as application namein Auth0 (in this example it's XoperoAuth0)
Next, paste the previously copied SAML Metadata URL in the Metadata URL field.
Add certificate and password if required.
Set up a default Language and Role for users with Auth0SAML authentication permissions.
Double-check the settings and hit Save at the bottom of Add identity provider tab.
Login to , select Microsoft Entra ID and click Manage > Enterprise applications.
Click the New application button and then Create your own application.
Log in to your CyberArk account. Expand Apps & Widgets dropdown menu and select Web Apps.
Click Add Web Apps button in the top-right corner.
Login to your Google admin console. Next, click the burger menu icon in the top-left corner of the screen and go to Apps > Web and mobile apps. Click Add app and select Add custom SAML app from the drop-down menu.
In the app details page create a custom name for your app and type it in App name field, then click
Log in to the JumpCloud Admin Portal, navigate to USER AUTHENTICATION > SSO Applications, and then click + Add New Application.
In Create New Application Integration window search for Custom Application, select it, and hit Next.
PKCS #12 file with X.509 certificate and private key (usually a .pfx file; can be password protected) must be included in IdP configuration in Xopero ONE. X.509 certificate file (usually a .crt file) for signature verification on IdP side must be included in application configuration defined in Okta panel.
Both files contain the same certificate. The PKCS #12 file also contains a private key to this certificate.
Login to your OneLogin admin console and go to Applications > Applications > Add App.
Search for SAML Custom Connector (Advanced) and select the first result from the search results.
To log in to Xopero ONE using a SAML-integrated identity provider, always start from the Xopero ONE panel. Do not log in from the IdP panel (for example, the Okta panel) to the application configured for Xopero ONE — the only exception is JumpCloud, which provides a built-in option to log in directly from its panel.
To enable an existing Xopero ONE user to log in via an identity provider (IdP), you must turn on the IdP login toggle for that account (⚙️ Settings > Accounts > Edit). Once an account is set to use an identity provider (IdP) for authentication, it cannot be switched back. To change the authentication method, you must delete the account and add it again.
Click Save to finish the setup. You can now log out and test your configured SAML login integration.
Enter a custom name for the app and select Integrate any other application you don’t find in the gallery (Non-gallery).
Confirm the configuration and click Create button.
Open the Single sign-on tab and select SAML method.
Click the Edit button in Basic SAML Configuration section to edit it.
Set up a unique Identifier (Entity ID) i.e., SAMLTestAzure
Enter the following URL in Reply URL (Assertion Consumer Service URL) section:
Go to SAML Responsetab and scroll down to Script to set custom claims section. Enter the following script and press the Save button:
Head over to Permissions tab, click Add button, select all users you want to authorize to use SAML integration, and Save your settings.
Login to your XMS web panel, go to Settings (bottom-left corner in the left-hand side menu) and select External Identity Providers.
Click Add new provider button and fill in the details:
Name: your own custom name, i.e., CyberArk
Entity ID: should be the same name you've set in Application ID in CyberArk (in this example it's XONESAMLID)
Next, paste the previously copied Metadata URL in the Metadata URL field.
Add certificate and password if required.
Set up a default Language and Role for the users with CyberArk SAML authentication permissions.
Click Save to finish the setup. You can now log out and test your configured SAML login integration.
XMS login page with CyberArk SAML integrity set up.
Continue
.
Next, click DOWNLOAD METADATA button under Option 1: Download IdP metadata. Upload the downloaded file to your web server and save its URL (it will be needed later for Xopero ONE configuration).
Click Continue and in the next window screen fill the Service provider details as follows:
Entity ID: custom, globally unique name (in this example we'll be using SAMLGOOGLE)
Start URL (optional): your XoperoONEManagementServiceURL
Once done, click Continue and on the next page hit Finish.
Back on the admin console main page, click the burger menu in the top-left corner, go to Apps > Web and mobile apps, then select your newly created SAML app.
Click User access and select either On for everyone or Off for everyone based on your organization's needs.
Once done, hit Save to finish the configuration process.
Login to your XMS web panel, go to Settings (bottom-left corner in the left-hand side menu) and select External Identity Providers.
Click Add new provider button and fill in the details:
Name: your own custom name, i.e., Google
Entity ID: should be the same name you've set in Google (in this example it's SAMLGOOGLE)
Next, paste the previously copied metadata URL in the Metadata URL field.
Add certificate and password if required.
Set up a default Language and Role for the users with Google SAML authentication permissions.
Click Save to finish the setup. You can now log out and test your configured SAML login integration.
Check Manage Single Sign-On (SSO) checkbox and select Configure SSO with SAML option., then hit Next.
In Enter general info set a unique custom application name (in this example we'll be using XONE), type it in Display Label field, and click Save Application.
In your new application settings go to SSO tab and fill the fields as follows:
IdP Entity ID: your unique application name (in this example it's XONE)
SP Entity ID: your unique application name (in this example it's XONE)
Click the Copy Metadata URL button under JumpCloud Metadata at the top and save it for later— it will be needed for Xopero ONE configuration in XMS.
Scroll down, set SAMLSubject NameID to email, and for SAML Subject NameID Format select urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress from the drop down menu.
In Sign section select Assertion. The IDP URL should read:
https://sso.jumpcloud.com/saml2/xone
Correctly filled Login URL example.
In Attributes section add a new logout response by filling the fields as follows:
JumpCloud Attribute Name: select email from the drop-down menu
Click Save to update the connector and move to the User Groups tab. Select the groups/users you want to enable JumpCloud SAML authorization for Xopero ONE login to.
Double-check if the data you entered is correct and save your configuration.
Login to your XMS web panel, go to Settings (bottom-left corner in the left-hand side menu) and select External Identity Providers.
Click Add new provider button and fill in the details:
Name: your own custom name, i.e., JumpCloud
Entity ID: should be the same name you've set in SSO IDP Entity ID in JumpCloud (in this example it's XONE)
Next, paste the previously copied Metadata URL in the Metadata URL field.
Add certificate and password if required.
Set up a default Language and Role for the users with JumpCloud SAML authentication permissions.
Click Save to finish the setup. You can now log out and test your configured SAML login integration.
In Admin dashboard (in the right-top corner of the window) expand the Applications tab and select the Applications option.
Hit Create App Integration button and select SAML 2.0.
In General Settings enter a unique application name and move to Configure SAML section.
In Configure SAML tab set the Single sign-on URL parameter as follows:
In Audience URL type your unique application name that you've previously set in General Settings tab.
Click Show advanced settings and upload the certificate file to Signature Certificate field. Check Allow application to initiate Single Logout checkbox in the Enable Single Logout section— it's necessary.
You will now see two additional fields under Enable Single Logout— fill them as follows:
SP Issuer: your unique application name that you've previously set in General Settings tab (in this example it's MyOktaApp)
Next, go to Group Attribute Statements section and fill it as follows:
Name: xoperogroup
Starts with: XONE
Double-check if the data you've entered is correct and click Next. In the next window select I'm an Okta customer adding an internal app option, thenhit Finish.
Open the created application and go to Sign On tab.
In SAML Signing Certificates section select your uploaded certificate and click Actions > View IdP metadata. Copy the URL of the opened page— it will be required later in Xopero ONE configuration.
Once done, go to the Assignments tab.
Assignments tab view.
Assign the application to a selected user, or group. Hit Done to finish the configuration.
Login to your XMS web panel, go to Settings (bottom-left corner in the left-hand side menu) and select External Identity Providers.
Click Add new provider button and fill in the details:
Name: your own custom name, i.e., Okta
Entity ID: should be the same name you've set in General Settings in Okta (in this example it's MyOktaApp)
Next, paste the previously copied IdP metadata URL in the Metadata URL field.
Add the required certificate and a password to the Password Manager.
Set up a default Language and Role for the users with Okta SAML authentication permissions.
Click Save to finish the setup. You can now log out and test your configured SAML login integration.
Next, enter a unique, custom name for the app in Display Name field and hit Save.
Open the Configuration settings of your custom app, fill the displayed fields as follows and hit Save to save the configuration:
Audience (EntityID): a unique, custom name to identify the app on the IdP side (in this example we'll be using XOPEROSAML)
Click the SSO menu option on the left. Change SAML Signature Algorithm to SHA-256. Copy the Issuer URL value and save it for later— it will be needed for Xopero ONE configuration.
Save all your settings. Open Users settings in the left-hand side menu, select user(s) you want to have permission to use OneLogin for Xopero ONE authentication, then in the window that pops-up, check the Allow user to sign in checkbox and hit Save.
In the Applications tab, use the (+) button to add proper permissions to your custom application.
Login to your XMS web panel, go to Settings (bottom-left corner in the left-hand side menu) and select External Identity Providers.
Click Add new provider button and fill in the details:
Name: your own custom name, i.e., OneLogin
Entity ID: should be the same name you've set in Configuration (Audience (EntityID))in OneLogin (in this example it's XOPEROSAML)
Next, paste the previously copied Issuer URL in the Metadata URL field.
Upload the previously downloaded OneLogin .pfx certificate file and add a password to it if required.
Set up a default Language and Role for the users with OneLogin SAML authentication permissions.
Click Save to finish the setup. You can now log out and test your configured SAML login integration.
Go to User > Roles and create roles you would like to use (i.e., XONE viewers, XONE admins, etc.). Assign these roles to different users.
Next, in Applications tab, edit the SAML application. Go to Parameters and use the (+) icon to create a new parameter. In Name field enter http://schemas.xmlsoap.org/claims/Group. Check both Flags (Include in SAML assertion and Multi-value parameter) and save your settings.
In Default if no value selected section select User Roles and Semicolon Delimited input (Multi-value output) from the drop-down menu, and save the parameter.
In your Xopero ONE console go to ⚙️ Settings > External Identity Providers and select the IdP you want to edit.
Click the Group mapping button in the bottom left. In Claim type field enter http://schemas.xmlsoap.org/claims/Group, and in Claim value field enter the name of the role, e.g., XONE viewers. Select roles and permissions you want this group to have, then save. Repeat this step for each role/permission you want to create.
In the above address, change XoperoONEManagementServiceURL to your unique XMS URL. You can find it in your XMS login URL— it's the first part of the address (i.e., in https://12a345bc-67de-8901-2345-f6gh78901i2j.ada.xopero.com/authorization/login the part highlighted in red is the URL you need to copy).
In the above address, change XoperoONEManagementServiceURL to your unique XMS URL. You can find it in your XMS login URL— it's the first part of the address (i.e., in https://12a345bc-67de-8901-2345-f6gh78901i2j.ada.xopero.com/authorization/login the part highlighted in red is the URL you need to copy).
Configuration in Xopero ONE
Configuration in Azure
Configuration in CyberArk
Configuration in Google
Configuration in JumpCloud
Requirements and limitations
If the PKCS #12 file is password protected, add this password to the IdP configuration in Xopero ONE web panel.
Configuration in Okta
Configuration in OneLogin
Using IdP authentication method
Enabling IdP login for the root admin account will prevent logging into the system when an external provider is unavailable.
In the above addresses, change XoperoONEManagementServiceURL to your unique XMS URL. You can find it in your XMS login URL— it's the first part of the address (i.e., in https://12a345bc-67de-8901-2345-f6gh78901i2j.ada.xopero.com/authorization/login the part highlighted in red is the URL you need to copy).
Configuration in Xopero ONE
In the above addresses, change XoperoONEManagementServiceURL to your unique XMS URL. You can find it in your XMS login URL— it's the first part of the address (i.e., in https://12a345bc-67de-8901-2345-f6gh78901i2j.ada.xopero.com/authorization/login the part highlighted in red is the URL you need to copy).
Configuration in Xopero ONE
In the above addresses, change XoperoONEManagementServiceURL to your unique XMS URL. You can find it in your XMS login URL— it's the first part of the address (i.e., in https://12a345bc-67de-8901-2345-f6gh78901i2j.ada.xopero.com/authorization/login the part highlighted in red is the URL you need to copy).
Configuration in Xopero ONE
The Signature Algorithm by default is RSA-SHA256— leave it as is.
If you also want to login to Xopero ONE from the JumpCloud panel, additionally, add your XoperoONEManagementServiceURL in Login URL field.
In the above address, change XoperoONEManagementServiceURL to your unique XMS URL. You can find it in your XMS login URL— it's the first part of the address (i.e., in https://12a345bc-67de-8901-2345-f6gh78901i2j.ada.xopero.com/authorization/login the part highlighted in red is the URL you need to copy).
Configuration in Xopero ONE
In the above address, change XoperoONEManagementServiceURL to your unique XMS URL. You can find it in your XMS login URL— it's the first part of the address (i.e., in https://12a345bc-67de-8901-2345-f6gh78901i2j.ada.xopero.com/authorization/login the part highlighted in red is the URL you need to copy).
In the above address, change XoperoONEManagementServiceURL to your unique XMS URL. You can find it in your XMS login URL— it's the first part of the address (i.e., in https://12a345bc-67de-8901-2345-f6gh78901i2j.ada.xopero.com/authorization/login the part highlighted in red is the URL you need to copy).
Configuration in Xopero ONE
You can read more about adding a new password to the Password Manager in KB article.
Learn more about roles in KB article.
In the above address, change XoperoONEManagementServiceURL to your unique XMS URL. You can find it in your XMS login URL— it's the first part of the address (i.e., in https://12a345bc-67de-8901-2345-f6gh78901i2j.ada.xopero.com/authorization/login the part highlighted in red is the URL you need to copy).
To properly configure logout, the private key of the entity that receives the logout request is required. You must upload a file with the .pfx extension to Xopero ONE for OneLogin integration to work properly. Unfortunately, the .pfx file cannot be downloaded directly from OneLogin— you have to use your own certificate or generate it for implementation.
OneLogin offers a form where you can generate a self-signed certificate:
Manually edited login details always override those set by rules or with provisioned attributes.
Configuration in Xopero ONE
It's important to understand that with this integration method, you cannot initiate the login from the OneLogin application page. Instead, the login must always be triggered directly from the Xopero ONE side.
Group mapping
You can use group mapping if you have many users whom you want to assign different permissions to.
Each new login to Xopero ONE resets permissions to default— if you change permissions for a user it will only apply during the active session. Relogging the user will make permissions return to default.
Group mapping configuration must be done both in OneLogin and Xopero ONE— start by configuring the OneLogin side.
Login to Xopero ONE Management Service (XMS) using a web browser, then go Settings > Advanced > Workers and click the Download agent button.
The Download agent window will open— scroll down to the Server section and click Windows Server > button.
Select WS 2012 or WS 2008 R2 to download a dedicated installer.
The download will start automatically; additionally, an Installation tab with a step-by-step installation instruction will pop-up in XMS.
Under the Install section you will see the address combined a port — save it for later as you will have to use it during agent installation.
Once the installation wizard is downloaded, you can move to the installation process.
Open and run the downloaded setup wizard. Click Next to begin the installation process.
Read and accept the End-User License Agreement, then move to the next step.
Choose the installation directory for the Xopero ONE client.
Paste the previously copied address to the Address field and hit Next to continue.
Click Install to start the installation.
Once the wizard finishes installation, click the Finish button to close it.
You can now activate your device in Xopero ONE Management Service.
Login to Xopero ONE Management Service (XMS) using a web browser, then go Settings > Advanced > Workers and click the Download agent button.
The Download agent window will open— scroll down to the Server section and click Windows Server > button.
Open Active Directory and create a new Organizational Unit on the domain controller under the Active Directory Users and Computers catalog.
Enter a custom name for the Organizational Unit and click OK to confirm.
To learn how to activate the agent in the Xopero management console, check the Useful links and items section.
Select WS 2012 R2 OR NEWER to download a dedicated installer.
The download will start automatically; additionally, an Installation tab with a step-by-step installation instruction will pop-up in XMS.
Under the Install section you will see the address combined a port— save it for later as you will have to use it during agent installation.
Open and run the downloaded setup wizard. Click Next to begin the installation process.
Read and accept the End-User License Agreement, then move to the next step.
Choose the installation directory for the Xopero ONE client.
Paste the previously copied address to the Address field and hit Next to continue.
Click Install to start the installation.
Once the wizard finishes installation, click the Finish button to close it.
You can now activate your device in Xopero ONE Management Service.
Transfer all devices you want to have the Xopero ONE agent installed on to the newly created Organizational Unit.
Create a folder that will be available on your network to all computers that are to be covered by the installation policy of the Xopero ONEagent, and place the .msi installer in it.
Change access permissions of the folder created in the previous step. Right-click the folder and select Properties, then go to Sharing tab and click the Advanced Sharing button.
Make sure the ✅Share this folder checkbox is checked and click Apply to save your settings.
Next, click the Permissions button under the Comments field and change user permissions for the folder.
For domain adminstrators: Full Control
For authenticated users: Read
Open the Group Policy Management (GPO) window, find the OU created in step 1, right-click it, and select the Create a GPO in this domain, and Link it here... option from the drop-down menu.
Enter a custom name for your new group object and click OK.
Right-click the newly created rule and select Edit... from the drop-down menu.
Expand Computer Configuration > Policies > Software Settings > Software Installation tabs. Inside Software Installation, right-click anywhere on the right side of the window and select New > Package... from the dropdown.
Find the shared directory in which you've placed the .msi installer in, then select and open it.
In Deploy Software window select the Advanced deployment method and click OK.
In Xopero ONE Backup&Recovery Agent Properties window, switch to Modifications tab.
Create an .mst file containing additional configuration for the installer — you can use Orca software available as part of the Windows SDK:
1️⃣ Run Orca, go to File > Open, then find and select the Xopero ONEagent.msi installer.
2️⃣ Click Transform and select New Transform from the context menu. Find the Property table and double-click the MANAGEMENT_URL row to edit it — change its value to your XMS IP address (in XMSIPaddress:port format, i.e., https://123.4.5.6:28555).
3️⃣ Additional parameters that can be edited are:
APPDIR — Xopero ONE agent installation path
4️⃣ Next, click Transform > Generate transform and save the .mst file in the previously created shared directory.
Back to Xopero ONE Backup&Recovery Agent Properties window, click Add... and specify the path to the .mst file corresponding to the XMS address (parameter for the MSI installer). Once done, click OK to confirm the changes and close the window.
Once the GPO responsible for MSI installer distribution and deployment is successfully created, you can implement it on user computers covered by this policy in Active Directory— simply run CMD and use the following command:
After restarting the updated station, the Xopero ONEagent will be automatically installed with the parameter corresponding to the XMS address.
