Veeam Agent Mac 2 0 User Guide
Veeam Agent Mac 2 0 User Guide
Version 2
User Guide
November, 2024
© 2024 Veeam Software.
All rights reserved. All trademarks are the property of their respective owners.
No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or
translated into any language in any form by any means, without written permission from Veeam Software
(Veeam). The information contained in this document represents the current view of Veeam on the issue
discussed as of the date of publication and is subject to change without notice. Veeam shall not be liable for
technical or editorial errors or omissions contained herein. Veeam makes no warranties, express or implied, in
this document. Veeam may have patents, patent applications, trademark, copyright, or other intellectual
property rights covering the subject matter of this document. All other trademarks mentioned herein are the
property of their respective owners. Except as expressly provided in any written license agreement from Veeam,
the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other
intellectual property.
NOTE
Read the End User Software License Agreement before using the accompanying software programs. Using
any part of the software indicates that you accept the terms of the End User Software License Agreement.
Customer Support
Should you have a technical concern, suggestion or question, visit the Veeam Customer Support Portal to open a
case, search our knowledge base, reference documentation, manage your license or obtain the latest product
release.
Company Contacts
For the most up-to-date information about company contacts and office locations, visit the Veeam Contacts
Webpage.
Online Support
If you have any questions about Veeam products, you can use the following resources:
Intended Audience
The user guide is intended for anyone who wants to use Veeam Agent for Mac to protect their Mac computer.
Veeam Agent can be used by IT administrators to protect different types of computers and devices: servers,
desktops and laptops.
Veeam Agent offers a variety of features to protect your data. You can back up all user profiles data or individual
files and folders. Backups can be stored on a local hard drive, on an external hard drive, in a network shared
folder, in an object storage repository, in a Veeam backup repository, or Veeam Cloud Connect repository.
In case of a disaster, you can restore individual files and folders from backups to their original location or a new
location.
Veeam Agent for Mac integrates with Veeam Backup & Replication. Backup administrators who work with
Veeam Backup & Replication can perform tasks with Veeam Agent backups: configure backup policies, manage
backups created with backup policies, restore files and folders from backups.
When you install the product, Veeam Agent deploys the following components:
• Veeam Agent for Mac Service (veeamservice) is a service responsible for managing all tasks and resources
in Veeam Agent. The veeamservice component is registered as a daemon in the macOS upon the product
installation. The service is started automatically when you start the OS and runs in the background.
• Veeam Agent for Mac Job Manager (veeamjobman) is a process started by Veeam Agent for Mac Service
for every backup job session.
• Veeam Agent that communicates with the Veeam Agent for Mac Service and Veeam Agent for Mac Job
Manager. Veeam Agent is started by Veeam Agent for Mac Manager to perform data transfer operations of
any kind: copy data from the backed-up volume to the backup location during backup, from the backup
location to the target volume during restore, perform data compression, and so on.
• Veeam Agent for Mac Installer (veeaminstaller) is a component responsible for Veeam Agent
uninstallation process. To learn more, see Uninstalling Veeam Agent.
• Veeam Agent for Mac GUI Application is a component responsible for the Veeam Agent control panel,
status bar and tray menus, as well as Ba ckup Job and Imp ort wizards.
• To store its configuration data, Veeam Agent uses the SQLite database engine. SQLite requires only few
files to install and takes little resources to run on a macOS.
Standalone Mode
In this mode, Veeam Agent operates as a standalone product. To use Veeam Agent operating in the standalone
mode, you must manually install the product directly on the computer whose data you want to protect.
For Veeam Agent operating in the standalone mode, data protection, disaster recovery and administrati on tasks
are performed by the user. You can also use Veeam Agent operating in the standalone mode with Veeam Backup
& Replication. In this scenario, you can use backup repositories managed by Veeam Backup & Replication as a
target location for Veeam Agent backups and use the Veeam Backup & Replication console to perform a number
of tasks with Veeam Agent backup jobs and backups. To learn more, see Integration with Veeam Backup &
Replication.
You can also use Veeam Backup & Replication as a gateway for creating backups targeted at the following types
of repositories:
• Veeam Cloud Connect repository. To learn more, see Backup to Veeam Cloud Connect.
With Veeam Agent operating in the standalone mode, you can also back up data directly to an object
storage repository. To learn more about both options, see Backup to Object Storage.
Managed Mode
In this mode, Veeam Agent operates under control from one of the following Veeam products:
You can automate management of Veeam Agents on multiple computers in your infrastructure in the
Veeam Backup & Replication console. You can configure Veeam Agent backup policies and perform other
data protection and administration tasks on remote computers.
To manage Veeam Agent from Veeam Backup & Replication, you must create a protection group for pre -
installed Veeam Agents and export Veeam Agent installation packages and configuration f ile. After that,
you must install Veeam Agent and apply the configuration file on the computer whose data you want to
protect. For more information on managed Veeam Agent deployment, see the Deploying Veeam Agent for
Mac section in Veeam Agent Management User Guide.
For Veeam Agent managed by Veeam Backup & Replication, data protection, data restore and
administration tasks are performed by a backup administrator in the Veeam Backup & Replication console.
To learn about managing Veeam Agent in Veeam Backup & Replication, see the Veeam Agent Management
Guide.
You can use Veeam Service Provider Console to manage Veeam Agents on multiple computers in your
infrastructure. When Veeam Agent is managed by Veeam Service Provider Console, you can configure
backup job settings, start and stop backup, change glob al settings, update and uninstall Veeam Agent and
collect Veeam Agent data for monitoring and billing.
For Veeam Agent managed by Veeam Service Provider Console, data protection, data restore and
administration tasks are performed by a backup administrator in Veeam Service Provider Console.
Backup administrator can enable a read-only access mode for Veeam Agent installed on the protected
computer. When you work directly with Veeam Agent operating in the read-only access mode, you can
perform a limited set of operations, including:
To learn about deploying and managing Veeam Agent with Veeam Service Provider Console, see Veeam
Service Provider Console User Guides. Select the guide that suits your user role.
You can configure Veeam Agent to perform automatic scheduled backups (triggered at specific time of the day),
or you can choose to back up data manually when needed.
You can back up all user profiles data or individual folders and files.
If Veeam Agent operates in the Workstation or Server edition, you can set up Veeam Agent to create multiple
backups — with individual backup scope, upon individual schedule or in different locations. To learn more about
editions, see Product Editions.
Backups created with Veeam Agent can be saved to the following locations:
With Veeam Agent for Mac, you can specify which files and folders to back up:
• When you back up user profiles data, Veeam Agent captures the content of the home folders of all users
on your computer. When you recover from such backup , you will be able to restore all user profiles data or
restore individual subfolders of home folders and files in these folders.
NOTE
When you back up user profiles data, Veeam Agent does not include data from guest user account
into the backup scope.
• You can include individual folders in the backup. When you include a folder in the backup, its subfolders
are automatically included in the backup too. When you recover from such backup, you will be able to
restore folders that you have selected to back up, all subfolders of these folders and files in these folders.
• You can include or exclude files of a specific type in/from the backup. You can specify file names explicitly
or use UNIX wildcard characters to specify file name masks. When you recover from such backup, you will
be able to restore folders that you have selected to back up with files whose names match the specified
include criteria.
1. When a new backup session starts, Veeam Agent creates a backup file in the target location.
2. In the backup file, Veeam Agent creates a virtual disk. The disk contains a volume with an ext4 file system.
3. Veeam Agent checks the file system of the volume whose data you selected for backup. If data is located
on the volume with an APFS file system, Veeam Agent commands macOS to create an APFS snapshot.
Creating an APFS snapshot guaranties that the data on the volume is consistent and does not change
during backup.
If data is located on the volume with any supported file system excluding APFS, Veeam Agent performs
the backup operation in the snapshot-less mode. This mode allows you to back up data that resides in any
supported file system mounted to the root file system of the Veeam Agent computer. However, Veeam
Agent does not track whether source files have changed since the backup process start.
IMP ORTANT
During backup in the snapshot-less mode, Veeam Agent does not track whether files and directories
have changed in their original location since the time when the backup process started. To make sure
that data in the backup is in the consistent state, you must not perform write operations in the file
system that contains the backed-up data until the backup process is completed.
4. [For incremental backup] To detect files that changed on the Veeam Agent computer since the previous
backup session, Veeam Agent reads file metadata and compares last modification time of files in the
original location and files in the backup created during the previous job session. If the file has modification
time later than the previous job session start time, Veeam Agent considers the file as changed.
5. Veeam Agent reads data from the created APFS snapshot or directly from the volume whose data you
want to back up and copies data that you selected for backup to the target location.
NOTE
The connection between Veeam Agent and the repository may be interrupted when the data is being
copied from the Veeam Agent computer to the target backup repository. If the backup job runs on a
schedule, after the connection is restored Veeam Agent will retry the backup job. During retry,
Veeam Agent will resume the process of data transfer to the backup repository from the point where
it was interrupted. For details, see Resume Backup.
In Veeam Agent, you can configure multiple backup jobs with different settings. For example, you can configure
backup jobs targeted at different backup locations to keep copies of your backed -up data. You can also fine-
tune automatic backup creation process by defining an individual schedule for every backup job.
NOTE
You can create more than one backup job only if Veeam Agent operates in the Workstation or Server
edition. To learn more, see Product Editions.
NOTE
If you use the Server edition of Veeam Agent, you can modify the default settings for backup job retries in
the backup job wizard. For more information, see Scheduling Settings in Server Edition.
In case the backup job fails, Veeam Agent creates a new session for this backup job with the Pending status. The
new session for the backup job retry will start in about 10 minutes.
• Veeam Agent will not perform a backup job retry if the backup job ended with the Success or Warning
status.
• If a backup job fails because of an interrupted connection to the backup repository, Veeam Agent will retry
the backup job and attempt to continue the data transfer that was started before the backup job failed
from the point at which it was interrupted. For more information, see Resume Backup.
• [For object storage repositories] Veeam Agent will launch a backup job retry if during the backup job
session, a backup health check detects corrupted data in the backup. In case the b ackup job was run on a
schedule, Veeam Agent will retry such backup job up to 3 times. Veeam Agent will retry the backup job
only once if the backup job was launched manually. For more information, see Health Check for Object
Storage.
Resume Backup
If a backup job fails due to interrupted connection to the backup repository, Veeam Agent will perform a backup
job retry. During retry, instead of restarting data transfer from the beginning, Veeam Agent will try to resume
the backup process from the point where it was interrupted.
If the connection to the target repository is interrupted, after it is restored, Veeam Agent retries the backup job.
Depending on the type of the source file system, Veea m Agent behaves differently:
• If the data to back up resides on a volume with an APFS file system, Veeam Agent will find the sync file for
the file on which the backup process was interrupted. Veeam Agent will read the offset value from the
sync file and will resume transferring data from the APFS snapshot to the target repository. After the file
is fully copied to the target repository, Veeam Agent deletes its sync file.
NOTE
If for some reason, after the connection to the backup repository is restored, the APFS snapshot is no
longer available, Veeam Agent will trigger the creation of a new snapshot. Then Veeam Agent will
compare the modification times of the files in the new snapshot and on the target repository. In the
backup repository, Veeam Agent will replace all files that have mismatching modification timestamps
with their latest versions from the newly created snapshot.
• If the data to back up resides on a volume with any supported file system excluding APFS, Veeam Agent
performs the backup of such data in the snapshot-less mode. In this case, after the connection to the
repository is restored, Veeam Agent will compare the modification times of the files in the source file
system and in the target repository. In the backup repository, Veeam Agent will replace all files that have
mismatching modification timestamps with their latest versions from the source file system.
• Resume Backup is initiated during a retry of a scheduled backup job only. If you start the backup job
manually and Veeam Agent loses connection to the target repository during backup, after the connection
is restored, Veeam Agent will remove the incomplete restore point and create a new restore point.
• Resume Backup is disabled for backups to local and directly attached storage repositories.
• Direct attached storage (DAS), such as USB, eSATA or Firewire external drives
• Object storage repository, such as S3 Compatible storage, Amazon S3, Google Cloud or Microsoft Azure
Blob
• Network Attached Storage (NAS) able to represent itself as SMB (CIFS) share
• Veeam Backup & Replication 12.1 or later backup repository (including deduplication appliances)
IMP ORTANT
• [For local storage] A backup repository should be created on a separate volume from a volume that
contains data you plan to back up.
• [For Veeam backup repository] Backup repositories with enabled KMS encryption are not supported.
If you target a backup job at the network shared folder, every time the backup job starts, Veeam Agent will
automatically mount the shared folder to the computer file system and create a backup file in the mount
directory. After the backup job completes, Veeam Agent will automatically unmount the network shared folder.
You can target several backup jobs to individual backup repositories or use the same target repository for
several backup jobs. This may be useful if you want to back up different types of data to separate locations or to
keep all backed-up data at one place.
Veeam Agent for Mac works with backup storage differently depending on the way you configure and start
backup jobs — with the Veeam Agent control panel or command line interface. For details, see Managing Backup
Repositories.
• During the first backup job session, Veeam Agent performs full backup. I t copies all data that you have
chosen to back up (entire volumes and folders) and stores the resulting full backup file (VBK) in the target
location. The full backup takes significant time to complete and produces a large backup file: you have to
copy the whole amount of data.
• During subsequent backup job sessions, Veeam Agent performs incremental backups. It copies only new or
changed data relatively to the last backup job session and saves this data as an incremental backup file
(VIB) in the target location. Incremental backups typically take less time than full backup: you have to
copy only changes, not the whole amount of data.
After several backup cycles, you have a chain of backup files in the target location: the first full backup file and
subsequent incremental backup files. Every backup file contains a restore point for backed -up data. A restore
point is a "snapshot" of your data at a specific point in time. You can use restore points to roll back your data to
the necessary state.
To recover data to a specific restore point, you need a chain of backup files: a full backup file plus a set of
incremental backup files following this full backup file. If some file from the backup chain is missing, you will
not be able to roll back to the necessary state. For this reason, we recommend that you do not delete separate
backup files manually. To learn more, see Deleting Backups.
• VBM — backup metadata file. The backup metadata file is updated with every backup job session. It
contains information about the computer on which the backup was created, every restore point in the
backup chain, how restore points are linked to each other and so on. The backup metadata file is required
for performing file-level and volume-level restore operations.
By default, Veeam Agent for Mac retains 7 latest restore points. You can d efine a different number in the backup
job settings. During every backup job session, Veeam Agent checks if there is any obsolete restore point in the
backup chain. If some restore point is obsolete, it is removed from the chain.
1. During every backup job session, Veeam Agent adds a backup file to the backup chain and checks if there
is an obsolete restore point.
a. Veeam Agent re-builds the full backup file to include in it data of the incremental backup file that
follows the full backup file. To do this, Veeam Agent injects into the full backup file data blocks from
the earliest incremental backup file in the chain. This way, a full backup ‘moves’ forward in the backup
chain.
b. The earliest incremental backup file is removed from the chain as redundant: its data has already been
injected into the full backup file, and the full backup file includes data of this incremental backup file.
To mark a backup file for long-term retention, Veeam Agent can assign to the file the following types of GFS
flags: weekly (W), monthly (M) and yearly (Y). The types of GFS flags that Veeam Agent assigns depend on the
configured GFS retention policy settings.
NOTE
Consider the following:
• GFS flags can be assigned only to full backup files created during the time period specified in GFS
policy settings.
• If you store your backups in an object storage repository managed by Veeam Backup & Replication
and connection to this repository is set up through a gateway server, configuring active full backups
is not required, Veeam Agent will create a full backup based on the last incremental backup and will
assign a GFS flag to this full backup. If some data blocks required to create the full backup already
reside in the object storage repository, the full backup will contain links to such data blocks. To
avoid extra costs, Veeam Agent does not retrieve actual data blocks from the object storage
repository.
If Veeam Agent assigns a GFS flag to a full backup file, this backup file can no longer be deleted or modified.
Veeam Agent does not apply short-term retention policy settings to the full backup file. For example, Veeam
Agent ignores the backup file when determining whether the number of allowed backup files is exceeded.
When the specified retention period ends, Veeam Agent unassigns the GFS flag from the full backup file. If the
backup file does not have any other GFS flags assigned, it can be modified and deleted according to the short-
term retention policy.
Limitations
When planning to use GFS retention policy, consider the following limitations:
• [Applicable to all backup targets except object storage] While applying the GFS retention policy, Veeam
Agent does not create new full backup files. You must configure your backup jobs in a way you do not lose
any essential data due to an insufficient number of full backup files. For example, if you configure monthly
GFS retention, you need at least one full backup file per month.
• If a GFS flag is assigned to a full backup file in an active backup chain, the following applies:
o Veeam Agent cannot transform the backup chain according to the short-term retention policy.
o Veeam Agent is not able to merge data from incremental backup files into the full backup file.
• Veeam Agent assigns GFS flags only after you save GFS retention policy settings. This means that GFS
flags are assigned only to those backup files created after the configuration, while backup files created
earlier are not affected and previously assigned flags are not modified.
• You cannot store full backups to which GFS flags are assigned in backup repositories with rotated drives.
• Retention policy for deleted items does not apply to full backup files to which GFS flags ar e assigned.
When Veeam Agent performs active full backup, it produces a full backup file and adds this file to the backup
chain.
The active full backup resets the backup chain. All incremental backup files use the latest active full backup file
as a new starting point. A previously used full backup file and its subsequent incremental backup files remain on
the disk. After the last incremental backup file created prior to the active full backup becomes outdated, Veeam
Agent automatically deletes the previous backup chain. To learn more, see Retention Job for Active Full
Backups.
• To learn how to configure active full backup schedule and create active full backups in the Veeam Agent
for Mac control panel, see Backup Settings and Creating Active Full Backups from Control Panel.
• To learn how to configure active full backup schedule and create active full backups in the Veeam Agent
for Mac command line interface, see Configuring Active Full Backup Schedule and Creating Active Full
Backups in Command Line Interface.
• In case active full backup is scheduled on a week day, Veeam Agent modifies the regular schedule of the
backup job.
For example, the regular backup schedule is set to Monday and Tuesday at 15:00. Active full backup
schedule is set to Friday. In this case, the backup job schedule will contain information that the job must
start on Monday, Tuesday and Friday at 15:00.
• In case active full backup is scheduled on a day of the month, Veeam Agent runs the backup job on this
day at the same time as it must run upon the regular schedule.
Keep in mind that if the job is not scheduled to run automatically, Veeam Agent will not run active full backup.
For information on how to configure backup job schedule, see Define Backup Schedule and Configuring Backup
Schedule.
For this reason, if you create an active full backup, in some days there will be more restore points on the di sk
than specified by retention job settings. Veeam Agent will remove the full backup chain only after the last
incremental backup file in the chain becomes outdated.
For example, the retention job is set to 3 restore points. A full backup file is created on Sunday, incremental
backup files are created on Monday and Tuesday, and an active full backup is created on Wednesday. Although
the backup chain now contains 4 restore points, Veeam Agent will not delete the previous backup chain. Veeam
Agent will wait for the next 2 incremental backup files to be created, and only then will delete the whole
previous chain, which will happen on Friday. As a result, although the retention job is set to 3 restore points, the
actual number of backup files on the disk will be greater for some time.
Data Compression
Data compression decreases the size of created backups but affects duration of the backup procedure. Veeam
Agent allows you to select one of the following compression levels:
Dedupe-friendly 1 Rle Optimized compression level for very low CPU usage.
You can select this compression level if you want to
decrease the load on the CPU of the Veeam Agent
computer.
Extreme 4 Zstd 9 Provides the smallest size of the backup file but reduces
the backup performance. We recommend that you use
the extreme compression level only on Veeam Agent
computers with modern multi-core CPUs (6 cores
recommended).
You can change data compression settings for existing backup jobs. New settings will not have any effect on
previously created backup files in the backup chain. They will be applied to new backup files created after the
settings were changed.
Compression settings are changed on the fly. You do not need to create a new full backup to use new settings —
Veeam Agent will automatically apply the new compression level to newly created backup files.
Storage Optimization
Depending on the type of storage you select as a backup target, Veeam Agent uses data blocks of different size,
which optimizes the size of a backup file and job performance. You can choose one of the following storage
optimization options:
• 1 MB (default) — select this option for backup to SAN, DAS or local storage. With this option selected, Veeam
Agent will use data block size of 1024 KB.
The SAN identifies larger blocks of data and therefore can process large amounts of data at a time. This
option provides the fastest backup job performance.
• 512 KB — select this option for backup to NAS and onsite backup. With this option selected, Veeam Agent
will use data block size of 512 KB. This option reduces the size of an incremental backup file because of
reduced data block sizes.
• 256 KB — select this option if you plan to use WAN for offsite backup. With this option selected, Veeam
Agent will use data block size of 256 KB. This results in the smallest size of backup files, allowing you to
reduce the amount of traffic over WAN.
NOTE
If you change storage optimization settings, the new settings will be applied only after an active full
backup is created. Veeam Agent will use the new block size for the active full backup and subsequent
backup files in the backup chain. For more information on scheduling active full backups, see Backup
Settings.
Data encryption transforms data to an unreadable, scrambled format with the help of a cryptographic algorithm
and a secret key. If encrypted data is intercepted, it cannot be unlocked and read by the eavesdropper. Only
intended recipients who know the secret key can reverse encrypted information back to a readable format.
In Veeam Agent, encryption works at the backup job level. Veeam Agent uses the block cipher encryption
algorithm and stores data in the encrypted format to a backup file.
• Encryption is performed on the source side for all backup targets except the Veeam backup repository.
• Encryption is performed on the target side if you store backups in the Veeam backup repository.
To create encrypted backups, you must enable the encryption option and specify a password that will be u sed
for data encryption. To learn more, see Storage Settings.
NOTE
You cannot enable encryption options in the properties of the Veeam Agent backup job if you have chosen
to create Veeam Agent backups in a Veeam backup repository. For such jobs, encryption options are
managed by a backup administrator working with Veeam Backup & Replication. To learn more about data
encryption capabilities available in Veeam Backup & Replication, see the Data Encryption section in the
Veeam Backup & Replication User Guide.
Encryption Algorithms
To encrypt data in backups and files, Veeam Agent employs a symmetric key encryption algorithm.
The symmetric, or single-key encryption algorithm, uses a single, common secret key to encrypt and decrypt
data on the trusted side. To restore encrypted data, you must have the same secret key. Users who do not have
the secret key cannot decrypt data and get access to it.
Encryption Keys
An encryption key is a string of random characters that is used to bring data to a s crambled format and back to
unscrambled. Encryption keys encode and decode initial data blocks or underlying keys in the key hierarchy.
o Session Key
o Metakey
o Storage key
The session key is the lowest layer in the encryption key hierarchy. When Veeam Agent encrypts data, it first
encodes every data block in a file with a session key. For session keys, Veeam Agent uses the AES algorithm with
a 256-bit key length in the CBC-mode.
Veeam Agent generates a new session key for every backup job session. For example, if you have created an
encrypted backup job and run 3 job sessions, Veeam Agent will produce 3 backup files that will be encrypted
with 3 different session keys:
The session key is used to encrypt only data blocks in backup files. To encrypt backup metadata, Veeam Agent
applies a separate key — metakey. Use of a metakey for metadata raises the security level of encrypted backups.
For every job session, Veeam Agent generates a new metakey. For example, if you have run 3 job sessions,
Veeam Agent will encrypt metadata with 3 metakeys.
In the encryption process, session keys and metakeys are encrypted with keys of a higher layer — storage keys.
Cryptograms of session keys and metakeys are stored in the resulting file next to encrypted data blocks.
Metakeys are additionally kept in the Veeam Agent database.
Storage Keys
Backup files in the backup chain often need to be transformed, for example, when the earliest incremental
backup file in the chain becomes obsolete and its data should be included into the full backup file. When Veeam
Agent transforms a full backup file, it writes data blocks from several restore points to the full backup file. As a
result, the full backup file contains data blocks that are encrypted in different job sessions with different session
keys.
In such situation, storing and handling session keys would be resource consuming and complicated. To facilitate
the encryption process, Veeam Agent uses another type of service key — a storage key.
For storage keys, Veeam Agent uses the AES algorithm with a 256-bit key length in the CBC-mode. A storage
key is directly associated with one restore point in the backup chain. The storage key is used to encrypt the
following keys in the encryption hierarchy:
• All session keys for all data blocks in one restore point
During the restore process, Veeam Agent uses one storage key to decrypt all session keys for one restore point,
no matter how many session keys were used to encrypt data blocks in this restore point. As a result, Veeam
Agent does not need to keep the session keys history in the Veeam Agent database. Instead, it requires only one
storage key to restore data from one file.
In the encryption process, storage keys are encrypted with a key of a higher layer — a user key. Cryptograms of
storage keys are stored in the resulting file next to encrypted data blocks, and cryptograms of session keys and
metakeys.
Storage keys are also kept in the Veeam Agent database. To maintain a set of valid storage keys in the database,
Veeam Agent uses retention policy settings specified for the job . When some restore point is removed from the
backup chain by retention, the storage key corresponding to this restore point is also removed from the Veeam
Agent database.
User Keys
When you enable encryption for a job, you must define a password to protect data processed by this job, and
define a hint for the password. The password and the hint are saved in the job settings. Based on this password,
Veeam Agent generates a user key.
Veeam Agent saves a hint for the password to its database and to the backup metadata file (VBM). When you
decrypt a file, Veeam Agent displays a hint for the password that you must provide. After you enter a password,
Veeam Agent derives a user key from the password and uses it to unlock the storage key for the encrypted file.
According to the security best practices, you should change passwords for encrypted jobs regularly. When you
change a password for the job, Veeam Agent creates a new user key and uses it to encrypt new restore points in
the backup chain. If you lose a password that was specified for encryption, you can change the password in the
encryption settings. You can use the new password to restore data from all restore points in the backup chain,
including those restore points that were encrypted with an old password.
1. When you create a backup job, you enable the encryption option for the job and enter a password to
protect data at the job level.
3. When you start an encrypted job, Veeam Agent creates a storage key and stores this key in its database.
4. Veeam Agent creates a session key and a metakey. The metakey is stored in the Veeam Agent database.
a. The session key encrypts data blocks in the backup file. The metakey encrypts backup metadata.
b. The storage key encrypts the session key and the metakey.
• If encryption keys required to unlock the backup file are available in the Veeam Agent database, you do
not need to enter the password. Veeam Agent uses keys from the database to unlock the backup file. Data
decryption is performed in the background, and data restore does not differ from that from an
unencrypted one.
Automatic data decryption can be performed if you encrypt and decrypt the backup file on the same
Veeam Agent computer using the same Veeam Agent database.
• If encryption keys are not available in the Veeam Agent database, you need to provide a password to
unlock the encrypted file.
Data decryption is performed on the source or target side depending on the backup target. As a result,
encryption keys are not passed to the untrusted side, which helps avoid data interception.
In Veeam Agent, the decryption process includes the following steps. Keep in mind that steps 1 and 2 are
required only if you decrypt the file on the Veeam Agent computer other than the computer where the file was
encrypted.
1. You select the backup from which you want to restore data. Veeam Agent notifies you that one or more
files in the backup chain are encrypted and requires a password.
2. You specify a password for the imported file. If the password has changed once or several times, you need
to specify the latest password. In Veeam Agent, you can use the latest password to restore data from all
restore points in the backup chain, including those restore points that were encrypted with an old
password.
3. Veeam Agent reads the entered password and generates the user key based on this password. With the
user key available, Veeam Agent performs decryption in the following way:
a. Veeam Agent applies the user key to decrypt the storage key.
b. The storage key, in its turn, unlocks underlying session keys and a metakey.
After the encrypted file is unlocked, you can work with it as usual.
NOTE
You cannot specify encryption options for the backup job if you have chosen to save backup files on a
Veeam backup repository. Encryption options for Veeam Agent backup jobs targeted at the backup
repository are managed by a backup administrator working with Veeam Backup & Replication. To learn
more, see the Data Encryption section of the Veeam Backup & Replication User Guide.
3. Veeam Agent encrypts data blocks and transfers them to the target location alre ady encrypted.
4. On the target storage, encrypted data blocks are stored in a resulting backup file.
1. You select an encrypted backup file and define a password to decrypt the backup file. If the password has
changed once or several times, you need to specify the latest password that was used to encrypt files in
the backup chain.
2. Veeam Agent uses the provided password to generate user key and unlock the subsequent keys for backup
file decryption.
3. Veeam Agent retrieves data blocks from the backup file, sends them to the target volume and decrypts
them on the target volume.
Password
1. Use strong passwords that are hard to crack or guess. Consider the following recommendations:
d. The password must significantly differ from the password you used previously.
e. The password must not contain any real information related to you, for example, date of birth, your
pet’s name, your logon name and so on.
2. Provide a meaningful hint for the password that will help you recall the password. The hint for the
password must significantly differ from the password itself. The hint for the password is displayed when
you select an encrypted backup server and attempt to unlock it.
Encryption is not retroactive. If you enable encryption for an existing backup job, Veeam Agent does not encrypt
the previous backup chain created with this job. However, Veeam Agent encrypts backup metadata. As a result,
you need to enter the password to restore data from unencrypted backup files in the backup chain as well as
from encrypted backup files in this chain.
NOTE
• You can use Veeam Agent for Mac2.1 to create backups in a Veeam Cloud Connect repository only if
the backup server of the service provider runs Veeam Backup & Replication 12.0 or later.
• Backup to a Veeam Cloud Connect repository is available if Veeam Agent operates in the
Workstation or Server edition.
If Veeam Agent is managed by Veeam Backup & Replication, see Backup to Veeam Cloud Connect Repository in
the Veeam Agent Management Guide.
If Veeam Agent is managed by Veeam Service Provider Console, see Choose Backup Destination in the Veeam
Service Provider Console Guide for Service Providers.
• Amazon S3
• S3 compatible — on-premises (for example, MinIO) or cloud (including Wasabi Cloud and IBM Cloud)
• [For Veeam Agent 2.1.2] Veeam Data Cloud Vault added as a Veeam backup repository or Veeam Cloud
Connect repository.
Depending on your backup infrastructure, object storage can be available in different configurations. To learn
more, see the following subsections:
• Backup Destinations
Backup Destinations
You can back up Veeam Agent computer data to object storage in the following ways:
• Directly to object storage. In this case, Veeam Agent connects to an object storage account and creates a
backup repository in this storage.
Keep in mind that to connect to object storage, you need to have an account with access p ermissions to
read and write data.
• To object storage added as a Veeam backup repository. In this case, Veeam Agent connects to the Veeam
backup repository and Veeam Backup & Replication connects to object storage and creates a backup
repository in this storage.
• To object storage added as a Veeam Cloud Connect repository. In this case, Veeam Agent connects to the
cloud backup repository and Veeam Backup & Replication connects to the object storage and creates a
backup repository in this storage.
• Connection through a gateway server. With this connection type, Veeam Agent connects to the repository
using a proxy component — a gateway server that is assigned in the Veeam Backup & Replication console.
The backup data is transferred from the Veeam Agent computer to the gateway serve r, then it is
transferred from the gateway server to the repository.
• Direct connection. With this connection type, Veeam Agent connects directly to the repository. The
backup data is transferred from the Veeam Agent computer to the repository without proxy components.
The access to this repository is managed by Application Programming Interface (API) that is provided by
the object storage provider.
• Veeam Agent does not support direct backup to the Microsoft Azure Blob Storage under the general -
purpose V1 storage account type.
• You can store backups only in those S3 compatible storage repositories that are accessible over the HTTPs
protocol.
• [For object storage added as a Veeam backup repository or Veeam Cloud Connect repository] If you want
to back up your data directly to the S3 compatible storage, you must additionally specify access
permissions settings for the storage. For direct access, enable the Ag ents share credentials to object
storage repository or the P rovided by IAM/STS object storage capabilities access control option. For more
information, see the Managing Permissions for S3 Compatible Object Storage section in the Veeam Backup
& Replication User Guide.
• [For object storage added as a Veeam backup repository or Veeam Cloud Connect repository] Data
recovery options are not available if you access the object storage repository using credentials with the
read-only access permissions.
• Veeam Agent does not support backup to object storage for which lifecycle rules are enabled. Enabling
lifecycle rules may result in backup and restore failures.
• Veeam Agent verifies metadata of the whole backup, not just the latest restore point.
• Veeam Agent does not read data from data blocks in the storage; Veeam Agent only lists data blocks to
make sure all blocks in the storage are available for rebuilding every restore point in the active backup
chain. This mechanism reduces the number of requests to the storage, which makes health check for
object storage cost-efficient.
• Health check is run automatically during incremental backup job session on the days specified in the
health check schedule. If the backup job runs several times on a specified day, health check is performed
only with the first run of the backup job on that day.
Health check is not performed during the first full backup or subsequent active full backup job sessions.
• If Veeam Agent does not run any backup jobs on the day specified in the health check schedule, health
check will be performed during the first backup job session following that day.
For example, you may have scheduled to run a health check every last day of a month, while the backup
job is scheduled to run every day and to create an active full backup on Sundays. If the last day of a month
falls on a Sunday, the health check will be performed on the following Monday with the first incremental
backup job session on that day.
1. During the backup job session after a new incremental backup file is created, Veeam Agent starts the
health check of the whole backup. Veeam Agent checks if the metadata of the backup is consistent, and
no metadata is missing. Veeam Agent also checks if all data blocks for every restore point are available on
the storage. Veeam Agent does not read data from data blocks.
2. If Veeam Agent does not find any corrupted data, the health check completes successfully. Otherwise, the
health check completes with an error.
You can view the health check result in the session log. If during the health check, Veeam Agent finds
corrupted data, it will also display information on where corrupt data has been detected — in backup
metadata or data blocks, as well as list all restore points that share the corrupted data blocks.
Depending on the detected data inconsistency, Veeam Agent acts in one of the following ways:
o If the health check detects corrupted metadata, Veeam Agent will mark the backup chain as corrupted
in the Veeam Agent configuration database; the backup job session will fail. During the next
scheduled or manual backup job session, Veeam Agent will create a full backup and will start a new
backup chain. The corrupted backup chain will become orphaned and will remain in the repository —
you can keep or delete it.
o If the health check detects corrupted data blocks in the latest restore point of the active backup
chain, Veeam Agent launches a health check retry.
During the health check retry, Veeam Agent will restart the backup job to create a new restore point.
After that, Veeam Agent will transfer data blocks from the Veeam Agent computer to the backup
repository. The transferred data blocks will include the blocks that were corrupted in the object
storage repository and the blocks that changed since the start of the backup job session that
triggered the health check. Veeam Agent will not perform another health check after the job retry is
finished. The next health check will be run according to the defined schedule.
o If the health check detects corrupted data blocks in an inactive backup chain, Veeam Agent will not
launch a health check retry. Veeam Agent will mark the backup and all related restore points as
corrupted; the backup job session will end with a warning message.
If you try to restore data from a corrupted backup, Veeam Agent will display a warning message
informing you that the restore operation may fail or the restored data may be corrupted.
Backup Immutability
If you store your backup files in an object storage repository, Veeam Ag ent allows you to protect backup data
from deletion or modification by making that data temporarily immutable. It is done for increased security:
immutability protects data in your recent backups from loss as a result of attacks, malware activity or any ot her
injurious actions.
IMP ORTANT
Backup immutability uses native object storage capabilities. You may incur additional API and storage
charges from the storage provider.
• Amazon S3
NOTE
Veeam Agent does not support backup immutability for the Google Cloud storage.
• [S3 Compatible and Amazon S3 storage] When you create the S3 bucket, you must enable versioning and
the S3 Object Lock feature for the bucket. For more information, see AWS documentation.
• [S3 Compatible and Amazon S3 storage] After you create the S3 bucket with Object Lock enabled, make
sure that the default retention is disabled to avoid unpredictable system behavior and data loss. To
disable the default retention, edit the Object Lock retention settings as describe d in AWS documentation.
• [Microsoft Azure Blob storage] You must enable blob versioning and version-level immutability support in
the storage account. For more information, see Microsoft documentation.
• The effective immutability period consists of the user-defined immutability period and the block
generation period automatically appended by Veeam Agent. For more information, see How Backup
Immutability Works and Block Generation.
• [Microsoft Azure Blob storage] Do not enable immutability for already existing containers in the Microsoft
Azure Portal. Otherwise, Veeam Agent will not be able to process these containers properly and it may
result in data loss.
• [Backup Job wizard] You must specify the immutability period at the Bucket step of the wizard. For more
information, see Object Storage Settings.
• [Command line interface] You must specify the immutability period in the advanced options of the
command for creating the backup job. For more information, see Creating Backup Job in CLI.
NOTE
If you want to create the backup job in command line interface, you must create the object storage
repository first. For details, see Creating Repository in Object Storage.
• If you create the backup job that is targeted at an object storage repository configured as a Veeam backup
repository or Veeam Cloud Connect repository, the immutability period in the settings of the repository
must be specified in Veeam Backup & Replication. For details, see the Adding Object Storage Repositories
section in the Veeam Backup & Replication User Guide.
Veeam Agent will remove the irrelevant restore points per the defined backup retention policy. If the data
associated with the removed restore point is still immutable, such data will remain in the repository until
expiration of the immutability period. After that it will be automatically removed from the storage.
1. Add the object storage repository that contains the necessary data to Veeam Backup & Replication. For
more information, see the Adding Object Storage Repositories section in the Veeam Backup & Replication
User Guide.
2. Roll back to the necessary checkpoint. For more information, see the Immutability section in the Veeam
PowerShell Reference.
3. Remove the repository from the Veeam Backup & Replication infrastructure. For more information, see the
Removing Backup Repositories section in the Veeam Backup & Replication User Guide.
During the effective immutability period, the following operations with backup data in the object storage
repository will be prohibited:
• Removal of data by the technical support department of the object storage provider.
During data transfer, the effective immutability period for the backup is set as follows:
• [For new data blocks in the checkpoint] Immutability is set anew. The user -defined immutability period is
appended with a 10-day block generation period.
• [For data blocks reused from the previous checkpoint] Immutability is extended to the immutability
expiration date set for the new blocks.
• [For data blocks that are not reused in the checkpoint] Immutability is not extended. Such data blocks will
remain in the repository until their immutability period is over. After that Veeam Agent will automatically
remove them from the repository.
Block Generation
When you specify an immutability period for the recent backups, Veeam Agent will automatically add 10 days to
the immutability expiration date. This period is called block generation. The block generation period serves to
reduce the number of requests to the object storage repository, which results in lower traffic and reduced
storage costs. You do not have to configure it, the block generation period is applied automatically.
When the block generation period is appended to the user-defined immutability period, it means there is no
need to extend the immutability period for old data blocks when adding new data blocks to the backup during
that block generation period.
If a block generation period is over but data blocks from that generation are reused in the newly created
checkpoint, their effective immutability period is automatically extended to ensure that the effective
immutability period for all the data blocks in the new checkpoint is no less than the user -defined immutability
period. For more information, see How Backup Immutability Works.
If you have lost or modified folders and files on your computer by mistake, you can restore a copy of the
necessary items from the backup.
To use Veeam Agent for Mac 2.1 with Veeam Backup & Replication, you must install Veeam Backup &
Replication 12.1 on the Veeam backup server.
To use Veeam Agent for Mac 2.0 with Veeam Backup & Replication, you must install Veeam Backup &
Replication 12.0 or later on the Veeam backup server.
You can store backup files created with Veeam Agent for Mac on backup repositories managed by Veeam Backup
& Replication. To do this, you must connect Veeam Agent to a Veeam backup server and select a Veeam Backup
& Replication backup repository as a target location in the backup job settings. To learn more about supported
backup repositories, see the Backup Repositories and Scale-Out Backup Repositories sections in the Veeam
Backup & Replication User Guide.
Veeam Agent for Mac works with the Veeam Backup & Replication backup repository as with any other backup
repository. Backup files are stored to a separate folder; you can perform standard restore operations using these
files.
Information about Veeam Agent backups stored on the Veeam Backup & Replication backup repositories, backup
jobs and sessions becomes available in the Veeam Backup & Replication console:
• The Veeam Agent for Mac backup job is displayed in the list of jobs in Veeam Backup & Replication.
• Backup files created with Veeam Agent for Mac are displayed in the list of backups, under the Ag ents
node.
• Performed job sessions are available in the History view of Veeam Backup & Replication.
Backup administrators working with Veeam Backup & Replication can perform a set of operations with Veeam
Agent backups:
• Perform data protection operations: copy Veeam Agent backups to secondary backup repositories and
archive these backups to tape.
• Perform restore operations: restore individual files and directories from Veeam Agent backups, export
disks and export restore points of Veeam Agent backups to standa lone full backup files.
• Perform administrative tasks: disable and delete Veeam Agent backup jobs, import and remove Veeam
Agent backups, and so on.
Sp ecification Requirement
Ha rdware The protected Mac computer must meet the following hardware
requirements:
• HFS+
• MS-DOS (FAT)
• exFAT
• NTFS
• FAT32
• SMB
Keep in mind that characters that you can use in the file name may be
encoded in 2 bytes or more.
• Sparse files are not supported. Veeam Agent backs up and restores
sparse files as regular files.
• Veeam Agent for Mac automatically excludes from backup the files
that have the following extended attribute:
com.apple.metadata:com_apple_backup_excludeItem.
Backup Target
Backup can be performed to the following types of storage:
IMP ORTANT
Network
Consider the following:
• Domain names of the Veeam Agent for Mac computer, Veeam Backup
& Replication server and other servers in the Veeam backup
infrastructure must be resolvable into IPv4 or IPv6 addresses.
• Amazon S3 or S3 compatible
Amazon S3 or S3 compatible
If you plan to back up data to the Amazon S3 or S3 compatible storage, make sure the user account that you
plan to use has the following permissions:
Identity-based permission:
{
"s3:ListAllMyBuckets"
}
Resource-based permissions:
{
"s3:DeleteObject",
"s3:GetBucketLocation",
"s3:GetBucketObjectLockConfiguration",
"s3:GetBucketVersioning",
"s3:GetObject",
"s3:ListBucket",
"s3:PutObject"
}
TIP
For information about required permissions for Amazon S3 storage with immutability enabled, see the
Using Object Storage Repositories section in the Veeam Backup & Replication User Guide.
{
"storage.buckets.get",
"storage.buckets.list",
"storage.objects.create",
"storage.objects.delete",
"storage.objects.get",
"storage.objects.list"
}
To learn about ports required to enable proper work of Veeam Agent for Mac managed by Veeam Backup &
Replication, see the Ports section in the Veeam Agent Management Guide.
Veeam Agent Veeam TCP 10006 Default port used for communication with
computer backup server the Veeam backup server.
Veeam Agent TCP 10101 Port used to create a mount point on the
computer computer. Veeam Agent uses this mount
point when the restore process starts and
allows you to browse and restore files.
Veeam Agent Linux server TCP 2500 to Default range of ports used as data
computer performing 3300 transmission channels. For every TCP
the role of a connection that a job uses, one port from
backup this range is assigned.
repository
Shared folder TCP 137 to 139, Ports used as a transmission channel from
SMB (CIFS) UDP 445 the Veeam Agent for Mac computer to
share the target SMB (CIFS) share.
Veeam Agent Cloud TCP 6180 Port on the cloud gateway used to
computer gateway transport Veeam Agent backup data to
the Veeam Cloud Connect repository.
Veeam Amazon S3 TCP 443 Used to communicate with the Amazon S3 object
Agent object storage through the following endpoints:
Computer storage
• *.amazonaws.com (for both Global and
Government regions)
• *.amazonaws.com.cn (for China region)
• ocsp.msocsp.com
IBM Cloud TCP Depends on Used to communicate with IBM Cloud object
object device storage.
storage configuration
1. The computer on which you plan to install Veeam Agent must satisfy system requirements specified in this
document.
2. To install the Veeam Agent package, you must use the Administrator account on the computer where you
plan to install the product.
1. Download the setup archive for standalone Veeam Agent for Mac from this Veeam webpage and save it on
the computer where you plan to install the product.
2. Double-click the downloaded setup archive. In the open archive, double-click the .pkg setup file to
launch the installation wizard.
4. [macOS 10.14 or later] After the installation process is complete, you must enable full disk access for
Veeam Agent. To learn more, see Granting Full Disk Access.
Keep in mind that during the installation process, Veeam Agent will prompt you to enter the Administrator
password.
Alternatively, you can install Veeam Agent for Mac with the MDM solution or in command line interface.
NOTE
If you are using macOS High Sierra (version 10.13.6), the access to files and folders is granted automatically
at the moment of installation. Starting from macOS Mojave (10.14.X), you must grant access manually.
Depending on the macOS version, to grant full disk access to Veeam Agent, do the following.
1. In the upper-left corner of the screen, click the Ap p le menu > Sy stem Settings.
4. In the list of apps, use the toggle switch next to Veea m Agent for Mac to enable full disk access.
If the Veeam Agent for Mac is not in the list of applications, click the "plus" icon and add Veeam Agent for
Mac to the list.
5. If prompted, provide the administrator password to allow editing the system settings.
1. In the upper-left corner of the screen, click the Ap p le menu > Sy stem Preferences.
2. In Sy stem Preferences, click Security & Privacy and select the P rivacy tab.
3. If the preference pane is locked, click the lock icon and enter the administrator password to allow editing
the system preferences.
5. In the list of apps, select the check box next to Veeam Agent for Mac to enable full disk access.
If the Veeam Agent for Mac is not in the list of applications, click the "plus" icon and add Veeam Agent for
Mac to the list.
Alternatively, you can grant full disk access to Veeam Agent with the MDM solution.
IMP ORTANT
Before starting the upgrade process, make sure that there are no backup jobs running on the Veeam Agent
computer.
1. Save the installation package for the newer version of Veeam Agent to the Mac computer where you plan
to upgrade the product.
3. Click OK to accept an upgrade of Veeam Agent that is currently installed on the Mac computer.
Keep in mind that during the upgrade process, Veeam Agent will prompt you to enter the Administrator
password.
1. Open the Find er, then click Ap p lications in the sidebar of the Find er window.
3. Double-click the Uninstall Agent for Mac application. After that, Veeam Agent for Mac and Uninstall
Ag ent for Mac applications will be uninstalled.
Keep in mind that during the uninstallation process, Veeam Agent will prompt you to enter the Administrator
password.
IMP ORTANT
Do not move Veeam Agent for Mac and Uninstall Agent for Mac applications to Bin.
The veeam group is automatically created by Veeam Agent at the process of the product installation. To let
regular users work with Veeam Agent without the need to gain root privileges, you can add the necessary use rs
to this group. Users in the veeam group will be able to execute Veeam Agent commands and perform backup
and restore tasks under a regular user account.
IMP ORTANT
• To add a user to the veeam group, you must have administrator privileges.
• An administrator can restore all user profiles that are available in the backup file, a standard user
can restore only their own user profile.
Depending on the macOS version, to add a user to the veeam group, do the following.
1. In the upper-left corner of the screen, click the Ap p le menu > Sy stem Settings.
3. In the list of groups, click the "info" icon next to the veeam group.
4. In the list of users, turn on the toggle switch next to the user you want to add to the group.
If prompted, provide the administrator password to allow editing the system settings.
1. In the upper-left corner of the screen, click the Ap p le menu > Sy stem Preferences.
3. If the preference pane is locked, click the lock icon and enter the administrator password to allow editing
system preferences.
5. In the list of users, select the check box next to the user you want to add to the group.
Alternatively, you can add a user to the veeam group with the command line interface.
Veeam Agent for Mac provides setup files for the following MDM solutions:
• Jamf Pro
• Microsoft Intune
• SimpleMDM
Veeam Agent for Mac installation and configuration includes the following operations:
For details how to deploy a .pkg package, refer to the documentation of your MDM solution.
To grand full disk access and perform other configuration tasks, you need to use the following Veeam
Agent parameters:
The configuration process is required to connect Veeam Agent to Veeam backup server and include Veeam
Agent computer in the protection group. Veeam Agent configuration is performed by deploying device
profile on the Veeam Agent computer.
If you use Jamf Pro, Microsoft Intune or SimpleMDM, see detailed instructions in Appendix A. Deploying
Device Profile with MDM Solution. If you use another MDM solution, instructions may differ, refer to the
documentation of your MDM solution.
1. Save the downloaded package on the computer where you plan to install the product.
where:
o <volume> — name of the volume where you want to install Veeam Agent. To install Veeam Agent on
the volume from which your Mac computer started up, specify the '/' (slash) character.
For example:
3. After the installation process is complete, grant full disk access for Veeam Agent. To learn more, see
Granting Full Disk Access.
TIP
To check whether license agreements are accepted, use the following command: veeamconfig
agreement show.
1. Get the configuration file from your system administrator and upload this file to the Veeam Agent
computer.
2. Navigate to the directory where you have saved the configuration file and run the following command:
Alternatively, you can specify the full path to the configuration file without navigating to the directory where
you have saved this file — for example:
Mind that the connection between Veeam backup server and Veeam Agent computer is not persistent. Veeam
Agent synchronizes with Veeam Backup & Replication every 6 hours. To synchronize Veeam Agent immediately,
run the following command from the Veeam Agent computer:
where:
<username> — name of the account to which you want to grant access to Veeam Agent.
For example:
To check whether the user is added to the veeam group, you can use the following command:
groups
For example:
user@wrk001 ~ % groups
staff adm everyone dip plugdev lpadmin veeam
where:
The --purge option is optional. Use this option to delete a local Veeam Agent database together with Veeam
Agent for Mac.
For example:
You can import a configuration file generated by Veeam Backup & Replication in ether of the following ways:
• In command line interface. For more information, see Connecting to Veeam Backup & Replication.
• With MDM solution. For more information, see Installation and Configuration with MDM Solution.
After importing the configuration using the control panel or status bar menu, Veeam Agent will automatically
connect to the Veeam backup server.
Veeam Agent allows you to perform the following actions to manage the operation mode:
P a rameter Description
If Veeam Agent operates in the standalone mode, Veeam Agent will display the Not
Set value.
Keep in mind that features and limitations of Veeam Agent operating in the managed
mode are different from those in the standalone mode. To learn more about managed
mode, see the Veeam Agent Management Guide.
For example:
If Veeam Agent operates in the managed mode, you can reset it to the standalone mode at any time. To learn
more, see Resetting to Standalone Operation Mode.
Before you reset Veeam Agent to the standalone mode, consider the following:
• Veeam Agent computer added to the protection group of pre-installed Veeam Agents will be
automatically removed from the protection group in Veeam Backup & Replication.
• All backup jobs configured on the Veeam Agent computer will be deleted. If you plan to protect this
computer with a standalone Veeam Agent, you will need to create new backup jobs.
• Veeam backup server settings including protection group configuration settings will be deleted.
• Previously created backup files will remain in the target backup repository. If the target repository is
managed by the Veeam backup server, in the Veeam Backup & Replication console, they will be marked as
Orphaned .
To reset Veeam Agent to the standalone operating mode, run the following command:
You can use the --force option to override additional input prompts and error messages:
You can import the configuration file generated by Veeam Backup & Replication in ether of the following ways:
• With MDM solution. For more information, see Installation and Configuration with MDM Solution.
After importing the configuration using the control panel or status bar menu, Veeam Agent will automatically
connect to the Veeam backup server.
1. Get the configuration file from your System Administrator and upload this file to the Veeam Agent
computer.
where:
o <file_name> — configuration file name. Alternatively, you can specify the full path to the
configuration file with the --cfg option.
o --force — with this option enabled, Veeam Agent will override additional input prompts and error
messages. This parameter is optional.
For example:
You can immediately synchronize Veeam Agent with backup server in the following ways:
You can export product logs to Veeam backup server in the following ways:
Veeam Agent will collect logs, export them to an archive file with the name
veeam_logs_<agent>_<date>_<time>.tar.gz and save the archive to to the following folder on the
Veeam backup server:
C:\ProgramData\Veeam\Backup\Endpoint\Other\AgentLogs\<computer_name>
TIP
If Veeam Agent operates in the standalone mode, you can export product logs only to a local directory on
the Veeam Agent computer. To learn more, see Exporting Product Logs.
Depending on the installation mode, you must accept these license agreements in the following ways:
• [Installation wizard] Confirm you accept these agreements at the respective steps of the Installation
wizard.
• [Command line interface] Accept these agreements after the installation using a separate command. For
details, see Accepting License Agreements.
If you want to use a commercial version of Veeam Agent, you must obtain a license and install it on the
protected computer. If you do not install a license, the product will operate in the Free edition.
Depending on the Veeam Agent operation mode, you can manage licenses in the following ways:
• If Veeam Agent operates in the standalone mode, you can manage product licenses in the Veeam Agent
control panel or in command line interface. To learn more, see the topics in this section.
• If Veeam Agent operates in the managed mode, you can manage product licenses and editions from the
Veeam Backup & Replication console. To learn more, see Managing License with Veeam Backup &
Replication.
To learn more about operation modes, see Standalone and Managed Operation Modes.
• Server — a commercial edition that provides access to all product functions and is intended for performing
data protection tasks on servers that run macOS.
• Workstation — a commercial edition that offers limited capabilities that are sufficient for performing data
protection tasks on desktop computers and laptops that run macOS.
• Free — a free edition that offers the capabilities of the Workstation edition with certain limitations. Free
edition does not come with a commercial support program. In contrast to the workstation and server
editions, the Free edition does not require a license.
NOTE
After the license expires, Veeam Agent for Mac automatically switches to the Free edition. If Veeam Agent
for Mac operated in the Server or Workstation edition and multiple backup jobs were configured, after
switching to the Free edition, all backup jobs will be failing.
1. The number of backup jobs that you can configure in Veeam Agent for Mac is limited to one.
2. You cannot use a Veeam Cloud Connect repository as a target location for backup files.
4. The number of backup jobs that you can configure in Veeam Agent for Mac is limited to one backup job
targeted at a local drive, network shared folder, object storage repository or Veeam backup r epository
plus unlimited number of backup jobs targeted at a Veeam Cloud Connect repository.
NOTE
If you plan to use a Veeam backup repository as a target location for backups, you must install a license in
Veeam Backup & Replication. The license must have enough instances to protect machines with Veeam
Agents that back up data to the Veeam backup repository. To learn more, see Managing License.
To install a license:
2. From the application main menu, select Settings > Install License.
Veeam Agent will install the license and select the product edition that is allowed by the license. If a
license supports both the Workstation and Server editions, Veeam Agent will select the Workstation
edition.
You can change the product edition manually if needed. To learn more, see Selecting Product Edition
You can change the product edition manually if needed. To select the product edition:
To learn more about editions of Veeam Agent for Mac, see Product Editions.
NOTE
After you switch from the Server edition to the Workstation edition, or vice versa, Veeam Agent will disable
the configured backup jobs. This operation is required because backup retention policies and available
backup job options differ in Workstation and Server editions. To enable the job, you must edit the backup
job settings in accordance with the selected edition.
To revoke a license:
1. From the Veeam Agent for Mac application menu, select Settings > Install License.
After you revoke the license, Veeam Agent for Mac will continue to operate in the Free edition. If Veeam Agent
operated in the Server or Workstation edition and multiple backup jobs were configured, after switching to the
Free edition, all backup jobs will be failing.
TIP
If Veeam Agent operates in the managed mode, you can manage product licenses only from the Veeam
Backup & Replication console. To learn more, see Managing License.
or
where:
• <path> — path to the license key file in the local file system of your computer.
• workstation or server — edition in which Veeam Agent will operate. To learn more about editions, see
Product Editions.
Veeam Agent for Mac will install the license and display information about the license. You can also view this
information later at any time. To learn more, see Viewing License Information.
For example:
TIP
If you work with Veeam Agent operating in the managed mode, you can manage a license only from the
Veeam Backup & Replication console. To learn more, see Managing Instance Consumption by Veeam
Agents.
Veeam Agent for Mac will display information about the license. For example:
After you remove the license, Veeam Agent for Mac will continue to operate in the Free edition. If Veeam Agent
operated in the Server or Workstation edition and multiple backup jobs were configured, after switching to the
Free edition, all backup jobs will be failing.
1. Define what data you want to back up and configure the backup job .
Before you configure the backup job, you should decide on the following backup details:
o Backup destination: where you want to store your backed -up data.
After that, you can configure one or several backup jobs. The backup job captures the data that you have
added to the backup scope and creates a chain of restore points in the target location. If your data gets
lost or corrupted, you can restore it from the necessary restore point.
In Veeam Agent, you can configure the backup job in one of the following ways:
You can use the session log window in the Veeam Agent control panel to view how backup tasks are being
performed, what errors have occurred during the backup job and other session statistics in real time. You
can also use Veeam Agent command line interface to get information on backup and restore sessions
status and view session logs. To learn more, see Reporting.
3. In case of a disaster, y ou can restore your data. You can perform data recovery operations in several ways:
• Add, edit, start and stop standalone backup jobs. For more information, see Performing Backup.
• Monitor performance and status, as well as view logs of backup sessions. For more informa tion, see
Reporting.
• View and browse available restore points, restore files, folders and user profiles data. For more
information, see Performing Restore.
• Manage product license and edition. For more information, see Licensing.
• Temporarily suspend scheduled backups. For more information, see Suspending Scheduled Backups.
• Import configuration from Veeam Backup & Replication. For more information, see Importing
Configuration from Veeam Backup Server.
Application Menu
The Veeam Agent application menu provides the following items:
o Add New Job — use this option to create new backup jobs using the Ba ckup Job wizard.
o Import Backup — use this option to import backups using the Imp ort wizard.
o Edit Backup Job — use this option to select a backup job and edit its settings in the Ba ckup Job wizard.
o Delete Backup Job — use this option to select a backup job to delete.
o Import Configuration — use this option to import a configuration file from Veeam Backup &
Replication.
o Install License — use this option to view and manage the Veeam Agent license.
o Sync with the Backup Server — if Veeam Agent computer is managed by Veeam Backup & Replication
through a protection group for pre-installed Veeam Agents, use this option to immediately
synchronize Veeam Agent configuration with Veeam Backup & Replication database.
IMP ORTANT
This option is inactive if Veeam Agent operates in the standalone mode. For more information
on operation modes, see Standalone and Managed Operation Modes.
o Export Logs to — use this menu to export product logs. It provides two options:
▪ Local folder — use this option to save the product logs in a local folder on the Veeam Agent
computer.
▪ Veeam server — if Veeam Agent computer is managed by Veeam Backup & Replication through a
protection group for pre-installed Veeam Agents, use this option to save the product logs in a
folder on the Veeam backup server.
IMP ORTANT
This option is inactive if Veeam Agent operates in the standalone mode. For more
information on operation modes, see Standalone and Managed Operation Modes.
• If there is only one job configured in Veeam Agent, you can start and stop the job, as well as run an ad -hoc
active full backup. For more information, see Performing Backup.
• Import configuration from Veeam Backup & Replication. For more information, see Importing
Configuration from Veeam Backup Server.
• Export product logs. For more information, see Exporting Product Logs with Control Panel and Status Bar
Menu.
To work with Veeam Agent using command line interface, you can use a terminal console or a terminal emulator
of your choice. All tasks in Veeam Agent are performed with the veeamconfig command line utility. To
perform tasks with Veeam Agent, you should construct the necessary command and type it in the terminal
prompt.
You can view short help information on every Veeam Agent command at any time you need. To learn more, see
Viewing Help.
In Veeam Agent command line interface, in addition to operations that you can perform with the Veeam Agent
graphic user interface, you can perform a set of advanced tasks — for example:
o Monitor performance and status of any backup, restore and other data transfer session that was
started in Veeam Agent.
where:
• <command_1> — command that defines a type of an object with which you want to perform a task.
Currently, the following commands are available in Veeam Agent:
o agreement
o backup
o cloud
o config
o grablogs
o healthcheck
o help
o job
o license
o mode
o objectstorage
o repository
o schedule
o session
o version
o vbrserver
• <command_2> — command that defines a task that you want to perform with an object of the specified
type. For example, you can perform the following commands with backup repositories:
o create
o createrepository
o delete
o edit
o help
o list
o rescan
• <parameter_1>, <parameter_2>, <parameter_n> — parameters for the command that you want
to execute. Commands may require one or several mandatory or optional parameters. Some commands,
for example, veeamconfig ui and veeamconfig [<command>] help do not require parameters.
The following example shows the command that displays a list of backup repositories configured in Veeam
Agent and the output of this command:
Viewing Help
You can view short help information on the specific Veeam Agent command. To view help, use the following
command:
where:
<command> — name of the command for which you want to view help information.
or
or
• You can configure backup jobs targeted at different backup repositories to keep several copies of your
backed-up data at different locations.
• You can configure several backup jobs and define individual schedule for every job to back up necessary
data at the desired time.
You can configure a backup job that will automatically back up your data according to a defined schedule. You
can also start backup job manually at any time.
• The target location where you plan to store backup files must have enough free space.
• [For Veeam Backup & Replication repositories] To store backups in a backup repository, the backup server
must run the following version of Veeam Backup & Replication:
o [For Veeam Agent version 2.1] Veeam Backup & Replication version 12.1 or later.
o [For Veeam Agent version 2.0] Veeam Backup & Replication version 12.0 or later.
• [For Veeam Backup & Replication repositories] If you plan to use a Veeam Backup & Replication repository
as a target for backups, you must pre-configure user access permissions on this backup repository. To
learn more, see Setting Up User Permissions on Backup Repositories.
• [For object storage repositories] If you plan to use an object storage repository as a target for backups,
you must set up an account with the storage provider. The account must have permissions to read and
write data.
• You cannot save the backup of entire computer on the local computer disk. Use an external hard drive or
USB drive, network shared folder or backup repository as a target location.
• Veeam Agent does not back up data to which symbolic links are targeted. It only backs up the path
information that the symbolic links contain. After restore, identical symbolic links are created in the
restore destination.
• Keep in mind that Veeam Agent stops running the backup job after 21 days (504 hours).
• In the Veeam Agent for Mac application menu, select Ba ckup > Ad d New Job.
• In the Veeam Agent for Mac control panel, click Ad d New Job.
If you haven't created any backup jobs yet, the control panel will display the Ad d New Job link in the
center of the window:
You can include all or either of the following data in the backup:
• Data on USB drives — data that resides on the USB devices attached to your computer.
• Personal files — data related to user profiles. With this option enabled, Veeam Agent will back up data
related to all user profiles on the Veeam Agent computer. You can specify what personal data to include in
the backup and choose whether to exclude network accounts from the backup. To le arn more, see
Protecting User Profiles Data.
If you do not want to back up default personal data, you can change the backup scope by selecting what folders
Veeam Agent includes in the Users component. To do this, click Choose next to the P ersonal files field and
select the necessary options in the Ba ck up user profile folders window.
You can use the All other files option to back up all folders and files that are located in the Users folder on the
system volume, but are not available in the Ba ck up user profile folders window.
Selecting Folders
You must include in the backup at least one folder. If you do not want to back up some subfolders of the
specified folder, you can exclude these subfolders from the backup. If you want to include or exclude spec ific
files or file types in/from the backup, click Ad vanced. To learn more, see Configuring Filters.
You can include in the backup scope folders and files that reside on an external USB/eSATA or FireWire
drive connected to the Veeam Agent computer.
1. In the The following file system objects section, navigate to the folder that you want to backup in the file
system tree.
2. Select the check box next to each folder that you want to back up.
3. If you want to exclude from backup one or more subfolders of the selected folder, expand the folder and
clear the check box next to the subfolders that you want to exclude.
Configuring Filters
You can specify file name masks for files or file types that you want to include or exclude in/from the backup. To
do this:
o To include specific files into the backup, enter file names and masks in the Include masks field — for
example, MyMovie.avi, *filename*, *.docx, *.mp3. Veeam Agent will create a backup only for
the selected files; no other files will be backed up.
o To exclude specific files from the backup, enter file names and masks in the E x clude masks field — for
example, OldPhotos.rar, *.temp, *.tmp, *.back. Veeam Agent will back up all files except the
files specified in the exclude mask.
3. Click Ad d .
Veeam Agent backup will include all files in the PDF format that do not contain draft in their names.
• Loca l storage — select this option if you want to save the backup on a local computer drive, direct or
network attached storage — for example, a USB flash drive or locally mounted SMB share. With this option
selected, you will pass to the Local Storage step of the wizard.
• Ob ject storage — select this option if you want to create the backup on an object storage repository
exposed to you by third-party vendors. With this option selected, you will pass to the Cloud Type step of
the wizard.
• Network Share — select this option if you want to save the backup to a network shared folder. With this
option selected, you will pass to the Network Share step of the wizard.
• Veeam backup repository — select this option if you want to save the backup on a backup repository
managed by the Veeam backup server. With this option selected, you will pass to the Backup Server step
of the wizard.
• Veeam Cloud Connect repository — select this option if you want to create the backup on a cloud
repository exposed to you by the Veeam Cloud Connect service provider. With this option selected, you
will pass to the Service Provider step of the wizard.
• Local storage settings — if you have selected the Loca l storage option at the Destination step of the
wizard.
• Object storage settings — if you have selected the Ob ject storage option at the Destination step of the
wizard.
• Shared folder settings — if you have selected the Network Share option at the Destination step of the
wizard.
• Veeam backup repository settings — if you have selected the Veeam backup repository option at the
Destination step of the wizard.
• Veeam Cloud Connect repository settings — if you have selected the Veea m Cloud Connect repository
option at the Destination step of the wizard.
NOTE
The Veeam Cloud Connect repository option is available if Veeam Agent operates in the Workstation or
Server edition.
1. In the panel that displays available storage locations, select a location where you want to store the
backup.
2. In the Folder field, specify a path to the folder where backup files must be saved. By default, Veeam
Agent saves files in the VeeamBackup folder.
3. In the Retention policy section, specify the number of restore points for Veeam Agent to store in the
target location. By default, Veeam Agent keeps 7 restore points. To learn more, see Backup Retention
Policy.
4. To specify the GFS retention policy, select the Keep certain full backups longer for archival purposes
check box and press Configure. In the Configure GFS window, specify how weekly, monthly and yearly full
backups must be retained. For details, see Specify GFS Retention Policy.
At the Cloud Type step of the wizard, select the cloud storage. You can select one of the following options:
• S3 Compatible — select this option if you want to create a backup in an S3 compatible storage repository.
With this option selected, you will pass to the Account step of the wizard.
TIP
If you plan to store backups on an IBM or Wasabi cloud storage, use the S3 compatible storage
option.
• Ama zon S3 — select this option if you want to create a backup in an Amazon S3 storage repository. With
this option selected, you will pass to the Account step of the wizard.
• Goog le Cloud Storage — select this option if you want to create a backup in a Google Cloud storage
repository. With this option selected, you will pass to the Account step of the wizard.
S3 Compatible Settings
If you have selected to store backup files on an S3 compatible storage, specify the following settings:
1. Account settings.
2. Bucket settings.
NOTE
You can store backups only in the S3 compatible storage repositories that are accessible over the HTTPs
protocol.
1. In the Service point field, specify the address of your S3 compatible storage.
NOTE
If you want to connect to the repository using the IPv6 address and the port number, you must use
the following format: IPv6:port, where:
2. In the Reg ion field, specify a storage region based on your regulatory and compliance requirements.
a. Click Browse.
b. In the Buck ets window, select the necessary bucket and click OK.
a. Click Browse.
b. In the Folders window, select the necessary folder and click OK.
TIP
3. In the Retention policy section, specify the number of restore points that you want to store in the target
location. By default, Veeam Agent keeps 7 latest restore points. After this number is e xceeded, Veeam
Agent will remove the earliest restore points from the backup chain. To learn more, see Backup Retention
Policy.
4. To specify the GFS retention policy, select the Keep certain full backups longer for archival purposes
check box and press Configure. In the Configure GFS window, specify how weekly, monthly and yearly full
backups must be retained. For details, see Specify GFS Retention Policy.
5. Click Ad vanced to specify additional backup job settings. For details, see Specify Advanced Backup
Settings.
7. After you specified the bucket settings, click Nex t. Veeam Agent will create a new backup repository for
the configured cloud storage.
Amazon S3 Settings
If you have selected to store backup files on an Amazon S3 storage, specify the following settings:
1. Account settings.
2. Bucket settings.
IMP ORTANT
You must create the bucket where you want to store your backup data beforehand. When you create a
bucket, consider Amazon bucket naming rules. For example, it is not recommended that you use dots (.) in
the bucket name. For more information on bucket naming rules, see this AWS documentation article.
1. In the Da ta center window, select the geographic region where Veeam Agent will store backups.
a. Click Browse.
b. In the Buck ets window, select the necessary bucket and click OK.
a. Click Browse.
b. In the Folders window, select the necessary folder and click OK.
TIP
5. To specify the GFS retention policy, select the Keep certain full backups longer for archival purposes
check box and press Configure. In the Configure GFS window, specify how weekly, monthly and yearly full
backups must be retained. For details, see Specify GFS Retention Policy.
6. Click Ad vanced to specify additional backup job settings. For details, see Specify Advanced Backup
Settings.
7. To prohibit modification and deletion of blocks of data from the object storage repository, select the Make
recent backups immutable for check box and specify the immutability period in days. For more
information, see Backup Immutability.
8. After you specified the bucket settings, click Nex t. Veeam Agent will create a new backup repository for
the configured cloud storage.
1. Account settings.
2. Bucket settings.
To connect to the Google Cloud storage, in the Access k ey and Secret key fields, specify the Hash-based
Message Authentication Code (HMAC) key associated with the Google Cloud account. Veeam Agent will use the
HMAC key to authenticate requests to the Google Cloud storage. For more information on Google Cloud
accounts, see the Google Cloud documentation.
1. In the Da ta center window, select the geographic region where Veeam Agent will store backups.
a. Click Browse.
b. In the Buck ets window, select the necessary bucket and click OK.
a. Click Browse.
b. In the Folders window, select the necessary folder and click OK.
TIP
4. In the Retention policy section, specify the number of restore points that you want to store in the target
location. By default, Veeam Agent keeps 7 latest restore points. After this number is exceeded, Veeam
Agent will remove the earliest restore points from the backup chain. To learn more, see Backup Retention
Policy.
5. To specify the GFS retention policy, select the Keep certain full backups longer for archival purposes
check box and press Configure. In the Configure GFS window, specify how weekly, monthly and yearly full
backups must be retained. For details, see Specify GFS Retention Policy.
6. Click Ad vanced to specify additional backup job settings. For details, see Specify Advanced Backup
Settings.
1. Account settings.
2. Container settings.
NOTE
The Allow storage a ccount key access option for Shared Key authorization must be enabled in the storage
account. For more information on how to find this option, see Microsoft Docs.
2. In the Sha red key field, enter the storage account shared key.
a. Click Browse.
b. In the Containers window, select the necessary container and click OK.
a. Click Browse.
b. In the Folders window, select the necessary folder and click OK.
TIP
3. In the Retention policy section, specify the number of restore points that you want to store in the target
location. By default, Veeam Agent keeps 7 latest restore points. After this number is exceeded, Veeam
Agent will remove the earliest restore points from the backup chain. To learn more, see Backup Retention
Policy.
4. To specify the GFS retention policy, select the Keep certain full backups longer for archival purposes
check box and press Configure. In the Configure GFS window, specify how weekly, monthly and yearly full
backups must be retained. For details, see Specify GFS Retention Policy.
5. Click Ad vanced to specify additional backup job settings. For details, see Specify Advanced Backup
Settings.
7. After you specified the bucket settings, click Nex t. Veeam Agent will create a new backup repository for
the configured cloud storage.
1. In the Server field, type an IP address or domain name of the server that hosts the shared folder.
2. In the Folder field, type a name of the network shared folder in which you want to store backup files.
3. If the network shared folder requires authentication, specify credentials to access the network shared
folder:
a. In the Username field, type a name of the account that has access permissions on the shared folder.
b. If necessary, in the Doma in field, type a name of the domain in which the account that has access
permissions on the shared folder is registered.
c. In the P a ssword field, type a password of the account that has access permissions on the shared
folder.
4. In the Retention policy section, specify the number of restore points for Veeam Agent to store in the
target location. By default, Veeam Agent keeps 7 restore points. To learn more, see Backup Retention
Policy.
5. To specify the GFS retention policy, select the Keep certain full backups longer for archival purposes
check box and press Configure. In the Configure GFS window, specify how weekly, monthly and yearly full
backups must be retained. For details, see Specify GFS Retention Policy.
IMP ORTANT
• If you plan to use a commercial version of Veeam Agent with Veeam Backup & Replication, you must
install a license in Veeam Backup & Replication before connecting to the backup server.
• If you change an account to connect to the Veeam backup server and then start a backup job
targeted at the backup repository managed by this backup server, Veeam Agent will start a new
backup chain on the backup repository.
Specify settings for the Veeam backup server that manages the target backup repository:
1. In the Veeam backup server name or IP address field, specify a DNS name or IP address of the Veeam
backup server.
2. In the P ort field, specify the number of the port over which Veeam Agent must communicate with the
backup repository. By default, Veeam Agent for Mac uses port 10006.
3. In the Sp ecify your p ersonal credentials section, enter credentials to access the server:
a. In the Username field, type a name of the account that has access permissions on the Veeam backup
repository.
c. In the P a ssword field, type a password of the account that has access to the Veeam backup repository.
1. From the Ava ilable repositories list, select a backup repository where you want to store backups. The list
of backup repositories displays only those backup repositories on which you have permissions t o store
data. To learn more, see Setting Up User Permissions on Backup Repositories.
2. In the Retention policy section, specify the number of restore points for Veeam Agent to store in the
target location. By default, Veeam Agent keeps 7 restore points. To learn more, see Backup Retention
Policy.
3. To specify the GFS retention policy, select the Keep certain full backups longer for archival purposes
check box and press Configure. In the Configure GFS window, specify how weekly, monthly and yearly full
backups must be retained. For details, see Specify GFS Retention Policy.
NOTE
The Veeam Cloud Connect repository option is available only in the Workstation and Server editions of
Veeam Agent for Mac.
Specify settings for the cloud gateway that the Veeam Cloud Connect service provider (SP) or your backup
administrator has provided to you:
1. In the DNS name or IP address field, enter a full DNS name or IP address of the cloud gateway.
1. In the Username field, enter the name of the tenant or subtenant account that the SP or your backup
administrator has provided to you. The name of the subtenant account must be specified in the
TENANT\SUBTENANT format.
2. In the P a ssword field, provide a password for the tenant or subtenant account.
3. [Optional] To validate the certificate of the SP server with a thumbprint, do the following:
a. In the Thumbprint f or certificate verification field, paste the thumbprint you obtained from the SP.
If the certificate has not been verified on the Veeam Agent computer, after you click Nex t at the Credentials
step of the wizard, you will be asked to verify the certificate.
• View — select this option to view the details of the certificate. After you view the certificate details, select
Accept to verify the certificate.
You can, at any time, view the details of the verified certificate by clicking the active link in the Verified by field
at the Credentials step of the wizard.
1. From the Ava ilable cloud repositories list, select a cloud repository where you want to store created
backups. The Ava ilable cloud repositories list displays only those cloud repositories that can be accessed
by the tenant or subtenant account that you use to connect to the service provider.
2. In the Retention policy section, specify the number of restore points for Veeam Agent to store in the
target location. By default, Veeam Agent keeps 7 restore points. To learn more, see Backup Retention
Policy.
3. To specify the GFS retention policy, select the Keep certain full backups longer for archival purposes
check box and press Configure. In the Configure GFS window, specify how weekly, monthly and yearly full
backups must be retained. For details, see Specify GFS Retention Policy.
1. Select the Keep certain full backups longer for archival purposes option and press Configure at one of the
following steps of the wizard:
o Local Storage — if you have selected the Loca l storage option at the Destination step of the wizard.
o Network Share — if you have selected the Network Share option at the Destination step of the wizard.
o Repository — if you have selected the Veeam backup repository option at the Destination step of the
wizard.
o Repository — if you have selected the Veeam Cloud Connect repository option at the Destination step
of the wizard.
o Bucket — if you have selected the Ob ject storage option at the Destination step of the wizard, then
selected the S3 compatible option at the Cloud Type step of the wizard.
o Bucket — if you have selected the Ob ject storage option at the Destination step of the wizard, then
selected the Ama zon S3 option at the Cloud Type step of the wizard.
o Bucket — if you have selected the Ob ject storage option at the Destination step of the wizard, then
selected the Goog le Cloud Storage option at the Cloud Type step of the wizard.
o Bucket — if you have selected the Ob ject storage option at the Destination step of the wizard, then
selected the Microsoft Azure Blob Storage option at the Cloud Type step of the wizard.
a. If you want to create weekly restore points for archival purposes, select the Keep weekly full backups
for check box. Then specify the GFS retention period in weeks. During this period, the restore points
will be protected from modification and deletion.
In the If multiple full backups exist, use the one from list, select a week day when Veeam Agent must
assign the weekly GFS flag to a full restore point.
b. If you want to create monthly restore points for archival purposes, select the Keep monthly full
b a ckups for check box. Then specify the number of months during which you want to prevent restore
points from being modified and deleted.
In the Use weekly full backup for the following week of a month list, select a week when Veeam
Agent must assign the monthly GFS flag to a full restore point. A week equals 7 calendar days; for
example, the first week of May is days 1–7, and the last week of May is days 25–31.
c. If you want to create yearly restore points for archival purposes, select the Keep y early full backups
for check box. Then specify the number of years during which you want to prevent restore points from
being modified and deleted.
In the Use monthly full backup for the following month list, select a month when Veeam Agent must
assign the yearly GFS flag to a full restore point.
• Backup settings
• Maintenance settings
• Storage settings
Backup Settings
You can use advanced backup settings to schedule a periodic active full backup. For more information on this
backup type, see Active Full Backup
NOTE
Before scheduling a periodic full backup, you must make sure that the tar get location for the scheduled
backup job has enough free space.
3. Use the Monthly on or W eekly on selected days options to define the schedule for active full backup.
• If you selected Veeam backup repository or Veeam Cloud Connect repository as a target for your backups,
the Ma intenance tab will display the setting that allows you to define how long the deleted backup files
will be stored in the repository before they are permanently removed. For details, see Configuring
Removal of Deleted Items Data.
• If you selected Ob ject Storage as a target for your backup, the Ma intenance tab will display the setting
that allows you to schedule a regular backup health check. For details, see Scheduling Health Check.
NOTE
The Ma intenance settings are not available if you have chosen Loca l Storage or Network Share as a backup
target at the Destination step of the wizard.
By default, the retention period for outdated backups is 30 days. Do not set this retention period to 1 day or a
similar short interval. In the opposite case, the backup job may work not as expected and remove data that you
still require.
NOTE
• Health check runs automatically during incremental backup job session on the days specified in the
health check schedule. If the backup job runs several times on a specified day, health check is
performed only with the first run of the backup job on that day.
Health check is not performed during the first full backup or subsequent active full backup jobs.
• If Veeam Agent does not run any backup jobs on the day specified in the health check schedule,
health check will be performed during the first backup job session following that day.
For example, you may have scheduled to run health check every last day of a month, while the
backup job is scheduled to run every day and create an active full backup on Sundays. If the last day
of a month falls on a Sunday, health check will be performed on the following Monday with the first
incremental backup job session on that day.
Storage Settings
To specify storage settings for the backup job:
2. In the Compression level field, select a compression level for the backup: None, Dedupe-friendly , Optimal,
High or Extreme. For more information on compression levels, see Data Compression.
3. In the Storage optimization field, select what type of backup target you plan to use: Local, LAN or WAN.
Depending on the chosen storage type, Veeam Agent will use data blocks of different size to optimize the
size of backup files and job performance. For more information on storage optimization, see Data
Compression.
4. If you want to encrypt the content of backup files, in the E ncryption section, specify encryption settings
for the backup job:
b. In the P a ssword field, type a password that you want to use for encryption.
NOTE
• You cannot specify encryption options for the backup job if you have chosen to save backup files on
a Veeam backup repository. Encryption of Veeam Agent backups stored on the backup repository are
managed per repository by a backup administrator working with Veeam Backup & Replication. To
learn more, see the Data Encryption and Access Permissions sections in the Veeam Backup &
Replication User Guide.
• If you lose a password that was specified for encryption, you can change the password in the
encryption settings. After the backup job creates a new restore point encrypted with the new
password, you will be able to use this password to restore data form all restore points in the backup
chain, including those restore points that were encrypted with an old password.
• If you enable encryption for the existing backup job that has already created one or more restore
points, during the next job session, Veeam Agent will create active full backup. The created full
backup file and subsequent incremental backup files in the backup chain will be encrypted with the
specified password.
• Encryption is not retroactive. If you enable encryption for the existing backup job, Veeam Agent
does not encrypt the previous backup chain created with this job.
1. Select the Run the job automatically check box. If this check box is not selected, you will have to start the
backup job manually to create backup.
3. In the drop-down next to the time field, select one of the available options:
o Everyday — select this option to start the job at the specified time daily.
o On weekdays — select this option to start the job at the specified time on every weekday.
o On these days — select this option to start the job at the specified time on selected days.
When you choose this option, the Da y s field is activated. Click Da y s and select check boxes next to the
necessary days of the week.
1. Select the Run the job automatically check box. If this check box is not selected, you will have to start the
backup job manually to create backup.
o To run the job at specific time daily, on defined week days or with specific periodicity, select Da ily at
this time. Use the fields of this option to configure the necessary schedule.
o To run the job once a month on specific days, select Monthly at this time. Use the fields of this option
to configure the necessary schedule.
o To run the job repeatedly throughout a day with a specific time interval, select P eriodically every. Use
the fields of this option to specify the time interval in hours or minutes.
NOTE
Veeam Agent always starts counting defined intervals from 12:00 AM. For example, if you
configure to run a job with a 4-hour interval, the job will start at 12:00 AM, 4:00 AM, 8:00 AM,
12:00 PM, 4:00 PM and so on.
3. If the backup job runs according to a schedule and fails for any reason, Veeam Agent will automatically
retry the backup job 3 times with an interval of 10 minutes. You can specify the number of attempts to
retry the failed backup job, as well as the period of time between retries. If you do not want to retry the
backup job, clear the Retry failed job check box.
2. To automatically start the job after you close the wizard, make sure that the Run the job when I click
Finish check box is selected.
If you want to start the backup job later, you can clear the Run the job when I click Finish check box. You
will be able to start the backup job manually at any time you need. To learn more, see Starting Backup
Job.
3. Click Finish to complete backup job configuration and exit the wizard .
where:
• <repository_name> — name of the backup repository that should be used as a target location for the
backup job. The backup repository must be created in advance. To learn more, see Creating Backup
Repository
If you want to create Veeam Agent backups in the Veeam backup repository, you should connect to the
Veeam backup server in advance, before configuring the backup job. To learn more, see Connecting to
Veeam Backup Server.
• <objects> — files and directories inclusion/exclusion options. To learn more, see File Inclusion Options.
• <advanced_options> — advanced options for the backup job. To learn more, see Advanced Backup job
Settings.
• <schedule_options> — schedule options for the backup job. To learn more, see Schedule Settings.
• <active_full_backup_options> — active full backup schedule options for the backup job. To learn
more, see Active Full Backup Schedule Settings.
• --nosnap — option that sets Veeam Agent to perform the backup operation in the snapshot-less mode.
For more information on snapshot-less mode, see How Backup Works.
For example:
• You can specify backup schedule for the backup job after you create the backup job. For details, see
Configuring Backup Schedule.
• You can specify active full backup schedule for the backup job after you create the backup job. For
details, see Configuring Active Full Backup Schedule.
• [For object storage repository targets] You can specify a schedule for a backup health check. For
details, see Configuring Health Check Schedule.
To define the backup scope for the backup job, you can use the following command -line options:
--includedirs Full path to a folder that should be included in backup, for example: /home/user.
You can specify one or several paths to directories in the computer file system. To
separate several paths, use the ',' (comma) character, for example:
/home/user/Documents,/home/user/reports.
Note: You cannot use UNIX wildcard characters in the paths to the folders you want to
include.
Tip : If you want to back up the root directory and specify the '/' (slash) character,
Veeam Agent does not automatically include network file system mount points in the
backup scope. To include such mount points, you need to specify paths to these mount
points manually.
For example, you have a network file system mounted to the /home/media directory.
If you add '/' as an object to the backup scope, Veeam Agent will not back up the
mounted network file system. To back up the root directory and the mounted network
file system, add the following objects to the backup scope: /,/home/media.
--ex cludedirs Full path to a folder that should be excluded from backup. The folder specified with
this option must be a subfolder of the folder specified with the --includedirs
option. To separate several paths, use the ',' (comma) character, for example,
/home/user/Documents,/home/user/reports.
Note: You cannot use UNIX wildcard characters in the paths to the folders you want to
exclude.
--includemasks Mask for file name or path that should be included in backup. You can use the
following UNIX wildcard characters for file name masks:
• '*' — a substitution for one or more characters in the file name or path. Can be
used for any sequence of characters (including no characters). For example,
*.pdf.
• '?' — a substitution of one character in the file name or path. For example,
repor?.pdf.
• '[]' — a substitution of one character in the file name or path with any of the
characters enclosed in square brackets (or a range of characters defined with the
'-' character). For example: report_201[3456].pdf or report_201[3-
6].pdf.
Keep in mind that you must specify all names with masks in double quotation marks
(""). For example: --includemasks "*.bak".
If you want to use several file name masks, you must specify them in double quotation
marks ("") and separated with a comma (,). For example: --includemasks
"*.bak,*.pdf".
File inclusion option is applied to all directories that are specified with the --
includedirs option. For example, if you include in backup the
/home/user/Documents folder and files that match the repor?.pdf file name
mask, Veeam Agent will back up the /home/user/Documents/report.pdf file and
will not back up the /home/user/reports/report.pdf file.
--ex cludemasks Mask for file name or path that should be excluded from backup. You can use the
following UNIX wildcard characters for file name masks:
• '*' — a substitution for one or more characters in the file name or path. Can be
used for any sequence of characters (including no characters). For ex ample,
*.pdf.
• '?' — a substitution of one character in the file name or path. For example,
repor?.pdf.
• '[]' — a substitution of one character in the file name or path with any of the
characters enclosed in square brackets (or a range of characters defined with the
'-' character). For example: report_201[3456].pdf or report_201[3-
6].pdf.
Keep in mind that you must specify all names with masks in double quotation marks
(""). For example: --excludemasks "*.bak".
If you want to use several file name masks, you must specify them in double quotation
marks ("") and separated with a comma (,). For example: --excludemasks
*.bak,*.pdf".
File exclusion option is applied to all directories that are specified with the --
includedirs option and files that match file name masks specified with the --
includemasks option. For example, you may want to specify the following backup
scope for the backup job:
• Include in backup the /home/user/Documents folder
• Include files that match the report.* file name mask
• Exclude files that match the *.odt file name mask.
--b locksize Data block size in kilobytes. Possible values are 256, 512, 1024 or 4096.
--ma xpoints The number of restore points that you want to store in the backup location. By
default, Veeam Agent keeps 7 latest restore points. When the new restore point that
exceeds the specified number is created, Veeam Agent will remove the earliest
restore point from the backup chain.
--immutabledays The time period in days during which the backup stored in an object storage
repository will be immutable to modification or deletion. For more information, see
Backup Immutability.
--setencryption Defines that data encryption option is enabled for the job. When you use the
veeamconfig job create command with the --setencryption option, Veeam
Agent will prompt you to specify a password for data encryption and hint for the
password.
--d eleteold The number of days to keep the backup created with the backup job in the target
location. If Veeam Agent does not create new restore points for the backup, the
backup will remain in the target location for the specified number of days. When this
period is over, the backup will be removed from the target location. Possible values
are: 1–999.
If you do not specify the --deleteold option, Veeam Agent will not apply this
setting. As a result, backup will be stored in the target location until you delete it
manually.
--weekdays [For weekly schedules] Specifies the weekdays when the backup job must run. If you
want to run the backup job more than once during the week, the list of weekdays
must be separated by a comma (','). Possible values are:
• Mon — Monday
• Tue — Tuesday
• Wed — Wednesday
• Thu — Thursday
• Fri — Friday
• Sat — Saturday
• Sun — Sunday
--d a ily [For weekly schedules] Defines that the backup job must start daily at specific time.
--thisday [For monthly schedules] Specifies the day of the month when the backup job must
run. Possible values: from 1 to 31 or Last.
--weeknumber [For monthly schedules] Specifies the week of the month when the backup job must
run. Possible values: First, Second, Third, Fourth or Last. This option must be
used in combination with the --monthlyweekday option.
--monthlyweekday [For monthly schedules] Specifies the day of the week when the backup job must run.
You can select only one weekday. Possible values are:
• Mon — Monday
• Tue — Tuesday
• Wed — Wednesday
• Thu — Thursday
• Fri — Friday
• Sat — Saturday
• Sun — Sunday
--months [For monthly schedules] Specifies the months when the backup job must run. If you
specify more than one month, the list must be separated by a comma (,) — for
example: Jan,Apr,Jul,Oct. If you do not specify this option, the backup job will
run every month.
--every [For periodic schedules] Specifies the period of time in minutes or hours between the
runs of the backup job. The period must be specified in the HH: MM format — for
example, 06:00.
--a t [For weekly and monthly schedules] Specifies the time of day in the HH:MM format
when the backup job must start — for example: 20:00.
After the backup job is created, Veeam Agent automatically enables backup schedule. To learn about how to
configure backup schedule for an existing backup job, see Configuring Backup Schedule.
If you use Veeam Agent version 2.0, you can specify schedule options for the backup job to create active full
backups on specific days of the week or month. You can also configure more flexible monthly schedules for
active full backups by using the following options: --weeknumber-full, --monthlyweekday-full and --
months-full.
--weekdays-full [For weekly schedules] Specifies the weekdays when the backup job must create an
active full backup. If you want to create an active full backup more than once during
the week, the list of weekdays must be separated by a comma (','). Possible values
are:
• Mon — Monday
• Tue — Tuesday
• Wed — Wednesday
• Thu — Thursday
• Fri — Friday
• Sat — Saturday
• Sun — Sunday
--thisday-full [For monthly schedules] Specifies the day of the month when the backup job must
create an active full backup. Possible values: from 1 to 31 or Last.
--weeknumber-full [For monthly schedules] Specifies the week of the month when the backup job must
create an active full backup.. Possible values: First, Second, Third, Fourth or
Last. This option must be used in combination with the --monthlyweekday option.
--monthlyweekday- [For monthly schedules] Specifies the day of the week when the backup job must
full create an active full backup. You can select only one weekday. Possible values are:
• Mon — Monday
• Tue — Tuesday
• Wed — Wednesday
• Thu — Thursday
• Fri — Friday
• Sat — Saturday
• Sun — Sunday
--months-full [For monthly schedules] Specifies the months when the backup job must create an
active full backup. If you specify more than one month, the list must be separated by
a comma (,) — for example: Jan,Apr,Jul,Oct. If you do not specify this option, the
backup job will create an active full backup. every month.
After the backup job is created, Veeam Agent automatically enables active full backup schedule using the
specified settings. To learn about how to configure active full backup schedule for an existing ba ckup job, see
Configuring Active Full Backup Schedule.
TIP
You can also specify backup schedule for the backup job when you create the job. For details, see Creating
Standalone Backup Job.
After you define the schedule, Veeam Agent automatically enables this schedule for the specified backup job.
• To run the backup job on specific days of the week, use the following command:
or
where:
o <job_id> — ID of the backup job for which you want to configure the schedule. You should look up
the job ID in advance, before configuring the schedule — for example, with the veeamconfig job
list command. To learn more, see Viewing List of Backup Jobs.
o <job_name> — name of the backup job for which you want to configure the schedule.
o <days> — days when the backup job must start separated by a comma (',') — for example:
Monday,Tuesday,Wednesday,Thursday,Friday or Mon,Tue,Wed,Thu,Fri.
o <time> — time of day when the backup job must start specified in the HH:MM format — for example,
20:00.
For example:
• To run the backup job every day, use the following command:
or
where:
o <job_id> — ID of the backup job for which you want to configure the schedule. You should look up
the job ID in advance, before configuring the schedule — for example, with the veeamconfig job
list command. To learn more, see Viewing List of Backup Jobs.
o <job_name> — name of the backup job for which you want to configure the schedule.
For example:
• To run the backup job monthly on a specific day of the specific week, use the following command:
or
where:
o <job_id> — ID of the backup job for which you want to configure the schedule. You should look up
the job ID in advance, before configuring the schedule — for example, with the veeamconfig job
list command. To learn more, see Viewing List of Backup Jobs.
o <job_name> — name of the backup job for which you want to configure the schedule.
o <day> — day of the week when the backup job must start — for example, Tuesday or Tue.
o <week> — week of the month when the backup job must run. Possible values: First, Second,
Third, Fourth or Last.
o <months> — months when the backup job must run separated by a comma (',') — for example:
Jan,Apr,Jul,Oct. If you do not specify this option, the backup job will run every month.
o <time> — time of day when the backup job must start specified in the HH:MM format, — for example,
20:00.
For example:
• To run the backup job monthly on a specific day of the month, use the following command:
where:
o <job_id> — ID of the backup job for which you want to configure the schedule. You should look up
the job ID in advance, before configuring the schedule — for example, with the veeamconfig job
list command. To learn more, see Viewing List of Backup Jobs.
o <job_name> — name of the backup job for which you want to configure the schedule.
o <day> — day of the month when the backup job must start. Possible values range from 1 to 31 or
Last.
o <months> — months when the backup job must run separated by a comma (',') — for example:
Jan,Apr,Jul,Oct. If you do not specify this option, the backup job will run every month.
o <time> — time of day when the backup job must start specified in the HH:MM format, — for example,
20:00.
For example:
or
where:
• <job_id> — ID of the backup job for which you want to configure the schedule. You should look up the
job ID in advance, before configuring the schedule — for example, with the veeamconfig job list
command. To learn more, see Viewing List of Backup Jobs.
• <job_name> — name of the backup job for which you want to configure the schedule.
• <time> — period of time when the backup job must start specified in the HH:MM format, — for example,
06:00.
To view the schedule defined for the backup job, use the following command:
or
where:
• <job_id> — ID of the backup job for which you want to view the schedule.
• <job_name> — name of the backup job for which you want to view the schedule.
Veeam Agent will display the details and the status (enabled or disabled) of the job schedule — for example:
or
or
• <job_id> — ID of the backup job for which you want to disable the schedule.
• <job_name> — name of the backup job for which you want to disable the schedule.
For example:
or
where:
• <job_id> — ID of the backup job for which you want to enable the schedule. You should look up the job
ID in advance, for example, with the veeamconfig job list command. To learn more, see Viewing List of
Backup Jobs.
• <job_name> — name of the backup job for which you want to enable the schedule.
For example:
You can disable the schedule for the job at any time. To learn more, see Disabling Backup Schedule.
veeamconfig gfs set --jobid <job_id> weekly --on <weekday> --keep <weeks>
or
veeamconfig gfs set --jobname <job_name> weekly --on <weekday> --keep <weeks>
where:
• <job_id> — ID of the backup job for which you want to configure the long -term retention policy. You
should look up the job ID in advance, before configuring the schedule, for example, with the
veeamconfig job list command. To learn more, see Viewing List of Backup Jobs.
• <job_name> — name of the backup job for which you want to configure the long -term retention policy.
• <weekday> — week day when Veeam Agent must assign a weekly GFS flag to a full restore point — for
example, Tue or Tuesday.
• <weeks> — number of weeks to keep the weekly GFS flag on the full restore point.
For example:
veeamconfig gfs set --jobid <job_id> monthly --on <week_number> --keep <months>
or
veeamconfig gfs set --jobname <job_name> monthly --on <week_number> --keep <mon
ths>
• <job_id> — ID of the backup job for which you want to configure the long -term retention policy. You
should look up the job ID in advance, before configuring the schedule, for example, with the
veeamconfig job list command. To learn more, see Viewing List of Backup Jobs.
• <job_name> — name of the backup job for which you want to configure the long -term retention policy.
• <week_number> — number of the week when Veeam Agent must assign a monthly GFS flag to a full
restore point. Possible values: First, Second, Third, Fourth or Last.
• <months> — number of months to keep the monthly GFS flag on the full restore point.
For example:
veeamconfig gfs set --jobid <job_id> yearly --on <month> --keep <years>
or
veeamconfig gfs set --jobname <job_name> yearly --on <month> --keep <years>
where:
• <job_id> — ID of the backup job for which you want to configure the long -term retention policy. You
should look up the job ID in advance, before configuring the schedule, for example, with the
veeamconfig job list command. To learn more, see Viewing List of Backup Jobs.
• <job_name> — name of the backup job for which you want to configure the long -term retention policy.
• <month> — month when Veeam Agent must assign a yearly GFS flag to a full restore point — for example,
Jan or January.
• <years> — number of years to keep the yearly GFS flag on the full restore point.
For example:
or
where:
• <job_id> — ID of the backup job for which you want to enable the long -term retention policy. You
should look up the job ID in advance, for example, with the veeamconfig job list command. To
learn more, see Viewing List of Backup Jobs.
• <job_name> — name of the backup job for which you want to enable the long -term retention policy.
• <period> — type of the long-term retention policy. Possible values: weekly, monthly or yearly.
This parameter is optional. You can use it to enable a specific type of long-term retention policy. To
enable several types of retention at once, specify all necessary retention types separated by a comma (' ,')
— for example: weekly,monthly.
For example:
You can disable the long-term retention policy for the job at any time. To learn more, see Disabling Long-Term
Retention Policy.
or
where:
• <job_id> — ID of the backup job for which you want to view the long-term retention policy.
• <job_name> — name of the backup job for which you want to view the long-term retention policy.
P a rameter Description
• GFS is enabled
• GFS is disabled
• GFS is not set
Desired time Weekday, week number or month when Veeam Agent will set the GFS flag on the full
restore point.
Keep for Period of time for retaining the GFS flag on the full restore point.
The information listed in the table above is displayed for weekly, monthly and yearly retention policies.
For example:
where:
• <job_id> — ID of the backup job for which you want to disable the long -term retention policy.
• <job_name> — name of the backup job for which you want to disable the long -term retention policy.
For example:
or
where:
• <job_id> — ID of the backup job for which you want to disable the long -term retention policy.
• <job_name> — name of the backup job for which you want to disable the long -term retention policy.
• <period> — single type of the long-term retention policy you want to disable. Possible values: weekly,
monthly or yearly.
For example:
TIP
You can also specify active full backup schedule for the backup job when you create the job. For details,
see Backup Settings.
or
where:
• <job_id> — ID of the backup job for which you want to configure the active full backup schedule. You
should look up the job ID in advance, before configuring the schedule, for example, with the
veeamconfig job list command. To learn more, see Viewing List of Backup Policies.
• <job_name> — name of the backup job for which you want to configure the active full backup schedule.
• <day> — number of the day of the month when Veeam Agent must perform active full backup.
For example:
where:
• <job_id> — ID of the backup job for which you want to configure the active full backup schedule. You
should look up the job ID in advance, before configuring the schedule, for example, with the
veeamconfig job list command. To learn more, see Viewing List of Backup Policies.
• <job_name> — name of the backup job for which you want to configure the active full backup schedule.
• <days> — days when the backup job must create an active full backup separated by a comma (','). For
example: Monday,Friday. The backup job will create an active full backup on the specified days at the
time specified in the backup job schedule settings.
For example:
or
where:
• <job_id> — ID of the backup job for which you want to enable the active full backup schedule. You
should look up the job ID in advance, for example, with the veeamconfig job list command. To learn
more, see Viewing List of Backup Policies.
• <job_name> — name of the backup job for which you want to enable the active full backup schedule.
For example:
You can disable the schedule for the backup job at any time. To learn more, see Disabling Backup Schedule.
or
where:
• <job_id> — ID of the backup job for which you want to view the active full backup schedule.
• <job_name> — name of the backup job for which you want to view the active full backup schedule.
Veeam Agent for Mac displays the following information about the active full backup schedule:
P a rameter Description
E very <value> Days on which the backup job creates active full backups. For example: Every Monday
or Every 1 day of every month.
Run a utomatically State of the active full backup schedule. Possible values:
• Enabled
• Disabled
For example:
or
where:
• <job_id> — ID of the backup job for which you want to disable the active full backup schedule.
For example:
You can perform the following actions with backup health check schedule in command line interface:
or
where:
• <job_id> — ID of the backup job for which you want to configure health check schedule. You should look
up the backup job ID before you configure the schedule — for example, with the veeamconfig job
list command. To learn more, see Viewing List of Backup Jobs.
• <job_name> — name of the backup job for which you want to configure the health check schedule.
If the name of the job consists of several words and contains spaces, use quote marks around the
name — for example, --jobName "Files Backup".
• <day> — day of the week when the backup job must perform health check — for example, Tuesday or
Tue.
• <week> — week of the month when the backup job must perform health check. Possible values: First,
Second, Third, Fourth or Last.
• <months> — months when the backup job must perform health check, separated by a comma (',') — for
example: Jan,Apr,Jul,Oct. If you do not specify this option, the health check will run every month.
For example:
or
where:
• <job_id> — ID of the backup job for which you want to configure health check schedule. You should look
up the backup job ID before you configure the schedule — for example, with the veeamconfig job
list command. To learn more, see Viewing List of Backup Jobs.
• <job_name> — name of the backup job for which you want to configure the health check schedule.
TIP
If the name of the job consists of several words and contains spaces, use quote marks around the
name — for example, --jobName "Files Backup".
• <days> — comma-separated list of days when the backup job must run backup health check. For example:
Mon,Fri. The backup job will run the health check on the specified days at the time specified in the
backup job schedule settings.
For example:
or
where:
• <job_id> — ID of the backup job for which you want to configure health check schedule. You should look
up the backup job ID before you run the command to enable the schedule — for example, with the
veeamconfig job list command. To learn more, see Viewing List of Backup Jobs.
• <job_name> — name of the backup job for which you want to configure the health check schedule.
TIP
If the name of the job consists of several words and contains spaces, use quote marks around the
name — for example, --jobName "Files Backup".
For example:
You can disable health check schedule for a job at any time. To learn more, see Disabling Health Check Schedule.
or
where:
• <job_id> — ID of the backup job for which you want to configure health check schedule. You should look
up the backup job ID before you run the command to view the schedule — for example, with the
veeamconfig job list command. To learn more, see Viewing List of Backup Jobs.
• <job_name> — name of the backup job for which you want to configure the health check schedule.
If the name of the job consists of several words and contains spaces, use quote marks around the
name — for example, --jobName "Files Backup".
Veeam Agent for Mac displays the following information about the health check schedule:
P a rameter Description
E very <value> Days on which the backup job runs the health check — for example, Every last Fri of
every month.
Run health-check State of the backup health check schedule. Possible values:
a utomatically
• Enabled
• Disabled
For example:
or
where:
• <job_id> — ID of the backup job for which you want to configure health check schedule. You should look
up the backup job ID before you run the command to disable the schedule — for example, with the
veeamconfig job list command. To learn more, see Viewing List of Backup Jobs.
• <job_name> — name of the backup job for which you want to configure the health check schedule.
TIP
If the name of the job consists of several words and contains spaces, use quote marks around the
name — for example, --jobName "Files Backup".
You can also start a backup job to create an ad-hoc full backup — active full backup, and add it to the backup
chain on the target storage. The active full backup resets the backup chain. All subsequent incremental backups
use the active full backup as a starting point. The previously used full backup will remain on the t arget storage
until it is removed from the backup chain according to the retention policy.
You can stop a running backup job before the job session completes — for example, if the backup process is
about to take long, and you do not want the job to produce workload on the production environment during
business hours. When you stop a backup job, the job session will finish immediately. Veeam Agent will not
produce a new restore point during the session, and the session will finish with the Failed status.
You can start and stop backup jobs in one of the following ways:
• [Any number of jobs] In the main pane of the control panel, press the Ba ckup Now button under the name
of the job in focus.
TIP
If there are more than one backup jobs, select the job you want to start in the left-hand Ba ckup Jobs
pane to set the job in focus and display its details in the main pane of the control panel. If you have
only one backup job, this job is displayed in the main pane of the control panel by default.
• [Single job] From the Veeam Agent status bar menu, select the Sta rt Backup Job option.
Veeam Agent will immediately start the backup job. You can monitor the progress of the backup job session and
view the session log in real time. To do this, select a session and click the View Log button in the bottom-right
corner of the Veeam Agent control panel. For details, see Reporting with Veeam Agent Control Panel..
If you start the backup job while another backup job is running, Veeam Agent will perform the backup job
immediately after the current job is completed. For details, see Job Queue.
To cancel the backup job that is in the Pending status, do either of the following:
• In the main pane of the control panel, press the Remove from queue button under the name of the job in
focus.
NOTE
• Job queue can contain up to 3 backup jobs besides the job that is already running.
• You cannot submit the same backup job to the queue if it is already running.
• [Multiple jobs] In the Ba ckup Jobs pane of the control panel, right-click the job that you want to run as an
active full backup and select Active Full.
If you start an active full backup job while another backup job is running, Veeam Agent will perform the active
full backup immediately after the current job is completed. For details, see Job Queue.
• In the main pane of the control panel, press the Stop Job button under the name of the job in focus.
• In the Ba ckup Jobs pane of the control panel, right-click the job that you want to stop and select Stop
Job .
or
where:
TIP
You can use the veeamconfig job start command with the --activefull option to create active
full backups. To learn more, see Creating Active Full Backups.
For example:
Veeam Agent will immediately start the backup job. You can check the backup job session status or view the
backup job session log using the Veeam Agent command line interface.
If you start the backup job while another backup job is running, Veeam Agent will perform the backup job
immediately after the current job is completed. For details, see Job Queue.
The queued backup job creates a new session with the Pending status. You can view all jobs in the queue by
running the veeamconfig session list command.
NOTE
• Job queue can contain up to 3 backup jobs besides the job that is already running.
• You cannot submit the same backup job to the queue if it is already running.
or
where:
• <job_name> — name of the backup job that you want to start to create an active full backup.
• <job_id> — ID of the backup job that you want to start to create an active full backup.
You can view the progress for the active full backup session in the s ame way as for any other backup job session.
In particular, you can check the backup job session status or view the backup job session log using the Veeam
Agent command line interface.
If you start an active full backup job while another backup job is running, Veeam Agent will perform the active
full backup immediately after the current job is completed. For details, see Job Queue.
or
where:
• <session_id> — ID of the currently running backup job session that you want to stop.
• --force — with this option enabled, Veeam Agent will immediately stop the backup session even if it is
unable to stop the veeamjobman process for some reason.
For example:
TIP
You can use the veeamconfig session stop command to remove a backup job with the Pending status
from the job queue.
The backup jobs are sorted by the date and time of job creation: the more recently created jobs are displayed at
the top of the list. Select a backup job to view the list of sessions for this backup job.
• In the Veeam Agent for Mac application menu, select Ba ckup > E d it Backup Job > < Job Name>, where Job
Na me is the name of the job you want to edit.
Veeam Agent will launch the Backup Job wizard. For details on backup job settings, see Creating Backup Job
with Backup Job Wizard.
The disabling option is applicable to backup job sessions started upon schedule. You can create standalone full
backups and perform ad-hoc incremental backup even if the scheduled backups are disabled.
The disabling option is applicable to all backup jobs configured in Veea m Agent for Mac. If you enable this
option, all jobs that you configured will not start automatically upon the defined schedule. If you want to
prevent a specific job from starting automatically, disable scheduling options in the properties of this job.
If you configured a backup job that is set up to create database log backups, after you disable scheduled
backups, the database log backup job will be disabled, too.
The disabling option does not put on hold the backup cache synchronization process. If Veeam Agent has
created one or more backup files in the backup cache, and then the backup target becomes available, Veeam
Agent will immediately upload backup files to the target location.
1. From the Veeam Agent for Mac application menu, select Settings.
1. From the Veeam Agent for Mac application menu, select Settings.
• In the Veeam Agent for Mac application menu, select Ba ckup > Delete Backup Job > < Job Name>, where
Job Name is the name of the job you want to edit.
• In the Ba ckup Jobs pane of the Veeam Agent control panel, right-click the backup job you want to edit and
select the Delete Job option from the context menu.
In the list of backup jobs, Veeam Agent displays the following information:
P a rameter Description
Rep ository Name of the backup repository that is specified as a backup storage for the backup job.
For example:
where:
• <job_name> — name of the backup job for which you want to view settings.
• <job_id> — ID of the backup job for which you want to view settings.
Veeam Agent for Mac displays the following information about the backup job:
P a rameter Description
Rep ository ID ID of the backup repository that is specified as a backup storage for the backup job.
Rep ository name Name of the backup repository that is specified as a backup storage for the backup job.
• 0 — No compression
• 1 — Rle
• 2 — Lz4
• 3 — ZlibLow
• 4 — ZlibHigh
Ma x Points Number of restore points to keep on disk. By default, Veeam Agent for Mac keeps 7
latest restore points. When the new restore point that exceeds the specified number is
created, Veeam Agent for Mac will remove the earliest restore point from the backup
chain.
Block size Size of data blocks that Veeam Agent uses to process data.
Ob jects for backup Backup scope specified for the backup job.
or
where:
• <option> — option that you want to edit for the job. You can specify one or several options at a time. To
learn more, see Backup Job Options.
For example:
--b locksize Data block size in kilobytes. Possible values are 256, 512, 1024, 4096 or 8192.
--immutabledays The time period in days during which the backup stored in an object storage repository
will be immutable to modification or deletion. For more information, see Backup
Immutability.
--ma xpoints Number of restore points that you want to store in the backup location. By default,
Veeam Agent keeps 7 latest restore points. When the new restore point that exceeds
the specified number is created, Veeam Agent will remove the earliest restore point
from the backup chain.
--includedirs Full path to a folder that should be included in backup, for example: /home/user.
You can specify one or several paths to directories in the computer file system. To
separate several paths, use a ',' (comma) character, for example:
/home/user/Documents,/home/user/reports.
--ex cludedirs Full path to a folder that should be excluded from backup.
The folder specified with this option must be a subfolder of the folder specified with
the --includedirs option. To separate several paths, use a ',' (comma) character,
for example, /home/user/Documents,/home/user/reports.
--includemasks Mask for file name or path that should be included in backup.
You can use the following UNIX wildcard characters for file name masks:
• '*' — a substitution for one or more characters in the file name or path. Can be
used for any sequence of characters (including no characters). For example,
*.pdf.
• '?' — a substitution of one character in the file name or path. For example,
repor?.pdf.
• '[]' — a substitution of one character in the file name or path with any of the
characters enclosed in square brackets (or a range of characters defined with the
'-' character). For example: report_201[3456].pdf or report_201[3-
6].pdf.
File inclusion option is applied to all directories that are specified with the --
includedirs option. For example, if you include in backup the
/home/user/Documents folder and files that match the repor?.pdf file name
mask, Veeam Agent will back up the /home/user/Documents/report.pdf file and
will not back up the /home/user/reports/report.pdf file.
--ex cludemasks Mask for file name or path that should be excluded from backup.
You can use the following UNIX wildcard characters for file name masks:
• '*' — a substitution for one or more characters in the file name or path. Can be
used for any sequence of characters (including no characters). For example,
*.pdf.
• '?' — a substitution of one character in the file name or path. For example,
repor?.pdf.
• '[]' — a substitution of one character in the file name or path with any of the
characters enclosed in square brackets (or a range of characters defined with the
'-' character). For example: report_201[3456].pdf or report_201[3-
6].pdf.
File exclusion option is applied to all directories that are specified with the --
includedirs option and files that match file name masks specified with the --
includemasks option. For example, you may want to specify the following backup
scope for the backup job:
• Include in backup the /home/user/Documents folder
• Include files that match the report.* file name mask
• Exclude files that match the *.odt file name mask.
If you want to use several name masks, you must specify them in double quotation
marks, for example: veeamconfig job create filelevel --name
BackupJob1 --reponame vault13 --includedirs /home --includemasks
"*.bak,*.pdf".
--setencryption Defines that data encryption option is enabled for the job. You can use this option to
enable encryption for the existing backup job or change a password used for
encryption for the backup job. When you use the veeamconfig job edit command
with the --setencryption option, Veeam Agent for Mac will prompt you to specify
a password for data encryption and hint for the password.
--resetencryption Defines that data encryption option is disabled for the job. You can use this option to
disable encryption for the existing backup job.
--d eleteold The number of days to keep the backup created with the backup job in the target
location. If Veeam Agent does not create new restore points for the backup, the
backup will remain in the target location for the specified number of days. When this
period is over, the backup will be removed from the target location. Possible values
are: 1–999.
If the --deleteold option is not specified, Veeam Agent does not apply this setting.
As a result, backup will be stored in the target location until you delete it manually.
If you specified the value earlier and want to disable this setting, specify the false
value for the option: --deleteold false. After the next successful backup session,
this setting will be disabled for the backup in the target location.
NOTE
• If you change the target location for the backup job, during the next backup job session Veeam
Agent for Mac will perform full data backup. All subsequent backup sessions will produce
incremental backups — Veeam Agent for Mac will copy only changed data to the target location and
add a new incremental backup file to the backup chain.
• If you change the backup scope for the backup job, during the next backup job session Veeam Agent
for Mac will create a new incremental backup. The backup will contain all data blocks pertaining to
new data added to the backup scope and changed data blocks pertaining to original data in the
backup scope (data that was processed by the job at the time before you changed the backup
scope).
• Full backup takes much more time than incremental backup. If you change the target location, you
can copy an existing backup chain to the new location manually. In this case, the new backup job
session will produce an incremental backup file and add it to the backup chain.
or
where:
You can edit the repository properties in the settings of the backup job. For details, see Specify Backup Storage
Settings.
IMP ORTANT
A backup repository must be created on a separate volume from a volume whose data you plan to back up.
If you target a backup job at a Veeam backup repository or Veeam Cloud Connect repository, you do not need to
create repositories. Before configuring the backup job, you must connect to the Veeam backup server or Veeam
Cloud Connect service provider. To learn more, see Connecting to Veeam Backup Server and Connecting to
Service Provider.
where:
For example:
where:
• <path_to_repository> — path to the network shared folder where backup files will be stored in the
//SERVER/FOLDER format.
IMP ORTANT
If the directory to which the shared folder should be mounted resides on the backed-up volume, the
backup job may fail.
• <user_name> — account name that Veeam Agent will use to access the SMB network shared folder.
• <domain> — domain in which the account that has access permissions on the shared folder is registered.
Mind that if you specify --password parameter, Veeam Agent will prompt you to specify a password for the
SMB network shared folder.
Examples
Command with --username, --password, --domain parameters:
TIP
• If you mount a network shared folder to a folder in the Veeam Agent machine file system in advance,
you can create the backup repository in the same way as in a local folder. For details, see Creating
Repository in Local Folder.
• macOS may save CIFS/SMB credentials in a cache. As a result, if credentials have been changed,
Veeam Agent for Mac uses obsolete credentials and fails to connect to shared folders. To refresh
cached credentials, reboot the Veeam Agent computer.
• [Microsoft Azure Blob storage] The soft delete feature for blobs and containers must be disabled in the
storage account.
• [Microsoft Azure Blob storage] To use the Veeam backup immutability feature, you must enable blob
versioning and version-level immutability support in the storage account. For more information, see this
Microsoft Azure documentation.
• [S3 Compatible and Amazon S3 storage] To use the Veeam backup immutability feature, you must enable
versioning and the S3 Object Lock feature in the storage account. For more information, see this Amazon
S3 documentation.
• [Google Cloud storage] The Veeam backup immutability feature is not supported for repositories
configured in Google Cloud storage.
where:
• <provider_type> — name of the object storage provider. Veeam Agent supports the following options:
o s3compatible — for creating an S3 Compatible repository (including Wasabi Cloud and IBM Cloud
repositories).
• <options> — options necessary to connect to the target object storage. For more information, see the
following subsections:
After Veeam Agent creates a new backup repository in the object storage location, you can specify object
storage as a destination for the backup job.
where:
NOTE
If you want to connect to the repository using the IPv6 address and the port number, you must use
the following format: IPv6:port, where:
NOTE
You can find the list of supported regions in the documentation of the selected storage provider.
If Veeam Agent does not find a folder with the name specified in the command, Veeam Agent will create a
new folder in the bucket under Veeam/Backup/ — for example, Veeam/Backup/folder01.
For example:
After you use the command, Veeam Agent will prompt you to specify a s ecret key associated with the object
storage account. Enter the secret key to complete the creation of the repository.
where:
NOTE
You can find the full list of supported regions by storage provider in the
PublicCloudRegions.xml file located in the /Library/Application Support/Veeam folder
on Veeam Agent computer.
IMP ORTANT
You must create the bucket where you want to store your backup data beforehand. When you create
a bucket, consider Amazon bucket naming rules. For example, it is not recommended that you use
dots (.) in the bucket name. For more information on bucket naming rules, see this AWS
documentation article.
If Veeam Agent does not find a folder with the name specified in the command, Veeam Agent will create a
new folder in the bucket under Veeam/Backup/ — for example, Veeam/Backup/folder01.
For example:
After you use the command, Veeam Agent will prompt you to specify a secret key associated with the Amazon
S3 storage account. Enter the secret key to complete the creation of the repository.
• <id> — access key associated with the Google Cloud storage account.
NOTE
You can find the full list of supported regions by storage provider in the
PublicCloudRegions.xml file located in the /Library/Application Support/Veeam folder
on Veeam Agent computer.
If Veeam Agent does not find a folder with the name specified in the command, Veeam Agent will create a
new folder in the bucket under Veeam/Backup/ — for example, Veeam/Backup/folder01.
For example:
After you use the command, Veeam Agent will prompt you to specify a secret key associated with the Google
Cloud storage account. Enter the secret key to complete the creation of the repository.
• <repository_name> — name of the backup repository for the Veeam Agent database.
Veeam Agent supports specification of 3 generic Microsoft Azure Blob storage locations:
• Azure Global (Standard) — can be used for any data center region, except the regions in China
and the regions intended for US governments. To specify this region in the command to create
the repository, use the following value: AzureCloud.
• Asia China — can be used for any region in China. To specify this region in the command to
create the repository, use the following value: AzureChinaCloud.
• Azure Government — can be used for Azure Government regions only. To specify this region in
the command to create the repository, use the following value: AzureGovernmentCloud.
You can find the full list of supported regions by storage provider in the
PublicCloudRegions.xml file located in the /Library/Application Support/Veeam folder
on Veeam Agent computer.
If Veeam Agent does not find a folder with the name specified in the command, Veeam Agent creates a
new folder in the container under Veeam/Backup/ — for example, Veeam/Backup/folder01.
For example:
After you use the command, Veeam Agent will prompt you to specify the shared key associated w ith the object
storage account. Enter the shared key to complete the creation of the repository.
P a rameter Description
Loca tion Location of the backup repository. Depending on the repository type, this column can
contain one of the following:
• true
• false
Ba ckup server Backup server on which Veeam backup repository added to Veeam Agent is configured.
For example:
You can edit properties of the following repository types only in the backup job settings in the Veeam Agent
control panel:
NOTE
• If you change location for the backup repository that is already used by a backup job and contains
backup files, during the next backup job run, Veeam Agent will create a new backup chain in the new
repository location.
• You can temporarily change backup repository location if you want to create an ad hoc full backup in
addition to the backup chain created by the backup job in the original repository location.
or
where:
For example:
or
For example:
or
where:
For example:
NOTE
When you use the veeamconfig respotiry rescan command with the --all option, consider the
following:
• Rescanning can take significant amount of time if there are multiple repositories configured in
Veeam Agent.
• Rescanning multiple object storage repositories may result in greater storage costs due to additional
volume of data transactions.
or
where:
For example:
NOTE
You cannot delete a backup repository that is specified as a backup storage location in the backup job
settings.
IMP ORTANT
Veeam Agent for Mac can be connected to one Veeam Backup & Replication server only. If you want to
create backups on the backup repository managed by another Veeam backup server, you need to delete
currently used backup server and all jobs targeted at back up repositories managed by this backup server.
To learn more, see Deleting Connection to Veeam Backup Server.
If you add a connection to another backup server, backup jobs targeted at the original backup server will
fail, and backups created on the Veeam backup repository will become unavailable in Veeam Agent. To
continue using the original backup server, you need to delete the connection to the new backup server and
re-create all backup jobs that used the original backup server.
If you change an account to connect to the Veeam backup server and then start a backup job targeted at
the backup repository managed by this backup server, Veeam Agent will start a new backup chain on the
backup repository.
To connect Veeam Agent for Mac to a Veeam backup server, use the following command:
where:
• <vbr_name> — name of the Veeam backup server that manages the backup repository.
• <vbr_port> — port over which Veeam Agent must communicate with Veeam Backup & Replication. The
default port used for communication with the Veeam backup server is 10006.
• <username> — a name of the account that has access to the Veeam backup repository.
• <domain> — a name of the domain in which the account that has access to the Veeam backup repository is
registered.
• <password> — password of the account that has access to the Veeam backup repository.
Permissions on the backup repository managed by the target Veeam backup server must be granted
beforehand. To learn more, see Setting Up User Permissions on Backup Repositories.
For example:
When Veeam Agent for Mac connects to a Veeam Backup & Replication server, Veeam Agent retrieves
information about backup repositories managed by this Veeam backup server and displays them in the list of
available backup repositories. You can then specify a Veeam backup repository as a target for a backup job.
To view the list of backup repositories, use the veeamconfig repository list command. To learn
more, see Viewing List of Backup Repositories.
For the Veeam backup server in the list, Veeam Agent for Mac displays the following information:
P a rameter Description
E nd point IP address of the Veeam backup server and port over which Veeam Agent for Mac
communicates with Veeam Backup & Replication.
For example:
or
where:
Veeam Agent for Mac displays the following information about the Veeam backup server:
P a rameter Description
E nd point IP address of the Veeam backup server and port over which Veeam Agent for Mac
communicates with Veeam Backup & Replication.
Log in Name of the account that has access to the Veeam backup repository.
Doma in Name of the domain in which the account that has access to the Veeam backup
repository is registered.
For example:
where:
For example:
where:
• <vbr_port> — port over which Veeam Agent for Mac must communicate with Veeam Backup &
Replication.
For example:
If you change an account to connect to the Veeam backup server and then start a backup job targeted at
the backup repository managed by this backup server, Veeam Agent will start a new backup chain on the
backup repository.
To change an account whose credentials will be used to connect to the Veeam backup server, use the following
command:
where:
• <username> — name of the account that has access to the Veeam backup repository.
• <domain> — name of the domain in which the account that has access to the Veeam backup repository is
registered.
• <password> — password of the account that has access to the Veeam backup repository.
For example:
To update the list of backup repositories managed by the Veeam backup server, use the following command:
TIP
To view updated list of available Veeam backup repositories after resync, use the veeamconfig
repository list command. To learn more, see Viewing List of Backup Repositories.
You cannot delete a connection to the Veeam backup server in the following situations:
• Veeam Agent operates in the managed mode. To delete connection to the Veeam backup server, reset
Veeam Agent to the standalone mode. For details, see Resetting to Standalone Operation Mode.
• Veeam Agent has a backup job that saves backup files to a repository managed by this backup server. To
remove such connection to the Veeam backup server, you first need to delete reference to the Veeam
backup repository in the job settings.
To delete a connection to the Veeam backup server, use the following command:
or
where:
For example:
To connect Veeam Agent for Mac to a service provider, use the following command:
where:
• <sp_address> — IP address or full DNS name of the cloud gateway that the SP or your backup
administrator has provided to you.
• <sp_port> — port over which Veeam Agent must communicate with the cloud gateway. The default port
used for communication with the cloud gateway is 6180.
• <username> — name of the tenant or subtenant account that the SP or your backup administrator has
provided to you. The name of the subtenant account must be specified in the TENANT/SUBTENANT
format.
• <password> — password of the tenant or subtenant account used to connect to the service provider.
• <sp_thumbprint> — thumbprint used to verify the TLS certificate that the SP has provided to you.
For example:
NOTE
When you enter the veeamconfig cloud add command, Veeam Agent will display information about
the TLS certificate obtained from the SP. To accept the certificate, type yes in the command prompt and
press E nter.
When Veeam Agent connects to the service provider, Veeam Agent retrieves information about cloud
repositories available to the tenant or subtenant and displays them in the list of available backup repositories.
You can then specify a cloud repository as a target for a backup job.
TIP
To view the list of available cloud repositories, use the veeamconfig repository list command. To
learn more, see Viewing List of Backup Repositories.
For the service provider in the list, Veeam Agent for Mac displays the following information:
P a rameter Description
Ad d ress IP address of the cloud gateway and port over which Veeam Agent communicates with
the cloud gateway.
Ga te servers IP address of the cloud gateway and port over which Veeam Agent communicates with
the cloud gateway.
Username Name of the tenant or subtenant account used for connection to the service provider.
For example:
Changing SP Name
To change a name for the SP, use the following command:
or
where:
For example:
veeamconfig cloud edit --address <sp_address> --port <sp_port> for --name <sp_n
ame>
or
veeamconfig cloud edit --address <sp_address> --port <sp_port> for --id <sp_id>
• <sp_address> — IP address or full DNS name of the cloud gateway that the SP or your backup
administrator has provided to you.
• <sp_port> — port over which Veeam Agent must communicate with the cloud gateway. The default port
used for communication with the cloud gateway is 6180.
For example:
user@wrk01:~$ veeamconfig cloud edit --address 172.17.53.67 --port 6180 for --n
ame SP
veeamconfig cloud edit --login <username> --password <password> for --name <sp_
name>
or
veeamconfig cloud edit --login <username> --password <password> for --id <sp_id
>
where:
• <username> — name of the tenant or subtenant account that the SP or your backup administrator has
provided to you. The name of the subtenant account must be specified in the TENANT/SUBTENANT
format.
• <password> — password of the tenant or subtenant account used to connect to the service provider.
For example:
or
where:
• <sp_thumbprint> — thumbprint used to verify the TLS certificate and connect to the service provider.
For example:
If the cloud repository currently used as a target location for Veeam Agent backups becomes unavailable, and
Veeam Agent fails to reflect this change in its database for some reason, the veeamconfig cloud resync
command may finish with errors. In this case, you can use the --force option to refresh information about
available cloud repositories. For example:
With the --force option, Veeam Agent will retrieve the list of available cloud repositories from the service
provider and save the new information about cloud repositories in the Veeam Agent database.
TIP
To view updated list of available cloud repositories after resync, use the veeamconfig cloud list
command. To learn more, see Viewing List of Service Providers.
You cannot delete a connection to the service provider if a cloud repository managed by this service provider is
used by a backup job. To remove such connection to a service provider, you first need to delete a reference to
the cloud repository in the job settings.
or
where:
For example:
If for some reason, Veeam Agent does not have access to the backup file from which you want to restore data,
you can import the backup file to your computer.
Veeam Agent also allows you to view the list of available backups and restore points within those backups, as
well as browse backup content and delete backups. For details, see Managing Backups.
• The backup file was created by a Veeam Agent installed on another computer.
• Due to a disaster, the Veeam Agent and Veeam Agent database on your computer have been removed, and
the database of the re-installed Veeam Agent does not contain information on the previously created
backup file.
Veeam Agent lets you to import backup files in the following ways:
• In the Veeam Agent for Mac application menu, select Ba ckup > Import Backup.
• In the Veeam Agent for Mac status bar menu, select Imp ort > Ba ckup.
• Ind ividual files (default) — allows you to browse the backup and select specific files or folders to restore.
• User profiles data — allows you to restore user profiles data as a whole.
• Loca l storage — select this option if you want to restore data from the backup that resides on a local
computer drive, direct or network attached storage — for example, a USB flash drive or locally mounted
SMB share. After you select this option and specify the location of the backup file, you will pass to the
Restore Point step of the wizard.
• Veeam backup repository — select this option if you want to restore data from the backup that resides in a
backup repository managed by the Veeam backup server. With this option selected, you will pass to the
Backup Server step of the wizard.
• Veeam Cloud Connect repository — select this option if you want to restore data from the backup that
resides in a cloud repository exposed to you by the Veeam Cloud Connect service provider. With this
option selected, you will pass to the Service Provider step of the wizard.
• Ob ject storage repository — select this option if you want to restore data from the backup that resides in
an object storage repository exposed to you by third -party vendors. With this option selected, you will
pass to the Cloud Type step of the wizard.
• Local storage settings — if you have selected the Loca l Storage option at the Backup Location step of the
wizard.
• Veeam backup repository settings — if you have selected the Veeam backup repository option at the
Backup Location step of the wizard.
• Veeam Cloud Connect repository settings — if you have selected the Veea m Cloud Connect repository
option at the Backup Location step of the wizard.
• Object storage settings — if you have selected the Ob ject storage repository option at the Backup Location
step of the wizard.
NOTE
If you want to import the backup file from the network drive, you must connect your computer to the
network storage beforehand.
To specify the location of a backup file that resides in a local or network drive:
1. At the Ba ckup Location step of the wizard, under the selected Loca l Storage option, click Browse.
2. In the Find er window, open the folder that contains the backup file and select the VBM file of the
necessary backup.
Alternatively, you can type a path to the folder that contains the VBM file in the Ba ckup File field.
Specify settings for the Veeam backup repository that contains the necessary backup file:
1. In the Veeam backup server name or IP address field, specify a DNS name or IP address of the Veeam
backup server.
2. In the P ort field, specify the number of the port over which Veeam Agent must communicate with the
backup repository. By default, Veeam Agent for Mac uses port 10006.
o Log in and password. With this option selected, specify the following settings:
i. In the Log in field, type in the name of the account that has access to the Veeam backup
repository.
ii. Optionally, in the Doma in field, type in the name of the domain in which the account that has
access to the Veeam backup repository is registered.
iii. In the P a ssword field, type in the password of the account that has access to the Veeam backup
repository.
NOTE
If you want to perform restore from a backup created by Veeam Agent operating in the
managed mode, you must use an account that has the Veeam Backup Administrator or Veeam
Restore Operator role on the Veeam backup server. For more information about user roles, see
the Users and Roles section in the Veeam Backup & Replication User Guide.
4. Press [Enter]. Veeam Agent will connect to the Veeam backup server. If prompted, accept the self -signed
certificate of the Veeam backup server to continue.
After successful connection to the Veeam backup server, you will pass immediately to the Backup step of
the wizard.
Specify settings for the cloud gateway that the Veeam Cloud Connect service provider (SP) or your backup
administrator has provided to you:
1. In the DNS name or IP address field, enter a full DNS name or IP address of the cloud gateway.
2. In the P ort field, specify the port over which Veeam Agent will communicate with the cloud gateway. By
default, Veeam Agent uses port 6180.
Verify TLS certificate settings and specify settings for the tenant account or subtenant account that you want to
use to connect to the cloud repository.
1. In the certificate details section, review information about the TLS certificate obtained from the SP side
and verify the TLS certificate.
c. In the Thumbprint for certificate verification field, paste the thumbprint you obtained from the SP.
d. Click Verify. Veeam Agent will check if the thumbprint you entered matches the thumbprint of the
obtained TLS certificate.
5. In the Username field, enter the name of the tenant or subtenant account that the SP or your backup
administrator has provided to you. The name of the subtenant account must be specified in the
TENANT\SUBTENANT format.
At the Cloud Type step of the wizard, select the cloud storage type. You can select one of the following options:
• S3 compatible — select this option if you want to import a backup from an S3 compatible storage
repository. With this option selected, you will pass to the Account step of the wizard.
TIP
If you plan to store backups on an IBM or Wasabi cloud storage, use the S3 compatible storage
option.
• Ama zon S3 — select this option if you want to import a backup from an Amazon S3 storage repository.
With this option selected, you will pass to the Account step of the wizard.
• Goog le Cloud Storage — select this option if you want to import a backup from a Google Cloud storage
repository. With this option selected, you will pass to the Account step of the wizard.
1. In the Service point field, specify the address of your S3 compatible storage.
NOTE
If you want to connect to the repository using the IPv6 address and the port number, you must use
the following format: IPv6:port, where:
2. In the Reg ion field, specify a storage region based on your regulatory and compliance requirements.
a. Click Browse.
b. In the Buck ets window, select the necessary bucket and click OK.
a. Click Browse.
If you have selected to store backup files on an Amazon S3 storage, specify settings to connect to the storage:
1. In the Da ta center window, select the geographic region where Veeam Agent will store backups.
a. Click Browse.
b. In the Buck ets window, select the necessary bucket and click OK.
a. Click Browse.
If you have selected to import backup from a Google Cloud storage repository, specify settings to connect to
the storage:
1. In the Da ta center window, select the geographic region where Veeam Agent will store backups.
a. Click Browse.
b. In the Buck ets window, select the necessary bucket and click OK.
a. Click Browse.
NOTE
The Allow storage a ccount key access option for Shared Key authorization must be enabled in the storage
account. For more information on how to find this option, see Microsoft Docs.
2. In the Sha red key field, enter the storage account shared key.
a. Click Browse.
b. In the Containers window, select the necessary container and click OK.
a. Click Browse.
b. In the Folders window, select the necessary folder and click OK.
From the list of backups, select the VBM (backup metadata) file of the necessary backup.
By default, Veeam Agent lists the metadata files for the backups created by Veeam Agent on the computer
where Veeam Agent is installed. Select Show All to display all the backups available in the Veeam backup
repository.
Veeam Agent displays only those backups that are available to the user whose credentials are specified to
access the selected repository. Consider the following specifics of the backup display logic depending on the
repository type:
• If you restore data from a backup stored in a Veeam backup repository, Veeam Agent displays only those
backups that are accessible by the user whose credentials are specified at the Backup Server step of the
wizard:
o If you specify credentials for the user who has access to the backup repository, the list of backups will
include only backups created by this user.
o If you specify credentials for the user who is assigned the Backup Administrator or Restore Operator
role on the backup server, the list of backups will include all Veeam Agent backups stored on the
backup repository.
• If you restore data from a backup stored in a Veeam Cloud Connect repository, Veeam Agent displays only
those backups that are accessible by the user whose credentials are specified at the Credentials step of the
wizard:
o If you specify credentials for the tenant account, the list of backups will include backups created by
all users who create backups under this account.
o If you specify credentials for the subtenant account, the list of backups will include only those Veeam
Agent backups that were created under this subtenant account.
If you restore data from an encrypted backup that was created on another Veeam Agent computer, you
need to provide a password to unlock the encrypted file. To learn more, see Restoring Data from Encrypted
Backups.
2. Click Op en. Veeam Agent will retrieve the content of the backup file and display it in the Veeam Backup
browser.
You can perform the following operations with the files and folders from the imported backup:
where:
<path> — path to the VBM file of the backup that you want to import.
For example:
2. You can monitor the import process and result by viewing the import session log with the following
command:
where:
For example:
3. Imported backup will be displayed in the list of backups. To view the list of backups , use the following
command:
1. If you have multiple backup jobs configured in Veeam Agent, from the Ba ckup Jobs list, select the backup
job whose backup you want to view.
If you have only one backup job configured in Veeam Agent, its details are displayed in the main pane by
default. Proceed to Step 2.
For each restore point, Veeam Agent displays the date and time it was created, type ( Full or Increment)
and size.
• View backups
• Delete backup
Viewing Backups
To view a list of backups created by a backup job configured in Veeam Agent for Mac, use the following
command:
In the list of backups, Veeam Agent for Mac displays the following information:
P a rameter Description
Job name Name of the backup job by which the backup was created.
Rep ository Name of the backup repository in which the backup was created.
Imported backups are marked as Imported in the Rep ository column. For information
about the import procedure, see Importing Backups.
For example:
where:
<backup_id> — ID of the backup for which you want to view detailed information.
P a rameter Description
Ma chine name Host name of the machine on which the backup job is configured and the name of the
job.
For example:
or
where:
<backup_id> — ID of the backup for which you want to view information on restore points.
For example:
Veeam Agent for Mac displays the following information about restore points in the backup:
P a rameter Description
Job name Name of the backup job by which the backup was created.
Is corrupt Indicates whether restore point in the backup is corrupted. Possible values:
• True
• False
Retention Displays information about enabled long-term retention per each type: weekly (W),
monthly (M) and yearly (Y).
Deleting Backups
Backup files created with Veeam Agent are removed automatically according to the retention job settings. You
can also remove backups from the target location and Veeam Agent configuration database manually if
necessary.
where:
Veeam Agent for Mac will remove records about the deleted backup from the Veeam Agent database. Back up
files themselves (VBK, VIB, VBM) remain in the backup repository. You can import the removed backup later to
Veeam Agent for Mac and perform restore operations with the imported backup.
where:
Veeam Agent for Mac will remove records about the deleted backup from the Veeam Agent database and,
additionally, delete backup files themselves from the destination storage.
When you restore user profiles data, Veeam Agent restores the home folders of all users that were set on the
Veeam Agent computer at the moment of backup. If the computer, on which you plan to perform the restore,
contains users with the same name as in the backup, all data of these users will be overwritten.
NOTE
• Computer administrator can restore data of all user profiles that are available in the backup file,
standard user can restore only their own user profile.
• Veeam Agent does not back up data of network users that do not have local accounts.
• The backup from which you plan to restore data must be successfully created at least once.
• The backup from which you plan to restore data must be created by a backup job that has P ersonal files in
the backup scope.
• [For backups stored in network shared folders, on Veeam backup repositories and Veeam Cloud Connect
repositories] You must have access to the target location where the backup file resides.
• [For Veeam backup repository targets] If you plan to restore data from a backup stored on a backup
repository, you must have access permissions on this backup repository. To learn more, see Setting Up
User Permissions on Backup Repositories.
1. In the Veeam Agent control panel, select the backup job that created the backup from which you want to
restore users.
2. In the main pane of the control panel, select the Restore tab. Veeam Agent will display the list of available
restore points in the backup.
Veeam Agent will copy the content of the backup file to the Users folder in the computer file system and
display a notification window with the corresponding message.
When you perform file-level restore, Veeam Agent publishes the backup content directly into the computer file
system. You can browse to files and folders in the backup, restore files and folders to their initial loca tion, copy
files and folders to a new location or simply target applications to restored files and work with them as usual.
• The backup from which you plan to restore data must be successfully created at least once.
• [For backups stored in network shared folders, on Veeam backup repositories and Veeam Cloud Connect
repositories] You must have access to the target location where the backup file resides.
• [For Veeam backup repository targets] If you plan to restore data from a backup stored on a backup
repository, you must have access permissions on this backup repository. To learn more, see Setting Up
User Permissions on Backup Repositories.
1. In the Veeam Agent control panel, select the backup job that created the backup from which you want to
restore users.
2. In the main pane of the control panel, select the Restore tab. Veeam Agent will display the list of available
restore points in the backup.
Veeam Agent will launch the Veeam Backup browser and display the content of the backup.
After you finish working with files and folders, close the Veeam Backup browser.
o Open the Op tions menu in the top right corner of the browser window.
o To overwrite the original item on your computer with the item restored from the backup, select
Restore > Overwrite.
o To save the item restored from the backup next to the original item on your computer, select Restore
> Keep. Veeam Agent for Microsoft Windows will add the -RESTORED postfix with a time stamp to
the restored file or folder name and save it in the same loca tion where the original file resides.
5. In the Find er window, specify the location for the copied items.
We recommend that you close the Veeam Backup browser after you finish restoring files and folders. Every 5
minutes, Veeam Agent checks if there is any activity in the Veeam Backup browser. If the user or product
components and services have not performed any actions for 30 minutes, Veeam Agent automatically closes the
Veeam Backup browser.
• If encryption keys required to unlock the backup file are available in the Veeam Agent database, that is, if
you encrypt and decrypt the backup file on the same Veeam Agent computer, you do not need to specify
the password. Veeam Agent uses keys from the database to unlock the backup file. Data decryption is
performed in the background, and data restore from the encryp ted backup does not differ from that from
an unencrypted one.
• If encryption keys are not available in the Veeam Agent database, you need to provide a password to
unlock the encrypted file. The password must be the same as the password that was used to encrypt the
backup file. If the password has changed once or several times, you need to specify the latest password. In
Veeam Agent, you can use the latest password to restore data form all restore points in the backup chain,
including restore points that were encrypted with an old password and restore points that were created
before you have enabled the encryption option for the job.
1. If you want to perform file-level restore from an encrypted backup that was created on another Veeam
Agent computer, launch the Veeam Agent control panel with Launchpad.
2. Select the encrypted backup and restore point from which you want to restore da ta.
3. Veeam Agent will display the E ncryption window. Enter the password for the backup file.
In the Hint field of the E ncryption window, Veeam Agent displays a hint for the password that was used to
encrypt the backup file. Use the hint to recall the password.
If you changed the password one or several times while the backup chain was created, you need to specify
the latest password. In Veeam Agent, you can use the latest password to restore data form all restore
points in the backup chain, including those restore points that were encrypted with an old password.
If you enter correct password, Veeam Agent will decrypt the backup metadata. You will be able to
continue the restore operation in a regular manner.
NOTE
In the Veeam Agent control panel, you can view information on backup job sessions only. To view
information on import or restore sessions, use command line interface.
For every configured backup job, Veeam Agent displays backup session statistics in the main pane of the control
panel. Depending on the number of the configured backup jobs, when you launch Veeam Agent, the control
panel displays the following information:
• [Single job] Session statistics for the only backup job configured in Veeam Agent.
• [Multiple jobs] Session statistics for the top job in the Ba ckup Jobs pane of the control panel. To view
statistics for another job, select the necessary job from the Ba ckup Jobs list.
The control panel displays information about backup job sessions that ran previously as well as about the
backup job session that is currently running. Veeam Agent provides the following details for every backup
session: backup start time and date, backup status and size of the resulting backup file. A session can have one
of the following statuses:
• Warning — the backup job has completed with a warning. Veeam Agent has managed to create the
resulting backup file, but you need to pay your attention to some alerts, for example: the target location
is running low on disk space.
• Failed — the backup job has failed to complete. The resulting backup file has not been created.
1. Select a backup job. In the main pane of the control panel, Veeam Agent will display the list of sessions for
the selected backup job.
2. Select a session.
3. Click View Log. Veeam Agent will display a window with information on the selected session.
• The pane at the top of the window lists the operations performed during the backup job session, their
start time and duration time, as well as operation status. Operations can have the following statuses:
o Information — marks messages that inform about a certain stage of the process — for example,
Preparing for backup or Processing finished .
o In P rogress — marks operations being performed. You can view such operation status if you are
monitoring a running session.
o Duration — time from the job start till the job end.
o P rocessing rate — average speed of data processing. This counter is a ratio between the amount of
processed data (P rocessed counter) and job duration (Duration counter).
o Rea d — amount of data read from the backed-up computer by Veeam Agent prior to applying
compression. For incremental job runs, the value of this counter is typically lower than the value of
the P rocessed counter. Veeam Agent reads only data blocks that have changed since the last job
session, processes and copies these data blocks to the target location.
o Tra nsferred — amount of data transferred from the backed-up computer to the backup location after
applying compression. This counter does not directly indicate the size of the resulting files.
Depending on the backup infrastructure and job settings, Veeam Agent can perform additional
activities with data — for example, decompress data prior to writing the file to disk. These activities
can impact the size of the resulting file.
To enable desktop notifications, hover over the "Veeam Agent for Mac" Notifications message and select
Op tions > Allow.
Alternatively, you can enable and disable Veeam Agent notifications in the system settings of the Mac
computer. For details, see Apple documentation.
Once an event occurs, a message notifying about this event will appear in the notification center.
where:
For example:
2023-01-26 12:19:52 UTC [info] Job Daily Backup started at 2023-01-26 12:19:52
UTC
where:
P a rameter Description
ID ID of the session.
Job name Name of the backup job that is parent to the session. Veeam Agent displays value for
this parameter only for backup job sessions.
Job ID ID of the backup job that is parent to the session. Veeam Agent displays value for this
parameter only for backup job sessions.
E nd time Date and time of the session completion. Veeam Agent displays value for this
parameter only for completed sessions.
The following example shows status information on the completed backup policy session:
P a rameter Description
Job name Name of the backup job that is parent to the session. Veeam Agent displays value for
this parameter only for backup job sessions.
ID ID of the session.
Finished at Date and time of the session completion. Veeam Agent displays value for this
parameter only for completed sessions.
For example:
Job
name Type ID State Created
at Started at Finished at
When you export logs, Veeam Agent collects its log and configuration files, as well as the required system logs,
exports them to an archive file in the tar.gz format and saves this archive file to a folder on the Veeam Agent
computer.
You can perform the export logs operation in one of the following ways:
• With the Veeam Agent control panel — in this case, you can specify a local folder where Veeam Agent will
save the log archive.
• In command line interface — in this case, Veeam Agent will save the log archive to the current working
folder.
NOTE
If Veeam Agent operates in the managed mode, product logs are automatically exported to the Veeam
backup server. For more information, see Exporting Logs to Backup Server.
NOTE
Veeam Agent provides the Help > E xport logs to menu with 2 options: Local folder and Veeam server . The
Veeam Server option is available only when Veeam Agent operates in the managed mode. For more
information on operating modes, see Standalone and Managed Operation Modes.
2. In the Find er window, specify the location for the resulting log archive.
2. In the Find er window, specify the location for the resulting log archive.
veeamconfig grablogs
Veeam Agent will collect logs, export them to an archive file with the name
veeam_logs_vam_<date>_<time>.tar.gz, and save the archive to the current working folder.
For example:
• You can search for the information on the necessary subject in the current Veeam Agent for Mac User
Guide.
• You can visit Veeam R&D Forums and share your opinion or ask a question.
• If you use Veeam Agent with an active license installed, you can visit Veeam Customer Support Portal and
submit a support case to the Veeam Customer Support Team.
IMP ORTANT
If you plan to use Veeam Agent for Mac 2.1 with Veeam Backup & Replication, you must install Veeam
Backup & Replication 12.1 on the Veeam backup server.
For more information on managing connection to a Veeam backup server, see Managing Veeam Backup &
Replication Servers.
NOTE
This and subsequent sections describe tasks with Veeam Backup & Replication available for Veeam Agent
operating in the standalone mode. For information about tasks available in Veeam Backup & Replication
within the Veeam Agent management scenario, see the Veeam Agent Management Guide.
Restore tasks
• Export restore points of Veeam Agent backups to standalone full backup files .
Administrative tasks
IMP ORTANT
Veeam Agent for Mac does not support Veeam backup repositories with enabled KMS encryption. To learn
more about KMS encryption for Veeam backup repositories, see the Key Management System Keys section
in the Veeam Backup & Replication User Guide.
NOTE
If you plan to create backups in a Veeam backup repository with Veeam Agent backup jobs configured in
Veeam Backup & Replication, you do not need to grant access permissions on the backup repository to
users. In the Veeam Agent management scenario, to esta blish a connection between the backup server and
protected computers, Veeam Backup & Replication uses a TLS certificate. To learn more, see the
Configuring Security Settings section in the Veeam Agent Management Guide.
Access permissions are granted to security principals such as users and AD groups by the backup administrator
working with Veeam Backup & Replication. Users with granted access permissions can target Veeam Agent
backup jobs at this backup repository and perform restore from backups located in this backup repository.
Right after installation, access permissions on the default backup repository are set to Allow to everyone for
testing and evaluation purposes. If necessary, you can change these settings.
After you create a new backup repository, access permissions on this repository are set to Deny to everyone . To
allow users to store backups in the backup repository, you must grant users with a ccess permissions to this
repository.
o The Ba ckup Repositories node — if you want to grant access permissions on a regular backup
repository to Veeam Agent users.
o The Sca le-out Repositories node — if you want to grant access permissions on a scale-out backup
repository to Veeam Agent users.
4. In the Access Permissions window, in the Sta ndalone applications tab, specify to whom you want to grant
access permissions on this backup repository:
o Allow to everyone — select this option if you want all users to be able to store backups on this backup
repository. Setting access permissions to Everyone is equal to granting access rights to the Everyone
Microsoft Windows group ( Anonymous users are excluded). However, we recommend this scenario for
demo environments only.
o Allow to the following accounts or groups only — select this option if you want only specific users to
be able to store backups on this backup repository. Click Ad d to add the necessary users and groups
to the list.
5. If you want to encrypt Veeam Agent backup files stored in the backup repository, select the E ncrypt
b a ckups stored in this repository check box and choose the necessary password from the field below. If
you have not specified a password beforehand, click Ad d on the right or the Ma nage passwords link to add
a new password. Veeam Backup & Replication will encrypt files at the backup repository side using its
built-in encryption mechanism. To learn more, see Veeam Backup & Replication Documentation.
If Veeam Agent is set up to use the backup cache, and the backup cache contains one or more restore
points, Veeam Agent will automatically remove these restore points from the backup cache after you
enable or disable the encryption option for the backup repository.
After Veeam Agent connects to Veeam Backup & Replication, Veeam Agent automatically starts consuming
instances in the license. The product edition for Veeam Agent is selected depending on the type of the OS
running on the Veeam Agent computer. You can switch to another commercial edition of Veeam Agent manually
if needed. If you do not want Veeam Agents to consume instances, you can restrict instance consumption. For
more information, see Managing Instance Consumption by Veeam Agents.
The number of backup jobs configured in Veeam Agent does not impact instance consumption. For example, if 2
backup jobs are configured in Veeam Agent that operates in the Server edition, this Veeam Agent will consume
instances required for 1 server.
Veeam Agent obtains information about the license from Veeam Backup & Replication and keeps it locally on
the Veeam Agent computer. Information about the license is valid for 32 days. If Veeam Agent does not connect
to Veeam Backup & Replication during this period, Veeam Backup & Replication will revoke its license.
NOTE
In addition to managing Veeam Agent licenses, you can use the Veeam Backup & Replication console to
manage Veeam Agent backup jobs and perform operations with backups created by these jobs.
If your backup server is connected to Veeam Backup Enterprise Manager, you can use Veeam Backup
Enterprise Manager to manage licenses and perform restore tasks with Veeam Agent backups. You cannot
manage Veeam Agent backup jobs with Veeam Backup Enterprise Manager.
For more information on Veeam Backup & Replication licensing, see the Licensing section in the Veeam Backup
& Replication User Guide.
If you restrict instance consumption, Veeam Backup & Replication will switch all Veeam Agents connected to
this Veeam backup server to the free edition that offers limited capabilities. For information about Veeam Agent
editions, see Product Editions.
1. In Veeam Backup & Replication, from the main menu, select License.
3. On the Instances tab, clear the Allow unlicensed agents to consume instances check box.
4. Click Close.
You can also assign a license to Veeam Agent manually if needed. When you assign a license, you can select the
product edition, too.
To assign a license:
1. In Veeam Backup & Replication, from the main menu, select License.
2. In the License Information window, select the Instances tab and click Ma nage.
3. In the Licensed Instances window, select the Veeam Agent to which you want to assign the license, click
Assign and select the desired product edition: Workstation or Server.
1. In Veeam Backup & Replication, from the main menu, select License.
2. In the License Information window, select the Instances tab and click Ma nage.
In the list of licensed instances, Veeam Backup & Replication displays Veeam Agents that have established a
connection with the backup server when you created the backup job.
1. In Veeam Backup & Replication, from the main menu, select License.
2. In the License Information window, select the Instances tab and click Ma nage.
3. In the Licensed Instances window, select a Veeam Agent and click Revoke. Veeam Backup & Replication
will revoke the license from the Veeam Agent, and the license will be freed for other workloads that you
want to protect with Veeam products.
• Back up your data and store the resulting backup files in one of the following types of Veeam backup
repositories:
o Copy Veeam Agent backups from the backup repository to a secondary backup repository with backup
copy jobs.
NOTE
• A Veeam Agent backup job can be started automatically upon the defined schedule or manually
from the Veeam Agent computer. You cannot start, stop, retry or edit Veeam Agent backup jobs in
the Veeam Backup & Replication console.
• If the user is granted restore permissions on the Veeam backup server, the user will be able to see
all backups in the backup repository.
• The user who creates a Veeam Agent backup in the backup repository is set as the owner of the
backup file. The backup file owner can access this file and restore data from it. If the user who is not
the backup file owner needs to perform operations with the backup file, the user must have the
Veeam Backup & Replication role that allows to perform these operations. To learn more about
roles, see the Users and Roles section in the Veeam Backup & Replication User Guide.
Backup jobs targeted at the backup repository become visible in Veeam Backup & Replication under the Job s >
Ba ckup node in the Home view. Backups created with Veeam Agent are available under the Ba ck ups > Disk node
in the Home view.
The Veeam Backup Administrator working with Veeam Backup & Replication can manage Veeam Agent backup
jobs and restore data from Veeam Agent backups. To learn more, see Restoring Data from Veeam Agent Backups
and Performing Administration Tasks.
The backup administrator working with Veeam Backup & Replication on the tenant side can manage Veeam
Agent backups created in the cloud repository and restore data from such backups. To recover data from a
Veeam Agent backup, you can perform the following operations:
• Instant recovery
• Disk restore
• Disk publish
To learn more, see the Restoring Data from Tenant Backups section in the Veeam Cloud Connect Guide.
Backup copy jobs treat Veeam Agent backups as usual backup files. The backup copy job setup and proces sing
procedures practically do not differ from the same procedures for a backup copy job that processes VM backups.
To learn more about backup copy jobs, see the Backup Copy section in the Veeam Backup & Replication User
Guide.
When mapping a backup copy job to a Veeam Agent backup, consider the limitations listed in the Map Backup
File section in the Veeam Backup & Replication User Guide.
To overcome this limitation, you can delegate the restore task to backup administrators who work with Veeam
Backup & Replication. Backup administrators can use Veeam Backup & Replication options to recover data from
such backups: for example, perform file-level restore or retrieve necessary application items with Veeam
Explorers.
You can also restore data from the copied backup stored in the target repository using Veeam Agent.
Backup to tape jobs treat Veeam Agent backups as usua l backup files. The archiving job setup and processing
procedures practically do not differ from the regular ones. To learn more about backup to tape jobs, see the
Backup to Tape section in the Veeam Backup & Replication User Guide.
NOTE
For the After this job option in the backup to tape job schedule settings, you cannot select a backup job
managed by Veeam Agent or a standalone Veeam Agent backup job as the preceding backup job.
• Export restore points of Veeam Agent backups to standalone full backup files
The procedure of file-level restore from a Veeam Agent backup is similar to the same procedure for a VM
backup. To learn more about file-level restore, see the Restore from Linux, Unix and Other File Systems section
in the Veeam Backup & Replication User Guide.
Consider the following:When you perform the file-level restore procedure, Veeam Backup & Replication
provides the following options for mounting disks of the machine from the backup or replica:
o Mounting disks to a helper host — any Linux host from your infrastructure with a supported operating
system.
o Mounting disks to a temporary helper appliance — a helper VM required to mount Linux computer
disks from the backup.
If you have selected to mount disks to a temporary helper appliance, it is recommended that you add
a vCenter Server and not a standalone ESXi host in the Veeam backup console. If Veeam Backup &
Replication is set up to deploy a helper appliance on a standalone ESXi host, after Veeam Backup &
Replication removes the helper appliance, the helper VM will be displayed in vCenter as orphaned .You
cannot restore files or folders from Veeam Agent for Mac backup to the original machine. You can
only save files and folders to a new location over the network by using the Cop y To option.
During disks restore, Veeam Backup & Replication creates standard virtual disks that can be used by VMware
vSphere and Microsoft Hyper-V VMs.
• When you restore a disk in the VMDK format, Veeam Backup & Replication creates a pair of files that make
up the VM virtual disk: a descriptor file and file with the virtual disk content.
• When you restore a disk in the VHD/VHDX format, Veeam Backup & Replication creates a file of the VHD
or VHDX format.
You can save converted disks locally on any server or SMB share added to the backup infrastructure or place
disks on a datastore connected to an ESXi host (for VMDK disk format only). VMDK disks can be restored as thin
provision and thick disks:
Veeam Backup & Replication supports batch disk restore. For example, if you choose to restore 2 computer
disks, Veeam Backup & Replication will convert them to 2 virtual disks and store these disks in the specified
location.
IMP ORTANT
• If the backup from which you restore disks contains a Btrfs storage pool, during the disk restore
process Veeam Backup & Replication will create a separate disk and restore the Btrfs pool to this
disk.
• If the disk you want to restore contains an LVM volume group, Veeam Agent will restore the original
disk and the LVM volume group as 2 separate disks. Among other things, this leads to the increase
of the required storage space. For example, you restore a machine with 2 disks, and a separate LVM
volume group is configured on each of these disks. In this case, Veeam Agent will restore 4 disks.
The restored disks will consume storage space equal to the size of 2 original disks and 2 LVM volume
groups from these disks.
To restore disks and convert them to the VMDK, VHD or VHDX format, perform the following steps in the
E x port Disk wizard:
• Open the Home tab and click Restore > Ag ent > Disk restore > E xport disk. In this case, you will be able to
select a backup of the necessary Veeam Agent computer at the Backup step of the wizard.
• Open the Home view. In the inventory pane, click the Ba ckups node. In the working area, expand the
necessary Veeam Agent backup, select the necessary computer in the backup and click E x port Disks on the
ribbon or right-click a computer in the backup and select E x port content as virtual d isks.
In this case, you will pass immediately to the Restore Point step of the wizard.
1. From the Server list, select a server on which the resulting virtual disks must be saved. If you plan to save
the disks in the VMDK format on a datastore, select an ESXi host to which this datastore is connected.
2. In the P a th to folder field, specify a folder on the server or datastore where the virtual disks must be
placed.
o VMDK — select this option if you want to save the resulting virtual disk in the VMware VMDK format.
o VHD — select this option if you want to save resulting virtual disk in the Microsoft Hyper -V VHD
format.
o VHDX — select this option if you want to save resulting virtual disk in the Microsoft Hyper -V VHDX
format (supported by Microsoft Windows Server 2012 and later).
4. Click Disk type to specify how the resulting disk must be saved:
o [For VMDK disk format] in the thin provisioned, lazy zeroed thick provisioned, or eagerly zeroed thick
provisioned format
o [For VHD and VMDX disk formats] in the dynamic or fixed format
5. [For export of a VMDK disk to an ESXi host] Click the P ick proxy to use link to select backup proxies over
which backup data must be transported to the target datastore.
• If you have selected to store the resulting virtual disk in a datastore, you will be able to save the
virtual disk in the VMDK format only. Other options will be disabled.
• If you have selected to store the resulting virtual disk on the server running Microsoft Windows
Server OS and in the VMDK format, you will be able to save the virtual disk in the lazy zeroed thick
provisioned format only.
TIP
If you do not want to display the Restore Reason step of the wizard in future, select the Do not show me
this page again check box.
2. Click Finish to start the restore procedure and exit the wizard.
TIP
You can publish disks using the PowerShell console. To learn more, see the Disk Publishing (Data
Integration API) section in the Veeam PowerShell Reference.
Disk publishing allows you to save time by getting backup content of one or multiple disks instead of all disks
from a backup. This technology gives read-only access to data and helps if you want to analyze data of your
backup. For example, look for specific documents or usage patterns, or perform antivirus scan of backed -up
data.
For macOS-based Veeam Agent computers, disk publishing uses the FUSE protocol. After the publishing, the
target server can access the backup content using the FUSE protocol and read the necessary data from the disk.
To learn more, see the Disk Publishing section in the Veeam Backup & Replication User Guide.
4. Select disks.
• The necessary ports must be opened on the target server. For more information, see Ports.
• The target server must support the file system of the disk that you plan to publish.
• If data deduplication is enabled for some disks in a backup, data deduplication must be enabled on the
target server.
• The 32-bit version of a Linux server is not supported as the target server.
• You cannot publish disks from backups stored in the Veeam Cloud Connect repository.
For the full list of limitations, see the Considerations and Limitations section in the Veeam Backup & Replication
User Guide.
• On the Home tab, click Restore > Ag ent > Disk Restore > P ublish disk.
• Open the Home view. In the inventory pane, click Ba ckups. In the working area, expand the necessary
Veeam Agent backup, select a computer whose disks you want to publish and click P ub lish Disks on the
ribbon. Alternatively, you can right-click the computer and select P ub lish disks. In this case, you will
proceed to the Restore point step of the wizard.
If you want to add a new backup server to the backup infrastructure at this step, click Ad d . In this case,
you will be able to add a new Linux server. To learn more, see the Adding Linux Servers section in the
Veeam Backup & Replication User Guide.
• A temporary server. In this case, select Specify a different host from the drop-down list. In the Ta rget
Server window, specify the following settings:
a. In the Host name field, specify a server name or IP address of the server.
b. Select the account from the Credentials list. If you have not set up credentials beforehand, click the
Ma nage accounts link or click Ad d on the right to add a new account in the Credentials Manager. To
learn more, see the Credentials Manager section in the Veeam Backup & Replication User Guide.
c. Click Ad vanced and customize connection settings in the Network Settings window . To learn more,
see Customizing Connection Settings.
3. [For Linux server deployed outside NAT] In the P referred TCP connection role section, select the Run
server on this side check box.
To learn more about these settings, see the Specify Credentials and SSH Settings section in the Veeam Backup &
Replication User Guide.
TIP
If you do not want to show this page, select the Do not show me this page again check box. If you further
will want to return this page, follow the instructions described in this Veeam KB article.
After you started a disks publishing session, you can view the session statistics or stop the session from the
Veeam backup console. To learn more, see Managing Publishing Disks Session.
• Open the Home view. In the inventory pane, select Instant Recovery. In the working area, select the
necessary publishing session and click P roperties on the ribbon. Alternatively, right-click the session and
P roperties.
• Open the Home view. In the inventory pane select La st 24 hours. In the working area, double-click the
necessary publishing session. Alternatively, you can select the session and click Sta tistics on the ribbon or
right-click the session and select Sta tistics.
• At the top of the Restore Session window, Veeam Backup & Replication shows general session statistics. It
includes a name of the Veeam Agent computer whose disk you want to publish, a name of the backup
server which initiated the publishing session, a user name of the account under which the session was
started, session status and duration details.
• The Rea son tab shows the reason for the publishing session.
• The P a rameters tab shows information about the target server, the Veeam Agent computer whose disks
you publish and the restore point selected for publishing.
• The Log tab shows the list of operations performed during the session.
• Open the Home view. In the inventory pane select Instant Recovery. In the working area, double-click the
necessary publishing session and click Ca ncel restore task in the Restore Session window. Alternatively,
you can select the necessary publishing session and click Stop Publishing on the ribbon or right-click the
session and click Stop P ublishing.
• Open the Home view. In the inventory pane select La st 24 hours. In the working area, double-click the
necessary publishing session and click Ca ncel restore task in the Restore Session window. Alternatively,
you can select the necessary publishing session and click Stop on the ribbon or right-click the session and
click Stop session.
• The Veeam Agent backup is stored on a drive managed by another computer (not the Veeam backup
server).
• The Veeam Agent backup is stored in a backup repository managed by another Veeam backup server.
• The Veeam Agent backup has been removed in the Veeam Backup & Replication console.
After importing, the Veeam Agent backup becomes available in the Veeam Backup & Replication console. You
can restore data from such backup in a regular manner.
• The computer or server from which you plan to import the backup must be added to Veeam Backup &
Replication. Otherwise you will not be able to access backup files.
• To be able to restore data from previous backup restore points, make sure that you have all incremental
restore points in the same folder where the full backup file resides.
1. In Veeam Backup & Replication, click Imp ort Backup on the Home tab.
2. From the Computer list, select the computer or server on which the backup you want to import is stored.
3. Click Browse and select the necessary VBM or VBK file. If you select the VBM file, the import process will
be notably faster. We recommend that you use the VBK files for import only if a corresponding VBM file is
not available.
4. Click OK. The imported backup will become available in the Home view, under the Ba ckups > Disk
( imported) node in the inventory pane.
2. From the Computer list, select the host on which the backup you want to import is stored.
4. Click OK. The encrypted backup will appear under the Ba ckups > Disk (encrypted) node in the inventory
pane.
5. In the working area, select the imported backup and click Sp ecify Password on the ribbon, or right-click
the backup and select Sp ecify password.
6. In the P a ssword field, enter the password for the backup file. If you changed the password one or several
times while the backup chain was created, you need to specify the latest passwor d. For Veeam Agent
backups, you can use the latest password to restore data form all restore points in the backup chain,
including those restore points that were encrypted with an old password.
If you enter correct password, Veeam Backup & Replication will decrypt the backup file. The backup will be
moved under the Ba ckups > Disk ( imported) node in the inventory pane.
When you disable the job, you prohibit the user to store the resulting backup in the backup repository. If the
user starts a disabled job manually or the job starts by schedule, the job session will fail and report the " Job is
disabled on backup server " error. To let Veeam Agent store backups in the backup repository again, you must
enable the disabled job.
To disable or enable the scheduled backup job in Veeam Backup & Replication:
3. Select the necessary job in the working area and click Disable on the ribbon, or right-click the necessary
job in the working area and select Disable. To enable the disabled job, click Disable on the toolbar, or
right-click the job and select Disable once again.
3. In the working area, select the necessary Veeam Agent backup job and click Sta tistics on the ribbon, or
right-click the job and select Sta tistics.
When you delete a Veeam Agent backup job, Veeam Backup & Replication removes all records about the job
from its database and console. When the user starts a new Veeam Agent backup job session manually or the job
starts automatically by schedule, the job will appear in the Veeam Backup & Replication console again, and
records about a new job session will be stored in the Veeam Backup & Replication database.
NOTE
When you delete a Veeam Agent backup job, the backup files become orphaned and can be deleted by the
background retention. For more information about the background retention, see the Background
Retention section in the Veeam Backup & Replication User Guide.
To prevent the job from starting permanently, you must delete the job and unassign access rights permissions
for this user from the backup repository. To completely delete the job, you must perform this operation in
Veeam Agent on the Veeam Agent machine.
To remove a job:
3. Select the necessary job in the working area and click Delete on the ribbon, or right-click the necessary job
in the working area and select Delete.
3. In the working area, expand the Ag ents node, select the necessary backup and click P roperties on the
ribbon, or right-click the backup and select P roperties.
You can generate the recovery token on the Veeam Backup & Replication side. Then, on the computer side, with
this recovery token get access to the backup and recover data that are stored in the backup. To learn more, see
Veeam Backup Repository Settings.
• You can recover files and folders from the selected backups only.
• During recovery, Veeam Backup & Replication does not stop backup operations.
• You cannot create a recovery token for backups stored in Veeam Cloud Connect repository.
3. In the working area, right-click the backup and select Create recovery token.
You can create a recovery token for several backups. To do this, press and hold [Ctrl], select multiple
backups, right-click one of the selected backups and select Create recovery token.
You can modify the existing recovery token using the PowerShell console. To learn more, see the Working with
Tokens section in the Veeam PowerShell Reference.
Alternatively, you can get access to the backup using user credentials. To learn more, see Veeam Backup
Repository Settings.
IMP ORTANT
Removing backups from configuration is designed for experienced users only. Consider using the Delete
from disk operation instead.
3. Press and hold the [Ctrl] key, select the backup, right-click the backup and select Remove from
configuration.
3. Select the necessary computer backup and click Delete from > Disk on the ribbon or right-click the
computer and select Delete from disk.
• Configure network throttling settings so that Veeam Agent backup job does not consume all network
resources. To learn more, see the Specifying I/O Settings topic in the Veeam Backup & Replication User
Guide.
• Configure the following global notification settings to get alerted about the Veeam Agent backup job
results:
o Email notifications. To learn more, see the Specifying Email Notification Settings section in the Veeam
Backup & Replication User Guide.
o SNMP notifications. To learn more, see the Specifying SNMP Settings section in the Veeam Backup &
Replication User Guide.
To learn more, see the Users and Roles section in the Veeam Backup & Replication User Guide.
The configuration file is one of the Veeam Agent for Mac setup files that you must obtain from your System
Administrator. To learn more about setup files, see the Deploying Veeam Agent for Mac section in the Veeam
Agent Management Guide.
The example below can be used to install Veeam Agent for Mac with Jamf Pro, Microsoft Intune or SimpleMDM.
If you use another MDM solution, instructions may differ. For details, refer to the documentation of your MDM
solution.
• Yellow parts can be replaced with any values of your choice. Mind that UUI Ds must be in the UUID format.
a. <protection_group_name>_escaped.xml
b. <protection_group_name>.xml
where <protection_group_name> is a name of the protection group for pre-installed Veeam Agents.
To learn more about Veeam Agent setup files, see the Deploying Veeam Agent for Mac section in the
Veeam Agent Management Guide.
After the device profile is installed on the Veeam Agent computer, Veeam Agent will connect to Veeam backup
server.
Mind that the connection between Veeam Backup & Replication and Veeam Agent is not persistent. Veeam
Agent synchronizes with the backup server periodically. To synchronize Veeam Agent immediately, run the
following command: