manageprofiles command

Syntax

app_server_root\bin\manageprofiles.bat -augment -help

Depending on the operation that you want to perform with the manageprofiles command, you need to provide one or more of the following parameters. The command-line tool validates that the required parameters are provided and the values that are entered for those parameters are valid. Be sure to type the name of the parameters with the correct uppercase and lowercase 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.

app_server_root/bin/manageprofiles.sh -create 
   -profileName profile_name 
   -profilePath profile_root 
   -templatePath template_path 

Parameters

The following options are available for the manageprofiles command:

-adminPassword adminPassword

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

-adminUserName adminUser_ID

Specify the user ID that is used for administrative security.

-applyPerfTuningSetting option

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

This parameter is only valid for the default profile template.

standard

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

peak

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

development

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

Important: Do not use the development settings for production servers.

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

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

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

Important: The templates that are included with the WebSphere Application Server 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. If you are changing the ports during profile creation, for example, use the -startingPort or -portsFile arguments on the manageprofiles command instead of modifying the file in the profile template directory.

You can specify a relative path for the -templatePath parameter if the profile templates are relative to the app_server_root/profileTemplates directory. Otherwise, specify the fully qualified template path. For example:

 manageprofiles -augment -profileName profile_name -templatePath template_path

See also the -unaugment parameter.

-backupFile backupFile_name

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

-backupProfile

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

manageprofiles(.bat)(.sh) -backupProfile -profileName profile_name -backupFile backupFile_name

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

-cellName cell_name (Optional Parameter)

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

Avoid trouble: Use a unique name even if you plan to federate the custom profile or standalone 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 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.

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

The default cell 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 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. The verbose Ant output is combined with logging from the manageprofiles command in log files that begin with the manageprofiles name in the app_server_root/logs/directory directory.

-personalCertValidityPeriod validity_period (Optional Parameter)

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

-defaultPorts

Assigns the default or base port values to the profile.

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

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

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

-delete

Deletes the profile.

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: If you are deleting an old node that has been migrated, shut down the new migrated deployment manager 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.

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.

-dmgrAdminPassword password

If you are federating a node, specify a valid user name for a deployment manager if administrative security is enabled on the deployment manager. 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 deployment manager if administrative security is enabled on the deployment manager. Use this parameter with the -dmgrAdminPassword parameter and the -federateLater parameter.

-dmgrHost dmgr_host_name (Optional Parameter)

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 with the managed -templatePath parameter. The -dmgrHost 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 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 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.

You 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 deployment manager. Administrative security enabled for the deployment manager is required to enable security for the federated custom profile.

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

-getPath

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

-getName

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

-help

Displays command syntax.

-hostName host_name

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

-ignoreStack (Optional Parameter)

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

-importPersonalCertKS keystore_path

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

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

-importPersonalCertKSAlias keystore_alias

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

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

-importPersonalCertKSPassword keystore_password

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

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

-importPersonalCertKSType keystore_type

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

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

-importSigningCertKS keystore_path

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

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

-importSigningCertKSAlias keystore_alias

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

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

-importSigningCertKSPassword keystore_password

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

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

-importSigningCertKSType keystore_path

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

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

-isDefault

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

-isDeveloperServer

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

This parameter is valid only for the default profile template.

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

-keyStorePassword keystore_password

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

-listAugments

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

-listProfiles

Lists the profiles that are in the profile registry.

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

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

The following default node names exist:

• management template for the deployment manager, administrative agent, or the job manager: profilenameManager
• default template: shorthostname_profilename
• managed template: shorthostname_profilename
• cell: See the previous management and default template examples and apply as appropriate to the two profiles that are created.
• secureproxy template: shorthostname_profilename

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

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

-omitAction feature1 feature2... featureN (Optional Parameter)

An optional parameter that excludes profile features.

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

• default - application server
  • deployAdminConsole
  • defaultAppDeployAndConfig
  • deployIVTApplication
• management - management profile for the deployment manager, administrative 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

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

Avoid trouble:

• To ensure that the subject alternative name (SAN) field is populated at profile creation, a certificate's subject DN must only contain characters that are letters, digits, and hyphens. If other characters are used then the profile fails to create. This criteria applies for fix packs, version 9.0.5.5 through version 9.0.5.7.
• For fix pack, version 9.0.5.8+, you may specify a certificate subject DN that does not meet this criteria, but doing so results in an empty SAN field at profile creation.

-portsFile file_path (Optional Parameter)

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

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

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

