WAS v8.5 > Set up the application serving environment > Manage profiles

manageprofiles command

Use manageprofiles.sh 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.

Creating 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 you are federating a node.


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 manageprofiles.sh, use the -help parameter. The following example uses the help parameter with the manageprofiles -augment command on Windows operating systems:

The output from the help command will specify which parameters are required and which are optional.

Depending on the operation to perform with themanageprofiles command, provide one or more of the following parameters. The command-line tool validates 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 manageprofiles.sh:

-adminUserName adminUser_ID

Specify the user ID used for administrative security.

-adminPassword adminPassword

Specify the password for the administrative security user ID specified with the -adminUserName parameter.

-augment

Use the augment parameter to make changes to an existing profile with an augmentation template. The augment parameter causes manageprofiles.sh to update or augment the profile identified in the -profileName parameter using the template in the -templatePath parameter. The augmentation templates that we can use are determined by which IBM products and versions are installed in the environment.

The templates that are included with the WebSphere Application Server base product 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 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 manageprofiles.sh instead of modifying the file in the profile template directory.

Specify the fully qualified file path for -templatePath. For example:

    manageprofiles.sh -augment -profileName profile_name -templatePath template_path

We can specify a relative path for the -templatePath parameter if the profile templates are relative to the app_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.

-backupProfile

Performs a file system backup of a profile folder and the profile metadata from the profile registry file. Any servers using the profile to back up must first be stopped prior to invoking manageprofiles.sh with the -backupProfile option. The -backupProfile parameter must be used with the -backupFile and -profileName parameters, for example:

    manageprofiles.sh -backupProfile -profileName profile_name -backupFile backupFile_name

When you back up a profile using the -backupProfile option, first stop the server and the running processes for the profile to back up.

-backupFile backupFile_name

Backs up the profile registry file to the specified file. Provide a fully qualified file path for the backupFile_name.

-cellName cell_name

Cell name of the profile. Use a unique cell name for each profile.

This is an optional parameter. If you omit the parameter, a default cell name is assigned.

The default value for this parameter is based on a combination of the short host name, the constant cell, and a trailing number:

  • Application server profile: Not any
  • Management profile with the administrative agent server: shortHostNameAACellCellNumber

where CellNumber is a sequential number starting at 01.

The value for this parameter must not contain spaces or any invalid characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, |, and so on.

-create

Creates the profile.

Specify manageprofiles -create -templatePath fully_qualified_file_path_to_template -help for specific information about creating a profile. Available templates include:

  • management - Management. Use in conjunction with the -serverType parameter to indicate the type of management profile.
  • default - Application server

-debug

Turns on the debug function of the Ant utility, which manageprofiles.sh uses.

-personalCertValidityPeriod validity_period

An optional parameter that specifies the amount of time in years the default personal certificate is valid. If we do not specify this parameter with the -personalCertDN parameter, the default personal certificate is valid for one year.

-defaultPorts

Assigns the default or base port values to the profile.

Do not use this parameter when using the -startingPort or -portsFile parameter.

During profile creation, manageprofiles.sh uses an automatically generated set of recommended ports if we 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.

Remember: Do not use this parameter if you are using the managed profile template.

-delete

Deletes the profile.

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.

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

If you delete a profile that has augmenting templates registered to it in the profile registry, then unaugment actions are performed automatically.

-deleteAll

Deletes all registered profiles.

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.

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

If you delete a profile that has augmenting templates registered to it in the profile registry, then unaugment actions are performed automatically.

-enableAdminSecurity true | false

Enables administrative security. Valid values include true or false. Default is false.

When enableAdminSecurity is set to true, you must also specify the parameters -adminUserName and -adminPassword along with the values for these parameters.

-enableService true | false

Enables the creation of a Linux service. Valid values include true or false. The default value for this parameter is false.

When manageprofiles.sh 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 manageprofiles.sh, 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.

-getDefaultName

Returns the name of the default profile.

