[AIX HP-UX Linux Solaris Windows]This topic applies only on the i5/OS operating system.

manageprofiles command

The manageprofiles command line tool creates all application server runtime environments. The command creates a profile, which is the set of files that define the runtime environment for a deployment manager, a custom profile, or a stand-alone application server.

The manageprofiles command creates the runtime environment for a WebSphere Application Server process in a set of files called a profile. The profile defines the runtime environment and includes all of the files that the server processes in the runtime environment can change.

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

For more information about where to run this command, see Using command line tools.
Note: The Feature Pack for Web Services does not have a managed profile template. This feature pack has a deployment manager and application server template only. For more information, see "Profile augmentation rules and limitations for feature packs."
[AIX HP-UX Linux Solaris Windows] [Fix Pack 9 or later]
[This information only applies to Version 6.1.0.9 and later running on the Microsoft Windows Vista operating system.] [Fix Pack 9 or later] Notes on running the manageprofiles command on Microsoft® Windows Vista™ and Windows 2008 operating systems:
  • [This information only applies to Version 6.1.0.9 and later running on the Microsoft Windows Vista operating system.] After installing WebSphere® Application Server Version 6.1 on your Microsoft® Windows® Vista operating system, you should install a service pack containing Version 6.1.0.9 or later before attempting to create any profiles using the manageprofiles command.
    If you are running Version 6.1.0.9 or later on the Microsoft Windows Vista operating system, you must run the manageprofiles command with elevated Administrator privileges. To run the manageprofiles with Administrator privileges, run it from a Command Prompt window that is launched by performing the following actions:
    • Right-click a Command Prompt shortcut.
    • Click Run As Administrator.
  • After installing WebSphere Application Server Version 6.1 on your Microsoft Windows 2008 operating system, you should install a service pack containing Version 6.1.0.17 or later before attempting to create any profiles using the manageprofiles command.
    If you are running Version 6.1.0.17 or later on the Microsoft Windows 2008 operating system, you must run the manageprofiles command with elevated Administrator privileges. To run the manageprofiles with Administrator privileges, run it from a Command Prompt window that is launched by performing the following actions:
    • Right-click a Command Prompt shortcut.
    • Click Run As Administrator.

Syntax

The manageprofiles command is used to perform the following:
  • create a profile (-create)
  • delete a profile (-delete)
  • augment a profile (-augment)
  • unaugment a profile (-unaugment)
  • delete all profiles (-deleteAll)
  • list all profiles (-listProfiles)
  • 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)
  • set the default profile name (-setDefaultName)
  • backup a profile (-backupProfile)
  • restore a profile (-restoreProfile)
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
The output from the help command will specify which parameters are required and which are optional.

