Command line syntax

The following table shows the syntax when using the backup or restore command.
TIP:
For the backup command, quotation marks (" ") are not supported in the command lines. Make sure that single sign-on is enabled when using the backup command.
Option
Description
/N
(Required) For backup command only.
Specifies the name of the application to back up.
/P
(Required) For backup command only.
Specifies the full path of the backup archive file.
The file name must be with an .apb extension and can contain underscores ( _ ) or spaces.
/E
(Optional) For both backup and restore commands.
Specifies a password for the archive file.
For the backup command, the password length is from 6 through 8. For the restore command, the password length is not limited, the same as the UI configuration. If the password includes any special characters, enclose the entire password in quotation marks (" "). The slash symbol (/) is not supported, because it is a reserved character in the command.
/T
(Optional) For backup command only.
Specifies the application type to back up. The default value is
D
.
  • L
    : Local Station application
  • S
    : Network Station application
  • D
    : Network Distributed application
/L
(Optional) For backup command only.
Specifies to back up all data logging file sets under the HMI project, followed by the value
ALL
.
/R
(Required) For restore command only.
Specifies that the command is for restoring an archive file.
/F
(Required) For restore command only.
Specifies the full path of the restore configuration JSON file.
TIP: If the path includes a space, enclose the path in quotation marks (" ").
/U
(Optional) For restore command only.
Specifies the username to log in to the current FactoryTalk Directory. By default, if you omit this parameter, the current single sign-on user will perform this operation. If you want to specify a user to perform this operation, enter this parameter.
/PW
(Optional) For restore command only.
Specifies the password of the FactoryTalk user who will log in to the current FactoryTalk Directory.
/AU
(Optional) For restore command only.
Specifies the username to log in to the new FactoryTalk Directory in the archive file.
/APW
(Optional) For restore command only.
Specifies the password of the FactoryTalk user who will log in to the new FactoryTalk Directory in the archive file.
/?
Optional.
Displays help information for the commands.
When you use /?, omit all the other parameters.
Example
The following backup command:
DistributedApplicationManager.exe /N InstantFizz /P D:\backup\myInstantFizz.apb /E Pwd12345 /L ALL
means that you will:
  • Back up the network distributed application
    InstantFizz
    .
  • Save the archive file in
    D:\backup
     with the name
    myInstantFizz.apb
    .
  • Set a password
    Pwd12345
     for the archive file.
  • Back up all data logging file sets with the application.
The following restore command:
DistributedApplicationManager.exe /R /F D:\ConfigFile\restore_config.json /E pwd12345 /U admin /PW adminpwd123 /AU archiveuser /APW archiveuserpwd123
means that you will:
  • Start a restoring operation.
  • The restore type, archive file, application name, and so on are configured in the JSON file, which is in
    D:\ConfigFile\restore_config.json
    .
  • Specify the password
    pwd12345
     for the archive file.
  • Log in to the current FactoryTalk Directory with username
    admin
     and password
    adminpwd123
    .
  • Log in to the new FactoryTalk Directory in the archive file with username
    archiveuser
     and password
    archiveuserpwd123
    .
Provide Feedback
Have questions or feedback about this documentation? Please submit your feedback here.
Normal