-getName

Gets the name for a profile registered at a given -profilePath parameter.

-getPath

Gets the file system location for a profile of a given name. Requires the –profileName parameter.

-help

Displays command syntax.

-hostName host_name

Specifies the host name where you are creating the profile. This should match the host name that you specified during installation of the initial product. The default value for this parameter is the long form of the domain name system. The value for this parameter must be a valid IPv6 host name and must not contain spaces or any characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, |, and so on.

-ignoreStack

An optional parameter used with the -templatePath parameter to unaugment a particular profile that has been augmented. See the -unaugment parameter.

-importPersonalCertKS keystore_path

Path to the keystore file that we use to import a personal certificate when we create the profile. The personal certificate is the default personal certificate of the server.

Best practice: When you import a personal certificate as the default personal certificate, import the root certificate that signed the personal certificate. Otherwise, manageprofiles.sh adds the public key of the personal certificate to the trust.p12 file and creates a root signing certificate. The -importPersonalCertKS parameter is mutually exclusive with the -personalCertDN parameter. If we do not specifically create or import a personal certificate, one is created by default.

When we specify any of the parameters that begin with -importPersonal, specify them all.

-importPersonalCertKSType keystore_type

Type of the keystore file specified on the -importPersonalCertKS parameter. Values might be JCEKS, CMSKS, PKCS12, PKCS11, and JKS. However, this list can change based on the provider in the java.security file.

When we specify any of the parameters that begin with -importPersonal, specify them all.

-importPersonalCertKSPassword keystore_password

Password of the keystore file specified on the -importPersonalCertKS parameter.

When we specify any of the parameters that begin with -importPersonal, specify them all.

-importPersonalCertKSAlias keystore_alias

Alias of the certificate that is in the keystore file specified on the -importPersonalCertKS parameter.

The certificate is added to the server default keystore file and is used as the server default personal certificate.

When we specify any of the parameters that begin with -importPersonal, specify them all.

-importSigningCertKS keystore_path

Path to the keystore file that we use to import a root certificate when we create the profile. The root certificate is the certificate that we use as the server default root certificate. The -importSigningCertKS parameter is mutually exclusive with the -signingCertDN parameter. If we do not specifically create or import a root signing certificate, one is created by default.

When we specify any of the parameters that begin with -importSigning, specify them all.

-importSigningCertKSType keystore_path

Type of the keystore file specified on the -importSigningCertKS parameter. Valid values might be JCEKS, CMSKS, PKCS12, PKCS11, and JKS. However, this list can change based on the provider in the java.security file.

When we specify any of the parameters that begin with -importSigning, specify them all.

-importSigningCertKSPassword keystore_password

Password of the keystore file specified on the -importSigningCertKS parameter.

When we specify any of the parameters that begin with -importSigning, specify them all.

-importSigningCertKSAlias keystore_alias

Alias of the certificate that is in the keystore file specified on the -importSigningCertKS parameter.

The certificate is added to the server default root keystore and is used as the server default root certificate.

When we specify any of the parameters that begin with -importSigning, specify them all.

-isDefault

The profile identified by the accompanying -profileName parameter is to be the default profile once it is registered. When issuing commands that address the default profile, it is not necessary to use the -profileName attribute of the command.

-isDeveloperServer

The server is intended for development purposes only. This parameter is useful when creating profiles to test applications on a non-production server before deploying the applications on their production application servers.

This parameter is valid only for the default profile template.

If we specify both the -isDeveloperServer and -applyPerfTuningSetting parameters, depending on the option selected for -applyPerfTuningSetting, -applyPerfTuningSetting might override -isDeveloperServer.

-applyPerfTuningSetting option

Performance-tuning setting that most closely matches the type of environment in which the application server will run.

This parameter is only valid for the default profile template.

standard

The standard settings are the standard out-of-the-box default configuration settings that are optimized for general-purpose usage.

production

