Introduction

When you click the Edit subtab, the screen displays the interface for editing client configurations.

All of the clients on the system (except for Myself) are listed in the left column.

You can use the options on the Edit Clients line to

  • create a client configuration,
  • delete a client configuration,
  • filter the list of displayed clients, and
  • view and change the default configuration settings.

Creating a client configuration

To create a new client configuration, on the Edit Clients line, click New.

The New Client dialog box will appear.

Setting Description
Name The name of the new client configuration. It cannot be changed once the client has been created.
Description An optional description of the client configuration.
Operating System Select from the drop-down list.
Set as Default OS Check this check box if you want your operating system selection to be the new default for your CFA.
Address Specify the clients IP address or DNS name.
Push Backup Agent Software Will push the Agent and DR Image software to a Windows client.
Schedule Select the schedule you would like the client to start with.

Then press OK. The new client will then be listed on the Clients Edit screen.

Deleting a client configuration

To delete one or more client configurations, check the check boxes for the respective clients, and then click Delete on the Edit Clients line.

Then, on the Confirm Client Delete dialog box, to purge the client’s backup data, choose whether or not to purge the associated jobs from that client.

Note

If you do not purge the backup data with the client, there will be orphaned jobs left on the CFA. Without a client to refer to, the CFA will never know when to delete this information, as retention settings (recycling) is set at the client level. Therefore, the data will remain indefinitely.

File sets

CFA determines which files to backup using a file set for each client. Each file set has a number of attributes, which allow you to specify how the set is handled.

Note

The first time you click the Edit subtab on a new installation, no clients will be listed. (See Creating a Client Configuration.)

When clients are listed on the screen, you can use the check boxes to select one or more. If you select multiple clients, all settings that the clients have in common will be displayed. Any settings that are different among the selected clients (including check boxes) will be displayed with angle brackets (< >). When you save any changes that you make, only new settings will be modified for the selected clients.

When you edit any setting on the screen, a blue triangle will appear next to the changed setting, indicating that a change (delta) has occurred.

After you complete any configuration changes, click Apply to apply your settings, or click Reset to return to the original. Also, Activate Configuration to confirm all changes made.

The settings on the screen are documented in the following sections.

Note

Clients can share defined file sets. (See Shared File Sets subtab.)

General settings

Name

The Name setting corresponds to the name of the client. The name is set when you create the client; you cannot change it.

Description

