This topic applies only to the Distributed platforms

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, are the only ways to create profiles, or the only ways to create runtime environments. You can also augment profiles and delete profiles with the manageprofiles command-line utility.

The command file is located in the install_root/bin directory. 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:
  • For Linux operating systemFor UNIX operating system install_root/logs/manageprofiles
  • For Windows operating system 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. You can also specify profile templates that lie outside the installation root if they exist. Use the following templates with IBM® Business Process Manager:
  • default.procsvr: for an IBM Business Process Manager stand-alone server profile, which define stand-alone servers with capabilities and functionality specific to IBM BPM Standard and Express configurations.
  • default.procsvr.adv: for Process Server stand-alone profiles, which define stand-alone servers with capabilities and functionality specific to an IBM BPM Advanced configuration.
  • dmgr.procsvr: for an IBM Business Process Manager Process Server 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.
  • managed.procsvr: for an IBM Business Process Manager custom profile, which, when federated to a deployment manager, defines a managed node.

    If you have decided that your solution requires a network deployment configuration, your runtime environment requires one or more managed nodes. A custom profile contains an empty node that you must federate into a deployment manager cell to make operational. Federating the custom 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 custom profile you are creating. Also, IBM® Business Process Manager Advanced: Process Server profiles cannot use a WebSphere® Enterprise Service Bus deployment manager, but WebSphere Enterprise Service Bus profiles can use an IBM Business Process Manager Advanced: Process Server deployment manager.

  • default.esbserver: for a WebSphere® Enterprise Service Bus stand-alone server profile, which defines a stand-alone server.
  • dmgr.esbserver: for a WebSphere Enterprise Service Bus deployment manager profile, which defines a deployment manager.
  • managed.esbserver: for a WebSphere Enterprise Service Bus custom profile, which, when federated to a deployment manager, defines a managed node.
  • default.procctr: for an IBM Business Process Manager Process Center stand-alone profile, which define stand-alone servers with capabilities and functionality specific to IBM BPM Standard and Express configurations.
  • dmgr.procctr for an IBM Business Process Manager Process Center 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.
  • managed.procctr for an IBM Business Process Manager Process Center custom profile, which, when federated to a deployment manager, defines a managed node. If you have decided that your solution requires a deployment environment, your runtime environment requires one or more managed nodes.

    A custom profile contains an empty node that you must federate into a deployment manager cell to make operational. Federating the custom 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 custom profile you are creating.

This topic applies only to the Distributed platforms

Syntax

The manageprofiles command-line utility is used to perform the following tasks:
  • Creating a profile (-create parameter). See the instructions for your specific profile type and database.
  • Augmenting a profile (-augment parameter). See the instructions for your specific profile type and database.
    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)

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.

This topic applies only to the Distributed platforms

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 path_to_template

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