Depending on the operation that you want to perform with the manageprofiles command, you will need to provide one or more of the following parameters. The command line profile management 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 profile management tool does not validate the case of the parameter name. Incorrect results can occur when the parameter case is not typed correctly.

  • -profileName profile_name
  • -profilePath profile_root
  • -templatePath template_path
  • -nodeName node_name
  • -cellName cell_name
  • -hostName host_name
  • [iSeries] -serverName server_name
  • -adminUserName adminUser_ID
  • -adminPassword adminPassword
  • -appServerNodeName application_server_node_name
  • -backupFile backupFile_name
  • -dmgrProfilePath dmgr_profile_path
  • -dmgrHost dmgr_host_name
  • -dmgrPort dmgr_port_number
  • -debug
  • -enableAdminSecurity true | false
  • -federateLater true | false
  • -isDefault
  • -isDeveloperServer
  • -nodeDefaultPorts
  • -nodePortsFile node_ports_path
  • -nodeProfilePathnode_profile_path
  • -omitAction feature1 feature2... featureN
  • -response reponse_file
  • -samplesPassword samplesPassword
  • -startingPort starting_port | -portsFile file_path | -defaultPorts
  • -validatePorts
  • -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
  • [Linux] -enableService true | false
  • [Linux] -serviceUserName service_user_ID
  • [Windows] -winserviceCheck true | false
  • [Windows] -winserviceAccountType specifieduser | localsystem
  • [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:

-adminUserName adminUser_ID
Specify the user ID that is used for administrative security.
-adminPassword adminPassword
Specify the password for the administrative security user ID specified with the -adminUserName parameter.
-appServerNodeName application_server_node_name
Specifies the node name of the application server that you are federating into the cell. Specify this parameter when you create the deployment manager portion of the cell and when you create the application server portion of the cell.
-augment
Use the augment parameter to make changes to an existing profile with an augmentation template. The augment parameter causes the manageprofiles command to update or augment the profile identified in the -profileName parameter 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.
Note: The templates that are included with WebSphere Application Server can only be used to create profiles and not to augment existing profiles because only create templates are shipped with the product.

New or updated for this feature pack However, if you applied a feature pack that allows profile augmentation, then you can augment a profile based on the particular feature pack rules.

Also, do not manually modify the files that are located in the install_dir/ profileTemplates directory. For example, if you are changing the ports during profile creation, use the Profile Management tool or the -startingPort or -portsFile arguments on the manageprofiles command instead of modifying the file in the profile template directory.

[AIX HP-UX Linux Solaris Windows] Specify the fully qualified file path for -templatePath. For example:
 manageprofiles(.bat)(.sh) -augment -profileName profile_name -templatePath fully_qualified_template_path

[AIX HP-UX Linux Solaris Windows] Specifying a relative file path for the -templatePath parameter results in the specified profile not being fully augmented.

[iSeries] You 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. For example:
 manageprofiles -augment -profileName profile_name -templatePath template_path

See also the -unaugment parameter.

-backupProfile
Performs a file system back up 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.

-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.
-cellName cell_name
Specifies the cell name of the profile. Use a unique cell name for each profile.

Use a unique name even though you plan to federate the custom profile or stand alone profile into a deployment manager cell. Federation requires unique cell names before it can make the node part of the deployment manager cell. A cell name must be unique whenever the product is running on the same physical machine or cluster of machines, such as a sysplex. Additionally, a cell name must be unique when network connectivity between entities is required either between the cells or from a client that must communicate with each of the cells. Cell names also must be unique if you want to federate their name spaces. Otherwise, you might encounter errors such as a javax.naming.NameNotFoundException exception. In which case, you need to create uniquely named cells.

[AIX HP-UX Linux Solaris Windows] The default value for this parameter is based on a combination of the short host name, the constant cell, and a trailing number, for example:
if (DMgr)
	shortHostNameCellCellNumber
else
	shortHostNameNodeNodeNumberCell
where CellNumber is a sequential number starting at 01 and NodeNumber is the node number that you used to define the node name.
[iSeries] The default node names are as follows:
  • dmgr template: profilenameNetwork
  • default template: shorthostname_profilename
  • managed template: shorthostname_profilename
  • cell template: Same as the previous dmgr example for the two profiles that are created.

The value for this parameter must not contain spaces or any 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:
  • cell - Deployment manager cell (dmgr and default)
  • dmgr - Deployment manager
  • default - Application server
  • managed - Custom
-debug
Turns on the debug function of the Ant utility, which the manageprofiles command uses.
-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.

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

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

[iSeries] The profile directory is deleted when you delete the profile so that you can recreate the profile without having to manually delete the directory.

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

Avoid trouble Avoid trouble: If you are deleting the profile for an old node that has been migrated, you must shut down the new migrated deployment manager before you delete the profile for the old node. This action ensures that the profile for the new migrated node is not accidentally removed from the new migrated cell. gotcha
-deleteAll
Deletes all registered profiles.

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

[iSeries] The directory for the profile is deleted when you delete the profile so that when you recreate the profile, you do not have outdated information to manage.

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

-dmgrHost dmgr_host_name
Identifies the machine where the deployment manager is running. Specify this parameter and the dmgrPort parameter to federate a custom profile as it is created.

The host name can be the long or short DNS name or the IP address of the deployment manager machine.

Specifying this optional parameter directs the manageprofiles command to attempt to federate the custom node into the deployment manager cell as it creates the custom profile. This parameter is ignored when creating a deployment manager profile or an Application Server profile.

If you federate a custom node when the deployment manager is not running or is not available because of security being enabled or for other reasons, the installation indicator in the logs is INSTCONFFAIL to indicate a complete failure. The resulting custom profile is unusable. You must move the custom profile directory out of the profile repository (the profiles installation root directory) before creating another custom profile with the same profile name.

If you have enabled security or changed the default JMX connector type, you cannot federate with the manageprofiles command. Use the addNode command instead.

The default value for this parameter is localhost. The value for this parameter must be a properly formed host name and must not contain spaces or characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, |, and so on. A connection to the deployment manager must also be available in conjunction with the dmgrPort parameter.

-dmgrPort dmgr_port_number
Identifies the SOAP port of the deployment manager. Specify this parameter and the dmgrHost parameter to federate a custom profile as it is created. The deployment manager must be running and accessible.

If you have enabled security or changed the default JMX connector type, you cannot federate with the manageprofiles command. Use the addNode command instead.

The default value for this parameter is 8879. The port that you indicate must be a positive integer and a connection to the deployment manager must be available in conjunction with the dmgrHost parameter.

-dmgrProfilePath dmgr_profile_path
Specifies the profile path to the deployment manager portion of the cell. Specify this parameter when you create the application server portion of the cell.
-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. If samples were installed during the application server install, you must also specify the -samplesPassword parameter when creating a profile for which administrative security is enabled. If the -samplesPassword parameter is not specified when administrative security is enabled, the profile is created successfully, but when you attempt to run the samples, exceptions and failures will be put in the server system out log.
-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.

-federateLater true | false
Indicates if the managed profile will be federated during profile creation or if you will federate it later using the addNode command. If the dmgrHost, dmgrPort, dmgrAdminUserName and dmgrAdminPassword parameters do not have values, the default value for this parameter is true. Valid values include true or false.
-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 that is used with the -templatePath parameter to unaugment a particular profile that has been augmented. See the -unaugment parameter.
-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 whether the server is intended for development purposes only. This parameter is useful when creating profiles to test applications on a non-production server prior to deploying the applications on their production application servers.
-listProfiles
Lists all defined profiles.
-nodeDefaultPorts
Defines a set of ports when creating a profile in conjunction with a cell template. If you specify this option, you cannot specify the -nodePortsFile or nodeStartingPort options at the same time.
-nodePortsFile node_ports_path
Specifies ports for the node portion of the cell that you are creating. If you specify this option, you cannot specify the -nodeDefaultPorts or -nodeStartingPort options at the same time.
-nodeProfilePath node_profile_path
Specifies the profile path to the node portion of the cell. Specify this parameter when you create the deployment manager portion of the cell.
-nodeName node_name
Specifies the node name for the node that is created with the new profile. Use a unique value within the cell or on the machine. Each profile that shares the same set of product binaries must have a unique node name.
[AIX HP-UX Linux Solaris Windows] The default value for this parameter is based on the short host name, profile type, and a trailing number, for example:
if (DMgr)
	shortHostNameCellManagerNodeNumber
else
	shortHostNameNodeNodeNumber
where NodeNumber is a sequential number starting at 01.
[iSeries] The default node names are as follows:
  • dmgr template: profilenameManager
  • default template: shorthostname_profilename
  • managed template: shorthostname_profilename
  • cell: See the previous dmgr and default template examples and apply as appropriate to the two profiles that are created.

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 samplesInstallAndConfig option is only available when WebSphere Application Server is installed with samples applications selected. The following optional features can be used with the -omitAction parameter for the following profile templates:
  • default - Application server
    • deployAdminConsole
    • samplesInstallAndConfig
    • defaultAppDeployAndConfig
  • dmgr - Deployment manager
    • deployAdminConsole
  • cell - Deployment manager cell which is composed of both a dmgr and a default profile template
    • cell_dmgr (dmgr created during cell profile creation)
      • deployAdminConsole
      • samplesInstallAndConfig
      • defaultAppDeployAndConfig
-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, 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:
profileType ProfileNumber
where profileType is a value such as AppSrv, Dmgr, or Custom and ProfileNumber 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 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 throughout the information center as the profile_root.
Specify the full path to avoid an ANT scripting limitation that can cause a failure when federating the profile into a cell. For example:
-profilePath profile_root

[Windows] 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 file.

[iSeries] The default value is based on the user_data_root directory, the profiles subdirectory, and the name of the file.

For example, the default is:
WS_WSPROFILE_DEFAULT_PROFILE_HOME/profileName
where WS_WSPROFILE_DEFAULT_PROFILE_HOME 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.

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

[iSeries] The QEJBSVR profile must have permissions to write to the directory.

-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. The following is an example response file for a create operation:
create
profileName=testResponseFileCreate
profilePath=profile_root
templatePath=app_server_root/profileTemplates/default
nodeName=myNodeName
cellName=myCellName
hostName=myHostName
omitAction=myOptionalAction1, myOptionalAction2
[Updated in April 2012] 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 personalCertDN 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=samplesInstallAndConfig,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
    
[Updated in April 2012]
apr2012
-restoreProfile
Restores the given profile backup to its previous location. This option is not supported on remote machines. 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. Manually delete the directory for the profile from file system.
  2. Run the -validateAndUpdateRegistry option of the manageprofiles command.
  3. Stop the server and the running processes for the profile that you want to restore.
  4. Restore the profile by using the -restoreProfile option of the manageprofiles command.
-samplesPassword samplesPassword
Creates a password to be used for samples. The password is used to restrict access to web application samples installed during the install of the application server.
-serverName server_name [iSeries]
Specifies the name of the server. If you do not specify this parameter, the default server name is the name of the profile that contains the server.
-serviceUserName service_user_ID [Linux]
Specify the user ID that is used during the creation of the Linux service so that the Linux service will run under 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
-startingPort startingPort
Specifies the starting port number for generating and assigning all ports for the profile.

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

[iSeries] Port values are assigned sequentially from the -startingPort value.

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

During profile creation, the manageprofiles command uses an automatically generated set of recommended ports if you do not specify the -startingPort parameter, the -defaultPorts parameter or the -portsFile parameter. The recommended port values can be different than the default port values based on the availability of the default ports.

Note: 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 HP-UX Linux Solaris Windows] Use absolute paths. This parameter must exist as a directory and point to a valid template directory.

