script language="JavaScript" src="/includes/js/ajax.js"> script language="JavaScript"> //
Skip to end of metadata
Go to start of metadata

Linux Web Server User Guide

README FIRST

Welcome to the R1Soft - Linux Web Server For Data Centers - User Guide


The purpose of this manual is to provide you with complete instructions on how to use your R1Soft - Linux Web Server For Data Centers 2.14 - software.

To find a specific topic in a particular section, click on the topic name in the Table of Contents.

Common Questions

You may want to view our list of common questions located in:

Common Questions

Table of Contentsts

Common Questions

Below is a list of common questions specific to using your R1Soft Linux Web Server For Data Centers 2.14 software. Each set of questions is categorized for you to quickly find what you need. Each question is linked to a document with further information.


Hosts

See also:  Linux CDP Data Centers Getting Started Guide.

Devices

Disk Safes

Backups

Recovery Points and Disk Recovery Points

Restoring Files

See also: Linux Bare-Metal Restore - Common Questions.

Tasks

Users

Hosts

About Hosts

Hosts are computers and servers that are being backed up. Hosts run the CDP Agent and accept connections from the CDP Server for Backup and Restore. Host's hard Disks, Partitions, and other Volumes are mounted as Devices (Linux Web Server - Devices). Quotas can optionally be set limiting the Disk usage of a Host (Linux Web Server - Host Quotas).

Users with the appropriate permission can add new Hosts. By default, when a User adds a Host, this User is automatically added as an Administrator for the Host with Full Control. New Host Administrators can be added and their permissions can be changed. Host Administrators can have permission to change and delete Hosts.

Read more in:

Host Quotas

You can optionally set Quotas to limit the Disk usage of a Host. A Host level Quota applies to all data storage used by a Host including all of a Host's Disk Safes. When a Quota is reached, the Backup process will be interrupted and fail.

To limit a User's ability to change their own Quota, refer to Host Administrator.

For more information on how to change a Host's Quota, see Changing Hosts.

Devices

Righteous Backup refers to a Host's Hard Disks and Partitions where file systems can be mounted as Devices. A Device is a Partition (or Partition Table) on a Host eligible for Backup. Righteous Backup can back up any Device with a supported file system. For example, Windows Host can have the following Devices, all or some of which can be selected to be backed up:

/dev/sda1

Disk partition is a separate division of a hard disk drive. A PC hard disk can contain up to four partitions. All these partitions are described by 16-byte entries that constitute the Partition Table. Partition Tables and partitions are taken by the CDP Server as separate Devices.

The Devices can have the following properties:

  • Enabled/Disable - Option provided by CDP Control Server. Disabled Devices are excluded by Backup Tasks.
  • Disk - Equal to Disk's Partition Table. Partition Tables are internal address tables used to locate information.
    In Windows Hosts, the Disk names have the following format within the System: Disk 0, Disk 1, Disk 2, etc.
    Linux example:
    /dev/hda.
  • Partition- In Windows Hosts, partition name within the System includes Disk number plus the word "Partition" with number starting from 0. The following format is used: Disk 0 Partition 0, Disk 1 Partition 0, etc.
    Linux examples:
    /dev/hda1, /dev/hdas, etc.
  • Mount Point - In Linux, it is the Partition location in the operating system's directory structure.
    Linux example:
    /boot.
    The equivalent to mounting in Microsoft Windows is known as mapping a drive.
    Windows Example: C:\, D:.
  • Type - File system type. Examples: Partition Table, NTFS, swap, ext2/ext3.
  • Size  - Example: 39.99 GB, 196.11 MB.

These properties are displayed in a table on the Host's Devices screen.

If your Devices have been backed up, you can see the Disk Recovery Points and Recovery Points in Linux Web Server - The Disk Safe Browser

Read more in:

Adding Hosts

After you have copied the Web Server's Public Key to the Agent (see Activating the Agent), you can add a new Host to your Web Server. Hosts are computers and servers that are being backed up.

Note
You can add both Windows and Linux Hosts. The number of Hosts you can add is defined in the properties of the Host's Volume.
Notice
Volumes must be added before creating Hosts. See Linux DC - Adding Volumes.

Follow the instructions below to add a new Host to your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page typically loads after you log in to the system.

3. Click on "New Host".

4. When the "New Host" page has loaded, define the Backup-related settings specific to each Host.

The following settings are available for the "New Host":

Network Settings:

  • Host Name or IP - Enter the Host Name or IP address of the Host.
  • Host Description (New in Version 2) - Enter a description for the Host. The Description will be displayed in the Host List and used for control panel authentication.
  • Host Type - Select the Host's operating system and license type from the drop-down menu (Windows or Linux).
  • Remote Port (New in Version 2) - Define a Port to connect to the Agent.
    Note
    Default is usually defined by the system administrator in Options Server Settings Agent Settings.
    Read more in Linux Control Server - Agent Settings.
  • Timeout (New in Version 2) - Define a Timeout to connect to the Agent.
    Note
    Default is usually defined by the system administrator  in Options Server Settings Agent Settings.
    Read more in Linux Control Server - Agent Settings.
  • Use Default Network Settings (New in Version 2.5.x)- Check this box to use the default Remote Port and Timeout.
    Note
    Defaults are usually defined by the system admin in Options Server Settings Agent Settings.
    Read more in Linux Control Server - Agent Settings.

Licensed Add-on Modules:

  • Enable Control Panel Module - Select this check box to enable the control panel module.
    Note
    Available only for Linux hosts.
    Read more in the Hosting Control Panel Add-On Admin Guide and Hosting Control Panel Add-On User Guide.
  • Enable CDP for MySQL Module- Select this check box to restore MySQL databases separately from another Host's information. Available only for Linux hosts.
    Note
    You need to buy a license to use this module.
    Read more in the CDP for MySQL User Guide.
  • Enable Archiving Module (New in Version 2.9.0) - Select this check box to enable the Archiving add-on.
    Note
    You need to buy a license to use this module.

Storage Settings:

Other Options:

  • Create Disk Safe - Checked by default. Verify that the "Create Disk Safe" box is checked.
    Note
    If the check box is selected, a Disk Safe will be created after you enter the Host information. A Host must have a Disk Safe before any Backup jobs will run.
  • Disable Host After Creating - Select this check box to disable the Host.

5. Click on "OK" to continue.

6. Create a new Disk Safe for the Host. For more information, see Creating Disk Safes.

7. After the new Host and Disk Safe have been created, you can view the summary page for the added Host. If needed, you can change the Host properties by clicking on "Change". Read more in Changing Hosts.

Note
After a new Host has been added to the system, a Host Discovery Task is automatically run. The Host Discovery Task adds a new Host to the Backup system and discovers Devices available for Backup. Read more in Host Discovery.

8. Click on "History" in the Main Menu to view the status of the Host Discovery Task that was automatically launched when the Host was added.

Note
If the Host Discovery Task was successful, a green icon ( ) will be displayed under "State" on the "Task History" page.

Note
If the Host Discovery Task was not successful, an error indicator ( ) will be displayed. You can click on the Task name to view the error message at the bottom of the page.

Notice
You have activated the Agent (see Activating the Agent) and your Host has been successfully discovered. Now the Host is ready to be backed up immediately. There is no need to restart any service or execute any command.

Changing Hosts

A Host has the following properties as described in Linux Web Server - Adding Hosts:

  • Enabled
  • Host Name or IP
  • Host Description (New in Version 2)
  • Host Type
  • Remote Port (New in Version 2)
  • Timeout (New in Version 2)
  • Use Default Network Settings (New in Version 2.5)
  • Enable Control Panel Module
  • Enable CDP for MySQL Module
  • Enable Archiving Module (New in Version 2.9)
  • Volume (Note: The Volume can not be changed.)
  • Enforce Disk Safe Storage Quota
  • Hard Limit

Follow the instructions below to change Host properties in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Change" to view the Host options in edit mode.

5. When the "Edit" page has loaded, set the options. Descriptions of the options are provided in Adding Hosts.

6. When you have finished making the necessary changes, click on "OK".

Deleting Hosts

Deleting a Host will delete all of the Host's Disk Safes. The Host itself is actually not completely deleted from the system. Instead, it becomes hidden and can not be found using the Web Interface. A Delete Host Task is responsible for deleting all of the Host's Disk Safes. You can check the status of the Delete Host Task on the "Global Task History" page. Read more in About Tasks and Accessing the Global Task History. Another Host having the same Host Name can not be added to the system until after the Delete Host Task is finished. If an error occurs when deleting the Host, the Delete Host Task will fail and the Host will become visible again in the Web Interface.

Follow the instructions below to permanently delete a Host in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Confirm your request to permanently delete the Host and all its Backups by clicking on "OK".

Host Discovery

After a new Host is added to the system, a Host Discovery Task is automatically run.

The Host Discovery connects to the Host's CDP Agent to complete the process of adding the Host to the system. The mounted Hard Disks and Partitions (called "Devices") of the Host are automatically imported into the system, and Devices with supported file systems become eligible for Backups.

