WebSphere Enterprise Service Bus, Version 6.2.0 Operating Systems: AIX, HP-UX, i5/OS, Linux, Solaris, Windows


manageprofiles parameters

Use the following parameters with the manageprofiles command for WebSphere® ESB.

The manageprofiles command file is located in the install_root/bin directory. The command file is a script named manageprofiles for i5/OS® platforms, manageprofiles.sh for Linux® and UNIX® platforms, or manageprofiles.bat for Windows® platforms.

Before you begin using the manageprofiles command, make sure that you understand all prerequisites for creating and augmenting profiles. For more information about prerequisites, see Prerequisites for creating or augmenting profiles. For more information about creating and augmenting profiles, see Creating profiles using the manageprofiles command and Augmenting profiles using the manageprofiles command.

Attention: When creating a WebSphere ESB profile, use only the parameters that are documented in the information center for WebSphere ESB.
Note: All parameters are case-sensitive.

The following options are available for the manageprofiles command:

-adminUserName adminUser_ID
Specifies the user ID that is used for administrative security. For augmenting an existing profile that has administrative security enabled, this parameter is required.
-adminPassword adminPassword
Specifies the password for the administrative security user ID specified with the -adminUserName parameter. For augmenting an existing profile that has administrative security enabled, this parameter is required.
-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: 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.
Specify the fully qualified file path for -templatePath. For example:
manageprofiles(.bat)(.sh) -augment -profileName profile_name
 -templatePath fully_qualified_template_path
-backupProfile
Performs a file system back up of a profile folder and the profile metadata from the profile registry file.

This parameter is not supported with WebSphere ESB.

-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.
-cbeServerName
The name of the server where the WebSphere ESB Common Base Event Browser is configured to run.
-ceiBufferPool4k
Specifies the name of the 4K buffer pool for the Common Event Infrastructure. This buffer pool must be active before the database DDL scripts can be run.
Note: Deprecated in 6.2 for all databases except DB2® for z/OS®.
-ceiBufferPool8k
Specifies the name of the 8K buffer pool for the Common Event Infrastructure. This buffer pool must be active before the database DDL scripts can be run.
Note: Deprecated in 6.2 for all databases except DB2 for z/OS.
-ceiBufferPool16k
Specifies the name of the 16K buffer pool for the Common Event Infrastructure. This buffer pool must be active before the database DDL scripts can be run.
Note: Deprecated in 6.2 for all databases except DB2 for z/OS.
-ceiDbInstallDir
The directory where the database is installed for the Common Event Infrastructure. This parameter is required only if you specified true for the dbDelayConfig parameter.
-ceiDbName
The name of the Common Event Infrastructure event database to be created. For DB2 databases, Derby databases, Informix® databases, and Microsoft® SQL Server databases, the default value is event if not specified. For DB2 iSeries® (i5/OS) Native databases, the default value is *LOCAL if not specified. For DB2 iSeries (i5/OS) Toolbox databases, the default value is *SYSBAS if not specified.

For Oracle databases, the Oracle System Identifier (SID) must have been already created and available for the event service command to create the tables and populate the tables with data. The default value is orcl if not specified.

