pack and unpack commands.The commands are located in the ORACLE_HOME/oracle_common/common/bin directory.
This chapter includes the following sections:
The pack command creates a template (a .jar archive file) that contains a snapshot of either an entire WebLogic domain or a subset of a WebLogic domain. You can use a template that contains a subset of a WebLogic domain to create a Managed Server domain directory hierarchy on a remote machine.
The following sections describe the files and directories that are included in the domain and Managed Server templates that you create by using the pack command.
All files and directories in the source WebLogic domain are included, with the following exceptions:
Temporary files that are created when you start a server
The servers directory
Files in the security directory that are created automatically when you create the WebLogic domain, such as DefaultAuthenticatorInit.ldift and XACMLRoleMapperInit.ldift
Persistent file stores, even if they are located with the domain. File stores are excluded whether they are defined for JMS or other file systems. If the file store is located within the domain, an empty file store directory will be created on the target system.
In addition to files within the domain directory, deployment plans located in external directories will be included in the template that is created by pack. These will be copied by unpack to the following standard location in the domain:
domain_home/config/deployments/deployment_name/plan
Note:
Plans already within the domain will not be relocated.
External directories include locations outside of the Oracle home directory, the domain home, and any location defined in the ORACLE_HOME/oracle_common/common/lib/internalpaths.txt file.
If you configured additional security data, such as for users, groups, or roles, through the Oracle WebLogic Server Administration Console or other online tools, the security data is stored in the LDAP server and is not included in the template. You must first export the data and then import it into the target WebLogic domain.
Because it is an offline command, the pack command does not export security provider data, such as embedded LDAP data, into a domain template. After using unpack to create the new domain, you must manually port the security provider data to the new domain. To do so:
The following files and directories are included by default:
All files in the root directory with the following extensions: .cmd, .sh, .xml, .properties, and .ini.
Any files with the .pem extension defined in the SSL configuration for your WebLogic domain
All files and subdirectories in the config directory, with the exception of config.xml
bin directory
lib directory
The following files and directories are not included in a Managed Server template by default:
Applications and certain application initialization files
config.xml
Temporary files that are created when you start a server
The servers directory
Files in the security directory that are created automatically when you create the WebLogic domain, such as DefaultAuthenticatorInit.ldift and XACMLRoleMapperInit.ldift.
You can pack any domain, whether or not it specifies specific names or ports for the servers in the domain. You can then unpack the domain on any machine, but servers that are defined in the config.xml file to use specific machines and ports will not work on other machines. You must therefore unpack the same template on each remote node for all servers to start successfully on their appropriate nodes and machines.
Node Manager configuration is not preserved by pack and unpack for both managed and non-managed modes. The Node Manager type is always set to PerDomainNodeManager by default in the unpacked domain.
If the Node Manager type in the original domain was CustomLocationNodeManager, when unpacking the domain, you must include the -nodeManagerType and -nodeManagerHome parameters in the unpack command to preserve the configuration.
If the Node Manager type in the original domain was ManualNodeManagerSetup, you must manually reconfigure Node Manager after unpacking the domain on each remote machine.
If a ManualNodeManagerSetup configuration was used for the original domain, the Node Manager configuration information is discarded from the template that is created by pack. When unpacking the domain, specify ManualNodeManagerSetup using the -nodeManagerType parameter. After unpacking the domain, you must manually configure Node Manager.
For information about Node Manager types, see Default Node Manager Configuration in Administering Node Manager for Oracle WebLogic Server.
Node Manager credentials, which are stored in config.xml, are copied from the packed domain to the unpacked domain.
pack -domain=domain -template=template -template_name="template_name" [-template_author="author"] [-template_desc="description"] [-managed=true|false] [-log=log_file] [-log=log_file] [-log_priority=log_priority]
Table 2-1 lists the parameters of the pack command.
Table 2-1 Parameters of the Pack Command
| Parameter | Required or Optional | Description |
|---|---|---|
|
|
Required |
The full or relative path for the WebLogic domain from which the template is to be created. |
|
|
Required |
The full or relative path and file name of the template to be created. The template filename must include the Note: The |
|
|
Required |
Descriptive name for the template. Quotes are required only if the value contains spaces. |
|
|
Optional |
The name of the author of the template. Quotes are required only if the value contains spaces. |
|
|
Optional |
Description of the template. Quotes are required only if the value contains spaces. |
|
|
Optional |
Specifies whether the template is to be used to create Managed Servers on remote machines. The default is Note: As of WebLogic Server 12.1.2, you can use the WLST |
|
|
Optional |
Name of the log file. |
|
|
Optional |
The priority setting for the log file. Use a log4j priority string. Valid log4j priority strings are |
To create a template JAR file based on an existing WebLogic domain named mydomain that is located in the C:/oracle/user_projects/domains directory, run the following command:
pack -domain=C:/oracle/user_projects/domains/mydomain -template=C:/oracle/user_templates/mydomain.jar -template_name="My WebLogic Domain"
A template file named mydomain.jar is created in the C:/oracle/user_templates directory. The name of the template is My WebLogic Domain.
The unpack command creates a full WebLogic domain or a subset of a domain that is used for a Managed Server domain directory on a remote machine.
You should use unpack only with a template that is compatible with your current installation. The current installation binaries must exist on the machine on which you are running the unpack command. The template can be any of the following:
A domain template that is packaged with your current installation
A domain template created by using the Domain Template Builder or WLST
A domain template created by using the pack command
A Managed Server template created by using the pack command
When you use the unpack command with a domain template, it creates a WebLogic domain containing all of the application and resource files defined in the template. It also creates necessary start scripts, and certain security and configuration files.
Note:
The source domain must have both an administrator user and administrator password defined for the domain. Otherwise, an error is displayed when running the unpack command. The administrator password comes from the wallet that is specified by the walletDir option when the unpack command is run on a template that is created by the pack command in which the managed parameter is set to false.
When you use the unpack command with a Managed Server template, it creates a Managed Server domain directory that includes the following:
A customized start script for each Managed Server in the WebLogic domain
config_bootstrap.xml file (based on the config.xml in the template)
nm_password.properties file
SerializedSystemIni.dat file
An entry for the Managed Server domain directory is also created in the NM_HOME /nodemanager.domains file, where NM_HOME is the node manager home directory for the product installation on the remote machine. The location of this directory depends on the Node Manager type. For more information on Node Manager type and Node Manager home, see Table 2-2.
Note:
By default, application files are not included in a Managed Server template created by using the pack command. If an application in the WebLogic domain from which you created a Managed Server template was deployed by using the external_stage mode, the Managed Server domain directory that you create with the unpack command does not contain any of the externally staged applications. Before you start the Managed Server, you must ensure that it has access to the externally staged application files.
For more information, see the Controlling Deployment File Copying with Staging Modes section in the Deploying Applications to Oracle WebLogic Server guide.
unpack [-initialize] -template=template -domain=domain [-walletDir=directory] [-user_name=username] [-password=password] [-app_dir=application_directory] [-nodemanager_type=type] [-nodemanager_home=nodemanager_home_directory] [-java_home=java_home_directory] [-server_start_mode=dev|prod] [-overwrite_domain] [-log=log_file] [-log_priority=log_priority]
Table 2-2 lists the parameters that you can use with the unpack command.
Table 2-2 Parameters of the Unpack Command
| Parameter | Required or Optional | Description |
|---|---|---|
|
|
Optional |
This parameter applies only to WebLogic domains in which Fusion Middleware products are installed. Note: When setting this parameter to When this parameter is When this parameter is When this parameter is For information about Service Tables, see Understanding Service Tables in Administering Oracle Fusion Middleware. |
|
|
Required |
The full or relative path and filename of the template from which the WebLogic domain is to be created. |
|
|
Required |
The full or relative path of the WebLogic domain to be created. |
|
|
Optional |
The directory in which the wallet file that contains the password for
If you want to create a different administrator user for the domain you are unpacking:
Note: The walletDir option must be used even when the |
|
|
Optional |
The username for the default administrator as currently defined in the template or via the WalletDir. This username is used to boot the Administration Server and connect to it. If you specify a new password for the default administrator, the password is reset to the value specified. If no administrative users are defined in the template, you can create a new default administrator by using If a default administrator and password are currently defined in the template, you can add a new administrative user by The value must not include commas, tabs, or any characters in the following list: < > # | & ? ( ) { }. Usernames are case sensitive. A valid password consists of a string of at least eight case-sensitive characters. The Note: This parameter is not applicable if you are creating a WebLogic domain using a Managed Server template. |
|
|
Optional |
This parameter has been deprecated. For better security, use the
A valid password consists of a string of at least eight case-sensitive characters. The Note: This parameter is not applicable if you are creating a WebLogic domain using a Managed Server template. |
|
|
Optional |
The full path to the directory used to store the applications defined in the template. This parameter is applicable only if the template supports a separate applications directory. |
|
|
Optional |
Sets the Node Manager type for the domain you are creating. Specify one of the following types:
The default value is |
|
|
Conditional |
If the specified Node Manager type is If the specified Node Manager type is not |
|
|
Optional |
The full path to the Java home directory. When set, this parameter identifies the default JVM used by the Administration Server for the WebLogic domain. This parameter is not applicable if you are creating a WebLogic domain based on a Managed Server template. |
|
|
Optional |
The start mode for the Administration Server: Note: If you want the unpacked domain to run in production mode, you must include this parameter in the This parameter is not applicable if you are creating a WebLogic domain by using a Managed Server template. If |
|
|
Optional |
If the specified domain directory already exists and is not empty, no warnings to that effect are displayed, and the files in the directory are automatically overwritten. No attempt is made to merge or preserve local customizations. Note: If a system error occurs after domain generation starts, the domain directory will be in an unknown state. |
|
|
Optional |
Name of the log file. |
|
|
Optional |
The priority setting for the log file. Use a log4j priority string. Valid log4j priority strings are |
To create a WebLogic domain named mynewdomain in the C:/oracle/user_projects/domains directory, by using the mydomain.jar template in the C:/oracle/user_templates directory, run the following command:
unpack -template=C:/oracle/user_templates/mydomain.jar -domain=C:/oracle/user_projects/domains/mynewdomain