Note
If new Hard Disks or Storage Devices are mounted on the Host, running a fresh Host Discovery Task automatically imports them into the Web Server. See Linux Web Server - Adding Devices.

During the Host Discovery process, the CDP Agent's RSA Public Key is stored and checked for uniqueness in the CDP Server. A Host cannot be added twice to the same CDP Server.

Notice
No Backup or Restore Tasks can run until the Host Discovery process is complete.

Checking the Status of the Host Discovery Task

You can check the status of the Host Discovery Task on the Task History page. Read more in Linux Web Server - Task History.

Initiating a Host Discovery Task

If new Hard Disks or Storage Devices are mounted on the Host, running a fresh Host Discovery Task automatically imports them into the Web Server.

Notice
A Host can be discovered successfully after you copy the CDP Server's Public Key to the Agent. Refer to the Activating the Agent.

Follow the instructions below to initiate a Host Discovery Task in your Windows Web Server For Data Centers.

1. Open the Web browser connecting to the Windows Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Host Discovery".

5. When the page has loaded, the Host Discovery Task is displayed.

Failures During Host Discovery

Failures during Host Discovery are typically caused by:

  • the Host not being online
  • the Host not being configured correctly to accept requests from the CDP Server

See Activating the Agent for more information.

Note
If the Host Discovery fails, it is automatically scheduled to retry later. The time between retries is lengthened as the number of failed attempts increase.

Testing Agent Connectivity

Follow the instructions below to test connectivity between your Host and the Windows Web Server For Data Centers.

1. Open the Web browser connecting to the Windows Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Test connectivity between the CDP Server and Agent by clicking on "Test Agent" on the "Host" page.

5. To start the test, click on "Start Test".

Notice
Tests usually complete in less than the specified Timeout. If not, there is a problem connecting to the Agent. See Agent Connectivity Troubleshooting.
Note
Once installed, the CDP Agent runs as a daemon and listens on TCP port 1167 for requests from CDP Servers. Port and Timeout values are specified in the Host properties. Default values are defined in Options Server Settings Agent Settings.

6. The result will be displayed as shown below.

Agent Connectivity Troubleshooting

The possible errors that can occur during Testing Agent Connectivity are listed below.

ERROR: Failed to connect to (x.x.x.x) after (5) seconds

Possible Causes:

  • The Agent is not running or is not installed.
  • The Host you are trying to connect to is not online or is not accessible over the network.
  • There is a network or Host based firewall preventing the CDP Server from connecting to the Agent on TCP port 1167.

ERROR: This server not in agent's allow list

The Agent is not properly configured to accept connections from this CDP Server. This is usually caused when the Agent's server.allow directory (default: /etc/buagent/server.allow) does not have a file named with the CDP Server's IP address. This file must contain the CDP Server's RSA Public Key.

Refer to Activating the Agent for more information.

ERROR: Access to agent denied. Wrong RSA key

The Agent is not properly configured to accept connections from this CDP Server. There is a file in the Agent's server.allow directory named with the IP address of the CDP Server, but it does not contain the correct RSA Public Key.

Refer to Activating the Agent for more information.

Launching Quota Check At Host Level

New in Version 2.5
You can run a Host Quota Check manually.

Follow the instructions below.

Note
The Host Quota Check Task performs a Quota Check for a Host and all of its Disk Safes comparing actual Disk usage to the usage recorded in the Quota. This Task can fix Quota discrepancies that might occur when the Backup System is uncleanly shutdown.

1. Open the Web browser connecting to the Web Server Web Interface and log in.

2. Click on the "Hosts" tab in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads automatically after you log in.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. When the Host properties page has loaded, click on "Quota Check".

5. You will be redirected to the "Host History" page.

6. The Task Log Messages will be displayed at the bottom of the page.

Cleaning Up Host Log Files

Follow the instructions below to create a scheduled Host Log Cleanup Task for a Host in your Windows Web Server.

New in Version 2.5
There is a System-wide setting to automatically create a scheduled Host Log Cleanup Task for newly created Hosts. This default setting can be defined by administrators in Options Server Settings Agent Settings Create Log Cleanup Task For New Hosts.
See Linux Control Server - Agent Settings.
Note
You can find out if there is a scheduled Host Log Cleanup Task already created for your Host on the Host Scheduler page (see Linux Web Server - Accessing the Host Task History). You can also change the Task properties on the Host Scheduler page.
Read more in R1D:Windows Web Server - Editing Scheduled Tasks] and Linux Web Server - Disabling and Enabling Tasks.

1. Open the Web browser connecting to the CDP Server Web Interface and log in.

2. Click on the "Hosts" tab in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads automatically after you log in.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". Or you can click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. On the Host properties page, click on "Clean Up Log Files".

5. Define the following Task properties:

Note
Last Edited By - The User that last changed the settings for the Task.
  • Enabled - Select the check box to enable the scheduled Backup Task.
  • Description - Enter a name you can use to recognize this Task apart from other scheduled Backup Tasks.
  • Recurrence - Select the Recurrence Type from the drop-down menu (Now, Minutely, Hourly, Daily, Weekly, or Monthly).
  • Recurrence Settings

In our example, we used "Weekly." For "Weekly" Recurrence you need to define the following settings:

  • Start Time - Specify the start time in hours and minutes by selecting the appropriate number from the drop-down menu.
  • Sunday to Saturday - Specify the day(s) of the week by selecting the appropriate check box(es).

Log Cleanup Options:

  • Delete logs older than: x days - Enter a number of days in the text box. The logs older than the entered number of days will be deleted.
    New in Version 2.5
    There is an option for the default number of Host Log Rotation Days, which can be defined by administrators in Options Server Settings Agent Settings Default time to retain logs (days).

6. Click on "OK" to save the scheduled Host Log Cleanup Task.

Adding Devices

The Web Interface provides a way to add the Devices and Partitions to the Web Server. The easiest way to update this list, and reflect the changes in hardware configuration on your Host, is to rerun the Host Discovery. See Host Discovery.

Follow the instructions below to run the Device Discovery in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". Or you can click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Devices" in the "Host" Menu.

5. When the page has loaded, all of the Devices will be displayed.

6. Click on "Run Device Discovery".

7. When the page has loaded, all found Devices will be displayed.

Displaying Devices

Follow the instructions below to display the Devices of a Host in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". Or you can click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Devices" in the "Host" Menu.

5. When the page has loaded, the Devices are displayed in a table containing the following information:

  • Enabled
  • Disk
  • Partition
  • Mount Point
  • Type
  • Size
  • Actions - The ability to enable or disable the Device.

Disabling Devices

Follow the instructions below to disable Devices in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Devices" in the "Host" Menu.

5. To disable a Partition or entire Device, click on the "Disable" link under "Actions" corresponding to the appropriate Device or Partition.

Adding Host Administrators

Adding an Administrator to a Host involves the following two (2) steps:

  • Adding an Admin to a Host
  • Setting the Host Admin permissions
    Note
    By default, a Host Admin is given Admin permissions.

    Follow the instructions below to add a Host Administrator in your Windows Web Server For Data Centers.

    Note
    You must have Admin privileges on a User to be able to add them as an Admin to a Host.

    1. Open the Web browser connecting to the Windows Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Administrators" in the "Host" Menu.

5. When the page has loaded, all current Host Administrators are displayed. Click on "Add Administrators".

6. When the page has loaded, select the User(s) to add from the "Search Results" box or by entering the Username(s) in the "Username" text box, and clicking on "Search".

Note
The "Add Administrators" page will display a list of Users that you can add. If the list of eligible Users is short, the entire list will be displayed for you to select from. If the list is large (likely if you are a Super User), no Users will be displayed and you will be required to search for a User by "Username."

7. Click on "Add" to the right of the "Search Results" box to add the selected User(s) to the "Administrators" box.

8. Click on "Done" to save.

Editing Host Administrator Permissions

Follow the instructions below to change Host Administrator permissions in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

Note
To find a Host, you can use the Host List Filter.

4. Click on "Administrators" in the "Host" Menu.

5. When the page has loaded, all current Host Administrators are listed in the "Administrators" box.

6. Select the User you want to edit from the "Administrators" box.

7. The page will reload and the permissions for the selected User are displayed below the "Administrators" list. Define the permissions you want to assign to the selected User by selecting the corresponding check box.

The following Permissions are available:

  • Full Control
  • Admin
  • Restore
  • Backup
  • Can Change Quota
    Note
    The permissions are described in detail in Host Administrator.

8. When finished, click on "Update".

Disk Safes

About Disk Safes

A Disk Safe is a Differential Block Storage Container. This technology was invented by Righteous Software to support the storage of Incremental Disk Images at the sector level, encryption, and/or compression of variable length block sizes. The system delivers fast access to any Incremental as if it were a complete Disk Image with performance comparable to the native file system. Disk Safes allow any Incremental to be deleted, freeing up the Disk space consumed by the Incremental, while still maintaining the dependent sectors used by other Incremental Disk Images.