-ceiDbNodeName
The DB2 node name (must be 8 characters or less) for the Common Event Infrastructure. This node must be already cataloged and configured to communicate with the DB2 server. This parameter must be set if the current workstation is configured as a DB2 client and the parameter dbDelayConfig is set to true.
Note: Deprecated in 6.2 for all databases except DB2 client.
-ceiDbUser
Note: Deprecated in 6.2 for all databases except Microsoft SQL Server.
Specifies the user ID to use for the Common Event Infrastructure event database.
For DB2 databases, the default value is db2inst1 if not specified. For DB2 for z/OS databases, it specifies the user ID that has privileges to create and drop the databases. This parameter is required.
For i5/OS operating system For iSeries (i5/OS) databases, it specifies the user ID that has privileges to create and drop the databases. This parameter is required.
For Derby databases, it is the user ID used by the data source for the Derby database authentication. This parameter is optional when the WebSphere domain security is disabled and is required when the WebSphere domain security is enabled.
For Informix databases, it specifies the Informix database schema user ID that will own the event service database tables. The WebSphere data source uses this user ID to authenticate the Informix database connection. This parameter is required.
For Oracle databases, it specifies the Oracle schema user ID that will own the event service Oracle tables. The user ID will be created during the database creation and the WebSphere data source uses this user ID to authenticate the Oracle database connection. The default value is ceiuser if not specified.
For Microsoft SQL Server databases, it specifies the SQL Server user ID that will own the event service tables. The default value is ceiuser if not specified.
-dbCeiUserId
For Oracle databases, specifies the CEI user ID.
-dbUserId
Specifies the user ID to use for the Common Event Infrastructure event database.
For DB2 databases, the default value is db2inst1 if not specified. For DB2 for z/OS databases, it specifies the user ID that has privileges to create and drop the databases. This parameter is required.
For i5/OS operating system For iSeries (i5/OS) databases, it specifies the user ID that has privileges to create and drop the databases. This parameter is required.
For Derby databases, it is the user ID used by the data source for the Derby database authentication. This parameter is optional when the WebSphere domain security is disabled and is required when the WebSphere domain security is enabled.
For Informix databases, it specifies the Informix database schema user ID that will own the event service database tables. The WebSphere data source uses this user ID to authenticate the Informix database connection. This parameter is required.
For Oracle databases, it specifies the Oracle schema user ID that will own the event service Oracle tables. The user ID will be created during the database creation and the WebSphere data source uses this user ID to authenticate the Oracle database connection. The default value is ceiuser if not specified.
For Microsoft SQL Server databases, it specifies the SQL Server user ID that will own the event service tables. The default value is ceiuser if not specified.
-ceiDiskSizeInMB
The database size in MB to be created for the Common Event Infrastructure event database. The lowest value that can be set is 10 MB. For DB2 for z/OS, the default value is 100 MB if not specified.
Note: Deprecated in 6.2 for all databases except DB2 for z/OS.
-ceiInstancePrefix
For Informix, Oracle, and Microsoft SQL Server databases, the command uses the Common Event Infrastructure event database instance name to group the database files in a directory with unique names. The default value is ceiinst1 if not specified.
Note: Deprecated in 6.2 for all databases except Informix, Oracle, Microsoft SQL Server.
-dbLocation
The directory of the ORACLE_HOME. This parameter is required when the parameter dbDelayConfig is set to true.
-ceiOverrideDataSource
When this parameter is set to true, the command removes any existing Common Event Infrastructure service data source at the specified scope before creating a new one. When this parameter is set to false, the command does not create an event service data source at the specified scope if another event service data source is found at the same scope. The default value is false if not specified.
-ceiSaUser
The Microsoft SQL Server ID that has privileges to create tables, devices, and caches for the Common Event Infrastructure. This parameter is required if the dbDelayConfig parameter is set to true.
Note: Deprecated in 6.2 for all databases except Microsoft SQL Server.
-ceiSaPassword
The password for the Microsoft SQL Server ID that has privileges to create tables, devices, and caches for the Common Event Infrastructure. This parameter is required if you specify a value for the ceiSaUser parameter, unless the sa user ID does not have a password.
Note: Deprecated in 6.2 for all databases except Microsoft SQL Server.
-cellName cell_name
Specifies the cell name of the profile for the Common Event Infrastructure. Use a unique cell name for each profile. This parameter is for profile creation only. Do not supply this parameter when augmenting an existing 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:
if (DMgr)
	shortHostNameCellCellNumber
else
	shortHostNameNodeNodeNumberCell
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: *, ?, ", <, >, ,, /, \, and |.

-configureBSpace true | false
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: Derby Embedded, Derby Network Server, DB2 Universal, DB2 Universal Runtime Client, DB2 for i5/OS, DB2 for z/OS, Oracle 9i, Oracle 10g, and Oracle 11g.
Important: If the Common database you use for WebSphere ESB does not match the supported databases for Business Space, the manageprofiles command uses a Derby Embedded database for the Business Space configuration. You cannot federate this profile into a deployment environment later, because Derby Embedded is not supported for deployment environments.
For more information about configuring Business Space for deployment environments, see Configuring Business Space under Related information.
-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.esbserver: for a WebSphere Enterprise Service Bus stand-alone server profile, which defines a stand-alone server.
  • dmgr.esbserver: for a WebSphere Enterprise Service Bus deployment manager profile, which defines a deployment manager.
  • managed.esbserver: for a WebSphere Enterprise Service Bus custom profile, which, when federated to a deployment manager, defines a managed node.
