manageprofiles command-line utility

The manageprofiles command-line utility creates a profile, which is the set of files that define the runtime environment for a deployment manager, a managed node, or a stand-alone server.

The profile defines the runtime environment and includes all of the files that the server processes can change during runtime.

The manageprofiles command-line utility and its graphical user interface, the Profile Management Tool, offer alternate ways to create, augment, and delete profiles. For more information, see BPMConfig command-line utility.

The command file is located in the install_root/bin directory, where install_root is the installation location of IBM Business Process Manager. The command file is a script named manageprofiles.sh for Linux and UNIX platforms or manageprofiles.bat for Windows platforms.

The manageprofiles command-line utility creates a log for every profile that it creates, deletes, or augments. The logs are in the following directory, depending on platform:

install_root/logs/manageprofiles
install_root\logs\manageprofiles

The files are named as follows:

profile_name_create.log
profile_name_augment.log
profile_name_delete.log

Templates for each profile are located in the install_root/profileTemplates directory. Within this directory are various directories that correspond to different profile types. The directories are the paths that you indicate while using the manageprofiles command-line utility with the -templatePath option. Use the following templates with IBM® Business Process Manager:

BPM/BpmServer: Use this template for an IBM Business Process Manager stand-alone server profile, which defines stand-alone servers with capabilities and functionality specific to IBM BPM Express configurations. This template is only supported in IBM BPM Express installations.
BPM/BpmDmgr: Use this template for an IBM Business Process Manager deployment manager profile, which defines a deployment manager. A deployment manager provides one administrative interface to a logical group of servers on one or more workstations. This template is only supported in IBM BPM Standard and IBM BPM Advanced installations.
BPM/BpmNode: Use this template for an IBM Business Process Manager managed-node profile, which, when federated to a deployment manager, defines a managed node. This template is only supported in IBM BPM Standard and IBM BPM Advanced installations.
If you have decided that your solution requires a network deployment configuration, your runtime environment requires one or more managed nodes. A managed-node profile contains an empty node that you must federate into a deployment manager cell to make operational. Federating the managed-node profile changes it into a managed node. Do not federate a node unless the deployment manager you are federating to is at a release level the same or higher than that of the managed-node profile you are creating.

Syntax

The manageprofiles command-line utility is used to perform the following tasks:

Creating a profile (-create parameter).
Augmenting a profile (-augment parameter).
Note: Using profiles that have been unaugmented (-unaugment parameter) is not supported.
Deleting a profile (-delete parameter).
Follow the instructions in Removing profiles using the manageprofiles command-line utility.
Deleting all profiles (-deleteAll parameter)
Listing all profiles (-listProfiles parameter)
Getting the name of an existing profile from its name (-getName parameter)
Getting the name of an existing profile from its path (-getPath parameter)
Validating a profile registry (-validateRegistry parameter)
Validating and updating a profile registry (-validateAndUpdateRegistry parameter)
Getting the default profile name (-getDefaultName parameter)
Setting the default profile name (-setDefaultName parameter)
Backing up a profile (-backupProfile parameter)
Restoring a profile (-restoreProfile parameter)
Using a response file containing the information required to run a manageprofiles command-line utility (-response parameter)

Note: The -backupProfile and -restoreProfile parameters are not supported with IBM Business Process Manager.

For detailed help including the required parameters for each of the tasks accomplished with the manageprofiles command-line utility, use the -help parameter. The following is an example of using the help parameter with the manageprofiles command-line utility -augment parameter on Windows operating systems: manageprofiles.bat -augment -help. The output specifies which parameters are required and which are optional.

Parameters

Depending on the operation that you want to perform with the manageprofiles command-line utility, you might need to provide one or more of the parameters described in manageprofiles parameters. The Profile Management Tool validates that the required parameters are provided and the values entered for those parameters are valid. Be sure to type the name of the parameters with the correct case, because the command line does not validate the case of the parameter name. Incorrect results can occur when the parameter case is not typed correctly.

For a full list of available parameters for a specific profile template, use the command-line help. For example:

manageprofiles -create -help -templatePath template_path

Restriction: When you create profiles using PMT or manageprofiles, you must use parameter values that match the values that are specified in the properties file that the BPMConfig command uses to configure the deployment environment. For example, if you set the value of cellName to PSCell1, the BPMConfig properties file must also use the PSCell1 value. If you omit optional parameter values, PMT or manageprofiles creates default values that must also match the required parameter values that are used by BPMConfig.

The following examples illustrate how the manageprofiles parameter values and the corresponding values in the PMT entry fields must match the input settings in the BPMConfig properties file. In the examples, the references to the configuration properties file are denoted as <property.name> and their default values, if any, are denoted as <property.name=defaultValue>, where the default value may refer to other properties. (The default value for cellName is PSCell1 for Process Server environments and PCCell1 for Process Center environments.)

Stand-alone profile

-profileName=<bpm.de.node.1.profileName=<bpm.de.node.1.name>Profile>
-profilePath=<bpm.de.node.1.profilePath=<bpm.de.node.1.installPath>/profiles/<bpm.de.node.1.profileName>>
-cellName=<bpm.cell.name=PSCell1>
-nodeName=<bpm.de.node.1.name=Node1>
-serverName=server1
-hostName=<bpm.de.node.1.hostname=localhost>
-adminAliasName=<bpm.cell.roleMapping.1.alias=CellAdminAlias>
-adminUserName=<bpm.cell.authenticationAlias.1.user>
-adminPassword=<bpm.cell.authenticationAlias.1.password>

Deployment manager profile

-profileName=<bpm.dmgr.profileName=<bpm.dmgr.name>Profile>
-profilePath=<bpm.dmgr.profilePath=<bpm.dmgr.installPath>/profiles/<bpm.dmgr.profileName>>
-cellName=<bpm.cell.name=PSCell1>
-nodeName=<bpm.dmgr.name=Dmgr>
-hostName=<bpm.dmgr.hostname=localhost>
-adminAliasName=<bpm.cell.roleMapping.1.alias=CellAdminAlias>
-adminUserName=<bpm.cell.authenticationAlias.1.user>
-adminPassword=<bpm.cell.authenticationAlias.1.password>

Managed-node profile (using node index 1, similar to other nodes in the cell)

-profileName=<bpm.de.node.1.profileName=<bpm.de.node.1.name>Profile>
-profilePath=<bpm.de.node.1.profilePath=<bpm.de.node.1.installPath>/profiles/<bpm.de.node.1.profileName>>
# must not use the cell name from the config model here, or else node federation will fail - append the node name to ensure uniqueness
-cellName=<bpm.cell.name=PSCell1<bpm.de.node1.name>>
-nodeName=<bpm.de.node.1.name=Node1>
-hostName=<bpm.de.node.1.hostname=localhost>

Command output

On completion, the command displays a statement similar to one of the following messages. (Exact wording varies depending on whether you created, deleted or augmented a profile.)

INSTCONFSUCCESS: Profile creation succeeded.
INSTCONFFAILED: Profile creation failed.
INSTCONFPARTIALSUCCESS: Some non-critical post installation configuration actions did not succeed.

In some cases, the statement is displayed more than once. For example, the INSTCONFSUCCESS line is displayed three times at the command line. For more information, see Installation and profile creation log files.