WebSphere WebSphere Enterprise Service Bus, Version 6.0.1 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows

manageprofiles command

The manageprofiles command line tool can be used to create all WebSphere ESB runtime environments, as an alternative to the graphical Profile creation wizard. The command creates profiles, which is the set of files that define the runtime environment for a deployment manager, a custom profile, or a stand-alone server profile. The command can be used to create, delete, augment, unaugment, list or validate profiles.

The Profile creation wizard is an InstallShield for Multiplatforms (ISMP) application. You can use the wizard to enter most of the parameters that are described in this topic. Some parameters, however, require you to use the manageprofiles command. You must use the manageprofiles command to delete or unaugment a profile, for example, because the Profile creation wizard does not provide a deletion function.

However, the Profile creation wizard also performs tasks that the manageprofiles command does not. For instance, the wizard can create a Windows service for each profile that it creates. It can also assign non-conflicting ports based on previous port assignments.

When the Profile creation wizard is used (interactively or silently) to initially create or augment a profile, a command-line version of the profile creation or augmentation is written to a log file. You can extract this command line from the log file, carefully modify it, and use it to create or augment other profiles.

Important: To successfully create a new WebSphere ESB profile, or augment an existing WebSphere Application Server profile, you should first use the Profile creation wizard or silent installation process and only use the manageprofiles command to "clone" such a profile or create one that is very similar. Using the manageprofiles command to create and augment profiles contains step-by-step instructions for this procedure.
Refer to the following sections for further information:

Profile types

Templates for each profile are located in the install_root/profileTemplates directory.

Within this directory are various directories that correspond to different profile types. These directories are the paths that you indicate to the manageprofiles command with the -templatePath option. You can also specify profile templates that lie outside the installation root, if you happen to have any.

The manageprofiles command in WebSphere ESB can create the following types of ESB profiles:
  • Stand-alone server profile uses the install_root/profileTemplates/default.esbserver template.
  • Deployment manager profile uses the install_root/profileTemplates/dmgr.esbserver template.
  • Custom profile uses the install_root/profileTemplates/managed.esbserver template.

Location of the command file

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 Profile creation wizard is the graphical user interface to the command line tool. The file name of the command that calls the Profile creation wizard varies per operating system platform.

Logging

Each invocation of manageprofiles will create two logs in the install_root/logs/wasprofile directory.
  • The wasprofile_<mode>_profile_name.log will contain the details of the actions that were invoked by the manageprofiles command.
  • The manageprofile_<mode>_profile_name.log will contain a much briefer description of which templates were applied for a given invocation, and their return codes.
For example, when the manageprofiles command is used to create a profile called profile1, two log files are created:
  • install_root/logs/wasprofile/wasprofile_create_profile1.log
  • install_root/logs/wasprofile/manageprofile-create-profile1.log
LINUX platforms UNIX platforms

manageprofiles.sh command syntax

Use the following syntax and parameters with the manageprofiles command to get information about your profiles, to delete profiles, or to unaugment profiles. To create or augment a profile with manageprofiles, follow the instructions in Using the manageprofiles command to create and augment profiles.

List existing profiles:
# ./manageprofiles.sh -listProfiles 
                 
Remove the most recent augmentation for a profile:
# ./manageprofiles.sh -unaugment 
              -profileName profile_name 
Delete profiles:
Note: You must remove all augmentations from a profile before you delete the profile. Issue the unaugment command twice before issuing the delete command for WebSphere ESB profiles. This ensures that the profile and all its related artefacts are deleted. After deleting a profile, manually delete the contents of the profile_root directory before attempting to re-create the profile.
# ./manageprofiles.sh -unaugment 
              -profileName profile_name
# ./manageprofiles.sh -unaugment 
              -profileName profile_name
# ./manageprofiles.sh -delete 
                -profileName profile_name | -profilePath profile_path 
                
Get the name of an existing profile from its path:
# ./manageprofiles.sh -getName 
                 -profilePath profile_path 
                
Get the path of an existing profile from its name:
# ./manageprofiles.sh -getPath 
                 -profileName profile_name 
                
Check the integrity of the profile registry:
# ./manageprofiles.sh -validateRegistry 
                
Check the integrity of the profile registry, removing profiles that are not found:
# ./manageprofiles.sh -validateAndUpdateRegistry 
                 [-backup file_name] 
                
Get help for the command:
# ./manageprofiles.sh -help

# ./manageprofiles.sh -option_name -help
For Windows platforms

manageprofiles.bat command syntax

List existing profiles:
manageprofiles -listProfiles 
             
Remove the most recent augmentation for a profile:
manageprofiles -unaugment 
               -profileName  profile_name 
Delete profiles:
Note: You must remove all augmentations from a profile before you delete the profile. Issue the unaugment command twice before issuing the delete command. This ensures that the profile and all its related artefacts are deleted. After deleting a profile, manually delete the contents of the profile_root directory before attempting to re-create the profile.
manageprofiles -unaugment 
               -profileName  profile_name
manageprofiles -unaugment 
               -profileName  profile_name
manageprofiles -delete 
              -profileName profile_name | -profilePath profile_path 
            
Get the name of an existing profile from its path:
manageprofiles -getName 
               -profilePath fully_qualified_profile_path 
             
Get the path of an existing profile from its name:
manageprofiles -getPath 
               -profileName profile_name 
             
Check the integrity of the profile registry:
manageprofiles -validateRegistry 
             
Check the integrity of the profile registry, removing any unfound profiles:
manageprofiles -validateAndUpdateRegistry 
             [-backup file_name] 
             
Get help for the command:
manageprofiles -help

manageprofiles -option_name -help

Parameters

The WebSphere ESB manageprofiles command has the same parameter set as the WebSphere Process Server manageprofiles command.

Refer to manageprofiles parameters for a list and descriptions of parameters to use with the manageprofiles command for WebSphere ESB.

Command output

On completion of a create or augment command one of the following statements will be printed to the command line (exact wording will vary depending on what mode of manageprofiles was called):
  • 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 printed more that once. For example, for a WebSphere ESB profile, the INSTCONFSUCCESS line is printed 3 times to the command line.

Examples

UnaugmentLINUX platforms UNIX platforms
install_root/bin  manageProfiles.sh -unaugment –profileName profileName
For Windows platforms
install_root\bin  manageProfiles -unaugment –profileName profileName
DeleteLINUX platforms UNIX platforms
install_root/bin  manageProfiles.sh -delete –profileName profileName
For Windows platforms
install_root\bin  manageProfiles -delete –profileName profileName
Related reference
manageprofiles parameters

Reference topic

Terms of Use | Rate this page

Timestamp iconLast updated: 13 Dec 2005
http://publib.boulder.ibm.com/infocenter/dmndhelp/v6rxmx/index.jsp?topic=/com.ibm.websphere.wesb.doc\ref\rwesb_manageprofile.html

(C) Copyright IBM Corporation 2005. All Rights Reserved.
This information center is powered by Eclipse technology. (http://www.eclipse.org)