New in Version 2
The Disk Safe data file page heap is now stored in its own file, providing a solution for the slow loading of large or highly fragmented Disk Safes.
New in Version 2
Disk Safes are now multi-threaded, so file indexing ("Make File List" Task) for browsing while the Disk Safe is in use is no longer necessary.
Notes
  • You can not backup a Host until it has at least one (1) Disk Safe.
  • New Backups can only be stored in the most recent Disk Safe. See Creating Disk Safes.
  • You can restore from any available Incremental in any Disk Safe.

Read more in:

Disk Safe Compression

Disk Safes use zlib also known as gzip compatible compression and are capable of delivering about a 2:1 compression ratio for most environments. Compression is performed at the Hard Disk sector level on the Host during a Backup by the CDP Agent. The compressed Disk sectors are sent over the network and stored in compressed form in the Disk Safe. Compression can be used on its own or in combination with encryption.

Not all data compresses well, such as zip files or other media that is already highly compressed. Sometimes the compressed results are actually larger than the uncompressed data. This scenario is automatically detected and the data chunks are not compressed.

The Compression Levels are as follows:

  • No Compression
    Note
    We recommend "No Compression" to complete Backups in the shortest amount of time over fast LANs (Local Area Networks).
  • Compression 1 Through 9
    Note
    Nine (9) is the highest level of compression.

For Backups over the Internet or other slow links we recommend using compression.

We recommend level 1 as it will deliver close to 50% compression on most data. The higher levels will yield better compression at a significant cost in time and CPU usage.

Disk Safe Defragmentation

Disk Safes store data in a similar manner as a file system, such as ext2 or NTFS. The difference is that Disk Safes store all of the data in a small set of files on top of the file system on the CDP Server. Much like deleting a file in a file system, when you delete a Recovery Point, it does not actually reduce the space used by that Disk Safe on the hard Disk. Space freed by deleting is available for new files, or in this case, new Backup Images.

When a Recovery Point is deleted, the portions of the Disk Safe occupied by the Incremental are marked free and available to store future Backup Data. This means that after deleting an Incremental the files comprising your Disk Safe still consume the same amount of space on the CDP Server's file system. After deleting an Incremental, your Disk Safe will still consume the same Disk usage and the space will still count against any Quotas used by the Host and/or Volume associated with the Disk Safe.

Much like a file system, the Disk Safe can be resized. This happens automatically in the background when data is added to the Disk Safe and there is no more free space. The files are grown and new space is accommodated in small chunks called pages. Fortunately, growing a Disk Safe is fast and easy and it occurs automatically as needed. Much as when defragmenting a hard Disk, defragmenting or shrinking the Disk Safe is not easy and can involve relocating data in the Disk Safe.

Normally, Disk Safes never need to be defragmented as data storage usually increases with time. As old Incrementals are deleted, they free up space to store the data associated with a new Incremental. The scenario that usually requires a defragmentation of a Disk Safe is when a Host reduces its Disk usage substantially.

Example Scenario: You have a Partition on your Host that uses 50 GB of data. You discover that you do not want or need much of the data anymore. After cleaning things up, you get the Disk usage down to 10 GB and make another Backup. Let us assume you take daily Backups of your Host and only keep the last 7 days. After 7 days of Backups at the new lower usage level you will have rotated out all Backups containing the deleted data. At that point a large portion of your Disk Safe would be empty and defragmenting your Disk Safe to reduce its Disk usage is now recommended.

Defragmenting Disk Safes Is Important in CDP Server 2.x

Due to the change in caching techniques in CDP Server 2.x, keeping your Disk Safe defragmented is now of greater importance. CDP Server 1.x caches open parts or pages of the Disk Safe files in memory, which helped increase performance. However, this method was driving memory usage up, some times as much as 50-75 MB per Backup Task. In CDP Server 2.x, you can get adequate performance without all of the page caching. The trade-off is that as you free Recovery Points, small portions of your Disk Safe files become free. This causes your Disk Safe files to also become fragmented which can cause lots of Disk seeks and reduce Disk throughput on your CDP Server.

The CDP Server provides an option to define the lowest percentage of free space that can trigger a Disk Safe defragment operation. The default for the new 2.x version installation is 0% (no limit). It is recommended that you set this option to 0% as it will allow you to configure Disk Safes to reduce fragmentation as much as possible.

Refer to "Storage Settings" in the CDP Server Admin Guide.
After your System-wide Minimum Free Space Threshold is correct, make sure that automatic Disk Safe defragmentation is enabled for all of your Disk Safes. Also, confirm that the threshold values are 0% or 1%. If your Disk Safe has more than 1% of wasted or free space, a defragmention will be launched. This function will shrink and optimize your Disk Safe files after every Backup operation.

Note
For example, 1% of a 500 GB Disk Safe is a lot of fragmentation.

Read more in Linux Web Server - Enabling Automatic Defragmentation.

Disk Safe Encryption

The Disk Safe where you store the backed up data has the option to "Use Encryption." This option can be enabled while creating the Disk Safe.

Encryption of the Disk Safe can not be disabled at a later time. Only the passphrase can be changed for the Disk Safe. If you no longer need encryption, you have to create a new Disk Safe. After you click on "Change Passphrase" located on the Disk Safe edit page, you are able to access the following page:

Disk Safes currently support encryption using 128-bit RSA Keys and the Blowfish Cipher for symmetric encryption. There are plans to add other encryption ciphers and key size options in the future. When the CDP Agent is first installed, a unique RSA Key and Symmetric Blowfish Cipher Key is generated. These Keys are used when encryption is enabled.
The default installation location for these files on the CDP Agent is

/etc/buagent.

The PEM encoded RSA Key is

rsa.key.

The Symmetric Blowfish Key is stored with a SHA-1 checksum and encrypted with the RSA Key.
When encryption is enabled for a new Disk Safe, an Encryption Setup Task is run. The Encryption Setup Task connects to the Agent and downloads a copy of the Agent's RSA Key and Backup Key over the encrypted socket established between the CDP Server and Agent. The RSA Key is stored in the Disk Safe and encrypted using the passphrase specified during Disk Safe creation. The RSA Key and Backup Key stored on the CDP Server are used to run MakeFileList Tasks and Restore encrypted files. They are also sent to the CDP Agent during a Bare-Metal Restore to decrypt your Disk Image. The RSA Key and Backup Key stored on the server are useless without the passphrase.

Notice
Righteous Backup has strong encryption. If the passphrase used to protect an encrypted Disk Safe is lost, there is no way to recover the data.
More Information
Check related articles from the Knowledge Base:
Page: Why Recreate a Disk Safe (Archived Knowledge Base)
Page: Bare-Metal Restore from an Encrypted Disk Safe (Knowledge Base)
Page: Restoring Files From An Encrypted Disk Safe (Archived Knowledge Base)
Page: Disk Safe Browser - Error Reading File System (Archived Knowledge Base)
Page: Restoring Encrypted Files (Archived Knowledge Base)
Showing first 5 of 6 results

and more: label encryption.

Creating Disk Safes

Note
A Host must have a Disk Safe before any Backup jobs will run.

Follow the instructions below to create a Disk Safe in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter

4. Click on "Disk Safes" in the "Host" Menu.

5. Click on "New Disk Safe" on the "Disk Safes" page.

Note
If you are creating a new Disk Safe for a Host with an already existing Disk Safe, you will be warned that your next Backup will take a new Seed Image of all Partitions on the Host. If you want to proceed, click on "Continue".

6. When the "Start New Disk Safe" page has loaded, define the following settings specific to the new Disk Safe:

  • Compression Level - Define the level of compression for the Disk Safe.
    Note
    This setting can be changed later.

    See Linux Web Server - Disk Safe Compression for more details.

  • Defragment if free space exceeds x - Select the check box and a value from the drop down menu. This setting limits the free space to "X." The Defragment Task runs when the free space limit is reached. The Defragment Task shrinks the unused space by deleting or rotating out unwanted Incremental Backups in your Disk space. The Defragment Task reduces the Disk usage counted against Quotas. If your Disk Safe has more than the selected percent of wasted or free space, defragmentation will be launched. This Task will shrink and optimize your Disk Safe files after every Backup operation.
    Note
    Recommended. This setting can be changed later.

    For more information, see Disk Safe Defragmentation.

Encryption:

  • Use Encryption - Select the check box to enable encryption for the Disk Safe. This setting allows the Backup Data to be encrypted during the storage process.
    Notice
    Once a Disk Safe with encryption enabled is created, only the passphrase can be changed.
    Notice
    Encryption cannot be disabled at later time without creating a new Disk Safe.

    For more information, refer to Disk Safes Encryption.

7. Click on "OK".

Defining Disk Safe Settings

You can change the following settings for the existing Disk Safe:

  • Compression Level
  • Defragment if free space exceeds x
  • Encryption
    Note
    The settings are described in Creating Disk Safes.

    Follow the instructions below to change the Disk Safe settings in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Disk Safes" in the "Host" Menu.