WAS v8.5ion performance settings are optimized for a production environment where application changes are rare and optimal runtime performance is important.

development

The development settings are optimized for a development environment where frequent application updates are performed and system resources are at a minimum.

Do not use the development settings for production servers.

If we specify both the -isDeveloperServer and -applyPerfTuningSetting parameters, depending on the option selected for -applyPerfTuningSetting, -applyPerfTuningSetting might override -isDeveloperServer.

-keyStorePassword keystore_password

Password to use on all keystore files created during profile creation. Keystore files are created for the default personal certificate and the root signing certificate.

-listAugments

Lists the registered augments on a profile that is in the profile registry. Specify the -profileName parameter with the -listAugments parameter.

-nodeName node_name

Node name for the node that is created with the new profile. Use a unique value on the machine. Each profile that shares the same set of product binaries must have a unique node name.

The default value for this parameter is based on the short host name, profile type, and a trailing number:

  • Application server profile: shortHostNameNodeNodeNumber
  • Management profile with the administrative agent server: shortHostNameAANodeNodeNumber

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

-omitAction feature1 feature2... featureN

An optional parameter that excludes profile features.

Each profile template comes predefined with certain optional features. The following optional features can be used with the -omitAction parameter for the following profile templates:

  • default - application server

    • deployAdminConsole
    • defaultAppDeployAndConfig

  • management - management profile for the administrative agent

    • deployAdminConsole

-personalCertDN distinguished_name

Distinguished name of the personal certificate that you are creating when we create the profile. Specify the distinguished name in quotes. This default personal certificate is located in the server keystore file. The -importPersonalCertKSType parameter is mutually exclusive with the -personalCertDN parameter. See the -personalCertValidityPeriod parameter and the -keyStorePassword parameter.

-portsFile file_path

An optional parameter that specifies the path to a file that defines port settings for the new profile.

Do not use this parameter when using the -startingPort or -defaultPorts parameter.

During profile creation, manageprofiles.sh uses an automatically generated set of recommended ports if we 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.

-profileName profile_name

Name of the profile. Use a unique value when creating a profile. Each profile that shares the same set of product binaries must have a unique name. The default profile name is based on the profile type and a trailing number, for example:

    <profile_type><profile_number>
where

  • <profile_type> is a value such as AppSrv or AdminAgent
  • <profile_number> 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 any of the following: *, ?, ", <, >, ,, /, \, |, and so on.

The profile name that you choose must not be in use.

-profilePath profile_root

Fully qualified path to the profile, which is referred to as the 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 profile.

For example, the default is:

    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.

You must have permissions to write to the directory.

-response reponse_file

Accesses all API functions from the command line using manageprofiles.sh.

The command line interface can be driven by a response file containing 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 manageprofiles.sh with the -help parameter.

Use the following example response file to run a create operation: 

create
profileName=testResponseFileCreate
profilePath=profile_root
templatePath=app_server_root/profileTemplates/default
nodeName=myNodeName
cellName=myCellName
hostName=myHostName
omitAction=myOptionalAction1,myOptionalAction2

