backupConfig command

The backupConfig command is a simple utility to back up the configuration of your 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. For more information about where to run this command, see Using command line tools. If you do not have root authority, you must specify a path for the backup file in a location where you 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.

[IBM i] The backupConfig command does not save authorities that were granted to the configuration directory structure of the profile. The restoreConfig command sets the owner of the directory structure and its contents to QEJBSVR and restores private authorities to the QTMHHTTP and QNOTES user profiles (if they exist). It does not restore any other private authorities that were granted.

Avoid trouble: This command uses the user ID and password information in the profile_root/properties/ipc.client.props file. To avoid user ID and password prompts when you use this command, add the user ID and password information to the ipc.client.props file.

Location

Issue the command from the profile_root/bin directory.

Syntax

The command syntax is as follows:

backupConfig.sh backup_file [options]

backupConfig.bat backup_file [options]

backupConfig.sh backup_file [options]

backupConfig backup_file [options]

where backup_file specifies the file to which the backup is written. If you do not specify one, a unique name is generated.

[IBM i] The QEJBSVR user profile must have *WX authority to the directory path specified in backup_file. If no path is specified, the QEJBSVR user profile must have *WX authority to the current working directory.

Parameters

The following options are available for the backupConfig command:

-nostop: Tells the backupConfig command not to stop the servers before backing up the configuration
-quiet: Suppresses the progress information that the backupConfig command prints in normal mode
-logfile file_name: Specifies the 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 application server 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.
-replacelog: Replaces the log file instead of appending to the current log
-trace: Generates trace information into the log file for debugging purposes
-username user_name: Specifies the user name for authentication if security is enabled in the server; acts the same as the -user option
-user user_name: Specifies the user name for authentication if security is enabled in the server; acts the same as the -username option
-password password: Specifies the password for authentication if security is enabled in the server
-help: Prints a usage statement
-?: Prints a usage statement

Usage

The following example creates a new file that includes the current date:

backupConfig.sh WebSphereConfig_2005-04-22.zip

backupConfig.bat WebSphereConfig_2005-04-22.zip

backupConfig.sh WebSphereConfig_2005-04-22.zip

backupConfig WebSphereConfig_2005-04-22.zip

The following example creates a file called myprofileBackup.zip under the /home/mydir directory for the myprofile profile.

backupConfig /home/mydir/myprofileBackup.zip -profileName myprofile

The following example creates a file called myBackup.zip and does not stop any servers before beginning the backup process:

backupConfig.sh myBackup.zip -nostop

backupConfig.bat myBackup.zip -nostop

backupConfig.sh myBackup.zip -nostop

backupConfig myBackup.zip -nostop