Use the manageprofiles command to create, delete, augment, back up, and restore profiles, which define runtime environments. Using profiles instead of multiple product installations saves disk space and simplifies updating the product because a single set of core product files is maintained.
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 -help
Depending on the operation that you want to perform with themanageprofiles command, you need to provide one or more of the following parameters. The command-line 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 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:
This parameter is only valid for the default profile template.
If you specify both the -isDeveloperServer and -applyPerfTuningSetting parameters, depending on the option selected for -applyPerfTuningSetting, -applyPerfTuningSetting might override -isDeveloperServer.
Also, do not manually modify the files that are located in the install_dir/ profileTemplates directory. If you are changing the ports during profile creation, for example, use the -startingPort or -portsFile arguments on the manageprofiles command instead of modifying the file in the profile template directory.
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 standalone 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 must also be unique if their namespaces are federated. Otherwise, you might encounter symptoms such as a javax.naming.NameNotFoundException error, in which case, create uniquely named cells.
This is an optional parameter. If you omit the parameter, a default cell name is assigned.
The value for this parameter must not contain spaces or any invalid 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.
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 with the managed -templatePath parameter. The -dmgrHost 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 Java Management Extensions (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.
You cannot use the -enableAdminSecurity parameter to enable administrative security for a custom profile. For security to be enabled for a custom profile, the custom profile must be federated into a deployment manager. Administrative security enabled for the deployment manager is required to enable security for the federated custom profile.
When you specify any of the parameters that begin with -importPersonal, you must specify them all.
When you specify any of the parameters that begin with -importPersonal, you must specify them all.
When you specify any of the parameters that begin with -importPersonal, you must specify them all.
When you specify any of the parameters that begin with -importPersonal, you must specify them all.
When you specify any of the parameters that begin with -importSigning, you must specify them all.
When you specify any of the parameters that begin with -importSigning, you must specify them all.
When you specify any of the parameters that begin with -importSigning, you must specify them all.
When you specify any of the parameters that begin with -importSigning, you must specify them all.
This parameter is valid only for the default profile template.
If you specify both the -isDeveloperServer and -applyPerfTuningSetting parameters, depending on the option selected for -applyPerfTuningSetting, -applyPerfTuningSetting might override -isDeveloperServer.
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.
<profile_type><profile_number>
where The value for this parameter must not contain spaces or characters that are not valid such as any of 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 user_data_root directory,
the profiles subdirectory, and the name of the profile.
WS_WSPROFILE_DEFAULT_PROFILE_HOME/profileName
The WS_WSPROFILE_DEFAULT_PROFILE_HOME element
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.
The command line interface can be driven by a response file that contains the input arguments for a given command in the properties file in key and value format. To determine which input arguments are required for the various types of profile templates and action, use the manageprofiles command with the -help parameter.
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=deployAdminConsole,defaultAppDeployAndConfig
manageprofiles(.bat)(.sh) -restoreProfile -backupFile file_name
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.
manageprofiles -create -profileName MyProfile -startingPort 10380
The available templates are described in the Profile concepts topic.
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 because you must 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.
When using the -templatePath parameter, you can
specify a relative file path for the parameter.
Optionally, specify the -unaugmentDependents parameter with the -unaugmentAll parameter to unaugment all profiles that are prerequisites of the profiles that are being unaugmented.
See also the augment parameter.
Specify the -unaugmentDependents parameter with the -unaugmentAll 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.
You can create a deployment manager profile after installing your core product files. The deployment manager provides a single administrative interface to a logical group of application servers on one or more machines. Use the manageprofiles.sh -create command to create a deployment manager profile.
To create a deployment manager profile named shasti:
manageprofiles -create
-profileName shasti
-profilePath /shasti/WebSphere
-templatePath /opt/IBM/WebSphere/AppServer/profileTemplates/management
-serverType DEPLOYMENT_MANAGER
-cellName cell1
-hostName planetaix
-nodeName dmgr1
If you do not specify one of the port options during profile creation, a recommended set of port values will be used. The port conflict resolution algorithm determines these ports. The recommended set of ports must be free of conflict. If you want to use the IBM default ports, use the -defaultPorts option when you create a profile.
The manageprofiles command can assign port numbers based on a starting port value. You can provide the starting port value from the command line, using the -startingPort parameter. The command assigns port numbers sequentially from the starting port number value. However, if a port value in the sequence conflicts with an existing port assignment, the next available port value is used
The order of port assignments is arbitrary. Predicting assignments is not possible.
For example, ports created with -startingPort 20002 would appear similar to the following example:
WC_defaulthost=20002
WC_adminhost=20003
WC_defaulthost_secure=20004
WC_adminhost_secure=20005
BOOTSTRAP_ADDRESS=20006
SOAP_CONNECTOR_ADDRESS=20007
IPC_CONNECTOR_ADDRESS=20008
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20009
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20010
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20011
ORB_LISTENER_ADDRESS=20012
DCS_UNICAST_ADDRESS=20013
SIB_ENDPOINT_ADDRESS=20014
SIB_ENDPOINT_SECURE_ADDRESS=20015
SIB_MQ_ENDPOINT_ADDRESS=20016
SIB_MQ_ENDPOINT_SECURE_ADDRESS=20017
SIP_DEFAULTHOST=20018
SIP_DEFAULTHOST_SECURE=20019
OVERLAY_UDP_LISTENER_ADDRESS=20020
OVERLAY_TCP_LISTENER_ADDRESS=20021
BOOTSTRAP_ADDRESS=20002
SOAP_CONNECTOR_ADDRESS=20003
IPC_CONNECTOR_ADDRESS=20004
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20005
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20006
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20007
ORB_LISTENER_ADDRESS=20008
NODE_MULTICAST_DISCOVERY_ADDRESS=20009
NODE_IPV6_MULTICAST_DISCOVERY_ADDRESS=20010
NODE_DISCOVERY_ADDRESS=20011
DCS_UNICAST_ADDRESS=20012
NODE_XDAGENT_PORT=20013
NODE_OVERLAY_UDP_LISTENER_ADDRESS=20014
NODE_OVERLAY_TCP_LISTENER_ADDRESS=20015
WC_defaulthost=20002
WC_defaulthost_secure=20003
BOOTSTRAP_ADDRESS=20004
SOAP_CONNECTOR_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20007
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20008
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20009
ORB_LISTENER_ADDRESS=20010
DCS_UNICAST_ADDRESS=20011
SIB_ENDPOINT_ADDRESS=20012
SIB_ENDPOINT_SECURE_ADDRESS=20013
SIB_MQ_ENDPOINT_ADDRESS=20014
SIB_MQ_ENDPOINT_SECURE_ADDRESS=20015
SIP_DEFAULTHOST=20016
SIP_DEFAULTHOST_SECURE=20017
NODE_MULTICAST_DISCOVERY_ADDRESS=20018
NODE_IPV6_MULTICAST_DISCOVERY_ADDRESS=20019
NODE_DISCOVERY_ADDRESS=20020
NODE_DCS_UNICAST_ADDRESS=20021
NODE_BOOTSTRAP_ADDRESS=20022
NODE_SOAP_CONNECTOR_ADDRESS=20023
NODE_ORB_LISTENER_ADDRESS=20024
NODE_SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20025
NODE_CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20026
NODE_CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20027
NODE_IPC_CONNECTOR_ADDRESS=20028
OVERLAY_UDP_LISTENER_ADDRESS=20029
OVERLAY_TCP_LISTENER_ADDRESS=20030
NODE_XDAGENT_PORT=20031
NODE_OVERLAY_UDP_LISTENER_ADDRESS=20032
NODE_OVERLAY_TCP_LISTENER_ADDRESS=20033
WC_adminhost=20002
WC_adminhost_secure=20003
BOOTSTRAP_ADDRESS=20004
SOAP_CONNECTOR_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20007
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20008
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20009
ORB_LISTENER_ADDRESS=20010
CELL_DISCOVERY_ADDRESS=20011
DCS_UNICAST_ADDRESS=20012
XDAGENT_PORT=20013
OVERLAY_UDP_LISTENER_ADDRESS=20014
OVERLAY_TCP_LISTENER_ADDRESS=20015
STATUS_LISTENER_ADDRESS=20016
WC_adminhost=20002
WC_adminhost_secure=20003
BOOTSTRAP_ADDRESS=20004
SOAP_CONNECTOR_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20007
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20008
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20009
ORB_LISTENER_ADDRESS=20010
CELL_DISCOVERY_ADDRESS=20011
DCS_UNICAST_ADDRESS=20012
DataPowerMgr_inbound_secure=20013
XDAGENT_PORT=20014
OVERLAY_UDP_LISTENER_ADDRESS=20015
OVERLAY_TCP_LISTENER_ADDRESS=20016
STATUS_LISTENER_ADDRESS=20017
WC_adminhost=20002
WC_adminhost_secure=20003
BOOTSTRAP_ADDRESS=20004
SOAP_CONNECTOR_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20007
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20008
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20009
ORB_LISTENER_ADDRESS=20010
STATUS_LISTENER_ADDRESS=20011
WC_adminhost=20002
WC_adminhost_secure=20003
BOOTSTRAP_ADDRESS=20004
SOAP_CONNECTOR_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20007
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20008
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20009
ORB_LISTENER_ADDRESS=20010
PROXY_HTTP_ADDRESS=20002
PROXY_HTTPS_ADDRESS=20003
PROXY_SIP_ADDRESS=20004
PROXY_SIPS_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006
The following example uses the startingPort parameter of the manageprofiles command and creates ports from an initial value of 20002, with the content shown in the previous example:
app_server_root/bin/manageprofiles -create
-profileName shasti
-profilePath user_data_root/profiles/shasti
-templatePath app_server_root/profileTemplates/default
-nodeName W2K03
-cellName W2K03_Cell01
-hostName planetnt
-startingPort 20002
To create the cell profile using the manageprofiles command, you must create both the cell management profile for a deployment manager server and the cell node profile using two different manageprofiles command-line invocations. The combination of these two profiles is the cell profile.
Two templates are used to create the cell profile: cell_dmgr and cell_node. The templates are linked and some parameters must match between the creation parameters in these two invocations. Verify that the invocations match.
From the command line, you can create the two halves of the cell in any order or at any time. It is a best practice to create the deployment manager portion of the profile first. After you create the cell, the cell contains a deployment manager and a federated node. The deployment manager portion and the node portion are in separate directories.
For each of the two profiles that you create, you
can specify the fully qualified path to the resulting profile using
the -profilePath parameter. If you do not specify
the parameter, the default value for each profile path is based on
the directory, the profiles subdirectory, and the name of the profile.
The two templates that compose a cell profile have dependencies between one another which requires some parameter values to match between the two create invocations. To create a full working cell, the -nodeProfilePath, -cellName, -appServerNodeName, -nodeName parameters are required to have the same values for both the cell_dmgr profile and the cell_node profile. In the case of ports, and especially in the case of dynamically allocated ports, the creation of the second half of the cell must reference the ports that are used in the first half of the cell. Use the -portsFile and -nodePortsFile arguments with references to the following files of the profile that represents the first half of the cell:
For detailed help in creating a cell profile, use the following commands:
app_server_root/bin/manageprofiles -create
-templatePath
app_server_root/profileTemplates/cell/dmgr
-help
or
app_server_root/bin/manageprofiles -create
-templatePath
app_server_root/profileTemplates/cell/default
-help
The output from the -help parameter specifies which parameters are required and which are optional when creating the cell deployment manager profile and the cell node profile.
After the creation of the deployment manager and node portions of the cell profile, a synchronization between the two servers must occur. By default, synchronization occurs automatically between the two servers at some specified interval. However, if synchronization is disabled, the interval is too long, or some problem occurs that keeps the synchronization from occurring in a timely manner, run the syncNode command to synchronize the deployment manager and the node.
You must either use the portsFile or the nodePortsFile parameter and the startingPort or the nodeStartingPort parameter.
If you use the manageprofiles command, you can choose the profile that you want to be the default.
The manageprofiles command recommends initial port values when you do not explicitly set port values. You can use predefined port values instead.
Profile | File path |
---|---|
Application server | app_server_root/profileTemplates/default/actions/portsUpdate/portdef.props |
Cell - application server portion | app_server_root/profileTemplates/cell/dmgr/actions/portsUpdate/nodeportdef.props |
Cell - deployment manager portion | app_server_root/profileTemplates/cell/dmgr/actions/portsUpdate/portdef.props |
Custom | app_server_root/profileTemplates/managed/actions/portsUpdate/portdef.props |
Management profile for a deployment manager server | app_server_root/profileTemplates/management/actions/portsUpdate/dmgr.portdef.props |
Management profile for an administrative agent server | app_server_root/profileTemplates/management/actions/portsUpdate/adminagent.portdef.props |
Management profile for a job manager server | app_server_root/profileTemplates/management/actions/portsUpdate/jmgr.portdef.props |
Secure proxy | app_server_root/profileTemplates/secureproxy/actions/portsUpdate/portdef.props |
WC_defaulthost=39080
WC_adminhost=39060
WC_defaulthost_secure=39443
WC_adminhost_secure=39043
BOOTSTRAP_ADDRESS=32809
SOAP_CONNECTOR_ADDRESS=38880
IPC_CONNECTOR_ADDRESS=39633
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=39401
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=39403
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=39402
ORB_LISTENER_ADDRESS=39100
DCS_UNICAST_ADDRESS=39353
SIB_ENDPOINT_ADDRESS=37276
SIB_ENDPOINT_SECURE_ADDRESS=37286
SIB_MQ_ENDPOINT_ADDRESS=35558
SIB_MQ_ENDPOINT_SECURE_ADDRESS=35578
SIP_DEFAULTHOST=35060
SIP_DEFAULTHOST_SECURE=35061
OVERLAY_UDP_LISTENER_ADDRESS=35062
OVERLAY_TCP_LISTENER_ADDRESS=35063
STATUS_LISTENER_ADDRESS=35064
After running the manageprofiles command to create your profile with the user defined port values, a success or fail result displays.
The manageprofiles command creates a copy of the current portdefs.props file in the profile_root\properties directory.
Use only one of the three port values parameters, -startingPort, -defaultPorts, or -portsFile with the manageprofiles command. The three parameters are mutually exclusive.