WAS v8.0 > Migration and coexistence > Distributed operating systems > Scenario 4: Flexible Management: Migrating a job manager profile and its registered set of servers > 2. Create the target job manager profile


manageprofiles command

Use the manageprofiles command to create, delete, augment, back up, and restore profiles, which define runtime environments. Using profiles instead of multiple product installations saves disk space and simplifies updating the product because a single set of core product files is maintained.

The manageprofiles command and its graphical user interface, the Profile Management Tool, are the only ways to create runtime environments.

The command file is located in...

WAS_HOME/bin
The command file is a script named manageprofiles.

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.

The manageprofiles command is used to perform the following tasks:

For detailed help including the required parameters for each of the tasks accomplished with the manageprofiles command, use the -help parameter. The following example uses the help parameter with the manageprofiles -augment command on Windows operating systems: 

WAS_HOME\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 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 entered for those parameters are valid. Be sure to type the name of the parameters with the correct upper and lower case as the command-line tool does not validate the case of the parameter name. Incorrect results can occur when the parameter case is not typed correctly.

The following example uses the manageprofiles -create command on operating systems such as AIX or Linux: 

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

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

Node name of the application server that you are federating into the cell. Specify when creating the dmgr 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 the environment.

The templates that are included with the WAS Network Deployment 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. For example, if you are changing the ports during profile creation, use the -startingPort or -portsFile arguments on the manageprofiles command instead of modifying the file in the profile template directory.

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 WAS_HOME/profileTemplates directory. Otherwise, specify the fully qualified template path. For example: 

 manageprofiles -augment -profileName profile_name -templatePath template_path

See also the -unaugment parameter.

-backupProfile

Performs a file system backup of a profile folder and the profile metadata from the profile registry file. Any servers using the profile to back up must first be stopped prior to invoking 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, first stop the server and the running processes for the profile to back up.

-backupFile backupFile_name

Backs up the profile registry file to the specified file. We must provide a fully qualified file path for the backupFile_name.

-cellName cell_name

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

Use a unique name even though you plan to federate the custom profile or stand alone profile into a dmgr cell. Federation requires unique cell names before it can make the node part of the dmgr cell. A cell name must be unique in any circumstance in which the product is running on the same physical machine or cluster of machines, such as a sysplex. Additionally, a cell name must be unique in any circumstance in which network connectivity between entities is required either between the cells or from a client that must communicate with each of the cells. Cell names must also be unique if their namespaces are federated. Otherwise, you might encounter symptoms such as a javax.naming.NameNotFoundException error, in which case, create uniquely named cells.

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
  • Custom profile: Not any
  • Management profile with the dmgr server: shortHostNameCellCellNumber
  • Management profile with the job manager server: shortHostNameJobMgrCellCellNumber
  • Management profile with the admin agent server: shortHostNameAACellCellNumber
  • Cell profile, application server portion: shortHostNameCellCellNumber
  • Cell profile, dmgr portion: shortHostNameCellCellNumber
  • Secure proxy profile: Not any

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:

  • cell - Deployment manager cell (dmgr and default)
  • management - Management. Use in conjunction with the -serverType parameter to indicate the type of management profile.
  • secureproxy- Secure proxy
  • default - Application server
  • managed - Custom

-debug

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

-personalCertValidityPeriod validity_period

An optional parameter that specifies the amount of time in years that the default personal certificate is valid. If not specified 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.

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

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.

Avoid trouble: If you are deleting an old node that has been migrated, shut down the new migrated dmgr before deleting the old node. This will ensure that the new migrated node is not accidentally removed from the new migrated cell.

-deleteAll

Deletes all registered profiles.

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

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.

-dmgrAdminPassword password

If you are federating a node, specify a valid user name for a dmgr if administrative security is enabled on the dmgr. Use this parameter with the -dmgrAdminUserName parameter and the -federateLater parameter.

-dmgrAdminUserName user_name

If you are federating a node, specify a valid password for a dmgr if administrative security is enabled on the dmgr. Use this parameter with the -dmgrAdminPassword parameter and the -federateLater parameter.

-dmgrHost dmgr_host_name

Identifies the machine where the dmgr 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 dmgr machine.

Specify this optional parameter directs the manageprofiles command to attempt to federate the custom node into the dmgr cell as it creates the custom profile with the managed -templatePath parameter. The -dmgrHost parameter is ignored when creating a dmgr profile or an Application Server profile.

