Use the following parameters with the manageprofiles command-line utility for IBM® Business Process Manager.
The manageprofiles command file is 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 options provided in Table 1 are available for the manageprofiles command-line utility.
Parameter | Description | Required? |
---|---|---|
-adminUserName adminUser_ID | Specifies the user ID that is used for administrative
security. You can omit this parameter only when -enableAdminSecurity for WebSphere® ESB profiles is set to false. |
Yes For stand-alone profiles in all IBM Business Process Manager configurations (Advanced, Standard, or Express®). |
-adminPassword adminPassword | Specifies the password for the administrative
security user ID specified with the -adminUserName parameter. The same password is set for all internal administrative accounts, including tw_admin and tw_user. |
Required whenever the -adminUserName parameter is required. |
-applyPerfTuningSetting | Set a performance tuning level appropriate for
the profile you are creating. This parameter is a WebSphere Application Server parameter. Valid
settings include the following levels:
|
No |
-augment | Use the augment parameter to change an existing
profile with an augmentation template. The augment parameter causes
the manageprofiles command-line
utility to update or augment the profile identified in the required -profileName parameter
using the template in the required -templatePath parameter.
The augmentation templates that you can use are determined by which IBM products and versions are installed
in your environment. Note: Do not manually modify the files that are
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-line
utility instead of modifying the file in the profile template directory.
Specify
the fully qualified file path for -templatePath as
shown in the following example:
|
If you are augmenting a profile, this parameter is required. |
-backupProfile | Performs a file system backup of a profile folder
and the profile metadata from the profile registry file. This parameter is not supported with IBM Business Process Manager. |
No |
-bpmdbDesign design_file | Specifies the file that holds the database configuration
design for all of the IBM Business Process Manager components (except the Business Process Choreographer component). Important: If you specify this parameter, you cannot specify
any other database-related parameter except for -dbDelayConfig or -dbCreateNew.
This parameter replaces the -wbidbDesign that was used in previous versions of WebSphere Process Server and WebSphere ESB. Note: Business Process Choreographer always uses the common
database (CMNDB). For more information, see -configureBPC.
|
No |
-cdbSchemaName db_schema_name | The schema name for the Common database. If
no value is specified, the following default database schema names
are used:
The -cdbSchemaName parameter is valid for all database types except for Oracle and Microsoft SQL Server. Do not use this parameter if you are using -bpmdbDesign. |
No |
-cellName cell_name | Specifies the cell name of the profile. Use
a unique cell name for each profile. The default value for this
parameter is based on a combination of the short host name, the constant Cell,
and a trailing number, for example:
where CellNumber is a sequential
number starting at 01 and NodeNumber is
the node number that you used to define the node name.
The value for this parameter must not contain spaces or any characters that are not valid such as the following characters: *, ?, ", <, >, ,, /, \, and |. |
No Important: This parameter is
for profile creation only. Do not supply this parameter when augmenting
an existing profile.
|
-configureBPC true | false | Determines whether the Business Process Choreographer
sample configuration is created. The following conditions apply:
Note: If these conditions are too restrictive, consider setting -configureBPC to false and
using other documented methods to configure Business Process Choreographer.
See Planning the topology,
setup, and configuration path for more information.
|
No |
-configureBRM true | false | Configures the business process rules manager. The default value is false. | No |
-configureBSpace true | false | When used with the default.esbserver template,
configures Business Space powered by WebSphere,
which provides an integrated user experience for application users
across the IBM WebSphere Business
Process Management portfolio. The default value is true. Business Space is supported
with the following database products: DB2, DB2 for z/OS®, Oracle, and Microsoft SQL Server. For more information
about configuring Business Space for deployment environments, see Configuring Business Space under Related
information. Important: The configureBSpace parameter
can be used only with the default.esbserver template. Do not use this
parameter with any other template.
|
No |
-create | Creates the profile. Specify manageprofiles -create -templatePath fully_qualified_path_to_template -help for specific information about creating a profile. See the templatePath parameter for a list of available templates. The template_path parameter is required when you are creating a profile. |
If you are creating a profile, this parameter is required. |
-dbAppMeUserId app_me_userID | The default user name is the first three characters
of the Oracle database service name. For example: If the database
service name is ORCL, dbAppMeUserId is ORCSA00. Do not use this parameter if you are using -bpmdbDesign. |
If you enter a user-specified a user name and password during profile creation and if you specified ORACLE for dbType, this parameter is required. |
-dbAppMePassword app_me_pwd | The password for the user ID of the dbAppMeUserId parameter. Do not use this parameter if you are using -bpmdbDesign. |
If you enter a user-specified a user name and password during profile creation and if you specified ORACLE for dbType, this parameter is required. |
-dbCeiMeUserId cei_me_pwd | The default user name is the first three characters
of the Oracle database service name. For example: If the database
service name is ORCL, dbCeiMeUserId is ORCCM00. Do not use this parameter if you are using -bpmdbDesign. |
If you enter a user-specified a user name and password during profile creation and if you specified ORACLE for dbType, this parameter is required. |
-dbCeiMePassword cei_me_userID | The password for the user ID of the dbCeiMeUserId parameter. Do not use this parameter if you are using -bpmdbDesign. |
If you enter a user-specified a user name and password during profile creation and if you specified ORACLE for -dbType, this parameter is required. |
-dbCommonUserId common_db_userid | The user ID to authenticate with the Common
database. For Oracle, the default user name is the first three characters
of the Oracle database service name. For example: If the database
service name is ORCL, dbCommonUserId is ORCCOMM. Do not use this parameter if you are using -bpmdbDesign. |
Required for all stand-aloneIBM Business Process Manager profiles and advanced deployment manager (dmgr.*.adv) profiles, if the -dbType parameter is set to ORACLE or MICROSOFT_SQLSERVER and no bpmdbDesign file was specified. |
-dbCommonPassword common_db_pswd | The password for the user ID of the dbCommonUserId parameter. Do not use this parameter if you are using -bpmdbDesign. |
Required for all stand-aloneIBM Business Process Manager profiles and advanced deployment manager (dmgr.*.adv) profiles, if the -dbType parameter is set to ORACLE or MICROSOFT_SQLSERVER and no bpmdbDesign file was specified. |
-dbConnectionLocation db2_location | The location of DB2 for z/OS database. Do not use this parameter if you are using -bpmdbDesign. |
No |
-dbCreateNew | Indicates a new database is created or if an existing database is to be reused. Valid values are true or false. This value cannot be true for an SQL Server database or a DB2 z/OS database. This value can be true only for a DB2 database. | No |
-dbDelayConfig | Indicates whether to postpone table creation
until after the profile is created. Valid values are true or false.
The parameter is set to false by default. Setting
this parameter to true delays the execution of the
scripts that create the database tables. For any type of database, other than DB2 for z/OS, the value can be true. |
No Specify false if you want the database to be set up during profile creation. |
-dbDriverType db_driver_type | The database driver type. For an Oracle database,
specify ORACLE. For databases other than Oracle,
the value is automatically set based on the server operating system.
Server installations on z/OS use
type 2. Server installations on all other operating
systems use type 4. Do not use this parameter if you are using -bpmdbDesign. |
No, this parameter is only valid if you are using an Oracle database. |
-dbHostName db_host_name | The database server host name or IP address.
The default value is the local host name. Do not use this parameter if you are using -bpmdbDesign. |
Required for stand-alone profiles and advanced or ESB dmgr profiles when the -bpmdbDesign parameter was not specified. (It is not required for managed profiles, standard dmgr profiles, or if the -bpmdbDesign parameter is specified.) |
-dbJDBCClasspath jdbc_driver_location | The directory path location of JDBC driver files.
The default is <install_root>/jdbcdrivers/<dbProduct>,
where <dbProduct> depends on
the value that was specified for <dbType> and <dbProduct> is
one of the following directories:
Do not use this parameter if you are using -bpmdbDesign. |
No |
-dbLocation db_location | The directory of the ORACLE_HOME directory.
This parameter is required when the parameter dbDelayConfig is
set to false. Do not use this parameter if you are using -bpmdbDesign. |
No, this parameter is only valid if you are using Oracle databases. |
-dbName db_name | The name of the database. By default, the value is set to orcl for Oracle databases and to CMNDB for all other supported databases. Do not use this parameter if you are using -bpmdbDesign. |
No |
-dbPassword db_pswd | The password required for database authentication. Do not use this parameter if you are using -bpmdbDesign. |
Required only if you are creating a stand-alone profile, an advanced profile, or an ESB dmgr profile with a DB2 database, when the -bpmdbDesign file is not set. |
-dbPerfDWMeUserId db_PerfDW_Me_UserId | Performance Data Warehouse Messaging Engine
user name. Do not use this parameter if you are using -bpmdbDesign. |
Required for setting up the Performance Data Warehouse Messaging Engine. |
-dbPerfDWMePassword db_PerfDW_ME_Password | Performance Data Warehouse Messaging Engine
password. Do not use this parameter if you are using -bpmdbDesign. |
Required for setting up the Performance Data Warehouse Messaging Engine. |
-dbPerfDWUserId db_PerfDW_UserId | Performance Data Warehouse user name. Do not use this parameter if you are using -bpmdbDesign. |
Required for setting up the Performance Data Warehouse. |
-dbPerfDWPassword db_PerfDW_Password | Performance Data Warehouse password. Do not use this parameter if you are using -bpmdbDesign. |
Required for setting up the Performance Data Warehouse. |
-dbProcSvrMeUserId db_ProcSvr_ME_UserID | Process Server Messaging Engine user name. Do not use this parameter if you are using -bpmdbDesign. |
Required for setting up the Process Server Messaging Engine. |
-dbProcSvrMePassword db_ProcSvr_Me_Password | Process Server Messaging Engine password. Do not use this parameter if you are using -bpmdbDesign. |
Required for setting up the Process Server Messaging Engine. |
-dbProcSvrUserId db_ProcSvr_UserId_name | The Process Server user name. Do not use this parameter if you are using -bpmdbDesign. |
Required for setting up the Process Server. |
-dbProcSvrPassword db_ProcSvr_Password | The Process Server password. Do not use this parameter if you are using -bpmdbDesign. |
Required for setting up the Process Server. |
-dbSchemaName schema_name | Attention: This parameter was deprecated
in WebSphere Process Server V7.
In V8.0.1,
this parameter is no longer supported. Use cdbSchemaName for
the Common database schema name.
The database schema name for DB2 for z/OS.
If both dbSchemaName and cdbSchemaName are
set, cdbSchemaName take precedence. Do not use this parameter if you are using -bpmdbDesign. |
No |
-dbServerPort db_port_number | The database server port number. Depending on
the database you are using, you can specify a different port number
instead of the default port number. Do not use this parameter if you are using -bpmdbDesign. |
No |
-dbStorageGroup db_stg_group | The storage group name for DB2 z/OS databases. Do not use this parameter if you are using -bpmdbDesign. |
No |
-dbSysMeUserId sys_me_userID | The default user name for the SCA system bus
messaging engine is the first three characters of the Oracle database
service name. For example: If the database service name is ORCL,
dbSysMeUserId is ORCSS00. Do not use this parameter if you are using -bpmdbDesign. |
If you enter a user-specified a user name and password during profile creation and if you specified ORACLE for dbType, this parameter is required. |
-dbSysMePassword sys_me_pwd | The default password for the SCA system bus
messaging engine is dbPassword. Do not use this parameter if you are using -bpmdbDesign. |
If you enter a user-specified a user name and password during profile creation and if you specified ORACLE for dbType, this parameter is required. |
-dbType db_type | The database type. Set one of the following
values for the type of database product you are using with IBM Business Process Manager.
Do not use this parameter if you are using -bpmdbDesign. |
Required only for in the following cases:
|
-dbUserId db_userid | The user ID for all database types. Specifies
the user ID that has privileges to create and drop the databases.
The WebSphere data source
uses this ID to authenticate the database connection. For DB2 databases, this parameter specifies
the database user ID that will own the database tables. The default
value is db2inst1. For DB2 for z/OS databases, it specifies the
user ID that has privileges to create and drop the databases.
Important: The -dbUserId parameter value
must be a valid database authorization ID. For more information about
authorization IDs, see the Authorization IDs and authorization
names section of the DB2 property
restriction page.
Do not use this parameter if you are using -bpmdbDesign. |
Required only if you are creating a stand-alone profile or an advanced or ESB dmgr profile with a DB2 database and the -bpmdbDesign file is not set. |
-dbWinAuth | An optional parameter that is valid in all default
profile templates. Specify true to indicate that
you are running SQL Server using integrated windows authentication. Do not use this parameter if you are using -bpmdbDesign. Important: If you are setting -dbType MSSQLSERVER_MICROSOFT, -dbWinAuth
true, and -winserviceCheck true, you must
also set -winserviceAccountType specifieduser, -winserviceUserName dbUser,
and -winservicePassword dbPassword.
|
No |
-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-line utility 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.
|
No |
-delete | Deletes the profile. Deleting a profile does not delete the profile directory. For example, if you create a profile in the /usr/WebSphere/ProcServer/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 uninstallation procedure. If you delete a profile that has augmenting templates registered to it in the profile registry, then unaugment actions are performed automatically. |
No |
-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/ProcServer/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 uninstallation procedure. If you delete a profile that has augmenting templates registered to it in the profile registry, then unaugment actions are performed automatically. |
No |
-dmgrHost dmgr_host_name | Identifies the workstation where the deployment
manager is running. Specify this parameter and the dmgrPort parameter
to federate a custom profile as it is created or augmented. This parameter
is available with the managed.templateName and managed.esbserver profile
templates. The host name can be the long or short DNS name or the IP address of the deployment manager workstation. Specifying this optional parameter directs the manageprofiles command-line utility to attempt to federate the custom node into the deployment manager cell as it creates the custom profile. This parameter is ignored when creating a deployment manager profile or stand-alone server profile. If you federate a custom node when the deployment manager is not running, the installation indicator in the logs is INSTCONFFAILED to indicate a complete failure. The resulting custom profile is unusable. You must move the custom profile directory out of the profile repository (the installation root directory of the profile) before creating another custom profile with the same profile name. If you change the default JMX connector type, you cannot federate with the manageprofiles command-line utility. 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 characters: *, ?, ", <, >, , , /, \, and |. A connection to the deployment manager must also be available in conjunction with the dmgrPort parameter. |
Required if you are creating a managed profile with the -federateLaterBPM parameter set to false and the deployment manager is not on the local machine. |
-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 or augmented. The deployment
manager must be running and accessible. If you change the default JMX connector type, you cannot federate with the manageprofiles command-line utility. 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. |
Required if you are creating a managed profile, the -federateLaterBPM parameter is set to false, and the deployment manager was configured with a port that was not a default port. |
-enableAdminSecurity true | false | For IBM Business Process Manager omit this parameter. Administrative security is always enabled for IBM Business Process Manager profiles. You must also specify the parameters -adminUserName and -adminPassword along with the values for these parameters. Do not supply this parameter when augmenting an existing profile |
No. |
-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-line utility 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 nonroot user runs the manageprofiles command-line utility, the profile is created, but the Linux service is not. The Linux service is not created because the nonroot 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 install_root/logs/manageprofiles/profile_name_create.log contains a message indicating the current user does not have sufficient permission to set up the Linux service. |
No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
-environmentName | Specifies the name of the environment you are
configuring. This parameter has no default value, and it must not be empty. |
Yes. |
-environmentType | Specifies the environment type. The environment type refers to how IBM Business Process Manager is used; for example, in a production, stage or test environment. Load testing might be done on a test server, while a stage environment type might be used as a temporary location to host changes before putting those changes into production. You might specify Stage as the Environment type if the server you are configuring will be accessed and used to review content and new functionality. Valid
values are as follows:
|
No. Can be set when setting up the server. |
-federateLaterBPM true | false | Indicates if the managed profile is to be federated
later using either the profileTemplates/managed.esbserver or
the profileTemplates/BPM/managed.templateName template.
Valid values are true or false. If the -dmgrHost, -dmgrPort, -dmgrAdminUserName, and -dmgrAdminPassword parameters are not set, the default value for this parameter is true. You can use the -federateLaterBPM parameter when using the profileTemplates/managed.esbserver or theprofileTemplates/BPM/managed.templateName template. If you use -federateLaterBPM, you must either omit the WebSphere Application Server-based parameter -federateLater or set it to true. |
No. This parameter is relevant when creating a custom (managed node) profile only. |
-federateLaterWESB true | false | Indicates if the managed profile is to be federated
later using the managed.esbserver template. Valid
values are true or false. If the -dmgrHost, -dmgrPort, -dmgrAdminUserName, and -dmgrAdminPassword parameters are not set, the default value for this parameter is true. You can use the -federateLaterWESB parameter when using the profileTemplates/managed.esbserver template. If you use -federateLaterWESB, you must either omit the WebSphere Application Server-based parameter -federateLater or set it to true. |
No. This parameter is relevant when creating a custom (managed node) profile only. |
-getDefaultName | Returns the name of the default profile. | No |
-getName | Gets the name for a profile registered at a given -profilePath parameter. | No |
-getPath | Gets the file system location for a profile of a given name. Requires the profileName parameter. | No |
-help | Displays command syntax. | No |
-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. This parameter is required for profile creation only. 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 characters: *, ?, ", <, >, ,, /, \, and |. | No. Do not supply this parameter when augmenting an existing profile. |
-ignoreStack | An optional parameter that is used with the -templatePath
parameter to unaugment a particular profile that was augmented. Note: Using
profiles that have been unaugmented (-unaugment parameter)
is not supported.
|
No |
-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. When you import a personal certificate as the default personal certificate, import the root certificate that signed the personal certificate. Otherwise, the manageprofiles utility adds the public key of the personal certificate to the trust.p12 file and creates a root signing certificate. 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 after it is registered. When issuing commands that address the default profile, it is not necessary to use the -profileName attribute of the command. | No |
-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 before deploying
the applications on their production application servers. If -isDeveloperServer is set when creating an IBM Business Process Manager profile, then a preconfigured VMM file repository is installed. This file repository contains a sample organization that can be used to test Business Process Choreographer people resolution, ready for you to use as is. |
No. This parameter is valid only for creating profiles on IBM Business Process Manager. |
-keyStorePasswordkeyStore_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. | No |
-listAugments | Lists the registered augments on a profile that is in the profile registry. You must specify the -profileName parameter with the -listAugments parameter. | No |
-listProfiles | Lists all defined profiles. | No |
-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 workstation. Each profile that shares the same set of product
binary files must have a unique node name. This parameter is required
for profile creation only with the dmgr.esbserverdefault.procsvrdefault.procctrdefault.procsvr.advdefault.procctr.advdmgr.procctrmanaged.procctrmanaged.procsvr templates. The default value for this parameter
is based on the short host name, profile type, and a trailing number,
for example:
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 characters: *, ?, ", <, >, ,, /, \, and |, . |
No. Do not supply this parameter when augmenting an existing profile. |
-omitAction feature1 feature2... featureN | An optional parameter that excludes profile
features. Each profile template comes predefined with certain optional
features. The following optional features can be used with the -omitAction parameter
for the following profile templates:
|
No |
-perfDWDbName perfDW_Db_Name | Database name for Performance Data Warehouse. If you are using Oracle, the value specified for -perfDWDbName and -procSvrDbName can be the same. If you are using any other supported database, the value specified for -perfDWDbName and -procSvrDbName must be different. Do not use this parameter if you are using -bpmdbDesign. |
No |
-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 quotation marks. This default personal certificate is in the server keystore file. See the -personalCertValidityPeriod parameter and the -keyStorePassword parameter. | No. The -personalCertDN parameter is mutually exclusive with the parameter -importPersonalCertKSType. |
-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. | No |
-portsFile file_path | An optional parameter that specifies the path
to a file that defines port settings for the new profile. Do not supply
this parameter when augmenting an existing profile. Do not use this parameter when using the -startingPort or -defaultPorts parameter. During profile creation, the manageprofiles command-line utility 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. |
No |
-processCenterPassword | Specifies the user password to be used to connect to the Process Center. This parameter is valid for stand-alone Process Server profiles. | This parameter is required if the Process Server is online (connected to a Process Center). It is required for a stand-alone process server (standard or advanced) profile if the processCenterURL parameter is specified. |
-processCenterUserId | Specifies the user ID to be used to connect to the Process Center. This parameter is valid for stand-alone Process Server profiles. | This parameter is required if the Process Server is online (connected to a Process Center). It is required for a stand-alone process server (standard or advanced) profile if the processCenterURL parameter is specified. |
-processCenterURL | Specifies the URL of the Process Center that
the Process Server connects to. If this parameter is set, the protocol
must be either http or https. Note: No
corresponding useServerOffline parameter exists
to use the server offline.
To use the server offline, omit the processCenterURL parameter. |
No |
-procSvrDbName | Database name for Process Server database. If you are using Oracle, the value specified for -procSvrDbName and -perfDWDbName can be the same. If you are using any other supported database, the value specified for -procSvrDbName and -perfDWDbName must be different. Do not use this parameter if you are using -bpmdbDesign. |
No |
-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 binary files must have a unique name. The default profile
name is based on the profile type and a trailing number, for example:
where profileType is
a value such as ProcSrv, 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 characters: *, ?, ", <, >, ,, /, \, and |. The profile name that you choose must not be in use. |
Required when augmenting a profile. |
-profilePath profile_root | Specifies the fully qualified path to the profile,
which is referred to throughout the information center as the profile_root. For
example:
On Windows platforms: If the fully qualified path contains spaces, enclose the value in quotation marks. The default value is based on the install_root directory, the profiles subdirectory, and the name of the file. For example,
the default for profile creation is:
where WS_WSPROFILE_DEFAULT_PROFILE_HOME is
defined in the wasprofile.properties file in
the install_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. |
No. Use this parameter when creating profiles only. Do not set this parameter for augmenting an existing profile. |
-response response_file | Accesses all API functions from the command
line using the manageprofiles command-line
utility. 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. The following example is
a response file for a create operation:
Important: Ensure that you do not leave
blank spaces after the values; for example 'personalCertValidityPeriod=1
' or 'winserviceCheck=false '. Spaces cause
profile creation to fail.
On Windows platforms: 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:
When adding properties that denote distinguished
names for certificates, commas must be preceded by double back slashes
(\\). Note that the separator between the key (personalCertDN)
and the value is not an equals sign, it is a blank space. This is
because the equals sign occurs within the property value. Here is
an example of a response file cert entry statement using double back
slashes:
To determine which input arguments are required for the various types of profile templates and action, use the manageprofiles command-line utility with the -help parameter. |
No. Note: If
you use the -response parameter, it must be the
only parameter on the command line. If you include any manageprofiles parameters
(in addition to -response) on the command-line,
the response file is ignored.
|
-restoreProfile | Restores a profile backup. This parameter is not supported for IBM Business Process Manager. | No |
-serverName serverName | Specifies the name of the server. Specify this parameter only for the default.procctr, default.procctr.adv, default.procsvr, and default.procsvr.adv templates. If you do not specify this parameter, the default server name is server1 for the default profile. | No. Note: Do not set this parameter if you are
augmenting an existing profile.
|
-serviceUserName service_user_ID | Specifies the user ID that is used during the creation of the Linux service so that the Linux service will run under this user ID. The Linux service runs whenever the user ID is logged on. | No |
-setDefaultName | Sets the default profile to one of the existing
profiles. Must be used with the -profileName parameter,
as shown in the following example:
|
No |
-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 quotation marks. This default personal certificate is in the server keystore file. If you do not specifically create or import a root signing certificate, one is created by default. See the -signingCertValidityPeriod parameter and the -keyStorePassword. | No. The -signingCertDN parameter is mutually exclusive with the -importSigningCertKS parameter. |
-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 20 years. | No |
-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-line utility 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. |
No. Do not set this parameter if you are augmenting
an existing profile. 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 have any. Use absolute paths. This parameter must exist as a directory and point to a valid template directory. Use the following templates with IBM Business Process Manager:
|
Required when creating or augmenting profiles. |
-unaugment | Note: Using
profiles that were unaugmented (-unaugment parameter)
is not supported.
|
No |
-unaugmentAll | Unaugments all profiles that were 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. |
No |
-unaugmentDependents true|false | If it is set to true,
the parameter unaugments all the augmented profiles that are prerequisites
to the profiles being unaugmented with the -unaugmentAll parameter.
The default value for this parameter is false. Optionally, specify the -unaugmentDependents parameter with the -unaugmentAll parameter. |
No |
-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. | No |
-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. | No |
-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. | No |
-webFormConfig true | false | Indicates if Business Space is configured to
use IBM Forms Server to work
with Human Task Management widgets. The default value for this parameter
is false. Indicate true to configure
Business Space to use IBM Forms
Server. Both the webFormConfig and webFormInstallRoot parameters
are required to configure IBM Forms
Server. This parameter is valid for stand-alone server profiles only. Note: IBM Forms Server configuration using
these parameters is only valid for local IBM Forms
Server installations.
|
No |
-webFormHTTP URL | Specifies the location of the IBM Forms Server Translator. The default URL for the location is http://localhost:8085/translator. | No. This parameter is valid only if the -webFormConfig parameter is set to true. It is valid for stand-alone server profiles only. |
-webFormInstallRoot Webform_Server_install_root | Specifies the full path where IBM Forms Server is installed. For example, the IBM Forms Server installation root might be C:/IBM/IBMFormsServer/4.0/WebFormServer. | No. This parameter is valid only if the -webFormConfig parameter is set to true. It is valid for stand-alone server profiles only. |
-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. | No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
-webServerHostname webserver_host_name | The host name of the server. The default value for this parameter is the long host name of the local workstation. | No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
-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 workstation and the value of the webServerType parameter.
For example:
|
No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
-webServerName webserver_name | The name of the web server. The default value for this parameter is webserver1. | No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
-webServerOS webserver_operating_system | The operating system where the web server resides. Valid values include: windows, linux, solaris, aix, hpux, os390, and os400. Use this parameter with the webServerType parameter. | No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
-webServerPluginPath webserver_pluginpath | The path to the plug-ins that the web server uses. The default value for this parameter is install_root/plugins. | No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
-webServerPort webserver_port | Indicates the port from where the web server will be accessed. The default value for this parameter is 80. | No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
-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. | No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
-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. |
No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
-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: If you are setting -dbType MSSQLSERVER_MICROSOFT, -dbWinAuth
true, and -winserviceCheck true, you must
also set -winserviceAccountType specifieduser, -winserviceUserName dbUser,
and -winservicePassword dbPassword.
|
No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
-winservicePassword winservice_password | Specify the password for the specified user or the local account that is to own the Windows service. | No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
-winserviceStartupType manual | automatic | disabled | The following values for Windows service startup can be used:
The default value for this parameter is manual. |
No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
-winserviceUserName winservice_user_ID | Specify your user ID so that the Windows operating system can verify you as
an ID that can create a Windows service.
Your user ID must belong to the Administrator group and have the following
advanced user rights:
|
No. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile. |
For stand-alone configurations only, when you configure the Process Server database, the Process Server messaging engine tables are created in the Process Server database. When you configure the Performance Data Warehouse database, the Performance Data Warehouse messaging engine tables are created in the Performance Data Warehouse database. The Service Component Architecture (SCA) system, SCA application, Common Event Infrastructure (CEI), and Business Process Choreographer messaging engine tables are all created in the Common database.
Because all the components use the same Oracle instance, there is no difference in the databases used for individual components.
For stand-alone configurations only, when you configure the Process Server database, the Process Server messaging engine tables are created in the Process Server database. When you configure the Performance Data Warehouse database, the Performance Data Warehouse messaging engine tables are created in the Performance Data Warehouse database. The Service Component Architecture (SCA) system, SCA application, and Common Event Infrastructure (CEI) messaging engine tables are all created in the Common database.