[AIX Solaris HP-UX Linux Windows]

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.

[AIX Solaris HP-UX Linux Windows]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.

Note: Creating a profile by running manageprofiles.sh directly is not supported on z/OS.
Remember: If you use this command with the managed profile template, application servers are not created. However, ports are still used if you 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:
  • create a profile (-create)
  • delete a profile (-delete)
  • augment a profile (-augment)
  • unaugment a profile (-unaugment)
  • unaugment all profiles that have been augmented with a specific augmentation template (-unaugmentAll)
  • delete all profiles (-deleteAll)
  • list all profiles (-listProfiles)
  • list augments for a profile (-listAugments)
  • get a profile name (-getName)
  • get a profile path (-getPath)
  • validate a profile registry (-validateRegistry)
  • validate and update a profile registry (-validateAndUpdateRegistry)
  • get the default profile name (-getDefaultName)
  • back up a profile (-backupProfile)
  • restore a profile (-restoreProfile)
  • perform manageprofiles command tasks that are contained in a response file (-response)
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 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 that are entered for those parameters are valid. Be sure to type the name of the parameters with the correct 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.
  • -adminPassword adminPassword
  • -adminUserName adminUser_ID
  • -applyPerfTuningSetting standard | peak | development
  • -augment
  • -backupFile backupFile_name
  • -backupProfile
  • -cellName cell_name (Optional Parameter)
  • -create
  • -debug
  • -defaultPorts
  • -delete
  • -deleteAll
  • -enableAdminSecurity true | false
  • [Linux]-enableService true | false
  • -getDefaultName
  • -getPath
  • -getName
  • -help
  • -hostName host_name
  • -ignoreStack (Optional Parameter)
  • -importPersonalCertKS keystore_path
  • -importPersonalCertKSAlias keystore_alias
  • -importPersonalCertKSPassword keystore_password
  • -importPersonalCertKSType keystore_type
  • -importSigningCertKS keystore_path
  • -importSigningCertKSAlias keystore_alias
  • -importSigningCertKSPassword keystore_password
  • -importSigningCertKSType keystore_type
  • -isDefault
  • -isDeveloperServer
  • -keyStorePassword keystore_password
  • -listAugments
  • -listProfiles
  • -nodeName node_name
  • -omitAction feature1 feature2... featureN (Optional Parameter)
  • -personalCertDN distinguished_name
  • -personalCertValidityPeriod validity_period (Optional Parameter)
  • -portsFile file_path (Optional Parameter)
  • -profileName profile_name
  • -profilePath profile_root
  • -response response_file
  • -restoreProfile
  • -serverName server_name
  • -serverType ADMIN_AGENT
  • [Linux]-serviceUserName service_user_ID
  • -setDefaultName
  • -signingCertDN distinguished_name
  • -signingCertValidityPeriod validity_period (Optional Parameter)
  • -startingPort starting_port | -portsFile file_path | -defaultPorts
  • -templatePath template_path
  • -unaugment
  • -unaugmentAll
  • -unaugmentDependents
  • -validateAndUpdateRegistry
  • -validatePorts
  • -validateRegistry
  • -webServerCheck true | false
  • -webServerHostnamewebserver_host_name
  • -webServerInstallPath webserver_installpath_name
  • -webServerName webserver_name
  • -webServerOS webserver_operating_system
  • -webServerPluginPath webserver_plugin_path
  • -webServerPort webserver_port
  • -webServerType webserver_type
  • [Windows]-winserviceAccountType specifieduser | localsystem
  • [Windows]-winserviceCheck true | false
  • [Windows]-winservicePassword winservice_password
  • [Windows]-winserviceStartupType manual | automatic | disabled
  • [Windows]-winserviceUserName winservice_user_ID

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:

-adminPassword adminPassword
Specify the password for the administrative security user ID specified with the -adminUserName parameter.
-adminUserName adminUser_ID
Specify the user ID that is used for administrative security.
-applyPerfTuningSetting option
Specifies the 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.
peak
The peak 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.
Important: Do not use the development settings for production servers.

If you do not specify an option with the -applyPerfTuningSetting parameter, the default value is standard.

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

-augment
Use the augment parameter to change to an existing profile with an augmentation template. The augment parameter causes the manageprofiles command to update or augment the profile that is identified in the -profileName parameter by using the template in the -templatePath parameter. The augmentation templates that you can use are determined by which IBM® products and versions are installed in your environment.
Important: The templates that are included with the WebSphere Application Server base or WebSphere Application Server - Express 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 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.

[AIX Solaris HP-UX Linux Windows]Specify the fully qualified file path for -templatePath. For example:
 manageprofiles(.bat)(.sh) -augment -profileName profile_name -templatePath template_path
You 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.