[iSeries] The default template path is app_server_root/profileTemplates/default. You can use a relative path for the -templatePath parameter. The path is relative to the current working directory or to app_server_root/profileTemplates, in that order. The following example creates a profile based on the default for a stand-alone application server:
manageprofiles -create -profileName MyProfile -startingPort 10380
The following example creates a profile for a stand-alone application server for the Feature Pack for Web Services.New or updated for this feature pack
manageprofiles -create -profileName myWebSvcProfile -templatePath WEBSERVICES/default.wsfep
-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 as you must ensure that you are not violating profile template dependencies.

[AIX HP-UX Linux Solaris Windows] When using the -templatePath parameter, specify the fully qualified file path for the parameter.

[iSeries] When using the -templatePath parameter, you can specify a relative file path for the parameter.

See also the augment 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.
-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.
-validatePorts
Specifies 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 to use this parameter with the –portsFile parameter.
-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”
[iSeries]
webServerType=IHS: webServerInstallPath defaulted to “n\a”
webServerType=IIS: webServerInstallPath defaulted to “n\a”
webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “n\a”
webServerType=DOMINO: webServerInstallPath defaulted to “n\a”
webServerType=APACHE: webServerInstallPath defaulted to “n\a”
webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n\a”
-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.
-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 system.
-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.
-winservicePassword winservice_password [Windows]
Specify the password for the specified user or the local account that is to own the Windows service.
-winserviceStartupType manual | automatic | disabled [Windows]
Possible startup_type values are:
  • manual
  • automatic
  • disabled