The Description setting is optional, and can be used to help further identify the client. Client descriptions can include any character except double-quotes (").

Password

The system-generated client password is used to authenticate the CFA and the client software installed on each client. This password will be entered automatically into the client’s configuration file. Each client uses its client password to authenticate the CFA each time a backup or restore is performed.

If you check the Auto Generate Password check box, when you save the client, the current password will be discarded and replaced with a random password string. Be sure to update the agent with the new password if it has been changed on the client.

Push Backup Agent

Push Backup Agent allows pushing the Backup Agent and DR Image software to a Windows client. Clicking the Push Backup Agent option during client creation or from the Clients > Edit tab will start the Push Backup Agent wizard.

Push Backup Agent wizard

The push backup agent wizard will allow you to push the backup agent and DR Image software to a Windows machine. When you start the wizard it will pre-fill the CFA IP address, clients IP address, and port number.

These fields are not editable from the wizard. If you need to edit them, it is recommended to close the wizard and make the changes in the respective parts of the UI. You will need to provide credentials for an administrator level account on the desired Windows machine.

If you click on the top right of the dialog, it’ll open a pre-requisite dialog. These conditions must be met in order for the push functionality to work.

Client Networking settings

The Client Networking pane has two settings:

  • The Address setting should be either the client’s IP address or the client’s DNS name. The default setting is the value used for the Name field. If the Name value is not a valid DNS name, enter a valid DNS name or an IP address into the Address field.

  • The Port setting is the TCP port that the CFA uses to communicate with the client. Normally you don’t need to change this port; however, if you want to run multiple agents with different privilege levels on the same client, each agent will require a different port setting. The default value is 9102.

Notification settings

You can set up emails to be sent to you in System > System Alerts for all clients on the CFA. It is recommended that you use this area only if there is another contact, besides this global recipient for this specific client.

If you want the contact to receive emails about all backup activity, type your email address in the Email box. If you want this contact to receive the emails only when errors occur, check the Email only on error check box.

Note

You can include multiple addresses separated with commas.

Backup settings

The Backup pane has three settings: Schedule, Priority, and File Set.

Schedule

The Schedule setting specifies when backups will run for the client, and at what backup level (full, differential, or incremental). There are four predefined schedules. You can edit these default schedules or add your own schedules. (See Schedules subtab.).

Backup schedule Description
Quarterly Performs a full backup on the first day of January, April, July, and October; a differential backup on the first day of every other month; an incremental backup on all other days.
Monthly Performs a full backup on the first Sunday of every month; a differential backup on each subsequent Sunday of the month; an incremental backup on all other days.
Weekly Performs a full backup on every Sunday; an incremental backup on every other day of the week.
Daily Performs a full backup every day.1

You can also set Schedule to None, meaning to never automatically back up the client. You can then back up the client manually at any time. This is useful for computers, such as laptops, whose presence on the network is not guaranteed. For information on performing manual backups, see Manual Backup.

The backup levels (full, differential, and incremental) are summarized in the following table.

Backup Level Definition
Full Saves all files specified for the client, whether or not the files have been modified since the last backup.
Differential Saves all files that have been modified since the last successful full backup.
Incremental Saves any file that has changed since any previous successful backup of that file.

Note

For more information on backup levels, see Backup Level Considerations.

Priority

The priority of this client configuration relative to other client configurations when the backup system is processing multiple client configuration jobs concurrently. The priority can range from 1 to 999; lower-numbered priority jobs are performed first.

Job priorities 1 to 500 are nonexclusive—jobs will be submitted in priority order and will run concurrently, up to the number allowed by the Maximum Concurrent Jobs setting.

Job priorities 501 to 999 are exclusive—no jobs of priority 501 to 999 will run until all jobs of less than priority 501 are done. For priorities in the range 501 to 999, only jobs of exactly the same priority will run, unless a job in the priority range 1 to 500 is executed while a job in the range 501 to 999 is already running.

File Set

The File Set setting specifies what directories or files to back up. Each file set has a name and is defined for a specific operating system. The default file set for your client depends on the operating system. For example, by default, Windows clients will back up C:/, and Linux and Mac clients will back up /.

Using the File Set drop-down list, you can select a default file set based on the operating system, or you can customize your own file set (by selecting the file set having the name of the client).

Whichever file set you select, you can then click Edit to edit the file set according to your needs. This opens the File Set Editor window.

The File Set Editor window includes the following options.

Option Description
VSS To let the agent back up open files, check the check box.
Promote jobs to Full after file set configuration changes Indicates whether a full backup should be forced after the File Set configuration is changed.
Override Client-Configured Plug-in Settings Used to override the plug-in configuration. When the new control group is unselected, the override is not in effect, and all plug-in configurations are controlled through InfrascaleConfig.

Browsing for Starting Point folders

To use the file browser to find folders and files for backup and add them to the client’s file set, go to Clients > Edit, click the file set’s Starting Directories and Files entry that you want to edit. (If no entries exist, click New to create an entry.)

The list of directories to be backed up will appear, along with the Browse Client button which enables you to browse the client’s file system.

Click Browse Client and use the file browser to select a folder to add to the list.

Note

In some cases, such as when you are editing file sets from multiple clients or editing shared file sets, you may be prompted to identify, from the available clients, the single client that you want to browse.

After you accept your selection in the file browser, the selection will be added to the list of directories to be backed up for the current file set.

VSS

VSS client plug-in now supports application writers as well as the previously supported in-use files. This complete implementation of the Microsoft standard is the foundation for many new features and functionality, and it will continue to provide for greater extensibility in future releases.

By default, most application “writers” that are discovered on a client will be backed up during a backup that has VSS enabled. The following exceptions apply:

  • The Microsoft SQL Server writer is never used. SQL plug-in provided by us has a richer feature set and is the preferred method for backing up and restoring SQL data-bases.

  • System writers will be backed up if the “system state” backup option is explicitly configured to be enabled on the client. If it is not enabled, all system writers will be ignored during backup.

  • The Microsoft Exchange Server writer is only used on Exchange 2010 clients when Exchange Database backups are explicitly configured using the plug-in override controls.

You can also exclude writers from backup by explicitly specifying them as excluded in the file set.

Matchers

Matchers are used for including and/or excluding files, folders, or writers from a given file set. Below are several examples of how to configure Matchers for different purposes.

Matchers may be created when editing a file set. Below the List of directories to backup, click the New button in the blue bar.

Add a “matcher” to an existing “starting directories and files” specification. Select the Exclude option and add a “Plug-in Config”.

For each VSS writer that you want to exclude from being backed up, add it to the “matching patterns” dialog.

The format of the entries must be VSS:/name of writer where name of writer is the exact name of the VSS writer itself. (You can use the vssadmin tool provided by Microsoft to list all writers available on a particular system.)

If you click Browse Client, you can browse the writers available on the client and select a writer to add to the list.

The Starting Directories and Files area shows what directories will be included in the backup. To add new directories, click New. To delete or edit an existing directory specification, click Delete or Edit, respectively.

If you click New, a window similar to the following will appear:

Enter the directories in the upper area of the window. You can select the various default options in the lower area by checking the check boxes or using the drop-down menus.

Important

Be aware that the order of the matchers is important. For example, the job will fail if you first exclude everything and then try to include a certain folder.

Note

Matchers may be used for any file system; the examples below are written as if for Windows but could easily be converted to macOS, Linux or NetWare.

Matching examples

Example 1

This will back up the entire C:/ but will exclude any file with an .mp3 extension.

List of directories to backup: C:/

Matcher: Exclude, Case Ignore, Wild

File: \*.mp3

Example 2

This will back up everything under /departments and exclude only the /my music folders.

List of directories to backup: D:/departments

Matcher: Exclude, Case Ignore, Wild

Directory: D:/\*/my music

Example 3

This will back up everything at the /departments level and for each user, the /my documents folder and all its contents. Everything else will be excluded.

List of directories to backup: D:/departments

Matcher 1: Include, Case Ignore, Wild

Directory: D:/departments/users/\*/my documents

Matcher 2: Exclude, Case Ignore, Wild

Directory: D:/departments/users/\*/\*

Example 4

A more complex combination similar to all of the above. Mac users may recognize these paths, the C: was added just for the example.

This will backup each user’s Desktop and Documents folder. The subfolder Microsoft User Data will be excluded. Any files with .mp3 or .exe or .avi extensions will be excluded. All other directories under the starting point are excluded.

This one requires a bit more explaining. Obviously we have our starting directory and we are excluding three different file types. What is not clear is the fact that the path in Matcher 2 is a subdirectory to a path in Matcher 3. In other words, we are preemptively excluding /Microsoft User Data which is a subdirectory of the included /Documents directory. We then exclude everything else.

List of directories to backup: C:/volumes/docs/staff\_data

Matcher 1: Exclude, Case Ignore, Wild

File: \*.mp3;\*.exe;\*.avi

Matcher 2: Exclude, Case Ignore, Wild

Directory: C:/\*/Microsoft User Data

Matcher 3: Include, Case Ignore, Wild

Any: C:/volumes/docs/staff\_data/\*/Desktop; C:/volumes/docs/staff\_data/\*/Documents

Matcher 4: Exclude, Case Ignore, Wild

Directory: C:/volumes/docs/staff\_data/\*/\*

If using Regular Expressions the \* should change to .\*.

Matchers can be highly useful to trim down your backups and save space on your CFA. However, they may be a little tricky to get right on the first try. If these examples do not help your scenario or you have other questions, feel free to contact Infrascale Support for help. If you can describe exactly what you want, we should be able to help you create the matcher set to make it happen.

Note

For information on regular expressions, see POSIX Regular Expressions.

Browsing for files and folders used to define matchers

To use the file browser to find folders and files and specify them as wildcard or regular expression (matchers) for the client’s file set, go to a file set’s Starting Directories and Files entry that you want to edit. (If no entries exist, click New to create an entry.)

Find an existing matcher that you want to edit, or click New to create a new matcher. Click Add and select the type of matcher condition that you want to add.

The current list of patterns for the selected condition will appear along with the Browse Client button that enables you to browse the client’s file system.

Click Browse Client and use the file browser to select a folder or file to add to the list.

Note

In some cases, such as when you are editing file sets from multiple clients, you may be prompted to identify the single client that you want to browse.

As you browse a client, keep in mind that you must select the folder by clicking it in the Entry List pane. The selection will then appear in the Selection area at the bottom of the screen.

After you accept your selection in the file browser, the selection will be added to the list of patterns for the selected condition.

Note

You can further modify the new pattern by editing the text in the text area as needed.

DR Image settings

The Disaster Recovery Image group has the following settings:

  • Schedule. Allows to set a separate schedule to run your DR backups, independent of your file backups.

  • Priority. Allows you to set the priority of the client for Disaster Recovery Backups.

  • Volume Set. Allows to choose which volumes in Windows are captured with DR backups. These are set by specifying the drive letter that Windows has assigned to the volume.

Appliance Networking settings

From the Interface drop-down menu, select the network interface for your CFA. This tells the client which IP on the CFA to send its data to when doing a backup. This only rarely needs to be set.

If you select NAT, you are required to specify an IP address. If your CFA is behind a router doing NAT, and you have forwarded port 9103 to the CFA to let clients on the other side of that router access the CFA, you will have to put the router IP here because clients on the other side of the router will not be able to talk to the CFA IP address directly. This is a rarely used option.

Job Retention settings

These settings allow you to create a job retention period for each backup level. Jobs that exceed this retention period will be automatically deleted from the RAID, freeing the disk space they once used.

If you do not check the check box for a backup level, those backups will not be deleted but will be kept forever (or until manually deleted).

For each backup level, specify the number and use the drop-down list to select the unit (years, quarters, months, weeks, etc.).

Note

The month option reflects 30 days, not the number of days in the current calendar month. If you wish to reflect a 31 day month, it is recommended to set the recycling schedule to 31 days rather than 1 month.

If you would like to change the default retention settings for newly created clients, you may do so in Jobs > Retention.

Offsite Job Retention settings

These settings allow you to create a Job Retention policy for jobs that have been replicated offsite. These settings will only be applicable if replication is enabled.

If you would like to change the default retention settings for newly created clients, you may do so in Jobs > Retention.

Offsite settings

The Replicate checkbox selects to have the jobs for this client replicated to the cloud or secondary CFA (if replication is configured). There is also a priority number which indicates the relative importance of replicating jobs for this client comparted to other clients. Those with a lower number will be queued for replication ahead of those with a higher number.

Purge Remove Jobs checkbox selects if the jobs for this client that have been replicated to the replication target should be left in place on that target machine, or deleted when replication is disabled for this client.

Error Recovery settings

The Error Recovery group has two settings:

Setting Description
Rerun Failed Whether to rerun failed backup jobs
Recover Entries How many times to retry the backup job and at what interval

Other Actions settings

The Other Actions group has two settings:

Setting Description
Run Before Backup Use this to run a script you have set up before the backups for this client run. The script is not saved on the CFA, rather it is hosted on the server that needs to use it and the path to its location is stored here.
Run After Backup Use this to run a script you have set up after the backups for this client run. The script is not saved on the CFA, rather it is hosted on the server that needs to use it and the path to its location is stored here.

Filter the list of clients to edit

You can use the Filter drop-down list on the Edit Clients line to display only clients on the Clients Edit tab that are selected (check boxes checked), and/or have been changed (since the last you activated the configuration).

View or modify default settings of a client

To view the default client configuration (which will apply whenever you create a new client), click Defaults on the Edit Clients line.

If you want to modify the default client configuration, after you make your changes, click Apply.

When you have finished viewing or modifying your client defaults, click Defaults again.

  1. Use this schedule sparingly, because it could quickly use up your available backup space.