- -adminUserName adminUser_ID
- Specify the user ID that is used for administrative security.
- -adminPassword adminPassword
- Specify the password for the administrative security user ID specified
with the -adminUserName parameter.
- -augment
- 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.
Note: The
templates that are included with WebSphere Application Server 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. For example, if you are changing the ports during profile
creation, use the Profile Management tool or
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.
- -backupProfile
- Performs a file system back up 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.
- -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.
- -cellName cell_name
- Specifies the cell name of the profile. Use a unique cell name
for each profile.
This is an optional parameter for WebSphere Application
Server - Express.
If
you omit the parameter, a default cell name is assigned.
where CellNumber is a sequential number starting
at 01 and NodeNumber is the node number that you used
to define the node name.The default node 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 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:
- default - Application server
- -debug
- Turns on the debug function of the Ant utility, which the manageprofiles command
uses.
- -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.
Note: 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
the profile for an old node that has been migrated, you must shut
down the new migrated deployment manager before you delete the profile
for the old node. This action ensures that the profile for the new
migrated node is not accidentally removed from the new migrated cell.
gotcha
- -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.
- -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. If samples were installed during
the application server install, you must also specify the -samplesPassword parameter
when creating a profile for which administrative security is enabled.
If the -samplesPassword parameter is not specified
when administrative security is enabled, the profile is created successfully,
but when you attempt to run the samples, exceptions and failures will
be put in the server system out log.
- -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.
- -getName
- Gets the name for a profile registered at a given -profilePath parameter.
- -getPath
- Gets the file system location for a profile of a given name. Requires
the –profileName 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
- An optional parameter that is used with the -templatePath parameter
to unaugment a particular profile that has been augmented. See the
-unaugment parameter.
- -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 whether the server is intended for development purposes
only. This parameter is useful when creating profiles to test applications
on a non-production server prior to deploying the applications on
their production application servers.
- -listProfiles
- Lists all defined profiles.
- -nodeName node_name
- Specifies the node name for the node that is created with the
new profile. Use a unique value on
the machine. Each profile that shares the same set of product binaries
must have a unique node name.
The default node names are as follows:
- dmgr template: profilenameManager
- default template: shorthostname_profilename
- managed template: shorthostname_profilename
- cell: See the previous dmgr and default template examples and
apply as appropriate to the two profiles that are created.
The value for this parameter must not contain spaces or
any characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, |,
and so on.
- -omitAction feature1 feature2...
featureN
- An optional parameter that excludes profile features.
Each
profile template comes predefined with certain optional features.
The
samplesInstallAndConfig option is only available
when
WebSphere® Application Server is installed
with samples applications selected. The following optional features
can be used with the
-omitAction parameter for the
following profile templates:
- default - Application server
- deployAdminConsole
- samplesInstallAndConfig
- defaultAppDeployAndConfig
- -portsFile file_path
- 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:
profileType ProfileNumber
where profileType is
a value such as AppSrv, Dmgr, or Custom and ProfileNumber 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 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 throughout the information center as the profile_root.
The default value
is based on the app_server_root directory,
the profiles subdirectory, and the name of the file.
The default value is based on the user_data_root directory,
the profiles subdirectory, and the name of the file.
For example,
the default is:
WS_WSPROFILE_DEFAULT_PROFILE_HOME/profileName
where
WS_WSPROFILE_DEFAULT_PROFILE_HOME is
defined in the
wasprofile.properties file in the
app_server_root/properties directory.
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.
- -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. The following is an example response
file for a create operation:
create
profileName=testResponseFileCreate
profilePath=profile_root
templatePath=app_server_root/profileTemplates/default
nodeName=myNodeName
cellName=myCellName
hostName=myHostName
omitAction=myOptionalAction1, myOptionalAction2
![[Updated in April 2012]](../../delta.gif)
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 personalCertDN 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=samplesInstallAndConfig,defaultAppDeployAndConfig
- Do not specify a blank line in a response file. This can cause
an error.
![[Updated in April 2012]](../../deltaend.gif)
apr2012
- -restoreProfile
- Restores the given profile backup to its previous location. This
option is not supported on remote machines. Must be used with the -backupFile parameter,
for example:
manageprofiles(.bat)(.sh) -restoreProfile -backupFile file_name
To
restore a profile, perform the following steps:
- Manually delete the directory for the profile from file system.
- Run the -validateAndUpdateRegistry option of the manageprofiles command.
- Stop the server and the running processes for the profile that
you want to restore.
- Restore the profile by using the -restoreProfile option
of the manageprofiles command.
- -samplesPassword samplesPassword
- Creates a password to be used for samples. The password is used
to restrict access to web application samples installed during the
install of the application server.
- -serverName server_name
- Specifies the name of the server. If you do not specify this parameter,
the default server name is the name of the profile that contains the
server.
- -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
- -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.
Note: Do
not use this parameter if you are using the managed profile template.
- -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 stand-alone application server:
manageprofiles -create -profileName MyProfile -startingPort 10380
- -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 as 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.
- -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.
- -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.
- -validatePorts
- Specifies the ports should be validated to ensure 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
to use this parameter with the –portsFile parameter.
- -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.