5. Select the Disk Safe you want to change the settings for, using the "Disk Safe" drop-down menu. Click on "Open".

6. After selecting the Disk Safe, define the following settings:

  • Compression Level
  • Defragment if free space exceeds x
  • Encryption
    Note
    The settings are described in Creating Disk Safes.

7. Click on "Update" to save the settings.

Enabling Automatic Defragmentation

Disk Safes can be defragmented automatically after a Backup Task and after any Backups are deleted or rotated out. When the percentage of free space in the Disk Safe exceeds the "Limit free space to" setting, a Defragment Task will be launched and your Disk Safe will be reduced as much as possible. Read more on this topic in Disk Safe Defragmentation.

Follow the instructions below to enable automatic defragmentation for a Host in your Linux Web Server For Data Centers.

Notice
It is recommended that you enable defragmentation for all of your Hosts in Version 2.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Disk Safes" in the "Host" Menu.

5. Select the Disk Safe you want to enable automatic defragmentation for, using the "Disk Safe" drop-down menu. Then click on "Open".

6. On the Disk Safe properties page, select the check-box beside "Defragment if free space exceeds" and set the value to the recommended value of "0%" or "1%."

Note
The minimum possible value you can select is defined by the system administrator in Options > System Settings > Storage Settings.
Read more in Storage Settings.

7. Click on "Update".

Notice
If you have never defragmented your Disk Safes, the first time may take hours (much like defragmenting a Hard Disk). Once the defragmentation process runs automatically, it will be much faster.

Deleting Disk Safes

Deleting a Disk Safe will launch a Delete Disk Safe Background Task. The Background Task will delete all of the files used by the Disk Safe. You can check the status of the Delete Disk Safe Background Task on the "Global Task History" page.

Follow the instructions below to permanently delete a Disk Safe in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under"Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Disk Safes" in the "Host" Menu.

5. Select the Disk Safe you want to change the settings for using the "Disk Safe" drop-down menu. Then click on "Open".

6. Click "Delete".

7. Confirm your request to permanently delete the Disk Safe by clicking "OK" on the next screen.

Incremental Backups

About Backups

R1Soft CDP Server 2.0 uses the Incremental Backup method when each original piece of backed up information is stored only once, and any successive backups only contain the information that has changed since a previous backup. Read more in Backup Method - Incremental Backup (Technical Papers.)

A Backup within the System is a Task that can be scheduled and completed automatically depending on the defined Recurrence Type (Minutely, Daily, Hourly, Weekly, or Monthly) and other options. A Backup can also be completed once without scheduling (Now).

Before scheduling a Backup of your Host, you need to create a Disk Safe (Creating Disk Safes). By default, you are prompted to create a Disk Safe after adding a new Host (Adding Hosts).

After you start the Backup task, you can check its status on the "Global Task History" page. Read more in Creating Backups, Accessing the Global Task History.

When you have finished your backups, you can access them via Disk Safe Browser which lists all Disk Safes, Devices, and Incrementals

More Information
Check related articles from the Knowledge Base:
Page: MySQL 5.5.10 - Unable to Find any Databases During Replication (Knowledge Base)
Page: How to change the location of the backing file in a replication policy. (Linux Agents) (Knowledge Base)
Page: High-Speed Bandwidth and Backup Performance (Archived Knowledge Base)
Page: Speeding Up Backup Process (Archived Knowledge Base)
Page: Backup Tasks Take a Long Time (Archived Knowledge Base)
Showing first 5 of 14 results

and more: label backup.

Backup Rotation Policies

Each scheduled Backup Task can have an associated Rotation Policy. This policy is defined when creating the Task or changed by editing the Backup Task.

When defining a Backup Task, you can specify the number of Recovery Points to keep. After the next successful backup the oldest Recovery Points will then be deleted.

Rotation Policy Task is responsible for deleting Recovery Points. After a scheduled Backup has finished successfully, the Rotation Policy Task runs and checks all Incremental Backups (=Recovery Points) created by the Backup Task and deletes the oldest Recovery Points until only the last X Recovery Points remain as defined in the Backup Task. The Rotation Policy Task counts only the Recovery Points created by Backup Task with the same recurrence. Read more in Linux Web Server - Creating Backups.

Note
A locked Recovery Point will be skipped by the Rotation Policy and will remain a part of the Disk Safe until it is unlocked. Read more in Linux Web Server - Locking Recovery Points.

Rotation Policies can be defined based on the following Recurrence Types:

  • Minutely
  • Hourly
  • Daily
  • Weekly
  • Monthly

Backup Rotation Policy Examples

  • Hourly - If you define a Backup Task with a Hourly Recurrence called Hourly and specify to only keep the last 24 Recovery Points, then every time a Backup is performed the oldest Recovery Points will be deleted until there are only 24 left. Only Recovery Points created by the Scheduled Task described as Hourly will be counted in the 24 and be eligible to be deleted.
  • Daily - If you define a Backup Task with a Daily Recurrence called Daily and specify to only keep the last 7 Recovery Points, then every time a Backup is performed the oldest Recovery Points will be deleted until there are only 7 left. Only Recovery Points created by the Scheduled Task described as Daily will be counted in the 7 and be eligible to be deleted.

The Disk Safe Browser

The Disk Safe Browser allows you to browse your Disk Safes, Devices, and Incremental Backups (Disk Recovery Points and Recovery Points) in a file system tree. You can also select combinations of files and directories to restore in the Disk Safe Browser.

See also:

Disk Safe Browser Modes

The "Browse" page has three (3) modes in the drop-down menu at the right:

  • Restore Files - Use this mode to manage Incremental Backups and select individual files to Restore.
    Note
    Restore Files is the default Disk Safe Browser Mode.
  • Archive Files - This option provides a possibility to extract data from the Disk Safes and to save this data to the specified destination.
    Read more in Archiving Add-On User Guide.
  • Download Files as Archive - This option allows you to have single or multiple files or a Recovery Point from a Disk Safe on your local computer.
    Read more in Archiving Add-On User Guide.

Recovery Points and Disk Recovery Points

An Incremental Backup used by R1Soft CDP Server 2.0, is a backup method where multiple backups are kept (not only the last one); such Incremental Backups only contain the information that has changed since a previous backup.

Disk Recovery Point is backup data (incremental backup image) of a Disk created by one (1) Backup Task. Read more in Linux Web Server - Devices. Disk Recovery Points are displayed as the child level to Disk Safe in the Disk Safes Browser:

Recovery Point is backup data (incremental backup image) of a Partition created by one (1) Backup Task. Read more in Linux Web Server - Devices. Recovery Points are located under the Disk Recovery Points in the Disk Safes Browser:

The system delivers fast access to any Incremental Backup (Recovery Point) as if it were a complete Disk Image with performance comparable to the native file system. Disk Safes allow any Recovery Point to be deleted, freeing up the Disk space consumed by the Recovery Point, while still maintaining the dependent sectors used by other Disk Recovery Points.

Read more in:

Creating Backups

Follow the instructions below to create (schedule) a Backup in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. When the page has loaded, you should see the "Hosts" tab of the interface. If the "Hosts" page does not appear, click on the "Hosts" tab.

Note
The "Hosts" page normally loads automatically after you log in.

3. Select the Host you want to Backup by clicking on the appropriate Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

4. Click on "Backup and Restore" in the "Host" Menu.

5. Click on "Schedule Backup". 

6. The "Schedule a new Backup task" page will load. Define the following settings specific to the new Backup Task:

  • Save Task - Select the check box to save the Backup Task.
  • Enabled - Select the check box to enable the Backup Task. 
  • Description - Enter a name you can use to distinguish this Task from other scheduled Backup Tasks. 
  • Recurrence - Define the schedule and frequency for the new Backup Task. If you want to run a Backup immediately, leave the default "Now" selected in the drop-down menu. 
    For more information, refer to Recurrence Types

Backup Task Options:

  • Only keep the last X recovery points - Select the check box to enable the Rotation Policy and define the Rotation Policy in the text box.
    See Backup Rotation Policies for more information.
  • Verify recovery point when finished - Select the check box to verify the Recovery Point upon completion of the Backup.
    New in Version 2.x
    The "Verify" option for Backup only verifies the last Recovery Point instead of all the Recovery Points.
  • Devices Selected for Backup - Select the check box(es) beside the Devices you would like to Backup.
    Read more in Devices

7. Click on "OK" to save the Backup Task.

Accessing the Disk Safe Browser

The Disk Safe Browser is defined in The Disk Safe Browser.

Follow the instructions below to access the Disk Safe Browser in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click "Browse" in the "Host" Menu.

5. The Disk Safe Browser will be displayed.

Note
"Restore Files" is the default Browser mode. Read more in Linux Web Server - The Disk Safe Browser.

Verifying Disk Safes

Follow the instructions below to manually start the "Verify Disk Safe" Task in your Linux Web Server For Data Centers.

Note
Backup Task screen allows you to enable an option to start the "Verify Disk Safe" Task after the Backup Task will be finished.
New in Version 2.x
The "Verify" option for Backup only verifies the last Recovery Point instead of all the Recovery Points.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Browse" in the "Host" Menu.

