+

Search Tips   |   Advanced Search

manageprofiles command

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.

Create a profile by running manageprofiles.sh directly is not supported on z/OS.

Remember: If we use this command with the managed profile template, application servers are not created. However, ports are still used if we are federating a node.

Important: The default behavior for manageprofiles is to create files with permissions of 755, ignoring the system wide umask. If you wish to modify these permissions, use the chmod command each time you pass the profile from one user to another.


Syntax

The manageprofiles command is used to perform the following tasks:

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 -help

Depending on the operation to perform with themanageprofiles command, 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.

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 


Parameters

The following options are available for the manageprofiles command:


Usage scenario

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.


Logs

The manageprofiles command creates a log for every profile that it creates.


Example: Creating deployment manager profiles

We can create a deployment manager profile after installing our 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:

(AIX) (HPUX) (Linux) (Solaris)

manageprofiles.sh -create
              -profileName shasti 
              -profilePath /shasti/WebSphere 
              -templatePath /opt/IBM/WebSphere/AppServer/profileTemplates/management
              -serverType DEPLOYMENT_MANAGER
              -cellName cell1
              -hostName planetaix 
              -nodeName dmgr1

(Windows)

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

(iSeries)

manageprofiles -create
              -profileName shasti 
              -profilePath /shasti/WebSphere 
              -templatePath /opt/IBM/WebSphere/AppServer/profileTemplates/management
              -serverType DEPLOYMENT_MANAGER
              -cellName cell1
              -hostName planetaix 
              -nodeName dmgr1

The command creates a deployment manager profile named shasti in a cell named cell1 with a node name of dmgr1 in the following location:

If we 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. To use the IBM default ports, use the -defaultPorts option when we create a profile.


Example: Incrementing default port numbers from a starting point

The manageprofiles command can assign port numbers based on a starting port value. We 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
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

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
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

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
XDAGENT_PORT=20013
OVERLAY_UDP_LISTENER_ADDRESS=20014
OVERLAY_TCP_LISTENER_ADDRESS=20015
STATUS_LISTENER_ADDRESS=20016

Assigned ports for a management profile with a deployment manager server

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

Assigned ports for a management profile with a job manager server

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

Assigned ports for a management profile with an administrative agent server

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 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:

(Windows)

manageprofiles.bat -create
               -profileName shasti 
               -profilePath G:\shasti\WebSphere 
               -templatePath G:\shasti\WebSphere\profileTemplates\default 
               -nodeName W2K03 
               -cellName W2K03_Cell01
               -hostName planetnt 
               -startingPort 20002 
                            
(Linux) (HPUX) (Solaris) (AIX)
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
(iSeries)
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


Example: Creating cell profiles

To create the cell profile using the manageprofiles command, 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, we 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 we 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.

(Dist) For each of the two profiles that we create, we can specify the fully qualified path to the resulting profile using the -profilePath parameter. If we 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.

(iSeries) For each of the two profiles that we create, we can specify the fully qualified path to the resulting profile using the -profilePath parameter. If not specified, 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 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:

(Linux) (HPUX) (Solaris) (AIX) (iSeries)

(Windows)

This approach ensures that the ports in the second half of the cell are created with the correct correlation to the first half of the cell.

For detailed help in creating a cell profile.:

(Linux) (HPUX) (Solaris) (AIX)

app_server_root/bin/manageprofiles.sh -create
 -templatePath
app_server_root/profileTemplates/cell/dmgr
 -help 
(Windows)
app_server_root\bin\manageprofiles.bat -create
 -templatePath
app_server_root\profileTemplates\cell\dmgr
 -help
(iSeries)
app_server_root/bin/manageprofiles -create
 -templatePath
app_server_root/profileTemplates/cell/dmgr
 -help 

or

(Linux) (HPUX) (Solaris) (AIX)

app_server_root/bin/manageprofiles.sh -create
 -templatePath
app_server_root/profileTemplates/cell/default
 -help 
(Windows)
app_server_root\bin\manageprofiles.bat -create
 -templatePath 
app_server_root\profileTemplates\cell\default
 -help 
(iSeries)
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.

