- -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.
- -appServerNodeName application_server_node_name
- Specifies the node name of the application server that you are
federating into the cell. Specify this parameter when you create the
deployment manager portion of the cell and when you create the application
server portion of the cell.
- -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.
Important: The
templates that are included with the WebSphere
® Application
Server
Network Deployment product 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 -startingPort or -portsFile arguments on the manageprofiles command
instead of modifying the file in the profile template directory.
Specify the fully qualified file path for
-templatePath.
For example:
manageprofiles(.bat)(.sh) -augment -profileName profile_name -templatePath template_path
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 backup 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.
Use a unique
name even though you plan to federate the custom profile or stand
alone profile into a deployment manager cell. Federation requires
unique cell names before it can make the node part of the deployment
manager cell. A cell name must be unique in any circumstance in which the product is running on the same physical machine or cluster of machines, such as a sysplex. Additionally, a cell name must be unique in any circumstance in which network connectivity between entities is required either between the cells or from a client that must communicate with each of the cells. Cell names must also be unique if their namespaces are federated. Otherwise, you might encounter symptoms such as a javax.naming.NameNotFoundException error, in which case, create uniquely named cells.
The default value for this parameter is based on a
combination of the short host name, the constant cell, and a trailing
number:
- Application server profile: Not any
- Custom profile: Not any
- Management profile with the deployment manager
server: shortHostNameCellCellNumber
- Management profile with the job manager server: shortHostNameJobMgrCellCellNumber
- Management profile with the administrative agent server: shortHostNameAACellCellNumber
- Cell profile, application server portion: shortHostNameCellCellNumber
- Cell profile, deployment manager portion: shortHostNameCellCellNumber
- Secure proxy profile: Not any
where
CellNumber is a sequential number starting at
01.
The value for this parameter must not contain spaces or
any invalid 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:
- cell - Deployment
manager cell (dmgr and default)
- management - Management. Use in conjunction with the -serverType parameter
to indicate the type of management profile.
- secureproxy- Secure
proxy
- default - Application server
- managed - Custom
- -debug
- Turns on the debug function of the Ant utility, which the manageprofiles command
uses.
- -personalCertValidityPeriod validity_period
- An optional parameter that specifies the amount of time in years
that the default personal certificate is valid. If you do not specify
this parameter with the -personalCertDN parameter,
the default personal certificate is valid for one year.
- -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.
Remember: Do not
use this parameter if you are using the managed profile template.
- -delete
- Deletes the profile.
Deleting a profile does
not delete the profile directory. For example, suppose that you create
a profile in the /usr/WebSphere/AppServer/profiles/managedProfile directory.
The directory remains after you delete the profile.
You
can delete or leave the directory. However, the profile_root/logs directory
contains information about uninstalling the profile. For example,
you might retain the _nodeuninst.log file to
determine the cause of any problem during the uninstall procedure.
Required
parameter: -profileName. If you do not include this
parameter, then the operation cannot complete.
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.
Deleting a
profile does not delete the profile directory. For example, suppose
that you create a profile in the /usr/WebSphere/AppServer/profiles/managedProfile directory.
The directory remains after you delete the profile.
You
can delete or leave the directory. However, the profile_root/logs directory
contains information about uninstalling the profile. For example,
you might retain the _nodeuninst.log file to
determine the cause of any problem during the uninstall procedure.
If you delete a profile
that has augmenting templates registered to it in the profile registry,
then unaugment actions are performed automatically.
- -dmgrAdminPassword password
- If you are federating a node, specify a valid user name for a
deployment manager if administrative security is enabled on the deployment
manager. Use this parameter with the -dmgrAdminUserName parameter
and the -federateLater parameter.
- -dmgrAdminUserName user_name
- If you are federating a node, specify a valid password for a deployment
manager if administrative security is enabled on the deployment manager.
Use this parameter with the -dmgrAdminPassword parameter and the -federateLater
parameter.
- -dmgrHost dmgr_host_name
- Identifies the machine where the deployment manager is running.
Specify this parameter and the dmgrPort parameter
to federate a custom profile as it is created.
The host name can
be the long or short DNS name or the IP address of the deployment
manager machine.
Specifying this optional parameter directs
the manageprofiles command to attempt to federate
the custom node into the deployment manager cell as it creates the
custom profile with the managed -templatePath parameter. The -dmgrHost
parameter is ignored when creating a deployment manager profile or
an Application Server profile.
If you federate a custom node
when the deployment manager is not running or is not available because
of security being enabled or for other reasons, the installation indicator
in the logs is INSTCONFFAIL to indicate a complete failure. The resulting
custom profile is unusable. You must move the custom profile directory
out of the profile repository (the profiles installation root directory)
before creating another custom profile with the same profile name.
If
you have enabled security or changed the default JMX connector type,
you cannot federate with the manageprofiles command.
Use the addNode command instead.
The default
value for this parameter is localhost. The value for this
parameter must be a properly formed host name and must not contain
spaces or characters that are not valid such as the following: *, ?, ", <, >, ,, /, \, |,
and so on. A connection to the deployment manager must also be available
in conjunction with the dmgrPort parameter.
- -dmgrPort dmgr_port_number
- Identifies the SOAP port of the deployment manager. Specify this
parameter and the dmgrHost parameter to federate
a custom profile as it is created. The deployment manager must be
running and accessible.
If you have enabled security or changed
the default Java Management Extensions (JMX)
connector type, you cannot federate with the manageprofiles command.
Use the addNode command instead.
The default
value for this parameter is 8879. The port that you indicate
must be a positive integer and a connection to the deployment manager
must be available in conjunction with the dmgrHost parameter.
- -dmgrProfilePath dmgr_profile_path
- Specifies the profile path to the deployment manager portion of
the cell. Specify this parameter when you create the application server
portion of the cell.
- -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.
You cannot use the -enableAdminSecurity
parameter to enable administrative security for a custom profile.
For security to be enabled for a custom profile, the custom profile
must be federated into a deployment manager. Administrative security
enabled for the deployment manager is required to enable security
for the federated custom profile.
- -enableService true | false
- Enables the creation of a Linux service.
Valid values include true or false.
The default value for this parameter is false.
When
the manageprofiles command is run with the -enableService option
set to true , the Linux service
is created with the profile when the command is run by the root user.
When a non-root user runs the manageprofiles command,
the profile is created, but the Linux service
is not. The Linux service is not created because the non-root
user does not have sufficient permission to set up the service. An INSTCONPARTIALSUCCESS result
is displayed at the end of the profile creation and the profile creation
log app_server_root/logs/manageprofiles_create_profilename.log contains
a message indicating the current user does not have sufficient permission
to set up the Linux service.
- -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.
- -importPersonalCertKS keystore_path
- Specifies the path to the keystore file that you use to import
a personal certificate when you create the profile. The personal certificate
is the default personal certificate of the server.
Best practice: When
you import a personal certificate as the default personal certificate,
import the root certificate that signed the personal certificate.
Otherwise, the
manageprofiles adds
the public key of the personal certificate to the trust.p12 file and
creates a root signing certificate.
bprac
The -importPersonalCertKS parameter
is mutually exclusive with the -personalCertDN parameter.
If you do not specifically create or import a personal certificate,
one is created by default.When you specify any of the parameters
that begin with -importPersonal, you must specify them all.
- -importPersonalCertKSType keystore_type
- Specifies the type of the keystore file that you specify on the -importPersonalCertKS parameter.
Values might be JCEKS, CMSKS, PKCS12, PKCS11,
and JKS. However, this list can change based on
the provider in the java.security file.
When you specify any of
the parameters that begin with -importPersonal, you must specify them
all.
- -importPersonalCertKSPassword keystore_password
- Specifies the password of the keystore file that you specify on
the -importPersonalCertKS parameter.
When you specify
any of the parameters that begin with -importPersonal, you must specify
them all.
- -importPersonalCertKSAlias keystore_alias
- Specifies the alias of the certificate that is in the keystore
file that you specify on the -importPersonalCertKS parameter.
The certificate is added to the server default keystore file and
is used as the server default personal certificate.
When you specify
any of the parameters that begin with -importPersonal, you must specify
them all.
- -importSigningCertKS keystore_path
- Specifies the path to the keystore file that you use to import
a root certificate when you create the profile. The root certificate
is the certificate that you use as the server default root certificate.
The -importSigningCertKS parameter is mutually exclusive
with the -signingCertDN parameter. If you do not
specifically create or import a root signing certificate, one is created
by default.
When you specify any of the parameters that begin with
-importSigning, you must specify them all.
- -importSigningCertKSType keystore_path
- Specifies the type of the keystore file that you specify on the -importSigningCertKS parameter.
Valid values might be JCEKS, CMSKS, PKCS12, PKCS11,
and JKS. However, this list can change based on the
provider in the java.security file.
When you specify any of the
parameters that begin with -importSigning, you must specify them all.
- -importSigningCertKSPassword keystore_password
- Specifies the password of the keystore file that you specify on
the -importSigningCertKS parameter.
When you specify
any of the parameters that begin with -importSigning, you must specify
them all.
- -importSigningCertKSAlias keystore_alias
- Specifies the alias of the certificate that is in the keystore
file that you specify on the -importSigningCertKS parameter.
The certificate is added to the server default root keystore and
is used as the server default root certificate.
When you specify
any of the parameters that begin with -importSigning, you must specify
them all.
- -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 that the server is intended for development purposes
only. This parameter is useful when creating profiles to test applications
on a non-production server before deploying the applications on their
production application servers.
This parameter is valid only for
the default profile template.
If you
specify both the -isDeveloperServer and -applyPerfTuningSetting parameters,
depending on the option selected for -applyPerfTuningSetting, -applyPerfTuningSetting might
override -isDeveloperServer.
- -applyPerfTuningSetting option
- Specifies the performance-tuning setting that most closely matches
the type of environment in which the application server will run.
This
parameter is only valid for the default profile template.
- standard
- The standard settings are the standard out-of-the-box default
configuration settings that are optimized for general-purpose usage.
- peak
- The peak performance settings are optimized for a production environment
where application changes are rare and optimal runtime performance
is important.
Avoid trouble: This
option is not valid if you are running on Version 7.0.0.15 or higher.
gotcha
- production
- The production performance settings are optimized for a production
environment where application changes are rare and optimal runtime
performance is important.
Avoid trouble: This option is only valid if you are running on Version
7.0.0.15 or higher.
gotcha
- development
- The development settings are optimized for a development environment
where frequent application updates are performed and system resources
are at a minimum.
Important: Do not use the development
settings for production servers.
If you specify both the -isDeveloperServer and -applyPerfTuningSetting parameters,
depending on the option selected for -applyPerfTuningSetting, -applyPerfTuningSetting might
override -isDeveloperServer.
- -keyStorePassword keystore_password
- Specifies the password to use on all keystore files created during
profile creation. Keystore files are created for the default personal
certificate and the root signing certificate.
- -listAugments
- Lists the registered augments on a profile that is in the profile
registry. You must specify the -profileName parameter with the -listAugments
parameter.
- -nodeDefaultPorts
- Defines a set of ports when creating a profile in conjunction
with a cell template. If you specify this option, you cannot specify
the -nodePortsFile or nodeStartingPort options at the same time.
- -nodePortsFile node_ports_path
- Specifies ports for the node portion of the cell that you are
creating. If you specify this option, you cannot specify the -nodeDefaultPorts
or -nodeStartingPort options at the same time.
- -nodeProfilePath node_profile_path
- Specifies the profile path to the node portion of the cell. Specify
this parameter when you create the deployment manager portion of the
cell.
- -nodeName node_name
- Specifies the node name for the node that is created with the
new profile. Use a unique value within
the cell or on the machine. Each profile that shares the same
set of product binaries must have a unique node name.
The
default value for this parameter is based on the short host name,
profile type, and a trailing number:
- Application server profile: shortHostNameNodeNodeNumber
- Custom profile: shortHostNameNodeNodeNumber
- Management profile with the deployment manager
server: shortHostNameCellManagerNodeNumber
- Management profile with the job manager server: shortHostNameJobMgrNodeNumber
- Management profile with the administrative agent server: shortHostNameAANodeNodeNumber
- Cell profile, application server portion: shortHostNameNodeNodeNumber
- Cell profile, deployment manager portion: shortHostNameCellManagerNodeNumber
- Secure proxy profile: shortHostNameNodeNodeNumber
where
NodeNumber is a sequential number starting at
01.
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 Sample applications selected. The following optional features
can be used with the
-omitAction parameter for the
following profile templates:
- default - Application server
- deployAdminConsole
- samplesInstallAndConfig
- defaultAppDeployAndConfig
- management -
Management profile for the deployment manager, administrative agent,
or job manager
- cell -
Deployment manager cell which is composed of both a dmgr and a default
profile template
- cell_dmgr (dmgr created during cell profile creation)
- deployAdminConsole
- samplesInstallAndConfig
- defaultAppDeployAndConfig
- -personalCertDN distinguished_name
- Specifies the distinguished name of the personal certificate that
you are creating when you create the profile. Specify the distinguished
name in quotes. This default personal certificate is located in the
server keystore file. The -importPersonalCertKSType parameter
is mutually exclusive with the -personalCertDN parameter.
See the -personalCertValidityPeriod parameter and
the -keyStorePassword parameter.
- -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:
<profile_type><profile_number>
where
- <profile_type> is a value such as AppSrv, Dmgr, JobMgr, AdminAgent,
or Custom
- <profile_number> 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 any of 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 as the profile_root.
Specify the full path to avoid
an Ant scripting limitation that can cause a failure when federating
the profile into a cell. For example:
-profilePath profile_root
If the fully qualified path contains spaces, enclose
the value in quotation marks.
The default value
is based on the app_server_root directory, the
profiles subdirectory, and the name of the profile.
For
example, the default is:
WS_WSPROFILE_DEFAULT_PROFILE_HOME/profileName
The
WS_WSPROFILE_DEFAULT_PROFILE_HOME element
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.
You 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.
Use the following example
response file to run a create operation:
create
profileName=testResponseFileCreate
profilePath=profile_root
templatePath=app_server_root/profileTemplates/default
nodeName=myNodeName
cellName=myCellName
hostName=myHostName
omitAction=myOptionalAction1,myOptionalAction2
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.
- The path statement in the Windows operating
system can use either forward slashes (/) or back slashes (\). If
the path statement uses back slashes, then the response file requires
double back slashes for the response file to correctly understand
the path. Here is an example of a response file for a create operation
that uses the double back slashes:
create
templatePath=C:\\WebSphere\\AppServer\\profileTemplates\\default
Best practice: Use forward slashes in order to
reduce the chance of errors when switching between platforms.
bprac
- -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:
- Stop the server and the running processes for the profile that
you want to restore.
- Manually delete the directory for the profile from the file system.
- Run the -validateAndUpdateRegistry option of the manageprofiles command.
- 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.
- -securityLevel security_level
- Specifies the initial security level settings for the secure proxy
server. Valid values are low, medium,
and high. The default value is high.
The security level is based on startup user permissions, routing considerations,
administration options, and error handling. You can optionally change
your security settings after you create the secure proxy server profile.
- -serverName server_name
- Specifies the name of the server. Specify this parameter only
for the default and secureproxy templates. If you do not specify this
parameter when using the default or secureproxy templates, the default
server name is server1 for the default profile, and proxy1 for the
secure proxy profile.
- -serverType DEPLOYMENT_MANAGER
| ADMIN_AGENT | JOB_MANAGER
- Specifies the type of management profile. Specify DEPLOYMENT_MANAGER for
a deployment manager server, ADMIN_AGENT for an administrative
agent server, or JOB_MANAGER for a job manager server. This parameter is required when
you create a management profile.
- -serviceUserName service_user_ID
- Specify the user ID that is used during the creation of the Linux service
so that the Linux service runs from this user ID. The Linux service
runs whenever the user ID is logged on.
- -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
- -signingCertDN distinguished_name
- Specifies the distinguished name of the root signing certificate
that you create when you create the profile. Specify the distinguished
name in quotes. This default personal certificate is located in the
server keystore file. The -importSigningCertKS parameter
is mutually exclusive with the -signingCertDN parameter.
If you do not specifically create or import a root signing certificate,
one is created by default. See the -signingCertValidityPeriod parameter
and the -keyStorePassword.
- -signingCertValidityPeriod validity_period
- An optional parameter that specifies the amount of time in years
that the root signing certificate is valid. If you do not specify
this parameter with the -signingCertDN parameter,
the root signing certificate is valid for 15 years.
- -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, omitting
those ports that are already in use. The system recognizes and resolves
ports that are currently in use and determines the port assignments
to avoid port conflicts.
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.
Attention: Do not
use this parameter if you are using the managed profile template.
- -supportedProtocols supported_protocols
- Specifies the protocols that are valid for the secure proxy server
to proxy requests. Valid values are SIP, HTTP,
and HTTP,SIP.
- -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.
You can specify
a relative path for the -templatePath parameter if
the profile templates are relative to theapp_server_root/profileTemplates directory.
Otherwise, specify the fully qualified template path. F
The
available templates are described in the Profile concepts topic.
- -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 because you must ensure that you are
not violating profile template dependencies.
When
using the -templatePath parameter, specify the fully qualified file
path for the parameter.
See
also the augment parameter.
- -unaugmentAll
- Unaugments all profiles that have been augmented with a specific
augmentation template. The -templatePath parameter is required with
the -unaugmentAll parameter.
When using the -templatePath
parameter, specify the fully qualified file path for the parameter.
Optionally,
specify the -unaugmentDependents parameter with the -unaugmentAll
parameter to unaugment all profiles that are prerequisites of the
profiles that are being unaugmented.
Note: If you use
this parameter when you have no profiles augmented with the profile
templates, an error might be delivered.
See also the augment
parameter.
- -unaugmentDependents
- If specified, the parameter unaugments all the augmented profiles
that are prerequisites to the profiles being unaugmented with the
-unaugmentAll parameter. If not specified, it does not unaugment the
augmented profiles that are prerequisites to the profiles being unaugmented.
Specify
the -unaugmentDependents parameter with the -unaugmentAll 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 that 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 “C:\Program Files\IBM\HTTPServer”
webServerType=IIS: webServerInstallPath defaulted to “C:\”
webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “C:\”
webServerType=DOMINO: webServerInstallPath defaulted to “”
webServerType=APACHE: webServerInstallPath defaulted to “”
webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”
webServerType=IHS: webServerInstallPath defaulted to “/opt/IBM/HTTPServer”
webServerType=IIS: webServerInstallPath defaulted to “n\a”
webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “/opt/sun/webserver”
webServerType=DOMINO: webServerInstallPath defaulted to “”
webServerType=APACHE: webServerInstallPath defaulted to “”
webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”
webServerType=IHS: webServerInstallPath defaulted to “/usr/IBM/HTTPServer”
webServerType=IIS: webServerInstallPath defaulted to “n\a”
webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “/opt/sun/webserver”
webServerType=DOMINO: webServerInstallPath defaulted to “?”
webServerType=APACHE: webServerInstallPath defaulted to “?”
webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”
webServerType=IHS: webServerInstallPath defaulted to “/opt/IBM/HTTPServer”
webServerType=IIS: webServerInstallPath defaulted to “n\a”
webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “/opt/sun/webserver”
webServerType=DOMINO: webServerInstallPath defaulted to “”
webServerType=APACHE: webServerInstallPath defaulted to “”
webServerType=HTTPSERVER_ZOS: webServerInstallPath defaulted to “n/a”
webServerType=IHS: webServerInstallPath defaulted to “/opt/IBM/HTTPServer”
webServerType=IIS: webServerInstallPath defaulted to “n\a”
webServerType=SUNJAVASYSTEM: webServerInstallPath defaulted to “/opt/sun/webserver”
webServerType=DOMINO: webServerInstallPath defaulted to “”
webServerType=APACHE: webServerInstallPath defaulted to “”
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.
- -winserviceAccountType specifieduser
| localsystem
- The type of the owner account of the Windows service
created for the profile. Valid values include specifieduser or localsystem.
The localsystem value runs the Windows service
under the local account of the user who creates the profile. The default
value for this parameter is localsystem.
If the value is specifieduser,
the winservicePassword parameter is required. The winserviceUserName
parameter defaults to the environment username value if not specified.
- -winserviceCheck true | false
- The value can be either true or false. Specify true to
create a Windows service for the server
process that is created within the profile. Specify false to
not create the Windows service. The default
value for this parameter is false.
Important: With
a custom profile, you cannot create a Windows service with this parameter.
Instead, use the WASService command to create the
service separately.
- -winservicePassword winservice_password
- Specify the password for the specified user or the local account
that is to own the Windows service.
- -winserviceStartupType manual
| automatic | disabled
- Possible startup_type values are:
- manual
- automatic
- disabled
Read the topic on the WASService command for
more information about Windows services.
The
default value for this parameter is automatic.
- -winserviceUserName winservice_user_ID
- Specify your user ID so that the Windows operating
system can verify you as an ID that is capable of creating a Windows service. Your user ID must belong
to the administrator group and have the following advanced user rights:
- Exist as part of the operating system
- Log on as a service
The default value for this parameter is the current user name.
The value for this parameter must not contain spaces or characters
that are not valid such as the following: *, ?, ", <, >, ,, /, \, |,
and so on. The user that you specify must have the proper permissions
to create a Windows service. You must specify
the correct password for the user name that you choose. Important: ![[Updated in February 2013]](../../delta.gif)
When you create a profile with a Windows services with a specified
user and password and the user is a domain user, you must use a
double
backslash as shown below:
winServiceUserName=DOMAIN\\DOMAINUSER
winServicePassword=DOMAINUSERPASSWORD
![[Updated in February 2013]](../../deltaend.gif)
feb2013