Endpoint backup job item attributes

Main: General

Attribute name

Description

Name

Name of the Endpoint backup job item.

This field is mandatory.

Type

Type of the Endpoint backup job item. The type of a backup job can be either shared or device specific.

A device specific backup job defines backup actions for a one specified device, whereas shared backup job defines backup rules for multiple devices at once.

Backup type

Backup type defines the backup method used by this backup job item. Possible values:

  • File system: Backup files are stored to a local or network drive (e.g. internal or external hard disk, USB stick, network share...).

  • Backup server: Backup files are stored to an Endpoint backup server.

Status

Status of the Endpoint backup job item.

If Status = Disabled, the backup actions defined by this item will not be performed.

Mandatory job

This field defines whether the backup job defined by this item is mandatory for the device(s) that match with the scope.

If Mandatory job = Yes, the backup job is mandatory for the device(s) that match with the scope and end-users of the devices cannot edit or remove the backup job. They will, however, see the job in their Endpoint backup client.

If Mandatory job = No, the backup job is not mandatory for the device(s) that match with the scope and end-users of the devices are able to edit or remove the backup job using Endpoint backup client.

What to backup

This field defines, in a managed device, the source directory which will be backed up. In other words, this field defines the folder to be backed up.

Environment variables can be used in this field. Notice that the syntax may vary depending on the installed operating system.

For example:

%HOMEPATH%\Documents (in Windows computers the variable is enclosed by percentage signs)

$HOME/Documents (in Linux & OS X computers the variable begins with a dollar sign)

By using the environment variables, certain directories can be referenced conveniently even if the actual location of the directory would vary from computer to computer.

This field is mandatory.

Where to backup

When Backup type = File system

This field defines the destination where the backup is stored to. The backup destination can be located at a local USB drive, NAS device, or a file server for example.

Environment variables can be used in this field. Notice that the syntax may vary depending on the installed operating system.

For example:

%HOMEPATH%\Documents (in Windows computers the variable is enclosed by percentage signs)

$HOME/Documents (in Linux & OS X computers the variable begins with a dollar sign)

By using the environment variables, certain directories can be referenced conveniently even if the actual location of the directory would vary from computer to computer.

When Backup type = Backup server

This field defines the Endpoint backup server where backup files are stored.

This field is mandatory.

Description

This field can be used to describe the backup job. For example, what is backed up, where the backup is stored, and what is the backup interval.

Main: Scope

Attribute name

Description

Assigned to

This field specifies the target device for a  device-specific backup job.

Restrictions

This field defines a scope for a shared backup job. In this field, you may define rule(s) which determine the devices to which the backup actions, defined by this rule, are applied to.

Miradore then processes the rules in an order from smallest to largest and applies the rule that first matches with the device.

Main: Advanced settings

Attribute name

Description

Include filters

This field can be used as a file filter to define which type(s) of files should be included in the backup.

Use file extensions with ; delimiter to list the file types that you wish to backup.

For example:

exe;docx

Notice that if this field is used, only listed file types will be backed up.

Exclude filters

This field can be used as a file filter to define which type(s) of files should be excluded from the backup.

Use the file extensions with ; delimiter to list the file types that you wish to exclude from the backup.

For example;

mp3;avi;wav

Backup scheduling

This field defines whether the backup job runs at regular intervals around the clock or during a given time frame once in a day. See more information from the appropriate fields.

Backup interval

This field defines how often the backup job runs in the target devices. For example, if the backup interval is 2 hours and 30 minutes, then the backup job attempts to run every 2,5 hours around the clock.

Backup window

Backup window defines a time slot when the backup job must run. For example, 20-05 means that the backup job must run between 8:00 PM and 5:59 AM. The backup window should be entered in "hh-hh" format, e.g. "02-04".

The actual time to run the backup job is randomised, which means that all assets which are in the scope of the backup job will run the backup job on different times, but within the given backup window.

Retry until success

This field defines whether Miradore must try to run the backup job again if it didn't succeed to run the backup job with the previous attempt. This setting is applied to the backup jobs which are scheduled to run during a backup window.

Notice that a retry may take place outside the backup window.

Time to store deleted files

This field defines how long backup file is stored at the backup destination after the source file was deleted.

Allowed account

This field defines the type of the accounts which are allowed to run the backup job on the target device(s).

  • Any user account: Any end-user account is allowed to run this backup job.

  • Responsible person only: Only the user account of asset's responsible person is allowed to run this backup job.

  • System account only: Only local system account is allowed to run this backup job.

 

In "Administration > System settings > Endpoint backup > Scope of where backup jobs are allowed to run...", you can define the targets assets to which the backup jobs should be distributed to. There are actually two different sections, which allow to define different scopes for backup jobs that are executed with a local system account and end-user accounts.

Allowed users

In this field, you can list user IDs separated with ; (semicolon).

If "Allow only responsible person = Yes", this field cannot be used since then the backup job is only aimed  for device responsible person's.

If any user IDs have been listed in this field, backups are run only for computers that match with the job scope and have some of the listed users logged in. If the user ID that is used to run backup doesn't match with the users listed here, the backup will not be made.

However, if this field is left empty, then backups are run for all computers that match with the job scope despite the user ID that is used to run backup.

Append source path to destination path

This field defines if the backup source path is appended to the destination path when performing backup to a file system. This setting is available only for file system backup jobs.

Disabling this setting may avoid the situation where the maximum path length of the Windows file system gets exceeded. Note that when this setting is disabled, extra precaution is required for not to create multiple backup jobs that point to the same destination folder.

Example:

Backup source folder is "c:\data" and its contents are backed up to the destination folder "d:\my_backups".

The possible options for this setting are:

  • Yes (default): Backups are created in the folder "d:\my_backups\c\data".

  • No: Backups are created in the folder "d:\my_backups"

Allow restore for end-users

This field defines whether device end-users are allowed to restore files from backup through the graphical user interface of Miradore Endpoint Backup.

If "Allow restore for end-users = No", then the end-users are not able to restore files by themselves. In that case, the restore can be performed only by help desk personnel by restoring the files manually from the backup location.

This setting is only available for backup jobs, whose backup type is "file system".

Main: Bandwidth management settings

Attribute name

Description

Required transfer rate

This field defines the minimum network or file transfer speed which is required in order to run the backup actions defined by this item. If a computer doesn't meet the requirement, backup will not be made. If the backup job is initiated manually, the required transfer rate setting is disregarded.

Maximum bandwidth consumption

This field defines the maximum allowed network bandwidth consumption for transferring backup files from a computer to a backup destination. The setting is not applied when backup files are recovered back to the computer from the backup destination.

The possible values of this field are:

  • Not defined:  If limit has not been defined, backup is allowed to use all the available network bandwidth to transfer the backup files to the backup destination.

  • Static limit: If static limit is selected, the selected value defines, in kilobytes or megabytes the maximum allowed bandwidth consumption for transferring the backup files to the backup destination.

  • Dynamic limit: If dynamic limit is selected, the selected value defines, in percentages the maximum allowed bandwidth consumption for transferring the backup files to the backup destination. When using the dynamic limit, the available network bandwidth is constantly measured during backup and the data transfer rate is adjusted according to the measured bandwidth.

If the backup job is initiated manually, the maximum bandwidth consumption setting is disregarded.

Main: Additional information

Attribute name

Description

Attachments

You may attach files into this field. About attaching files.

This field is optional.

Comments

You may add comments related to this item here.

This field is optional.

Related to

Endpoint backup job item