The manageprofiles command line tool creates all application server run-time environments. The command creates a profile, which is the set of files that define the run-time environment for a deployment manager, a custom profile, or a stand-alone application server.
The manageprofiles command creates the run-time environment for a WebSphere Application Server process in a set of files called a profile. The profile defines the run-time environment and includes all of the files that the server processes in the run-time environment can change.
The command file is located in the app_server_root/bin directory. The command file is a script named manageprofiles. For more information about where to run this command, see Using command line tools.
Note: If you use this command with the managed profile template, application servers are not created. However, ports are still used if you are federating a node.
For detailed help including the required parameters for each of the tasks accomplished with the manageprofiles command, use the -help parameter. The following example uses the help parameter with the manageprofiles -augment command on Windows operating systems:
app_server_root\bin\manageprofiles.bat -augment -helpThe output from the help command will specify which parameters are required and which are optional.
Depending on the operation that you want to perform with the manageprofiles command, you will need to provide one or more of the following parameters. The command line profile management tool validates that the required parameters are provided and the values entered for those parameters are valid. Be sure to type the name of the parameters with the correct upper and lower case as the command line profile management tool does not validate the case of the parameter name. Incorrect results can occur when the parameter case is not typed correctly.
The following example uses the manageprofiles -create command on operating systems such as AIX or Linux:
app_server_root/bin/manageprofiles.sh -create
-profileName profile_name
-profilePath profile_root -templatePath template_path
The following options are available for the manageprofiles command:
Note: The templates that are included with WebSphere Application Server can only be used to create profiles and not to augment existing profiles because only create templates are shipped with the product.
Also, do not manually modify the files that are located in the install_dir/ profileTemplates directory. For example, if you are changing the ports during profile creation, use the Profile Management tool or the -startingPort or -portsFile arguments on the manageprofiles command instead of modifying the file in the profile template directory. You can specify a relative path for the -templatePath parameter if the profile templates are relative to theapp_server_root/profileTemplates directory. Otherwise, specify the fully qualified template path. For example:
manageprofiles -augment -profileName profile_name -templatePath template_path
See also the -unaugment parameter.
manageprofiles(.bat)(.sh) -backupProfile -profileName profile_name -backupFile backupFile_name
When you back up a profile using the -backupProfile option, you must first stop the server and the running processes for the profile that you want to back up.
Use a unique name even though you plan to federate the custom profile or stand alone profile into a deployment manager cell. Federation requires unique cell names before it can make the node part of the deployment manager cell. A cell name must be unique in any circumstance in which the product is running on the same physical machine or cluster of machines, such as a sysplex. Additionally, a cell name must be unique in any circumstance in which network connectivity between entities is required either between the cells or from a client that must communicate with each of the cells. Cell names also must be unique if their name spaces are going to be federated. Otherwise, you might encounter symptoms such as a javax.naming.NameNotFoundException exception, in which case, you need to create uniquely named cells. where CellNumber is a sequential number starting at 01 and NodeNumber is the node number that you used to define the node name.The default node names are as follows:
The value for this parameter must not contain spaces or any characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, |, and so on.
Do not use this parameter when using the -startingPort or -portsFile parameter.
During profile creation, the manageprofiles command uses an automatically generated set of recommended ports if you do not specify the -startingPort parameter, the -defaultPorts parameter or the -portsFile parameter. The recommended port values can be different than the default port values based on the availability of the default ports.
Note: Do not use this parameter if you are using the managed profile template.
The profile directory is deleted when you delete the profile so that you can recreate the profile without having to manually delete the directory.
If you delete a profile that has augmenting templates registered to it in the profile registry, then unaugment actions are performed automatically.
The directory for the profile is deleted when you delete the profile so that when you recreate the profile, you do not have outdated information to manage.
If you delete a profile that has augmenting templates registered to it in the profile registry, then unaugment actions are performed automatically.
The host name can be the long or short DNS name or the IP address of the deployment manager machine.
Specifying this optional parameter directs the manageprofiles command to attempt to federate the custom node into the deployment manager cell as it creates the custom profile. This parameter is ignored when creating a deployment manager profile or an Application Server profile.
If you federate a custom node when the deployment manager is not running or is not available because of security being enabled or for other reasons, the installation indicator in the logs is INSTCONFFAIL to indicate a complete failure. The resulting custom profile is unusable. You must move the custom profile directory out of the profile repository (the profiles installation root directory) before creating another custom profile with the same profile name.
If you have enabled security or changed the default JMX connector type, you cannot federate with the manageprofiles command. Use the addNode command instead.
The default value for this parameter is localhost. The value for this parameter must be a properly formed host name and must not contain spaces or characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, |, and so on. A connection to the deployment manager must also be available in conjunction with the dmgrPort parameter.
If you have enabled security or changed the default JMX connector type, you cannot federate with the manageprofiles command. Use the addNode command instead.
The default value for this parameter is 8879. The port that you indicate must be a positive integer and a connection to the deployment manager must be available in conjunction with the dmgrHost parameter.
The value for this parameter must not contain spaces or any characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, |, and so on.
Do not use this parameter when using the -startingPort or -defaultPorts parameter.
During profile creation, the manageprofiles command uses an automatically generated set of recommended ports if you do not specify the -startingPort parameter, the -defaultPorts parameter or the -portsFile parameter. The recommended port values can be different than the default port values based on the availability of the default ports.
profileType ProfileNumberwhere profileType is a value such as AppSrv, Dmgr, or Custom and ProfileNumber is a sequential number that creates a unique profile name.
The value for this parameter must not contain spaces or characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, |, and so on. The profile name that you choose must not be in use.
-profilePath profile_root
The default value is based on the app_server_root directory, the profiles subdirectory, and the name of the file.
The default value is based on the user_data_root directory, the profiles subdirectory, and the name of the file. For example, the default is:
WS_WSPROFILE_DEFAULT_PROFILE_HOME/profileNamewhere WS_WSPROFILE_DEFAULT_PROFILE_HOME is defined in the wasprofile.properties file in the app_server_root/properties directory.
The value for this parameter must be a valid path for the target system and must not be currently in use.
The QEJBSVR profile must have permissions to write to the directory.
create profileName=testResponseFileCreate profilePath=profile_root templatePath=app_server_root/profileTemplates/default nodeName=myNodeName cellName=myCellName hostName=myHostName omitAction=myOptionalAction1, myOptionalAction2
To determine which input arguments are required for the various types of profile templates and action, use the manageprofiles command with the -help parameter.
manageprofiles(.bat)(.sh) -restoreProfile -backupFile file_nameTo restore a profile, perform the following steps:
manageprofiles(.bat)(.sh) -setDefaultName -profileName profile_name
Port values are assigned sequentially from the -startingPort value.
Do not use this parameter with the -defaultPorts or -portsFile parameters.
During profile creation, the manageprofiles command uses an automatically generated set of recommended ports if you do not specify the -startingPort parameter, the -defaultPorts parameter or the -portsFile parameter. The recommended port values can be different than the default port values based on the availability of the default ports.
Note: Do not use this parameter if you are using the managed profile template.
manageprofiles -create -profileName MyProfile -startingPort 10380
To unaugment a particular profile that has been augmented, additionally specify the -ignoreStack parameter with the -templatePath parameter. Normally, you would not unaugment a particular profile as ensure that you are not violating profile template dependencies.
When using the -templatePath parameter, you can specify a relative file path for the parameter.
See also the augment parameter.
webServerType=IHS: webServerInstallPath defaulted to “n\a” webServerType=IIS: webServerInstallPath defaulted to “n\a” webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “n\a” webServerType=DOMINO: webServerInstallPath defaulted to “n\a” webServerType=APACHE: webServerInstallPath defaulted to “n\a” webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n\a”
The following examples demonstrate correct syntax. Issue the command in any of the following examples on one line. Each example shows the command on more than one line to increase clarity.
Creating a deployment manager profile The following example uses the dmgr template to create a deployment manager profile named Dmgr001. The deployment manager ports start at port 20000.
manageprofiles -create -profileName Dmgr001 -profilePath profile_root -templatePath dmgr -startingPort 20000
Creating a custom profile
Federate a custom profile to customize the profile with the deployment manager.
Create a custom profile for federating into a deployment manager cell with the following command:
manageprofiles -create -profileName Custom01 -templatePath managed -startingPort 22000
Creating an application server profile
Create an application server profile named Default01 with the following command:
manageprofiles -create -profileName Default01 -templatePath default -startingPort 21000
Creating a cell profile
Creating a cell profile requires the creation of both the deployment manager and the application server portion of the cell profile. The two profiles are linked and some parameters must match between the creation parameters of the deployment manager and the application server portion of the cell profile. For more detailed information regarding creating a cell profile, see Example: Creating a cell profile with the manageprofiles command. The following example shows the creation of a cell profile named Dmgr001 having a cell name of Default01Cell and a node name of Default01Node. To create a full working cell, the -nodeProfilePath, -cellName, -appServerNodeName, -nodeName parameters are required to match between the cell_dmgr profile and the cell_node profile.
app_server_root/bin/manageprofiles -create -templatePath app_server_root/profileTemplates/cell/dmgr -nodeProfilePath app_server_root/profiles/AppSrv01 -profileName Dmgr001 -cellName Default01Cell -nodeName Default01Node -appServerNodeName Default01Node
app_server_root/bin/manageprofiles -create -templatePath app_server_root/profileTemplates/cell/default -dmgrProfilePath app_server_root/profiles/Dmgr001 -portsFile app_server_root/profiles/Dmgr001/properties/portdef.props -nodePortsFile app_server_root/profiles/Dmgr001/properties/nodeportdef.props -profileName AppSrv01 -cellName Default01Cell -nodeName Default01Node -appServerNodeName Default01Node
The logs are in the user_data_root/profileRegistry/logs/manageprofiles directory. The files are named in this pattern: profile_name_create.log.
The command also creates a log for every profile that it deletes. The logs are in the user_data_root/profileRegistry/logs/manageprofiles directory. The files are named in this pattern: profile_name_delete.log.