The manageprofiles command line tool creates all application server runtime environments. The command creates a profile, which is the set of files that define the runtime environment for a deployment manager, a custom profile, or a stand-alone application server.
The manageprofiles command creates the runtime environment for a WebSphere Application Server process in a set of files called a profile. The profile defines the runtime environment and includes all of the files that the server processes in the runtime environment can change.
The manageprofiles command and its graphical
user interface, the Profile Management tool, are the only ways
to create runtime environments.
The command file is located in the app_server_root/bin directory. The command file is a script named manageprofiles.
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.
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:
However, if you applied
a feature pack that allows profile augmentation, then you can augment
a profile based on the particular feature pack rules.
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.
manageprofiles(.bat)(.sh) -augment -profileName profile_name -templatePath fully_qualified_template_path
Specifying a relative file path for the -templatePath parameter
results in the specified profile not being fully augmented.
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 whenever the product is running on the same physical machine or cluster of machines, such as a sysplex. Additionally, a cell name must be unique when 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 you want to federate their name spaces. Otherwise, you might encounter errors such as a javax.naming.NameNotFoundException exception. In which case, you need to create uniquely named cells.
if (DMgr) shortHostNameCellCellNumber else shortHostNameNodeNodeNumberCell
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.
Deleting a profile does
not delete the profile directory. For example, suppose that you create
a profile in the /usr/WebSphere/AppServer/profiles/managedProfile directory.
The directory remains after you delete the profile.
You
can delete or leave the directory. However, the profile_root/logs directory
contains information about uninstalling the profile. For example,
you might retain the _nodeuninst.log file to
determine the cause of any problem during the uninstall procedure.
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.
Deleting a
profile does not delete the profile directory. For example, suppose
that you create a profile in the /usr/WebSphere/AppServer/profiles/managedProfile directory.
The directory remains after you delete the profile.
You
can delete or leave the directory. However, the profile_root/logs directory
contains information about uninstalling the profile. For example,
you might retain the _nodeuninst.log file to
determine the cause of any problem during the uninstall procedure.
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.
When the manageprofiles command is run with the -enableService option set to true , the Linux service is created with the profile when the command is run by the root user. When a non-root user runs the manageprofiles command, the profile is created, but the Linux service is not. The Linux service is not created because the non-root user does not have sufficient permission to set up the service. An INSTCONPARTIALSUCCESS result is displayed at the end of the profile creation and the profile creation log app_server_root/logs/manageprofiles_create_profilename.log contains a message indicating the current user does not have sufficient permission to set up the Linux service.
if (DMgr) shortHostNameCellManagerNodeNumber else shortHostNameNodeNodeNumberwhere NodeNumber is a sequential number starting at 01.
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
If the fully qualified path contains spaces, enclose
the value in quotation marks.
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.
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.
You must
have permissions to write to the directory.
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
signingCertDN=cn=testserver.ibm.com\\,ou=Root Certificate\\, ou=testCell\\,ou=testNode01\\,o=IBM\\,c=US
omitAction=samplesInstallAndConfig,defaultAppDeployAndConfig
create templatePath=C:\\WebSphere\\AppServer\\profileTemplates\\default
manageprofiles(.bat)(.sh) -restoreProfile -backupFile file_name
manageprofiles(.bat)(.sh) -setDefaultName -profileName profile_name
Port values are assigned
sequentially from the -startingPort value, omitting
those ports that are already in use. The system recognizes and resolves
ports that are currently in use and determines the port assignments
to avoid port conflicts.
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.
Use absolute paths.
This parameter must exist as a directory and point to a valid template
directory.
manageprofiles -create -profileName MyProfile -startingPort 10380The following example creates a profile for a stand-alone application server for the Feature Pack for Web Services.
manageprofiles -create -profileName myWebSvcProfile -templatePath WEBSERVICES/default.wsfep
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 you must ensure that you are not violating profile template dependencies.
When
using the -templatePath parameter, specify the fully qualified file
path for the parameter.
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 “C:\Program Files\IBM\HTTPServer” webServerType=IIS: webServerInstallPath defaulted to “C:\” webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “C:\” webServerType=DOMINO: webServerInstallPath defaulted to “” webServerType=APACHE: webServerInstallPath defaulted to “” webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”
webServerType=IHS: webServerInstallPath defaulted to “/opt/IBM/HTTPServer” webServerType=IIS: webServerInstallPath defaulted to “n\a” webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “/opt/sun/webserver” webServerType=DOMINO: webServerInstallPath defaulted to “” webServerType=APACHE: webServerInstallPath defaulted to “” webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”
webServerType=IHS: webServerInstallPath defaulted to “/usr/IBM/HTTPServer” webServerType=IIS: webServerInstallPath defaulted to “n\a” webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “/opt/sun/webserver” webServerType=DOMINO: webServerInstallPath defaulted to “?” webServerType=APACHE: webServerInstallPath defaulted to “?” webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”
webServerType=IHS: webServerInstallPath defaulted to “/opt/IBM/HTTPServer” webServerType=IIS: webServerInstallPath defaulted to “n\a” webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “/opt/sun/webserver” webServerType=DOMINO: webServerInstallPath defaulted to “” webServerType=APACHE: webServerInstallPath defaulted to “” webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”
webServerType=IHS: webServerInstallPath defaulted to “/opt/IBM/HTTPServer” webServerType=IIS: webServerInstallPath defaulted to “n\a” webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “/opt/sun/webserver” webServerType=DOMINO: webServerInstallPath defaulted to “” webServerType=APACHE: webServerInstallPath defaulted to “” webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”
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”
See WASService command for more information about Windows services.
The default value for this parameter is automatic.
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
app_server_root/bin/manageprofiles.sh -create -profileName Dmgr001 -profilePath profile_root -templatePath app_server_root/profileTemplates/dmgr -nodeName Dmgr001Node -cellName Dmgr001NodeCell -hostName localhost -isDefault -startingPort 20000
app_server_root\bin\manageprofiles.bat -create -profileName Dmgr001 -profilePath profile_root -templatePath app_server_root\profileTemplates\dmgr -nodeName Dmgr001Node -cellName Dmgr001NodeCell -hostName localhost -isDefault -startingPort 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:
c:\WebSphere\AppServer\bin manageprofiles -create -profileName Custom01 -profilePath profile_root -templateParh app_server_root\profileTemplates\managed -nodeName CustomNode01 -cellName CustomNodeCell01 -hostName myhost.mycity.mycompany.com -isDefault -dmgrHost myhost.mycity.mycompany.com -dmgrPort 8879 -startingPort 22000
app_server_root/bin/manageprofiles.sh -create -profileName Custom01 -profilePath profile_root -templatePath app_server_root/profileTemplates/managed -nodeName Custom01Node -cellName Custom01Cell -hostName myhost.mycity.mycompany.com -isDefault -startingPort 22000
manageprofiles -create -profileName Custom01 -templatePath managed -startingPort 22000
Creating an application server profile
Create an application server profile named Default01 with the following command:
app_server_root\bin manageprofiles -create -profileName Default01 -profilePath profile_root -templatePath app_server_root\profileTemplates\default -nodeName Default01Node -cellName Default01Cell -hostName myhost.mycity.mycompany.com -isDefault -winserviceCheck true -winserviceAccountType specifieduser -winserviceUserName my_user_id -winservicePassword my_password -winserviceStartupType manual -startingPort 21000
app_server_root/bin/manageprofiles.sh -create -profileName Default01 -profilePath profile_root -templatePath app_server_root/profileTemplates/default -nodeName Default01Node -cellName Default01Cell -hostName myhost.mycity.mycompany.com -isDefault -startingPort 21000
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.
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.sh -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/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
app_server_root/bin/manageprofiles.sh -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
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 app_server_root/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 app_server_root/logs/manageprofiles directory. The files are named in this pattern: profile_name_delete.log.
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.