Stand-alone profiles
You can use the manageprofiles.bat or manageprofiles.sh command to create or augment stand-alone profiles.
This command is found in the app_server_root/bin directory.
To
install or run the manageprofiles command on Windows,
you must elevate your Microsoft Windows user account privileges by
using the runas command. Remember to put double
quotation marks around the manageprofiles command
and all parameters. For example:
runas /env /user:MyAdminName "manageprofiles.bat -create -profileName WBMON01 -templatePath C:\Program Files\IBM\WebSphere\AppServer\profileTemplates\wbmonitor\default -wbmDBJDBCClasspath C:\Program Files\IBM\WebSphere\AppServer\jdbcdrivers\DB2" Purpose
This command creates stand-alone IBM® Business Monitor profiles, which are used for single-server installations. For examples, see the Examples section.Parameters
To create or augment a stand-alone profile, use the manageprofiles command with the following parameters.| Parameter and value | Required? | Description | Comments |
|---|---|---|---|
| -create | Required for profile creation | Create a profile. | Do not use for profile augmentation. |
| -augment | Required for profile augmentation | Augment an existing profile. | Do not use for profile creation. Restriction: You cannot augment an IBM Business
Process Manager profile
with IBM Business Monitor.
|
-templatePath app_server_root /profileTemplates/ |
Required | The location of the IBM Business Monitor template for stand-alone profiles. | |
| -profileName profile_name | Required for profile augmentation | The name of the profile. | A default name is supplied for profile creation if you do not provide one. |
| -cellName cell_name | Optional | The cell name of the profile. | The default is the cell name of the profile as defined by WebSphere® Application Server. |
| -nodeName node_name | Optional | The node name of the profile. | The default is the node name of the profile as defined by WebSphere Application Server. |
| -adminUserName user_name | Required if -enable Admin Security is set to true or if this is an augmentation of a profile that has WebSphere Application Server security enabled. | The user name of the WebSphere Application Server administrator. | |
| -adminPassword password | Required if -enable Admin Security is set to true or if this is an augmentation of a profile that has WebSphere Application Server security enabled. | The password of the WebSphere Application Server administrator. | |
| -configureRESTSecurity true | false | Optional | Whether to configure security for the IBM Business Monitor Rest Services gateway. | The default value is false. |
| -enableAdminSecurity true | false | Optional | Whether WebSphere Application Server security is enabled for the profile being created. | The default is true for a new IBM Business Monitor profile. If a profile is being augmented, this value is ignored. |
| -profilePath path | Optional | The root directory for the profile being created or augmented, as defined by WebSphere Application Server. | For example, profile_root/StandAloneServer1. Refer to the WebSphere Application Server documentation for more information. |
| -washome app_server_root | Optional | The root directory where WebSphere Application Server is installed. | |
| -installShowcase true | false | Optional | Whether to install the Showcase model with IBM Business Monitor. | The default is false. |
| -samplesPassword sample_pw | Required when you are using Samples; not used otherwise | ||
| MONITOR database configuration | |||
-wbmDBType DB2_DATASERVER | DB2UDBOS390 | Oracle11g | |
Optional | The type of database. | Use DB2_DATASERVER for connecting to DB2®. Use Oracle11g for connecting to either Oracle 10g or Oracle 11g. Use DB2UDBOS390 for connecting to DB2 for z/OS®. Use MSSQLSERVER_MICROSOFT for connecting to Microsoft SQL Server. |
| -wbmDBDelayConfig true | false | Optional | If you ignore this parameter or set the value to false, a local database is created on the machine where the profile is created. If you set the value to true, the database and all required tables are not created during the installation. You can use existing tables that have been created previously, or you can use the database scripts to create the database and tables manually. | The default value is false. The DDLs are generated
regardless of the value of this parameter. If you do not have a local database client that can run SQL statements against your database, you must set this value to true. Note: If the database server contains multiple versions
of DB2 installed,
or multiple DB2 instances,
profile creation will use the server's default DB2 version or
instance. To control which DB2 version or
instance is used, use the "Installing the database manually" procedure
so that the database administrator can ensure that the proper DB2 version or
instance is used.
|
| -wbmDBOutputScriptDir output_script_directory | Optional | The directory where the DDLs will be created. The generated DDLs can be run manually on the database server. | The default value is profile_root/dbscripts/Monitor. |
| -wbmDBSchemaName database_schema_name | Optional | The name of the schema. | The default value is MONITOR. If you are using DB2 for z/OS, the IBM Business Monitor database schema name must be different from the Process Server common database schema name to prevent collisions between database objects. |
| -wbmDBName database_name | Optional | The name of the database. | For DB2, the default value is MONITOR. If you are using Oracle, it should be set to the Oracle service name. |
| -wbmDBUserId database_user_name | Required | The user name to access the database. | |
| -wbmDBPassword database_password | Required | The password for the specified user. | |
| -wbmDBJDBCClasspath database_JDBC_classpath | Optional | The path to the JDBC driver for the database. | If wbmDBType is set to DB2_DATASERVER or DB2UDBOS390,
the default value is monitor_root/jdbcdrivers/DB2. If wbmDBType is set to Oracle11g, the default value is monitor_root/jdbcdrivers/Oracle. If wbmDBType is set to MSSQLSERVER_MICROSOFT, the default value is monitor_root/jdbcdrivers/SQLServer. |
| -wbmDBHostName host_name | Required | The host name for the database server. | The default value is localhost. |
| -wbmDBServerPort port_number | Required | The port where the TCP/IP service is assigned or the port on which the database is listening. | The following values are the defaults, based
on the value of wbmDBType:
|
| -wbmDBDriverType 2 | 4 | Required if wbmDBType is Oracle11g | The driver type for the database. | For an Oracle database,
specify either 2 or 4. A value of 2 corresponds to the OCI driver
and a value of 4 corresponds to the Thin driver. The default is 4. 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. This parameter is not used for SQL Server. |
| -wbmDBSysUserId system_user_name | Required if wbmDBType is Oracle11g or MSSQLSERVER_MICROSOFT and wbmDB DelayConfig is false | The name for the Oracle or SQL Server database administrator. This user must have access to create and drop databases and users. | This parameter is not required if wbmDBDelayConfig is true and the database will be created at a later time. |
| -wbmDBSysPassword system_user_password | Required if wbmDBType is Oracle11g or MSSQLSERVER_MICROSOFT and wbmDB DelayConfig is false | The password for the specified Oracle or SQL Server database administrator. This user must have access to create and drop databases and users. | |
| -wbmDBSubsystem connection_location | Required for DB2 for z/OS | The location of the DB2 for z/OS database. | This parameter applies only to DB2 for z/OS. No spaces are allowed in the value. |
| -wbmDBStorageGroup storage_group_name | Optional | The storage group name. | This parameter applies only to DB2 for z/OS. |
| IBM Cognos® BI content store database configuration | |||
| -wbmCognosCreateNewServerDB true | false | Optional | Whether to create a new IBM Cognos BI content store database. | The default value is true if the app_server_root/Cognos directory
exists, and false otherwise. This value must not be the same as the wbmCognosUseExistingServer value. |
| -wbmCognosDBName database_name | Optional | The name of the database to use for the IBM Cognos BI content store database. | The default value is COGNOSCS. This database name must be different from the wbmDBName (the IBM Business Monitor database name) if the wbmDBType is MSSQLSERVER_MICROSOFT. For Oracle, the wbmCognosDBname is the Oracle service name. |
| -wbmCognosDBUserName database_user_name | Optional | The user name for creating the IBM Cognos BI content store database. | This user name must have credentials to create
tables. The default value is the wbmDBUserName value. Because the database user provided for accessing the content store database must have privilege to create tables in the database, it is recommended that you create a new database user for the content store database only. |
| -wbmCognosDBPassword database_password | Optional | The password for the supplied database user name. | The default value is the wbmDBPassword value. If the wbmCognosDBUserName is the same as the wbmDBUserName, the passwords must also be the same. |
| -wbmCognosUseExistingServer true | false | Optional | Whether to use an existing IBM Cognos BI server. | The default value is true if the app_server_root/Cognos directory
does not exist, and false otherwise. This value must not be the same as the wbmCognosCreateNewServerDB value. |
| -wbmCognosUrl external dispatcher_uri | Optional | The external dispatcher URI of the IBM Cognos BI server. You can find this URI in the IBM Cognos BI configuration client in (for example, http://my_host:my_port/p2pd/servlet/dispatch/ext). |
The IBM Cognos BI server does not have to be available to set this value. The server is required when you install monitor models if you want to perform multidimensional analysis for those models. |
| -wbmCognosAdminUserName user_name | Optional | The administrator user name for the existing IBM Cognos BI server. | There is no default value. The IBM Cognos BI server does not have to be available to set this value. |
| -wbmCognosAdminPassword password | Optional | The password for the supplied administrator user name. | There is no default value. The IBM Cognos BI server does not have to be available to set this value. |
| Common Event Infrastructure Database configuration | |||
-ceiDbProduct DERBY_EMBEDDED | CEI_DB_DB2 | |
Optional | The database product used for the CEI event
database. The default value for stand-alone profiles is CEI_DB_DERBY_EMBEDDED. Use CEI_DB_DB2 for DB2. Use CEI_DB_ORACLE for connecting to either Oracle 10g or Oracle 11g. Use CEI_DB2_ZOS for connecting to DB2 for z/OS, version 8 or 9.1. Use CEI_DB_SQL_SERVER for SQL Server. |
IBM Business Monitor does not require a CEI database and it is not recommended because it is inefficient at handling IBM Business Monitor events. For a better way to view events, see "Managing recorded events." |
| -ceiOutputScriptDir output_script_directory | Optional | The location for the generated database configuration scripts, which you can use to manually configure the event database at any time | |
| -wbmCeiDbName database_name | Optional | The name of the CEI event database to be created | For DB2 and SQL Server databases,
the default value is event if not specified. For Oracle databases, the Oracle service name 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. |
| -ceiDbExecuteScripts true | false | Optional | If you ignore this parameter or set the value to true, this command generates and runs the DDL CEI event database configuration scripts. | The default is true. To create the database
automatically, the system must already be configured to run the database
commands. Use false if you plan to create the CEI database manually or if you already have one. If this parameter is set to false, the scripts are generated but are not run. You must then run the database configuration scripts to complete the database configuration. |
| -ceiOverrideDataSource true | false | Optional | If you set the value to true, this command removes any existing CEI service data source at the specified scope before creating a new one. When this parameter is ignored or the value 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. |
| -ceiDbUser user_name | Required (if you choose to create a CEI database) for DB2, Oracle, and SQL Server databases, and for Derby databases if WebSphere domain security is enabled | The user name for the CEI event database. | For Derby databases, the default is the WebSphere Application
Server user name
if security is enabled, and blank otherwise. For DB2 databases, the default value is db2inst1. For Oracle databases, this user ID specifies the Oracle schema user ID that will own the event service Oracle tables. The user ID is 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 SQL Server databases, the default value is ceiuser if not specified. |
| -ceiDbPassword password | Required (if you choose to create a CEI database) if ceiDbUser is specified | The password for the ceiDbUser. | The ceiDbPassword is required for all databases
except Derby. With Derby Network Server, ceiDbPassword is required
if administrative security is enabled. For Oracle databases, this parameter is the password of the schema user ID, created during the database creation. The WebSphere data source uses this password to authenticate the Oracle database connection. |
| -ceiJDBCClassPath JDBC_classpath | Required (if you choose to create a CEI database) for DB2, Oracle and SQL Server databases | For DB2, Oracle and SQL Server databases, the path to the JDBC driver for CEI. | Specify only the path to the driver file; do
not specify the file name. For DB2, the default value is app_server_root/jdbcdrivers/DB2. |
| -ceiDbHostName host_name | Required (if you choose to create a CEI database) for DB2, Oracle and SQL Server databases | The host name of the machine where the CEI event database server is installed. | |
| -ceiDbPort port_number | Optional | The port number of the CEI event database instance. | For DB2 databases,
the default value is 50000 if not specified. For Oracle, the default value is 1521 if not specified. For SQL Server, the default value is 1433 if not specified. |
| -ceiDbNodeName node_name | Optional | The DB2 node name (must be eight characters or less) for CEI. You must supply this parameter only if you have a remote DB2 database instance (node) cataloged and you want to create the remote database (ceiDb Execute Scripts is set to true) | This node must be already cataloged and configured to communicate with the DB2 server. |
| -ceiDbNodeName node_name | Optional | The DB2 node name (must be eight characters or less) for CEI. You must supply this parameter only if you have a remote DB2 database instance (node) cataloged and you want to create the remote database (ceiDb Execute Scripts is set to true) | This node must be already cataloged and configured to communicate with the DB2 server. |
| -ceiDbSubSystemName subsystem_name | Required (if you choose to create a CEI database) for DB2 for z/OS | The location of the DB2 for z/OS database. | This parameter applies only to DB2 for z/OS. No spaces are allowed in the value. |
| -ceiBufferPool4K buffer_pool_name | Required (if you choose to create a CEI database) for DB2 for z/OS | The name of the 4K buffer pool for CEI. This buffer pool must be active before the database DDL scripts can be run. | This parameter applies only to DB2 for z/OS. |
| -ceiBufferPool8K buffer_pool_name | Required (if you choose to create a CEI database) for DB2 for z/OS | The name of the 8K buffer pool for CEI. This buffer pool must be active before the database DDL scripts can be run. | This parameter applies only to DB2 for z/OS. |
| -ceiBufferPool16K buffer_pool_name | Required (if you choose to create a CEI database) for DB2 for z/OS | The name of the 16K buffer pool for CEI. This buffer pool must be active before the database DDL scripts can be run. | This parameter applies only to DB2 for z/OS. |
| -ceiCacheSizeInMB cache_size | Optional | The size of the cache to be used for transaction logs. | |
| -ceiDbAliasName alias_name | Required (if you choose to create a CEI database) for DB2 for z/OS if ceiDb Execute Scripts is set to true | The name of the cataloged database on the DB2 client machine. | |
| -ceiDbInstallDir db_install_dir | Required (if you choose to create a CEI database) if ceiDb Execute Scripts is set to true | The directory where the CEI database is installed. | |
| -ceiDbServerName db_server_name | Optional | The server instance name for the CEI event database. | If you are using SQL Server, this parameter must be set if ceiDb Execute Scripts is set to true |
| -ceiDbSysUser system_user_name | Optional | The Oracle SYSUSER user name for the CEI event database. This user must have SYSDBA privileges. | This parameter applies only to Oracle databases. |
| -ceiDbSysPassword system_user_password | Optional | The password for the user specified by the ceiDbSysUser parameter. | This parameter applies only to Oracle databases. |
| -ceiSaUser system_user_name | Optional | The SQL Server system administrator user name for the CEI event database. This user must have system administrator privileges. | This parameter applies only to SQL Server databases. |
| -ceiSaPassword system_user_name | Optional | The password for the user specified by the ceiSaUser parameter. | This parameter applies only to SQL Server databases. |
| -ceiFindDeviceNumber db_server_name | Optional | The event database creates six devices for CEI. This keyword identifies the value of the first device number to be assigned to the new devices. | The default value is 10. |
| -ceiInstancePrefix instance_prefix | Optional | If you are using an Oracle database, enter the prefix used for the CEI instance name. This name is the file prefix for Oracle CEI table spaces and is useful if you have multiple server environments sharing a single Oracle database instance. | The default value is ceiinst1. This parameter applies only to Oracle databases. |
| -ceiOracleHome Oracle_home | Required (if you choose to create a CEI database) if ceiDb Product is set to CEI_DB_ ORACLE and ceiDb Execute Scripts is set to true | The root directory where the Oracle product was installed. | This parameter applies only to Oracle databases. |
| -ceiServerName CEI_server_name | Optional | The name of the server where the CEI service should be deployed in the runtime environment. The value must be a valid server for the profile. | The default value is the server that you are creating (if you are creating a profile), or the first server found (if you are augmenting an existing profile). |
| -ceiStorageGroup storage_group_name | Optional | The name of the DB2 for z/OS storage group that will be used by CEI to communicate with its database. For example, EVTSTO. | This parameter applies only to DB2 for z/OS. |
| -wbmCeiDiskSizeInMB disk_size | Optional | The database size in MB to be created for the CEI 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. |
| -wbmCeiEventCatalogDBName event_catalog_db_name | Required (if you choose to create a CEI database) for DB2 for z/OS | The name of the event catalog. | This parameter applies only to DB2 for z/OS. The default value is eventcat. |
| Monitor Messaging Engine configuration | |||
| -msFileStore true | false | Optional | If you set the value to true, a file store is used for the message store. A file store is a message store that uses files in a file system through the operating system. | This option is not available if you are using a clustered environment. Otherwise, the default value is true if the database type is any of the DB2 types, and false otherwise. |
| -msDataStore true | false | Optional | If you set the value to true, a data store is used for the message store. A data store is a message store that contains a set of tables that are accessible to all members of the cluster that hosts the messaging engine. | The default is false if the database type is any of the DB2 types, and true otherwise. |
| -dataStoreDefaultDataSource true | false | Optional | If you set the value to true, a default Derby-based datasource is created. | The default value is true. This command is only valid when the target is a server. |
| -dataStoreExistingDataSource true | false | Optional | If you set the value to true, an existing datasource is used for the data store. | The default value is false. |
| -dataStoreJndiName JNDI_name | Required if dataSource Existing DataSource is true | The JNDI name of the existing datasource to use. | |
| -dataStoreSchemaName schema_name | Required if dataSource Existing DataSource is true | The schema name of the existing datasource to use. | The default value is MONCM00. |
| -dataStoreAuthAlias authentication_alias_name | Required if dataSource Existing DataSource is true | The name of the authentication alias used to authenticate the messaging engine to the datasource. | |
| -dataStoreCreateTables true | false | Optional | If you ignore this parameter or set the value to true, the database tables for the data store are created. | |
| -fileStoreSameSetting true | false | Optional | If ms FileStore is true and you ignore this parameter or set the value to true, the default settings are used for the file store. | |
| -fileStoreDefaultLog true | false | Optional | If ms FileStore is true and you ignore this parameter or set the value to true, the default log location is used for the file store. | |
| -fileStoreDefaultPerm true | false | Optional | If ms FileStore is true and you ignore this parameter or set the value to true, the default permanent log location is used for the file store permanent log. | |
| -fileStoreLogLocation log_location | Required if ms FileStore is true and fileStore DefaultLog is false | The location for the log for the file store. | |
| -fileStorePermLocation permanent_log_location | Required if ms FileStore is true and fileStore DefaultPerm is false | The location for the permanent file store log. | |
| --fileStoreDefaultTemp true | false | Optional | If ms FileStore is true and you ignore this parameter or set the value to true, the default temporary log location is used for the file store temporary log. | |
| -fileStoreTempLocation temporary_log_location | Required if ms FileStore is true and fileStore SameSetting and fileStore DefaultTemp are false | The location for the temporary file store log. | |
| Business Space configuration | |||
| -configureBSpace true | false | Optional | If you ignore this parameter or set the value to true, Business Space is deployed and configured. | The default value is true. |
| -dbBSpaceUserId bspace_db_user_name | Optional - Oracle only | The user name for the Business Space database. | This parameter is needed if you are using an Oracle database
and you require your own Business Space schema. If
not, the default value (IBMBUSSP) will be set. This parameter is only for Oracle databases. |
| -dbBSpacePassword bspace_db_password | Optional - Oracle only | The password for the Business Space database. | This parameter is needed if you are using an Oracle database
and you need your own Business Space password.
Otherwise, the default value will be set in the following order: dbPassword
if it exists or IBMBUSSP This parameter is only for Oracle databases. |
| -bspaceAlreadyConfigured true | false | Optional | If you ignore this parameter or set the value to false, Business Space will be configured. If you set the value to true, no Business Space configuration will be performed. | The default value is false. |
| -bspaceAlreadyDeployed true | false | Optional | If you ignore this parameter or set the value to false, Business Space will be deployed. If you set the value to true, the profile creation will finish without deploying Business Space. | The default value is false. |
The following example shows the creation
of a stand-alone profile using a DB2 database,
with administrative security enabled:
manageprofiles.bat -create -templatePath "IBM\WebSphere\MonServer\profileTemplates\wbmonitor\default" -profileName StandAloneServer1 -profilePath "IBM\WebSphere\MonServer\profiles\StandAloneServer1" -wbmDBType DB2_DATASERVER -wbmDBDelayConfig true -wbmDBOutputScriptDir "DB_SCRIPT_DIR" -wbmDBSchemaName DB_SCHEMA -wbmDBName DB_NAME -wbmDBUserId DB_USER -wbmDBPassword DB_PW -wbmDBJDBCClasspath "IBM\WebSphere\MonServer\jdbcdrivers\DB2" -wbmDBHostName DB_HOST -wbmDBServerPort DB_PORT -wbmCognosCreateNewServerDB true -wbmCognosDBName COGNOS_DB_NAME -wbmCognosDBUserName COGNOS_DB_USER -wbmCognosDBPassword COGNOS_DB_PW -enableAdminSecurity true -adminUserName WAS_USER -adminPassword WAS_PW -configureBSpace true -winserviceCheck false -samplesPassword SAMPLE_PWThe
following example shows the creation of a stand-alone profile using
an Oracle database,
with administrative security enabled:
manageprofiles.bat -create -templatePath "IBM\WebSphere\MonServer\profileTemplates\wbmonitor\default" -profileName StandAloneServer1 -profilePath "IBM\WebSphere\MonServer\profiles\StandAloneServer1" -wbmDBType Oracle11g -wbmDBDelayConfig true -wbmDBOutputScriptDir "DB_SCRIPT_DIR" -wbmDBSchemaName DB_SCHEMA -wbmDBName DB_NAME -wbmDBUserId DB_USER -wbmDBPassword DB_PW -wbmDBJDBCClasspath "IBM\WebSphere\MonServer\jdbcdrivers\Oracle" -wbmDBHostName DB_HOST -wbmDBServerPort DB_PORT -wbmDBDriverType 4 -wbmCognosCreateNewServerDB true -wbmCognosDBName COGNOS_DB_NAME -wbmCognosDBUserName COGNOS_DB_USER -wbmCognosDBPassword COGNOS_DB_PW -enableAdminSecurity true -adminUserName WAS_USER -adminPassword WAS_PW -configureBSpace true -winserviceCheck false -samplesPassword SAMPLE_PWThe
following example shows the creation of a stand-alone profile using
an SQL Server database,
with administrative security enabled:
manageprofiles.bat -create -templatePath "IBM\WebSphere\MonServer\profileTemplates\wbmonitor\default" -profileName StandAloneServer1 -profilePath "IBM\WebSphere\MonServer\profiles\StandAloneServer1" -wbmDBType MSSQLSERVER_MICROSOFT -wbmDBDelayConfig true -wbmDBOutputScriptDir "DB_SCRIPT_DIR" -wbmDBSchemaName DB_SCHEMA -wbmDBName DB_NAME -wbmDBUserId DB_USER -wbmDBPassword DB_PW -wbmDBJDBCClasspath "IBM\WebSphere\MonServer\jdbcdrivers\SQLServer" -wbmDBHostName DB_HOST -wbmDBServerPort DB_PORT -wbmCognosCreateNewServerDB true -wbmCognosDBName COGNOS_DB_NAME -wbmCognosDBUserName COGNOS_DB_USER -wbmCognosDBPassword COGNOS_DB_PW -enableAdminSecurity true -adminUserName WAS_USER -adminPassword WAS_PW -configureBSpace true -winserviceCheck false -samplesPassword SAMPLE_PWParent topic: Profile commands (manageprofiles)
Related tasks:
Related reference:
Related information: