Documentation

Metallic Documentation

No matter where your data is or where you want to store it, Metallic has a solution.


Going to the Hub

Go to the Hub for an overall picture of the health of your Metallic environment. The Hub is also the place to configure new data sources to back up.

Procedure

  1. Go to https://login.metallic.io/ and log in. The Hub appears.
  2. To determine the health of the environment, select from the following tabs, and then review the information in the tiles:
    • VM & Kubernetes Backup
    • File & Object Backup
    • Database Backup
    • Office 365 Backup
    • Endpoint Backup
  3. To back up a new data source, in the upper-right corner of the page, from the New Configuration list, click the type of data that you want to back up, and then follow the instructions in the guided setup.

Use cases

Data sourceData source locationBackup storage location
File servers SQL serversCloudCloud
File servers Endpoints SQL servers Virtual machinesOn-premisesCloud On-premises On-premises and cloud
Office 365: Exchange OneDrive SharePointCloudCloud

To learn more about choosing a storage option, see All about storage.


Creating an administrator

You can create additional administrators for Metallic. When you set up Metallic, one administrator account is automatically created. If you use the Endpoint application and need to authenticate laptop and desktop users, see Endpoint tasks.

Procedure

  1. From the navigation pane, go to Security > Users.The Users page appears.
  2. In the upper right corner of the page, click Add user. The Add user dialog box appears.
  3. Next to User type, click Local user, and then provide the user information.
  4. From the User group list, select Tenant Admin.
  5. Decide how to create the password for the user:
    • To auto-generate a password for local users, select the Use system generated password check box.
    • To manually set a password for the user, in the Password box and the Confirm password box, type a password.
  6. Click Save.

Editing User Details

You can edit a user to update details, such as the email address and the user group.

Procedure

  1. From the navigation pane, go to Manage > Security > Users.
    The Users page appears.
  2. In the User name column, click the user that you want to edit.
    The user details page appears.
  3. On the Overview tab, in the upper-right corner, click Edit.
    The Edit user dialog box appears.
  4. Update the user information.
  5. Click Save.

Configuring identity provider

To authenticate users with SAML, configure an identity provider. Common SAML identity providers include AD FS, Azure, and Okta.

Note: The direct access method for Active Directory is not supported.


Using Azure Active Directory as Your Identity Provider

Azure Active Directory (Azure AD) is a third-party identity provider (IdP) that can act as the IdP when your users log on to Metallic. Metallic is the service provider (SP).

To integrate with Azure AD, add a SAML application in your Azure AD account and in Command Center. Metadata from the Azure application (IdP) and the Command Center application (SP) are shared during this process.

Before You Begin

You must have the Azure Active Directory Premium P1 or Premium P2 edition. For information, go to the Microsoft Azure Active Directory documentation.

Step 1: Creating an Application in the Azure Portal

  1. Go to the Microsoft Azure portal.
  2. From the navigation pane, go to Azure Active Directory > Enterprise applications, and then click New application ( ).
  3. Under Add an application, click the Non-gallery application tile.
  4. Enter a name for the application, and then click Add.
  5. Review the overview, and under the Getting Started section, complete the following steps required by Microsoft: Assign users and groups and Add user.
    Note: The users and groups that are assigned in the steps can only access the application.
  6. From the navigation pane, click Single sign-on, and then click the SAML tile.
    The SAML-based Sign-on page appears.
  7. In the Basic SAML Configuration section, click Edit at the top-right corner, then in the Identifier (Entity ID) box and the Reply URL (Assertion Consumer Service URL) box, enter the Web Console URL, and then click Save.

    For example, the URL should be in the following format:https://mycompany:443/webconsole.
Screenshot of where the Federation Metadata XML download appears in the SAML Signing Certificate section
  1. Under the User Attributes & Claims section, click Edit at the top-right corner, then in the Unique User Identifier box, specify user.userprincipalname.
  2. In the SAML Signing Certificate section, next to Federation Metadata XML, click the Download link.


    The federated metadata file that you download is the IdP metadata file that you will upload to Metallic.
  3. Remain on the SAML-based Sign-on page.

    The SP metadata file that you will create in Metallic must be uploaded to your Azure application from the SAML-based Sign-on page.

Step 2: Adding a SAML Application in Metallic

  1. From the navigation pane, go to Manage > Security > Identity server.
    The Identity servers page appears.
  2. In the upper-right corner of the page, click Add.
    The Add domain dialog box appears.
  3. Click SAML.
  4. In the Domain name box, enter a domain name to which you want users to associate with.
    Note: SAML application is created using the domain name.
  5. In the SMTP address box, enter the SMTP address of the users.

    For example, if the username is jdoe@gmail.com, enter gmail.com as the SMTP address.

    Note:
    • You can enter multiple SMTP addresses separated by a comma.
    • Only users with specified SMTP addresses will be able to log in using this app.
  6. Upload the IdP metadata:
    1. Next to the Upload IDP metadata box, click Browse.
    2. Browse to the location of the XML file that contains the IdP metadata, select the file, and then click Open.
  7. Review the value in the Webconsole url box.
    This value is automatically generated and is used in the SP metadata file. The format of the value is https://mycompany:443/webconsole.
  8. To digitally sign the SAML message, move the Auto generate key for digital signing of SAML messages toggle key to the right.
  9. Click Save.
    The SP metadata file is generated and the IdP metadata is saved, and the Identity servers page appears.
  10. In the upper-right corner of the page, click Download SP metadata.


    The name of the file that is downloaded begins with SPMetadata. The SP metadata file must be uploaded to the Azure application.

Step 3: Uploading the Metadata to the Azure Portal

  1. In the Microsoft Azure portal, on the Single sign-on page, click Upload metadata file.
  2. Upload the SP metadata file.
  3. Click Add.
    The Identifier (Entity ID)Reply URL (Assertion Consumer Service URL), and Logout URL values are pre-filled using the SP metadata file.
  4. Click Save.

Using Okta as Your Identity Provider

Okta is a third-party identity provider (IdP) that can act as the IdP when your users log on to Metallic. Metallic is the service provider (SP).

To integrate with Okta, add a SAML application in your Okta account and in Command Center. Metadata from the Okta application (IdP) is shared with the Command Center application (SP) during this process.

Step 1: Creating an Application in Okta

  1. Log on to your Okta account. You will create a new application using SAML 2.0 as the sign on method.
  2. Follow the wizard for the general settings.
  3. Under Configure SAML > SAML Settings, in the Single sign on URL box and the Audience URI (SP Entity ID) box, enter the URL for the Web Console using the following format: https://mycompany:443/webconsole.
  1. From the Name ID format list, select Email Address.
  2. Continue to follow the wizard and accept the default values.
  3. Click Finish.
  4. Open the application, and then click Sign On.
  1. Under the View Setup Instructions button, click Identity Provider metadata, and then save the IdP metadata file as an XML file.

    The identity provider metadata file that you save is the IdP metadata file that you will upload to Metallic.
  2. Keep your Okta account open.

    The value in the Single sign on URL box in Okta must be updated after a new URL is created in Metallic.

Step 2: Adding a SAML Application in Metallic

  1. In the upper-right corner of the page, click Add. The Add domain dialog box appears.
  2. Click SAML.
  3. In the Domain name box, enter an application name.
  4. In the SMTP address box, enter the SMTP address.
  5. Upload the IdP metadata:
    1. Next to the Upload IDP metadata box, click Browse.
    2. Browse to the location of the XML file that contains the IdP metadata, select the file, and then click Open.
  6. Review the value in the Webconsole url box. This value is automatically generated and is used in the SP metadata file. The format of the value is https://mycompany:443/webconsole.
  7. To digitally sign the SAML message, move the Auto generate key for digital signing of SAML messages toggle key to the right.
  8. Click Save. The Identity servers page appears.
  9. In the Name column, click the identity server. The identity server properties page appears.
  10. In the General section, copy the value in the Single sign on url box. This value must be updated in Okta.

Step 3: Update the Single Sign-on URL in Okta

  • In your Okta account, under Configure SAML > SAML Settings, in the Single sign on URL box, paste the URL that you copied from Command Center. This is the value from the Single sign on url box.

Step 4: Optional Okta Configurations

  1. To configure single logout in Okta, complete the following steps:
    1. From the generated SP metadata XML file, copy the following information:
      • SP EntityId
      • SingleLogoutService location with POST binding
    2. To download the signature certificate, log on to Command Center, and then in your web browser, type the SAML App URL in the following format: https://webconsole_hostname/adminconsole/downloadSPCertificate.do?appName=URL encoded SAML app name Example: https://company.com/adminconsole/downloadSPCertificate.do?appName=app%20Name
    3. Press Enter.
    4. In your Okta account, under General > Advanced Settings, select the Enable Single Logout box.
    5. In the Single Logout URL box, type the SingleLogoutService location that you copied from the SP metadata XML file.
    6. In the SPIssuer box, type the entityID that you copied from the SP metadata XML file.
    7. In the Signature Certificate box, upload the certificate that you downloaded from the SAML app URL.
  2. To assign other Okta users access to your Okta account, complete the following steps:
    1. In your Okta account, under Assignments, click Assign, and then select one of the following options:
      • To assign individual Okta users, click Assign to People.
      • To assign a user group, click Assign to Groups.
    2. Select the user or group that you want to assign, and then click Add.
  3. To assign domain users based on Okta’s user groups SAML attribute, complete the following steps:
    1. In your Okta account, under Group Attribute Statements, click Add.
    2. In the Name box, type user_groups.
    3. In the Filter box, assign filters as required. For example, to assign users from a user group name that starts with “domain users”, select Starts With, and then type domain users.
    4. Preview the SAML assertion and verify that your IdP response XML includes the user group attribute. For example: <saml2:Attribute Name=”user_groups” NameFormat=”urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified”>
        <saml2:AttributeValue
      xmlns:xs=”http://www.w3.org/2001/XMLSchema”
      xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xsi:type=”xs:string”>GroupName Match Starts with “domain users” (ignores case)
      </saml2:AttributeValue>
      </saml2:Attribute>
    5. In Command Center, map Okta’s user_group SAML attribute with the user group user attribute.

Usage and Metering

Billing calculations can be based on the amount of data you back up, the number of users in your environment, and the amount of Metallic Cloud storage that you use.

Total usage for a period is defined as the total cumulative count of unique entities (as defined by a globally unique identifier) protected, in any capacity and for any duration, at any point during the billing period of measurement. It is the cumulative sum of all unique entities protected throughout that billing period.

You can view usage and metering information in the Subscription Usage tile on the Hub for each type of entity:

  • Metallic Cloud Storage: The peak volume of data protected in terabytes from the start of the current month to today. For more information, see Data stored in the Metallic cloud.
  • VM and Kubernetes: The total number of unique virtual machines protected from the start of the current month until today. For more information, see Subscription Usage for VMs and Kubernetes.
  • Files and Objects: The peak front-end size for file and object data protected from the start of the current month until today. For more information, see Subscription Usage for Files and Objects.
  • Databases: The peak front-end size for database data protected from the start of the current month until today. For more information, see Subscription Usage for Databases.
  • Office 365: The total number of unique users protected from the start of the current month until today. For more information, see Subscription Usage for Office 365.
  • Endpoint: The total number of unique users protected from the start of the current month until today. For more information, see Subscription Usage for Endpoint.

Security and Compliance

Metallic is committed to ensuring the security of your data at every level. Metallic is built on Microsoft Azure, the cloud platform leading the industry in compliance with over 90 certifications.

Commvault Systems, Inc. is also an ISO.IEC 27001:2013 certified provider whose Information Security Management System (ISMS) has received third-party accreditation from the International Standards Organization. The scope of our ISO/IEC 27001:2013 certification includes the Commvault offering Metallic.

A-lign, an independent, third-party auditor, found Metallic to have technical controls in place and formalized IT Security policies and procedures. A-lign is an ISO / IEC 27001 certification body accredited by the ANSI-ASQ National Accreditation Board (ANAB) to perform ISMS 27001 certifications.



GDPR

Metallic supports our customers’ compliance with the General Data Protection Regulation (GDPR). For information about Metallic and GDPR compliance, see GDPR readiness with Metallic.


Metallic storage


All about storage

Deciding where to store your data doesn’t have to be hard. You can choose to back up to an on-premises server, to the cloud, or to a combination of both.

Let’s look at the benefits and considerations for all of the options.

On-premises storage

Restoring data from an on-premises server is as fast as your own network.

Benefits of on-premises storage:

  • Fast recovery
  • No charge for moving data
  • You know exactly where your data is

Considerations for on-premises storage:

  • You must manage your storage infrastructure
  • Adding or upgrading storage requires planning and money

Cloud storage

Storing data in the cloud gives you the flexibility to scale up or down depending on your storage needs.

Benefits of cloud storage:

  • Easy to scale
  • No infrastructure management

Considerations for cloud storage:

  • Slower recovery
  • Depending on the agreement with the cloud provider, there could be charges associated with restoring data

Related topics

Backup gateway requirements

Cloud storage requirements


Cloud storage requirements

To store data in a cloud, use your own cloud or use the Metallic cloud.

Data flow

Supported providers

The following clouds are supported:

  • AWS
  • Azure

Data stored in the Metallic cloud

From the Hub, you can track the amount of data stored in your Metallic Azure cloud.

Usage information is available in the following tiles:

  • Subscription Usage: Displays the peak volume of data protected in terabytes from the start of the current month to today in the Metallic Cloud section of the Subscription Usage tile. For usage reconciliation purposes, the peak usage value for the month is used.
data stored metallic cloud subscription usage
  • Backup Storage Used: Displays the current storage usage in terabytes. The usage includes deduplicated data and data compression. This value can vary from the peak usage value displayed in the subscription tile.
data stored metallic cloud backup storage used

Metallic backup gateway requirements

The on-premises backup gateway functions as a gateway between the on-premises data source and the cloud backup service. If you want to use on-premises backup storage, you can store a copy of your data on the on-premises backup gateway.

Important: The on-premises backup gateway must be able to connect to the Metallic Backup Service and must be able to access the servers that need to be backed up.

Data flow

Hardware requirements

Install the backup gateway package on a server that meets the following minimum requirements.

Requirements1TB/10VMs3TB/30VMs10TB/100VMs30TB/300VMs
CPU2 vCPUs2 vCPUs2 vCPUs4 vCPUs
RAM8 GB16 GB16 GB32 GB
Disk: Operating system and program files300 GB, 200 IOPS500 GB, 250 IOPS1 TB, 250 IOPS3 TB, 500 IOPS
Disk: On-premises copy (30 days retention maximum)2 TB, any IOPS6 TB, any IOPS20 TB, any IOPS60 TB, any IOPS

Network requirements

  • TCP 443 outbound must be open for network access to backup service hosts and storage services (*.metallic.io).
  • To back up VMware servers, the backup gateway must be able to access the VMware environment and components:
    • vCenter: Port for web service (default: 443) must be opened. If vCenter is configured to use non-default ports, the non-default ports must also be opened.
    • ESX Server: Ports for web service (default: 443) and TCP/IP (default: 902) must be opened for the vStorage APIs for data protection.
  • To back up Hyper-V virtual machines (VMs), the Metallic VM proxy must be able to access the backup gateway on the port for the web service (default: 443).

Sizing

Requirements1TB/10VMs3TB/30VMs10TB/100VMs30TB/300VMs
Network interface card1 Gbps NIC1 Gbps NIC10 Gbps NIC2 10 Gbps NIC
Available internet bandwidth requirements30 Mbps100 Mbps1 Gbps3 Gbps

Supported operating systems

The following operating systems are supported:

  • Microsoft Windows Server 2019 Editions
  • Microsoft Windows Server 2012 R2 Editions
  • Microsoft Windows Server 2012 Editions
  • Microsoft Windows Server 2016 Editions
  • Microsoft Windows Client 10 Editions

VM & Kubernetes

To store data in a cloud, use your own cloud or use the Metallic cloud. To store data on-premises, configure a backup gateway. Data can be stored directly on the backup gateway, or you can access other resources by using a UNC path.

Flow

Subscription Usage for VMs and Kubernetes

You can view usage and metering information in the Subscription Usage tile and the Subscription Usage report on the Hub.

Subscription Usage Tile

The Subscription Usage tile in the Hub displays the total number of unique virtual machines protected from the start of the current month until today.

If a VM was protected for one or more days in the month, the VM is counted as part of the total VM usage. The VM is counted even if it is removed from a backup schedule or if backup data was deleted from the system. If the VM is not backed up in the following months, it is not counted as part of subscription usage for those months.

For example, if VM01 and VM02 are protected on the first day of the month, and VM01 is removed from the system later that month, the total number of VMs protected in the month is two VMs. If VM01 is not backed up in the following month and VM02 is backed up, the total number of VMs protected in the month is one VM.

Subscription Usage for VMs and Kubernetes

Subscription Usage Report

To access the Subscription Usage report, click the link in the Subscription Usage tile in the Hub. The Subscription Usage report lists the names of all the VMs protected from the start of the current month to today. Use this report to validate the subscription usage you are charged for.


Microsoft Azure VM

You can use Metallic to back up and to restore Azure virtual machines (VMs) residing in Azure public cloud datacenters. Metallic backups leverage Azure snapshots and Metallic streaming backups.

To allow Metallic backup services to connect to and to back up your Azure VMs, you must set up an application and tenant in the Azure portal.

Data Flow


Setting Up an Application and Tenant for Azure Resource Manager

To create an Azure virtualization client in the Metallic software, you need to set up an application and tenant for the Azure Resource Manager.

An application is a specific cloud service associated with your Azure account, and the tenant is a client or organization that manages an instance of the cloud service. The application and tenant are associated with your subscription through Azure Active Directory, which provides identity and access management for the Azure cloud.

To complete the setup of the Azure virtualization client in the Metallic software, you need the following:

  • Application name
  • Application ID
  • Subscription ID
  • Tenant ID (Directory ID)
  • Application key
Before You Begin

Collect the following information for your Azure account:

  • Subscription ID for the Azure account
  • User credentials with Service Administrator capabilities, for logging in to your Azure account
Procedure
  1. Log on to the public Azure portal with service administrator credentials.
  2. From the All services menu, select the App registrations tab, and then click on New registration.
  3. Enter the appropriate values for the following:
    • Name: Name of the application to be created on Azure Active Directory.
    • Account type: Select one from the following:
      • Accounts in this organizational directory only
      • Accounts in any organizational directory
      • Accounts in any organizational directory and personal Microsoft accounts.
    • Redirect URIOptional. https://app_name (URL including the application name you specify). For example: MyWebApp and https://MyWebApp.
  4. Click Register.
    The application will be listed on the App Registration tab. Note down the Application ID.
  5. Go to the API permissions blade.
  6. Click Add a permission to add the required API permissions:
    1. Select the Microsoft API: Azure Service Management.
    2. Select the option to provide delegated permissions to Access Azure Service Management as organization users.
    3. Click Add permissions.
      Note: If you are configuring a Linux proxy, you must also request API permissions for the Microsoft API: Azure Storage.
  7. Go to the Certificates & secrets blade.
  8. Click on New client secret, and then provide the key description and expiration date.
  9. Click Save.
    A unique secret key is generated for the application.
    Important: Save the key value. The key value will be your application password. You will not be able to retrieve the key after you leave the Certificate & secrets tab/blade.
  10. From the All services menu, click the Subscriptions tab, and then select the subscription ID for which the virtualization client needs to be created.
  11. To define a custom role instead of using the predefined Contributor role, do the following:
    Define a custom role to specify more limited permissions that can be used for backup and restore operations, either for a specific resource group or for the subscription as a whole.
    1. Download the CVBackupRole.json file, which contains the minimum permissions needed for Azure backup and restore operations.
    2. Use a JSON editor to modify the following entry and change #SubscriptionID# to your subscription ID: “AssignableScopes” : [“/subscriptions/#SubscriptionID#“]
    3. To create a custom role, refer to Custom roles for Azure resources.
  12. On the Access Control (IAM) tab, click Add to add a service principal user.
  13. On the Add Permissions blade, select the Contributor role or the custom role that you created.
  14. Select Azure AD user, group, or application.
  15. In the Select field, type the application name, and then select the application created in previous step.
  16. You can obtain the Tenant ID from the public Azure cloud by selecting Azure Active Directory > Properties Directory ID.
    The Directory ID is also the Tenant ID.
What to do next

In the Metallic software, create the Azure virtualization client using the Subscription ID, Tenant ID, Application ID, and Application Key.


Accessing the virtual machine overview

To perform operations on your Azure VMs, open the virtual machine overview page.

Procedure

  1. Go to the Hub.
  2. On the VM & Kubernetes tab, in the Protected Data Sources tile, above Virtual Machines, click the number.

    The Virtual machines page appears.

  3. In the Name column, click the virtual machine that you want to open.

Kubernetes

You can use Metallic to back up and restore stateful Kubernetes applications and data.

Backups

Metallic provides the following key backup capabilities:

  • Automatic discovery and backup of applications by using label selectors.
  • Automatic discovery and backup of namespaces.
  • Back up any Kubernetes orchestrated cluster, on-premise or cloud (such as GCP, AWS), and managed Kubernetes PaaS offerings such as Amazon Elastic Kubernetes Service (EKS) and Azure Kubernetes Service (AKS).
  • Back up Kubernetes applications. An application can be a pod, a deployment, a StatefulSet, or a workload.
  • Back up persistent volumes and persistent volume claims.
  • Back up custom resource definitions (CRD).

Restores

Restores You Can Perform
  • Recover a complete application to a previous point in time, including auto deployment to a new application or a new cluster.
  • Recover a sub-application from a composite (custom resource) application.
  • Recover an individual data volume from an application, for attaching to a new application.
  • Recover or download files and folders from data volumes, or application YAML manifests.
Granularity You Can Use for Restores
  • Application and data
  • Data volumes
  • Data (folders and files) from within the volume.
Backups You Can Use for Restores
  • Backups from any date/time, including the most recent backup
Destinations You Can Restore To
  • The current volume, application, or cluster (in place)
  • A different volume, application, or cluster (out of place)

Kubernetes Backup Requirements

Verify that your environment meets the requirements for Kubernetes.

Infrastructure

Metallic supports Kubernetes backups via a backup gateway or via Microsoft Azure Kubernetes Service (AKS).

Metallic Backup Gateway

Ensure that the following infrastructure requirements are met:

  • At least one Windows host (called an access node) that can communicate with the Kubernetes cluster.
  • The access node must have the Virtual Server Agent (VSA) package installed. For information about the access node software and hardware specifications, see “Access Node Software” and “Access Node Hardware”, below.
Microsoft AKS

You can use Microsoft AKS to back up Kubernetes.

There are no infrastructure requirements to use Microsoft AKS.

Access to Kubernetes Cluster