-profileName profile_name

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

<profile_type><profile_number>

where

• <profile_type> is a value such as AppSrv, 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

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

The default value is based on the user_data_root directory, the profiles subdirectory, and the name of the profile.

For example, the default is:

WS_WSPROFILE_DEFAULT_PROFILE_HOME/profileName

The WS_WSPROFILE_DEFAULT_PROFILE_HOME element is defined in the wasprofile.properties file in the app_server_root/properties directory.

Note: The wasprofile.properties file includes the following properties:

WS_CMT_PI_MODPERMS

This property specifies if the post installer should modify the permissions of any files it creates. Valid values are true or false. Any other value defaults to false. Removing this property from the file also causes it to default to false. When set to false, any files created by the post installer have permission based on the umask setting of the system.

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

The QEJBSVR profile must have permissions to write to the directory.

WS_CMT_PI_LOGS

This property specifies if and when the post installer should clean up its logs for each product that is located in the PROFILE_HOME/logs/service/productDir directory. The settings for this property enable you to specify the following log cleanup criteria:

• You can specify the number of logs you want to keep for each product in the PROFILE_HOME/logs/service/productDir directory. The specified value can be any integer between 1 and 999. For example, if you specify WS_CMT_PI_LOGS=5, the post installer keeps the five most recent logs for each product.
• You can specify the maximum amount of storage the logs can occupy. The specified value can be any integer between 1 and 999, followed by:
  • KB, if you are specifying the value in kilobytes.
  • MB, if you are specifying the value in megabytes.
  • GB, if you are specifying the value in gigabytes.
  For example, if you specify WS_CMT_PI_LOGS=10MB, when the amount of storage the logs occupy exceeds 10 megabytes, the post installer starts deleting the oldest logs.
  Avoid trouble: Because the values specified are case sensitive, the letters included in the specified value must be capital letters.
• You can specify the amount of time you want the post installer to keep the logs. The specified value can be any integer between 1 and 999, followed by:
  • D, if you are specifying the value in days.
  • W, if you are specifying the value inweeks.
  • M, if you are specifying the value in months.
  • Y, if you are specifying the value in years.
  For example, if you specify WS_CMT_PI_LOGS=2W, each log is kept for two weeks.
  Avoid trouble: Because the values specified are case sensitive, the letters included in the specified value must be capital letters.
• You can specify a specific date after which a log is deleted. The value must be specified using numeric values, separated by dashes in the format DD-MM-YYYY. For example, if you specify WS_CMT_PI_LOGS=12-31-2013, all of the logs are deleted on December31, 2013.
  Avoid trouble: If you do not specify the value in the indicated format, numbers separated by dashes, this property setting is ignored.

WS_WSPROFILE_USE_CHANNEL_FILELOCKS

This property specifies how lock/unlock requests to the ProfilesMutex class are processed. Java non-blocking I/O (NIO) APIs are used to control the synchronization of the requests. Valid values are true or false. Any other value defaults to false. Removing this property from the wasprofile.properties file causes the property to default to false.

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

-response reponse_file

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

The command line interface can be driven by a response file that contains the input arguments for a given command in the properties file in key and value format. To determine which input arguments are required for the various types of profile templates and action, use the manageprofiles command with the -help parameter.

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

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

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