-backupFile backupFile_name
Backs up the profile registry file to the specified file. You must provide a fully qualified file path for the backupFile_name.
-backupProfile
Performs a file system backup of a profile folder and the profile metadata from the profile registry file. Any servers using the profile that you want to back up must first be stopped prior to invoking the manageprofiles command with the -backupProfile option. The -backupProfile parameter must be used with the -backupFile and -profileName parameters, for example:
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.

-cellName cell_name (Optional Parameter)
Specifies the cell name of the profile. Use a unique cell name for each profile.
Avoid trouble: Cell names must be unique. If cells have duplicate names, you might experience problems with remote communications between cells, such as remote Enterprise JavaBeans calls.

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

[AIX Solaris HP-UX Linux Windows]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 the manageprofiles command uses. The verbose Ant output is combined with logging from the manageprofiles command in log files that begin with the manageprofiles name in the app_server_root/logs/directory directory.
-personalCertValidityPeriod validity_period (Optional Parameter)
An optional parameter that specifies the amount of time in years that the default personal certificate is valid. If you 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, 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.

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

[AIX Solaris HP-UX Linux Windows]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.

[AIX Solaris HP-UX Linux Windows]You can delete or leave the directory. However, the profile_root/logs directory contains information about uninstalling the profile. For example, you might retain the _nodeuninst.log file to determine the cause of any problem during the uninstall procedure.

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.

[AIX Solaris HP-UX Linux Windows]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.

[AIX Solaris HP-UX Linux Windows]You can delete or leave the directory. However, the profile_root/logs directory contains information about uninstalling the profile. For example, you might retain the _nodeuninst.log file to determine the cause of any problem during the uninstall procedure.

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. The default value is false.
When enableAdminSecurity is set to true, you must also specify the parameters -adminUserName and -adminPassword along with the values for these parameters.
[Linux]-enableService true | false
[Linux]Enables the creation of a Linux service. Valid values include true or false. The default value for this parameter is false.

When the manageprofiles command is run with the -enableService option set to true , the Linux service is created with the profile when the command is run by the root user. When a non-root user runs the manageprofiles command, the profile is created, but the Linux service is not. The Linux service is not created because the non-root user does not have sufficient permission to set up the service. An INSTCONPARTIALSUCCESS result is displayed at the end of the profile creation and the profile creation log app_server_root/logs/manageprofiles_create_profilename.log contains a message indicating the current user does not have sufficient permission to set up the Linux service.

-getDefaultName
Returns the name of the default profile.
-getPath
Gets the file system location for a profile of a given name. Requires the -profileName parameter.
-getName
Gets the name for a profile registered at a given -profilePath 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 (Optional Parameter)
An optional parameter that is used with the -templatePath parameter to unaugment a particular profile that has been augmented. See the -unaugment parameter.
-importPersonalCertKS keystore_path
Specifies the path to the keystore file that you use to import a personal certificate when you create the profile. The personal certificate is the default personal certificate of the server.
Note: When you import a personal certificate as the default personal certificate, import the root certificate that signed the personal certificate. Otherwise, the manageprofiles command 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 you do not specifically create or import a personal certificate, one is created by default.

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

-importPersonalCertKSAlias keystore_alias
Specifies the alias of the certificate that is in the keystore file that you specify on the -importPersonalCertKS parameter. The certificate is added to the server default keystore file and is used as the server default personal certificate.

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

-importPersonalCertKSPassword keystore_password
Specifies the password of the keystore file that you specify on the -importPersonalCertKS parameter.

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

-importPersonalCertKSType keystore_type
Specifies the type of the keystore file that you specify 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 you specify any of the parameters that begin with -importPersonal, you must specify them all.

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

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

-importSigningCertKSAlias keystore_alias
Specifies the alias of the certificate that is in the keystore file that you specify on the -importSigningCertKS parameter. The certificate is added to the server default root keystore and is used as the server default root certificate.

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

-importSigningCertKSPassword keystore_password
Specifies the password of the keystore file that you specify on the -importSigningCertKS parameter.

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

-importSigningCertKSType keystore_path
Specifies the type of the keystore file that you specify 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 you specify any of the parameters that begin with -importSigning, you must specify them all.

-isDefault
Specifies that 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
Specifies that the server is intended for development purposes only. This parameter is useful when creating profiles to test applications on a nonproduction server before deploying the applications on their production application servers.

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.

-keyStorePassword keystore_password
Specifies the 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. You must specify the -profileName parameter with the -listAugments parameter.
-listProfiles
Lists the profiles that are in the profile registry.
-nodeName node_name
Specifies the 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.
[AIX Solaris HP-UX Linux Windows]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 (Optional Parameter)
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
    • deployIVTApplication
  • management - management profile for the administrative agent
    • deployAdminConsole