-dbCommonForME
Indicates whether to use the Common database for messaging engines. For DB2 for z/OS databases, the default value is true. For all other databases, the default value is false. If this parameter is set to false, the messaging engines will use a file store data store.
-dbConnectionLocation
The location of DB2 for z/OS database.
-dbCreateNew
Indicates if you will create or reuse a database. Valid values are true or false.
-dbDelayConfig
Indicates if you will postpone table creation until after the profile is created. Valid values are true or false. The parameter is set to false by default.
-dbDriverType
The database driver type. For Oracle databases, valid values are ORACLE_THIN or ORACLE_OCI. For DB2 databases, valid values are 2 or 4.
-dbHostName
The database server host name or IP address. The default value is localhost.
-dbInstance
The database instance name for Informix databases.
-dbJDBCClasspath
The location of JDBC driver files.
-dbLocation
Indicates the database installation directory if you are using Informix databases. You can only use this parameter if the dbCreateNew parameter is set to true.
-dbName
The name of the database. The value is set to WPRCSDB by default.
-dbOutputScriptDir
The location for exported database scripts.
-dbPassword
The password required for database authentication. This parameter is required for all databases except Derby Embedded.
-dbSchemaName
The database schema name for DB2 for iSeries, DB2 for i5/OS, and DB2 for z/OS databases.
Note: This parameter is not valid for use with the DB2 Universal database.
-dbServerPort
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.
-dbStorageGroup
The storage group name for DB2 z/OS databases.
-dbType
The database type.

Set one of the following values for the type of database product you are using with WebSphere ESB.

  • DERBY_EMBEDDED for a Derby Embedded database
  • DERBY_NETWORKSERVER for a Derby Network Server database
  • DB2_UNIVERSAL for a DB2 Universal database
  • DB2UDBOS390_V8_1 for a DB2 for z/OS v8 database
  • DB2UDBOS390_V9_1 for a DB2 for z/OS v9 database
  • DB2UDBISERIES_NATIVE for a DB2 UDB for iSeries or DB2 for i5/OS database using a Native driver
  • DB2UDBISERIES_TOOLBOX for a DB2 UDB for iSeries or DB2 for i5/OS database using a Toolbox driver
  • INFORMIX for an Informix Dynamic Server database
  • MSSQLSERVER_EMBEDDED for a Microsoft SQL Server database using an Embedded driver
  • MSSQLSERVER_DATADIRECT for a Microsoft SQL Server database using a DataDirect driver
  • MSSQLSERVER_MICROSOFT for a Microsoft SQL Server database using a Microsoft driver
    Note: Support for the Microsoft SQL Server JDBC Driver, version 1.2 Microsoft SQL Server (Microsoft) driver was added in WebSphere Process Server, version 6.2.0.1.
  • ORACLE9I for an Oracle 9i database
  • ORACLE10G for an Oracle 10g or Oracle 11g database
-debug
Turns on the debug function of the Apache 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.

Deleting a profile does not delete the profile directory. For example, if you create a profile in the /usr/WebSphere/ESB/profiles/managedProfile directory or on i5/OS platforms, in the QIBM/UserData/WebSphere/ESB/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.

-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/ESB/profiles/managedProfile directory or on i5/OS platforms, in the QIBM/UserData/WebSphere/ESB/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.

-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.esbserver profile template.

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 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 profile's 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 |. 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 or augmented. The deployment manager must be running and accessible.

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 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.

-enableAdminSecurity true | false
Enables administrative security. Valid values include true or false. The default value is false. If you are creating profiles for a deployment environment, you must set this parameter to true. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile.
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 installation, 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.
For Linux operating system -enableService true | false
Enables the creation of a Linux service. Valid values include true or false. The default value for this parameter is false. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile.

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 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.

-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 you are creating a WebSphere ESB profile, do not supply a value; use the default of true.
-federateLaterWESB true | false
Indicates if the managed profile will be federated later using the managed.wesbserver 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.
-fileStoreForME true | false
If set to true, the file store data store will be used for the messaging engines. The default value for this parameter is false.
Note: The -dbCommonForME and -fileStoreForME parameters cannot both be set to true. This causes a validation error.
-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. Do not supply this parameter when augmenting an existing 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: *, ?, ", <, >, ,, /, \, and |.
-ignoreStack
An optional parameter that is used with the -templatePath parameter to unaugment a particular profile that has been augmented.
Note: Using profiles that have been unaugmented (-unaugment parameter) is not supported for WebSphere ESB.
-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. This parameter is valid only for creating profiles on WebSphere ESB.
If -isDeveloperServer is set when creating a WebSphere ESB profile, then a preconfigured VMM file repository is installed.
-listProfiles
Lists all defined profiles.
-ndtopology
Indicates if you want to use the deployment environment path for creating the profile. Valid values are true or false.
-nodeName node_name
Specifies the node name for the node that is created with the new profile. Do not supply this parameter when augmenting an existing profile. Use a unique value within the cell or on the workstation. Each profile that shares the same set of product binaries must have a unique node name. This parameter is required for profile creation only with the default.wbiserver, dmgr.wbiserver, and managed.wbiserver templates.
For Linux operating systemFor UNIX operating systemFor Windows operating system The default value for this parameter is based on the short host name, profile type, and a trailing number, for example:
if (DMgr)
	shortHostNameCellManagerNodeNumber