5. The Disk Safe Browser loads. All of your Disk Safes will be listed on the right.

Note
Read more in The Disk Safe Browser.

6. Click on the "Verify" link corresponding to the appropriate Disk Safe.

Note
You can select the "Verify" option for a particular Recovery Point. In this case the Verify Disk Safe task will work only with the selected Recovery Point, not with all Recovery Points of the Disk Safe.

7. The "Schedule a new Verify Disk Safe task" page will load.

8. Define the following parameters for the new Verify Disk Safe Task.

  • Save Task - Select the check box in the Task Scheduler to save the Verify Disk Safe Task to be completed next time. If you do not select the check box, the other parameters will not be available and the Task will be completed only one (1) time right after you click on "OK".
  • Enabled - Select the check box to enable the Task to be completed.
  • Description - Enter a description to be displayed in the Scheduler list.
  • Recurrence - Select "Now," "Minutely," "Hourly," "Daily," "Weekly," or "Monthly" from the drop-down menu.
  • Verify Disk Safe Options - "(X)" indicates the Disk Safe that will be verified.
    Note
    In this example, "(X)" is the Disk Safe "(0)."

9. Click on "OK" to save/complete the Task.

10. If you selected to run the Task "Now," the Task will start immediately and the History page is displayed.

11. You can view the selected Task Log Messages at the bottom of the page.

Repairing Disk Safes

Follow the instructions below to repair Disk Safes in your Linux Web Server For Data Centers.

New in Version 2.x
The "Disk Safe Repair" feature repairs Disk Safes automatically if there is an unclean shutdown.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on the "Hosts" tab in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Select the "Browse" tab in the "Host" Menu.

5. The Disk Safe Browser opens. All of your Disk Safes are listed on the right.

Note
Read more in The Disk Safe Browser.

6. Click on the "Repair" link corresponding to the appropriate Disk Safe.

7. The "Disk Safe Repair Task" screen will open. You have a possibility to define the following options for the Disk Safe Repair Task:

  • Save Task - Select the check box in the Task Scheduler to save the Repair Disk Safe Task to be completed next time. If you do not select the check box, the other parameters will not be available and the Task will be completed only one (1) time right after you click on "OK".
  • Enable - Select the check box to enable the Task to be completed.
  • Description - Provide a description of the Email Reporting Task in the text box provided.
    Note
    The description will be displayed in the "Description" column on the "System Tasks" page.
  • Recurrence - To schedule the Task, select the appropriate value from the drop-down menu: "Now," "Minutely," "Hourly," "Daily," "Weekly," or "Monthly." The default value is "Now."

8. Click on "OK".

9. If you do not save the Task, it will be run immediately and you will move to the "Host History" screen.

Managing Disk Recovery Points

Follow the instructions below to manage the Disk Recovery Points in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Browse" in the "Host" Menu.

5. The Disk Safe Browser page will load.

6. Select a Disk Safe from the file system tree on the left.

7. Select a Device (Disk) from the file system tree on the left.

8. The following information is displayed in the table when viewing a list of Incremental Disk Images for a Device:

  • Finished - A green check (!d8.gif) will be displayed if the Incremental Backup is complete. If the Disk Recovery Point is not checked, the Backup is in process.
  • Incremental Number - Incremental Backups start at number 0.
  • Snapshot - The date and time the Snapshot of the storage Device was taken.
  • Size - The amount of storage the Disk Recovery Point consumed on the CDP Server. The Size will be directly related to the amount of changed data that the Incremental must store.
  • Scheduled Task - The description of the Scheduled Task that created the Incremental.

Locking Disk Recovery Points

Follow the instructions below to lock a Disk Recovery Point in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Browse" in the "Host" Menu.

5. The Disk Safe Browser page is displayed.

6. Select a Disk Safe in the file system tree on the left.

7. Select a Device (Disk) in the file system tree on the left.

8. To lock the Disk Recovery Point, on the Disk Safe Browser page, click on the "Lock" link corresponding to the Disk you want to lock.

Managing Recovery Points

Follow the instructions below to manage the Recovery Points in your CDP Web Server.

1. Open the Web browser connecting to the CDP Server Web Interface and log in.

2. Click on the "Hosts" tab in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads automatically after you log in.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Select the "Browse" tab in the "Host" Menu.

5. The Disk Safe Browser page is displayed. Read more in The Disk Safe Browser.

6. Select a Disk Safe in the file system tree on the left.

Read more in About Disk Safes.

7. Select a Device (Partition) in the file system tree on the left.

Read more in Devices.

8. The following information is available in the table when viewing a list of Recovery Points for a Device:

  • Finished - A green check mark will be displayed if the Incremental Backup is complete. If the Incremental is not checked, the Backup is in process.
  • Incremental Number - Incremental Backups start at number 0. If a Recovery Point has been deleted, the old numbering is kept and there is no re-numbering.
  • Snapshot - The date and time the Snapshot of the storage Device was taken.
  • Size - The amount of storage consumed by the Incremental on the CDP (Backup) Server. The Size will be directly related to the amount of changed data that the Incremental must store.
  • Scheduled Task - The description of the Scheduled Task that created the Recovery Point.

Locking Recovery Points

Follow the instructions below to lock the Recovery Points in your Linux Web Server.

Note
A locked Incremental will be skipped by the Rotation Policy and remain a part of the Disk Safe until it is unlocked. Read more in Linux Web Server - Backup Rotation Policies.

1. Open the Web browser connecting to the CDP Server Web Interface and log in.

2. Click on the "Hosts" tab in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads automatically after you log in.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Select the "Browse" tab in the "Host" Menu.

5. The Disk Safe Browser page is displayed. Read more in The Disk Safe Browser.

6. Select a Disk Safe in the file system tree on the left.

Read more in About Disk Safes.

7. Select a Device (Partition) in the file system tree on the left.

Read more in Devices.

8. To lock a Recovery Point, click on the "Lock" link in the Disk Safe Browser page next to the Recovery Point you want to lock .

Deleting Recovery Points

Follow the instructions below to delete a Recovery Point in your Linux Web Server.

See also: Deleting Recovery Points (CDP Server 2.0 Knowledge Base).

Note
Any Recovery Point can be deleted except the most recent Snapshot.
Note
You can decrease the number of recovery points to be kept by individual Backup tasks, so that after the next successful backup it will delete the oldest Recovery Points.
Read more in Linux Web Server - Backup Rotation Policies.

1. Open the Web browser connecting to the CDP Server Web Interface and log in.

2. Click on the "Hosts" tab in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads automatically after you log in.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Select the "Browse" tab in the "Host" Menu.

5. The Disk Safe Browser page is displayed. Read more in The Disk Safe Browser.

6. Select a Disk Safe in the file system tree on the left.

Read more in Linux Web Server - Disk Safes.

7. Select a Device (Partition) in the file system tree on the left.

Read more in Devices.

8. To delete an Incremental, click on the "Delete" link on the Disk Safe Browser page next to the Incremental you want to delete .

9. You will be redirected to the Host History screen where you can observe the task completion.

Task log for the selected Task is shown in the bottom pane.

Restoring

See also:

About Bare-Metal Disaster Recovery

"Bare-Metal" is a term used to describe a highly efficient disaster recovery method for a Host. A "Bare-Metal Restore" does not require any installation of operating systems or backup software. You can stream your Disk Images across the network directly to the new or replacement hardware. The hardware or hard disks do not need to be formatted or partitioned, hence the term restoring to "Bare-Metal."

There are three (3) options for performing a Bare-Metal Restore for Linux and Windows platforms.

  • Live CD
  • Live Boot™ Remote Restore
  • PXE Network Boot

After you boot your Host using one of the above three (3) methods, you will need to follow the procedure for "Bare-Metal Restore" in your CDP Server.

Read more in:

About Files Restore

The "Restore Files Task" restores a set of selected files and directories. You can restore files from the Disk Safe Browser.

You can learn more in Restoring Files.

Bare-Metal Disaster Recovery of Disk Safes Using Encryption

When Restoring from a Disk Safe using encryption, you will be prompted for the passphrase. Bare-Metal Restores of Disk Safes using encryption are not possible without first entering the passphrase.

At the beginning of the Restore operation, the RSA Public Key and Backup Key are sent to the Agent over an encrypted socket. The Agent uses Keys to decrypt the Disk Image on its end as it is received over the network. Your data is always encrypted until the moment when it is decrypted before being written to the hard drive on the Host you are Restoring to.

See also: Linux Web Server - About Bare-Metal Disaster Recovery.

Restoring Files

Follow the instructions below to restore files in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the Host by clicking on the appropriate Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Browse" in the "Host" Menu.

5. The "Disk Safe Browser" will be displayed in a drop-down menu on the right. To restore files, make sure the "Disk Safe Browser" page is in the "Restore Files" mode.

Note
"Restore Files" is the default mode.

6. Select a "Disk Safe" in the file system tree on the left.