If you federate a custom node when the dmgr 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. We 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 we 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 dmgr must also be available in conjunction with the dmgrPort parameter.

-dmgrPort dmgr_port_number

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

If we have enabled security or changed the default Java Management Extensions (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 dmgr must be available in conjunction with the dmgrHost parameter.

-dmgrProfilePath dmgr_profile_path

Profile path to the dmgr portion of the cell. Specify when creating 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, also specify the parameters -adminUserName and -adminPassword along with the values for these parameters.

We cannot use the -enableAdminSecurity parameter to enable administrative security for a custom profile. For security to be enabled for a custom profile, the custom profile must be federated into a dmgr. Administrative security enabled for the dmgr is required to enable security for the federated custom profile.

-enableService true | false

Enable 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 WAS_HOME/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

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

-ignoreStack

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

-importPersonalCertKS keystore_path

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

Best practice: When you import a personal certificate as the default personal certificate, import the root certificate that signed the personal certificate. Otherwise, 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, specify them all.

-importPersonalCertKSType keystore_type

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, specify them all.

-importPersonalCertKSPassword keystore_password

Password of the keystore file that you specify on the -importPersonalCertKS parameter.

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

-importPersonalCertKSAlias keystore_alias

Alias of the certificate that is in the keystore file 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, specify them all.

-importSigningCertKS keystore_path

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, specify them all.

-importSigningCertKSType keystore_path

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, specify them all.

-importSigningCertKSPassword keystore_password

Password of the keystore file that you specify on the -importSigningCertKS parameter.

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

-importSigningCertKSAlias keystore_alias

Alias of the certificate that is in the keystore file 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, 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 non-production 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.

-applyPerfTuningSetting option

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

This parameter is only valid for the default profile template.

standard

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

production

The production performance settings are optimized for a production environment where application changes are rare and optimal runtime performance is important.

development

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

Do not use the development settings for production servers.

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

-keyStorePassword keystore_password

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

-listAugments

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

-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

Profile path to the node portion of the cell. Specify this parameter when you create the dmgr portion of the cell.

-nodeName node_name

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.

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

  • Application server profile: shortHostNameNodeNodeNumber
  • Custom profile: shortHostNameNodeNodeNumber
  • Management profile with the dmgr server: shortHostNameCellManagerNodeNumber
  • Management profile with the job manager server: shortHostNameJobMgrNodeNumber
  • Management profile with the admin agent server: shortHostNameAANodeNodeNumber
  • Cell profile, application server portion: shortHostNameNodeNodeNumber
  • Cell profile, dmgr portion: shortHostNameCellManagerNodeNumber
  • Secure proxy profile: shortHostNameNodeNodeNumber

where NodeNumber is a sequential number starting at 01.

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

-omitAction feature1 feature2... featureN

An optional parameter that excludes profile features.

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

  • default - Application server

    • deployAdminConsole
    • defaultAppDeployAndConfig

  • management - Management profile for the dmgr, admin agent, or job 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
      • defaultAppDeployAndConfig

-personalCertDN distinguished_name

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.

-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

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, Dmgr, AdminAgent, JobMgr, or Custom
  • <profile_number> is a sequential number that creates a unique profile name

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

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

-profilePath PROFILE_ROOT

Fully qualified path to the profile, which is referred to as the PROFILE_ROOT.

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

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

The default value is based on the WAS_HOME 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...

WAS_HOME/properties

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

We 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. Use the following example response file to run a create operation: 

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

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
The best practice is to use forward slashes in order to reduce the chance of errors when switching between platforms.

To determine which input arguments are required for the various types of profile templates and action, use the manageprofiles command with the -help parameter.

-restoreProfile

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

-securityLevel security_level

Initial security level settings for the secure proxy server. Valid values are low, medium, and high. The default value is high. The security level is based on startup user permissions, routing considerations, administration options, and error handling. We can optionally change the security settings after you create the secure proxy server profile.

-serverName server_name

Name of the server. Specify this parameter only for the default and secureproxy templates. If not specified 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 DEPLOYMENT_MANAGER | ADMIN_AGENT | JOB_MANAGER

Type of management profile. Specify DEPLOYMENT_MANAGER for a dmgr server, ADMIN_AGENT for an administrative agent server, or JOB_MANAGER for a job manager server. This parameter is required when you create a management profile.

-serviceUserName service_user_ID

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

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

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

-startingPort startingPort

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

Port values are assigned sequentially from the -startingPort value, omitting those ports that are already in use. The system recognizes and resolves ports that are currently in use and determines the port assignments to avoid port conflicts.

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

During profile creation, 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.

-supportedProtocols supported_protocols

Protocols that are valid for the secure proxy server to proxy requests. Valid values are SIP, HTTP, and HTTP,SIP.

-templatePath template_path

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

We can specify a relative path for the -templatePath parameter if the profile templates are relative to theWAS_HOME/profileTemplates directory. Otherwise, specify the fully qualified template path. F

-unaugment

Augmentation is the ability to change an existing profile with an augmentation template.

To unaugment a profile that has been augmented, specify the -unaugment parameter and the -profileName parameter. If a series of manageprofiles augmentations were performed, and 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 ensure that you are not violating profile template dependencies.

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

See also the augment parameter.

-unaugmentAll

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

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

Optionally, specify the -unaugmentDependents parameter with the -unaugmentAll parameter to unaugment all profiles that are prerequisites of the profiles that are being unaugmented.

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

See also the augment parameter.

-unaugmentDependents true | false

If set to true, the parameter unaugments all the augmented profiles that are prerequisites to the profiles being unaugmented with the -unaugmentAll parameter. The default value for this parameter is false.

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

-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

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

-webServerCheck true | false

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

-webServerHostname webserver_host_name

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

-webServerInstallPath webserver_installpath_name

The installation path of the web server, local or remote. The default value for this parameter is dependent on the operating system of the local machine and the value of the webServerType parameter. For example: 
webServerType=IHS: webServerInstallPath defaulted to “C:\IBM\HTTPServer”
webServerType=IIS: webServerInstallPath defaulted to “C:\”
webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “C:\”
webServerType=DOMINO: webServerInstallPath defaulted to “”
webServerType=APACHE: webServerInstallPath defaulted to “”
webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”

webServerType=IHS: webServerInstallPath defaulted to “/opt/IBM/HTTPServer”
webServerType=IIS: webServerInstallPath defaulted to “n\a”
webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “/opt/sun/webserver”
webServerType=DOMINO: webServerInstallPath defaulted to “”
webServerType=APACHE: webServerInstallPath defaulted to “”
webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”


webServerType=IHS: webServerInstallPath defaulted to “/usr/IBM/HTTPServer”
webServerType=IIS: webServerInstallPath defaulted to “n\a”
webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “/opt/sun/webserver”
webServerType=DOMINO: webServerInstallPath defaulted to “?”
webServerType=APACHE: webServerInstallPath defaulted to “?”
webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”

webServerType=IHS: webServerInstallPath defaulted to “/opt/IBM/HTTPServer”
webServerType=IIS: webServerInstallPath defaulted to “n\a”
webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “/opt/sun/webserver”
webServerType=DOMINO: webServerInstallPath defaulted to “”
webServerType=APACHE: webServerInstallPath defaulted to “”
webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”

webServerType=IHS: webServerInstallPath defaulted to “/opt/IBM/HTTPServer”
webServerType=IIS: webServerInstallPath defaulted to “n\a”
webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “/opt/sun/webserver”
webServerType=DOMINO: webServerInstallPath defaulted to “”
webServerType=APACHE: webServerInstallPath defaulted to “”
webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”

-webServerName webserver_name

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

-webServerOS webserver_operating_system

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

-webServerPluginPath webserver_pluginpath

The path to the plug-ins 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

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 if not specified.

-winserviceCheck true | false

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

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

-winservicePassword winservice_password

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

-winserviceStartupType manual | automatic | disabled

Possible startup_type values are:

  • manual
  • automatic
  • disabled

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

The default value for this parameter is automatic.

-winserviceUserName winservice_user_ID

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


Logs

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


Example: Creating dmgr profiles

We can create a dmgr profile after installing your core product files. The dmgr provides a single administrative interface to a logical group of application servers on one or more machines. Use the manageprofiles.sh -create command to create a dmgr profile.

To create a dmgr profile named shasti: 

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


manageprofiles.bat -create
              -profileName shasti
              -profilePath C:\shasti\WebSphere
              -templatePath C:\IBM\WebSphere\AppServer\profileTemplates\management
              -serverType DEPLOYMENT_MANAGER
              -cellName cell1
              -hostName planetnt
              -nodeName dmgr1

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

If you do not specify one of the port options during profile creation, a recommended set of port values will be used. The port conflict resolution algorithm determines these ports. The recommended set of ports must be free of conflict. To use the IBM default ports, use the -defaultPorts option when you create a profile.


Example: Incrementing default port numbers from a starting point

The manageprofiles command can assign port numbers based on a starting port value. We can provide the starting port value from the command line, using the -startingPort parameter. The command assigns port numbers sequentially from the starting port number value. However, if a port value in the sequence conflicts with an existing port assignment, the next available port value is used

The order of port assignments is arbitrary. Predicting assignments is not possible.

For example, ports created with -startingPort 20002 would appear similar to the following example:

Assigned ports for an application server profile 

WC_defaulthost=20002
WC_adminhost=20003
WC_defaulthost_secure=20004
WC_adminhost_secure=20005
BOOTSTRAP_ADDRESS=20006
SOAP_CONNECTOR_ADDRESS=20007
IPC_CONNECTOR_ADDRESS=20008
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20009
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20010
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20011
ORB_LISTENER_ADDRESS=20012
CELL_DISCOVERY_ADDRESS=20013
NODE_MULTICAST_DISCOVERY_ADDRESS=20014
NODE_IPV6_MULTICAST_DISCOVERY_ADDRESS=20015
NODE_DISCOVERY_ADDRESS=20016
DCS_UNICAST_ADDRESS=20017
SIB_ENDPOINT_ADDRESS=20018
SIB_ENDPOINT_SECURE_ADDRESS=20019
SIB_MQ_ENDPOINT_ADDRESS=20020
SIB_MQ_ENDPOINT_SECURE_ADDRESS=20021
SIP_DEFAULTHOST=20022
SIP_DEFAULTHOST_SECURE=20023

Assigned ports for a custom profile 

BOOTSTRAP_ADDRESS=20002
SOAP_CONNECTOR_ADDRESS=20003
IPC_CONNECTOR_ADDRESS=20004
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20005
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20006
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20007
ORB_LISTENER_ADDRESS=20008
NODE_MULTICAST_DISCOVERY_ADDRESS=20009
NODE_IPV6_MULTICAST_DISCOVERY_ADDRESS=20010
NODE_DISCOVERY_ADDRESS=20011
DCS_UNICAST_ADDRESS=20012

Assigned ports for a cell with a federated application server profile 

WC_defaulthost=20002
WC_defaulthost_secure=20003
BOOTSTRAP_ADDRESS=20004
SOAP_CONNECTOR_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20007
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20008
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20009
ORB_LISTENER_ADDRESS=20010
DCS_UNICAST_ADDRESS=20011
SIB_ENDPOINT_ADDRESS=20012
SIB_ENDPOINT_SECURE_ADDRESS=20013
SIB_MQ_ENDPOINT_ADDRESS=20014
SIB_MQ_ENDPOINT_SECURE_ADDRESS=20015
SIP_DEFAULTHOST=20016
SIP_DEFAULTHOST_SECURE=20017
NODE_MULTICAST_DISCOVERY_ADDRESS=20018
NODE_IPV6_MULTICAST_DISCOVERY_ADDRESS=20019
NODE_DISCOVERY_ADDRESS=20020
NODE_DCS_UNICAST_ADDRESS=20021
NODE_BOOTSTRAP_ADDRESS=20022
NODE_SOAP_CONNECTOR_ADDRESS=20023
NODE_ORB_LISTENER_ADDRESS=20024
NODE_SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20025
NODE_CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20026
NODE_CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20027
NODE_IPC_CONNECTOR_ADDRESS=20028

Assigned ports for a cell with a dmgr profile 

WC_adminhost=20002
WC_adminhost_secure=20003
BOOTSTRAP_ADDRESS=20004
SOAP_CONNECTOR_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20007
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20008
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20009
ORB_LISTENER_ADDRESS=20010
CELL_DISCOVERY_ADDRESS=20011
DCS_UNICAST_ADDRESS=20012

Assigned ports for a management profile with a dmgr server 

WC_adminhost=20002
WC_adminhost_secure=20003
BOOTSTRAP_ADDRESS=20004
SOAP_CONNECTOR_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20007
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20008
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20009
ORB_LISTENER_ADDRESS=20010
CELL_DISCOVERY_ADDRESS=20011
DCS_UNICAST_ADDRESS=20012
DataPowerMgr_inbound_secure=20013

Assigned ports for a management profile with a job manager server 

WC_adminhost=20002
WC_adminhost_secure=20003
BOOTSTRAP_ADDRESS=20004
SOAP_CONNECTOR_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20007
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20008
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20009
ORB_LISTENER_ADDRESS=20010

Assigned ports for a management profile with an admin agent server 

WC_adminhost=20002
WC_adminhost_secure=20003
BOOTSTRAP_ADDRESS=20004
SOAP_CONNECTOR_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20007
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20008
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20009
ORB_LISTENER_ADDRESS=20010

Assigned ports for a management profile with an admin agent server 

SOAP_CONNECTOR_ADDRESS=20002
IPC_CONNECTOR_ADDRESS=20003

Assigned ports for a secure proxy profile 

PROXY_HTTP_ADDRESS=20002
PROXY_HTTPS_ADDRESS=20003
PROXY_SIP_ADDRESS=20004
PROXY_SIPS_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006

The following example uses the startingPort parameter of the manageprofiles command and creates ports from an initial value of 20002, with the content shown in the previous example: 

 manageprofiles.bat -create
               -profileName shasti
               -profilePath G:\shasti\WebSphere
               -templatePath G:\shasti\WebSphere\profileTemplates\default
               -nodeName W2K03
               -cellName W2K03_Cell01
               -hostName planetnt
               -startingPort 20002
                     

WAS_HOME/bin/manageprofiles.sh -create
               -profileName shasti
               -profilePath WAS_HOME/profiles/shasti
               -templatePath WAS_HOME/profileTemplates/default
               -nodeName W2K03
               -cellName W2K03_Cell01
               -hostName planetnt
               -startingPort 20002


Example: Creating cell profiles

To create the cell profile using the manageprofiles command, create both the cell management profile for a dmgr server and the cell node profile using two different manageprofiles command-line invocations. The combination of these two profiles is the cell profile.

Two templates are used to create the cell profile: cell_dmgr and cell_node. The templates are linked and some parameters must match between the creation parameters in these two invocations. Verify that the invocations match.

From the command line, you can create the two halves of the cell in any order or at any time. It is a best practice to create the dmgr portion of the profile first. After you create the cell, the cell contains a dmgr and a federated node. The dmgr portion and the node portion are in separate directories.

For each of the two profiles that you create, you can specify the fully qualified path to the resulting profile using the -profilePath parameter. If you do not specify the parameter, the default value for each profile path is based on the WAS_HOME directory, the profiles subdirectory, and the name of the profile.

The two templates that compose a cell profile have dependencies between one another which requires some parameter values to match between the two create invocations.

To create a full working cell, the -nodeProfilePath, -cellName, -appServerNodeName, -nodeName parameters are required to have the same values for both the cell_dmgr profile and the cell_node profile. In the case of ports, and especially in the case of dynamically allocated ports, the creation of the second half of the cell must reference the ports that are used in the first half of the cell. Use the -portsFile and -nodePortsFile arguments with references to the following files of the profile that represents the first half of the cell:

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

For detailed help in creating a cell profile, use the following commands: 

WAS_HOME/bin/manageprofiles.sh -create
 -templatePath
WAS_HOME/profileTemplates/cell/dmgr
 -help

WAS_HOME\bin\manageprofiles.bat -create
 -templatePath
WAS_HOME\profileTemplates\cell\dmgr
 -help

or 

WAS_HOME/bin/manageprofiles.sh -create
 -templatePath
WAS_HOME/profileTemplates/cell/default
 -help

WAS_HOME\bin\manageprofiles.bat -create
 -templatePath
WAS_HOME\profileTemplates\cell\default
 -help

The output from the -help parameter specifies which parameters are required and which are optional when creating the cell dmgr profile and the cell node profile.

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

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

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

    • WAS_HOME/profiles
    • WAS_HOME\profiles

  2. Create the dmgr portion of the cell profile. 

    WAS_HOME/bin/manageprofiles.sh -create
 -templatePath
WAS_HOME/profileTemplates/cell/dmgr
 -nodeProfilePath
WAS_HOME/profiles/AppSrv01
 -profileName Dmgr001
 -cellName Default01Cell
 -nodeName Default01Node
 -appServerNodeName federated_node_name

    WAS_HOME\bin\manageprofiles.bat -create
 -templatePath
WAS_HOME\profileTemplates\cell\dmgr
 -nodeProfilePath
WAS_HOME\profiles\AppSrv01
 -profileName Dmgr001
 -cellName Default01Cell
 -nodeName Default01Node
 -appServerNodeName federated_node_name

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

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

    Use the same values for the cellName, nodeName, and appServerNodeName parameters that you used in the dmgr portion of the cell profile. The illustration below demonstrates the use of the same values for the cellName, nodeName, and appServerNodeName parameters in the dmgr and application server portions of the cell profile. 

    For Dmgr:                
-cellName host01Cell01   
-nodeName host01CellManager01
-appServerNodeName host01Node01
                         
For AppServer:           
-cellName host01Cell01   
-nodeName host01CellManager01
-appServerNodeName host01Node01
    If you did not specify names for these parameters when you created the dmgr portion of the cell profile, use the default name that was assigned in the first command-line invocation. 
    WAS_HOME/bin/manageprofiles.sh -create
 -templatePath
WAS_HOME/profileTemplates/cell/default
 -dmgrProfilePath
WAS_HOME/profiles/Dmgr001
 -portsFile
WAS_HOME/profiles/Dmgr001/properties/portdef.props
 -nodePortsFile
WAS_HOME/profiles/Dmgr001/properties/nodeportdef.props
 -profileName AppSrv01
 -cellName Default01Cell
 -nodeName Default01Node
 -appServerNodeName federated_node_name

    WAS_HOME\bin\manageprofiles.bat -create
 -templatePath
WAS_HOME\profileTemplates\cell\default
 -dmgrProfilePath
WAS_HOME\profiles\Dmgr001
 -portsFile
WAS_HOME\profiles\Dmgr001\properties\portdef.props
 -nodePortsFile
WAS_HOME\profiles\Dmgr001\properties\nodeportdef.props
 -profileName AppSrv01
 -cellName Default01Cell
 -nodeName Default01Node
 -appServerNodeName federated_node_name

After the creation of the dmgr and node portions of the cell profile, a synchronization between the two servers must occur. By default, synchronization occurs automatically between the two servers at some specified interval. However, if synchronization is disabled, the interval is too long, or some problem occurs that keeps the synchronization from occurring in a timely manner, run the syncNode command to synchronize the dmgr and the node.

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

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

If you federate an application server node as part of cell profile creation using the -appServerNodeName parameter, the node does not have an original configuration. If you use the -removeNode command on a node created during cell profile creation, the command will indicate that the node removal utility is unable to remove the node and restore the node to a base configuration.

To successfully remove a node that was federated as part of a cell profile creation, use the manageprofiles command to delete the profile for the node. Once the profile for the node is deleted, use the -cleanupNode command on Deployment Manager to remove the node configuration from the cell repository. A new profile can be created using the Profile Management Tool or the manageprofiles command.


Example: Using predefined port numbers

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

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

File locations of default port values.

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

Profile File path
Application server WAS_HOME/profileTemplates/default/actions/portsUpdate/portdef.props
Cell - application server portion WAS_HOME/profileTemplates/cell/dmgr/actions/portsUpdate/nodeportdef.props
Cell - dmgr portion WAS_HOME/profileTemplates/cell/dmgr/actions/portsUpdate/portdef.props
Custom WAS_HOME/profileTemplates/managed/actions/portsUpdate/portdef.props
Management profile for a dmgr server WAS_HOME/profileTemplates/management/actions/portsUpdate/dmgr.portdef.props
Management profile for an admin agent server WAS_HOME/profileTemplates/management/actions/portsUpdate/adminagent.portdef.props
Management profile for a job manager server WAS_HOME/profileTemplates/management/actions/portsUpdate/jmgr.portdef.props
Secure proxy WAS_HOME/profileTemplates/secureproxy/actions/portsUpdate/portdef.props

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

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

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

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

  3. Create your profile with 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: 

    manageprofiles.bat
   -create
   -profileName Wow_Profile
   -profilePath PROFILE_ROOT
   -templatePath WAS_HOME\profileTemplates\default
   -nodeName Wow_node
   -cellName Wow_cell
   -hostName lorriemb
   -portsFile C:\temp\ports\portdef.props
   -validatePorts

    manageprofiles.sh
   -create
   -profileName Wow_Profile
   -profilePath PROFILE_ROOT
   -templatePath WAS_HOME\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.

+

Search Tips   |   Advanced Search