else
	shortHostNameNodeNodeNumber
where NodeNumber is a sequential number starting at 01.
For i5/OS operating system 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 |, .

-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 the product 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
  • dmgr - Deployment manager
    • deployAdminConsole
-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 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 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: *, ?, ", <, >, ,, /, \, and |. 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.
For example:
-profilePath profile_root
Use this parameter when creating profiles only. Do not set this parameter for augmenting an existing profile.

For Windows operating system 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:
WS_WSPROFILE_DEFAULT_PROFILE_HOME/profileName
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.

-response response_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. The following is an example response file for a create operation:
create
profileName=testResponseFileCreate
profilePath=profile_root
templatePath=install_root/profileTemplates/default
nodeName=myNodeName
cellName=myCellName
hostName=myHostName
omitAction=myOptionalAction1, myOptionalAction2
For Windows operating system 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:
create
templatePath=C:\\WebSphere\\ESB\\profileTemplates\\default

To determine which input arguments are required for the various types of profile templates and action, use the manageprofiles command with the -help parameter.

-restoreProfile
Restores a profile backup. Must be used with the -backupFile parameter. This parameter is not supported for WebSphere ESB.
-samplesPassword samplesPassword
Creates a password to be used for samples. The password is used to restrict access to Web application samples installed during the installation of the application server.
For Linux operating system -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.
-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.

Do not set this parameter if you are augmenting an existing profile. Port values are assigned sequentially from the -startingPort value, omitting those ports that are already in use. On all systems, except i5/OS, 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.

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 WebSphere ESB:
  • default.esbserver: for a WebSphere Enterprise Service Bus stand-alone server profile, which defines a stand-alone server.
  • dmgr.esbserver: for a WebSphere Enterprise Service Bus deployment manager profile, which defines a deployment manager.
  • managed.esbserver: for a WebSphere Enterprise Service Bus custom profile, which, when federated to a deployment manager, defines a managed node.
-topologyPattern
Determines the deployment environment patterns for the deployment manager you are creating. Valid values are CondensedSync, CondensedAsync or Reference.
-topologyRole
Indicates the function that the profile will play in the deployment environment, when you are federating a profile that has been created. Valid values are ADT for a deployment target, Messaging for host messaging or Support for supporting services. You can indicate one value or more than one value, each separated by a space, for example ADT Messaging Support or Messaging or ADT Support.
-unaugment
Note: Using profiles that have been unaugmented (-unaugment parameter) is not supported for WebSphere ESB.
-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. 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. 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. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile.
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:
For AIX operating system
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”

For HP-UX operating system
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”

For Linux operating system
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”

For Solaris operating system
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”

For Windows operating system
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”
-webServerName webserver_name
The name of the Web server. The default value for this parameter is webserver1. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile.
-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.
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. 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. 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. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile.
For Windows operating system -winserviceAccountType specifieduser | localsystem
The type of the owner account of the Windows service created for the profile. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing 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 system.
For Windows operating system -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.
Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile.
For Windows operating system -winservicePassword winservice_password
Specify the password for the specified user or the local account that is to own the Windows service. Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile.
For Windows operating system -winserviceStartupType manual | automatic | disabled
Possible values for Windows service startup are:
  • manual
  • automatic
  • disabled

The default value for this parameter is manual.

Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile.

For Windows operating system -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:
  • Act 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 |. 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.
Use this parameter when creating profiles only. Do not supply this parameter when augmenting an existing profile.

reference Reference topic

Terms of use | Feedback


Timestamp icon Last updated: 21 June 2010


http://publib.boulder.ibm.com/infocenter/dmndhelp/v6r2mx/topic//com.ibm.websphere.wesb620.doc/doc/rins_manageprofiles_parms.html
Copyright IBM Corporation 2005, 2010. All Rights Reserved.
This information center is powered by Eclipse technology (http://www.eclipse.org).