7. Select a "Device" in the file system tree on the left.

8. Select any combination of files and directories you need from the file system tree on the left.

9. When you are finished selecting the files and directories, make sure the "Restore Files" mode is selected in the top right menu. Click on "Go".

10. The "Schedule a new Restore Files task" form will load. Define the following settings for Restoring Files:

  • Save Task - Select the check box to save the Task.
  • Enabled - Select the check box to enable the Task.
  • Description - Enter a name you can use to recognize this Task apart from other scheduled Backup Tasks.
  • Recurrence - Select the frequency for the new Backup Task from the drop-down menu (Now, Minutely, Hourly, Daily, Weekly, or Monthly). If you want to run a Backup immediately, leave this as the default setting "Now."
    For more information on this topic, see Recurrence Types.

Restore Files Task Options:

  • Overwrite Existing Files - When enabled, any existing files or directories with the same name will be overwritten even if they are newer.
  • Encrypt file data over network - Encrypts all data in an encrypted tunnel over the network during the restore. This setting is enabled by default. Disabling this setting can provide a small increase in speed for file restores.
  • Restore to Alternate Location - Specify a path for the Host to restore the files to. The complete path and directory structure of all selected files will be created under the path specified for this setting. If the specified path does not exist, it will be created.
    Note
    Files and folders are restored with their full path underneath the chosen location. For example, if "C:\SomeFolder\SomeFile.txt" is selected for restore and "C:\SomeOtherFolder" is entered as the alternate location, the file will be restored as: "C:\SomeOtherFolder\SomeFolder\SomeFile.txt"
  • Restore to Alternate Host - Select an Alternate Host to restore the files to. Select the Host from the drop-down menu of other Hosts you have Admin rights on. Alternatively, you can enter a Host Name or the IP Address of the Alternate Host. The Host must be running the "Righteous CDP Agent" and must be configured to accept requests from the CDP Server.
    See Activating the Agent for more information.

11. Click on "OK" to save the "Restore Files Task" settings.

12. You will be redirected to the History page where you can observe the progress of the "Restore Files Task."

Note
The Log Messages for the selected Task are displayed at the bottom of the page.

Restoring Files from Disk Safes Using Encryption

When Restoring files from a Disk Safe using encryption, you will be prompted to enter the encryption passphrase. Files cannot be Restored without first entering the passphrase. The passphrase is only stored in memory and never saved to Disk or database. If the Restore Files Task is interrupted because of a CDP Server shutdown event, it will not re-run automatically. You will need to initiate a new Restore Files Task and enter the passphrase again.

Read more on this topic in Linux Web Server - Disk Safe Encryption.

Tasks

About Tasks

Each operation completed by a User or by the system is called a Task. You can check the status of the Tasks on the "Global Task History" or "Host Task History" page (see Task History).

The Task Scheduler page (Task Scheduler) allows you to view and manage the Scheduled Tasks.

Tasks can have the following characteristics:

  • Scheduled Task Name - The User-defined name of the scheduled Task.
    Note
    One (1) Scheduled Task can run one (1) or several Tasks of one (1) or several Types.
  • Type - The Type of Task. See Task Types.
  • Recurrence - The description of the Scheduled Task. See Recurrence Types. Linux Web Server - Recurrence Types
  • Host - The Host the Task is associated with. This field is only visible on the Global Task History page.
    Note
    Not all Tasks are associated with a Host. There can be System-wide Tasks.

Tasks can have a number of characteristics applicable to each separate Task after it starts. Such properties are shown on the Task History page:

Task Types

The Tasks can belong to one the following Types:

  • Backup - A Backup Task.
    Read more in About Tasks.
  • Bare-Metal Restore - A restore of one (1) or more Disk Images and Partition Tables.
    See also Bare-Metal Disaster Recovery.
  • CP Restore Files - A Restore Files Task initiated by a control panel user.
    Refer to Testing Agent Connectivity.
  • Defragment - Launched by a Backup Task according to the free space limit defined in the Disk Safe. Shrinks Disk Safes when the free space limit has been reached or exceeded.
    Read more in Disk Safe Defragmention.
  • Delete Disk Recovery Point - Deletes a Backup of a Partition Table from a Disk Safe.
    Note
    Renamed in Version 2. In Version 1, called "Delete Disk Incremental."
  • Delete Disk Safe - Deletes a Disk Safe from the Volume where it resides.
    Read more in Deleting Disk Safes.
  • Delete Host - Deletes a Host and all of its Disk Safes.
    Read more in Deleting Hosts.
  • Delete Recovery Point - Deletes an Incremental Backup from a Disk Safe.
    Note
    Renamed in Version 2. In version 1, called "Delete Incremental."
  • Device Discovery - A sub-Task of Host Discovery that discovers the Devices available for Backup.
    Read more in Adding Devices.
  • Disk Safe Repair (New in Version 2) -  Disk Safe Repair repairs Disk Safes automatically if there is an unclean shutdown.
  • Email Reporting
    See Linux Control Server - Scheduling Email Reporting.
  • Encryption Setup - Connects to the Agent and retrieves the encryption Keys necessary for creating a new Disk Safe with encryption.
    Read more in Disk Safe Encryption.
  • Host Discovery - Adds a new Host to the Backup System and discovers Devices available for Backup.
    Read more in Host Discovery.
  • Host Email Reporting
    See Linux Control Server - Scheduling Email Reporting.
  • Host Log Cleanup - Deletes old Log Messages.
  • Host Quota Check - Performs a Quota Check for a Host and all of its Disk Safes comparing actual Disk usage to the usage recorded in the Quota. This Task can fix Quota discrepancies that might occur in case of an unclean shutdown of the Backup System.
    Read more in Host Quotas.
  • Log Cleanup - A Backup System-wide Task that launches Host Log Cleanup Tasks for every Host on the system.
  • Partition Table Backup - A sub-Task of Backup responsible for backing up the MBR (Master Boot Record) and Partition Table for a Device.
  • Partition Table Restore - A sub-Task of Bare-Metal Restore, responsible for restoring a Partition Table and/or MBR (Master Boot Record).
    Read more in Bare-Metal Disaster Recovery.
  • Restore Database
  • Restore Files - Restores a set of selected files and directories.
    Read more in Files Restore.
  • Rotation Policy - A Task launched by Backup Task that decides if and which Incrementals should be deleted to satisfy Backup Retention Policies.
    Read more in Backup Rotation Policies.
  • System Quota Check - A Backup System-wide Quota check that launches Host Quota Check Tasks for all of the Hosts on the system.
    Read more in Host Quotas.
  • Test Agent - Tests connectivity between the Agent and CDP Server.
    Refer to Testing Agent Connectivity.
  • Verify Disk Safe - Verifies the Disk Safe.
New in Version 2.x
The "Verify" option for Backup only verifies the last Recovery Point instead of all the Recovery Points.

See Verifying Disk Safes.

Note
"Make File List" is no longer necessary in version 2. Browsing a Recovery Point reads it in real-time as if a Recovery Point is a read-only Hard Disk.

All Task characteristics are listed in About Tasks.

Task History

Most work performed by the CDP Server is done as a background or Scheduled Task. The status and log record for each Task is available for browsing via the Task History page.

There are two (2) Task History pages:

  • Host Task History: The Host Task History is available from the Host menu and only shows Tasks specific to the Host you have selected.
  • Global Task History: The Global Task History page shows the Tasks for all Hosts you have permissions for.

If you are a Super User, this Global Task History page will allow you to see the status of all Tasks in the Backup system.

The Task History and Task Scheduler (Task Scheduler) pages show the Task characteristics. All possible Task characteristic types are listed in About Tasks.

Task Log Messages

The Tasks can have the following Log Messages:

  • Level - The current state of the Task.
  • Time - The date and time the message was received.
  • Message - The log message.
    Note
    Messages received from the CDP Agent have an AGENT: prefix.

    Task Log Message Levels

A Task can have a below listed status.

Info - A message logged for information purposes only.
Error - An error message.
Warning - A warning message.

See also: Downloading Task Log Messages

Task Scheduler

All created Backup and Restore Tasks are saved in a Host's Scheduler. They are available to be run again at a future date or on a Recurrence schedule.
 
The following information is available for each Task on the Task Scheduler page:

  • Enabled - An icon will be displayed next to enabled Tasks and disabled Tasks.
  • Type - The Type of the Task.
    See Task Types for more information.
  • Recurrence - The recurrence type or schedule.
    See Recurrence Types for more information.
  • Created By - The User that created the Task.
  • Last Edited By - The User that last changed the settings for the Task.
    See Accessing the Task Scheduler.

All Task characteristics are listed in About Tasks.

Task States

A Task can be in one (1) of the following states:

?
Icon Name Description
1 Success The Task completed successfully and without errors.
2
Error The Task has completed with one or more errors.
3 Running The Task is currently running.
4 Queued The Task has been queued and will run as soon as more resources are available. A Task can be queued either when the Host is locked by another "Backup" or "Restore" operation, or if the maximum simultaneous Tasks as configured by the CDP Server administrator have been reached.
5 Cancelled The Task has been cancelled. This can happen automatically because there is already a duplicate scheduled Task in the queue. Alternatively, the Task may have been cancelled by the User on the Task History page.