See WASService command for more information about Windows services.

The default value for this parameter is automatic.

-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:
  • Act 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.

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 a deployment manager profile

The following example uses the dmgr template to create a deployment manager profile named Dmgr001. The deployment manager ports start at port 20000.[Linux] [AIX HP-UX Solaris]
app_server_root/bin/manageprofiles.sh -create 
   -profileName Dmgr001
   -profilePath profile_root
   -templatePath app_server_root/profileTemplates/dmgr
   -nodeName Dmgr001Node
   -cellName Dmgr001NodeCell
   -hostName localhost
   -isDefault
   -startingPort 20000
[Windows]
app_server_root\bin\manageprofiles.bat -create 
   -profileName Dmgr001
   -profilePath profile_root
   -templatePath app_server_root\profileTemplates\dmgr
   -nodeName Dmgr001Node
   -cellName Dmgr001NodeCell
   -hostName localhost
   -isDefault
   -startingPort 20000
[iSeries]
manageprofiles -create 
   -profileName Dmgr001
   -profilePath profile_root
   -templatePath dmgr
   -startingPort 20000

Creating a custom profile

Federate a custom profile to customize the profile with the deployment manager.

Create a custom profile for federating into a deployment manager cell with the following command:

[Windows]
c:\WebSphere\AppServer\bin manageprofiles -create
				-profileName Custom01
				-profilePath profile_root
				-templateParh app_server_root\profileTemplates\managed
				-nodeName CustomNode01
				-cellName CustomNodeCell01
				-hostName myhost.mycity.mycompany.com
				-isDefault 
				-dmgrHost myhost.mycity.mycompany.com
				-dmgrPort 8879
				-startingPort 22000