The following example creates a cell profile named Dmgr001 having a cell name of Default01Cell and a node name of Default01Node.

  1. Verify that the following path is available for use:

    The path must be available when we create the deployment manager and node portions of the cell as subdirectories are added for each portion.

    • (Linux) (HPUX) (Solaris) (AIX) (iSeries) app_server_root/profiles
    • (Windows) app_server_root\profiles

  2. Create the deployment manager portion of the cell profile.

    (Linux) (HPUX) (Solaris) (AIX)

    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 federated_node_name
    
    (Windows)
    app_server_root\bin\manageprofiles.bat -create 
     -templatePath 
    app_server_root\profileTemplates\cell\dmgr 
     -nodeProfilePath 
    app_server_root\profiles\AppSrv01 
     -profileName Dmgr001 
     -cellName Default01Cell 
     -nodeName Default01Node 
     -appServerNodeName federated_node_name
    
    (iSeries)
    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 federated_node_name
    

  3. Verify that the Dmgr001 profile exists as it must exist before creating the application server portion of the cell profile.

  4. Create the application server portion of the cell profile.

    Important: We must use the same values for the cellName, nodeName, and appServerNodeName parameters that we used in the deployment manager portion of the cell profile. The following example illustrates the use of the same values for the cellName, nodeName, and appServerNodeName parameters in the deployment manager and application server portions of the cell profile.

    For Dmgr:                       
    -cellName host01Cell01          
    -nodeName host01CellManager01   
    -appServerNodeName host01Node01 
                                    
    For AppServer:                  
    -cellName host01Cell01          
    -nodeName host01CellManager01   
    -appServerNodeName host01Node01 
    
    If we did not specify names for these parameters when we created the deployment manager portion of the cell profile, use the default name that was assigned in the first command-line invocation. (Linux) (HPUX) (Solaris) (AIX)
    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 federated_node_name
    
    (Windows)
    app_server_root\bin\manageprofiles.bat -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 federated_node_name
    
    (iSeries)
    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 federated_node_name
    

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.

We must either use the portsFile or the nodePortsFile parameter and the startingPort or the nodeStartingPort parameter.

If we use the manageprofiles command, we can choose the profile to be the default.

(Dist) If we federate an application server node as part of cell profile creation using the -appServerNodeName parameter, the node does not have an original configuration. If we use the -removeNode command on a node 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.


Example: Using predefined port numbers

The manageprofiles command recommends initial port values when we do not explicitly set port values. Use predefined port values instead.

The manageprofiles command recommends port values when the options of -defaultPorts, -startingPort, or -portsFile are not specified.

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

To customize the port values in the portdef.props file before creating your profile, perform the following steps. The following example creates the default profile. For other types of profiles, we must substitute the file path with the file path of the profile to create.

  1. Copy the app_server_root/profileTemplates/default/actions/portsUpdate/portdef.props file from the default profile template path and place a copy of the file in an arbitrary temporary directory such as:

    • (Windows) c:\temp\ports
    • (UNIX) (iSeries) /temp/ports

  2. In the new file, modify the port settings to specify your port values.

  3. Create your profile with the manageprofiles command. Use the modified port values. Specify the location of our modified portdef.props file on the -portsFile parameter. Specify the -validatePorts parameter to ensure that ports are not reserved or in use. Use the following example as a guide:

    (Windows)

    manageprofiles.bat 
       -create
       -profileName Wow_Profile 
       -profilePath profile_root 
       -templatePath app_server_root\profileTemplates\default 
       -nodeName Wow_node 
       -cellName Wow_cell
       -hostName lorriemb 
       -portsFile C:\temp\ports\portdef.props
       -validatePorts 
    
    (AIX) (Linux)
    manageprofiles.sh 
       -create
       -profileName Wow_Profile 
       -profilePath profile_root 
       -templatePath app_server_root\profileTemplates\default 
       -nodeName Wow_node 
       -cellName Wow_cell
       -hostName lorriemb 
       -portsFile \temp\ports\portdef.props
       -validatePorts
    
    (iSeries)
    manageprofiles 
       -create
       -profileName Wow_Profile 
       -profilePath profile_root 
       -templatePath app_server_root\profileTemplates\default 
       -nodeName Wow_node 
       -cellName Wow_cell
       -hostName lorriemb 
       -portsFile \temp\ports\portdef.props
       -validatePorts
    

Suppose that the portdef.props file has the following values:

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.

(iSeries) Note: After creating a profile successfully, the console prints a message that indicates success and advises you to check the AboutThisProfile.txt file. However, a AboutThisProfile.txt file is not generated when we create a client profile or a plug-ins profile on IBM i.

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.