Add users and companies to MBS in bulk


This article describes a procedure that allows to bulk-add multiple user accounts, for example, when transitioning from another solution to Managed Backup Services. The users are imported based on information contained in a CSV file with the help of a Powershell script.


Prerequisites

  • Windows operating system with Windows PowerShell 3.0 or higher.
  • Administrator privileges
  • MBS root account credentials

Prepare for import

  1. Download sample CSV file by following the link below.

       Users.csv

  1. Go to MBS portal -> Settings -> General -> API 2.0 Credentials -> Change Credentials

  1. Generate new API credentials and copy them. We will need them for Powershell script later.

  1. Open Users.csv with MS Excel or OpenOffice. Make sure you use a comma as a separator.

4.1. Add user information.

Email, Password (minimum 6 symbols) and Enabled columns are required.

If randomly generated passwords are needed for specific users, the Password column can be left blank.

4.2. Companies, specified for users, will be created automatically or assigned if already exists.

4.3. Use semicolon to separate notification emails for user.

4.4. Save the CSV file.


Run script in Powershell

  1. Run Windows Powershell as administrator.

  1. Install MSP360 PowerShell module. Depending on the version of PowerShell in the system, use the correct commands described in the article below:

       Managed Backup Service PowerShell Module - Getting Started

  1. Set MBS API credentials for this session by executing the following command:
Set-MBSAPICredential -UserName your_login -Password your_password

  1. Change directory to location of Users.csv file.

  1. Import users by running the following command:
Import-MBSAPIUser

The script checks whether there are errors in CSV file. By default, import will not be done if errors persist.

Optional script parameters:

-GeneratePassword # Generates passwords (8 alphanumeric symbols long) for users with blank password field in CSV file. After import a new CSV file will be created where generated passwords will be filled.

-Force # Skip users with errors and import only entries with correct information.

  1. As a result of importing users, the script shows user ID or error message.

Add existing backup destination to all users

When users are created, you need to assign the backup destination to users. Follow the instructions in the video below.


Contact Us

Tech questions: tech@cloudberrylab.com

Sales questions: sales@cloudberrylab.com