-personalCertDN distinguished_name
Specifies the distinguished name of the personal certificate that you are creating when you 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.
Avoid trouble:
  • [8.5.5.18 or later]To ensure that the subject alternative name (SAN) field is populated at profile creation, a certificate's subject DN must only contain characters that are letters, digits, and hyphens. If other characters are used then the profile fails to create. This criteria applies for fix packs, version 8.5.5.18 through version 8.5.5.19.
  • [8.5.5.20 or later]For fix pack, version 8.5.5.20+, you may specify a certificate subject DN that does not meet the above criteria, but doing so will result in an empty SAN field at profile creation.
-portsFile file_path (Optional Parameter)
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, 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.

-profileName profile_name
Specifies the 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
Specifies the fully qualified path to the profile, which is referred to as the profile_root.

[Windows]If the fully qualified path contains spaces, enclose the value in quotation marks.

[AIX Solaris HP-UX Linux Windows]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.
Note: The wasprofile.properties file includes the following properties with the exception of WS_WSPROFILE_USE_CHANNEL_FILELOCKS, which must be entered manually into the file:
WS_CMT_PI_MODPERMS
This property specifies if the post installer should modify the permissions of any files it creates. Valid values are true or false. Any other value defaults to false. Removing this property from the file also causes it to default to false. When set to false, any files created by the post installer have permission based on the umask setting of the system.

The value for this parameter must be a valid path for the target system and must not be currently in use.

[AIX Solaris HP-UX Linux Windows]You must have permissions to write to the directory.

WS_CMT_PI_LOGS
This property specifies if and when the post installer should clean up its logs for each product that is located in the PROFILE_HOME/properties/service/productDir directory. The settings for this property enable you to specify the following log cleanup criteria:
  • You can specify the number of logs you want to keep for each product in the PROFILE_HOME/properties/service/productDir directory. The specified value can be any integer between 1 and 999. For example, if you specify WS_CMT_PI_LOGS=5, the post installer keeps the five most recent logs for each product.
  • You can specify the maximum amount of storage the logs can occupy. The specified value can be any integer between 1 and 999, followed by:
    • KB, if you are specifying the value in kilobytes.
    • MB, if you are specifying the value in megabytes.
    • GB, if you are specifying the value in gigabytes.
    For example, if you specify WS_CMT_PI_LOGS=10MB, when the amount of storage the logs occupy exceeds 10 megabytes, the post installer starts deleting the oldest logs.
    Avoid trouble: Because the values specified are case sensitive, the letters included in the specified value must be capital letters.
  • You can specify the amount of time you want the post installer to keep the logs. The specified value can be any integer between 1 and 999, followed by:
    • D, if you are specifying the value in days.
    • W, if you are specifying the value inweeks.
    • M, if you are specifying the value in months.
    • Y, if you are specifying the value in years.
    For example, if you specify WS_CMT_PI_LOGS=2W, each log is kept for two weeks.
    Avoid trouble: Because the values specified are case sensitive, the letters included in the specified value must be capital letters.
  • You can specify a specific date after which a log is deleted. The value must be specified using numeric values, separated by dashes in the format DD-MM-YYYY. For example, if you specify WS_CMT_PI_LOGS=12-31-2013, all of the logs are deleted on December31, 2013.
    Avoid trouble: If you do not specify the value in the indicated format, numbers separated by dashes, this property setting is ignored.
WS_WSPROFILE_USE_CHANNEL_FILELOCKS
This property specifies how lock/unlock requests to the ProfilesMutex class are processed. Java™ non-blocking I/O (NIO) APIs are used to control the synchronization of the requests. Valid values are true or false. Any other value defaults to false. Removing this property from the wasprofile.properties file causes the property to default to false.

This property is useful where numerous multiple asynchronous manageprofiles command invocations are taking place and experiencing intermittent failures.

