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 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 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:
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
app_server_root/bin/manageprofiles.sh -create -profileName Dmgr001 -profilePath profile_root -templatePath app_server_root/profileTemplates/management -serverType DEPLOYMENT_MANAGER -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\management -serverType DEPLOYMENT_MANAGER -nodeName Dmgr001Node -cellName Dmgr001NodeCell -hostName localhost -isDefault -startingPort 20000
Creating an administrative agent
The following example uses the management template to create an administrative agent named AdminAgent001. The administrative agent ports start at port number 24000.
app_server_root/bin/manageprofiles.sh -create -profileName AdminAgent001 -profilePath profile_root -templatePath app_server_root/profileTemplates/management -serverType ADMIN_AGENT -nodeName AdminAgent001Node -hostName localhost -isDefault -startingPort 24000
app_server_root\bin\manageprofiles.bat -create -profileName AdminAgent001 -profilePath profile_root -templatePath app_server_root\profileTemplates\management -serverType ADMIN_AGENT -nodeName AdminAgent001Node -hostName localhost -isDefault -startingPort 24000
Creating a job manager
The following example uses the management template to create a job manager named JobMgr001. The job manager ports start at port number 25000.
app_server_root/bin/manageprofiles.sh -create -profileName JobMgr001 -profilePath profile_root -templatePath app_server_root/profileTemplates/management -serverType JOB_MANAGER -nodeName JobMgr001Node -cellName JobMgr001NodeCell -hostName localhost -isDefault -startingPort 25000
app_server_root\bin\manageprofiles.bat -create -profileName JobMgr001 -profilePath profile_root -templatePath app_server_root\profileTemplates\management -serverType JOB_MANAGER -nodeName JobMgr001Node -cellName JobMgr001NodeCell -hostName localhost -isDefault -startingPort 25000
Creating a secure proxy
The following example uses the secure proxy template to create a secure proxy named SecureProxySrv001. The secure proxy ports start at port number 26000.
app_server_root/bin/manageprofiles.sh -create -profileName SecureProxySrv001 -profilePath profile_root -templatePath app_server_root/profileTemplates/secureproxy -nodeName SecureProxySrv001Node -serverName secproxy1 -hostName localhost -isDefault -startingPort 26000
app_server_root\bin\manageprofiles.bat -create -profileName SecureProxySrv001 -profilePath profile_root -templatePath app_server_root\profileTemplates\secureproxy -nodeName SecureProxySrv001Node -serverName secproxy1 -hostName localhost -isDefault -startingPort 26000
Creating a custom profile
The following example creates a custom profile and federates the profile into the deployment manager cell.
c:\WebSphere\AppServer\bin manageprofiles.bat -create -profileName Custom01 -profilePath profile_root -templatePath 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 -dmgrHost myhost.mycity.mycompany.com -dmgrPort 8879 -startingPort 22000
Creating an application server profile
Create an application server profile named Default01 with the following command.
The command also creates a Windows service for the application server, personal and root signing certificates for the profile, and a keystore password for the two certificates.
app_server_root\bin manageprofiles.bat -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 -personalCertDN "cn=testa, ou=Rochester, o=IBM, c=US" -signingCertDN "cn=testc, ou=Rochester, o=IBM, c=US" -keyStorePassword ap3n9krw
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 -personalCertDN "cn=testa, ou=Rochester, o=IBM, c=US" -signingCertDN "cn=testc, ou=Rochester, o=IBM, c=US" -keyStorePassword ap3n9krw
Creating a cell profile
For Dmgr: -cellName host01Cell01 -nodeName host01CellManager01 -appServerNodeName host01Node01 For AppServer: -cellName host01Cell01 -nodeName host01CellManager01 -appServerNodeName host01Node01
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.bat -create -profileName shasti -profilePath C:\shasti\WebSphere -templatePath C:\IBM\WebSphere\AppServer\profileTemplates\management -serverType DEPLOYMENT_MANAGER -cellName cell1 -hostName planetnt -nodeName dmgr1
manageprofiles.sh -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 is 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:
Assigned ports for an Application Server profile
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 CELL_DISCOVERY_ADDRESS=20013 NODE_MULTICAST_DISCOVERY_ADDRESS=20014 NODE_IPV6_MULTICAST_DISCOVERY_ADDRESS=20015 NODE_DISCOVERY_ADDRESS=20016 DCS_UNICAST_ADDRESS=20017 SIB_ENDPOINT_ADDRESS=20018 SIB_ENDPOINT_SECURE_ADDRESS=20019 SIB_MQ_ENDPOINT_ADDRESS=20020 SIB_MQ_ENDPOINT_SECURE_ADDRESS=20021 SIP_DEFAULTHOST=20022 SIP_DEFAULTHOST_SECURE=20023
Assigned ports for a custom profile
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
Assigned ports for a cell with a federated application server profile
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
Assigned ports for a cell with a deployment manager profile
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
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
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
Assigned ports for a management profile with an administrative agent server
The ports are for a Network Deployment installation.
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
Assigned ports for a management profile with an administrative agent server
SOAP_CONNECTOR_ADDRESS=20002 IPC_CONNECTOR_ADDRESS=20003
Assigned ports for a secure proxy profile
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:
manageprofiles.bat -create -profileName shasti -profilePath G:\shasti\WebSphere -templatePath G:\shasti\WebSphere\profileTemplates\default -nodeName W2K03 -cellName W2K03_Cell01 -hostName planetnt -startingPort 20002
app_server_root/bin/manageprofiles.sh -create -profileName shasti -profilePath app_server_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 app_server_root 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.sh -create -templatePath app_server_root/profileTemplates/cell/dmgr -help
app_server_root/bin/manageprofiles.sh -create -templatePath app_server_root/profileTemplates/SCA/cell.scafep/dmgr -help
app_server_root/bin/manageprofiles.sh -create -templatePath app_server_root/profileTemplates/SCA/cell.sdofep/dmgr -help
app_server_root\bin\manageprofiles.bat -create -templatePath app_server_root\profileTemplates\cell\dmgr -help
app_server_root\bin\manageprofiles.bat -create -templatePath app_server_root\profileTemplates\SCA\cell.scafep\dmgr -help
app_server_root\bin\manageprofiles.bat -create -templatePath app_server_root\profileTemplates\SCA\cell.sdofep\dmgr -help
or
app_server_root/bin/manageprofiles.sh -create -templatePath app_server_root/profileTemplates/cell/default -help
app_server_root/bin/manageprofiles.sh -create -templatePath app_server_root/profileTemplates/SCA/cell.scafep/default -help
app_server_root/bin/manageprofiles.sh -create -templatePath app_server_root/profileTemplates/SCA/cell.sdofep/default -help
app_server_root\bin\manageprofiles.bat -create -templatePath app_server_root\profileTemplates\cell\default -help
app_server_root\bin\manageprofiles.bat -create -templatePath app_server_root\profileTemplates\SCA\cell.scafep\default -help
app_server_root\bin\manageprofiles.bat -create -templatePath app_server_root\profileTemplates\SCA\cell.sdofep\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.
If you federate an application server node as part
of cell profile creation using the -appServerNodeName parameter, the
node does not have an original configuration. If you use the -removeNode command
on a node that was created during cell profile creation, the command
will indicate that the node removal utility is unable to remove the
node and restore the node to a base configuration. To successfully
remove a node that was federated as part of a cell profile creation,
use the manageprofiles command to delete the profile
for the node. Once the profile for the node is deleted, use the -cleanupNode command
on Deployment Manager to remove the node configuration from the cell
repository. A new profile can be created using the Profile Management
Tool or the manageprofiles command.
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
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.