• When you specify values, do not specify double-quote (") characters at the beginning or end of a value, even if that value contains spaces.
  Note: This is a different rule than when you specify values on a command line.
• When you specify a single value that contains a comma character, such as the distinguished names for the personalCertDN and signingCertDN parameters, use a double-backslash before the comma character. For example, here is how to specify the signingCertDN value with a distinguished name:

  signingCertDN=cn=testserver.ibm.com\\,ou=Root Certificate\\,
     ou=testCell\\,ou=testNode01\\,o=IBM\\,c=US 

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

  omitAction=deployAdminConsole,defaultAppDeployAndConfig 

• Do not specify a blank line in a response file. This can cause an error.

-restoreProfile

Important: The manageProfiles -restoreProfile command is only supported with a backup created at the same fixpack level.

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

manageprofiles(.bat)(.sh) -restoreProfile -backupFile file_name

To restore a profile, perform the following steps:

1. Stop the server and the running processes for the profile that you want to restore.
2. Manually delete the directory for the profile from the file system.
3. Run the -validateAndUpdateRegistry option of the manageprofiles command.
4. Restore the profile by using the -restoreProfile option of the manageprofiles command.

Attention: manageProfiles -restoreProfile is best used to restore a profile on the same machine, host, or install. However, you can use -restoreProfile on another machine where the WebSphere Application Server is at the same service level as the source machine. In this case, ensure that the directory structure of the second machine is the same directory structure that existed on the source machine when the manageProfiles -restoreProfile command was used.

-securityLevel security_level

Specifies the 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. You can optionally change your security settings after you create the secure proxy server profile.

-serverName server_name

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

-serverType DEPLOYMENT_MANAGER | ADMIN_AGENT | JOB_MANAGER

Specifies the type of management profile. Specify DEPLOYMENT_MANAGER for a deployment manager 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.

Deprecated feature: The job manager is deprecated. Instead of job manager, use Urban Code Deploy to install the product, to deploy applications, and to manage remote hosts. To manage WebSphere Application Server installations, you also can use swinging profiles. See Swinging profiles between product installations.

-setDefaultName

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

manageprofiles(.bat)(.sh) -setDefaultName -profileName profile_name

-signingCertDN distinguished_name

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

-signingCertValidityPeriod validity_period (Optional Parameter)

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

-startingPort startingPort

Specifies the starting port number for generating and assigning all ports for the profile.

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.

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

-supportedProtocols supported_protocols

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

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

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 standalone application server:

manageprofiles -create -profileName MyProfile -startingPort 10380

The available templates are described in the Profile concepts topic.

-unaugment

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

To unaugment a particular profile that has been augmented, additionally specify the -ignoreStack parameter with the -templatePath parameter. Normally, you would not unaugment a particular profile because you must ensure that you are not violating profile template dependencies.

When using the -templatePath parameter, you can specify a relative 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, you can specify a relative file path for the parameter.

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

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

See also the augment parameter.

-unaugmentDependents

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

Specify the -unaugmentDependents parameter with the -unaugmentAll parameter.

-validateAndUpdateRegistry

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

-validatePorts

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

-validateRegistry

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

-webServerCheck true | false

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

-webServerHostname webserver_host_name

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

-webServerInstallPath webserver_installpath_name

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

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.

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

  The following example uses the management template to create a deployment manager named Dmgr001. The deployment manager ports start at port number 20000.

  manageprofiles -create 
     -profileName Dmgr001
     -profilePath profile_root
     -templatePath management
     -serverType DEPLOYMENT_MANAGER
     -startingPort 20000
  

• Creating an administrative agent

  The following example uses the management template to create an administrative agent named AdminAgent001. The administrative agent ports start at port number 24000.

  manageprofiles -create 
     -profileName AdminAgent001
     -profilePath profile_root
     -templatePath management
     -serverType ADMIN_AGENT
     -startingPort 24000
  

• Creating a job manager
  Deprecated feature: The job manager is deprecated. Instead of job manager, use Urban Code Deploy to install the product, to deploy applications, and to manage remote hosts. To manage WebSphere Application Server installations, you also can use swinging profiles. See Swinging profiles between product installations.

  The following example uses the management template to create a job manager named JobMgr001. The job manager ports start at port number 25000.

  manageprofiles -create 
     -profileName JobMgr001
     -profilePath profile_root
     -templatePath management
     -serverType JOB_MANAGER
     -startingPort 25000
  

• Creating a secure proxy

  The following example uses the secureproxy template to create a secure proxy named SecureProxySrv001. The secure proxy ports start at port number 26000.

  manageprofiles -create 
     -profileName SecureProxySrv001
     -profilePath profile_root
     -templatePath secureproxy
     -startingPort 26000
  

• Creating a custom profile

  The following example creates a custom profile and federates the profile into the deployment manager cell.

  manageprofiles -create 
     -profileName Custom01 
     -templatePath managed 
     -startingPort 22000
     -dmgrHost myhost.mycity.mycompany.com
     -dmgrPort 8879
  

• Creating an application server profile

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

  manageprofiles -create 
     -profileName Default01 
     -templatePath default 
     -startingPort 21000
     -personalCertDN "cn=testa, ou=Rochester, o=IBM, c=US"   
     -signingCertDN "cn=testc, ou=Rochester, o=IBM, c=US"   
     -keyStorePassword ap3n9krw

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

  Important: For both the deployment manager and the application server portion of the cell profile, you must use the same values for the cellName, nodeName, and appServerNodeName parameters. If you did not specify names for these parameters when you created the deployment manager portion of the cell profile, you must use the default name that was assigned in the first command-line invocation. The following example illustrates the use of identical values for these parameters in the deployment manager and the application server portions of the cell profile.

  For Dmgr:                       
  -cellName host01Cell01          
  -nodeName host01CellManager01   
  -appServerNodeName host01Node01 
                                  
  For AppServer:                  
  -cellName host01Cell01          
  -nodeName host01CellManager01   
  -appServerNodeName host01Node01 

  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.

     app_server_root/bin/manageprofiles -create 
        -templatePath app_server_root/profileTemplates/cell/dmgr
        -nodeProfilePath user_data_root/profiles/AppSrv01
        -profileName Dmgr001
        -cellName Default01Cell
        -nodeName Default01Node
        -appServerNodeName Default02Node
     

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

     app_server_root/bin/manageprofiles -create
        -templatePath app_server_root/profileTemplates/cell/default
        -dmgrProfilePath user_data_root/profiles/Dmgr001
        -portsFile user_data_root/profiles/Dmgr001/properties/portdef.props
        -nodePortsFile user_data_root/profiles/Dmgr001/properties/nodeportdef.props
        -profileName AppSrv01
        -cellName Default01Cell
        -nodeName Default01Node
        -appServerNodeName Default02Node
     

Logs

Example: Creating deployment manager profiles

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

To create a deployment manager profile named shasti:

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

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. If you want 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. You can provide the starting port value from the command line, using the -startingPort parameter. The command assigns port numbers sequentially from the starting port number value. However, if a port value in the sequence conflicts with an existing port assignment, the next available port value is used.

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

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

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

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

WC_adminhost=20002
WC_adminhost_secure=20003
BOOTSTRAP_ADDRESS=20004
SOAP_CONNECTOR_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20007
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20008
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20009
ORB_LISTENER_ADDRESS=20010
CELL_DISCOVERY_ADDRESS=20011
DCS_UNICAST_ADDRESS=20012
XDAGENT_PORT=20013
OVERLAY_UDP_LISTENER_ADDRESS=20014
OVERLAY_TCP_LISTENER_ADDRESS=20015
STATUS_LISTENER_ADDRESS=20016

WC_adminhost=20002
WC_adminhost_secure=20003
BOOTSTRAP_ADDRESS=20004
SOAP_CONNECTOR_ADDRESS=20005
IPC_CONNECTOR_ADDRESS=20006
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=20007
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=20008
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=20009
ORB_LISTENER_ADDRESS=20010
CELL_DISCOVERY_ADDRESS=20011
DCS_UNICAST_ADDRESS=20012
XDAGENT_PORT=20014
OVERLAY_UDP_LISTENER_ADDRESS=20015
OVERLAY_TCP_LISTENER_ADDRESS=20016
STATUS_LISTENER_ADDRESS=20017

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

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

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:

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

Example: Creating cell profiles

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

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

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

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

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

app_server_root/bin/manageprofiles -create
 -templatePath
app_server_root/profileTemplates/cell/dmgr
 -help 

or

app_server_root/bin/manageprofiles -create
 -templatePath 
app_server_root/profileTemplates/cell/default
 -help 

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

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

You 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 that you want to be the default.

Example: Using predefined port numbers

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

WC_defaulthost=39080
WC_adminhost=39060
WC_defaulthost_secure=39443
WC_adminhost_secure=39043
BOOTSTRAP_ADDRESS=32809
SOAP_CONNECTOR_ADDRESS=38880
IPC_CONNECTOR_ADDRESS=39633
SAS_SSL_SERVERAUTH_LISTENER_ADDRESS=39401
CSIV2_SSL_SERVERAUTH_LISTENER_ADDRESS=39403
CSIV2_SSL_MUTUALAUTH_LISTENER_ADDRESS=39402
ORB_LISTENER_ADDRESS=39100
DCS_UNICAST_ADDRESS=39353
SIB_ENDPOINT_ADDRESS=37276
SIB_ENDPOINT_SECURE_ADDRESS=37286
SIB_MQ_ENDPOINT_ADDRESS=35558
SIB_MQ_ENDPOINT_SECURE_ADDRESS=35578
SIP_DEFAULTHOST=35060
SIP_DEFAULTHOST_SECURE=35061
OVERLAY_UDP_LISTENER_ADDRESS=35062
OVERLAY_TCP_LISTENER_ADDRESS=35063
STATUS_LISTENER_ADDRESS=35064

After running the manageprofiles command to create your profile with the user defined port values, a success or fail result displays.

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.