-response reponse_file
Accesses all API functions from the command line using the manageprofiles command.

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.

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 you create a response file, take into account the following set of guidelines:
  • When you specify values, do not specify double-quote (") characters at the beginning or end of a value, even if that value contains spaces.
    Note: This is a different rule than when you specify values on a command line.
  • When you specify a single value that contains 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 signingCertDN value with a distinguished name:
    signingCertDN=cn=testserver.ibm.com\\,ou=Root Certificate\\,
       ou=testCell\\,ou=testNode01\\,o=IBM\\,c=US 
  • When you 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=deployAdminConsole,defaultAppDeployAndConfig 
  • Do not specify a blank line in a response file. This can cause an error.
  • [Windows]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
Important: The manageProfiles -restoreProfile command is only supported with a backup created at the same fixpack level.
Restores a profile backup. Must be used with the -backupFile parameter, for example:
manageprofiles(.bat)(.sh) -restoreProfile -backupFile file_name
To restore a profile, perform the following steps:
  1. Stop the server and the running processes for the profile that you want to restore.
  2. Manually delete the directory for the profile from the file system.
  3. Run the -validateAndUpdateRegistry option of the manageprofiles command.
  4. Restore the profile by using the -restoreProfile option of the manageprofiles command.
Attention: manageProfiles -restoreProfile is best used to restore a profile on the same machine, host, or install. However, you can use -restoreProfile on another machine where the WebSphere Application Server is at the same service level as the source machine. In this case, ensure that the directory structure of the second machine is the same directory structure that existed on the source machine when the manageProfiles -restoreProfile command was used.
-serverName server_name
Specifies the name of the server. Specify this parameter only for the default and secureproxy templates. If you 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
Specifies the type of management profile. Specify ADMIN_AGENT for an administrative agent server. This parameter is required when you create a management profile.
[8.5.5.14 or later]Deprecated feature: The job manager is deprecated. Instead of job manager, use Urban Code Deploy to install the product, to deploy applications, and to manage remote hosts. To manage WebSphere Application Server installations, you also can use swinging profiles. See Swinging profiles between product installations.
[Linux]-serviceUserName service_user_ID
[Linux]Specify the user ID that is used during the creation of the Linux service so that 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(.bat)(.sh) -setDefaultName -profileName profile_name
-signingCertDN distinguished_name
Specifies the distinguished name of the root signing certificate that you create when you 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 you 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 (Optional Parameter)
An optional parameter that specifies the amount of time in years that the root signing certificate is valid. If you do not specify this parameter with the -signingCertDN parameter, the root signing certificate is valid for 15 years.
-startingPort startingPort
Specifies the starting port number for generating and assigning all ports for the profile.

[AIX Solaris HP-UX Linux Windows]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, 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.

Attention: Do not use this parameter if you are using the managed profile template.
-templatePath template_path
Specifies the 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. You can specify profile templates that lie outside the installation root, if you happen to have any.

[AIX Solaris HP-UX Linux Windows]You 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. 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, you must specify the -unaugment parameter and the -profileName parameter. If a series of manageprofiles augmentations were performed, and you 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 you must ensure that you are not violating profile template dependencies.

[AIX Solaris HP-UX Linux Windows]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.

[AIX Solaris HP-UX Linux Windows]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.

Note: If you use this parameter when you 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 that are 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.
-validatePorts
Specifies that the ports 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. You can use this parameter at any time on the create command line. It is recommended that you use this parameter with the -portsFile parameter.
-validateRegistry
Checks all of the profiles that are listed in the profile registry to see if the profiles are present on the file system. Returns a list of missing profiles.
-webServerCheck true | false
Indicates if you want 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:
[Windows]
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”
[Linux]
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”
[AIX]
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”
[HP-UX]
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”
[Solaris]
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 that 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.
[Windows]-winserviceAccountType specifieduser | localsystem
[Windows]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.

[Windows]-winserviceCheck true | false
[Windows]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.
Important: With a custom profile, you cannot create a Windows service with this parameter. Instead, use the WASService command to create the service separately.
[Windows]-winservicePassword winservice_password
[Windows]Specify the password for the specified user or the local account that is to own the Windows service.
[Windows]-winserviceStartupType manual | automatic | disabled
[Windows]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.

[Windows]-winserviceUserName winservice_user_ID
[Windows]Specify your user ID so that 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 that you specify must have the proper permissions to create a Windows service. You must specify the correct password for the user name that you choose.
Important: When you create a profile with a Windows services with a specified user and password and the user is a domain user, you must use a double backslash as shown in the following example:
winServiceUserName=DOMAIN\\DOMAINUSER
winServicePassword=DOMAINUSERPASSWORD

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.

  • Creating an application server profile

    Create an application server profile named Default01 with the following command.

    [Windows]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
    
    [AIX HP-UX Solaris][Linux]
    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

Logs

The manageprofiles command creates a log for every profile that it creates.
  • [AIX Solaris HP-UX Linux Windows]The logs are in the app_server_root/logs/manageprofiles directory. The files are named in this pattern: profile_name_create.log.
  • [AIX Solaris HP-UX Linux Windows]The command also creates a log for every profile that it deletes. The logs are in the app_server_root/logs/manageprofiles directory. The files are named in this pattern: profile_name_delete.log.

Example: Incrementing default port numbers from a starting point

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
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 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][AIX][Solaris][HP-UX]
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 you do not explicitly set port values. You can use predefined port values instead.

The manageprofiles command recommends port values when the options of -defaultPorts, -startingPort, or -portsFile are not specified.
Table 1. 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 that you want 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
    • [AIX HP-UX Solaris]/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 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:
    [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 
    [Linux][AIX]
    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 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

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.