backupConfig command

The backupConfig command is a simple utility to back up the configuration of the node to a file.

By default, all servers on the node stop before the backup is made so that partially synchronized information is not saved.

See about where to run this command, see the Use command line tools article. If we do not have root authority, specify a path for the backup file in a location where we have write permission. The backup file will be in zip format and a .zip extension is recommended.

In a UNIX or Linux environment, the backupConfig command does not save file permissions or ownership information. The restoreConfig command uses the current umask and effective user ID (EUID) to set the permissions and ownership when restoring a file. If it is required that the restored files have the original permissions and ownership, use the tar command (available on all UNIX or Linux systems) to back up and restore the configuration.



Issue the command from the $WP_PROFILE/bin directory.



The command syntax is as follows:
[AIX] [HP-UX] [Linux] [Solaris] backup_file [options]


backupConfig.bat backup_file [options]
where backup_file specifies the file to which the backup is written. If we do not specify one, a unique name is generated.



The following options are available for the backupConfig command:


Tells the backupConfig command not to stop the servers before backing up the configuration


Suppresses the progress information that the backupConfig command prints in normal mode

-logfile file_name

Location of the log file to which trace information is written

By default, the log file is named backupConfig.log and is created in the logs directory.

-profileName profile_name

Defines the profile of the appserver process in a multi-profile installation

The -profileName option is not required for running in a single-profile environment. The default for this option is the default profile.


Replaces the log file instead of appending to the current log


Generates trace information into the log file for debugging purposes

-username user_name

User name for authentication if security is enabled in the server; acts the same as the -user option

-user user_name

User name for authentication if security is enabled in the server; acts the same as the -username option

-password password

Password for authentication if security is enabled in the server


Prints a usage statement


Prints a usage statement



The following example creates a new file that includes the current date:
[AIX] [HP-UX] [Linux] [Solaris]



The following example creates a file called and does not stop any servers before beginning the backup process:
[AIX] [HP-UX] [Linux] [Solaris] -nostop


backupConfig.bat -nostop


Related tasks

Use command line tools
Backing up and restoring admin configuration files


Related information