All Task characteristics are listed in About Tasks.

Task Status

A Task can have the following status:

  • State - The current state of the Task. See Task States.
  • Host - The Host the Task is associated with. This field is only visible on the Global Task History page.
    Note
    Not all Tasks are associated with a Host.
  • Type - The Type of Task. See Task Types.
  • Progress - Bar showing the progress of Task completion. All Tasks do not have a predictable progress. These Tasks have a scrolling busy indicator instead of a progress bar.
    Note
    MakeFileList is an example of a Task that uses a busy indicator.
  • Started - The date and time when the Task was first queued for running.
  • Finished - The date and time when the Task finished or was interrupted.
  • Scheduled Task - The description of the Scheduled Task.
  • Run By - The User that ran the Task or last edited the Scheduled Task.

All Task characteristics are listed in About Tasks.

Recurrence Types

The following Task Recurrence Types are available:

  • Now - A Task that will run only one time when it is first created and does not repeat.
    Note
    The only way a "Now" Task will run again is if the "Run Now" button is clicked next to the Task in the Scheduler.
  • Minutely - A Task that will run every X minutes. X can be a value in minutes between 0 and 59.
  • Hourly - Select the start time (minutes after the hour) and the hours the Task should run. Select the check box next to each hour you want the Task to run.
  • Daily - A Task that will run once a day. Specify the start time in hours and minutes.
  • Weekly - A Task that will run once a week. Specify the start time in hours and minutes and select one or more weekdays for the Task to run.
  • Monthly - A Task that will run once a month. Specify the start time in hours and minutes and select which day of the month the Task should run (1st to 31st).

All Task characteristics are listed in About Tasks.

Accessing the Global Task History

Follow the instructions below to access the "Global Task History" page in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "History" in the "Hosts" Main Menu.

3. The "Global Task History" page will load.

The following "Task History" information is displayed for each Host:

  • State - The State of the Task.
    Read more in Task States.
  • Host - The name of the Host that the Task was completed for.
  • Type - The Type of Host Task.
    Read more in Task Types.
  • Progress - Bar that displays the progress of the Task.
  • Started - Time stamp of the date and time the Task was started.
  • Finished - Time stamp of the date and time the Task was completed.
  • Scheduled Task - The description of the Scheduled Task.
  • Run By -The User that ran the Task or last edited the Scheduled Task.
  • Task Log Messages - Displayed at the bottom of the "Task History" page. Consists of the following information:  

Accessing the Host Task History

Follow the instructions below to access the "Host Task History" page of your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "History" in the "Host" Menu.

5. The "Host Task History" page will load.

The "Host Task History" page displays the following "Task History" information for each Host:

  • State - The State of the Task.
    Read more in Task States.
  • Host - The name of the Host the Task was completed for.
  • Type - The Type of Host Task.
    Read more in Task Types.
  • Progress - A bar that displays the progress of the Task.
  • Started - Time stamp of the date and time the Task was started.
  • Finished - Time stamp of the date and time the Task was completed.
  • Scheduled Task - The description of the Scheduled Task that was entered during the creation of the Task.
  • Run By -The User that ran the Task or last edited the Scheduled Task.
  • Task Log Messages - The Task Log Messages are displayed on the bottom of the "Task History" page. The Task Log Messages consist of the following information:  

Accessing the Task Scheduler

Follow the instructions below to access the "Task Scheduler" page of your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Scheduler" in the "Host" Menu.

5. The following information is available for each Task on the Task Scheduler page:

  • Enabled - A green check icon ( ) will be displayed to inform you that the Task is enabled.
  • Description - A brief description of the Task, which was entered during the Task creation.
  • Type -The Type of Task.
    See Task Types for more information.
  • Recurrence - The Recurrence Type or schedule.
    See Recurrence Types for more information.
  • Created By - The User that created the Task.
  • Last Edited By - The User that last changed the settings for the Task.
  • Actions - Links for the following commands:  
    • Run Now
    • Edit
    • Disable 
    • Delete

Canceling a Running Task

Follow the instructions below to cancel a running Task in your Linux Web Server For Data Centers.

1. Access the "Global Task History" or the "Host Task History" page.

Read more in Accessing the Global Task History or Accessing the Host Task History.

2. To cancel a running Task, click the "Cancel" link in the "Actions" column corresponding to the Task you want to cancel.

Note
It may take up to several minutes before some Tasks respond to the cancel interrupt.
New in Version 2.5
Super Users are allowed to cancel all running Tasks.

Disabling and Enabling Tasks

Follow the instructions below to disable or enable a Task in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Scheduler" in the "Host" Menu.

5. The Task Scheduler page loads.

6. Select the "Disable" link corresponding to the appropriate Task to disable the Task. Select the "Enable" link corresponding to the appropriate Task to enable a disabled Task.

Editing Scheduled Tasks

Follow the instructions below to edit the scheduled Tasks in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Scheduler" in the "Host" Menu.

5. The Task Scheduler page loads.

6. Click on the appropriate "Edit" link in the "Actions" column for the corresponding Task.

7. When the page has loaded, you can edit the following parameters:

Note
Last Edited By - The User that last changed the settings for the Task.
  • Enabled - Select the check box to enable the scheduled Backup Task.
  • Description - Enter a name you can use to recognize this Task among other scheduled Backup Tasks.
  • Recurrence - Select the Recurrence Type from the drop-down menu (Now, Minutely, Hourly, Daily, Weekly, or Monthly).

Weekly:

  • Start Time - Specify the start time in hours and minutes.
  • Sunday to Saturday - Specify the days of the week.
    Note
    The Recurrence Type used in the example below is "Weekly."

Log Cleanup Options:

  • Delete logs older than: x days - Enter a number of days in the text box. The Logs older than the entered number of days will be deleted.
    Note
    The Task Type used in the example above is "Host Log Cleanup."
    New in Version 2.5
    There is an option for default number of Host log rotation days which can be defined by administrators in Options Server Settings Agent Settings Default time to retain logs (days).

8. Click on "OK" to save the changes.

Running Tasks Now

Follow the instructions below to run a Task immediately in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Hosts" in the Main Menu to access the "Hosts" page.

Note
The "Hosts" page normally loads after you log in to the system.

3. Select the appropriate Host by clicking on the Host Name link under "Host Name". You can also click on the corresponding "Open" link under "Actions".

New Feature in Version 2
To find a Host, you can use the Host List Filter.

4. Click on "Scheduler" in the "Host" Menu.

5. The Task Scheduler page will load.

6. Click on the "Run Now" link for the corresponding Task in the "Actions" column.

Viewing Task Log Messages

Follow the instructions below to view the Task Log Messages in your Linux Web Server For Data Centers.

1. Access the "Global Task History" or the "Host Task History" page.

Read more in Accessing the Global Task History or Accessing the Host Task History.

2. To view the Log Messages for a Task, click the Task Type in the row corresponding to the Host. Its Task Log Messages will load at the bottom of the page.

Notice
You can use the "Log Message Filter" to display the Task Log Messages. Select one (1) of the three (3) display options from the "Log Message Filter" drop-down menu.
  • Show ALL Log Messages
  • WARNINGS and ERROR Messages
  • ERROR Messages ONLY

See also Downloading Task Log Messages.

Downloading Task Log Messages

Follow the instructions below to download the Task Log Messages as a text file in your Linux Web Server For Data Centers.

1. Access the "Global Task History" or the "Host Task History" page.

Read more in Accessing the Global Task History or Accessing the Host Task History.

2. To download the Task Log Messages for a specific Task as a text file, click on the "Logs" link in the "Actions" column corresponding to the Task on the "Task History" page.

3. You can also click on "Disk" and download all of the Log Messages for all Tasks the Task History Filter matches in one (1) large text file.

See also Viewing Task Log Messages.

Users And Their Rights

About Users

The Web Server maintains a database of Users allowed to use the system to manage Hosts, Backups, and Restores. Service providers can manage their customers from one single location (Web Server). The system provides unparalleled flexibility allowing you to restrict access or resell services as a Backup service provider. The customers/Users of Backup services log in to the Web Server. There they can have access only to the Volumes, Hosts, and Users assigned to them. You can create all Users in the Web Server (Adding Users).


There are two (2) User Types by privileges:

Users that manage other Users are User Administrators. Read more in User Administrator.

Users that manage Hosts are Host Administrators. Read more in Host Administrator.

CDP Data Centers provides the ability to assign certain Users to CDP Server Cluster Nodes. Read more in Volume Administrator.

Common User

There are two (2) User Types within the System:

Common Users have restricted rights.

  • They may not be permitted to create new Users and Hosts.
  • Common Users can add only Common User accounts.
  • Common Users can administer only the Users which they have Administrator privileges on.
  • Common Users may not be allowed to change their Password in the system.

