6 minute readApplies to: v3

How to backup and restore SquaredUp

Backing up and restoring SquaredUp is relatively simple. If you are using SquaredUp with high availability (HA) there is more to consider, so see the separate instructions Backing up SquaredUp when using high availability (HA) and Restoring SquaredUp when using high availability (HA).

Backing up SquaredUp

You can backup the entire application folder, which by default is located at C:\inetpub\wwwroot\SquaredUpv3, or just the C:\inetpub\wwwroot\SquaredUpv3\User folder, as this where your specific dashboards and settings are located.

  • C:\inetpub\wwwroot\SquaredUpv3\User\Packages - contains your user-published dashboards and perspectives
  • C:\inetpub\wwwroot\SquaredUpv3\User\Profiles - contains your default and custom user profiles and navigation bar items
  • C:\inetpub\wwwroot\SquaredUpv3\User\Configuration - contains your SquaredUp configuration settings

Restoring SquaredUp

  1. Download and install SquaredUp.
  2. Log on to SquaredUp and complete the setup to configure SquaredUp, such as activating your licence and configuring the connection to the SCOM Data Warehouse. If you need an additional activation please contact SquaredUp Support.
  3. Restore the C:\inetpub\wwwroot\SquaredUpv3\User folder.
  4. In IIS recycle the SquaredUpv3 application pool.

If you restore to a new machine or operating system, you will need to reconfigure any OMS and Web API connections. API connections are encrypted, so any old connections will not be accessible because they cannot be decrypted on the new machine.

If you migrate to a new SCOM management group then the SCOM IDs of objects and custom groups will change. Any tiles that have been scoped to specific objects or custom groups will need the scope to be reconfigured. Tiles using classes or groups contained within sealed management packs will not be affected.

Backing up SquaredUp when using high availability (HA)

When using high availability (HA) you should backup:

  • Everything on the SquaredUp HA share.
  • C:\inetpub\wwwroot\SquaredUpv3\User\Configuration

Restoring SquaredUp when using high availability (HA)

Restoring the SquaredUp application (leaving the share as it is)

Follow these steps if you need to restore the SquaredUp application, but not the share, for example if the SquaredUp server has been replaced. This will set SquaredUp into HA mode to look at the share, but leave the files on the share as they are.

  1. Download and install SquaredUp. When using HA it is critical that all SquaredUp servers are running the same version of SquaredUp.
  2. Logon to SquaredUp and complete the setup to configure SquaredUp, such as activating your licence and configuring the connection to the SCOM Data Warehouse. If you need an additional activation please contact SquaredUp Support.
  3. In IIS stop the SquaredUpv3 application pool.
  4. Open an administrative command prompt on the server. Click on the Start button, type Command Prompt, right-click on the Command Prompt icon and select Run as administrator.
  5. Change to the SquaredUp installation folder, for example:

    cd C:\inetpub\wwwroot\SquaredUpv3

  6. Run the SquaredUp HA command with the noconfigcopy parameter:

    squaredup ha --share=<Your shared folder here> --noconfigcopy

    where <Your shared folder here> should be replaced by the drive or path specification for your network share. e.g: X:\ or \\myhost\folder. This should be the folder in which the Locking and User folders reside.

    This also restarts the SquaredUp application pool.

Restoring the HA share

Follow these steps if you need to restore the SquaredUp share, for example if the server which hosts the share has been replaced.

  1. In IIS on each SquaredUp server stop the SquaredUpv3 application pool.
  2. Restore all the files and folders to the HA share.
  3. Next we need to check the permissions on the share itself, as this takes precedence over the file and folder permissions. On the machine that hosts the share, click on Start > type Computer Management > open Computer Management. In System Tools > Shared Folders > Shares right-click on your HA share and select Properties. On the Share Permissions tab check that the SquaredUp application pool account has read and change permissions, or add the account(s) and the permissions if necessary.

    Check Share permissions in Computer Management

    It is possible for each SquaredUp server to be using a different SquaredUp application pool identity (except when using Windows authentication when they must use the same identity) so check that each application pool identity has the required permissions.

  4. Now we need to set the permissions of the files and folders on the share. Open an administrative command prompt on the server by clicking on the Start button, typingCommand Prompt, right-clicking on the Command Prompt icon and selecting Run as administrator.
  5. Change to the SquaredUp installation folder, for example:

    cd C:\inetpub\wwwroot\SquaredUpv3

  6. Run the following command to give the SquaredUp application pool the correct permissions to your HA share, for example:

    squaredup permissions --destination="<Your shared folder here>" --user="DOMAIN\USER"

    where <Your shared folder here> is replaced by your share, such as \\myhost\folder, DOMAIN is your domain and USER is the SquaredUp application pool identity.

    See How to check and modify the application pool identity

    If each SquaredUp server is using a different SquaredUp application pool identity you will need to run the command for each application pool identity.

  7. If you are only restoring the HA share, then the SquaredUp configuration on the servers should still point to the HA share. You can check or change the address of the HA share in the following file on each server:

    C:\inetpub\wwwroot\SquaredUpv3\User\Configuration\highavailability.json

  8. In IIS on each SquaredUp server restart the SquaredUpv3 application pool.

How to configure high availability (HA)

How to check and modify the application pool identity

Installing SquaredUp for the first time

Squared Up Ltd. (c) 2020Report an issue with this article