Use commands to back up and restore

FactoryTalk Services Platform
 supports backing up and restoring directory, system, and application via the user interface. From
FactoryTalk Services Platform
 version 6.21, the
FTSysBackupRestore Tool
 provides an option to use commands to back up and restore the directory, system, and applications.
Parameter
Required/Optional
Description
-s
Required
Specifies the FactoryTalk Directory scope. Only "Global" and "Local" scopes are supported.
-sso
Required
Uses single sign-on for authentication.
-b
Required
Command for backup, which is a conflict with the -r command.
-r
Required
Command for restore, which is a conflict with the -b command.
-bak
Required
Specifies the location to save the backup file or the location where the restore file can be found. (For example, -bak c:\aa.bak)
  • For backup operation, the existing files will be replaced while creating new files.
  • For restore operation, make sure the file already exists in the system.
-ftd
Optional
The whole FactoryTalk directory. The -sys and -app commands will be ignored if the -ftd is used.
-sys
Optional
The FactoryTalk System directory.
-app
Optional
Specifies the FactoryTalk application. Specific application names are needed when using this parameter.
-ido
Optional
Used to restore the FactoryTalk Directory identifier. It's only valid with command -r.
-prod
Optional
Specifies the product names. (For example: -prod "FactoryTalk Linx", -prod "FactoryTalk Linx Gateway")
-e
Optional
Used to encrypt the backup file.
-ep
Optional
Used to encrypt the passphrase.
-pp
Optional
The plain passphrase is used to encrypt or decrypt the backup file. The command will be ignored when "-ep" command is used or the "-e" command is not used.
Note
: If the passphrase contains a
"
, it should be type as
""
 in command line. For example, if the passphrase is
~!@#$%^&*()_+-={}[]|\:";'<>,.?/
, when you use the passphrase to encrypt or decrypt the backup file in commands, you should type the passphrase as
"~!@#$%^&*()_+-={}[]|\:"";'<>,.?/"
.
-f
Optional
Used to force replace the opened applications if needed.
-ow
Optional
Used to overwrite the existing applications.
Examples of using the command line:
  • Back up the FactoryTalk Directory
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -b -s Global -sso -bak C:\Users\Administrator\Desktop\ftd1.bak -ftd -e -pp "~!@#$%^&*()_+-={}[]|\:"";'<>,.?/"
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -b -s Global -sso -bak C:\Users\Administrator\Desktop\ftd2.bak -ftd -ido -prod "FactoryTalk Linx" -e -pp AQANCMnd8BF/Cl+s
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -b -s Global -sso -bak C:\Users\Administrator\Desktop\identifier.bak -ido
  • Back up an application
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -b -s Global -sso -bak C:\Users\Administrator\Desktop\application1.bak -app A1 -sys
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -b -s Global -sso -bak C:\Users\Administrator\Desktop\application2.bak -app A1 -sys -prod "FactoryTalk Linx"
  • Back up the
    FactoryTalk Linx Gateway
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -b -s Global -sso -bak C:\backup\FTLGW_File.bak -prod "FactoryTalk Linx Gateway"
  • Back up the System folder
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -b -s Global -sso -bak C:\Users\Administrator\Desktop\System.bak -sys
  • Restore the FactoryTalk Directory
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -r -s Global -sso -bak C:\Users\Administrator\Desktop\ftd1.bak -ftd -e -pp "~!@#$%^&*()_+-={}[]|\:"";'<>,.?/"
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -r -s Global -sso -bak C:\Users\Administrator\Desktop\ftd2.bak -ftd -ido -prod "FactoryTalk Linx" -e -pp AQANCMnd8BF/Cl+s
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -r -s Global -sso -bak C:\Users\Administrator\Desktop\identifier.bak -ido
  • Restore an application
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -r -s Global -sso -bak C:\Users\Administrator\Desktop\application1.bak -app A1 -sys
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -r -s Global -sso -bak C:\Users\Administrator\Desktop\application2.bak -app A1 -sys -prod "FactoryTalk Linx"
  • Restore the
    FactoryTalk Linx Gateway
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe -r -s Global -sso -bak C:\backup\FTLGW_File.bak -prod "FactoryTalk Linx Gateway"
  • Restore the System folder
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -r -s Global -sso -bak C:\Users\Administrator\Desktop\system.bak -sys
    TIP:
    For an encrypted bak file created in
    FactoryTalk Services Platform
     version 3.00 and before, if no passphrase was entered, the restore commands should be like:
    "C:\Program Files (x86)\Common Files\Rockwell\FTSysBackupRestoreTool.exe" -r -s Global -sso -bak C:\Users\Administrator\Desktop\Network.bak -ftd -e
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal