Installing the Filesystem Client

Overview

The Filesystem Client is the core component of the Commvault client software.  You can install this client to allow the UBSi service to backup individual files and directories on a Windows or Linux server.  You can also install this client in restore-only mode to provide a destination for restores of files from VM backups.  Once this client is installed, you can install additional components to perform application-specific backups.

Download the Installer

  1. Log into UBSi: https://ubsi.blue.psu.edu/commandcenter/
  2. Navigate to “Web console” -> “Download center” in the left-hand menu.
  3. Find the latest download for your operating system.  For example, “Windows FS 11.32.xx” or “Linux FS 11.32.xx” and click the “Download” button.  Save the download to your client system.

Direct Links:

Finding your authcode

In order to register a new client with your tenant, you will need to use the tenant’s “Authcode”.  To find the authcode:

  1. Log into UBSi: https://ubsi.blue.psu.edu/commandcenter/
  2. Make sure that you have the correct tenant (“Company”) selected in the upper right corner of the screen.
  3. Navigate to “Manage” -> “Company” in the left-hand menu.  (If you see “Companies” instead of “Company”, you missed step 2!)
  4. In the “General” pane, find the setting “Requires authcode for installation” and verify that it’s already enabled.
  5. To the right of the checkbox, you will see the 9 character authcode.  You can click on the code itself to copy it to your clipboard.You should avoid sharing your authcode with others, because it would allow them to add their machines to your tenant.  To the right of the authcode there is a small “refresh” arrow icon.  If you ever need to reset your authcode, you can press this icon to generate a new authcode and invalidate any previous ones.  This will not affect any clients that were previously joined to the tenant.

Windows GUI: Run the Installation Wizard

  1. Run the download package EXE file.  Select a destination folder, and click “Extract”.  The installer will be extracted, and “Setup.exe” will be launched automatically.
  2. Select the desired language and click the “Next” button.
  3. Check “I Agree” and click the “Next” button.
  4. Select “Install packages on this computer” and click the “Next” button.
  5. Select “Join an existing CommCell” and click the “Next” button.
  6. Check the “File server” role checkbox and click the “Next” button.  Do not check the “Laptop”, “Activate”, or “Gateways” checkboxes; we do not have access to those features.
  7. Review the “Installation Path” and click the “Next” button.
  8. Review the information on the “Installation Summary” screen and click the “Next” button to begin the install.
  9. Wait for the installation to complete.
  10. Enter the desired “Client Name”, verify the selected “Host Name”, and click the “Next” button.  Avoid including spaces in the client name (use only letters, numbers, period, hyphen, underscore).  If the client is a VM, it’s recommended to use VM’s name (as seen in the VM Hosting portal) as the client name.
  11. Enter the CommServe name “ubsi.blue.psu.edu” and click the “Next” button.  We use the default port (8403), so it can be omitted.  Leave “CommServe will connect to this computer to finish registration” UNCHECKED.  Your computer must connect to the CommServe; the CommServe cannot initiate this connection.
  12. Wait for the client to test its connection to the CommServe.
  13. On the “Server Authentication” screen, leave “Authcode” selected.  Enter your Authorization Code and click the “Next” button.  (See the section on “Finding your authcode” above.)
  14. Wait for the client to register with the CommServe and install any required updates.  When this is complete, the screen will say “Installation and configuration completed successfully.
  15. Click the “Finish” button.