When creating a response file, take into account the following set of guidelines:

  • When we specify values, do not specify double-quote (") characters at the beginning or end of a value, even if that value contains spaces.

    This is a different rule than when we specify values on a command line.

  • When we specify a single value containing a comma character, such as the distinguished names for the personalCertDN and signingCertDN parameters, use a double-backslash before the comma character. For example, here is how to specify the personalCertDN value with a distinguished name: 
    signingCertDN=cn=testserver.ibm.com\\,ou=Root Certificate\\,
   ou=testCell\\,ou=testNode01\\,o=IBM\\,c=US

  • When we specify multiple values, separate them with a comma character, and do not use double-backslashes. For example, here is how to specify multiple values for the omitAction parameter:

      omitAction=samplesInstallAndConfig,defaultAppDeployAndConfig
  • Do not specify a blank line in a response file. This can cause an error.
  • The path statement in the Windows operating system can use either forward slashes (/) or back slashes (\). If the path statement uses back slashes, then the response file requires double back slashes for the response file to correctly understand the path. Here is an example of a response file for a create operation that uses the double back slashes: 
    create
templatePath=C:\\WebSphere\\AppServer\\profileTemplates\\default

    Best practice: Use forward slashes in order to reduce the chance of errors when switching between platforms.

-restoreProfile

Restores a profile backup. Must be used with the -backupFile parameter, for example:

    manageprofiles.sh -restoreProfile -backupFile file_name

To restore a profile, perform the following steps:

  1. Stop the server and the running processes for the profile to restore.
  2. Manually delete the directory for the profile from the file system.

  3. Run the -validateAndUpdateRegistry option of manageprofiles.sh.
  4. Restore the profile using the -restoreProfile option of manageprofiles.sh.

-serverName server_name

Name of the server. Specify this parameter only for the default and secureproxy templates. If we do not specify this parameter when using the default or secureproxy templates, the default server name is server1 for the default profile, and proxy1 for the secure proxy profile.

-serverType ADMIN_AGENT

Type of management profile. Specify ADMIN_AGENT for an administrative agent server. This parameter is required when we create a management profile.

-serviceUserName service_user_ID

Specify the user ID used during the creation of the Linux service so the Linux service runs from this user ID. The Linux service runs whenever the user ID is logged on.

-setDefaultName

Sets the default profile to one of the existing profiles. Must be used with the -profileName parameter, for example:

    manageprofiles.sh -setDefaultName -profileName profile_name

-signingCertDN distinguished_name

Distinguished name of the root signing certificate that you create when we create the profile. Specify the distinguished name in quotes. This default personal certificate is located in the server keystore file. The -importSigningCertKS parameter is mutually exclusive with the -signingCertDN parameter. If we do not specifically create or import a root signing certificate, one is created by default. See the -signingCertValidityPeriod parameter and the -keyStorePassword.

-signingCertValidityPeriod validity_period

An optional parameter that specifies the amount of time in years the root signing certificate is valid. If we do not specify this parameter with the -signingCertDN parameter, the root signing certificate is valid for 15 years.

-startingPort startingPort

Starting port number for generating and assigning all ports for the profile.

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.

Do not use this parameter with the -defaultPorts or -portsFile parameters.

During profile creation, manageprofiles.sh uses an automatically generated set of recommended ports if we 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.

Do not use this parameter if you are using the managed profile template.

-templatePath template_path

Directory path to the template files in the installation root directory. Within the profileTemplates directory are various directories that correspond to different profile types and that vary with the type of product installed. The profile directories are the paths that you indicate while using the -templatePath option. We can specify profile templates that lie outside the installation root, if you happen to have any.

We 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. F

The available templates are described in the Profile concepts topic.

-unaugment

Augmentation is the ability to change an existing profile with an augmentation template. To unaugment a profile that has been augmented, specify the -unaugment parameter and the -profileName parameter. If a series of manageprofiles augmentations were performed, and we specify only these two parameters to unaugment a profile, the unaugment action undoes the last augment action first.

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 ensure that you are not violating profile template dependencies.

When using the -templatePath parameter, specify the fully qualified file path for the parameter.

See also the augment parameter.

-unaugmentAll

Unaugments all profiles that have been augmented with a specific augmentation template. The -templatePath parameter is required with the -unaugmentAll parameter.

When using the -templatePath parameter, specify the fully qualified 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.

If we use this parameter when we have no profiles augmented with the profile templates, an error might be delivered.

See also the augment parameter.

-unaugmentDependents

If specified, the parameter unaugments all the augmented profiles that are prerequisites to the profiles being unaugmented with the -unaugmentAll parameter. If not specified, it does not unaugment the augmented profiles that are prerequisites to the profiles being unaugmented.

Specify the -unaugmentDependents parameter with the -unaugmentAll parameter.

-validateAndUpdateRegistry

Checks all of the profiles listed in the profile registry to see if the profiles are present on the file system. Removes any missing profiles from the registry. Returns a list of the missing profiles that were deleted from the registry.

-validateRegistry

Checks all of the profiles listed in the profile registry to see if the profiles are present on the file system. Returns a list of missing profiles.

-validatePorts

Ports that should be validated to ensure they are not reserved or in use. This parameter helps you to identify ports that are not being used. If a port is determined to be in use, the profile creation stops and an error message displays. We can use this parameter at any time on the create command line. It is recommended that we use this parameter with the –portsFile parameter.

-webServerCheck true | false

Indicates if to set up web server definitions. Valid values include true or false. The default value for this parameter is false.

-webServerHostname webserver_host_name

The host name of the server. The default value for this parameter is the long host name of the local machine.

-webServerInstallPath webserver_installpath_name

The installation path of the web server, local or remote. The default value for this parameter is dependent on the operating system of the local machine and the value of the webServerType parameter. For example:

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”

-webServerName webserver_name

The name of the web server. The default value for this parameter is webserver1.

-webServerOS webserver_operating_system

The operating system from where the web server resides. Valid values include: windows, linux, solaris, aix, hpux, os390, and os400. Use this parameter with the webServerType parameter.

-webServerPluginPath webserver_pluginpath

The path to the plug-ins the web server uses. The default value for this parameter is WAS_HOME/plugins.

-webServerPort webserver_port

Indicates the port from where the web server will be accessed. The default value for this parameter is 80.

-webServerType webserver_type

The type of the web server. Valid values include: IHS, SUNJAVASYSTEM, IIS, DOMINO, APACHE, and HTTPSERVER_ZOS. Use this parameter with the webServerOS parameter.

-winserviceAccountType specifieduser | localsystem

The type of the owner account of the Windows service created for the profile. Valid values include specifieduser or localsystem. The localsystem value runs the Windows service under the local account of the user who creates the profile. The default value for this parameter is localsystem.

If the value is specifieduser, the winservicePassword parameter is required. The winserviceUserName parameter defaults to the environment username value if not specified.

-winserviceCheck true | false

The value can be either true or false. Specify true to create a Windows service for the server process that is created within the profile. Specify false to not create the Windows service. The default value for this parameter is false.

With a custom profile, we cannot create a Windows service with this parameter. Instead, use the WASService command to create the service separately.

-winservicePassword winservice_password

Specify the password for the specified user or the local account that is to own the Windows service.

-winserviceStartupType manual | automatic | disabled

Possible startup_type values are:

  • manual
  • automatic
  • disabled

Read the article on the WASService command for more information about Windows services.

The default value for this parameter is automatic.

-winserviceUserName winservice_user_ID

Specify the user ID so the Windows operating system can verify you as an ID that is capable of creating a Windows service. Your user ID must belong to the administrator group and have the following advanced user rights:

  • Exist as part of the operating system
  • Log on as a service

The default value for this parameter is the current user name. The value for this parameter must not contain spaces or characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, |, and so on. The user specified must have the proper permissions to create a Windows service. Specify the correct password for the user name that you choose.


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

The following example uses the startingPort parameter of manageprofiles.sh 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


Example: Using predefined port numbers

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

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

File locations of default port values.

This table lists the file locations of default port values by type of profile.

Profile File path
Application server app_server_root/profileTemplates/default/actions/portsUpdate/portdef.props
Management profile for an administrative agent server app_server_root/profileTemplates/management/actions/portsUpdate/adminagent.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, you 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:

    • c:\temp\ports
    • /temp/ports

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

  3. Create your profile with manageprofiles.sh. Use the modified port values. Specify the location of your 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: 

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

Suppose 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

After running manageprofiles.sh 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 manageprofiles.sh. The three parameters are mutually exclusive.


+

Search Tips   |   Advanced Search