Ensure that the following requirements are met:

  • Kubernetes cluster with access to the kube-apiserver endpoint (for example, https://kube-apiserver:kube-apiserver_port_number). The default API port is 6443.
  • A Kubernetes service account or an account to access Kubernetes.
External Connectivity

Ensure that the Kubernetes cluster can access the Docker Hub (https://hub.docker.com) so that it can download the following docker image: https://hub.docker.com/_/debian.

Note: Metallic downloads and uses the debian:stretch-slim image to create a temporary container during backups.

Kubernetes Distribution

Any CNCF-certified Kubernetes distribution version 1.18, 1.17, 1.16, 1.15 or 1.14.

For a list of CNCF-certified Kubernetes distributions, see CNCF-certified Kubernetes distribution.

The following distributions are validated by Metallic:

Access Node Software

The access node can run the following Windows operating systems:

  • Microsoft Windows Server 2019 Editions
  • Microsoft Windows Server 2016 Editions
  • Microsoft Windows Server 2012 R2 Editions
Access Node Hardware

For faster backups and restores, you can install multiple access nodes.

Ensure that each access node meets the following minimum hardware specifications:

  • 2 x vCPUs
  • 4 GB RAM
  • 100 MB of local disk space for the Commvault software
  • 1GbE network interface for backup data

Kubernetes Backup Guided Setup

You can follow a guided setup for Kubernetes backup. The setup creates a cluster configuration and enables the Kubernetes solution.

For more information, see the following:


Guided Setup – Kubernetes Backup Across a Local Network Via a Backup Gateway

You can follow a guided setup for Kubernetes backup across a local network via a backup gateway. The setup creates a cluster configuration and enables the Kubernetes solution.

Before You Begin

Ensure that at least one Linux or Windows host can communicate with the Kubernetes cluster. The host must have the Virtual Server Agent (VSA) package installed.

Procedure

  1. Go to the Hub.
  2. On the VM & Kubernetes tab, select New configuration > Kubernetes.

    The How do you want to deploy your backup? page appears.

  3. Select Backup via Gateway and then click Next.

    The Select backup gateway page appears.

  4. Follow the instructions on the page to download and install the software on the backup gateway.
  5. Enter the hostname for the backup gateway.
  6. Click Next.

    The Configure a local backup target for quick restores page appears.

  7. Follow the instructions on the page to add a new local storage location.
  8. Optional: Select Backup directly to cloud without a local backup target.

    The Configure cloud backup storage page appears.

    1. In the Storage account list, select your storage account.
    2. In the Cloud storage provider list, select your Cloud storage provider.
    3. In the Storage region list, select your storage region.
    4. In the New storage location name field, enter a name for your storage location.
    5. In the Account name field, enter the email address of your account.
    6. In the Access key ID field, enter your access key ID.
    7. In the Container field, select a container.
    8. Click Create.
  9. Click Next.

    The Create a plan page appears.

  10. Select a retention plan from the options on the page.
  11. In the New plan name field, enter a plan name.
  12. Click Create.
  13. Click Next.

    The Add cluster page appears.

  14. In the API server endpoint field, enter the API server endpoint URL.

    Typically, the URL is https://kube-apiserver:kube-apiserver_port_number. If you do not know the URL, you can use the kubectl config view.

  15. In the Name field, enter a name for the cluster.
  16. In the Authentication list, select the authentication method as follows:
    • Service account: Enter the Kubernetes service account name, and then copy the token into the Service token box.

      A Kubernetes service account that is used to access Kubernetes must have the cluster admin role assigned.

    • Kubeconfig file: Select the configuration file.
    • User name and password: Enter the user name and password.
  17. Click Next.
  18. The Add application group page appears.
  19. In the Cluster list, select a cluster.
  20. In the Name field, enter a name for the application group.
  21. Browse for and then select the applications to back up.
  22. Click Save.

Guided Setup – Kubernetes Backup Directly to the Azure Kubernetes Service (AKS)

You can follow a guided setup for Kubernetes backup directly to the Azure Kubernetes Service (AKS).

Before You Begin

Ensure that at least one Linux or Windows host can communicate with the Kubernetes cluster. The host must have the Virtual Server Agent (VSA) package installed.

Procedure

  1. Go to the Hub.
  2. On the VM & Kubernetes tab, select New configuration > Kubernetes.

    The How do you want to deploy your backup? page appears.

  3. Select Azure AKS.

    The Configure cloud backup storage page appears.

  4. In the Storage account list, select your storage account.
  5. In the Cloud storage provider list, Microsoft Azure storage is selected.
  6. In the Storage region list, select your storage region.
  7. In the New storage location name field, enter a name for your storage location.
  8. In the Account name field, enter the email address of your account.
  9. In the Access key ID field, enter your access key ID.
  10. In the Container field, select a container.
  11. Click Create.
  12. Click Next.

    The Create a plan page appears.

  13. Select a retention plan from the options on the page.
  14. In the New plan name field, enter a plan name.
  15. Click Create.
  16. Click Next.

    The Add cluster page appears.

  17. In the API server endpoint field, enter the API server endpoint URL.

    Typically, the URL is https://kube-apiserver:kube-apiserver_port_number. If you do not know the URL, you can use the kubectl config view.

  18. In the Name field, enter a name for the cluster.
  19. In the Authentication field, select the authentication method as follows:
    • Service account: Enter the Kubernetes service account name, and then copy the token into the Service token box.

      A Kubernetes service account that is used to access Kubernetes must have the cluster admin role assigned.

    • Kubeconfig file: Select the configuration file.
    • User name and password: Enter the user name and password.
  20. Click Next.

    The Add application group page appears.

  21. In the Cluster list, select a cluster.
  22. In the Name field, enter a name for the application group.
  23. Browse for and then select the applications to back up.
  24. Click Save.

Kubernetes Restores

You can restore the applications and data in a Kubernetes cluster to its current location (in place), to a different cluster (out of place)

Types of Restore You Can Perform

  • Application restore
  • Volume and data restore
  • Application manifest restore

Restore Kubernetes Applications

You can restore the Kubernetes applications in-place or out-of-place.

Restoring Kubernetes Applications In Place

You can restore Kubernetes applications in place.

Procedure

  1. From the navigation pane, go to Protect > Kubernetes.

    The Clusters page appears.

  2. In the Name column, click the cluster.

    The cluster page appears.

  3. Under Application groups, in the row for the application group that you want to restore, click the action button, and then click Restore.

    The Select restore type page appears.

  4. Click Full application.

    The Restore page appears.

  5. Select the applications to restore.
  6. To restore from a specific copy of backup data, in the upper-right corner of the page, from the Restore from default copy list, select the copy.

    If you select Restore from default copy (default), the restore operation searches for the requested data in the primary copy, and automatically selects a different copy if the data is not found in the primary copy.

  7. Click Restore.

    The Restore options dialog box appears.

  8. From the Access node list, select the access node.
  9. Click Submit.
Restoring Kubernetes Applications Out of Place

You can use out-of-place restores to migrate Kubernetes applications and data across cloud providers, from on-premise to cloud, or from cloud to on-premise.

You can perform out-of-place restores to any Kubernetes cluster, for example:

  • To a different cluster
  • From EKS to on-premise

Out-of-place restores allow you to configure a different storage class that will be used to provision the data volumes. Storage classes abstract the underlying physical storage tier used by the Kubernetes cluster. With this approach, the development and test restores of production data do not incur the cost of primary production storage.

Procedure

  1. From the navigation pane, go to Protect > Kubernetes.

    The Clusters page appears.

  2. In the Name column, click the cluster.

    The cluster page appears.

  3. Under Application groups, in the row for the application group that you want to restore, click the action button, and then click Restore.

    The Select restore type page appears.

  4. Click Full application.

    The Restore page appears.

  5. Select the applications to restore.
  6. Click Restore.

    The Restore options dialog box appears.

  7. Click Out of place.
  8. Click Submit.

Restore Kubernetes Volume and Data

You can restore the Kubernetes volumes and data in-place or out-of-place.

Restoring Kubernetes Volumes and Data In Place

You can restore the Kubernetes data volumes or specific files and folders in place.

Procedure

  1. From the navigation pane, go to Protect > Kubernetes.

    The Clusters page appears.

  2. In the Name column, click the cluster.

    The cluster page appears.

  3. Under Application groups, in the Actions column for the application group, click the action button, and then click Restore.

    The Select restore type page appears.

  4. Click Volumes and data.

    The Restore page appears.

  5. Select the volumes or specific files and folders to restore.
  6. To restore from a specific copy of backup data, in the upper-right corner of the page, from the Restore from default copy list, select the copy.

    If you select Restore from default copy (default), the restore operation searches for the requested data in the primary copy, and automatically selects a different copy if the data is not found in the primary copy.

  7. Click Restore.

    The Restore options dialog box appears.

  8. Click In place.
  9. Click Submit.
Restoring Kubernetes Volumes and Data Out of Place

You can restore the Kubernetes data volumes or specific files and folders out of place.

Note: For OpenShift, verify that the applications are not running when you perform a restore to a PVC.

Procedure

  1. From the navigation pane, go to Protect > Kubernetes.

    The Clusters page appears.

  2. In the Name column, click the cluster.

    The cluster page appears.

  3. Under Application groups, in the Actions column for the application group, click the action button, and then click Restore.

    The Select restore type page appears.

  4. Click Volumes and data.

    The Restore page appears.

  5. Select the volumes or specific files and folders to restore.
  6. To restore from a specific copy of backup data, in the upper-right corner of the page, from the Restore from default copy list, select the copy.

    If you select Restore from default copy (default), the restore operation searches for the requested data in the primary copy, and automatically selects a different copy if the data is not found in the primary copy.

  7. Click Restore.

    The Restore options dialog box appears.

  8. Click In place.
  9. Click Submit.

Restore Kubernetes Application Manifests

You can restore the Kubernetes application manifests to a specific path on the access node.

You can restore Kubernetes configurations by using the manifest YAML files. A YAML file is used to store or transfer application configurations between applications.

Restoring Kubernetes Application Manifests

From a YAML file, you can restore the Kubernetes data volumes or specific files and folders, to a specific path on the access node.

Procedure

  1. From the navigation pane, go to Protect > Kubernetes.

    The Clusters page appears.

  2. In the Name column, click the cluster.

    The cluster page appears.

  3. Under Application groups, in the Actions column for the application group, click the action button, and then click Restore.

    The Select restore type page appears.

  4. Click Application manifests.

    The Restore page appears.

  5. Select the YAML file to restore.
  6. Click Restore.

    The Restore options dialog box appears.

  7. From the Access node list, select an access node to stage the data for the restore operation.
  8. To use a saved user credentials to access data, enable the Impersonate user slider, and then select the credential to use.
  9. In the Path box, type the full path to the destination folder.
  10. To overwrite the existing data, move the Unconditionally overwrite if it already exists toggle key to the right.
  11. Click Submit.

Application Consistent Protection for Kubernetes

For Kubernetes, you can add pre-process script files or post-process script files on both Windows and Linux access nodes.

Pre-scripts and post-scripts are batch files or shell scripts that you can run before or after certain job phases. Both pre-script and post-script must be provided for application consistent protection.


Migration Use Cases for Kubernetes

You can use backups and restores to migrate Kubernetes data and applications.

Application Migration Using Out-of-Place Restores

You can use out-of-place restores to migrate applications as follows:

  • From on-premise clusters to cloud-managed clusters (for example, AKS, or EKS)
  • From one one cloud-managed cluster to another cloud provider (for example, between AWS, Azure)
  • From a cloud-managed cluster to a cloud IaaS cluster (for example, from EKS/AKS to AWS EC2, Azure)

Data Migration Using Backups

You can use application backups or volume backups to migrate data. You can use backups to migrate data across cloud providers, from on-premise to cloud, and from cloud to on-premise.

Related Topics

Restoring Kubernetes Applications Out of Place


Requirements for backing up Hyper-V servers

Review the following requirements if you want to back up on-premises Hyper-V servers.

To backup on-premises data, a backup gateway is required. To review the requirements for the backup gateway, see Backup gateway requirements.

Hyper-V deployment model

To back up Hyper-V virtual machines (VMs), Metallic VM proxy for Hyper-V must be installed on each Hyper-V host in the cluster. The Metallic VM proxy for Hyper-V communicates on TCP port 443 with the Metallic backup services hosted in the cloud and with the Metallic backup gateway.

Best Practice: Install the Metallic VM proxy for Hyper-V and the Metallic backup gateway on the same local network for the best backup and recovery performance. Using this configuration, options for both local and cloud backup copies are available.

Authenticating to Hyper-V

  • Obtain the user credentials to access the Hyper-V server from your Hyper-V administrator. The user must be part of the following administrator groups on the Hyper-V host:
    • Local Administrators group (for Hyper-V Server 2008 R2 and Hyper-V Server 2016)
    • Any user that are part of Hyper-V Administrators group (for Hyper-V Server 2012 and 2012 R2)
    For a Hyper-V cluster, the user account must have full Cluster Permissions (Read and Full Control).

Physical machine operating systems

  • Microsoft Windows Server 2019 (including Core Edition)
  • Microsoft Hyper-V Server 2019 (including Core Edition)
  • Microsoft Windows Server, version 1709 (including Core Edition)
  • Microsoft Hyper-V Server, version 1709 (including Core Edition)
  • Microsoft Windows Server 2016 (including Core Edition)
  • Microsoft Hyper-V Server 2016 (including Core Edition)
  • Microsoft Windows Server 2012 R2 (including Core Edition)
  • Microsoft Hyper-V Server 2012 R2 (including Core Edition)
  • Microsoft Windows Server 2012 (including Core Edition)
  • Microsoft Hyper-V Server 2012 (including Core Edition)
  • Microsoft Windows Server 2008 R2 SP1

Virtual machine operating systems

All guest operating systems supported by Microsoft Hyper-V.

Hyper-V integration services

To back up the virtual machines on a Hyper-V server or cluster, Hyper-V integration services must be installed and updated on the virtual machine.

Hard drive

100 GB is recommended.

Allocation unit size of the NTFS volumes

The cluster size or the allocation unit size of an NTFS volume in a virtual machine must be multiple of 1024 bytes. You can set the cluster size before formatting a volume. The default cluster size is 4096 bytes.

Microsoft Visual C++

The following Redistributable Package is installed automatically. The Redistributable Package can co-exist with other versions of this software.

  • Microsoft Visual C++ 2010 Redistributable Package
  • Microsoft Visual C++ 2013 Redistributable Package
  • Microsoft Visual C++ 2017 Redistributable Package

Disclaimer

Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works. Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor releases or service packs are compatible with the Commvault software.

Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.


Requirements for backing up VMware servers

Review the following requirements if you want to back up on-premises VMware servers.

To backup on-premises data, a backup gateway is required. To review the requirements for the backup gateway, see Backup gateway requirements.

VMware vCenter Server Support

The following versions are supported for vCenter Server and vCenter Server Appliance. vCenter Server support includes support for vSphere, Virtual Disk Development Kit (VDDK), ESX or ESXi, and file system versions as provided by the vCenter version.

For more information, see Correlating build numbers and versions of VMware products (1014508).

As a general rule of thumb, each version of the VDDK supports vCenter Server for the two previous major versions and for the next minor version. For example, VDDK 6.0.0 can be used with vCenter Server 5.5, 5.1, or 6.0 Update 1.

When VMware issues new versions or updates, Metallic tests against the current service pack before announcing support. For new VMware versions or updates released between Metallic service packs, and for earlier supported versions or service packs, Metallic provides continuing support, including Hot Fixes as needed to address VMware changes to functions that affect backup and recovery.

vCenter Server Version

  • 6.7 Update 3 (all minor updates)
  • 6.7 Update 2 (all minor updates)
  • 6.7 Update 1 (all minor updates)
  • 6.7 (all minor updates)
  • 6.5 Update 3 (all minor updates)
  • 6.5 Update 2 (all minor updates)
  • 6.5 Update 1 (all minor updates)
  • 6.5 GA (all minor updates)
  • 6.0 Update 3 (all minor updates)
  • 6.0 Update 2 (all minor updates)
  • 6.0 Update 1 (all minor updates)
  • 6.0 GA (all minor updates)
  • 5.5 Update 3 (all minor updates)
  • 5.5 Update 2 (all minor updates)
  • 5.5 Update 1 (all minor updates)
  • 5.5 GA (all minor updates)
  • 5.1 (all updates)
  • 5.0 (all updates)
  • 4.1 (all updates)

Note: If VMs are part of ESX 4.1, then streaming and IntelliSnap backups are supported only through the vCenter. You cannot use a standalone ESX 4.1 server.

ESX Host Support

Before configuring backup of any ESXi servers, ensure that you are using Essentials licensing level or higher. The vStorage APIs for Data Protection (VADP) are not provided with the free version of ESXi.

VDDK Support

Metallic includes the latest supported VDDK. Multiple versions of the VDDK are included, and the appropriate VDDK for the vSphere version is loaded automatically when required.

vCenter Server Versions Required for Specific Features

Some features are supported only for more recent versions of vCenter Server. The following table shows the required versions for features that are dependent on the version of vCenter Server and associated software. Support includes all updates for each major version unless an update is specifically excluded.

FeatureRequired Version of vCenterServer
Agentless file restores5.1, 5.5, 6.0, 6.5, 6.7
File Recovery Enabler for Linux4.1, 5.1, 5.5, 6.0, 6.5, 6.7

Virtual Machine Hardware

Version 4.0, 7.0, 8.0, 9.0, 10.0, 11.0, 13.0, 14.0, 15.0

Virtual Machine Operating Systems

All Guest Operating Systems supported by VADP.

Datastore Support

  • Network File System (NFS)
  • Virtual Machine File System (VMFS)
  • Virtual storage area network (vSAN)
  • VMware Virtual Volume (VVol)

VMware Tools on Virtual Machines

The latest version of VMware Tools supported by the host should be installed on each virtual machine. At a minimum, the version of VMware tools on virtual machines must be supported on the host; unsupported versions must be upgraded. For more information about VMware Tools support for Windows and Linux guest VMs, see the VMware Compatibility Guide.

open-vm-tools

For UNIX guest VMs running the following operating system releases, open-vm-tools can be used:

  • Fedora 19 and later
  • Debian 7.x and later
  • openSUSE 11.x and later
  • Recent Ubuntu (12.04 LTS, 13.10 and later)
  • Red Hat Enterprise Linux 7.0 and later
  • CentOS 7.0 and later
  • Oracle Linux 7.0 and later
  • SUSE Linux Enterprise 12 and later

For more information, see VMware support for open-vm-tools (2073803).

Port Requirements

In an environment with firewalls, the vCenter, ESX servers, and Virtual Server Agent must be able to communicate with each other. To ensure that all components can communicate through the firewall, ensure that the ports for web services (default: 443) and TCP/IP (default: 902) are opened for bidirectional communication on each of these machines.

vCenter
  • Port for web service (default: 443) must be opened. If vCenter is configured to use non-default ports, the non-default ports must also be opened.

ESX Server

  • Ports for web service (default: 443) and TCP/IP (default: 902) must be opened for the vStorage APIs for Data Protection

Allocation Unit Size of NTFS Volumes

The cluster size or the allocation unit size of an NTFS volume in a virtual machine must be multiple of 1024 bytes per cluster. You can set the cluster size before formatting a volume. The default cluster size is 4096 bytes per cluster.

Disclaimer

Third-party maintenance (minor) releases or service packs that are supported by the Commvault software may not be listed in our System Requirements. When possible, Commvault provides information on any known issues related to these minor releases or service packs. In some cases, these minor releases or service packs affect how the Commvault software works. Commvault software may experience changes in functionality as the result of the third-party minor release or service pack. These changes are beyond the control of Commvault. Platforms that are supported in the current version of Commvault software may not be supported in earlier versions of the software. Contact your software provider to ensure that third-party minor releases or service packs are compatible with the Commvault software.

Additional considerations regarding minimum requirements and End-of-Life policies from third-party vendors also apply.


Transport Modes for VMware

By default, the transport mode is selected automatically for backups and restores, based on the gateway used and the virtual machines being backed up or restored. You can force a specific transport mode by configuring it.

The following transport modes are available in VMware. Advanced transport methods (HotAdd) replace the proxy-based VMware Consolidated Backup (VCB) solution.

  • SAN (storage area network) – SAN mode is supported for directly connected storage using Fibre Channel (FC) or Internet SCSI (iSCSI) protocols. With automatic transport mode selection, SAN mode is selected if SAN storage is connected to the ESX host. The Virtual Server Agent must have access to the datastore LUNs (logical drives) that provide storage for virtual machine disks. Data is read directly from the storage where virtual machines reside, without going through the ESX host or transferring data over the local area network (LAN). The ESX host is contacted only to coordinate access to the LUN.
  • HotAdd – In HotAdd mode, software is installed on a virtual machine residing on an ESX Server. The term HotAdd refers to the way the backups are completed. In HotAdd mode, virtual disks from the virtual machines being backed up are automatically mounted to the gateway, so they can be accessed by the gateway as local disks. The ESX host the gateway is running on must have access to all datastores for the virtual machine. If the virtual machine and the gateway are not on the same host, all datastores must be shared between the hosts. In vSphere 5.0, the SCSI HotAdd feature is enabled only for vSphere editions Enterprise and higher, which have Hot Add licensing enabled. No separate Hot Add license is available for purchase as an add-on. In vSphere 4.1, Hot Add was also enabled in the Advanced edition. Customers with vSphere Essentials or Standard editions are not able to perform proxy-based backup, which relies on SCSI HotAdd. Those customers must use alternate transport modes.
  • Local Area Network (NBD and NBDSSL) – NBD (network block device) and NBDSSL (encrypted NBD) transmit data over the TCP/IP connection between the ESX server and the gateway computer. NBD serves as a fallback when other transport modes are not available. The local area network (LAN) can be the production network or a dedicated backup network. NBDSSL is similar to NBD mode, but data transfer between the gateway computer and the ESX server is encrypted. Encryption should be used for sensitive information, even within a private network.

SAN and HotAdd transport can enable LAN-free backups and restores. In most scenarios, backups and restores using SAN and HotAdd transport are faster than local area network (LAN) operations using network block device (NBD) or secure NBD (NBDSSL).

SAN restores using thin disk provisioning can be slower than LAN restores; performance can be improved by using NBD or by setting the transport mode to SAN and forcing the disk type to thick, which uses eager zero provisioning.

The following table summarizes the configurations based on the storage type.

ModeDatastore Storage TypeVM Data Protected by Single NodeAdditional Comments
LAN Free SAN modeVMFS using Fibre Channel or iSCSIUp to 40 TBSoftware installed on the same physical computer with direct connection to datastore.

Eliminates data transfer over network during backup and restore. Provides best backup and restore performance.
LAN Free HotAdd modeVMFS, NFS, vSAN, VVolUp to 30 TBSoftware installed on virtual machine running on host with access to datastore.

Eliminates data transfer over network during backup and restore.
Network based (NBD, HotAdd, NAS)VMFS, NFS, vSAN, VVol, direct attached storageSoftware installed on different computers. The software writes over the network to a remote computer.

Depends on infrastructure.
Connectivity

Configure DNS on the backup gateway, ESX hosts, and vCenter Server. For any transport mode, missing or incorrect DNS configuration produces nslookup errors during fully qualified domain name (FQDN) resolution.


File & Object Storage


Subscription Usage for Files and Objects

You can view usage and metering information in the Subscription Usage tile and the Subscription Usage report on the Hub.

Subscription Usage Tile

The Subscription Usage tile in the Hub displays the peak front-end size for file and object data protected from the start of the current month until today. The front-end size is the source data capacity before compression and deduplication.

If file and object data was protected for one or more days in the month, the data is counted as part of the peak front-end size for that month. The data is counted even if it is removed from a backup schedule or if backup data was deleted from the system. If the file and object data is not backed up in the following months, it is not counted as part of subscription usage for those months.

For example, if FS01 and FS02 (each with 1 GB capacity) are protected on the first day of the month, and FS01 is removed from the system later that month, the peak front-end size protected in the month is 2 GB. If FS01 is not backed up in the following month and FS02 is backed up, the peak front-end size protected in the month is 1 GB.

Subscription Usage for Files and Objects

Subscription Usage Report

To access the Subscription Usage report, click the link in the Subscription Usage tile in the Hub. The Subscription Usage report lists the names of all the file and object servers or instances with front-end size protected from the start of the current month to today. Use this report to validate the subscription usage you are charged for.


Files

To store data in a cloud, use your own cloud or use the Metallic cloud. To store data on-premises, configure a backup gateway. Data can be stored directly on the backup gateway, or you can access other resources by using a UNC path.

Data flow


Push installations

Applies to: Core installations for Windows, Linux, and Microsoft SQL Server

To install software on the server that you want to back up, you can push the software from the backup gateway to the server. To perform a push installation, you need the name of the server that you want to back up and the user credentials for the server.

To successfully perform a push installation, do the following:

  • Verify that the backup gateway has network access to the server.
  • Obtain system administrator (sysadmin) user credentials for the server.
  • Windows computers: The Remote Registry service must be enabled and configured to automatically start during the computer startup.
Firewall and Network Port Requirements

Turn off the firewall services on the server, and temporarily open the following inbound network ports before performing the push installation:

  • For UNIX, Linux, and Macintosh computers, enable SSH (Secure Shell), and then open port 22.
  • For Windows computers, do the following:
    • Open Port 135 for DCOM (Distributed Component Model).
    • Open Port 139 for NetBIOS Session Service (if you are using legacy Windows computers, such as Windows NT or earlier versions).
    • Open Port 445 for SMB (Server Message Block) file sharing.
    • Open the Windows Management Instrumentation (WMI) port. For instructions on setting up a fixed port for WMI, see Setting Up a Fixed Port for WMI on the Microsoft website.
    • Important: If Windows Firewall is enabled on the computer, do one of the following:
      • Temporarily open the following ports in Windows Firewall: – Port 135 for DCOM-In (COM + Network Access) – Port 445 for SMB – WMI port
      • Set up a remote cache in the network where the computer resides.

Customizing the Backup Content for a Server

You can customize the backup content for a file server.

The backup content originally comes from the plan associated with the file server. If you customize the backup content for the file server, the backup content on the plan is not affected.

The following tabs are available to add customized content:

  • On the Content tab, you specify the content that you want to back up.
  • On the Exceptions tab, you specify the content that you do not want to back up.
  • On the Exclusions tab, you specify exclusions to the the content that you specified in the exceptions list.
Procedure
  1. From the navigation pane, go to Protect File servers. The File servers page appears.
  2. In the Actions column for the server, click the action button, and then click Edit plan association. The Edit plan dialog box appears. The plan associated with the file server and the backup content defined in the plan are displayed.
  3. Move the Define your own backup content toggle key to the right.
  4. Complete the following steps to add customized content:
OptionOn tabsSteps
Enter custom pathContent
Exclusions
Exceptions
Type a path, and then click the add button
BrowseContent
Exclusions
Exceptions
1. Click Browse.
The Select a path dialog box appears.
2. Select a file or folder.
3. Click Save.
The path is added to the Files and folders table.
Content LibraryContent
Exclusions
Use the Content Library to select well known folders, such as Desktop, and file types.
1. Click Content Library.
The Add content dialog box appears.
2. Select content.
3. Click Save.
The path is added to the Files and folders table.
Impersonate userContentUse Impersonate user to use a saved user credential to access the file system.
1. Click Impersonate user.
The Impersonate user dialog box appears.
2. From the Credential list, select the user credential.
3. Click OK.
Files and foldersContent
Exclusions
Exceptions
Select the check boxes.
Important: If you do not select a check box, then that content is not included, excluded, or excepted from the exclusions.
Include global exclusion filtersExclusionsFrom the list, select one of the following options:
– Use cell level policy (default): Enables or disables the global exceptions for the default subclient depending on whether the Use global filters on all subclients option is enabled for the environment.
– On: Enables the global exceptions for the default subclient.
– Off: Disables the global exceptions for the default subclient.
  1. Click Save.

Microsoft Azure

You can configure your Azure blobs and files to back up directly to Metallic Azure storage without installing additional hardware or software. You can also back up Azure blobs and files to your own Azure storage.

Avoid Egress Charges

To avoid paying Azure egress charges, the Azure region the storage is located in must be the same Azure region that you back up to. For example, if you are backing up a blob located in Central US, the backup storage must also be located in Central US.

Supported Azure Regions

  • Central US
  • East US
  • East US 2
  • North Central US
  • South Central US
  • West Central US
  • West US
  • West US 2
  • Canada Central
  • Canada East
  • Australia Central (Canberra)
  • Australia Central 2 (Canberra)
  • Australia East (New South Wales)
  • Australia Southeast (Victoria)
  • UK South
  • UK West
  • West Europe
  • North Europe
  • Norway East

Accessing the object storage overview

To perform operations on your Azure blob, open the object storage overview page.

Procedure
  1. Go to the Hub.
  2. On the File & Object tab, in the Protected Data Sources tile, above Object Storage, click the number.
    The Object storage page appears.
  3. In the Name column, click the object storage that you want to open.

Azure Blob

You can configure your Azure blob to back up directly to Metallic Azure storage without installing additional hardware or software. You can also back up your Azure blob to your own Azure storage.

To back up multiple storage accounts, configure each storage account individually.

Data Flow

Restoring an Azure Blob in Place

To restore an Azure blob backup to its original location, use the in-place restore operation.

Procedure

  1. From the navigation pane, go to Protect > Object storage.The Object storage page appears.
  2. In the Object storage table, right-click the object storage repository that you want to restore, and then click Restore.
    The Backup content page appears.
  3. In the backup content list, select the backups to restore, and then click Restore.
    The Restore options dialog box appears.
  4. On the In place tab, specify the following information:
    • No of streams: Enter the number of streams to use for the restore operation.
    • Select one of the following:
      • Overwrite files unconditionally
      • Overwrite files only if the backed up file is newer
  5. Click Submit.

Restoring an Azure Blob Out of Place

To restore an Azure blob backup to a different blob (not the original blob), use the restore out-of-place operation.

Procedure

  1. From the navigation pane, go to Protect > Object storage.
    The Object storage page appears.
  2. In the Object storage table, right-click the object storage repository that you want to restore, and then click Restore.
    The Backup content page appears.
  3. In the backup content list, select the backups to restore, and then click Restore.
    The Restore options dialog box appears.
  4. On the Out of place tab, specify the following information:
    • Destination target: Type the path to the target.
    • No of streams: Type the number of streams to use for the restore operation.
    • Destination path: Type the full restore location path.
    • Select one of the following:
      • Overwrite files unconditionally
      • Overwrite files only if the backed up file is newer
  5. Click Submit.

Azure Files

You can configure your Azure files to back up directly to Metallic Azure storage without installing additional hardware or software. You can also back up your Azure files to your own Azure storage.

To back up multiple storage accounts, configure each storage account individually.

Data Flow

Restoring an Azure File in Place

To restore an Azure file backup to its original location, use the in-place restore operation.

Procedure

  1. From the navigation pane, go to Protect > Object storage.
    The Object storage page appears.
  2. In the Object storage table, right-click the object storage repository that you want to restore, and then click Restore.
    The Backup content page appears.
  3. In the backup content list, select the backups to restore, and then click Restore.
    The Restore options dialog box appears.
  4. On the In place tab, specify the following information:
    • No of streams: Enter the number of streams to use for the restore operation.
    • Select one of the following:
      • Overwrite files unconditionally
      • Overwrite files only if the backed up file is newer
  5. Click Submit.

Restoring an Azure File Out of Place

To restore an Azure file backup to a different location (not the original location), use the restore out-of-place operation.

Procedure

  1. From the navigation pane, go to Protect > Object storage.
    The Object storage page appears.
  2. In the Object storage table, right-click the object storage repository that you want to restore, and then click Restore.
    The Backup content page appears.
  3. In the backup content list, select the backups to restore, and then click Restore.
    The Restore options dialog box appears.
  4. On the Out of place tab, specify the following information:
    • Destination target: Type the path to the target.
    • No of streams: Type the number of streams to use for the restore operation.
    • Destination path: Type the full restore location path.
    • Select one of the following:
      • Overwrite files unconditionally
      • Overwrite files only if the backed up file is newer
  5. Click Submit.

Database

To store data in a cloud, use your own cloud or use the Metallic cloud. To store data on-premises, configure a backup gateway. Data can be stored directly on the backup gateway, or you can access other resources by using a UNC path.

Data flow


Subscription Usage for Databases

You can view usage and metering information in the Subscription Usage tile and the Subscription Usage report on the Hub.

Subscription Usage Tile

The Subscription Usage tile in the Hub displays the peak front-end size for database data protected from the start of the current month until today. The front-end size is the source data capacity before compression and deduplication.

If database data was protected for one or more days in the month, the data is counted as part of the peak front-end size for that month. The data is counted even if it is removed from a backup schedule or if backup data was deleted from the system. If the database data is not backed up in the following months, it is not counted as part of subscription usage for those months.

For example, if DB01 and DB02 (each with 1 GB capacity) are protected on the first day of the month, and DB01 is removed from the system later that month, the peak front-end size protected in the month is 2 GB. If DB01 is not backed up in the following month and DB02 is backed up, the peak front-end size protected in the month is 1 GB.

Subscription-Usage-for-Databases

Subscription Usage Report

To access the Subscription Usage report, click the link in the Subscription Usage tile in the Hub. The Subscription Usage report lists the names of all the database servers or instances with front-end size protected from the start of the current month to today. Use this report to validate the subscription usage you are charged for.


Oracle

You can use the Metallic software to back up and restore Oracle databases.

Backups

Data You Can Back Up

  • Database files
  • Log files
  • The control file

Backups You Can Perform

  • Full backups
  • Incremental backups

When You Can Perform Backups

  • On a schedule: The server plan that you assign manages scheduled backups
  • On demand: You can perform on-demand backups at any time

Restores

Data You Can Restore

  • Full database: This restore operation includes the database, the log files, and the control file.
  • Partial database: A combination of any of the following files
    • Archive logs
    • Control file
    • Individual data files and tablespaces
    • Database archived redo logs

Recover Options You Can Specify

  • Recover to the most recent backup
  • Recover to the current time
  • Recover to a point in time
  • Recover to a System Change Number (SCN)

Destinations You Can Restore To

  • The current location (in place)
  • A different server or instance (out of place)
  • Clone to a new server or a new instance

Automatic Instance Discovery

By default, after the Metallic agent is installed, database instances are automatically discovered. Auto discovery depends on the following conditions:

  • By default, database instance discovery runs every 24 hours.
  • Metallic uses instances that are defined in the Oracle oratab file, which is created by Oracle at installation and acts as a database registry file. On Solaris systems, this file is normally located in the /var/opt/oracle directory. On Linux/UNIX systems, it is located in the /etc directory.
  • Metallic discovers single instance Oracle (non-clustered) instances that are in the NOMOUNT, MOUNT, or OPEN state. It does not discover database instances that are shut down.

Oracle Backups

You can back up online or offline Oracle databases, log files, or Oracle datafiles and tablespaces. If the database must be accessible and you have a small backup window, run a series of online backups for different database portions.

You can run backups immediately or configure a schedule for the subclient.

Full Backups

Oracle full backups include the entire database and the control file. A full backup is the most comprehensive backup and is the baseline for incremental backups. Full backups of online databases include the log files. An offline full backup is a cold backup for Oracle databases.

Incremental Backups

An Oracle incremental backup contains the changed data from the last full backup. Incremental backups use less media and resources than full backups.

In a cumulative level n backup, only the data that differs from the most recent backup at level n-1 or lower, is backed up.

What Is Backed Up

  • Oracle database files that include the datafiles and control files
  • Archived redo logs
  • Parameter files (SP File)
  • Oracle Managed Files

What Is Not Backed Up

  • Oracle application files that are associated with the Oracle installation.
  • External files, for example, Oracle Wallet, and external tables.

Performing Oracle Backups

You can back up Oracle databases, log files, or Oracle datafiles and tablespaces. You can back up the database when it is online or offline. If the database must be accessible and you have a small backup window, run a series of online backups for different database portions.

You can perform a full, incremental or cumulative backup.

A full backup includes the database, the log files, and the control file.

An incremental backup contains the changed data from the last successful backup. Incremental backups use fewer resources than full backups. If you do not have any successful backups and you perform an incremental backup, the incremental backup is considered a full backup and all data is backed up.

Procedure

  1. From the navigation pane, go to Protect > Databases.
    The Instances page appears.
  2. To select an instance, on the Instances tab, click the instance name.
    The instance properties page appears.
  3. To select a subclient, in the Subclients section of the Overview tab, click the subclient name.
    The subclient properties page appears.
  4. On the subclient Overview tab, click Back up.
    The Select backup level dialog box appears.
  5. Select the backup level for the backup operation:
    • To perform a full backup operation, select Full.
    • To perform an incremental backup operation, select Incremental.
    • To perform a cumulative backup operation, select Incremental, and then select the Cumulative check box.
  6. To receive an email message when the backup operation is complete, select the When the job completes, notify me via email check box.
  7. Click OK.
    The Backup started dialog box appears.
  8. Optional: View the job details. Click the job ID.
  9. Optional: To view the RMAN log for the backup job, click View RMAN Log.
  10. Click OK.

Oracle Restores

A database restore might be necessary when the data area or the log area is damaged, to recover from a logical error, or to copy the database.

Oracle restores consist of the following main categories:

  • Full database restore: This is an in-place or out-of-place restore of all database files, the control file, and the server parameter file.
  • Database subset: This is a combination of a restore of any of the following files:
    • Archive logs
    • Oracle control file
    • In-place restore of individual datafiles and tablespaces
    • Database archived redo logs
  • Database clones: Create a clone so that you can:
    • Duplicate large databases in a short amount of time
    • Create test environments
    • Retrieve data quickly without intensive resource use on the production environment
    • Alleviate the load on production servers

Restoring a Oracle Database to Its Current Location (In Place)

You can restore Oracle data to the same database on the same client from which the database was backed up.

You can restore the following data:

  • The database and control file
  • The database
  • The control file
  • Individual tablespaces and the control file
  • Individual tablespaces

When you choose the option to recover from the latest backup time or from the latest System Change Number (SCN) with a secondary copy, the software only considers the time or SCN from the latest job available on the secondary copy, even when the primary copy or other copies have a more recent backup job.

Procedure

  1. From the navigation pane, go to Protect > Databases.
    The Instances page appears.
  2. Click the instance.
    The instance page appears.
  3. On the Overview tab, in the Recovery points section, select the backup to restore, and then click Restore.
    The Backup content page appears.
  4. Select the data that you want to restore, and then click Restore.
    The Restore options dialog box appears.
  5. Select the In place tab.
  6. To change the number of streams used for the restore operation, in the Number of streams box, type the number of streams to use.
  7. To specify an alternate directory to restore the database or individual table spaces into, do the following:
    a. Click Redirect.
    The Redirect path options dialog box appears.
    b. To redirect the database, click Database, and then enter the full path for the new location of the database.
    c. To redirect individual tablespaces and datafiles, click Tablespaces and datafiles. For each tablespace that you want to redirect:
    i. Expand the tablespace.
    ii. In the Datafiles box, change the path to the new location.
    d. To redirect the online redo logs, move the Online redo logs toggle key to the right, and then enter the full path for the new location.
    e. Click Save.
  8. Select the data that you want to restore:
    • To restore the database or individual tablespaces, select the Database check box and clear the Control file check box.
    • To restore the control file, clear the Database check box and select the Control file check box.
    • To restore the SP file, clear the Database check box and select the SP File check box.
    • To restore the log files, clear the Database check box.
  9. Select the database Recover to option. These options control how the archive files are applied to the data files.
    • To recover to the latest backup job completion time, select Most recent backup.
    • To recover the database to the current time, select Current time.
    • To recover to a point-in-time, select Point in time, and then enter the date and time.
    • To recover to a System Change Number, select SCN, and then enter the SCN.
      The System Change Number (SCN) tracks the timing of transactions in the Oracle database. The SCNs are stored in the control files and the datafile headers. You can recover the database to the last existing SCN number in the control file, which is the last consistent database state.
  10. Click Submit.

Restoring an Oracle Database to a Different Location (Out of Place)

You can restore the following data:

  • The database and control file
  • The database
  • The control file
  • Individual tablespaces and the control file
  • Individual tablespaces

You can restore the database to an instance with the same name as the source instance to the source client, or a different client.

After the restore, you can recover the database to a point other than the current time, if the current database is inconsistent.

When you choose the option to recover from the latest backup time or from the latest System Change Number (SCN) with a secondary copy, the software only considers the time or SCN from the latest job available on the secondary copy, even when the primary copy or other copies have a more recent backup job.

Procedure

  1. From the navigation pane, go to Protect > Databases.
    The Instances page appears.
  2. Click the instance.
    The instance page appears.
  3. On the Overview tab, in the Recovery points section, select the backup to restore, and then click Restore.
    The Backup content page appears.
  4. Select the data that you want to restore, and then click Restore.
    The Restore options dialog box appears.
  5. Select the Out of place tab.
  6. From the Destination sever list, select the destination host.
  7. From the Destination instance list, select the destination instance.
  8. To change the number of streams used for the restore operation, in the Number of streams box, type the number of streams to use.
  9. To specify an alternate directory to restore the database or individual table spaces into, do the following:
    a. Click Redirect.
    The Redirect path options dialog box appears.
    b. To redirect the database, click Database, and then enter the full path for the new location of the database.
    c. To redirect individual tablespaces and datafiles, click Tablespaces and datafiles. For each tablespace that you want to redirect:
    i. Expand the tablespace.
    ii. In the Datafiles box, change the path to the new location.
    d. To redirect the online redo logs, move the Online redo logs toggle key to the right, and then enter the full path for the new location.
    e. Click Save.
  10. Select the data that you want to restore:
    • To restore the database or individual tablespaces, select the Database check box and clear the Control file check box.
    • To restore the control file, clear the Database check box and select the Control file check box.
    • To restore the SP file, clear the Database check box and select the SP File check box.
    • To restore the log files, clear the Database check box.
  11. Select the database Recover to option. These options control how the archive files are applied to the data files.
    • To recover to the latest backup job completion time, select Most recent backup.
    • To recover the database to the current time, select Current time.
    • To recover to a point-in-time, select Point in time, and then enter the date and time.
    • To recover to a System Change Number, select SCN, and then enter the SCN.
      The System Change Number (SCN) tracks the timing of transactions in the Oracle database. The SCNs are stored in the control files and the datafile headers. You can recover the database to the last existing SCN number in the control file, which is the last consistent database state.
  12. If you want to mask the data on the destination, select the Mask sensitive data check box, and then from the Data masking policy list, select the data masking policy.
  13. Click Submit.

Oracle RAC

You can use the Metallic software to back up and restore Oracle RAC databases.

Backups

Data You Can Back Up

  • Database files
  • Log files
  • The control file

Backups You Can Perform

  • Full backups
  • Incremental backups

When You Can Perform Backups

  • On a schedule: The server plan that you assign manages scheduled backups
  • On demand: You can perform on-demand backups at any time

Restores

Data You Can Restore

  • Full database: This restore operation includes the database, the log files, and the control file.
  • Partial database: A combination of any of the following files
    • Archive logs
    • Control file
    • Individual data files and tablespaces
    • Database archived redo logs

Recover Options You Can Specify

  • Recover to the most recent backup
  • Recover to the current time
  • Recover to a point in time
  • Recover to a System Change Number (SCN)

Destinations You Can Restore To

  • The current location (in place)
  • A different server or instance (out of place)

Clone to a new server or a new instance


Oracle RAC Backup Operations

You can back up online or offline Oracle RAC databases, log files, or Oracle datafiles and tablespaces. If the database must be accessible and you have a small backup window, run a series of online backups for different database portions.

You can run backups immediately or configure a schedule for the subclient.

Full Backups

Oracle full backups include the entire database and the control file. A full backup is the most comprehensive backup and is the baseline for incremental backups. Full backups of online databases include the log files. An offline full backup is a cold backup for Oracle databases.

Incremental Backups

An Oracle incremental backup contains the changed data from the last full backup. Incremental backups use less media and resources than full backups.

A cumulative backup backs up all blocks changed after the most recent incremental level 0 backup.

What is Backed Up

  • Oracle database files that include the datafiles and control files
  • Archived redo logs
  • Parameter files (SP File)
  • Oracle Managed Files

What Is Not Backed Up

Oracle application files that are associated with the Oracle installation.

External files, for example, Oracle Wallet, and external tables.


Performing Oracle RAC Backup Operations

You can back up Oracle RAC databases, log files, or Oracle RAC datafiles and tablespaces. You can back up the database when it is online or offline. If the database must be accessible and you have a small backup window, then run a series of online backups for different database portions.

Procedure

  1. From the navigation pane, go to Protect > Databases.
    The Instances page appears.
  2. To select an instance, on the Instances tab, click the instance name.
    The instance properties page appears.
  3. To select a subclient, in the Subclients section of the Overview tab, click the subclient name.
    The subclient properties page appears.
  4. On the subclient Overview tab, click Back up.
    The Select backup level dialog box appears.
  5. Select the backup level for the backup operation:
    • To perform a full backup operation, select Full.
    • To perform an incremental backup operation, select Incremental.
    • To perform a cumulative backup operation, select Incremental, and then select the Cumulative check box.
  6. To receive an email message when the backup operation is complete, select the When the job completes, notify me via email check box.
  7. Click OK.
    The Backup started dialog box appears.
  8. Optional: View the job details. Click the job ID.
  9. Optional: To view the RMAN log for the backup job, click View RMAN Log.
  10. Click OK.

Restoring an Oracle RAC Database to Its Current Location (In Place)

You can restore Oracle RAC data to the same database on the same client from which the database was backed up.

Data Available to Restore

You can restore any of the following data:

  • The database and control file
  • The database
  • The control file
  • Individual tablespaces and the control file
  • Individual tablespaces

Before You Begin

Set the database to the correct mode defined in the table.

Control file in the restoreRequire database mode
Control file is included in the restoreNOMOUNT
Control file is not included in the restoreMOUNT

Procedure

  1. From the navigation pane, go to Protect > Databases.
    The Instances page appears.
  2. Click the instance.
    The instance page appears.
  3. On the Overview tab, in the Recovery points section, select the backup to restore, and then click Restore.
    The Backup content page appears.
  4. Select the data that you want to restore, and then click Restore.
    The Restore options dialog box appears.
  5. Select the In place tab.
  6. To specify an alternate directory to restore the database or individual table spaces into, do the following:
    a. Click Redirect.
    The Redirect path options dialog box appears.
    b. To redirect the database, click Database, and then enter the full path for the new location of the database.
    c. To redirect individual tablespaces and datafiles, click Tablespaces and datafiles. For each tablespace that you want to redirect:
    i. Expand the tablespace.
    ii. In the Datafiles box, change the path to the new location.
    d. To redirect the online redo logs, move the Online redo logs toggle key to the right, and then enter the full path for the new location.
    e. Click Save.
  7. Select the data that you want to restore:
    • To restore the database or individual tablespaces, select the Database check box and clear the Control file check box.
    • To restore the control file, clear the Database check box and select the Control file check box.
    • To restore the SP file, clear the Database check box and select the SP File check box.
    • To restore the log files, clear the Database check box.
  8. Select the database Recover to option. These options control how the archive files are applied to the data files.
    • To recover to the latest backup job completion time, select Most recent backup.
    • To recover the database to the current time, select Current Time.
    • To recover to a point-in-time, select Point in Time, and then enter the date and time.
    • To recover to a System Change Number, select SCN, and then enter the SCN.The System Change Number (SCN) tracks the timing of transactions in the Oracle database. The SCNs are stored in the control files and the datafile headers. You can recover the database to the last existing SCN number in the control file, which is the last consistent database state.
  9. You can change the use of streams for the restore, under Number of streams:
    • To change the number of streams, click the stream row, click Edit, and then change the number.
    • To change the order of the streams, click the stream row you want to move up, and then click Move up.
  10. Click Submit.

Restoring an Oracle RAC Database to a Different Location (Out of Place)

You can restore Oracle RAC data to a new database on the same host, a new host, or a new host and a new database.

Data Available to Restore

You can restore any of the following data:

  • The database and control file
  • The database
  • The control file
  • Individual tablespaces and the control file
  • Individual tablespaces

Before You Begin

Set the database to the correct mode defined in the table.

Control file in the restoreRequire database mode
Control file is included in the restoreNOMOUNT
Control file is not included in the restoreMOUNT

Procedure

  1. From the navigation pane, go to Protect > Databases.
    The Instances page appears.
  2. Click the instance.
    The instance page appears.
  3. On the Overview tab, in the Recovery points section, select the backup to restore, and then click Restore.
    The Backup content page appears.
  4. Select the data that you want to restore, and then click Restore.
    The Restore options dialog box appears.
  5. Select the Out of place tab.
  6. From the Destination server list, select the destination host.
  7. From the Destination instance list, select the destination instance.
  8. To specify an alternate directory to restore the database or individual table spaces into, do the following:
    a. Click Redirect.
    The Redirect path options dialog box appears.
    b. To redirect the database, click Database, and then enter the full path for the new location of the database.
    c. To redirect individual tablespaces and datafiles, click Tablespaces and datafiles. For each tablespace that you want to redirect:
    i. Expand the tablespace.
    ii. In the Datafiles box, change the path to the new location.
    d. To redirect the online redo logs, move the Online redo logs toggle key to the right, and then enter the full path for the new location.
  9. Click Save.
  10. Select the data that you want to restore:
    • To restore the database or individual tablespaces, select the Database check box and clear the Control file check box.
    • To restore the control file, clear the Database check box and select the Control file check box.
    • To restore the SP file, clear the Database check box and select the SP File check box.
  11. To restore the log files, clear the Database check box.
  12. Select the database Recover to option. These options control how the archive files are applied to the data files.
    • To recover to the latest backup job completion time, select Most recent backup.
    • To recover the database to the current time, select Current Time.
    • To recover to a point-in-time, select Point in Time, and then enter the date and time.
    • To recover to a System Change Number, select SCN, and then enter the SCN.
  13. The System Change Number (SCN) tracks the timing of transactions in the Oracle database. The SCNs are stored in the control files and the datafile headers. You can recover the database to the last existing SCN number in the control file, which is the last consistent database state.
  14. You can change the use of streams for the restore, under Number of streams:
    • To change the number of streams, click the stream row, click Edit, and then change the number.
  15. To change the order of the streams, click the stream row you want to move up, and then click Move up.
  16. Click Submit.

SAP HANA

You can use the Metallic software to back up and restore SAP HANA. SAP HANA is also supported in a multi-tenant environment.

Backups

Data You Can Back Up

  • All of the database files on each of the nodes
  • The log files on each of the nodes
  • The catalog files

Data That Cannot Be Backed Up

  • SAP HANA application profiles and binaries that are associated with the SAP HANA installation.

Backups You Can Perform

  • Full backups
  • Incremental backups
  • Differential backups

When You Can Perform Backups

  • On a schedule: The server plan that you assign manages scheduled backups
  • On demand: You can perform on-demand backups at any time

Restores

Data You Can Restore

  • Full Database: This restore operation includes the database and the log files
  • Data Only

Backups You Can Use for Restores

  • The most recent backup
  • A backup from a specific date (point-in-time)
  • A backup identified by a backup prefix or a internal backup job ID

Destinations You Can Restore To

  • Destination server is where you performed the backup operation
  • Destination server is different from where you performed the backup

SAP HANA Configuration

Configure SAP HANA.


Creating the SAP HANA HDBUSERSTORE KEY

To connect to the SAP HANA database by using the SAP HANA Secure User Store, create a SAP HANA HDBUSERSTORE key. Use a SAP HANA HDBUSERSTORE key instead of a user name and password so that users do not need to enter connection information.

Note: In a HANA replication setup, for example, if you have a replication system of HANA SID where the first two nodes (machine01 and machine 02) are master nodes, and the other two nodes (machine03 and machine04) are standby nodes, create the key on all nodes. When the master nodes are down and the standby nodes become the master nodes, the key will still remain valid and can connect to machine03 and machine04 when machine01 and machine02 are not available.

For information on the SAP Secure User Store, see hdbuserstore on the SAP website.

Before You Begin

Verify that the user associated with the HDBUSERSTORE key has the correct permissions:

  • Backup operations: The DBA COCKPIT privilege is required. For more information, go to the SAP Documentation site, DBA Cockpit for SAP HANA: Authorizations. In the Database Users section, look at the Customer-specific user row.

    To create a SAP HANA database user that has the required backup operation privileges, run the following SQL command:

    CREATE USER MY_BACKUP_USER PASSWORD BackupOnly01 NO FORCE_FIRST_PASSWORD_CHANGE;
    GRANT BACKUP ADMIN, DATABASE BACKUP ADMIN, CATALOG READ, INIFILE ADMIN TO MY_BACKUP_USER;


    where MY_BACKUP_USER is the user name and BackupOnly1 is the password. The user must be created for the SYSTEMDB and all tenant databases, and the user must have the same password for each database.
  • Restore operations or clone operations: To run the CREATE or RENAME statements, the DATABASE_ADMIN privilege is required. For more information, see the SAP documentation site, System Privileges.

    To create a SAP HANA database user that has the required restore operation privileges, run the following SQL command:

    CREATE USER MY_RESTORE_USER PASSWORD RestoreOnly01 NO FORCE_FIRST_PASSWORD_CHANGE;
    GRANT BACKUP ADMIN, DATABASE BACKUP ADMIN, DATABASE RECOVERY OPERATOR, CATALOG READ, INIFILE ADMIN, DATABASE START, DATABASE STOP, TRACE ADMIN, SERVICE ADMIN TO MY_RESTORE_USER;

    Where MY_RESTORE_USER is the user name and RestoreOnly1 is the password. The user must be created for the SYSTEMDB and all tenant databases, and the user must have the same password for each database.

Note: The DATABASE BACKUP ADMIN and DATABASE RECOVERY OPERATOR privileges are supported on SAP HANA 2.0 SPS05 and later versions.

Procedure

  1. Log on as the <SID> admin in SAP HANA, on the command line, type the following command:su – <SID>adm
    hdbuserstore -i set <key_name> <client_computer>:3NN13,<client_computer>:3NN15 <user_name> <password>

    where NN is the HANA SID number starting from 00 to 99. Example:
    • If you have HANA SID with One Node (machine01 only) with the SID name X01 and instance number 10, use the following command:

      su – x01adm
      hdbuserstore -i set MYKEY machine01:31013,machine01:31015 SYSTEM Password@12
    • If you have HANA SID with four nodes (machine01 to machine04) with SID name Y01 and instance number 99, then create the key only on the node that appears first in the SAP HANA database instance or on the node that the user has manually set to appear as the first node. You do not create the KEY on the other three nodes. To create the key, use the following command:

      su – y01adm
      hdbuserstore -i set MYKEY machine01:39913,machine01:39915,machine02:39913,machine02:39915,machine03:39913,machine03:39915,machine04:39913,machine04:39915
      SYSTEM Password@12
  2. On the command line, type the following command to verify the key information.

    hdbuserstore LIST <KEY>

    where, KEY is the SAP HANA HDBUSERSTORE key.

    Example:
    • To verify one node HANA SID machine01:hdbuserstore list MYKEY
      KEY MYKEY
        ENV : machine01:31013,machine01:31015
        USER: SYSTEM
    • To verify four node HANA SID machine01 to machine04:hdbuserstore list MYKEY
      KEY MYKEY
        ENV : machine01:39913,machine01:39915,machine02:39913,machine02:39915,machine03:39913,machine03:39915,machine04:39913,machine04:39915
        USER: SYSTEM

Creating the SAP HANA Parameter File

You must create a parameter file when you perform certain types of backups and restores.

A parameter file is required for the following use cases:

  • Perform a cross-machine restore. This includes a restore for disaster recovery.
  • Perform a backup or restore for a multi-instance configuration.

Procedure

  1. In the iDataAgent folder, on the host where you installed the SAP HANA agent, create the SAP HANA BACKINT parameter file.

    For information about required and optional parameters, see SAP HANA BACKINT Configuration Parameters.
  2. Create the /usr/sap/<SID>/SYS/global/hdb/opt/hdbconfig directory.
  3. To link the file to the specified location, on the command line, type the following command:

    ln -s /opt/commvault/iDataAgent/param /usr/sap/<SID>/SYS/global/hdb/opt/hdbconfig/param

    where param is the name of the parameter file.
  4. In the SAP HANA Studio, set the Backint data and log parameter files to the new parameter file.

    For information about configuring the files, see Configure a Third-Party Backup Tool on the SAP website.

    Note: Enable the third-party log backup option. Set the option to true.

SAP HANA BACKINT Configuration Parameters

The following table defines the SAP HANA BACKINT configuration file parameters.

ParameterExampleDefinition
CvInstanceNameCvInstanceName instance_name
Example: CvInstanceName
Instance001
The name of the configured instance. This parameter is optional.
CV_restCopyPrecCV_restCopyPrec copy_precedence
Example: CV_restCopyPrec
2
The copy precedence for the restore job. You must set this value to 0 if you restore from a selective copy.

Enabling SSL Communication with the SAP HANA System

If the SAP HANA system is configured to use an SSL (Secure Sockets Layer) connection, you must enable the Metallic software to authenticate access to the SAP HANA system.

Before You Begin

If the SAP HANA environment uses a Secure Sockets Layer (SSL) connection, obtain the name of the SSL provider and the SSL trust store file that stores the CA-signed certificates.

Procedure

  1. From the navigation pane, go to Protect > Databases.

    The Instances page appears.
  2. Click the SAP HANA instance.The instance page appears.
  3. In the General section, click Edit.

    The Edit SAP HANA instance dialog box appears.
  4. Move the Enable SSL toggle key to the right, and then provide the following details:
    • In the Service Provider box, type the service provider that is used for the SSL connection. For example, type commoncrpto.
    • In the SSL Trust store box, type the trust store name for the SSL connection. For example, type sapcli.pse.
  5. Click Save.

SAP HANA Restores

You can restore a SAP HANA database to its current location (in place) or to a different location (out of place).


Restoring to the Current Location (In Place)

You can restore a SAP HANA database to its current location (in place). The SAP HANA software brings the database down before the restore and brings it back up after the restore is complete.

To recover only the data, perform the restore by using a full backup.

Before You Begin

If you want to restore the most recent backup data and log files, stop the SAP HANA replication. If you do not stop the SAP HANA replication, only the latest data is restored and the latest log is not restored.

Procedure

  1. From the navigation pane, go to Protect > Databases > DB Instances > instance.

    The instance properties page appears.
  2. In the Recovery points section, click Restore.

    The Restore Options page appears.
  3. In the Destination Database, select the database where you want to restore.
  4. Choose the database recovery option:
    • To recover the database to a point-in-time, click Up to, and then select the date and time.
    • To restore by specifying the backup prefix, in the Backup prefix box, type the backup prefix for the backup.

      Note: The Metallic software creates the backup prefix by pre-pending the job ID to the backup prefix. For example, 4815976_COMPLETE_DATA_BACKUP. You do not need the catalog backup available with backint.
    • To restore by specifying the internal backup job ID, in the Internal Backup ID box, type the internal backup job ID.

      Note: If you restore by specifying the internal backup job ID, then you must have the catalog backup available with backint. SAP HANA creates the internal backup ID.
  5. To verify that all the backups required for the recovery operation are available, select the Check Access check box.
  6. To initialize the log area after the restore, select the Initialize log area check box.
  7. To recover using delta backups, select the Use delta backups check box.

    If you do not use a delta backup for the recovery option, the software only uses the log backups for recovery.
  8. To send a notification email when the restore job completes, select the When the job completes, notify me via email.
  9. Click Submit.

Restoring to a Different Location (Out of Place)

You can restore a SAP HANA database to a different location (out of place). The SAP HANA software brings the database down before the restore and brings it back up after the restore is complete.

To recover only the data, perform the restore by using a full backup.

Before You Begin

  • Verify that the restore environment has the same set of nodes and the instance SID name as the backup environment. If you modified the backup environment, then you must make the same modifications on the restore environment.
  • Verify that the SAP HANA software version on the destination is the same version or higher than the software version.
  • If you want to restore the most recent backup data and log files, stop the SAP HANA replication. If you do not stop the SAP HANA replication, only the latest data is restored and the latest log is not restored.

Procedure

  1. From the navigation pane, go to Protect > Databases > DB Instances > instance.

    The instance properties page appears.
  2. In the Recovery points section, click Restore.

    The Restore Options page appears.
  3. On the Out of place tab, in the Source database, select the source database from where you to restore.
  4. From the Destination Server list, select the destination host to use for the restore.
  5. From the Destination instance list, select the destination instance to use for the restore.
  6. To restore from a snapshot backup, in the HANA data directory box, click Browse and select the HANA directory.

    The full path where the destination instance resides. For example, if the SAP HANA SID path is hana/data/SID, then set the Destination Instance SAP HANA directory to: /hana/data.

    Note: This is required for IntelliSnap cross instance and cross machine restores.
  7. Choose the database recovery option:
    • To recover the database to a point-in-time, click Up to, and then select the date and time.
    • To restore by specifying the backup prefix, in the Backup prefix box, type the backup prefix for the backup.

      Note: The Metallic software creates the backup prefix by pre-pending the job ID to the backup prefix. For example, 4815976_COMPLETE_DATA_BACKUP. You do not need the catalog backup available with backint.
    • To restore by specifying the internal backup job ID, in the Internal Backup ID box, type the internal backup job ID.

      Note: If you restore by specifying the internal backup job ID, then you must have the catalog backup available with backint. SAP HANA creates the internal backup ID.
  8. To verify that all the backups required for the recovery operation are available, select the Check Access check box.
  9. To initialize the log area after the restore, select the Initialize log area check box.
  10. To recover using delta backups, select the Use delta backups check box.

    If you do not use a delta backup for the recovery option, the software only uses the log backups for recovery.
  11. To send a notification email when the restore job completes, select the When the job completes, notify me via email.
  12. Click Submit.

SQL Server


User Account configuration for SQL Server

Windows Configuration

Users who perform backup operations must be local administrators so that they have full control over the registry folder and the installation folder.

User credentials are not set during the agent installation. By default, the local system account is used. To access the SQL Server databases to perform backup and restore operations, SQL sysadmin rights are required.

SQL Server IsUser AccountPrivileges
Member of a WorkGroupLocal administrator of the computer where the SQL Server resides, like computer_name\user1.Member of the SQL sysadmin fixed server role.Able to back up any file and folder on the local computer to which the local group applies.
Member of a DomainMember of the Local administrator group of the computer where the SQL Server resides, like domain\user1.Member of the SQL sysadmin fixed server role.The account must have interactive log on rights to the computer where the SQL Server resides or have Log on as Batch job rights in the Local security policy.Able to back up any file and folder on the following entities: a computer in the domaina computer in a domain where a two-way trust relationship exist

For more information about the SQL sysadmin privileges, go to the Microsoft Support website and search for Microsoft KB article 2926557, SQL Server VDI backup and restore operations require Sysadmin privileges.


Push installations

Applies to: Core installations for Windows, Linux, and Microsoft SQL Server

To install software on the server that you want to back up, you can push the software from the backup gateway to the server. To perform a push installation, you need the name of the server that you want to back up and the user credentials for the server.

To successfully perform a push installation, do the following:

  • Verify that the backup gateway has network access to the server.
  • Obtain system administrator (sysadmin) user credentials for the server.
  • Windows computers: The Remote Registry service must be enabled and configured to automatically start during the computer startup.

Firewall and Network Port Requirements

Turn off the firewall services on the server, and temporarily open the following inbound network ports before performing the push installation:

  • For UNIX, Linux, and Macintosh computers, enable SSH (Secure Shell), and then open port 22.
  • For Windows computers, do the following:
    • Open Port 135 for DCOM (Distributed Component Model).
    • Open Port 139 for NetBIOS Session Service (if you are using legacy Windows computers, such as Windows NT or earlier versions).
    • Open Port 445 for SMB (Server Message Block) file sharing.
    • Open the Windows Management Instrumentation (WMI) port. For instructions on setting up a fixed port for WMI, see Setting Up a Fixed Port for WMI on the Microsoft website.
    • Important: If Windows Firewall is enabled on the computer, do one of the following:
      • Temporarily open the following ports in Windows Firewall:- Port 135 for DCOM-In (COM + Network Access) – Port 445 for SMB – WMI port
      • Set up a remote cache in the network where the computer resides.

Office 365

You can configure Office 365 applications to back up directly to the Metallic cloud without installing additional hardware or software. Protect data in the following Office 365 applications from accidental deletions, ransomware scenarios, and data corruption:

  • Exchange Online
  • SharePoint Online
  • OneDrive for Business
  • Teams

When it is time to recover data, you can find and recover as many files as you need, or you can restore an entire folder or mailbox to a point in time. Metallic eliminates “dumpster diving” or rummaging through the Office 365 recycle bin.

Data flow


Subscription Usage for Office 365

You can view usage and metering information in the Subscription Usage tile and the Subscription Usage report on the Hub.

Subscription Usage Tile

The Subscription Usage tile in the Hub displays the total number of unique users protected from the start of the current month until today. The way unique users are calculated differs for each Office 365 application:

  • For Mailboxes, user mailboxes are counted as part of subscription usage. However, both user mailboxes and group mailboxes are protected.
  • For SharePoint, when the tenant admin site URL is configured, all the users from the tenant subscription are counted as part of subscription usage.
  • For OneDrive, if the OneDrive Quota feature is enabled for a user and the user logs on, the user is counted as part of subscription usage.

If a user was protected for one or more days in the month, the user is counted as part of the total user usage. The user is counted even if it is removed from a backup schedule or if backup data was deleted from the system within the same month. If the user is not backed up in the following months, it is not counted as part of subscription usage for those months.

For example, if User 1 and User 2 are protected on the first day of the month, and User 1 is removed from the system later that month, the total number of users protected in the month is two users. If User 1 is not backed up in the following month and User 2 is backed up, the total number of users protected in the month is one user.

Subscription Usage for Office 365

Subscription Usage Report

To access the Subscription Usage report, click the link in the Subscription Usage tile in the Hub. The Subscription Usage report lists the names of all the users protected from the start of the current month to today. Use this report to validate the subscription usage you are charged for.


Accessing Office 365 apps

To perform operations, such as restore operations, on an Office 365 application, you must open the application.

  1. Go to the Hub.
  2. On the Office 365 tab, in the Protected Data Sources tile, click the number of mailboxes, users, or sites that you are managing. The Office 365 apps page appears.
  3. In the App name column, click the app that you want to open. Tip: The Service type column displays the app type: Exchange Online, OneDrive for Business, or SharePoint.

Exchange Online

You can use Metallic to back up and to restore Exchange Online data.

To set up Exchange Online, you can use the express configuration option or the custom configuration option.

Retention

The index server is scanned every 24 hours. Messages that are eligible for data aging based on their received time and the rules defined in the plans are pruned.


Getting started with Exchange Online

To get started with backing up an Exchange Online mailbox, complete the following tasks:

  1. Review the considerations for express and custom configuration methods to determine the best choice for your organization.
  2. Add an app for Exchange Online using the express or custom configuration method:Add an App for Exchange Online Using the Express Configuration Option
  3. Adding an App for Exchange Online Using the Custom Configuration Option
  4. Add a mailbox.
  5. Perform a test backup and restore to confirm that the system is set up correctly.
  6. Enable automatic discovery of mailboxes so that users and groups are automatically included in future backup operations.
    After you add a mailbox and enable automatic discovery of mailboxes, backup operations run according to the schedule and settings configured in the plan that you selected.
    Backups automatically start at 8-hour intervals. By default, data retention is set to unlimited, but you can set it at the individual mailbox level.
  7. Monitor backup activity to maintain a functional environment.

Configuration Methods for Exchange Online

There are two methods of configuration:

  • Express: Use this method in environments where the same person performs the roles of a backup administrator, an Office 365 administrator, and an Azure administrator.
  • Custom: Use the custom configuration method for any of the following reasons:
    • You do not want to use the Office 365 global administrator account.
    • You have MFA enabled for the global administrator account, which is not supported in the express configuration.
    • In your organization, a different person performs the role of either a backup administrator, an Office 365 administrator, or an Azure administrator.

Express configuration for Exchange Online

Before you begin the automated setup and configuration of Office 365 with Metallic, check the following configurations in the Office 365 applications:

  • You must have an Azure global administrator account. Using the global administrator account, Metallic automatically creates the Metallic backup app and registers with Azure AD.
  • You must turn off Multi Factor Authentication (MFA) during the configuration process, and then turn on MFA again after the configuration process completes. For more information, in the Microsoft documentation, see Use Conditional Access Policies.
  • Auto-generated service accounts must be excluded from any Modern Authentication policy and from any automatic password reset policy.
  • The credentials from the global administrator account are used to create the service accounts that are required to discover user mailboxes and group mailboxes.
  • After the Metallic app is configured, you can replace the global administrator role with the Exchange administrator role.
  • Service accounts with the Exchange administrator role must be excluded from any automatic password reset policy.

Add an App for Exchange Online Using the Express Configuration Option

Use the express configuration option to create an Exchange Online app. After you create the Azure app that is needed for the Exchange Online app, the Metallic software automatically creates an Exchange Online service account for the Azure app, syncs the app with Azure, and authorizes the Azure app.

Procedure

  1. Go to the Hub.
  2. On the Office 365 tab, from the New Configuration list, select Configure Exchange.
    The Exchange Online page appears.
  3. In the Name box, type a name for the app.
  4. From the Office 365 cloud region list, select the region that hosts Exchange Online:
    • If Exchange Online is not hosted in a national cloud, select Default (Global Service).
    • If Exchange Online is hosted in a national cloud, select the region.
  5. In the Connection settings section, enter the following information:
    1. Select Express configuration (Recommended).
    2. Enter the Office 365 global administrator account user name and password.
    3. Click Create Azure app.
      A Microsoft window displays all the permissions that are required to access the Azure app.
    4. Click Accept.
      If the pop-up blocker appears in the browser, allow access to the Microsoft window so that you can accept the required permissions without interference.
  6. Click Save.

Custom configuration for Exchange Online

The custom configuration method is a manual process that requires the following actions and information:

  • To set up modern authentication, complete these tasks:
    • Register the Azure app with Azure.
    • Provide service accounts access to Exchange Online shell.
  • Obtain the Azure application ID, secret application key value, and Azure directory ID. For instructions about locating this information in the Azure Portal, in the Microsoft documentation, see Get tenant and app ID values for signing in.
  • Obtain the Exchange Online service account log-on credentials.

Adding an App for Exchange Online Using the Custom Configuration Option

You can create the Exchange Online client manually by providing the Azure app details and Exchange Online service account login details.

Before You Begin

Complete the setup for Modern Authentication:

  • Registering the application in the Azure portal to obtain the application ID, the Azure directory ID, and the application key value.
  • Configuring the Exchange Online service account, and then using the Exchange Online service account login details to add the app.

Procedure

  1. Go to the Hub.
  2. On the Office 365 tab, from the New Configuration list, select Configure Exchange.
    The Exchange Online page appears.
  3. In the Name box, type a name for the app.
  4. From the Office 365 cloud region list, select the region that hosts Exchange Online:
    • If Exchange Online is not hosted in a national cloud, select Default (Global Service).
    • If Exchange Online is hosted in a national cloud, select the region.
  5. In the Connection settings section, enter the following information:
    1. Select Custom configuration (Advanced).
    2. To enable modern authentication during a backup operation and a restore operation, move the Use modern authentication toggle key to the right.
    3. Click Add an Azure app.
      The Azure application dialog box appears.
      1. In the Application ID box, type the application ID.
      2. In the Application secret box, type the key value.
      3. In the Azure directory ID box, type the directory ID.
      4. Click Add.
    4. Click Add a service account.
      The Exchange Online Service account dialog box appears.
      1. In the Email address box, type the service account email ID.
      2. Type the associated password.
      3. Click Add.
  6. Click Save.

Basic Authentication

Basic authentication is also called legacy authentication.


Registering the Azure App for Exchange Online

Register the Azure app with Microsoft Azure Active Directory (AD).

When you finish registering the app, record the Application ID and Directory ID. When you finish creating the client secret, record it. You will need to enter these values when you add an Exchange Online app.

To improve performance and to minimize throttling, you can register multiple apps. For example, for an Exchange Online app that has 2,500 mailboxes, register 5 apps. Every time an additional 1,000 mailboxes are added, register 1 additional app.

Disclaimer: You perform these steps in the Microsoft Azure Active Directory web application, which is subject to change without notice.

Log On to the Azure Portal as the Global Administrator

  1. Log on to the Azure portal (https://portal.azure.com/) using your global administrator account.
  2. Go to Azure Active Directory.

Register the Azure App

  1. In the navigation pane, click App registrations.
  2. Click New registration.
  3. In the Name box, enter a name for the app.
  4. Under Supported account types, select Accounts in this organizational directory only (<office_365_tenant_prefix> – Single tenant).
  5. Optional: To verify the status of the app and to authorize the app from the Metallic, under Redirect URI, enter the Metallic URL.
  6. Click Register.
  7. Copy and paste the following values in a file or other document that you can access later:
    • Application ID
    • Directory ID
      You will enter these values in the Command Center when you create the Exchange Online app.

Request and Grant Permissions for Azure APIs for Azure Apps

  1. In the navigation pane, click API permissions.
  2. Click Add a permission.
  3. Click Microsoft Graph.
  4. Click Application permissions.
  5. Select the following permissions:
    • Directory: Directory.Read.All
    • Group: Group.ReadWrite.All
  6. Click Add permissions.
  7. Click Add a permission.
  8. Click APIs my organization uses.
  9. On the search bar, type Office 365 Exchange Online.
  10. Select Office 365 Exchange Online, and then click Application permissions.
  11. Select full_access_as_app.
  12. Click Add permissions.
  13. Click Grant admin consent for tenant_name.

Create a Client Secret

  1. In the navigation pane, click Certificates & secrets.
  2. Click New client secret.
  3. Enter a description, and then select when you want the secret to expire.
  4. Click Add.
  5. Copy and paste the client secret value in a file or other document that you can access later.
    You will enter this value in the Command Center when you create the Exchange Online app.

Providing Service Accounts Access to Mailboxes in Exchange Online (Through Azure Active Directory)

Applies to: Office 365 with Exchange, User Mailbox

In an Office 365 with Exchange environment, you must configure the Exchange Online service account to discover, archive, clean up, and restore data for user mailboxes, group mailboxes, and all public folders.

Before You Begin

The Office 365 with Exchange (Exchange Online) administrator account must have the following service accounts configured:

  • Exchange Online service account, which must meet the following requirements:
    • Must be an online mailbox or a shared mailbox.
    • Must have multi-factor authentication enabled. You must provide the service account email address and the app password, which must be created so that the app can connect to Office 365. For more information, see Set up multi-factor authentication in the Office 365 admin center and Create an app password for Office 365 on the Microsoft documentation website. If MFA is enabled using the conditional access policy, then the app password cannot be configured.
    • Must have either the Exchange administrator role or the global administrator role assigned so that the Exchange administrator or the global administrator can discover and back up Office365 group mailboxes. For more information, see Assign admin roles in Office 365 on the Microsoft documentation website.
    • If you use more than one access node, the service account must have local logon rights.
    • For public folders, you must have owner permissions at the root level and the sub-folder level. Convert the shared mailbox to a user mailbox, assign assign the owner permissions, and then convert the mailbox back to a shared mailbox.
    • For public folder backup and restore, the service account must have impersonation and view-only permissions.
    • For the Exchange Online service account, a license is not required. Convert the user mailbox to a shared mailbox, and remove the Office 365 license for the Exchange Online service account.
  • Local system account (Windows user), which must meet the following requirements:
    • Must be a member of the local administrator group.
    • Must be a domain user.

Procedure

  1. Open Windows PowerShell and create a remote PowerShell session to Office 365 with Exchange.
  2. To assign impersonation and view-only recipient permissions, type the following command:
New-RoleGroup -Name “ExchangeOnlineBackupRoleGroup” -Roles “ApplicationImpersonation”, “View-Only Recipients” -Members serviceaccount1,serviceaccount2

 where:

  • ExchangeOnlineBackupRoleGroup is a unique name for the new role group.
  • serviceaccount1 and serviceaccount2 are Exchange Online service accounts.

Modern Authentication

Modern authentication is a method of identity management that offers more secure user authentication and authorization.


Registering Exchange Online with Azure

Register the Azure app with Microsoft Azure Active Directory (AD).

When you finish registering the app, record the Application ID and Directory ID. When you finish creating the client secret, record it. You need to enter these values when you add the app to the Metallic software.

To improve performance and to minimize throttling, you can register multiple apps.

For an Exchange Online app that has 5,000 mailboxes, register 5 apps. Every time an additional 1,000 mailboxes are added, register 1 additional app.

Disclaimer: This procedure is performed using the Microsoft Azure Active Directory (Azure AD) Web application. The Azure AD application is subject to change without notice. Consult Microsoft documentation, for example “Azure Active Directory Documentation” (https://docs.microsoft.com/en-us/azure/active-directory/).

Log On to the Azure Portal as the Global Administrator

  1. Log on to the Azure portal (https://portal.azure.com/) using your global administrator account.
  2. Go to Azure Active Directory.

Register the Azure App

  1. In the navigation pane, click App registrations.
  2. Click New registration.
  3. In the Name box, enter a name for the app.
  4. Under Supported account types, select Accounts in this organizational directory only (<office_365_tenant_prefix> – Single tenant).
  5. Optional: To verify the status of the app and to authorize the app from the Metallic, under Redirect URI, enter the Metallic URL.
    For example, enter https://Command_Center_name.domainname.com/adminconsole.
  6. Click Register.
  7. Copy and paste the following values in a file or other document that you can access later:
    • Application ID
    • Directory ID
      You will enter these values in the Command Center when you create the Exchange Online app.

Request and Grant Permissions for Azure APIs for Azure Apps

  1. In the navigation pane, click API permissions.
  2. Click Add a permission.
  3. Click Microsoft Graph.
    a. Click Application permissions.
    b. Select the following permissions:
    Directory: Directory.Read.All
    Group: Group.ReadWrite.AllClick Add a permission.
    c. Click Add permissions.
  4. Click APIs my organization uses and complete the following steps:
    a. On the search bar, type Office 365 Exchange Online.
    b. Select Office 365 Exchange Online, and then click Application permissions.
    c. Select full_access_as_app.
    d. Click Add permissions.
  5. On the app API permissions page, click Grant admin consent for tenant_name.

Create a Client Secret

  1. In the navigation pane, click Certificates & secrets.
  2. Click New client secret.
  3. Enter a description, and then select when you want the secret to expire.
  4. Click Add.
  5. Copy and paste the client secret value in a file or other document that you can access later.
    You will enter this value in the Command Center when you create the Exchange Online app.

Providing Service Accounts Access to Mailboxes for Exchange Online

You must configure the Exchange Online service account to discover, archive, clean up, and restore data for user mailboxes, group mailboxes, and all public folders.

Before You Begin

  • Exchange Online service account, must meet the following requirements:
    • MFA must be disabled for the service account.

Procedure

  1. Log on to the Azure portal using your global administrator account.
  2. Go to Azure Active Directory and create a user and disable MFA for the user. For more information, see Add or delete users using Azure Active Directory. The user must have full read and write permissions on the shared job result directory.
  3. Go to Office 365 Exchange Admin Center, create a custom role with the View-Only Recipients permission, and then add the user to this role.

Add a Mailbox to the Exchange Online App

Add the mailboxes that you want the Exchange Online app to back up to the app.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app that you want to add the mailbox to.
    The app page appears.
  3. Click Add, and then click Add Mailbox.
    The Add Mailbox dialog box appears.
  4. From the Office 365 plan list, select the Exchange mailbox plan to use.
  5. From the Select mailboxes list, select the mailboxes to add to the Exchange Online app.
  6. Click Save.

Perform a Test Backup and Restore for Exchange Online

To confirm that the Exchange Online app and mailboxes are set up correctly, perform a test backup and restore.

Back Up to Mailboxes

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the Exchange Online app.
    The app page appears.
  3. On the Mailboxes tab, select the mailboxes, and then click Back up.
    A message prompts you to confirm submission of the backup job.
  4. Click Yes.

Restore to Mailboxes

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app that contains the mailbox that you want to restore.
    The app page appears.
  3. On the Mailboxes tab, select the mailbox that you want to restore, click Restore, and then click Restore mailbox.
    The Restore options dialog box appears, with options for restoring to the original location already selected.
  4. For When message exists, specify what to do with existing items:
    • To overwrite existing items, select Overwrite unconditionally.
    • To not overwrite existing items, select Skip.
  5. Click Submit.
Enabling Autodiscovery of Mailboxes

To discover mailboxes automatically, add the AD group to the Exchange Online app.

After you enable automatic discovery on the app, when a backup operation runs for one of the mailboxes, users groups are automatically discovered and included in the backup.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app to which you want to add the mailbox.
    The app page appears.
  3. On the Content tab, click Add, and then click Add AD group.
    The Add AD group dialog box appears.
  4. From the Exchange plan list, select a plan.
  5. From the Select AD groups list, select one or more mailboxes on which you want to enable autodiscovery.
  6. Click Save.

What to Do Next

To automatically discover new user accounts, run a backup operation on the autodiscovery-enabled mailboxes.


Restores for Exchange Online

You can restore an individual mailbox item (such as folders, messages, and calendar appointments) or an entire mailbox.


Restoring an Individual Mailbox Item to Its Original Location

You can restore an individual Exchange Online mailbox item to the location that it was backed up from.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app that contains the item that you want to restore.
    The app page appears.
  3. On the Mailboxes tab, select the mailbox that contains the item that you want to restore, click Restore, and then click Restore messages.
    The mailbox contents appear.
  4. Select the item that you want to restore.
  5. Click Restore, and then click Selected items.
    The Restore options dialog box appears, with options for restoring to the original location already selected.
  6. For When message exists, specify what to do with existing items:
    • To overwrite existing items, select Overwrite unconditionally.
    • To not overwrite existing items, select Skip.
  7. Click Submit.

Restoring a Mailbox to Its Original Location

You can restore an entire mailbox to the location that it was backed up from.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app that contains the mailbox that you want to restore.
    The app page appears.
  3. On the Mailboxes tab, select the mailbox that you want to restore, click Restore, and then click Restore mailbox.
    The Restore options dialog box appears, with options for restoring to the original location already selected.
  4. For When message exists, specify what to do with existing items:
    • To overwrite existing items, select Overwrite unconditionally.
    • To not overwrite existing items, select Skip.
  5. Click Submit.

Downloading Exchange Online Folders or Messages

You can export folders or messages to an export set, change the format of the items to fit your needs, and download the exported PST or CAB file directly to your browser. When you export, an export set is automatically created.

The following file formats are supported when you export:

  • PST (Portable Storage Table)
  • CAB (cabinet file)

The default maximum size of export to PST or CAB is 25 GB. The size limitation applies to the total size of emails exported from the Office 365 client.

Note:

  • When the export size exceeds 25GB, the export job does not start and an error message occurs. You can use the restore option or create multiple, smaller export sets.
  • When multiple mailboxes are exported to a PST file, all the emails are exported from all the mailboxes into a single PST file.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Right-click the Office 365 app that contains what you want to export, and then click Restore.
    The user mailbox appears in the folder view.
  3. You can export a folder or messages:
    Note: To include deleted items in the export file, click the action button , and then select Include deleted items.
    • To export a folder or a sub-folder, do the following:
      1. In the left pane, expand the mailbox, and then click the folder or the sub-folder.
      2. From the Export selected folder to list, select the file format.
    • To export messages, do the following:
      1. Either expand folders to navigate to the messages, or in the Search box, enter search terms in the search filter list.
        For example, enter inbox for the Folder filter.
      2. Select the check boxes for the messages.
      3. From the Export selected items to list, select the file format.
        The Export to dialog box appears.
  4. In the Name box, type a name for the export set.
  5. If messages are selected, next to Selection Range, select the email messages to include in the export set:
    • To select the selected email messages, click Selected.
    • To select all the emails in the search results, select All.
  6. Click Submit.
    A job runs to create the export set.
  7. In the upper-right corner of the page, click View exports.
    The View exports dialog box appears. The export sets that are ready to be downloaded and the export sets that are being created are listed.
  8. To download the export set, click the download button download button.
    Note: When mailboxes are exported, the folder hierarchy is maintained in the export set.
  9. To delete an export set, select the check box for the export set, and then click Delete.
    The message Selected exports deleted successfully confirms the deletion.

OneDrive for Business

In Metallic, there are two versions of OneDrive protection: OneDrive and OneDrive Classic. Use the documentation that applies to the version that your environment has.

Which Version Am I Using?

If you signed up for OneDrive after February 26th, 2021, refer to the OneDrive documentation.

If you signed up for OneDrive prior to February 26th, 2021, refer to the OneDrive Classic documentation.


OneDrive for Business

You can use Metallic to back up and to restore Microsoft OneDrive for Business data.

The following features are now available:

  • Use search and filtering options to find the documents that you want to restore
  • Perform an on demand back up of user groups and all users
  • Set data retention for a user
  • Use search and filtering options to find the files that you want to restore

Note: Due to a known issue with Microsoft, the following items cannot be backed up or restored:

  • Locally created OneNote files that were manually copied to OneDrive. This is due to an API limitation.
  • OneNote files.
  • OneNote notebooks stored in the Notebooks folder of the OneDrive account.

Getting Started with OneDrive for Business

To get started with backing up a OneDrive for Business user, complete the following tasks:

  1. Use the express configuration option to add an Azure app and a service account.With the express configuration option, you use the Office 365 global administrator account. You can use the custom configuration option instead, if you do not want to use the global administrator account.
  2. Add a user.
  3. Perform a test backup and restore to confirm that the system is set up correctly.

Express Configuration for OneDrive for Business

Before you begin the automated setup and configuration of Office 365 with Metallic, check the following configurations in the Office 365 applications:

  • You must have an Azure global administrator account. Using the global administrator account, Metallic automatically creates the Metallic backup app and registers with Azure AD.
  • You must turn off Multi Factor Authentication (MFA) during the configuration process, and then turn on MFA again after the configuration process completes. For more information, in the Microsoft documentation, see Use Conditional Access Policies.
  • Auto-generated service accounts must be excluded from any Modern Authentication policy and from any automatic password reset policy.
  • The credentials from the global administrator account are used to create the service accounts that are required to discover user accounts.

Add an App for OneDrive for Business Using the Express Configuration Option

Use the express configuration option to create an OneDrive for Business app. After you create the Azure app that is needed for the OneDrive for Business app, the Metallic software automatically creates an OneDrive for Business service account for the Azure app, syncs the app with Azure, and authorizes the Azure app.

Procedure

  1. Go to the Hub.
  2. On the Office 365 tab, from the New Configuration list, select OneDrive.
    The OneDrive for Business page appears.
  3. In the Name box, type a name for the app.
  4. From the Office 365 cloud region list, select the region that hosts OneDrive for Business:
    • If OneDrive for Business is not hosted in a national cloud, select Default (Global Service).
    • If OneDrive for Business is hosted in a national cloud, select the region. Note: You cannot select China as the region.
      Note: You cannot select China as the region.
  5. In the Connection settings section, enter the following information:
    1. Select Express configuration (Recommended).
    2. Enter the Office 365 global administrator account user name and password.
    3. Click Create Azure app.
      A Microsoft window displays all the permissions that are required to access the Azure app.If the pop-up blocker blocks the Microsoft window, allow access to the Microsoft window.
    4. At the bottom of the Microsoft window, click Accept.
  6. Click Save.

Add a User to the OneDrive for Business App

Add the users that you want the OneDrive for Business app to back up to the app.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the OneDrive for Business app.
    The app page appears.
  3. On the Users tab, click Add, and then click Add Users.
    The Add user dialog box appears.
  4. From the User group list, select a user group to add users to.
  5. From the Select users list, select the users to add.
  6. Click Add.

Perform a Test Backup and Restore of the OneDrive for Business Users

To confirm that the OneDrive for Business app and users are set up correctly, perform a test backup and restore.

Back Up the Users

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the row for the app, click the Action button, and then click Back up.
    The Select backup level dialog box appears.
  3. Click OK.

Restore the Users

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the row for the app, click the Action button, and then click Restore.
    The Backup content page appears.
  3. Select all the users, and then click Restore.
    The Restore options dialog box appears, with options for restoring to the original location already selected.
  4. Click Submit.

Configuration for OneDrive for Business

After you confirm that the OneDrive for Business app and users are set up correctly by performing a test backup and restore, configure your environment.


Custom configuration for OneDrive for Business

The custom configuration method is a manual process that requires the following actions and information:

  • To set up modern authentication, register the Azure app with Azure.
  • Obtain the Azure application ID, secret application key value, and Azure directory ID. For instructions about locating this information, in the Microsoft documentation, see Get tenant and app ID values for signing in.
  • Obtain the OneDrive for Business service account log-on credentials.

Add an App Using Custom Configuration

You can create the OneDrive for Business app manually by providing the user details, Azure app details, and service account login details.

Before Your Begin

  • Obtain the application ID, the Azure directory ID, and the application key value by registering the application in the Azure portal. For information about registering the application, see Registering the Azure App for OneDrive for Business.
  • Obtain the OneDrive for Business service account login details.

Procedure

  1. Go to the Hub.
  2. On the Office 365 tab, from the New Configuration list, select OneDrive.
    The OneDrive for Business page appears.
  3. In the Name box, type a name for the app.
  4. From the Office 365 cloud region list, select the region that hosts OneDrive for Business:
    • If OneDrive for Business is not hosted in a national cloud, select Default (Global Service).
    • If OneDrive for Business is hosted in a national cloud, select the region.
      Note: You cannot select China as the region.
  5. In the Connection settings section, enter the following information:
    1. Select Express configuration (Recommended).
    2. Enter the Office 365 global administrator account user name and password.
    3. Click Create Azure app.
      A Microsoft window displays all the permissions that are required to access the Azure app.
      If the pop-up blocker blocks the Microsoft window, allow access to the Microsoft window.
    4. At the bottom of the Microsoft window, click Accept.
  6. Click Save.

Modern Authentication

Modern authentication is a method of identity management that offers more secure user authentication and authorization.

Tip: For modern authentication, create at least 3 apps.


Registering the Azure App for OneDrive

Register the Azure app with Microsoft Azure Active Directory (AD).

When you finish registering the app, record the Application ID and Directory ID. When you finish creating the client secret, record it. You will need to enter these values when you add an OneDrive for Business app.

Disclaimer: This procedure is performed using the Microsoft Azure Active Directory (Azure AD) Web application. The Azure AD application is subject to change without notice. Consult Microsoft documentation, for example “Azure Active Directory Documentation” (https://docs.microsoft.com/en-us/azure/active-directory/).

Log On to the Azure Portal as the Global Administrator

  1. Log on to the Azure portal (https://portal.azure.com/) using your global administrator account.
  2. Go to Azure Active Directory.

Register the Azure App

  1. In the navigation pane, click App registrations.
  2. Click New registration.
  3. In the Name box, enter a name for the app.
  4. Under Supported account types, select the accounts that you want to give access to the app.
  5. Optional: To verify the status of the app and to authorize the app from the Metallic, under Redirect URI, enter the Metallic URL.
    For example, enter https://Command_Center_name.domainname.com/adminconsole.
  6. Click Register.
  7. Copy and paste the following values in a file or other document that you can access later:
    • Application ID
    • Directory ID
      You will enter these values in the Metallic when you create the OneDrive for Business app.

Request and Grant Permissions for Azure APIs

  1. In the navigation pane, click API permissions.
  2. Click Add a permission.
    The Request API permissions pane appears.
  3. Click Microsoft Graph tile.
  4. Click Application permissions.
  5. Select the following permissions:
    • Directory: Directory.Read.All
    • Files: Files.ReadWrite.All
    • User: User.Read.All
    • Notes: Notes.ReadWrite.All
  6. Click Add permissions.
  7. Click Add a permission.
    The Request API permissions pane appears.
  8. Click SharePoint.
  9. Click Application permissions.
  10. Select the following permissions:
    • Sites: Sites.FullControl.All
    • User: User.Read.All
  11. Click Add permissions.
  12. Click Grant admin consent for tenant_name.
  13. Click Yes.

Create a Client Secret

  1. In the navigation pane, click Certificates & secrets.
  2. Click New client secret.
  3. Enter a description, and then select when you want the secret to expire.
  4. Click Add.
  5. Copy and paste the client secret value in a file or other document that you can access later.You will enter this value in the Metallic when you create the OneDrive for Business app.

Enabling Autodiscovery of Users for OneDrive for Business

All users that belong to the user groups that you add (including users that are automatically added to the user groups) are included in backups of the app.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app to add the user group to.
    The app page appears.
  3. On the Content tab, click Add, and then click Add user group.
    The Add user group dialog box appears.
  4. In the User group name box, type a name for the user group.
  5. Complete one of the following steps to add users to the user group:
    • On the Users tab, click Add user. Select the users you want to add, and then click Add.
    • On the (.*) Regex patterns tab, click Add pattern. In the Regular expression box, type a regular expression or wildcard pattern, and then click Add.
      You can enter multiple regular expressions or wildcard patterns.
  6. Click Save.

What to Do Next

To automatically discover new users, back up the OneDrive for Business app.


Adding All Users to the App

You can choose to add all users to a OneDrive for Business app so that all users, including new users that are automatically discovered, are included in backups of the app.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.The Office 365 apps page appears.
  2. Click the app to add all users to.The app page appears.
  3. On the Content tab, click Add, and then click All users.The Enable group dialog box appears.
  4. From the Office 365 plan list, select the plan to use for users.
  5. Click Update.

Results

The next time the OneDrive for Business app is backed up, new users are automatically discovered and included in the backup.

What to Do Next

To discover new users immediately, perform an on-demand backup.


Add the Access Node for OneDrive for Business

Add the OneDrive for Business access nodes.

Before You Begin

  • You need the following information:
    • Host name
    • User name and password
    • OS type

Procedure

  1. From the navigation pane, go to Manage > Servers.
    The Servers page appears.
  2. In the upper-right area of the page, click Add server.
    The Add server dialog box appears.
  3. Click File server.
  4. Click Select this method to install software packages on your computer.
  5. Enter the necessary information.
  6. From the Select packages list, select Office 365, and then click OK.
  7. Click Install.

Creating an Office 365 Plan to Use for OneDrive for Business

Office 365 plans specify how long deleted files and folders are retained in the backup. You can also use Office 365 plans to filter items from backups.

Procedure

  1. From the navigation pane, go to Manage > Plans.
    The Plans page appears.
  2. In the upper-right area of the page, click Create plan, and then click Office 365.
    The Create Office 365 plan dialog box appears.
  3. In the Plan name box, enter a name for the plan.
  4. Under Retention settings, specify how long to retain items.
  5. Click Save.

Removing a User from an App

You can delete a user or a user group from a OneDrive for Business app. After you delete a user, you can still restore the user’s data.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the user or the user group that you want to remove.
    The app page appears.
  3. On the Content tab, in the row for the user or the user group that you want to remove, click the action button, and then click Manage > Remove from content. A confirmation dialog box appears.
  4. Type DELETE, and then click Delete.

Excluding a User from Backups of a OneDrive for Business App

You can exclude a user or a user group from backups of a OneDrive for Business app. Excluding a user does not remove the user from the app, but the user’s data is not backed up.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the user or the user group that you want to exclude.
    The app page appears.
  3. On the Content tab, in the row for the user or the user group that you want to exclude, click the action button , and then click Manage > Exclude from backup.
    A confirmation dialog box appears.
  4. Type DELETE, and then click Delete.

Backups for OneDrive for Business

The server plan that you select for the OneDrive for Business app manages scheduled backups. You can also perform on-demand backups of individual users or of all users or users groups at any time.

Note:

  • You cannot run a synthetic full backup for OneDrive for Business.
  • You cannot run a selective copy job for OneDrive for Business. To copy data to secondary storage, run an auxiliary copy job.

Backing Up a OneDrive for Business User On Demand

You can back up a OneDrive for Business user on demand.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the user.
    The app page appears.
  3. On the Users tab, select a user, and then click Back up.
    A message prompts you to confirm submission of the backup job.
  4. Click Yes.

Backing Up All Users or User Groups for OneDrive for BusinessApp

You can back up all users or user groups in the OneDrive for Business app.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the users or the user groups.
    The app page appears.
  3. On the Content tab, select All users or user groups, and then click Back up.
    A message prompts you to confirm submission of the backup job.
  4. Click Yes.

OneDrive for Business Restore

You can restore the OneDrive for Business users and their files to their original location (in place), or to a different OneDrive account (out of place).


Restoring a OneDrive for Business User to Its Original Location (In Place)

You can restore the OneDrive for Business users to their original location.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the users that you want to restore.
    The app page appears.
  3. On the Users tab, select the users that you want to restore.
  4. Click Restore, and then click Restore user.
    The Restore options dialog box appears, with options for restoring to the original location already selected.
  5. Under File options, specify what to do with existing items:
    • To not overwrite existing items, select Skip.
    • To keep as a copy of the existing item, select Restore as a copy.
    • To overwrite existing items, select Unconditionally overwrite.
  6. Click Submit.

Restoring a OneDrive for Business User to Its Different Account (Out of Place)

You can restore the OneDrive for Business users to a different OneDrive account.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the users that you want to restore.
    The app page appears.
  3. On the Users tab, select the users that you want to restore.
  4. Click Restore, and then click Restore user.
    The Restore options dialog box appears.
  5. From the Restore destination list, select OneDrive for Business.
  6. Under OneDrive account, specify the location to restore the user:
    a. Select Restore the data to another location.
    b. In the User box, click Browse, and then select a OneDrive account.
    c. In the Folder box, click Browse, and then select a location.
    By default, the user is restored in the root folder.
  7. Under File options, specify what to do with existing items:
    • To not overwrite existing items, select Skip.
    • To keep as a copy of the existing item, select Restore as a copy.
    • To overwrite existing items, select Unconditionally overwrite.
  8. Click Submit.

Restore a File of a OneDrive for Business User

You can restore the files of OneDrive for Business users to their original location (in place), or to a different OneDrive account (out of place).


Restoring a File of a OneDrive for Business User to Its Original Location (In Place)

You can restore the file of a OneDrive for Business users to its current location.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the users that you want to restore.
    The app page appears.
  3. On the Users tab, select the users that you want to restore.
  4. Click Restore, and then click Restore files.
    The Restore options dialog box appears, with options for restoring to the original location already selected.
  5. Select the files that you want to restore.
    You can also search for a file from the Search box.
  6. Click Restore.
    The Restore options dialog box appears, with options for restoring to the original location already selected.
  7. Under File options, specify what to do with existing items:
    • To not overwrite existing items, select Skip.
    • To keep as a copy of the existing item, select Restore as a copy.
    • To overwrite existing items, select Unconditionally overwrite.
  8. Click Submit.

For more information about the search filters, see Refine Search for Restores.


Restoring a File of a OneDrive for Business User to a Different Account (Out of Place)

You can restore a OneDrive for Business user to a different OneDrive account.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the users that you want to restore.
    The app page appears.
  3. On the Users tab, select the users that you want to restore.
  4. Click Restore, and then click Restore files.
    The Restore options dialog box appears, with options for restoring to the original location already selected.
  5. Select the files that you want to restore.
    You can also search for a file from the Search box.
  6. Click Restore.
    The Restore options dialog box appears, with options for restoring to the original location already selected.
  7. From the Restore destination list, select OneDrive for Business.
  8. Under OneDrive account, specify the location to restore the file:
    a. Select Restore the data to another location.
    b. In the User box, click Browse, and then select a OneDrive account.
    c. In the Folder box, click Browse, and then select a location.
    By default, the file is restored in the root folder.
  9. Under File options, specify what to do with existing items:
    • To not overwrite existing items, select Skip.
    • To keep as a copy of the existing item, select Restore as a copy.
    • To overwrite existing items, select Unconditionally overwrite.
  10. Click Submit.

For more information about the search filters, see Refine Search for Restores.


Refine Search for OneDrive for Business Restores

You can refine search results.

The Search pane groups filtering options together. The number of search results will vary according to the selected filters.

The filtering groups list the following:

FilterDescription
TypeThe type of file that you want to search.
Item nameThe name of the file that you want to search.
UserThe username that you want to search.
LocationThe location where you want to search the file.
ModifiedThe time when the file was last modified.
SizeThe size of the file that you want to search.

SharePoint

In Metallic, there are two versions of SharePoint protection: SharePoint and SharePoint Classic. Use the documentation that applies to the version that your environment has.

Which Version Am I Using?

If you signed up for SharePoint after February 26th, 2021 and your automated setup includes the Express Configuration option, refer to the SharePoint documentation.

If you signed up for SharePoint prior to February 26th, 2021, refer to the SharePoint Classic documentation.


SharePoint

You can use Metallic to back up and to restore SharePoint sites.

The following features are now available:

  • Set up your environment using the Express configuration
  • Customize backup content based on templates
  • Set data retention at the site level
  • Use search and filtering options to find the documents that you want to restore

Getting started with SharePoint Online

To get started with backing up a SharePoint Online site, complete the following tasks:

  1. Add an App Using Custom Configuration.
  2. Add a site.
  3. Perform a test backup and restore to confirm that the system is set up correctly.

Express Configuration for SharePoint Online

Before you begin the automated setup and configuration of Office 365 with Metallic, check the following configurations in the Office 365 applications:

  • You must have a SharePoint service account with the SharePoint administrator role.
  • The SharePoint service account must be excluded from any automatic password reset policy.
  • You must have a SharePoint administrator site URL.

Add an App for SharePoint Online Using the Express Configuration Option

Use the express configuration option to create a SharePoint Online app. The Metallic software automatically creates a SharePoint Online service account for the Azure app, and then authorizes the Azure app.

With the express configuration option, you use the Office 365 global administrator account. You can use the custom configuration option instead, if you do not want to use the global administrator account.

Procedure

  1. Go to the Hub.
  2. On the Office 365 tab, from the New Configuration list, select SharePoint.
    The SharePoint Online page appears.
  3. In the Name box, type a name for the site.
  4. From the Office 365 cloud region list, select the region that hosts SharePoint Online.
  5. Select Express configuration (Recommended).
  6. Enter the Office 365 global administrator account user name and password.
  7. Click Create Azure app.
    A Microsoft window displays all the permissions that are required to access the Azure app.
    If the pop-up blocker blocks the Microsoft window, allow access to the Microsoft window.
  8. At the bottom of the Microsoft window, click Accept.
    The Create app principal dialog box appears.
  9. In the Create app principal dialog box, for step 1, click the tenant admin URL.
    A Microsoft page appears.
  10. Complete all the steps in the Create app principal dialog box.
  11. Click Save.

Add Sites to the SharePoint Online App

Add sites to the SharePoint Online app.

Note: The added site follows the retention level of the Office 365 plan that you select.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the SharePoint Online app.
    The app page appears.
  3. On the Sites tab, click Add, and then select Add sites.
    The Add sites dialog box appears.
  4. From the Office 365 plan list, select the plan to use for the sites.
  5. From the Sites list, select the sites to add.
  6. Click Add.

Creating an Office 365 Plan to Use for SharePoint Online


Perform a Test Backup and Restore of the SharePoint Online Sites

To confirm that the SharePoint Online app and sites are set up correctly, perform a test backup and restore.

Back Up the Sites

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the row for the app, click the Action button, and then click Back up.
    The Select backup level dialog box appears.
  3. Click OK.

Restore the Sites

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the row for the app, click the Action button, and then click Restore.
    The Backup content page appears.
  3. Select all the sites, and then click Restore.
    The Restore options dialog box appears, with options for restoring to the original location already selected.
  4. Click Restore.

Configurations

After you confirm that the SharePoint Online app and sites are set up correctly by performing a test backup and restore, configure your environment.


Custom configuration for SharePoint Online

The custom configuration method is a manual process that requires the following actions and information:

Before You Begin
  • To set up modern authentication, register the Azure app with Azure.
  • Obtain the Azure application ID, secret application key value, and Azure directory ID. For instructions about locating this information, in the Microsoft documentation, see Get tenant and app ID values for signing in.
  • Obtain the SharePoint Online admin site URL.

Add an App using Custom Configuration for SharePoint Online

You can create the SharePoint Online app manually by providing the tenant details, Azure app details, and service account login details.

Before You Begin

  • Obtain the application ID, the Azure directory ID, and the application key value by registering the application in the Azure portal. For information on registering the application, see Modern Authentication.
  • Obtain the SharePoint Online service account login details.
Procedure
  1. Go to the Hub.
  2. On the Office 365 tab, from the New Configuration list, select SharePoint.
    The SharePoint Online page appears.
  3. In the Name box, type a name for the site.
  4. From the Office 365 cloud region list, select the region that hosts SharePoint Online.
  5. Select Custom configuration (Advanced).
  6. In the Site URL box, type the URL for the tenant admin site.
    For example, enter https://office_365_tenant_prefix-admin.sharepoint.com.
  7. To enable modern authentication during backups and restores, move the Use modern authentication toggle key to the right.
  8. Click Add an Azure app.
    The SharePoint connection settings dialog box appears.
    a. In the Application ID box, type the application ID.
    b. In the Application secret box, type the key value.
    c. In the Azure directory ID box, type the directory ID.
    d. Click Add.
  9. Click Add a SharePoint service account.
    The SharePoint connection settings dialog box appears.
    a. In the User name box, type the service account email ID.
    b. Type the associated password.
    c. Click Add.
  10. Click Save.

Modern Authentication for SharePoint Online

Modern authentication is a method of identity management that offers more secure user authentication and authorization.


Registering the Azure App for SharePoint Online

For SharePoint Online backups to work in a modern authentication-enabled environment, you must create an Azure AD application and connect it to the tenant.

Disclaimer: This procedure is performed using the Microsoft Azure Active Directory (Azure AD) Web application. The Azure AD application is subject to change without notice. Consult Microsoft documentation, for example “Azure Active Directory Documentation” (https://docs.microsoft.com/en-us/azure/active-directory/).

Procedure

  1. Log on to the Azure portal (https://portal.azure.com/) using your global admin user account, and then go to Azure Active Directory.
  2. In the navigation pane, click App registrations.
    The App registrations page appears.
  3. To register the application, complete the following steps:
    a. Click New registration.
    The Register an application screen appears.
    b. In the Name box, type a name for the app.
    c. Under Supported account types, select Accounts in this organizational directory only (<office_365_tenant_prefix> – Single tenant).
  4. Optional: To verify the status of the app and to authorize the app from the Metallic, under Redirect URL, enter the Metallic URL.
    For example, enter https://Command_Center_name.domainname.com/adminconsole.
    a. Click Register.
    The app overview page appears.
    b. Record the Application ID and the Directory ID.
    You will enter these values later when you configure the Metallic environment.
  5. In the navigation pane, click Certificates & secrets.
    The Certificates & secrets page appears.
  6. To create a client secret, complete the following steps:
    a. Click New client secret.
    The Add a client secret dialog box appears.
    b. Type a description, and then select when you want the secret to expire.
    c. Click Add.
    d. Use the Copy to clipboard button to copy the client secret value.
    You will enter this value when later when you configure the Metallic environment.
  7. To assign full permissions to the tenant to back up SharePoint sites, in your browser, go to the tenant URL.For example, go to https://<office_365_tenant_URL>/_layouts/15/appinv.aspx.
    The Classic SharePoint admin center page appears.
  8. In the App ID box, enter the application ID that you recorded earlier, and then click Lookup.
    In the Title box, the name of the application appears.
  9. In the App Domain box, type tenantname.onmicrosoft.com.
    To get the correct domain name, go to the Microsoft Azure website, Custom domain names.
  10. In the App’s Permission Request XML box, type the following XML string:
    <AppPermissionRequests AllowAppOnlyPolicy="true">
    <AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl" />
    <AppPermissionRequest Scope="http://sharepoint/social/tenant" Right="Read" />
    </AppPermissionRequests>
  11. Click Create.
  12. Click Trust It.

Providing service accounts access to SharePoint Online

You must configure the SharePoint Online service account to discover, backup, and restore data for SharePoint sites.

SharePoint Online service account, must meet the following requirements:

  • SharePoint administrator or Office 365 user with PowerShell access rights are required for running licensing computation purposes.
  • Security defaults is a tenant option that is not supported for licensing computation purposes.
  • MFA must be disabled for the service account.

Adding Custom Content to an App

Add template-based sites to the SharePoint Online app.

You can add the following categories to the SharePoint Online app to back them up:

  • All web sites: Backs up all the sites in the SharePoint Online tenant
  • All team sites: Backs up all the SharePoint sites associated Teams
  • All project online sites: Backs up all the project web app sites

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app to add the template to.
    The app page appears.
  3. On the Content tab, click Add, and then select a template to add.
    The Edit association dialog box appears.
  4. From the Office 365 plan list, select a plan.
  5. Click Yes.

Add the Access Node for SharePoint Online

Add the SharePoint Online access nodes.

Before You Begin

  • You need the following information:
    • Host name
    • User name and password
    • OS type

Procedure

  1. From the navigation pane, go to Manage > Servers.
    The Servers page appears.
  2. In the upper-right area of the page, click Add server.
    The Add server dialog box appears.
  3. Click File server.
  4. Click Select this method to install software packages on your computer.
  5. Enter the necessary information.
  6. From the Select packages list, select Cloud Apps, and then click OK.
  7. Click Install.

Creating an Office 365 Plan to Use for SharePoint Online

Office 365 plans specify how long a list item or a library file is retained.

Procedure

  1. From the navigation pane, go to Manage > Plans.
    The Plans page appears.
  2. In the upper-right area of the page, click Create plan, and then click Office 365.
    The Create Office 365 plan dialog box appears.
  3. In the Plan name box, enter a name for the plan.
  4. Under Retention settings, specify how long to retain deleted items.
  5. Click Save.

Removing a Site from a SharePoint Online App

You can remove a site from a SharePoint Online app.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the site that you want to remove.
    The app page appears.
  3. On the Content tab, in the row for the site that you want to remove, click the Action button, and then click Manage > Remove from content.
    A confirmation dialog box appears.
  4. Confirm that you want to remove the site.

Excluding a Site from Backups of a SharePoint Online App

You can exclude a site from backups of a SharePoint Online app. Excluding a site does not remove that site from the app, but the site is not backed up.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the site that you want to exclude.
    The app page appears.
  3. On the Content tab, in the row for the site that you want to exclude, click the Action button, and then click Manage > Exclude from backup.

Backups for SharePoint Online

The server plan that you select for SharePoint Online manages scheduled backups. You can also perform on-demand backups at any time.

Note:

  • You cannot run a synthetic full backup for SharePoint Online.
  • You cannot run a selective copy job for SharePoint Online. So, run an auxiliary copy job to copy data to the secondary storage.

Backing Up a SharePoint Online Site On Demand

You can back up a SharePoint Online site on demand.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app to back up a site.
    The app page appears.
  3. Select a site, and then click Back up.
    A message prompts you to confirm submission of the backup job.
  4. Click Yes.

Restores for SharePoint Online

You can restore the SharePoint Online site and documents to their original location (in place), or to a different OneDrive account (out of place).


Restore a SharePoint Online Site to Its Original Location (In Place)

You can restore the SharePoint Online sites to their original location (in place).

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the sites you want to restore.
    The app page appears.
  3. On the Sites tab, select the sites you want to restore.
  4. Click Restore, and then click Restore sites.
    The Restore options dialog box appears, with options for restoring to the original location already selected.
  5. Enter the Azure storage account details.
  6. Under File options, for If the file exists, specify what to do with existing items:
    • To overwrite existing items, select Overwrite unconditionally.
    • To not overwrite existing items, select Skip.
  7. Under Advanced options, do the following:
    • To restore the ACLs, select the Restore ACLs only check box.
    • To restore the workflow definitions and alerts, select the Restore workflow definition and alerts only check box.
  8. Click Restore.

Restore a SharePoint Online Site to Another SharePoint Site

You can restore the SharePoint Online sites to their original location (in place).

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the sites you want to restore.
    The app page appears.
  3. On the Sites tab, select the sites you want to restore.
  4. Click Restore, and then click Restore sites.
    The Restore options dialog box appears.
  5. From the Restore to list, select SharePoint.
  6. To specify the location to restore the sites, in the Destination path box, click Browse, and then select a location.
  7. Under Advanced options, do the following:
    • To restore the ACLs, select the Restore ACLs only check box.
    • To restore the workflow definitions and alerts, select the Restore workflow definition and alerts only check box.
  8. Click Restore.

Note: By default, the existing files and folders are overwritten during the restore operation.


Restore a SharePoint Online Document

You can restore the SharePoint Online documents to their original location (in place), or to a different OneDrive account (out of place).


Restore a SharePoint Online Online Document to Its Original Location (In Place)

You can restore the SharePoint Online documents to their original location.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the sites you want to restore.
    The app page appears.
  3. On the Sites tab, select the sites you want to restore.
  4. Click Restore, and then click Restore documents.
  5. Select the documents that you want to restore.
    You can also search for a document from the Search box.
  6. Click Restore.
    The Restore options dialog box appears, with options for restoring to the original location already selected.
  7. Enter the Azure storage account details.
  8. Under File options, for If the file exists, specify what to do with existing items:
    • To overwrite existing items, select Overwrite unconditionally.
    • To not overwrite existing items, select Skip.
  9. Under Advanced options, do the following:
    • To restore the ACLs, select the Restore ACLs only check box.
    • To restore the workflow definitions and alerts, select the Restore workflow definition and alerts only check box.
  10. Click Restore.

For more information about the search filters, see Refine Search for Restores.


Restoring a SharePoint Online Document to Another SharePoint Site

You can restore the SharePoint Online documents to another SharePoint site.

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the sites you want to restore.
    The app page appears.
  3. On the Sites tab, select the sites you want to restore.
  4. Click Restore, and then click Restore documents.
  5. Select the documents that you want to restore.
    You can also search for a document from the Search box.
  6. Click Restore.
    The Restore options dialog box appears.
  7. From the Restore to list, select SharePoint.
  8. To specify the location to restore the documents, in the Destination path box, click Browse, and then select a location.
  9. Enter the Azure storage account details.
  10. Under File options, for If the file exists, specify what to do with existing items:
    • To overwrite existing items, select Overwrite unconditionally.
    • To not overwrite existing items, select Skip.
  11. Under Advanced options, do the following:
    • To restore the ACLs, select the Restore ACLs only check box.
    • To restore the workflow definitions and alerts, select the Restore workflow definition and alerts only check box.
  12. Click Restore.

Note: By default, the existing files and folders are overwritten during the restore operation.

For more information about the search filters, see Refine Search for Restores.


Refine Search for SharePoint Online Restores

You can refine search results.

The Search pane groups filtering options together. The number of search results will vary according to the selected filters.

The filtering groups list the following:

FilterDescription
TypeThe type of document that you want to search.
Item nameThe name of the document that you want to search.
ModifiedThe time when the documents was last modified.
SizeThe size of the document that you want to search.

Classic Agents

In Metallic, there are two versions of OneDrive and SharePoint protection. Use the documentation that applies to the version that your environment has.

Which Version Am I Using?

If you signed up for OneDrive or SharePoint after February 26th, 2021, refer to the OneDrive documentation and the SharePoint documentation.

If you signed up for OneDrive or SharePoint prior to February 26th, 2021, refer to the OneDrive Classic documentation and the SharePoint Classic documentation.


OneDrive for Business (Classic)

You can use Metallic to back up and to restore Microsoft OneDrive for Business data.

Due to a known issue with Microsoft, the following items cannot be backed up or restored:

  • Locally created OneNote files that were manually copied to OneDrive. This is due to an API limitation.
  • OneNote files.
  • OneNote notebooks stored in the Notebooks folder of the OneDrive account.

Getting Started with OneDrive for Business

To get started with backing up a OneDrive for Business user, complete the following tasks:

  1. Review the considerations for express and custom configuration methods to determine the best choice for your organization.
  2. Add an app for OneDrive for Business using the express or custom configuration method:
  3. Add a user.
  4. Perform a test backup and restore to confirm that the system is set up correctly.
  5. Enable automatic discovery of users so that they are automatically included in the future backup operations.
  6. Monitor backup activity to maintain a functional environment.

Configuration Methods for OneDrive for Business

There are two methods of configuration:

  • Express: Use this method in environments where the same person performs the roles of a backup administrator, an Office 365 administrator, and an Azure administrator.
  • Custom: Use the custom configuration method for any of the following reasons:
    • You do not want to use the Office 365 global administrator account.
    • You have MFA enabled for the global administrator account, which is not supported in the express configuration.
    • In your organization, a different person performs the role of either a backup administrator, an Office 365 administrator, or an Azure administrator.

Add a User to the OneDrive for Business App

Add the users that you want the OneDrive for Business app to back up to the app.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the OneDrive for Business app.
    The app page appears.
  3. On the Users tab, click Add, and then click Add Users.
    The Add user dialog box appears.
  4. From the User group list, select a user group to add users to.
  5. From the Select users list, select the users to add.
  6. Click Add.

Perform a Test Backup and Restore of the OneDrive for Business Users

To confirm that the OneDrive for Business app and users are set up correctly, perform a test backup and restore.

Back Up the Users

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the row for the app, click the Action button, and then click Back up.
    The Select backup level dialog box appears.
  3. Click OK.

Restore the Users

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the row for the app, click the Action button, and then click Restore.
    The Backup content page appears.
  3. Select all the users, and then click Restore.
    The Restore options dialog box appears, with options for restoring to the original location already selected.
  4. Click Submit.

Enabling Autodiscovery of Users for OneDrive for Business

All users that belong to the user groups that you add (including users that are automatically added to the user groups) are included in backups of the app.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app to add the user group to.
    The app page appears.
  3. On the Content tab, click Add, and then click Add user group.
    The Add user group dialog box appears.
  4. In the User group name box, type a name for the user group.
  5. Complete one of the following steps to add users to the user group:
    • On the Users tab, click Add user. Select the users you want to add, and then click Add.
    • On the (.*) Regex patterns tab, click Add pattern. In the Regular expression box, type a regular expression or wildcard pattern, and then click Add.
      You can enter multiple regular expressions or wildcard patterns.
  6. Click Save.

What to Do Next

To automatically discover new users, back up the OneDrive for Business app.


Automatic Discovery Options

To back up OneDrive user accounts, configure user groups to automatically discover user accounts. The user accounts that are discovered are added to user groups in the OneDrive app.

To perform a test backup operation, you can manually create a user group and then manually add a small number of user accounts to your user group.

Use either of the following options to automatically discover user accounts:

  • Regular expressions or wildcards: If you use regular expressions, you can chose to automatically create user groups that alphabetically organize user accounts, or you can manually create user groups and then define your own regular expressions to discover user accounts
  • Azure affinity groups

Autodiscovering User Accounts for OneDrive for Business Using Regular Expressions or Wildcards

You can use regular expressions or wildcards to autodiscover user accounts by UPN. For example, you can use regular expressions to discover all user accounts that contain “sales” in their UPN. The regular expressions that you use are case sensitive.

When you use regular expressions or wildcards to autodiscover user accounts, user accounts that match the regular expressions or the wildcard pattern are automatically assigned to the user-defined user group for which you enter the regular expressions or wildcards. If a user account does not match the expressions, then it is automatically assigned to the default user group.

Regular expressionWhat the regular expression matchesExamples of UPN that match the regular expression
Sales*UPN that begin with “sales” followed by any number of any charactersSalesA
SalesOffice
[JT]im*UPN that begin with “J” or “T”, followed by “im”, and then followed by any number of any charactersJim@xyz.abc
Tim@xyz.abc
[a-k]Lee*UPN that begin with “J” or “T”, followed by “im”, and then followed by any number of any charactersaLee@xyz.abc
bLee@xyz.abc
[A-Z]*[ ][A-E][A-Z]*To skip the entire first name, find the first space and then discover users with last name beginning with the letters “A” through “E”.

Before You Begin

Enable autodiscovery of user accounts, and then select Regex patterns. For more information, see Enabling Autodiscovery of User Accounts.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the OneDrive for Business app.
    The app page appears.
  3. On the User groups tab, update an existing user group or create a user group:
    • To add regular expressions to an existing user group, right-click the user group, and then select Manage.
      The user group page appears.
    • To add regular expressions to a new user group, in the upper-right corner of the page, click Add user group.
      The Add user group page appears.
  4. On the Regex patterns tab, click Add pattern.
    The Add new content dialog box appears.
  5. In the Regular expression box, type a regular expression or wildcard pattern, and then click Add.
    You can enter multiple regular expressions or wildcard patterns.
  6. Click Save.

What to Do Next

Run a backup operation on this user-defined user group to back up all the user accounts that have UPN that match the regular expressions or the wildcard patterns that you entered.


Autodiscovering User Accounts for OneDrive for Business Using Azure Affinity Groups

You can use Azure affinity groups to autodiscover user accounts.

Before You Begin

Enable autodiscovery of user accounts, and then select Azure AD groups. For more information, see Enabling Autodiscovery of User Accounts.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the OneDrive for Business app.
    The app page appears.
  3. On the User groups tab, update an existing user group or create a user group:
    • To add Azure AD groups to an existing user group, right-click the user group, and then select Manage.
      The user group page appears.
    • To add Azure AD groups to a new user group, in the upper-right corner of the page, click Add user group.
      The Add user group page appears.
  4. In the Content section, go to Add > Add group.
    The Add new content dialog box appears.
  5. Select the Azure affinity groups that you want to use to autodiscover user accounts, and then click Add.
  6. Click Save.

What to Do Next

Run a backup operation on this user-defined user group to back up all the user accounts that belong to the Azure affinity groups that you selected.


Creating a User Group for Testing

To perform a test backup operation, manually create a user group and then manually add a small number of user accounts to the user group.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the OneDrive for Business app.
    The app page appears.
  3. On the User groups tab, click Add user group.
    The Add user group dialog box appears.
  4. In the User group name box, type a name for the user group.
  5. From the Server plan list, select a plan.
  6. On the Users tab, click Add user.
    The Add new content dialog box appears.
  7. In the Name column, select the user accounts that you want to add.
  8. Click Add, and then click Save.

What to Do Next

After testing is complete, enable autodiscovery to automatically discover user accounts to back up.


Removing a User or a User Group from a OneDrive for Business App

You can delete a user or a user group from a OneDrive for Business app. After you delete a user, you can still restore the user’s data.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the user or the user group that you want to remove.
    The app page appears.
  3. On the Content tab, in the row for the user or the user group that you want to remove, click the action button, and then click Manage > Remove from content.
    A confirmation dialog box appears.
  4. Type DELETE, and then click Delete.

Excluding a User from Backups of a OneDrive for Business App

You can exclude a user or a user group from backups of a OneDrive for Business app. Excluding a user does not remove the user from the app, but the user’s data is not backed up.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. Click the app that contains the user or the user group that you want to remove.
    The app page appears.
  3. On the Content tab, in the row for the user or the user group that you want to remove, click the action button, and then click Manage > Exclude from backup.
    A confirmation dialog box appears.
  4. Type DELETE, and then click Delete.

OneDrive for Business Restore (Classic)

You can restore OneDrive for Business users and files from backup operations.


Restoring a OneDrive for Business User

You can restore a OneDrive for Business user.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
  2. The Office 365 apps page appears.
  3. On the Users tab, select the user group that you want to restore, and then click Restore > Restore user.
    The Restore options page appears.
  4. Select the users that you want to restore, and then click Restore.
    The Restore options dialog box appears.
  5. Under OneDrive account, select the restore destination:
    • Restore the data to its original location
    • Restore the data to another location
      • To specify a different user, beside User, click Browse, and then select a user.
      • To specify a different folder location, beside Folder, click Browse, and then select a folder or create a new folder.
  6. Under File options, for If the file exists, specify what to do with existing items:
    • To overwrite existing items, select Overwrite unconditionally.
    • To not overwrite existing items, select Skip.
  7. Under Advanced Options, select an Office 365 client.
  8. Click Submit.

Restoring a OneDrive for Business User to Its Current Location

You can restore a OneDrive for Business user.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
  2. The Office 365 apps page appears.
  3. On the Users tab, select the user group that you want to restore, and then click Restore > Restore user.
    The Restore options page appears.
  4. Select the users that you want to restore, and then click Restore.
    The Restore options dialog box appears.
  5. Under OneDrive account, select the restore destination:
    • Restore the data to its original location
    • Restore the data to another location
      • To specify a different user, beside User, click Browse, and then select a user.
      • To specify a different folder location, beside Folder, click Browse, and then select a folder or create a new folder.
  6. Under File options, for If the file exists, specify what to do with existing items:
    • To overwrite existing items, select Overwrite unconditionally.
    • To not overwrite existing items, select Skip.
  7. Under Advanced Options, select an Office 365 client.
  8. Click Submit.

Teams

You can use the Metallic software to back up and restore Teams.

Backups

Data You Can Back Up

Team itemType of itemBackupIn-place restore
TeamsPrivate Teams
Public Teams
Org-wide Teams
Fully supportedFully supported
ChannelsRegular channel
Private channel
Fully supportedFully supported
TabsPosts
Files
Wikis
Website
Word, Excel, PowerPoint, and PDF document Libraries
Fully supportedFully supported
PostsConversations
Replies
Fully supportedFully supported
Channel filesFilesFully supportedFully supported
Personal Chats and FilesChat messages
Files
With Exchange/OneDriveOut-of-place only

Backups You Can Perform

  • Forever incremental

When You Can Perform Backups

  • On a schedule: The server backup plan that you assign to the app manages scheduled backups
  • On demand: You can perform on-demand backups at any time

Restores

Backups You Can Use for Restores

  • Backups from any date/time, including the most recent backup

Destinations You Can Restore To

  • The current location (in place)
  • A different folder, a different team on a different channel (out of place)
  • A different file location

Authentication

During backups and restores, the modern authentication is used to access user data.


Getting Started with Teams

To get started with backing up Teams, complete the following tasks:

  1. Review the considerations for express and custom configuration methods to determine the best choice for your organization.
  2. Add an app for Teams using the express or custom configuration method:
  3. Add a Team.
  4. Perform a test backup and restore to confirm that the system is set up correctly.
  5. Enable automatic discovery of teams so that teams are automatically included in future backup operations.
    After you add a team and enable automatic discovery of teams, backup operations run according to the schedule and settings configured in the plan that you selected.
  6. Monitor backup activity to maintain a functional environment.

Configuration Methods for Teams

There are two methods of configuration:

  • Express: Use this method in environments where the same person performs the roles of a backup administrator, an Office 365 administrator, and an Azure administrator.
  • Custom: Use the custom configuration method for any of the following reasons:
    • You do not want to use the Office 365 global administrator account.
    • You have MFA enabled for the global administrator account, which is not supported in the express configuration.
    • In your organization, a different person performs the role of either a backup administrator, an Office 365 administrator, or an Azure administrator.

Express Configuration for Teams

Before you begin the automated setup and configuration of Office 365 with Metallic, check the following configurations in the Office 365 applications:

  • You must have an Azure global administrator account.Using the global administrator account, Metallic automatically creates the Metallic backup app and registers with Azure AD.
  • You must turn off Multi Factor Authentication (MFA) during the configuration process, and then turn on MFA again after the configuration process completes. For more information, in the Microsoft documentation, see Use Conditional Access Policies.
  • Auto-generated service accounts must be excluded from any Modern Authentication policy and from any automatic password reset policy.
  • When new channels are created, the global administrator credentials are used to assign service accounts to the group mailboxes that are created in the background.
  • Teams group mailboxes will not be protected because only global administrator credentials can assign service accounts to group mailboxes.

Adding an App for Teams Using the Express Configuration Option

Use the express configuration option to create a Teams app.

Before You Begin

  • For the express configuration, no Teams service account is created.
  • You need an Office 365 global administrator account. After you create the Azure app that is needed for the Teams app, the Metallic software automatically syncs the app with Azure, and authorizes the Azure app.
  • The Office 365 global administrator account must meet the following conditions:
    • It must be a licensed O365 mailbox user
    • It must be a a dedicated global administrator account for Teams backup because it will be added to all the Teams channels as a member. If notifications are turned on for users, then the users will be notified that an account has been added to the channel as a member. This is required for the backup process to access the data of each team.
    • You must turn the multi-factor authentication (MFA) off for the global administrator account.
  • The global administrator account will be added to each team that is backed up. After the express configuration, you can lower privileges from global administrator account to Teams administrator account.

Procedure

  1. Go to the Hub.
  2. On the Office 365 tab, from the New Configuration list, select Configure Teams.
    The Teams page appears.
  3. In the Name box, type a name for the app.
  4. In the Connection settings section, enter the following information:
    1. Select Express configuration (Recommended).
    2. Enter the Office 365 global administrator account user name and password.
    3. Click Create Azure app.
      A Microsoft window displays all the permissions that are required to access the Azure app.
      If the pop-up blocker blocks the Microsoft window, allow access to the Microsoft window.
    4. At the bottom of the Microsoft window, click Accept.
  5. Click Save.

Custom Configuration for Teams

You can customize the configuration of the Teams app.

The custom configuration method is a manual process that requires the following actions:

  • Register the Office 365 app with Azure.
  • Request and grant permission for Azure APIs.
  • Create a client secret for the Office 365 app.
  • Obtain the Azure application ID, secret application key value, and Azure directory ID. For instructions about locating this information, in the Microsoft documentation, see Get tenant and app ID values for signing in.

Registering Teams with Azure

Register the Azure app with Microsoft Azure Active Directory (AD).

When you finish registering the app, record the Application ID and Directory ID. When you finish creating the client secret, record it. You need to enter these values when you add the app to the Metallic software.

To improve performance and to minimize throttling, you can register multiple apps. Review the example that applies to the type of app that you are adding:

  • For a Teams app that has 5,000 Teams items, register 5 apps. Every time an additional 1,000 Teams items are added, register 1 additional app.

Disclaimer: This procedure is performed using the Microsoft Azure Active Directory (Azure AD) Web application. The Azure AD application is subject to change without notice. Consult Microsoft documentation, for example “Azure Active Directory Documentation” (https://docs.microsoft.com/en-us/azure/active-directory/).

Log On to the Azure Portal as the Global Administrator

  1. Log on to the Azure portal (https://portal.azure.com/) using your global administrator account.
  2. Go to Azure Active Directory.

Register the App in the Azure Portal

  1. In the navigation pane, click App registrations.
  2. Click New registration.
  3. In the Name box, enter a name for the app.
  4. Under Supported account types, select the accounts that you want to give access to the app.
  5. If you want to verify the status of the app and to authorize the app from the Command Center, under Redirect URI, enter the Command Center URL.For example, enter https://Command_Center_name.domainname.com/adminconsole.
  6. Click Register.
  7. Copy and paste the following values in a file or other document that you can access later:
    • Application ID
    • Directory ID
      You will enter these values in the Metallic software when you create the Office 365 app.

Request and Grant Permissions for Azure APIs for Azure Apps

  1. In the navigation pane, click API permissions.
  2. Click Add a permission.
  3. Click Microsoft Graph.
    a. Click Application permissions.
    b. Select the following permissions:
    • Channel:Channel.Create
    • Channel:Channel.ReadBasic.All
    • ChannelSettings:Channel.Settings.ReadWrite.All
    • Files:Files.ReadWrite.All
    • Group:Group.ReadWrite.All
    • Sites:Sites.FullControl.All
    • Team:Team.ReadBasic.All
    • TeamMember:TeamMember.ReadWrite.All
    • User:User.Read.All
    • Application:Application.ReadWrite.All
    c. Click Delegated permissions.
    d. Select the following permissions:
    • ChannelMessage:ChannelMessage.Read.All
    • ChannelMessage:ChannelMessage.Send
    • Directory:Directory.AccessAsUser.All
    • Group:Group.ReadWrite.All
    offline_access permission
    openid permission
    e. Click Add a permission.
  4. On the app API permissions page, click Add a permission.
  5. Click APIs my organization uses and complete the following steps:
    1. On the search bar, type Office 365 Exchange Online.
    2. Select Office 365 Exchange Online, and then click Application permissions.
    3. Select full_access_as_app.
    4. Click Add permissions.
  6. On the app API permissions page, click Grant admin consent for tenant_name.

Create a Client Secret

  1. In the navigation pane, click Certificates & secrets.
  2. Click New client secret.
  3. Enter a description, and then select when you want the secret to expire.
  4. Click Add.
  5. Copy and paste the client secret value in a file or other document that you can access later.
    You will enter this value in the Metallic software when you create the Office 365 app.

Adding an App for Teams Using the Custom Configuration Option

You can create the Teams app manually by providing the Azure app details.

Before You Begin

You need an Office 365 licensed user account. The account will be added to the team that is being backed up.

Procedure

  1. Go to the Hub.
  2. On the Office 365 tab, from the New Configuration list, select Configure Exchange.
    The Exchange Online page appears.
  3. In the Name box, type a name for the app.
  4. In the Connection settings section, enter the following information:
    a. Select Custom configuration (Advanced).
    b. Click Add an Azure app.
    The Azure application dialog box appears
    i. In the Application ID box, type the application ID.
    ii. In the Application secret box, type the key value.
    iii. In the Azure directory ID box, type the directory ID.
    iv. Click Add.
    c. Click Acquire token.
  5. Click Save.

Add a Team to the Teams App

To back up a team, add the team to a Teams app.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the Name column, click the app that you want to add a team to.
    The app page appears.
  3. Click Add, and then click Add team.
    The Add team dialog box appears.
  4. From the Office 365 plan list, select a plan.
  5. From the Teams list, select the items that you want to add to the app.
  6. Click Add.

Perform a Test Backup Restore in Teams

To confirm that the Teams app and teams are set up correctly, run a backup operation followed by a restore operation.

Back up a Team

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click a Teams app.
    The app page appears.
  3. On the Teams tab, select the a team, click the action button, and then click Back up.
    A message prompts you to confirm submission of the backup job.
  4. Click Yes.

Restoring a Team

  1. From the navigation pane, go to Protect > Applications > Office 365.
  2. The Office 365 apps page appears.
  3. In the App name column, click the app that contains the team that you want to restore.
    The app page appears.
  4. On the Teams tab, select the team that you want to restore, click Restore, and then click Restore team.
    The Restore options dialog box appears.
  5. For File options, specify what to do with existing files:
    • To not overwrite existing files, select Skip.
    • To overwrite existing files, select Unconditionally overwrite.
  6. Click Submit.

Enabling Autodiscovery of Teams

To discover teams items automatically, add all teams to the Teams app.

After you enable autodiscovery, then all teams are added in the subclient and backup operations run on all teams.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app to which you want to add the team item.
    The app page appears.
  3. On the Content tab, click Add, and then click All Teams.
    The Add team dialog box appears.
  4. From the Office 365 plan list, select a plan, and then click Add.
  5. Click Save.

What to Do Next

To automatically discover new user accounts, run a backup operation on the autodiscovery-enabled teams.


Configuration for Teams

You can configure the content that is included in Teams backup operations.


Removing an Item from a Teams in the Teams App

You can remove an item from a team.

The next autodiscovery will discover the removed item, and the item will be added back to the app.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the Actions column of the Team that you want to remove the item from, click the Action button , and then click Manage > Remove from content.
    A confirmation dialog box appears.
  3. Click Yes.

Tip: To see items that were removed, on the Content tab, click the gear icon , and then select Clear all filters. After you clear the filters, in the table column heading, click the Column Settings , and then click Column > Status. The status column is added to the table that displays Active, Deleted, Do not Backup and Unprotected status for the item.


Excluding an Item from a Teams App

You can exclude an item from a Teams app.

Excluding an item does not remove the item from the app, but the item will not be backed up after the next autodiscovery runs.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the Actions column of the Team that you want to remove the item from, click the Action button , and then click Manage > Exclude from backup.
    A confirmation dialog box appears.
  3. Click Yes.

Tip: To see items that were excluded, on the Content tab, click the gear icon , and then select Clear all filters. After you clear the filters, in the table column heading, click the Column Settings , and then click Column > Status. The status column is added to the table that displays Active, Deleted, Do not Backup and Unprotected status for the item.


Restores in Teams

You can restore an entire team, a channel, or Teams items such as posts, files, and wikis to the same location or to a different location. For files, in addition to in-place restore operation and out-of-place restore operation, you can also choose to restore to a file location.

Comparing Restore Operations

Depending on the location for the restore operation, you will see the following results:

Data typeIn-placeOut-of-place
TeamsThe team is restored under the same team.The team is restored to a different team, and the destination team is updated with the source channel name.
ChannelIf the destination selected is also a channel, then if the overwrite option is selected, content and settings are restored on the source channel.
PostPosts are restored with details from when the post was sent. Reactions to posts are not restored.
WikiThe wiki page is restored to the same team.The wiki page is created in a different team or channel.
FileA file can be restored to a different team and channel, or a different client location.

File Options

For any restore operation of teams, channels, posts, wikis, or files, you can choose the following file options:

  • Skip: If the file already exists on the location, then it will be skipped during restore.
  • Overwrite: If the file exists on the location, then it will be overwritten.

Restores for a Team

You can restore a team to its original location or to a team in a different location.


Restore a Team to Its Original Location

Restore a team to its original location.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app that contains the team that you want to restore.
    The app page appears.
  3. On the Teams tab, select the team that you want to restore, click Restore, and then click Restore team.
    The Restore options dialog box appears.
  4. For File options, specify what to do with existing files:
    • To not overwrite existing files, select Skip.
    • To overwrite existing files, select Unconditionally overwrite.
  5. Click Submit.

Restoring a Team to a Different Location

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app that contains the team that you want to restore.
    The app page appears.
  3. On the Teams tab, select the team that you want to restore, click Restore, and then click Restore team.
    The Restore options dialog box appears.
  4. Under Microsoft Teams, click Restore the data to another location, and then click the Browse button.
    The Select a team dialog box appears.
  5. Select a team, and then click Select.
  6. For File options, specify what to do with existing files:
    • To not overwrite existing files, select Skip.
    • To overwrite existing files, select Unconditionally overwrite.
  7. Click Submit.

Restores of Teams Items

You can restore individual items such as post, files, wikis to the same location or to a team or channel in a different location.

You can also choose to restore items that were deleted or versions of items.


Showing Deleted Items in Teams

When you restore items, you can choose to restore items that were deleted.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app that contains the team that you want to restore.
    The app page appears.
  3. On the Teams tab, select the team that contains the items that you want to restore, click Restore, and then click Restore items.
    The team page appears.
  4. In the Name column, click the channel that contains the items that you want to restore.
    The items that you can restore appear on the table.
  5. Click an item, click the action button at the top of the page, and then click Show deleted items.

Restoring Teams Items to Original Location in Teams
  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app that contains the team that you want to restore.
    The app page appears.
  3. On the Teams tab, select the team that you want to restore, click Restore, and then click Restore team.
    The team page appears.
  4. In the Name column, click the channel that contains the items that you want to restore.
    The items that you can restore appear on the table.
  5. Select an item, click on the action button , and then click Restore.
    The Restore options dialog box appears.
  6. Click Submit.
  7. For File options, specify what to do with existing files:
    • To not overwrite existing files, select Skip.
    • To overwrite existing files, select Unconditionally overwrite.
  8. Click Submit.

Restoring an Item to a Different Location in Teams
  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app that contains the team that you want to restore.
    The app page appears.
  3. On the Teams tab, select the team that you want to restore, click Restore, and then click Restore team.
    The team page appears.
  4. In the Name column, click the channel that contains the items that you want to restore.
    The items that you can restore appear on the table.
  5. Select an item, click on the action button , and then click Restore.
    The Restore option dialog box appears.
  6. Under Microsoft Teams, click Restore the data to another location.
  7. Specify the team to restore the data to:
    a. For Destination team, click the Browse button.
    The Select a team dialog box appears.
    b. Select a team, and then click Select.
  8. Optional: To also specify a channel to restore the data to, for Destination channel, click the Browse button, and then select a channel.
  9. For File options, specify what to do with existing files:
    a. To not overwrite existing files, select Skip.
    b. To overwrite existing files, select Unconditionally overwrite.
  10. Click Submit.

Restoring a File to a File Location in Teams
  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app that contains the team that you want to restore.
    The app page appears.
  3. On the Teams tab, select the team that you want to restore, click Restore, and then click Restore team.
    The team page appears.
  4. In the Name column, click the channel that contains the items that you want to restore.
    The items that you can restore appear on the table.
  5. Select Files, click on the action button, and then click Restore.
    The Restore options dialog box appears.
  6. In the Restore destination, select File Location.
  7. Under File location, from the Server list, select a server.
  8. In the Path box, click the Browser button.
    The Select a path dialog box appears.
    a. Select a path, and then click Save.
  9. Click Submit.

Restoring Versions of Items in Teams

When you restore an item that has versions, you can choose which version to restore.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app that contains the team that you want to restore.
    The app page appears.
  3. On the Teams tab, select the team that contains the items that you want to restore, click Restore, and then click Restore items.
    The team page appears.
  4. In the Name column, click the channel that contains the items that you want to restore.
    The items that you can restore appear on the table.
  5. In the Name column, click the item that contains the version that you want to restore.
    The items that you can restore appear on the table.
  6. For the item that you want to restore, click the action button, and then click Versions.
    The Versions dialog box appears.
  7. For the item that you want to restore, click the action button, and then click Restore.
  8. Click Restore.

Search for Teams

You can search for channels, conversations, files, teams, tabs, and wikis.

Filters for Restores in Teams

You can search by channels, conversations, files, teams, tabs, or wikis.

FilterDescription
typeYou can search by channel, conversation, file, team, tab, and wiki.
files extensionApplies to files. You can use one of the existing file extensions or customize the file extension.
item nameThe name of the item that you want to search for.
modifiedThe date that the item was modified.
sizeYou can search by size or a range of sizes.

Searching for a Team or for a Team Item

You can search for a team or a team item, such as channel, conversation, file, tab, or wiki.

Procedure

  1. From the navigation pane, go to Protect > Applications > Office 365.
    The Office 365 apps page appears.
  2. In the App name column, click the app that contains the team that you want to restore.
    The app page appears.
  3. In the upper-right area of the page, click Restore.
    The Teams page appears.
  4. In the Search box, click the filter button. The filter dialog box appears.
  5. From the Type list, you can select the one of the following:
    You can select to search by existing or custom file extensions, channels, conversations, teams, tabs, and Wikis.
  6. In the Item name box, enter a name.
  7. From the Modified list, select a period of time.
  8. From the Size list, select a size or size range.
  9. Click Search.

Salesforce

You can use the Metallic software to back up and restore Salesforce.

Backups

Data You Can Back Up

  • Standard objects
  • Custom objects
  • Documents
  • Attachments
  • CRM content
  • Files
  • Metadata supported by the Salesforce API if you configure the inclusion of metadata in Metallic

Backups You Can Perform

  • Full backups
  • Incremental backups

When You Can Perform Backups

  • On a schedule: The server plan that you assign manages scheduled backups
  • On demand: You can perform on-demand backups at any time

Restores

Restores You Can Perform

  • Object-level restores: Restore all records of the selected object
  • Record-level restores: Restore all the selected records of the selected object
  • Metadata restores
  • Sandbox seeding

Backups You Can Use for Restores

  • The most recent backup: For example, restore the most recent backup to secondary storage, such as tape, for long-term storage
  • A backup from a specific date: For example, restore data to a point in time before it became unusable
  • Backups from a date range: For example, restore data that was accidentally deleted

Destinations You Can Restore To

  • The Salesforce Cloud

Getting Started with Salesforce

Review each of the topics to get started.

Step 1: Obtain Your User Credentials to Access Metallic

Obtain the following information from your administrator:

  • The Metallic URL
  • Your Metallic user credentials

Step 2: Log On to the Metallic

Accessing the Metallic by using the URL and user account credentials that you obtained from the administrator.

Step 3: Review Salesforce Prerequisites

  • The following Salesforce editions are supported:
  • You must have a Salesforce admin user and security token for your Salesforce account.
  • Verify that you can connect to the Salesforce login URL from the access node.

Step 4: Configure the Salesforce Environment

Step 5: Complete the Salesforce Guided Setup

Configure the Salesforce app by completing the guided setup for Salesforce. For information, see Completing the Salesforce Guided Setup.

Step 6: Back Up Metadata (Optional)

You can include metadata in the Salesforce backups. For more information, see Backing Up Salesforce Metadata.

Step 7: Perform a Backup and Restore


Planning a Salesforce Installation

As part of planning the Salesforce installation, review the support information and data protection best practices.


Support

The Metallic software supports production and sandbox organizations, and all products and platforms that support Salesforce APIs, including the Lightning Platform.

Organizations

  • Production
  • Sandbox

Editions

  • Developer
  • Enterprise
  • Performance
  • Unlimited

Products

  • Sales Cloud
  • Service Cloud
  • Financial Cloud
  • All clouds or platforms that support Salesforce data APIs

Salesforce APIs

The Metallic software uses Salesforce version 47.0 of the following APIs:

  • REST API
  • SOAP API
  • Bulk API

Salesforce Data Protection Best Practices

Verify the Connection to Salesforce

When you perform any of the following operations, click Test Connection to verify that you can connect to Salesforce or the local database:

  • Creating an app
  • Creating a backup set
  • Performing a restore operation to the database, or Salesforce

Backup Schedules

Use the following schedule strategy because the catalog/sync database only contains the latest data cycle:

  • Schedule daily incremental backups
  • Schedule monthly or quarterly full backups depending on your RPO

Incremental Backups

  • Scheduling: The Salesforce replication API does not hold changes more than 30 days, so schedule daily incremental jobs.

Restoring: If you restore the data to a database, or the Salesforce cloud, and you changed data during the full backup, then you might need to restore additional incremental jobs so that you minimize data inconsistencies.

API Calls for Salesforce Backups

Calculate the percentage of API calls needed for backup operations, and if needed, adjust the percentage. For information, see Optimizing the API Calls for Backup Operations.


Completing the Salesforce Guided Setup

You can follow a guided setup for Salesforce backup. Use the setup to provision storage and to enter your Salesforce connection details.

Before You Begin

  • Add a Connected App in Salesforce. You must have the Salesforce consumer key and the Salesforce consumer secret that are generated when you add the connected app.
  • Decide if you want to connect to Salesforce with OAuth or with a user name and password. If you connect with OAuth, you will provide the Salesforce consumer key and the Salesforce consumer secret, and then log on to Salesforce.

Procedure

  1. Go to the Hub.
    The Salesforce trial dialog box appears.
  2. Click Trial Now.
    The Salesforce tab appears.
  3. Click Continue.
    The Hang tight while we prepare your storage and plan dialog box appears. This operation might take a few minutes to complete.
  4. Click OK.
  5. In the upper-right corner of the page, click New Configuration.
    The Add Salesforce organization page appears.
  6. In the Configure app section, enter the following information:
    a. In the Name box, enter a name for the specific Salesforce organization.
    b. From the Plan list, select a server plan.
  7. Under Salesforce account details, enter the account information:
    a. From the Environment list, select one of the following:
    • Sandbox
    • Production
  8. Next to Connection details, select the credentials to use to connect to Salesforce:
Connection typeSteps
OAuth: OAuth credentials are the Salesforce consumer key and the Salesforce consumer secret.1. Click OAuth.
2. Click Login with Salesforce, and then log on to Salesforce.
Password authentication1. Click Password authentication.
2. In the Salesforce login URL box, enter the URL that you use to connect to Salesforce.
3. In the User name box and Password boxes, enter the user credentials that you use to connect to Salesforce.
4. Optional: In the API token box, enter the token that you use to connect to Salesforce.
Salesforce sends the API token the first time that you sign in to your account. For additional information about Salesforce tokens, go to “Reset Your Security Token” on the Salesforce help site.
5. In the Consumer key box, enter the consumer key.
6. In the Consumer secret box, enter the consumer secret.

9. Click Save.


Setup in Salesforce

In Salesforce, verify that you have the required access and create a connected app to integrate with Salesforce.


Salesforce Account and User Permissions

Verify that you can access the Salesforce account and that you have the required Salesforce user permissions.

Account Access Requirements

You must have the following:

  • An admin user account that can connect to the Salesforce login URL from the access node
  • A security token

Best practice: To ensure that all data is backed up and restored, create a backup set for one Salesforce user account that has a System Administrator profile or an equivalent profile.

User Permission Requirements

Permissions for Backups

The Salesforce users who perform the backup operations must have the correct permissions set in their Salesforce user profiles.

Data to back upRequired permissions
Organization• System Administrator profile or an equivalent profile
• At least Read permission for all standard fields and custom fields
Private chatter messages and direct messagesManage Chatter Messages and Direct Messages
Knowledge articlesGive the user who is associated with the backup set access to the knowledge objects.
Encrypted Salesforce dataView Encrypted Data
Note: If you perform a backup without the View Encrypted Data permissions, the masked data is backed up.

Permissions for Restores

The Salesforce users who perform certain types of restore operations must have the correct permissions set in their Salesforce user profiles.

Data to restoreRequired permissions
• The Full Salesforce Sandbox• System Administrator profile or an equivalent profile
• Read/write/modify access to the objects involved
Private chatter messages and direct messagesSystem Administrator profile or an equivalent profile
Encrypted Salesforce dataView Encrypted Data
Note: Certain types of restores, such as single-record restores, contain encrypted data.

Salesforce Connected App for Integrating with APIs

To integrate the Metallic software with Salesforce APIs, in Salesforce you must create a connected app that uses the OAuth authorization protocol.

Note: When you create the connected app, record the Consumer Key and the Consumer Secret. You will enter those values when you add the Salesforce organization to the Metallic software.

Use the following parameters and values to create the connected app:

ParameterValue
Connected appAny unique name
API NameAny unique name
Enable OAuth SettingsSelect this option
Callback URLhttps://Metallic_webhost/adminconsole/#/oauthCallback/
Selected OAuth ScopeFull access (full)
If you will connect to Salesforce using OAuth, also add Perform requests on your behalf at any time (refresh_token, offline_access)
Refresh Token PolicyIf you will connect to Salesforce using OAuth, select Refresh token is valid until revoked.

Setup in Metallic for Salesforce

In the Metallic software, add a Salesforce app and if needed, configure additional options such as backing up Salesforce metadata.


Adding a Salesforce App

Add an app so that you can perform backup and restore operations on your Salesforce data.

Before You Begin

  • Add a Connected App in Salesforce. You must have the Salesforce consumer key and the Salesforce consumer secret that are generated when you add the connected app.
  • Decide if you want to connect to Salesforce with OAuth or with a user name and password. If you connect with OAuth, you will provide the Salesforce consumer key and the Salesforce consumer secret, and then log on to Salesforce.

Procedure

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. Click Add app.
    The Add Salesforce organization page appears.
  3. In the Configure app section, enter the following information:
    a. In the Name box, enter a name for the specific Salesforce organization.
    b. From the Plan list, select a server plan.
  4. Under Salesforce account details, enter the account information:
    a. From the Environment list, select one of the following:
    • Sandbox
    • Production
  5. Next to Connection details, select the credentials to use to connect to Salesforce:
Connection typeSteps
OAuth: OAuth credentials are the Salesforce consumer key and the Salesforce consumer secret.1. Click OAuth.
2. Click Login with Salesforce, and then log on to Salesforce.
Password authentication1. Click Password authentication.
2. In the Salesforce login URL box, enter the URL that you use to connect to Salesforce.
3. In the User name box and Password boxes, enter the user credentials that you use to connect to Salesforce.
4. Optional: In the API token box, enter the token that you use to connect to Salesforce.
Salesforce sends the API token the first time that you sign in to your account. For additional information about Salesforce tokens, go to “Reset Your Security Token” on the Salesforce help site.
5. In the Consumer key box, enter the consumer key.
6. In the Consumer secret box, enter the consumer secret.

6. Click Save.


Data Masking for Salesforce

Use Salesforce data masking to change sensitive information when restoring production data to a sandbox. Salesforce data masking is useful when you are populating or refreshing a sandbox for development or test purposes. With data masking, you can use realistic production data without exposing sensitive information.

The Metallic software applies the data-masking policies when you run a restore operation. You can apply data masking to sensitive data in objects that you are restoring to a destination sandbox.

To start using data masking, create data-masking policies for the Salesforce data.


Data Masking Strategies for Data Types in Salesforce

The Metallic software provides different data-masking strategies based on the data type that you want to mask. For more information about the data types, see the Salesforce documentation in Salesforce Object Basics and its subsections.

Data Masking Strategies

The following data masking types are available in the Metallic software:

  • Dictionary: Dictionary data masking replaces fields or sub-fields of the item with random values from a dictionary. The Metallic software supplies a default dictionary for each data type. You can update values in the dictionaries and add data to the dictionaries. For more information about updating dictionaries, see Modifications to Data-Masking Dictionaries.
  • Fixed string: Fixed string data masking replaces the original string with a string that you specify when you configure a data-masking policy.
  • Format-preserving encryption: Format-preserving encryption generates masked output that is the same length and format as the input. For example, the masked output of a 20-character user name is a 20-character string.
  • Numeric range: Numeric range data masking generates a random number between a minimum value and a maximum value that you specify when you configure a data-masking policy.
  • Numeric variance: Numeric variance data masking takes the initial value and varies it by the percentage that you specify when you configure a data-masking policy.
  • Shuffling: Shuffling data masking takes values from multiple rows in a block (up to 2000 rows) and exchanges the values for the same field by using the Fisher-Yates algorithm. For example, shuffling can be applied to the Name field in an Account object:
    • The Name field without shuffling:
IdName
record1account1
record2account2
record3account3

○ The Name field with shuffling:

IdName
record1account2
record2account3
record3account1

Salesforce Data Type Support

The data masking strategies available for each Salesforce data type are listed.

Salesforce data typeData masking strategy
base64Not applicable
booleanNot applicable
byteNot applicable
dateShuffling
double• Shuffling
• Format-preserving encryption
• Numeric range
• Numeric range
int• Shuffling
• Format-preserving encryption
• Numeric range
• Numeric range
string• Shuffling
• Format-preserving encryption
• Fixing string
timeShuffling
address• Shuffling
• Dictionary
anyType• Shuffling
• Format-preserving encryption
• Numeric range
• Numeric range
• Fixed string
calculatedNot applicable
comboboxNot applicable
currency• Shuffling
• Format-preserving encryption
• Numeric range
• Numeric range
DataCateogryGroupReferenceNot applicable
email• Shuffling
• Format-preserving encryption
• Fixed string
encryptedstring• Shuffling
• Format-preserving encryption
• Fixed string
IDNot applicable
JunctionIdListNot applicable
location• Shuffling
• Dictionary
masterrecordNot applicable
percent• Shuffling
• Format-preserving encryption
• Numeric range
• Numeric range
phone• Shuffling
• Format-preserving encryption
• Fixed string
picklistShuffling
referenceNot applicable
textarea• Shuffling
• Format-preserving encryption
• Fixed string
url• Shuffling
• Format-preserving encryption
• Fixed string

Adding a Data-Masking Policy for Salesforce

You can create a data masking policy for Salesforce data. A data-masking policy contains a set of Salesforce objects and fields to mask and the masking strategy to use to mask the data. The data masking strategies depend on the data type. For example, if the data type is “date”, then you can use the shuffling masking type. For easier management, use separate data-masking policies for each backup set.

Caution: The changes that data masking makes to the data are irreversible and might destroy the data. Data masking is intended for restoring production data to a sandbox.

Before You Begin

You must run a backup before you add your first data-masking policy.

Procedure

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. In the Name column, click the app.
    The app details page appears.
  3. In the upper-right corner of the page, click the action button, and then click Data masking policies.
    The Data masking policies page appears.
  4. Click Add policy.
    The Add masking policy dialog box appears.
  5. In the Policy name box, enter a name for the policy.
  6. In the Configuration section, click Add.
    The Add configuration dialog box appears.
  7. From the Object list, select an object to be masked.
  8. From the Fields list, select the fields to mask.
  9. From the Type list, select the type of masking to use.
    If you selected more than one field, only the data-masking types that are applicable to all the selected fields are shown.
  10. If the data masking type requires inputs, enter the inputs:
    • If you selected Fixed string, in the String box, type the string to use as a replacement.
    • If you selected Numeric range, in the Min and Max boxes, enter the minimum and maximum values to use to generate the random number.
    • If you selected Numeric variance, in the Max percentage box, enter the maximum percentage to use to vary the data.
  11. Click Add.
  12. Click Save.

Data Masking Strategies for Data Types


Modifications to Data-Masking Dictionaries

The Metallic software provides a dictionary for each data type that supports dictionary data masking. In a Linux environment (but not other environments), you can modify the values in the dictionaries, add lines to the dictionaries, and create new dictionaries.

About Modifying the Dictionaries

Important: Do not modify the first line in a dictionary file because it is the key for the contents of the file.

You can edit a dictionary file in-place. Or you can copy a file to another location, edit it, and then replace the original file with the edited file.

About the Dictionary Files

The data-masking dictionaries are text files in the comma-separated values (CSV) format.

The files are in software_installation_directory/Base/CvDmDictionaries.

The files are named data_type_dictionary.cvs. For example, the file for the address data type is Address_dictionary.cvs, and the file for the location data type is Location_dictionary.cvs.

The first three lines of the Address_dictionary.csv file are as follows:

Street,City,State,PostalCode,Country,Latitude,Longitude

253 Dilo Path,Liwaguvuj,MI,60033,USA,-15.34805,-60.0171

298 Cofofa Parkway,Miezupa,CA,73863,USA,8.60635,-39.92633

The first three lines of the Location_dictionary.csv file are as follows:

location__Latitude__s,location__Longitude__s

44.99047,103.21299

-87.34937,-148.14259

Data Masking Strategies for Data Types


Additional Configurations for Salesforce

You can fine-tune Metallic parameters for Salesforce based on your configuration.


Backing Up Deleted and Archived Records from Salesforce

Applies to: Full backup operations

You can back up archived records and records that are in the Salesforce recycle bin (deleted).

Procedure

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. In the Name column, click the app.
    The app details page appears.
  3. On the Overview tab, in the Content section, click Manage.
    The Content dialog box appears.
  4. Select the Backup archived and deleted records check box.
  5. Click Save.

Backing Up Salesforce Metadata

You can back up Salesforce metadata. By default, the Metallic software does not include the Salesforce metadata in backups.

Procedure

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. In the Name column, click the app.
    The app details page appears.
  3. On the Overview tab, in the Content section, click Manage.
    The Content dialog box appears.
  4. Select the Metadata check box.
  5. Click Save.

Excluding Salesforce Objects from a Backup Operation

You can define a list of objects names to exclude from a backup operation. You can use standard regular expressions to match a set of objects. For example, if you want to skip all external objects, enter .*__x$.

Procedure

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. In the Name column, click the app.
    The app details page appears.
  3. On the Overview tab, in the Content section, click Manage.
    The Content dialog box appears.
  4. In the Exclude objects section, click Add.
    The Add objects dialog box appears.
  5. In the Object names box, using a blank space to separate objects, enter the objects to exclude.
    For example, type Account Documents Attachment CustomObj__c.
  6. Click OK.
  7. Click Save.

Optimizing the API Calls for Backup Operations

You can adjust the percentage of Salesforce API calls that backup operations can use per day. The percentage controls the maximum number of files that are backed up per day. After the maximum number of files is backed up, the backup job is suspended. The backup job automatically resumes the next day.

The default value for Metallic backup operations is 50% of the total APIs calls for an organization. For example, if your organization has a maximum of 5 million API calls per day, by default, the Metallic backup operation uses 2.5 million calls per day.

Before You Begin

To calculate the current percentage, on the Salesforce site, go to Setup and look up the following information:

  • The total record count: Setup > Storage Usage > Current File Storage Usage
  • The maximum number of API calls allowed: Company Information > API Requests, Last 24 Hours > (max)

Compare the total record count to the maximum number of API allowed.

Procedure

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. In the Name column, click the app.
    The app details page appears.
  3. On the Configuration tab, in the Account Settings section, next to File download limit per backup, click the percentage.
    The Backup options dialog box appears.
  4. In the File download limit per backup box, type the percentage of API calls to use to back up files.
  5. Click Save.

Performing Salesforce Backups

You can perform a full backup or an incremental backup of the Salesforce data.

Before You Begin

Verify that the Salesforce user who performs the backup operations has the required permissions. For a list of the required permissions, see Account and User Permissions.

Procedure

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. Click the action button, and then click Backup.
    The Select backup level dialog box appears.
  3. Select the backup level:
    • To perform a full backup, select Full.
    • To perform an incremental backup, select Incremental.
  4. To receive an email message when the backup operation is complete, select the When the job completes, notify me via email check box.
  5. Click OK.

Result

When the backup is complete, the job status is Completed.

To avoid exceeding the Salesforce API size limit, a backup job runs until the number of files backed up reaches over 50 percent of the total API calls allowed for the day. Then, the backup job is suspended, but is automatically resumed the next day. This behavior continues until all of the files in the job are backed up.

Events are generated in the following cases:

  • An object fails because of a Salesforce API restriction.
  • The file does not download because the file does not exist at the time of the download.
  • The file is partially downloaded due to the Salesforce API size limit or due to file corruption, and so on.
  • The incremental backup operation identifies more than 100,000 records that were modified or deleted:
    • [NOTIFY_WARNING] Unusually high number of records were modified [record_number] for retrieving the updated records of [object_name]
    • [NOTIFY_WARNING] Unusually high number of records were deleted [record_number] for retrieving the deleted records of [object_name]

Salesforce Restores

As part of your overall data protection planning, plan your Salesforce restore operations according to your requirements.

Record-level Restores

You can restore Salesforce records to a file system or to the Salesforce cloud.

When you perform a record-level restore, you can view all versions of a Salesforce object record.

If you have triggers or workflows that you can edit and the restore destination is a Salesforce instance, then you can have the Metallic software disable the workflows or triggers before the restore, and then activate them after the restore completes (Disable triggers and rules check box). Use this option to improve load performance and minimize errors.

Object-level Restores

You can restore the Salesforce data the following destinations:

  • A file system path that you specify when you perform the restore
  • A relational database management system that you specify when you perform the restore
  • The Salesforce cloud

Salesforce Metadata

You can restore Salesforce metadata to a file system or to the Salesforce cloud. All metadata supported by the Salesforce API is supported for restore operations.

Seeding a Salesforce Sandbox

You can perform a restore to seed a Salesforce sandbox.

Perform granular seeding by configuring rules that specify the object that you want to seed and the object records to use for the seeding. If you would like to seed multiple objects which are not related, you must run separate restores for each object, including their children.

You can specify any of the following records:

  • All records
  • Records that are returned from a user-defined SQL query
  • Records that have been backed up in the last N number of days
  • The most recently backed up N records

Performing Salesforce Record-level Restore Operations

You can restore the selected records of a selected object to a file system or to a Salesforce instance. You can only restore records from the latest backup cycle. Data is restored from a local (sync) database.

If your Salesforce environment has the Persons Account feature, then make sure that you select the Account Object when you want to restore the Person account records. You must make this selection even when you have deleted the account record from the contacts. For more information about the person account feature, go to the Salesforce help site, Person Accounts.

Tip: To avoid errors, or to get faster results, disable the validation rules, Apex triggers, and workflows.

Before You Begin

  • Verify that the Salesforce user who performs the restores has the following permissions:
    • A System Administrator profile or an equivalent profile
    • Read/write/modify access to the objects involved
  • If you want to mask sensitive data during the restore, configure data-masking policies. For more information, see Data Masking.

Procedure

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. Click the action button, and then click Restore.
    The Select restore type page appears.
  3. Click Record level restore.
    The Backup content page appears.
  4. From the Object list, select the object that you want to restore.
    The records for the selected object appear in a table.
  5. Optional: In the upper-right of the page, filter the records:
    • To filter by version, select the versions that you want to view.
      • To show the latest record version, select Show latest version.
      • To show the all versions of the records, select Show all versions.
      • To show the deleted records, select Show deleted records.
    • To filter by SQL, click Advanced filter not set, and then select Set advanced filter.
      The Advanced filter dialog box appears.
      • In the box, type a valid SQL query, and then click OK.
  6. Next to the records that you want to restore, select the check box.
  7. Click Restore.
    The Restore options dialog box appears.
  8. Next to Restore target, select the restore target:
Restore targetSteps
Salesforce• Under Destination details, from the Destination organization list, select the Salesforce destination.
File system• Under Destination details
1. From the Destination server list, select which server to restore the data to.
2. In the Destination path box, enter a path to restore the data to.

9. Under Options, set the restore options:

  • To include parent objects in the restore, from the Parent objects to restore list, select All parents.
    Important: Including parent objects has the following effects:
    • Data integrity is maintained. If parent objects are included and some parents do not exist or some parents have incorrect values, restore operations will complete.
    • When objects such as User objects are updated, end users will receive notifications, which may not be desirable.
  • To include child objects in the restore, from the Child objects to restore list, select the child objects.
  • To exclude some child objects, select the Exclude children check box, and then in the Children to exclude box, select the child objects that you want to exclude.
  • To disable the Salesforce triggers and rules, select the Disable triggers and rules check box.
    After the restore is complete, the workflows and triggers are automatically enabled.
  • To apply data masking, select the Apply masking on destination check box, and then from the Select data masking policy list, select the data-masking policy.
    Note: Data masking can be applied when a cross-instance restore is run and data masking policies are defined.

10. Click Submit.

SQL WHERE Clause Examples for Salesforce Restores


Restoring Salesforce Data to Salesforce

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. Click the action button, and then click Restore.
    The Select restore type page appears.
  3. Click Object level restore.
    The Backup content page appears.
  4. Optional: To select a backup, from the Showing latest backup list, select one of the following options:
  • To show the latest backup, select Show Latest Backup.
  • To show a backup at a specific time, select Show backup as a of a specific date, and then type the date and time.
  • To show backups for a date range, select Show backup for a date range, and then specify the dates.

5. Select the data that you want to restore:

  • To restore files, select the check box next to Files.
  • To restore objects, select the check box next to Objects.
  • To restore both files and objects, select both check boxes.

6. Click Restore.
The Salesforce restore options dialog box appears.
7. Next to Restore target, select Salesforce.
8. Under Destination details, from the Destination organization list, select the Salesforce destination.
9. Under Options, set the restore options:

  • To include parent objects in the restore, from the Parent objects to restore list, select All parents.
    Important: Including parent objects has the following effects:
    • Data integrity is maintained. If parent objects are included and some parents do not exist or some parents have incorrect values, restore operations will complete.
    • When objects such as User objects are updated, end users will receive notifications, which may not be desirable.
  • To include child objects in the restore, from the Child objects to restore list, select the child objects.
    • To exclude some child objects, select the Exclude children check box, and then in the Children to exclude box, select the child objects that you want to exclude.
  • To disable the Salesforce triggers and rules, select the Disable triggers and rules check box.
    After the restore is complete, the workflows and triggers are automatically enabled.
  • To apply data masking, select the Apply masking on destination check box, and then from the Select data masking policy list, select the data-masking policy.
    Note: Data masking can be applied when a cross-instance restore is run and data masking policies are defined.

10. Click Submit.


Restoring Salesforce Metadata to Salesforce

You can restore Salesforce metadata to the Salesforce cloud. Data is restored from media. When data is restored from media, the data is restored to a staging location, and then the data is upload to Salesforce. You can also validate the metadata restore operation before you perform the actual restore operation.

Metadata supported by the Salesforce API is supported for restore operations.

If you need to modify or customize the metadata that you backed up, perform the following operations:

  1. Restore the metadata to a file system.
  2. Modify the corresponding xml files.
  3. Use the Force.com Migration Tool tool to deploy the metadata to the Salesforce organization. For more information, go to the Salesforce help website, Force.com Migration Tool.

Before You Begin

  • Verify that the Salesforce user who performs the restore operation has a System Administrator profile or an equivalent profile.
  • Configure backups to include metadata. For more information, see Backing Up Salesforce Metadata.

Procedure

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. Click the action button, and then click Restore.
    The Select restore type page appears.
  3. Select Metadata restore.
    The Backup content page appears.
  4. Optional: To select a backup, from the Showing latest backup list, select the backup:
    • To show the most recent backup, select Show Latest Backup.
    • To show a backup at a specific time, select Show backup as a of a specific date, and then type the date and time.
    • To show backups for a date range, select Show backup for a date range, and then specify the dates.
  5. Click the Metadata and unpackaged check boxes, and then select the check box for each metadata object that you want to restore.
    Note: For each metadata file that you want to restore, check if the metadata file (-meta.xml) exists, and then select it. For example, suppose that you have AccountBeforeUpdate.cls file that is accompanied by the AccountBeforeUpdate.cls-meta.xml file and you want to restore metadata. In this case, you will need to select both files in the restore operation.
  6. Click Restore.
    The Restore options dialog box appears.
  7. Next to Restore target, select Salesforce.
    a. Under Destination details, from the Destination organization list, select the Salesforce destination.
  8. Click Submit restore.

Restoring the Full Salesforce Sandbox

You can restore all of the organization data from production to a full Salesforce sandbox or from one sandbox to other sandbox. Cross organization restores are supported from full backups only.

Tip: To avoid errors, or to get faster results, disable the validation rules, Apex triggers, and workflows.

Before You Begin

  • Verify that the Salesforce user who performs the restores has the following permissions:
    • A System Administrator profile or an equivalent profile
    • Read/write/modify access to the objects involved
  • In Salesforce, create a destination Sandbox that contains the same metadata as your source organization. The Metallic software does not restore metadata as part of a Sandbox restore.
    For information about creating sandboxes, go to the Salesforce help site, Create a Sandbox.
  • Add an app for the destination organization.
  • To regain space or to prevent duplicate records after the restore is complete, reset the destination organization.
  • Verify that you have enough free space (it must be the size of the data that you want to restore):
    • If you restore from media, then the free space must be available on the staging database.
    • If you restore from the database, then the free space must be available on the catalog database.
    • You must have enough data and file storage space on your destination Salesforce environment.
  • Verify that the destination profile and users match the source profile and users.
  • Verify that the objects exist on the destination organization.
  • If you want to mask sensitive data during the restore, configure data-masking policies.

Procedure

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. Click the action button, and then click Restore.
    The Select restore type page appears.
  3. Select Object level restore.
    The Backup content page appears.
  4. Optional: In the upper right of the page, select the backups that you want to view.
    • To use the most recent backup, click Show latest backups.
    • To use a backup from a specific date, click Show backups as of a specific date, select a date, and then select the backup.
    • To use a backup from a date range, click Show backups for a date range, select a date range, and then select the backup.
  5. Select the data that you want to restore:
    • To restore files, select the check box next to Files.
    • To restore objects, select the check box next to Objects.
    • To restore both files and objects, select both check boxes.
      Note: For a full sandbox restore, do not select individual files or objects.
  6. Click Restore.
    The Salesforce restore options dialog box appears.
  7. Next to Restore target, select Salesforce.
  8. Under Destination details, from the Destination organization list, select the Salesforce destination.
  9. Under Options, set the restore options:
    Note: The Parent objects to restore and Child objects to restore options are ignored because for a full sandbox restore, all objects are restored.
    • To disable the Salesforce triggers and rules, select the Disable triggers and rules check box.
      After the restore is complete, the workflows and triggers are automatically enabled.
    • To apply data masking, select the Apply masking on destination check box, and then from the Select data masking policy list, select the data-masking policy.
      Note: Data masking can be applied when a cross-instance restore is run and data masking policies are defined.
  10. Click Submit.

Seeding a Salesforce Sandbox

Salesforce provides a sandbox that you can use for testing and demo purposes. You can populate (seed) the sandbox with a Metallic backup from your production Salesforce data or another Salesforce sandbox. Data is restored from a local (sync) database.

Perform granular seeding by configuring rules that specify the object that you want to seed and the object records to use for the seeding. If you would like to seed multiple objects which are not related, you must run separate restores for each object, including their children.

You can specify any of the following records:

  • All records
  • Records that are returned from a user-defined SQL query
  • Records that have been backed up in the last N number of days
  • The most recently backed up N records

Before You Begin

  • Verify that the Salesforce user who performs the restores has the following permissions:
    • A System Administrator profile or an equivalent profile
    • Read/write/modify access to the objects involved
  • If you want to mask sensitive data during the restore, configure data-masking policies. For more information, see Data Masking.

Procedure

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. Click the action button, and then click Restore.
    The Select restore type page appears.
  3. Select Sandbox seeding.
    The Sandbox seeding page appears.
  4. To determine which objects are used for seeding the Salesforce sandbox, create the seeding rules.
    a. From the Object name list, select the object that you want to seed.
    b. Click Pick rule/enter query.
    The Add rule dialog box appears.
    c. Next to Selection criteria, choose the records that the software adds to the sandbox:
    • To add all records, select All records.
    • To define a filter by using SQL, select SQL where clause.
    • To define a number of days, select Records updated in the last N days, and then in the Last N days box, enter the number of days.
    • To define the number of records, select Most recently updated N records, and then in the Number of records box, enter the number of records.

d. To include parent objects in the restore, from the Parent objects to restore list, select All parents.
Important: Including parent objects has the following effects:

○ Data integrity is maintained. If parent objects are included and some parents do not exist or some parents have incorrect values, restore operations will complete.
○ When objects such as User objects are updated, end users will receive notifications, which may not be desirable.

e. To include child objects in the restore, from the Child objects to restore list, select the child objects.

  • To exclude some child objects, select the Exclude children check box, and then in the Children to exclude box, select the child objects that you want to exclude.

f. Optional: To view the records, click Preview.
g. Click OK.

5. Optional: Create seeding rules for additional objects.
6. After all of the seeding rules are created, click Restore.
The Restore options dialog box appears.
7. Under Destination details, from the Destination organization list, select the Salesforce destination.
8. To disable the Salesforce triggers and rules, under Options, select the Disable triggers and rules check box.
After the restore is complete, the workflows and triggers are automatically enabled.
9. To apply data masking, select the Apply masking on destination check box, and then from the Select data masking policy list, select the data-masking policy.

Result

After the operation completes, the destination sandbox contains the records that meet the rules that you configured.

Related Topics

SQL WHERE Clause Examples for Salesforce Restores


SQL WHERE Clause Examples for Salesforce Restores

Applies to: Record-level restore operations and seeding a sandbox

If the restore operation accepts SQL queries as filters, use the SQL WHERE clause to define the filter.

Examples

  • Restore a specific set of records by using the 18 character Salesforce ID:
    Id IN (‘001f100001W8X5hAAF’, ‘001f100001W8X5hQAE’, ‘001j000000rqIlWAQE’)
  • Restore records that were modified during a specific time range:
    LastModifiedDate <= '2019-09-14 18:09:51' and LastModifiedDate >= '2019-08-14 18:09:50'
  • Restore Account records that were referred by a contact. The filter is applied to the Account object.
    Id IN (select AccountId from contact where contact.FirstName = 'jon')

Salesforce Data Comparisons

You can view the changes made to the data or the metadata in a Salesforce organization by comparing Salesforce backups.

The Metallic software offers the following comparison types:

  • Object comparison: View the added, deleted, and modified records for an object between two backup times.
  • Metadata comparison: View the file differences for the Salesforce metadata, such as layouts, Apex code, and workflows between two different backup times. You can also compare two Salesforce organizations to one another.

Performing a Salesforce Metadata Comparison

View the file differences for the Salesforce metadata, such as layouts, Apex code, and workflows between two different backup times. You can also compare two Salesforce organizations to one another.

Before You Begin

  • You must include metadata in the subclient that you use for the backups. For more information, see Backing Up Salesforce Metadata.
  • Verify that you have both a full backup and an incremental backup. For more information, see Performing Salesforce Backups.
  • The Metallic user must be associated with a role that includes the Download permission.

Procedure

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. In the Name column, click the app.
    The app details page appears.
  3. In the upper-right corner of the page, click the action button, and then click Compare.
    The Select compare type dialog box appears.
  4. Select Metadata compare.
    The Backup content page appears.
  5. Select the metadata to compare:
    a. In the left pane, go to metadata > unpackaged > metadata.
    b. Beside the data that you want to compare, select the check box.
    c. Click Compare.
    The Compare options dialog box appears.
  6. In the Source date and Date to compare boxes, select the dates for the backups that you want to compare.
  7. Click Compare.
    The Metadata compare details page appears.
    A row for each object lists the objects that were added, modified, and deleted.
  8. To view additional information about the record changes, in the column for the Added, Modified or Deleted changes, click the number.
    The Added, Deleted or Modified record page appears and displays a row for each record change.

Performing a Salesforce Object Comparison

View the added, deleted, and modified records for an object between two backup times.

Before You Begin

Verify that you have both a full backup and an incremental backup.

Procedure

  1. From the navigation pane, go to Protect > Applications > Salesforce.
    The Apps page appears.
  2. In the Name column, click the app.
    The app details page appears.
  3. In the upper-right corner of the page, click the action button, and then click Compare.
    The Select compare type dialog box appears.
  4. Select Object compare.
    The Backup content page appears.
  5. Select the check box next to each object that you want to compare, and then click Compare.
    The Compare options dialog box appears.
  6. In the Source date (start backup time) and Date to compare (end backup time) boxes, enter a date range that includes the backups that you want to compare.
  7. Click Compare.
    The Object compare details page appears.
    A row for each object lists the objects that were added, modified, and deleted.
  8. To view additional information about the record changes, in the column for the Added, Modified or Deleted changes, click the number.
    The Added, Deleted or Modified record page appears and displays a row for each record change.

Performing Salesforce Backups


Endpoint

If you are using the Endpoint solution to back up user laptops and desktops, you can manage your endpoints by using the Hub.

Key Features

  • Fully customizable, plan-based automatic backups: Secure protection for business-critical data on laptops and desktops through source-side deduplication, scheduling, and intelligent bandwidth throttling.
  • Data loss prevention and remote wipe: Prevent unauthorized access to data on laptops by using file-level security that includes securely erasing data and locking sensitive files.
  • End user self-service: End users can access their backed up data from smart phones, tablets, laptops, and desktops using mobile apps, a web-based portal and integrated file system plug-ins. End users can retrieve, manage, and view all of their protected files and e-mails in a cloud-based storage repository, and securely share files for collaboration.
  • Explorer Plugin for Windows: End users can access their backed up data and shares on the laptop using Windows explorer.
  • Migration Assistant: To easily set up a new laptop, end users can move backed up data and user settings (appearance and personalization settings, browser settings, network settings, and more) from their old laptop to their new laptop.

Setup considerations

Add an antivirus exclusion for the installation path: Metallic_installation_directory\Metallic\Contentstore. For example, add c:\Program Files\Metallic\ContentStore.

If outbound traffic to TCP 80/443 is restricted, do the following:

  1. Log on to the Metallic hub.
  2. In the URL, look for the environment number.
    For example, if your URL is m3.metallic.io, 3 is your environment number.
  3. From the hub, create a support case that includes the environment number and your region.
    Note: If you are in multiple regions, include all of the regions in the support case.
  4. After you receive the IP addresses, add them to your whitelist.

Endpoint hub

endpoint-hub

Subscription Usage for Endpoint

You can view usage and metering information in the Subscription Usage tile and the Subscription Usage report on the Hub.

Subscription Usage Tile

The Subscription Usage tile in the Hub displays the total number of unique users protected from the start of the current month until today.

If a user was protected for one or more days in the month, the user is counted as part of the total user usage. The user is counted even if it is removed from a backup schedule or if backup data was deleted from the system within the same month. If the user is not backed up in the following months, it is not counted as part of subscription usage for those months.

For example, if User 1 and User 2 are protected on the first day of the month, and User 1 is removed from the system later that month, the total number of users protected in the month is two users. If User 1 is not backed up in the following month and User 2 is backed up, the total number of users protected in the month is one user.

Subscription Usage for Endpoint

Subscription Usage Report

To access the Subscription Usage report, click the link in the Subscription Usage tile in the Hub. The Subscription Usage report lists the names of all the users protected from the start of the current month to today. Use this report to validate the subscription usage you are charged for.


Install software and authenticate users

To backup and monitor endpoint data, the Endpoint package must be installed on your users’ laptops and desktops. You can ask your users to download and to install the laptop package, or you can perform a silent installation of the laptop package. To decide which method to use in your environment, review the details of each method.

Interactive installations

User authenticationTenant administrator actionUser action
Active DirectoryConfigure an Active Directory identity server. Distribute the link for the laptop package and the auth code to users. Users can also use their email addresses to register their laptops.Download and install the laptop package, and then register the laptop or desktop with the auth code provided by the tenant administrator or your email address.
SAMLConfigure an identity provider that supports SAML. Distribute the link for the laptop package and the auth code to users.Download and install the laptop package, and then register the laptop or desktop with the auth code provided by the tenant administrator.
LocalCreate users and automatically send the users email invitations. The email invitation contains a link for the laptop package and user credentials.Download and install the laptop package, and then register the laptop or desktop with the credentials in the invitation email.

Silent Installations

User authenticationTenant administrator actionUser action
Active DirectoryConfigure an Active Directory identity server. Install the laptop package by using a third-party tool and the auth code.None
SAMLConfigure an identity provider that supports SAML. Install the laptop package by using a third-party tool and the auth code.None

Installing software by using a third-party tool

The Endpoint package can be pushed and installed using third-party software such as Microsoft System Center Configuration Manager (SCCM) or Jamf software.

Before you begin

Obtain the authorization code by going to the Hub, and then on the Endpoint tab, click Download Packages.

Procedure

Configure the third-party software to run the following command from the folder containing the laptop package contents.

  • Windows Windows packages use a self-extracting executable that can be launched using a deployment tool with command line. The package must be pushed to the machine locally before running the command line. Running the package remotely over the network is not supported.
    Win32_Client.exe /silent /install /silent /authcode authcode
    WinX64_Client.exe /silent /install /silent /authcode authcode
    Where authcode is the authorization code. The authorization code is required if the package does not contain user credentials for an installation user.
  • Macintosh Operating System (macOS) Silent macOS packages use the macOS pkg framework. These can be directly placed into the Jamf Casper software to run anytime. The package does not take arguments on command line, so you need to create a text file with the arguments, on the local macOS computer. On the local macOS computer, create an “install.ini” file in the global application support directory:
    • Path to the ini file: /Library/Application Support/Commvault/install.ini
    • Parameter inside the ini file: AUTH_CODE=”######” After creating the text file, you can push the macOS.pkg package to the client.
  • UNIX Operating System For silent install on a UNIX machine, use the following:
    ./silent_install –authcode authcode
    Where authcode is the authorization code. The authorization code is required if the package does not contain user credentials for an installation user.
  • For interactive or semi-silent install on a UNIX machine, use the following:
    ./cvpkgadd –authcode authcode
    Where authcode is the authorization code. The authorization code is required if the package does not contain user credentials for an installation user.

Uninstalling software

You can uninstall the Metallic software from a computer by running a command from the command line.

Procedure

  1. Log on to the computer as an Administrator or as a member of the Administrator group on that computer.
  2. At the command line, go to the location where you stored the installation package and then locate the Setup.exe file.
  3. Depending on the operating system, run one of the following commands:

Windows

Setup.exe /uninstall /silent 

UNIX, Linux, and Macintosh

cvpkgrm -i all

Tasks

From the Endpoint Hub, you can perform the following tasks:

  • Download packages for end-user laptops and desktops
  • Manually add users if you do not use an identity provider
  • Configure an identity provider
  • Change what is backed up on user laptops and desktops

Download packages

To backup and monitor endpoint data, the Endpoint package must be installed on your users’ laptops and desktops. You can ask your users to download and to install the laptop package, or you can perform a silent installation of the laptop package. For more information about these methods, see Install software and authenticate users.

The Endpoint package is available for the following operating systems:

Linux
  • Debian 9.x to Debian 10.x
  • Fedora release 29 with glibc 2.28.x to Fedora release 30 with glibc 2.29.x
  • Red Hat Enterprise Linux 7.x to Red Hat Enterprise Linux 8.x
  • Ubuntu 8.04 to Ubuntu 18.10
Macintosh
  • macOS Big Sur (v11.x)
  • macOS Catalina (v10.15.x)
  • macOS Mojave (v10.14.x)
  • macOS High Sierra (v10.13.x)
  • macOS Sierra (v10.12.x)
Windows
  • Microsoft Windows 7 Editions to Microsoft Windows Client 10 Editions

Add users manually

To authenticate users with credentials stored in the Metallic backup service, manually add users. When you manually add users, you have the option to automatically send the users email invitations to download and install the Endpoint package on their laptops or desktops. The email invitation contains a link for to the Endpoint package and user credentials.

Note: If you configure an identity provider, you do not need to create users local to the Metallic backup service.

Configuring identity provider

To authenticate users with SAML, configure an identity provider. Common SAML identity providers include AD FS, Azure, and Okta.

Managing backup content

You can change what is backed up on user laptops and desktops.

By default, the following content is included or excluded when a laptop or desktop is backed up:

IncludedExcluded
Desktop folder Documents folder Office file extensions Pictures folder Image file extensionsTemporary Files (Windows, Mac, Linux) C:\Program Files C:\Program Files (x86) C:\Windows

Procedure

  1. Go to the Hub.
  2. On the Endpoint tab, click Manage backup content.The Laptop plan page appears.
  3. On the General tab, in the Plan name box, type the name of the plan.
  4. Click Next.
  5. On the Backup content tab, click the Override base setting check box.
  6. Define the content to backup:
    1. On the WindowsMac, or UNIX tab, beside Content to backup, click Add.
    2. In the Add content dialog box, browse for content to back up, or click Add custom content to type a path or pattern. For example, type *.docx to back up all files with the docx extension.
    3. To exclude some content from the content you are backing up, next to Exclude these files/folders/patterns, click Add.
    4. Click Save.
    5. Repeat these steps until content is added for each operating system that you want the plan to support.
  7. Click Next accepting all default values.
  8. Optional: On the Options tab, clear the check box for any alerts that you do not want to receive.
  9. Click Finish.

Restoring files and folders for a laptop or computer

You can restore backed-up data, including data that was previously deleted, to the same computer or laptop or a different computer or laptop.

Procedure

  1. Go to the Hub.
  2. On the Endpoint tab, in the Protected Data Sources tile, click the number of devices that you are managing. The Laptops page appears.
  3. In the Actions column for the laptop or computer that you want to restore, click the action button , and then click Restore. The Backup content page appears.
  4. Browse for the files and folders that you want to restore. Tip: You can change the backup content you see by using the filter options in the upper-right corner of the page.
  5. To view data that was deleted from the previous backup operations, click the action button , and then click Show deleted items. Any previously deleted backed-up data appears.
  6. Select the check boxes for the files and folders that you want to restore.
  7. Click Restore. The Restore options dialog box appears.
  8. Choose how you want to restore the data:
    • Destination client: Select the computer where you want to restore the data.
    • Restore to original folder: (default) The option to restore data to the folder from where it was backed up. If you want to enter a new path in the Destination path box, clear this check box.
    • Destination path: If you cleared the Restore to original folder check box, click Browse to choose a folder or to create a new folder. The data is restored to the folder that you choose or create.
    • Unconditionally overwrite if it already exists: The option to overwrite files and folders on the destination laptop or computer with the files and folders you are restoring.
    • Impersonate user: Select this option, and then, in the Username and Password boxes, enter the credentials for a user account that has permissions to execute the restore process on the destination computer.
    • When the job completes, notify me via email: Select this option if you want to receive an email when the restore job completes.
  9. Click Submit.

Compliance Search

Use Compliance Search to search for information in structured or unstructured data within your organization. Compliance Search provides an intuitive interface for entering, categorizing and retrieving data securely, in compliance with security and data retention regulation.

Getting Started

After the Metallic team finishes setting up your Compliance Search environment, add compliance officers. Compliance officers perform searches to locate the information that is needed to satisfy regulatory compliance requirements.

Compliance Holds

To hold data for compliance purposes, you can set your user mailboxes to unlimited retention or to the retention term specified by your compliance mandate. Retention settings are on the plan that you associate with your mailboxes.


Creating compliance officers

To give users access to Compliance Search, create compliance officers.

Procedure

  1. Go to the Hub.
  2. In the User Management tile, click Manage > Compliance.
    The eDiscovery user group properties page appears.
  3. In the User section, click Add users.
    The Add users dialog box appears.
  4. You can add an existing user or a new user:
    • To add an existing user, do the following:
      1. Next to the user, select the check box.
      2. Click Add.
    • To add a new user, do the following:
      1. Click Add new user.
        The Add user dialog box appears.
      2. Enter the user information.
      3. Click Save.
        The user properties page appears.
      4. To return to the user group, click the name of the user group.

Accessing Compliance Search from the Hub

To search for email messages or files, you can open the Compliance Search search page from the Metallic Hub.

Note: If you are a Compliance Officer, access Compliance Search through the website address provided by your administrator.

Procedure

  1. Go to the Hub.
  2. On the Office 365 tab or the Endpoint tab, in the upper-right corner, click Compliance Search.
    The Search page appears.
  3. In the search box, type a keyword, and then click Search.
    Search results appear in a tab. In the left pane, under Search Engine, the number of results for each search engine is displayed. Click a search engine to see the search results for that search engine. In the left pane, you can also click predefined filters to quickly filter the search results.

Basic Email Search Options for Compliance Search

Use these options to perform basic email searches from the Compliance Search search bar.

Basic Search OptionsDescription
Search by KeywordType keywords into the search bar to search for messages that contain any of the entered keywords anywhere in the email message. Keyword searches are not case-sensitive. For example, searches that use the keywords monday or Monday will return the same results.
Search by Exact PhraseTo search using an exact phrase, place quotation marks before and after the phrase. For example, enter “today’s meeting notes” in the search bar to view results that contain this exact phrase.
Search by SenderTo search for emails from a particular sender, type from: in lower-case, followed by the sender’s name. For example, enter from: John Doe to search for emails sent from John Doe. You can also add quotation marks around the name to search by exact phrase.
Search by RecipientTo search for emails from a particular recipient, type to: in lower-case, followed by the recipient’s name. For example, enter to: John Doe to search for emails sent to John Doe. You can also add quotation marks around the name to search by exact phrase. Note: When you search for emails for a specific recipient, search results do not include messages sent to a distribution group the recipient belongs to unless you include the distribution group in your query.
Search by SubjectTo search for emails with certain keywords in the subject line, type conv: in lower-case, followed by the keywords. For example, enter conv: monday’s meeting to search for emails that contain these words in the subject line. You can also add quotation marks around the keywords to search by exact phrase.

Basic File Search Options for Compliance Search

Use these options to perform basic file searches from the Compliance Search search bar.

Basic Search OptionsDescription
Search by KeywordType keywords into the search bar to search for files that contain any of the entered keywords anywhere in the text of the document. Keyword searches are not case-sensitive. For example, searches that use the keywords monday or Monday return the same results.
Search by Exact PhraseTo search using an exact phrase, place quotation marks before and after the phrase. For example, enter “today’s meeting notes” in the search bar to view results that contain this exact phrase.
Search by LocationTo search for files within a particular location, type url: in lower-case, followed by the path of the directory. For example, enter url: C\:\\temp to search for files within the Temp folder on the C: drive.
Search by TitleTo search for files within a specific title, type conv: in lower-case, followed by the path of the title. For example, enter conv: agenda to search for files with the title Agenda. You can also add quotation marks around the keywords to search by exact phrase.

Wildcard Search

You can search for data using a wildcard character within a single keyword.

  • To replace a single character with a wildcard, use the question mark ? symbol. For example, to search for best or test,you can search using the keyword ?est.
  • To replace from zero to any number of characters with a wildcard, use the asterisk * symbol. For example, to search for betbetterbetting, you can search using the keyword bet*.
  • You can use wildcard characters in the middle of a keyword. For example, to search for books, you can search using the keyword boo*s.

Considerations

  • The wildcards are not supported within quotation marks ” “.
  • Multiple wildcard characters cannot be included when searching for a phrase.
  • Do not include a space before or after a wildcard character.

Creating Export Sets

You can create export sets in Compliance Search. Export sets are useful for preparing data or converting data to a uniform format such as CAB or PST.

Procedure

  1. In Compliance Search, perform a search.
  2. Click the check box next to the items that you want to add to the export set.
  3. Above the search bar, click Export To.
  4. Select the export format from the list.
  5. In the Export To dialog box, in the Export Set list, click Create New.
  6. Type the name of export set in the Export Set Name box.
    Note: The following characters / \ : * ? " < > | @ ; & ^ () % # + are not allowed in the name of an export set.
  7. Optional: In the Description box, type the description.
  8. Click OK.

Downloading Search Results in Compliance Search

You can download your Compliance Search search results. If multiple files or emails are selected for download, the files or emails are downloaded as a zip file. If the file name contains Unicode characters, the file name changes after download.

Procedure

  1. From the search result window, select the files or emails to be downloaded.
  2. Above the search bar, click Download.
    The files or emails are downloaded on your local disk at the destination folder specified by you.
    The downloaded file name is converted to a hyperlink.

Monitoring the Backup Environment

You can monitor activity in your environment by creating alert definitions, viewing events, and viewing and controlling jobs.


Accessing reports

Use reports to view the most critical information gathered from your Metallic environment.

To get started with Metallic reports, run the following reports:

  • SLA
  • Audit Trail
  • Backup Job Summary
  • Restore Job Summary

Procedure

  1. Log on to the Command Center.
  2. From the navigation pane, click Reports.
    The Reports page appears.
  3. Click a report.

Viewing Triggered Alerts

An alert is triggered when conditions within the entity meet the criterion selected in the alert definition.

Procedure

  1. From the navigation pane, click Alerts. The Triggered alerts page appears.
  2. Review the alerts triggered from the alert definitions.
  3. To see the alert details, in the Alert info column, click the descriptive link.

Deleting Triggered Alerts

You can delete triggered alerts.

Procedure

  1. From the navigation pane, click Alerts. The Triggered alerts page appears.
  2. To delete alerts, do one of the following:
    • To delete individual alerts, select the check box for the alert, and then click Delete.
    • To delete all of the alerts, select the check box in the table header and click Delete.

Note: If there are pinned alerts in the list, they are deleted.


Creating an Alert

You can create alerts to provide automatic notification about operations, such as failed jobs.

Procedure

  1. From the navigation pane, click Alerts. The Triggered alerts page appears.
  2. In the upper-left area of the page, click Alerts definitions. The Alerts definition page appears.
  3. In the upper-right area of the page, click Add alert definition. The Add alerts definition dialog box appears.
  4. In the Alert name box, type a name for the alert.
  5. From the Alert type list, click the type of alert you want to create. For example, select Backup Job Failed.
  6. If the alert type has a variable in it, in the Value for X box, enter a value for the variable.For example, you must define the value for X for the Backup Delay by X Hrs alert type.
  7. Under Entities, select the entities to apply the alert to.
  8. Under Users, for each user to notify, do one of the following:
    • Type the user email address.
    • Type the user or user group name, and from the generated list, select the user or user group.
  9. Click Add.
  10. Click Save.

Viewing Events

The Events page provides information about jobs and other significant events. In some cases, events can trigger alerts to notify users of events (such as job failures).

Procedure

  1. From the navigation pane, click Events. The Events page appears.
  2. To view details for an event, in the Event ID column, click the event ID.

Viewing Jobs

You can view jobs for the entities in your application. For example, you can view jobs for servers or laptops.

All Jobs

Procedure
  1. From the navigation pane, go to Jobs. The Active jobs page appears.

Tip: You can change the jobs you see by using the filter options in the upper-right corner of the page.

  1. To view the job details, in the Job ID column, click the job ID.

For a Specific Entity

Procedure
  1. From the navigation pane, click the entity. For example, select Servers.
  2. In the table of available entities, in the Name column, click the entity. The entity properties page appears.
  3. In the upper right of the entity details page, click Jobs.

Note: Some entities have links to view specific types of jobs. For example, on the laptop details page, click Restore jobs to view the restore jobs for the laptop.


Controlling Jobs

You can control active jobs. For example, you can suspend a job.

Procedure

  1. From the navigation pane, go to Jobs. The Active jobs page appears.

Tip: You can change the jobs you see by using the filter options in the upper-right corner of the page.

  1. In the Actions column for the job, click the action button and choose your action:
  • To kill the job, click Kill.
  • To suspend the job, click Suspend.
  • To resume a suspended job, click Resume.

Network connectivity

You must be able to connect to the proxies and domains associated with your Metallic environment. Outbound network connectivity is needed for data transfer, device registration, and portal access.

To allow outbound connectivity, obtain the region-specific proxy IP addresses and domains associated with your environment.

Procedure

  1. Log on to the Metallic hub.
  2. In the URL, look for the environment number.
    For example, if your URL is m3.metallic.io, 3 is your environment number.
  3. From the hub, create a support case that includes the environment number and your region.
    Note: If you are in multiple regions, include all of the regions in the support case.
  4. After you receive the proxy IP addresses and domains, allow outbound connectivity.

Supported platforms and applications

You can back up data sources that meet the following requirements.

Applications

The following applications are supported.

Linux

  • Microsoft SQL Server 2017 Editions up to the latest Service Pack

Windows

  • Microsoft SQL Server 2019 Editions up to the latest Service Pack
  • Microsoft SQL Server 2017 Editions up to the latest Service Pack
  • Microsoft SQL Server 2016 Editions up to the latest Service Pack
  • Microsoft SQL Server 2014 Editions up to the latest Service Pack
  • Microsoft SQL Server 2012 Editions up to the latest Service Pack
  • Microsoft SQL Server 2008 R2 Editions up to the latest Service Pack
  • Microsoft SQL Server 2008 Editions up to the latest Service Pack
  • Microsoft SQL Server 2005 Editions up to the latest Service Pack

Endpoints

The following operating systems are supported for laptops and desktops.

Linux

  • Debian 9.x to Debian 10.x
  • Fedora release 29 with glibc 2.28.x to Fedora release 30 with glibc 2.29.x
  • Red Hat Enterprise Linux 7.x to Red Hat Enterprise Linux 8.x
  • Ubuntu 8.04 to Ubuntu 18.10

Macintosh

  • macOS Big Sur (v11.x)
  • macOS Catalina (v10.15.x)
  • macOS Mojave (v10.14.x)
  • macOS High Sierra (v10.13.x)
  • macOS Sierra (v10.12.x)

Windows

  • Microsoft Windows 7 Editions to Microsoft Windows Client 10

File Servers

The following operating systems are supported.

Linux

  • Debian 9.x
  • Fedora release 29 with glibc 2.28.x
  • Red Hat Enterprise Linux/CentOS 7.x with glibc 2.17.x and Red Hat Enterprise Linux/CentOS 8.x with glibc 2.28.x
  • SuSE Linux (SLES) 11 to 15
  • Ubuntu 8.04 to Ubuntu 18.10

Windows

  • Microsoft Windows Server 2003 Editions to Microsoft Windows Server 2019 Editions: All editions except Nano Server

Hypervisors

The following hypervisors are supported.

VMware

  • Streaming backups using vCenter Server versions 4.1 – 6.7 Update 2

Hyper-V

  • Streaming backups using a Microsoft Windows Server or a Microsoft Hyper-V Server