The client should now be visible under in the UBSi – Commvault web interface (https://ubsi.blue.psu.edu/), and you can complete any remaining configuration there.

Linux Shell: Run the Installation Wizard

  1. Extract the download package TAR file. 
    mkdir ~/cvinstall
cd ~/cvinstall
tar xf /path/to/commvault_linux_x86-64_*.tar
  2. Run the extracted installer: 
    cd ~/cvinstall/Unix
sudo ./cvpkgadd
  3. OEM Selection
    Leave “Commvault” selected.  Use the “TAB” key to jump to “Next”, and press the “Enter” or “Space” key to confirm.
  4. Welcome to Commvault Installer
    Use the arrow keys to highlight the “Next” button, and the “Enter” or “Space” key to confirm.
  5. Install Task
    Check “Install packages on this machine”, then use the “TAB” key to jump to “Next”, and press “Enter” or “Space” to confirm.
  6. Install Option
    Check “Join an existing CommCell”, then “Next”.
  7. Interface Selection
    Select the correct network interface, then “Next”.
  8. Select Roles
    Select the “File server” Role, then “Next”.
  9. Install Agents for Restore Only
    Select “Yes” if you are installing the client as a restore destination or as the basis for an application-specific agent.
    Select “No” if you intend to perform file backups using this client.  You can change your mind later.
    Then select “Next”.
  10. Install Directory
    We recommend accepting the default installation directory (“/opt”).  Select “Next”.
  11. Log Directory
    We recommend accepting the default (“/var/log”).  Select “Next”.
  12. Unix Group Assignment
    Select the default (“No”), unless you need this feature.  Select “Next”.
  13. Client Host Information
    Confirm that the detected hostname is correct.  Select “Next”.
  14. Client Information
    Enter the desired client name.  If the system is a VM, use the VM’s name here.  Otherwise this value is somewhat arbitrary.  In most cases you should use a short or long hostname for your system, to make it easy to identify the client.  Select “Next”.
  15. Summary
    Review the previous answers.  Select “Next”.
  16. Installing Packages
    Wait for the installation to complete.
  17. Server Information
    Enter the CommServe name “ubsi.blue.psu.edu” and then select “Next”.  We use the default port (8403), so it can be omitted.  Leave “CommServe will connect to this computer to finish registration” UNCHECKED.  Your computer must connect to the CommServe; the CommServe cannot initiate this connection.
  18. Configure HTTP Proxy
    Enter your proxy information if required.  Most users can check “No” and then select “Next”.
  19. Firewall Configuration
    Wait for the installer to connect to the UBSi-Commvault server.  If the installer fails to connect, check your firewall rules and proxy settings.  The screen may briefly show “Back”, “Next”, “Quit” buttons, but you should not need to select them.
  20. Server Authentication
    Use TAB to select the “AuthCode” field.  Enter your Authorization Code and select “Next”.  (See the section on “Finding your authcode” above.)
  21. Register the Client
    Wait while the client registers with the UBSi-Commvault server.
  22. Installation Status
    Select “Finish”.

The client should now be visible under in the UBSi – Commvault web interface (https://ubsi.blue.psu.edu/), and you can complete any remaining configuration there.

Managing normal clients

If you did not select “Restore Only” mode, the client will appear under “Protect” -> “File servers”, where you can configure its backups.  You will need to select a backup Plan for the client so that it knows where to send the backup data and how long to retain it.  You can also customize the back up content and other settings.

Remember that VM Hosting VMs are also backed up as entire VMs, and you can restore files from within the VM backups if needed.  Where possible, select only the relevant data for your filesystem backups.  Avoid including operating system files, which are covered better by the VM backup.

Managing “Restore Only” clients

If you selected “Restore Only” mode, the client will not be used to perform backups, and will be excluded from SLA reports and alerts.  VM backups and alerts will still run normally.

When you perform a restore, you will be able to find and select this client in the “Destination client” dropdown box.

The client will NOT appear under the “Protect” menu, since it has no backups.  Instead, it will appear under “Manage” -> “Servers”.  Make sure to select “Type = All” instead of the default “Type = Infrastructure”.

To take a client out of “Restore Only” mode, use the “Add Software” action to add the “File System” package.  This will assign a File System license to your client, allowing you to manage its backups under “Protect” -> “File servers”.

To put a client back into “Restore Only” mode, submit a ticket with your request.  We will release the license for the client, returning it to “Restore Only” mode.