Augmentation is the ability to change an existing profile
with an augmentation template. You can augment existing WebSphere® Application Server or WebSphere Application Server
Network Deployment profiles into WebSphere ESB profiles.
You can augment a profile from the command line using the manageprofiles command.
Before you begin
Before using this procedure, ensure that you have done the
following tasks:
- You have reviewed the list of prerequisites for creating or augmenting
a profile at Prerequisites for creating or augmenting profiles.
- You have shut down any servers associated with the profile that
you plan to augment.
- If you plan to augment a stand-alone server or custom profile,
you have determined if it has already been federated to a deployment
manager:
- If the profile you want to augment has already
been federated to a deployment manager, you cannot augment it using
the manageprofiles command.
- If the profile you want to augment has not already been federated
to a deployment manager, when you do federate it via the addNode command later, the
following must be true of the deployment manager with which it is
federated in order for the augmentation to complete successfully:
- It must be running.
- It must be at a release level the same or higher than that of
the profile you are augmenting. WebSphere Enterprise
Service Bus profiles can use a WebSphere Enterprise
Service Bus or WebSphere Process
Server deployment manager.
- It must have a JMX administrative port enabled. The default protocol
is SOAP.
- It must have already been augmented into a WebSphere ESB profile,
depending on the product you have installed.
- You have reviewed example profile augmentation
commands in or Augmenting profiles with manageprofiles command with Oracle database – examplesAugmenting profiles with manageprofiles command with Derby or DB2 databases – examples or Augmenting profiles with manageprofiles command with Oracle database – examples.
- You have verified that you are not already running the manageprofiles command on
the same profile. If an error message is displayed, determine if there
is another profile creation or augmentation action in progress. If
so, wait until it completes.
Security role required for this task: See Granting write permission of files and directories to non-root users for profile creation.
To use the manageprofiles command to
augment a profile, perform the following steps.
Procedure
- Determine the template that the existing profile was created
with (deployment manager, stand-alone, or managed). You
can determine the template that was used for creating the profile
by viewing the profile registry in install_root/properties/profileRegistry.xml.
Do not modify this file, use it only to view the templates.
- Find the appropriate template to augment to. You
can augment an existing WebSphere Application
Server or WebSphere Application
Server Network Deployment profile into a WebSphere ESB profile. The
following profile templates are available:
- 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.
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 your environment. Make sure that you specify the fully qualified
file path for
-templatePath, because a relative
file path for the
-templatePath parameter results
in the specified profile not being fully augmented.
Note: Do not manually
modify the files that are located in the install_dir/profileTemplates directory.
- Run the file from the command line. Do not supply a -profilePath parameter. Here are some simple examples. For more
complex examples, see or Augmenting profiles with manageprofiles command with Oracle database – examplesAugmenting profiles with manageprofiles command with Derby or DB2 databases – examples or Augmenting profiles with manageprofiles command with Oracle database – examples.
manageprofiles
-augment -templatePath install_root/profileTemplates/default.esbserver
-profileName MyProfileName

manageprofiles.sh
-augment -templatePath install_root/profileTemplates/default.esbserver
-profileName MyProfileName
manageprofiles.bat
-augment -templatePath install_root\profileTemplates\default.esbserver
-profileName MyProfileName
If you have created a response file, use the -response parameter: -response
myResponseFile
The following example shows a response
file for an augment operation:
augment
profileName=testResponseFileAugment
templatePath=install_root/profileTemplates/default.esbserver
nodeName=myNodeName
cellName=myCellName
hostName=myHostName
omitAction=myOptionalAction1, myOptionalAction2
The command displays status as it runs. Wait for
it to finish. Normal syntax checking on the response file applies
as the file is parsed like any other response file. Individual values
in the response file are treated as command-line parameters.