About backup and restore scripts (FAST Search Server 2010 for SharePoint)
Applies To: FAST Search 2010
Applies to: FAST Search Server 2010
Use the Microsoft FAST Search Server 2010 for SharePoint backup and restore scripts to back up and restore a FAST Search Server 2010 for SharePoint farm. See Backup and restore (FAST Search Server 2010 for SharePoint) for more information.
The backup and restore scripts are stored in the <FASTSearchFolder>\bin folder.
Where <FASTSearchFolder> is the path of the folder where you have installed FAST Search Server 2010 for SharePoint, for example C:\FASTSearch.
| Use this script | To do this |
|---|---|
backup.ps1 |
Run a configuration backup or a full backup. |
restore.ps1 |
Restore a configuration backup or a full backup. |
Tip
To view a list of options that are available for the backup.ps1 and restore.ps1 scripts, use these commands: get-help backup.ps1 –detailed or get-help restore.ps1 –detailed.
In this article:
Backup script options (backup.ps1)
Restore script options (restore.ps1)
Backup script options (backup.ps1)
| Option | Values | Description |
|---|---|---|
-action |
config|full |
Specifies the backup type: config: configuration backup full: full backup |
-backuppath |
<UNC path of backup store> |
Specifies the path of the backup store. Always use UNC encoded paths. You can specify multiple backup stores by using a comma-separated list of UNC paths. |
-excludeindex |
Excludes the searchable index from the backup. This option cannot be used with the -sqluser and -sqlpasswordfile options. |
|
-force |
Overwrites the existing backup directory. |
|
-multithreaded |
Enables Robocopy to run with multiple threads. This is recommended for full backup of large FAST Search Server 2010 for SharePoint farms. Only supported on Windows Server 2008 R2. |
|
-passwordfile |
<name and path of the password file> |
Specifies a file that contains a saved password. This allows you to run the script without having to manually enter the password at runtime. See Run scripts with a saved password. |
-sqluser |
<SQL user account> |
Specifies the user name that is used for SQL authentication. This option cannot be used with the -excludeindex option. |
-sqlpasswordfile |
<name and path of the sql password file> |
Specifies the file that contains the password of the user that is used for SQL authentication. The file should contain the password as a secure string. This option cannot be used with the -excludeindex option. |
Restore script options (restore.ps1)
| Option | Values | Description |
|---|---|---|
-action |
config|full|configmigrate |
Specifies the restore type: config: configuration restore full: full restore configmigrate: migration of the configuration to a different deployment |
-backuppath |
<UNC path of backup store> |
Specifies the path of the backup store. Always use UNC encoded paths. You can specify multiple backup stores by using a comma-separated list of UNC paths. |
-multithreaded |
Enables Robocopy to run with multiple threads. This is recommended for full restore of large FAST Search Server 2010 for SharePoint farms. Only supported on Windows Server 2008 R2. |
|
-passwordfile |
<name and path of the password file> |
Specifies a file that contains a saved password. This allows you to run the script without having to manually enter the password at runtime. See Run scripts with a saved password. |
-sqluser |
<SQL user account> |
Specifies the user name that is used for SQL authentication. |
-sqlpasswordfile |
<name and path of the sql password file> |
Specifies the file that contains the password of the user that is used for SQL authentication. The files should contain the password as a secure string. |