[Linux] [AIX HP-UX Solaris]
app_server_root/bin/manageprofiles.sh -create 
   -profileName Custom01
   -profilePath profile_root
   -templatePath app_server_root/profileTemplates/managed
   -nodeName Custom01Node
   -cellName Custom01Cell
   -hostName myhost.mycity.mycompany.com
   -isDefault
   -startingPort 22000
[iSeries]
manageprofiles -create 
   -profileName Custom01 
   -templatePath managed 
   -startingPort 22000

Creating an application server profile

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

[Windows]
app_server_root\bin manageprofiles -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
[Linux] [AIX HP-UX Solaris]
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
[iSeries]
manageprofiles -create 
   -profileName Default01 
   -templatePath default 
   -startingPort 21000

Creating a cell profile

Creating a cell profile requires the creation of both the deployment manager and the application server portion of the cell profile. The two profiles are linked and some parameters must match between the creation parameters of the deployment manager and the application server portion of the cell profile. For more detailed information regarding creating a cell profile, see Example: Creating a cell profile with the manageprofiles command.

The following example shows the creation of a cell profile named Dmgr001 having a cell name of Default01Cell and a node name of Default01Node. To create a full working cell, the -nodeProfilePath, -cellName, -appServerNodeName, -nodeName parameters are required to match between the cell_dmgr profile and the cell_node profile.
  1. Create the deployment manager portion of the cell profile.
    [Windows]
    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 Default01Node
    [Linux] [HP-UX] [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 Default01Node
    
    [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 Default01Node
    
  2. Create the application server portion of the cell profile.
    [Windows]
    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 Default01Node
    
    [Linux] [HP-UX] [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 Default01Node
    
    [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 Default01Node
    

Logs

The manageprofiles command creates a log for every profile that it creates.
  • [AIX HP-UX Linux Solaris Windows]

    The logs are in the app_server_root/logs/manageprofiles directory. The files are named in this pattern: profile_name_create.log.

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

  • [iSeries]

    The logs are in the user_data_root/profileRegistry/logs/manageprofiles directory. The files are named in this pattern: profile_name_create.log.

  • [iSeries]

    The command also creates a log for every profile that it deletes. The logs are in the user_data_root/profileRegistry/logs/manageprofiles directory. The files are named in this pattern: profile_name_delete.log.




Subtopics
Example: Creating a deployment manager profile
[AIX HP-UX Linux Solaris Windows] Example: Creating a deployment manager profile in a multiuser environment
Example: Creating a cell profile with the manageprofiles command
Example: Deleting profiles
Example: Using predefined port numbers
Example: Incrementing default port numbers from a starting point
Related tasks
Deleting a profile
Creating, deleting, and augmenting profiles
Setting up and using the profile environment through commands
Creating customized CIP profiles
Related reference
[Windows] [Linux] WASService command
Related information
Using command line tools
Augmentation rules and limitations for feature packs on non-z/OS operating systems
Reference topic Reference topic    

Terms and conditions for information centers | Feedback

Last updatedLast updated: Aug 31, 2013 1:23:07 AM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=pix&product=was-nd-dist&topic=rxml_manageprofiles
File name: rxml_manageprofiles.html