Back up a primary StorageZones Controller configuration

A StorageZones Controller is installed on your local site and you are responsible for backing it up. To fully protect your deployment, you should take a snapshot of the StorageZones Controller server, back up your configuration, and Prepare StorageZones Controller for file recovery.

It is critical that you back up your configuration as described in this topic. For example, if you do not have a back up and someone accidentally deletes a zone, you cannot recover the folders and files in that zone.

Important: Be sure to use PowerShell 4.0 for this procedure. For more information about PowerShell requirements, refer to PowerShell scripts and commands in StorageZones Controller system requirements.

The StorageZones Controller installer includes a PowerShell module with commands that back up and restore a primary StorageZones Controller configuration settings. Your backup will include configuration information for zones, StorageZones for ShareFile Data, StorageZone Connector for SharePoint, and StorageZone Connector for Network File Shares.

The backup and restore commands require that you run the 32-bit version of PowerShell under the same user context as StorageZones Controller. To set the user context, use the tool PSExec. That tool is available for download from

Note: These steps do not apply to a secondary StorageZones Controller. To recover a secondary StorageZones Controller, reinstall StorageZones Controller on the server and then join the server to the primary StorageZones Controller.

  1. The PowerShell script used in this procedure is unsigned, so you might need to change your PowerShell execution policy.

    1. Determine if your PowerShell execution policy allows you to run local, unsigned scripts: PS C:\>Get-ExecutionPolicy

    For example, a policy of RemoteSigned, Unrestricted, or Bypass allows you to run unsigned scripts.

    2. To change your PowerShell execution policy: PS C:\>Set-ExecutionPolicy RemoteSigned

  2. Set the user context for this PowerShell session. In a command window, run one of the following commands.

    • If using the default Network Service account:

      PsExec.exe -i -u “NT AUTHORITY\NetworkService” C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell

    • If using a named user for the StorageZones Controller application pool:

      PsExec.exe -i -u “domain\username” C:\Windows\SysWOW64\WindowsPowerShell\v1.0\powershell

    A PowerShell window opens.

  3. From the PowerShell prompt, import the module ConfigBR.dll: Import-Module “C:\inetpub\wwwroot\Citrix\StorageCenter\Tools\SfConfigBR\ConfigBR.dll”

    You must import the module each time you open a new PowerShell window.

  4. From the PowerShell prompt, run the Get-SfConfig command: Get-SfConfig -PrimaryZoneController “server” -Passphrase “passphrase” -FilePath “fullpath”

    For example:

    Get-SfConfig -PrimaryZoneController “” -Passphrase “mypassphrase” -FilePath “c:\szc-backup.bak”

    Command parameters:

Parameters Description Examples
“server” The primary StorageZones Controller server name or IP address. It can be in any of the following forms shown under Examples and must include the trailing slash. Connect to a local server: http://localhost/ConfigService/; Connect to a remote server: http[s]://; Connect to a remote server if DNS issues prevent connection to a server name: http[s]://
“passphrase” The passphrase specified for StorageZones Controller. “MyPassphrase”
“fullpath” A location to save the backup file. “c:\szc-backup.bak”

The Get-SfConfig command creates the backup file.

To restore a primary StorageZones Controller configuration, refer to Recover a primary StorageZones Controller configuration.

Back up a primary StorageZones Controller configuration