Super User

There are two (2) User Types within the system:

Super Users do not have restricted rights. They can perform the following actions:

  • Super Users always have the right to add new Users and Hosts in to the system.
  • Super Users can view and administer all Users.
  • Super Users can view and administer all Hosts.
  • Super Users are always allowed to change their Password. 
  • Super Users are allowed to cancel all running Tasks. (New in Version 2.5)

Host Administrator

By adding Administrators to Hosts you can control who can access Hosts in the Backup System and what their level of permissions are. These features make Righteous Software a true multi-user Backup and Restore system.

By default, when a User adds a Host, they are automatically added as an Administrator for that Host with Full Control.

Note
Host Administrator permissions can be changed.

Host Administrator permissions include the following:

  • Full Control - All permissions.
  • Admin - Can control all aspects of the Host except changing the Host's Data Storage Quota.
  • Restore - Can use the Disk Safe Browser, initiate file Restores, and initiate Bare-Metal Disaster Recovery for the Host.
  • Backup - Can initiate Backups of the Host and manage Backup Tasks.
  • Can Change Quota - Can change or disable the Host's Quota.

Read more in:

User Administrator

The Administrator role provides the privilege to administer other Users within the System. An Administrator can perform the following actions:

  • View Users
  • Edit Users
  • Delete Users
    Note
    Users are not allowed to administrate themselves.

    Regarding the Administrator role, we need to indicate the Admin privileges of the various Users.

  • User Administrators can view, edit, and delete only Users they have privileges on.
  • Common Users may have Administrator privileges on some Users. They become Administrators on the Users they have added into the System.
  • Super Users always have Administrator privileges on Users.

The Administrator role can be given or taken away manually. See Adding an Administrator For A User.

Examples:

Commons Users can see only "child" Users, i.e. Users that they have Administrator privileges on.

Super Users can see all Users in the system.

Volume Administrator

CDP Data Centers provides the ability to assign certain Users to CDP Server Cluster Nodes. For example, a customer can belong to a CDP Server. To link Users to a certain CDP Server Node, you should assign these Users to the Volume that is linked to the Storage Pool of the necessary CDP Server.

Read more in Linux Control Server - Volumes.

Note
You can assign a User to only a certain Host. See Host Administrator.

The customers (Users) of Backup services log in to the Web Server. Users can have access only to the Volumes, Hosts, and/or Users assigned to them.

Adding Users

Follow the instructions below to create new User accounts in your Linux Web Server For Data Centers.

Note
Super Users always have the right to add new Users into the system. Common Users can have the right to add new Users if the corresponding option is checked for the User.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Users" in the Main Menu.

3. Then click on "New User".

Note
Common Users may not have the right to create new Users. In this case, the "New User" button is disabled. The right to create Users is defined and can be changed by the Administrator of the current User.

4. On the "New User" page you can set the following options:

  • Enabled - Select the check box to enable the User. Disabled Users are not allowed to log in to the system.
  • Is Super User - Select the check box to create a User with Super User rights. If you do not check this option, then the Common User will be created.
    Note
    Common Users have restricted rights. Common Users can only add Common User accounts.
  • Username - Enter the Username.
  • Email - Email associated with the User.
  • Password - Enter the Password for the User account.
    Note
    The Password must be between a minimum of 6 characters and a maximum of 50 characters.
  • Re-type Password - Re-enter the same password for the User account.
  • Can Change Password - Select the check box to allow the User to change their Password.
    Note
    : Super Users are always allowed to change their Password.
  • Must Change Password - Select the check box if the User must change their Password at the next log in.
  • Can Add Users - Select the check box to allow User to add other Users.
    Note
    Super Users are always allowed to add Users.
  • Can Add Hosts - Select the check box to allow User to add Hosts.
    Note
    Super Users are always allowed to add Hosts.

5. Click on "OK" to save the New User.

Changing User Properties

You can change the following User properties:

  • Enabled
  • Is Super User
  • User Name
  • Email
  • Password
  • Can Change Password
  • Must Change Password
  • Can Add Users
  • Can Add Hosts
    Note
    You cannot change your own User properties, except Password and email.

    Follow the instructions below to change the User properties in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Users" in the Main Menu.

3. When the "Users" page has loaded, the list of Users is displayed. Click on the appropriate "User Name" link, or click on the corresponding "Open" in the "Actions" column.

New in Version 2.5
You can use the User List Filter to select Users by certain parameters.
Note
Commons Users can see only "child" Users, i.e. Users which they have Administrator privileges on. Super Users can see all Users of the system.

4. The User summary page is displayed. Click on "Change" to edit the User properties.

5. The "New User" form loads. The settings are explained in Adding Users.

6. Click on "OK" to save the changes.

Note
After clicking on "OK" or "Cancel", you are returned to the User account properties page in view mode.

To return to the "User List" page, click on "Back", or click on "Users" in the Main Menu.

Deleting Users

Follow the instructions below to permanently delete an existing User account from your Linux Web Server For Data Centers.

Note
You may want to delete a User account from the system if it is no longer in use. If the account is temporarily not being used or you want to temporarily restrict access to it, you have the option to disable the User account. See Changing User Properties.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Users" in the Main Menu.

3. When the "Users" page has loaded, the list of Users is displayed. Click on the "Delete" link in the "Actions" column corresponding to the appropriate User Name.

Note
You cannot delete your own User account.
New in Version 2.5
You can use the User List Filter to select Users by certain parameters.
Note
Commons Users can see only "child" Users, i.e. Users which they have Administrator privileges on.  Super Users can see all Users in the system.

4. On the confirmation page, click on "OK" to permanently delete the selected User.

Note
The User does not exist any more. You are returned to the "Users" page that displays the list of Users.

Adding an Administrator for a User

Follow the instructions below to add an Administrator for a User in your Linux Web Server For Data Centers.

Note
You cannot add an Administrator for a Super User.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Users" in the Main Menu.

3. The list of Users is displayed on the "Users" page.

New in Version 2.5
You can use the User List Filter to select Users by certain parameters.
Note
Commons Users can see only "child" users, i.e. Users which they have Administrator privileges for. Super Users can see all Users in the system.

4. Click on the "User Name" link or click on the "Open" link for the appropriate User Name in the "Actions" column

5. The User summary will be displayed in view mode. Click on "Admins" in the "User" Menu.

6. On the "Administrators" page, the following information will be displayed:

  • Username - Enter the Username that you want to administer the selected User account.
  • Search Results - This box displays all Users.
  • Administrators - This box displays all current User's Administrators.

7. If there are many Users, you can use the search function. Type the Username or a part of the Username in the "Username" text box and click on "Search".

Note
If the list of eligible Users is short, the entire list will be displayed for you to select from.

8. If the list of eligible Users is large (likely if you are a Super User), no Users will be displayed. You will be required to search for a User by "Username."

Note
In the "Search Results" box, you can see all Usernames that contain the entered string.

Example: If you search for "ph," then the "Search Results" box may contain such names as "phil," "phillip," and "ralph."

Note
To show all Users, search for the empty string.

9. In the "Search Results" box, find the User that you want to administer the selected User account.  Select the User that you want to be the Administrator by clicking on the Username in the "Search Results" box.

Note
You can hold Shift to select several neighboring items and Ctrl to select any items from the box.

10. Click on "Add" to make the selected User(s) Administrator(s).

11. The selected Users will be displayed in the "Administrators" box on the right. Click on "User" or the back arrow to return to the User properties page.

Log In to the System

Follow the instructions below to log in to the Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in. Make sure "Standard Login" is selected from the drop-down menu.

2. Enter your "User Name" and "Password." Click on "Login".

3. When you log in for the first time, you may receive the following message:

"User must change password."

4. Enter your current Password. Enter and re-type the new Password. Click on "Login".

5. When you log in for the first time, the next page will display the Righteous Backup License Agreement. Click on the "Review License Agreement" link to display the License Agreement in a new window. Read the License Agreement to the end and click "I Accept".

Changing Email

Follow the instructions below to change your email in your Linux Web Server For Data Centers.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on "Options" in the Main Menu.

3. When the "Options" page has loaded, click on "Change Email Address".

4. When the "Change User Email Address" page has loaded, enter your new email address and click "OK" to save.

Changing Password

Follow the instructions below to change the User Password you use to log in.

Note
Some Common Users may not be allowed to change their Password. This option is determined by the User's Administrator.

1. Open the Web browser connecting to the Linux Web Server Web Interface and log in.

2. Click on the "Options" tab in the Main Menu.

3. When the "Options" page has loaded, click on "Change Password".

Note
If the User is not allowed to change their Password, this link is disabled. Please contact your Administrator.

4. The next page displays the "Change User Password" form. Enter the following information:

  • Old Password - Enter your current Password.
  • New Password - Enter the new Password that you are going to use.
  • Re-type New Password - Re-type the new Password.
    Note
    The Password must be between 6 and 50 characters long.

5. Click on "OK" to save your new Password. You can use your new Password the next time you log in to the system.

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.