This article is intended for individuals who administer CAB for Microsoft OneDrive. It is structured in such a way that you easily find the information you need to set up and manage the respective environment.

Scope and prerequisites

CAB for OneDrive covers the following:

  • Data backup (files and folders)

    Backup can be activated for all or selected sites.

  • Backup data restore

    Important

    CAB restore process is non-destructive; that is, the restored data does not overwrite the existing one.

  • Backup data export

To administer CAB for OneDrive in your Office 365 environment, the following are required:

Backup task activation

To activate OneDrive backup task, follow these steps:

  1. In the CAB Management Portal, click BACKUPS in the sidebar menu.

  2. Click Add Backup Task, and then click OneDrive.

  3. Complete the authorization process.

    You can activate the backup task using either OAuth or regular credentials (see Admin details).

    CAB automatically assigns admin permissions to OneDrive sites when using Office 365 admin account.

    Note

    If you choose to use the credentials-based authorization now, later you will not be able to switch to OAuth.
    Otherwise, if you choose to use the OAuth-based authorization, you will be able to switch to the credentials-based authorization later.

  4. In the list of sites, activate backup for those preferred (see Site backup management).

  5. Set the backup preferences and data indexing (see Backup task settings). You can change these later.

  6. Click Save to apply changes and activate the backup task.

Backup task settings

  1. In the CAB Management Portal, click BACKUPS in the sidebar menu.

  2. Click OneDrive or Edit .

  3. Change the backup settings as needed (see below), and then click Save.

Admin details

Here you can change the admin account used to activate the backup task.

  • If you have chosen the OAuth-based authorization when activating the backup task, you can choose from both OAuth and credentials again.

  • If you have chosen the credentials-based authorization, you can use only credentials again. If you want to use OAuth, you have to add a new OneDrive backup task.

For OAuth-based authorization, enter a OneDrive URL1, click Authenticate in Microsoft, and then sign in to your Office 365 admin account.

For regular credentials-based authorization, enter credentials for your Office 365 admin account and a OneDrive URL1, and then click Apply.

Site backup management

To manage backups at a site level and view the relevant details, click BACKUPS in the sidebar menu, and then click OneDrive or Edit .

Select Automatically start a backup when a new site is added to enable automatic backup for new sites. If cleared, you will need to manually add new sites and activate backup for them.

The system automatically archives the backups if the license is removed or a site is deleted. Select Retain auto-archived backups and enter the number of days to retain the automatic archive, or leave blank to retain it indefinitely. This does not affect manually paused backups.

The following details are available for each site backup:

Details Description
Account OneDrive site URL address
Status Backup status (Active, In Process, Not active, Scheduled, Paused, Backed-up in another task)
Last Backup Number of days from the last completed backup
Size Size of the backup data
Actions Set of special actions you can take in respect to the site backup (see details below)

The following special actions are available for each site backup:

Action icon Action name Action description
Resume Resume backup
Pause Pause backup
Backup Now Start backup immediately
Delete Remove backup and delete all backup data

Archived data indexing

Archived data indexing allows to provide the granular search and restore of the backup data. The system scans the data and builds the relevant search index. For this, you have to allow the system to unencrypt the data, since it is encrypted by default.

Select Index all archived data to allow indexing of the backup data for use in the granular search and restore functions. Once the search index is built, both the data and the index will be encrypted again.

Clear Index all archived data if you do not want to allow indexing. This will disable the granular search and restore functions, but you will still be able to browse backups by date.

Backup preferences

Preference Description
Friendly Name A nickname to identify the backup task. Default is the OneDrive URL
Archive location AWS datacenter location you have selected when enabling CAB for the company2
Backup frequency Frequency of the backup task initiation. Available options: Daily, Every 3 days, Weekly
Backup hour UTC time when the backup task is initiated
Retention period Number of days, months, or years to keep backups for until they are deleted from the cloud3

Domain backup management

You can manage the backup task at a domain (general) level. For this, in the CAB Management Portal, click BACKUPS in the sidebar menu, and use special actions opposite to OneDrive.

Action icon Action name Action description
Edit Edit backup task settings and manage site backups
Backup Now Start backup task immediately
Resume Resume backup task
Pause Pause backup task
Cancel Cancel backup task
Delete Remove backup task and delete all backup data

Backup data restore and export

To restore or export the backup data, follow these steps:

  1. In the CAB Management Portal, click RECOVERY in the sidebar menu, and then click OneDrive.

  2. Find the backup site to restore or export the data for, and then click Next in the Action column.

  3. Select the preferred choice for restore:

    • Via Snapshot

      1. Set the date range to show all snapshots within this range, and then click Continue.

      2. In the list of snapshots, select the snapshot to restore or export the data from.

        Tip

        You can also restore or export specific items from snapshots. To browse a snapshot, click Explore in the Action column, select the desired item(s), and then click Restore or Download.

    • Via Item Search

      1. Enter the search query (click More to show the advanced search options), and then click Continue.

      2. In the list of files, select the file(s) to restore or export.

  4. Click Restore to recover the selected files (you can restore the files to a different site), or click Download and specify the desired options to export the selected files.

    Note

    When exporting, the data is archived in a .zip file, which can be downloaded locally or exported to Amazon S3, Azure Blob, Box, or Dropbox.

Once you have initiated the restore or the download process, you can view its current status in the Restore & download status section.

You can manage the process using the following special actions in the Action column:

Action icon Action name Action description
Download Download exported data
Info View process details
Cancel Cancel process

  1. Sign in to your Office 365 admin account, go to OneDrive, and copy the URL address from your browser address bar (for example, company-my.sharepoint.com). ↩ ↩2

  2. If you want to change the datacenter location, please contact Infrascale Support. ↩

  3. By default, we provide unlimited retention for your backups for as long as you maintain your subscription. If you want to change this, please contact Infrascale Support. ↩