Skip to main content

BriefCam Installation Guide

Move Storage Tool

Last Updated: 2 minute read
Version2025r1
LanguageEnglish

The Move Storage tool updates the BriefCam shared directory to another location and a different name (when required).

The tool can be found at: {BriefCam Server installation folder}\tools\move_storage_tool.

The config file is available by contacting BriefCam’s support.

Note

The tool assumes that all data is saved in one location.

Prerequisites

Before execution it is highly recommended to:

  • Back up the Postgres database.

  • Remove previous shared folder mapping (if you want to use the same shared folder name).

Parameters

The following are the parameters that can be used:

Parameter 

Description 

Required or Optional 

-share-path {SHARE_PATH} 

Path to new share.

SHARE_PATH can be a regular path, such as: "c:\path\to\my\new\share" or a network path, such as: "\\host-name\share-name".

If it is a regular path, a new shared directory will be created. If it is a network path, it is assumed that this path is already shared under the required permissions and therefore will not be recreated.

required

-share-name {SHARE_NAME} 

New shared folder name

not required if network path is given

-share-host {SHARE_HOST} 

New shared folder host

not required in local execution

-db-port {DB_PORT} 

Database port

required

-db-user {DB_USER} 

Database username

required

-db-pwd {DB_PWD} 

Database user password

required

-local 

required for local operation

-config {CONFIG} 

Path to a JSON config file for remote execution. Contains the machines that belong to a certain BriefCam installation.

required for remote operation

Running the Tool

To run the tool from an all-in-one machine:

  1. Extract the move-storage.zip file.

  2. Open PowerShell as administrator.

  3. Run the tool from within the directory where you extracted the tool.

  4. The tool does not move the data. Therefore, after running the tool, you need to move the data to the new location.

To run the tool from a remote machine:

  1. Extract the move-storage.zip file.

  2. Update the config.json file with your hosts and credentials.

  3. Enable and allow WINRM and ICMP in the firewall administrator-level credentials of the remote machines.

  4. On every machine, enable the running of PowerShell remote-signed scripts. For additional information, see High Security Environment with Customized Policy Settings.

  5. Open PowerShell as administrator.

  6. Run the tool from within the directory where you extracted the tool.

  7. The tool does not move the data. Therefore, after running the tool, you need to move the data to the new location. First move the Backups folder (located at: \\server\BriefCam\ServerData\Backups) and the RESEARCH certificates (located at: \\server\BriefCam\certificates). Then move the rest of the data.

  8. Enable BriefCam’s Maintenance service.

Note

The move-storage.log file is available for troubleshooting this tool (located in the directory of the tool).

Examples

Here are a number of examples:

For local execution with a standard path: 

PS> ./move-storage.exe -local -share-path 'C:\my\new\share' -share-name 'shary' -db-port 5432 -db-user 'bb' -db-pwd 'king' 

For local execution with a network path: 

PS> ./move-storage.exe -local -share-path '\\MyMachine\MyShare' -db-port 5432 -db-user 'bb' -db-pwd 'king' 

Note that with the network path, the share name is not needed and will be ignored even if given explicitly.