You can set up an entry mapping repository,
a property
extension repository, or a custom registry database repository using
wsadmin commands.
What to do next
Using these commands, you can:
- Specify
the arguments on the command line.
- Specify the arguments in
a file.
The -file option enables you to specify
a file
in which some or all of the parameters are specified. To use the -file argument
on the command line, enter the full path to the
file. Parameters in the file must be specified in key=value pairs
and each must be on its own line. If a parameter is specified
on both the command line and in the file, the value on the command
line takes precedence.
Tips for diagnosing argument errors:
- If an argument is not properly specified on the command line or
in the file, a message is returned which states that the argument
was not properly specified. This might mean that the argument was
not specified at all or was required for a given configuration but
was not specified.
- If the argument was not specified at all,
check that the parameter
is specified on the command line or in the file, and that it is properly
spelled and has matching case.
- If the argument was required
for a given configuration but was
not specified, it is possible that a value is not required solely
by the command but is required for the type of database and configuration
you are setting.
For example, if you set the dn, wasAdminId,
or wasAdminPassword parameters, you must also specify
the dbDriver parameter.
Additionally,
if the dn, wasAdminId or wasAdminPassword parameters
are specified, and the databaseType is not a
Apache Derby v10.2 database, then the dbAdminId and dbAdminPassword parameters
must also be specified.
Important: To use
Apache Derby v10.2 for your repository, you must run the Apache Derby
Network Server framework. This framework supports multiple concurrent
JVM connections with the database, whereas the embedded framework
works with only a single JVM, which cannot fulfill most workload-balancing
requirements. Running the Network Server framework for Apache Derby
v10.2 requires the Derby Client driver files and classes.
The
setupIdMgrDBTables command:
The setupIdMgrDBTables
command creates, and populates the tables in the database that you
previously created. Arguments are case-sensitive, both through the
command line and the file.
Parameters:- schemaLocation (String, Required)
- The
location of the <WAS>/etc/wim/setup directory.
- dbPropXML (String)
- The location of
database repository property definition XML file.
- databaseType (String, Required)
- The type of
database. Supported databases are db2, oracle, informix,
derby, sqlserver, db2zos, and db2iseries.
- dbURL
(String, Required)
- The database URL for direct access mode.
For example: jdbc:db2:wim.
- dbDriver (String)
- The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver.
- dbAdminId (String)
- The database administrator
ID for direct access mode. For example:
db2admin.
Note: For a Apache Derby v10.2 embedded database, dbAdminId
is not required.
- dbAdminPassword
(String)
- The password associated with the dbAdminId.
Note: For
a Apache
Derby v10.2 embedded database, dbAdminPassword is not required.
- dn (String)
- The default organization
uniqueName to replace. For example: o=yourco. If it is not
set, o=Default Organization is
used.
- wasAdminId (String)
- The WebSphere Application Server admin user
ID. The ID should be a short name, not a uniqueName. For example:
wasadmin. After creation, the uniqueName is uid=wasadmin, <defaultOrg>.
- wasAdminPassword (String)
- The WebSphere Application Server admin user
password. If wasAdminId is set, then this parameter is mandatory.
- saltLength (Integer)
- The salt length
of the randomly generated salt for password hashing.
- encryptionKey (String)
- The password encryption
key. Set the password encryption key to
match the encryption key in the wimconfig.xml file for the repository.
If the encryption key is not set, the default is used.
- derbySystemHome (String)
- The home location of
the Apache Derby v10.2 system if you are
setting up a Apache Derby v10.2 database.
- reportSqlError
(String)
- Specifies whether to report SQL errors while setting
up databases.
- file (String)
- The
full path to a file containing the input parameters. Each
input parameter must match a corresponding parameter as it would be
typed on the command line, and it must be placed in a key=value pair.
Each pair must be on a separate line.
- tablesBufferPool (String)
- The buffer pool
variable of default tables in DB2 for z/OS. The
default value is BP0.
- LOBtablesBufferPool
(String)
- The buffer pool variable of auxiliary LOB tables
in DB2 for z/OS.
The default value is BP0.
- indextablesBufferPool
(String)
- The buffer pool variable of unique index tables in
DB2 for z/OS.
The default value is BP0.
- dbSchema (String)
- The database schema where you want to create the federated repository
tables. The default value is the default schema of the database according
to the database type. Typically, the default schema is the namespace
of the current database user.
- tablespacePrefix
(String)
- The tablespace prefix. The maximum length allowed
for this string
is 3 characters. The value of tablespacePrefix parameter is required
when you use the dbSchema parameter. It is specific to DB2 for z/OS
and will be ignored for any other database type.
The
deleteIdMgrDBTables command:
The deleteIdMgrDBTables command
deletes the tables in the database.
Parameters:
- schemaLocation (String, Required)
- The location
of the <WAS>/etc/wim/setup directory.
- databaseType (String, Required)
- The type of
database. Supported databases are db2, oracle, informix,
derby, sqlserver, db2zos, and db2iseries.
- dbURL
(String, Required)
- The database URL for direct access mode.
For example: jdbc:db2:wim.
- dbDriver (String)
- The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver.
- dbAdminId (String)
- The database administrator
ID for direct access mode. For example:
db2admin.
Note: For a Apache Derby v10.2 embedded database, dbAdminId
is not required.
- dbAdminPassword
(String)
- The password associated with the dbAdminId.
Note: For
a Apache
Derby v10.2 embedded database, dbAdminPassword is not required.
- derbySystemHome (String)
- The home
location of the Apache Derby v10.2 system if you are
setting up a Apache Derby v10.2 database.
- reportSqlError
(String)
- Specifies whether to report SQL errors while setting
up databases.
- file (String)
- The
full path to a file containing the input parameters. Each
input parameter must match a corresponding parameter as it would be
typed on the command line, and it must be placed in a key=value pair.
Each pair must be on a separate line.
- dbSchema
(String)
- The database schema from which you want to delete
the federated
repository tables. The default value is the default schema of the
database according to the database type. Typically, the default schema
is the namespace of the current database user.
- tablespacePrefix (String)
- The tablespace
prefix. The maximum length allowed for this string
is 3 characters. The value of tablespacePrefix parameter is required
when you use the dbSchema parameter. It is specific to DB2 for z/OS
and will be ignored for any other database type.
The
setupIdMgrPropertyExtensionRepositoryTables
command:
The setupIdMgrPropertyExtensionRepositoryTables
command sets up the property extension repository. The default behavior
includes creating and populating the tables in the database.
This
command is available in connected or local mode.
Parameters:
- schemaLocation (String, Required)
- The location
of the app_server_root/etc/wim/setup directory.
- laPropXML (String)
- The location of
the property extension repository definition XML
file.
- databaseType (String, Required)
- The type of database. Supported databases are db2, oracle, informix,
derby, sqlserver, db2zos, and db2iseries.
- dbURL
(String, Required)
- The database URL for direct access mode.
For example: jdbc:db2:wim.
- dbAdminId (String)
- The database administrator ID for direct access mode. For example:
db2admin.
Note: For a Apache Derby v10.2 embedded database, dbAdminId
is not required.
- dbAdminPassword
(String)
- The password associated with the dbAdminId.
Note: For
a Apache
Derby v10.2 embedded database, dbAdminPassword is not required.
- derbySystemHome (String)
- The home location
of the Apache Derby v10.2 system if you are
setting up a Apache Derby v10.2 database.
- reportSqlError
(String)
- Specifies whether to report SQL errors while setting
up databases.
- skipDBCreation (Boolean)
- Specifies whether to create the tables in the property extension
repository.
If you set this parameter value to false or do not specify
a value, then the command follows the default behavior of creating
and populating the tables in the database.
If you set this parameter
value to true, manually set up the property extension repository before
running this command so that the tables get populated. For more information
on this manual process, see the appropriate topic on manually setting
up the property extension repository for your database.
- file (String)
- The full path to a file
containing the input parameters. Each
input parameter must match a corresponding parameter as it would be
typed on the command line, and it must be placed in a key=value pair.
Each pair must be on a separate line.
- tablesBufferPool (String)
- The buffer pool
variable of default tables in DB2 for z/OS. The
default value is BP0.
- LOBtablesBufferPool
(String)
- The buffer pool variable of auxiliary LOB tables
in DB2 for z/OS.
The default value is BP0.
- indextablesBufferPool
(String)
- The buffer pool variable of unique index tables in
DB2 for z/OS.
The default value is BP0.
- dbSchema (String)
- The database schema where you want to create the federated repository
tables. The default value is the default schema of the database according
to the database type. Typically, the default schema is the namespace
of the current database user.
- tablespacePrefix
(String)
- The tablespace prefix. The maximum length allowed
for this string
is 3 characters. The value of tablespacePrefix parameter is required
when you use the dbSchema parameter. It is specific to DB2 for z/OS
and will be ignored for any other database type.
The
deleteIdMgrPropertyExtensionRepositoryTables
command:
The deleteIdMgrPropertyExtensionRepositoryTables
command deletes the tables in the property extension database.
This
command is available in the connected or local mode.
Parameters:
- schemaLocation (String, Required)
- The location
of the <WAS>/etc/wim/setup directory.
- databaseType (String, Required)
- The type of
database. Supported databases are db2, oracle, informix,
derby, sqlserver, db2zos, and db2iseries.
- dbURL
(String, Required)
- The database URL for direct access mode.
For example: jdbc:db2:wim.
- dbDriver (String)
- The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver.
- dbAdminId (String)
- The database administrator
ID for direct access mode. For example:
db2admin.
Note: For a Apache Derby v10.2 embedded database, dbAdminId
is not required.
- dbAdminPassword
(String)
- The password associated with the dbAdminId.
Note: For
a Apache
Derby v10.2 embedded database, dbAdminPassword is not required.
- derbySystemHome (String)
- The home location
of the Apache Derby v10.2 system if you are
setting up a Apache Derby v10.2 database.
- reportSqlError
(String)
- Specifies whether to report SQL errors while setting
up databases.
- file (String)
- The
full path to a file containing the input parameters. Each
input parameter must match a corresponding parameter as it would be
typed on the command line, and it must be placed in a key=value pair.
Each pair must be on a separate line.
- dbSchema
(String)
- The database schema from which you want to delete
the federated
repository tables. The default value is the default schema of the
database according to the database type. Typically, the default schema
is the namespace of the current database user.
- tablespacePrefix (String)
- The tablespace
prefix. The maximum length allowed for this string
is 3 characters. The value of tablespacePrefix parameter is required
when you use the dbSchema parameter. It is specific to DB2 for z/OS
and will be ignored for any other database type.
The
setupIdMgrEntryMappingRepositoryTables
command:
The setupIdMgrEntryMappingRepositoryTables command
sets up the entry mapping repository, which includes creating and
populating the tables of the repository.
Parameters:
- schemaLocation (String, Required)
- The location
of the <WAS>/etc/wim/setup directory.
- databaseType (String, Required)
- The type of
database. Supported databases are db2, oracle, informix,
derby, sqlserver, db2zos, and db2iseries.
- dbURL
(String, Required)
- The database URL for direct access mode.
For example: jdbc:db2:wim.
- dbDriver (String)
- The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver.
- dbAdminId (String)
- The database administrator
ID for direct access mode. For example:
db2admin.
Note: For a Apache Derby v10.2 embedded database, dbAdminId
is not required.
- dbAdminPassword
(String)
- The password associated with the dbAdminId.
Note: For
a Apache
Derby v10.2 embedded database, dbAdminPassword is not required.
- derbySystemHome (String)
- The home location
of the Apache Derby v10.2 system if you are
setting up a Apache Derby v10.2 database.
- reportSqlError
(String)
- Specifies whether to report SQL errors while setting
up databases.
- file (String)
- The
full path to a file containing the input parameters. Each
input parameter must match a corresponding parameter as it would be
typed on the command line, and it must be placed in a key=value pair.
Each pair must be on a separate line.
- tablesBufferPool (String)
- The buffer pool
variable of default tables in DB2 for z/OS. The
default value is BP0.
- dbSchema (String)
- The database schema where you want to create the federated repository
tables. The default value is the default schema of the database according
to the database type. Typically, the default schema is the namespace
of the current database user.
- tablespacePrefix
(String)
- The tablespace prefix. The maximum length allowed
for this string
is 3 characters. The value of tablespacePrefix parameter is required
when you use the dbSchema parameter. It is specific to DB2 for z/OS
and will be ignored for any other database type.
The
deleteIdMgrEntryMappingRepositoryTables
command:
The deleteIdMgrEntryMappingRepositoryTables command
deletes the tables in the entry mapping repository.
Parameters:
- schemaLocation (String, Required)
- The location
of the <WAS>/etc/wim/setup directory.
- databaseType (String, Required)
- The type of
database. Supported databases are db2, oracle, informix,
derby, sqlserver, db2zos, and db2iseries.
- dbURL
(String, Required)
- The database URL for direct access mode.
For example: jdbc:db2:wim.
- dbDriver (String)
- The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver.
- dbAdminId (String)
- The database administrator
ID for direct access mode. For example:
db2admin.
Note: For a Apache Derby v10.2 embedded database, dbAdminId
is not required.
- dbAdminPassword
(String)
- The password associated with the dbAdminId.
Note: For
a Apache
Derby v10.2 embedded database, dbAdminPassword is not required.
- derbySystemHome (String)
- The home location
of the Apache Derby v10.2 system if you are
setting up a Apache Derby v10.2 database.
- reportSqlError
(String)
- Specifies whether to report SQL errors while setting
up databases.
- file (String)
- The
full path to a file containing the input parameters. Each
input parameter must match a corresponding parameter as it would be
typed on the command line, and it must be placed in a key=value pair.
Each pair must be on a separate line.
- dbSchema
(String)
- The database schema from which you want to delete
the federated
repository tables. The default value is the default schema of the
database according to the database type. Typically, the default schema
is the namespace of the current database user.
- tablespacePrefix (String)
- The tablespace
prefix. The maximum length allowed for this string
is 3 characters. The value of tablespacePrefix parameter is required
when you use the dbSchema parameter. It is specific to DB2 for z/OS
and will be ignored for any other database type.
Sample
command line usage:
To set
up a database using the command line, enter the following:
$AdminTask setupIdMgrDBTables {-schemaLocation "C:/WAS/etc/wim/setup" -dbPropXML
"C:/WAS/etc/wim/setup/wimdbproperties.xml" -databaseType db2
-dbURL jdbc:db2:wim -dbAdminId db2admin
-dbDriver com.ibm.db2.jcc.DB2Driver -dbAdminPassword db2adminPwd
-reportSqlError true}
To delete database tables using the command line,
enter the following:
$AdminTask deleteIdMgrDBTables {-schemaLocation "C:/WAS/etc/wim/setup"
-databaseType db2 -dbURL jdbc:db2:wim -dbAdminId db2admin
-dbDriver com.ibm.db2.jcc.DB2Driver -dbAdminPassword db2adminPwd
-reportSqlError true}
To set up a property extension repository
using the command line, enter the following:
$AdminTask setupIdMgrPropertyExtensionRepositoryTables {-schemaLocation
"C:/WAS/etc/wim/setup"
-laPropXML "C:/WAS/etc/wim/setup/wimlaproperties.xml" -databaseType db2
-dbURL jdbc:db2:wim -dbAdminId db2admin -dbDriver com.ibm.db2.jcc.DB2Driver
-dbAdminPassword db2adminPwd -reportSqlError true}
To delete a property extension repository using
the command line, enter the following:
$AdminTask deleteIdMgrPropertyExtensionRepositoryTables {-schemaLocation "C:/WAS/etc/wim/setup "
-databaseType db2 -dbURL jdbc:db2:wim -dbAdminId db2admin -dbDriver
com.ibm.db2.jcc.DB2Driver -dbAdminPassword db2adminPwd -reportSqlError true}
To set up an entry mapping repository using the command
line, enter the following:
$AdminTask setupIdMgrEntryMappingRepositoryTables {-schemaLocation "C:/WAS/etc/wim/setup"
-databaseType db2 -dbURL jdbc:db2:wim -dbAdminId db2admin -dbDriver
com.ibm.db2.jcc.DB2Driver -dbAdminPassword db2adminPwd -reportSqlError true}
To delete an entry mapping repository using the
command line, enter the following:
$AdminTask deleteIdMgrEntryMappingRepositoryTables {-schemaLocation "C:/WAS/etc/wim/setup"
-databaseType db2 -dbURL jdbc:db2:wim -dbAdminId db2admin -dbDriver
com.ibm.db2.jcc.DB2Driver -dbAdminPassword db2adminPwd -reportSqlError true}
Sample CLI Usage using -file option:
To
set up a database with the
-file option using the example
params.txt file
below, enter the following:
$AdminTask setupIdMgrDBTables {–file C:/params.txt -dbPropXML
"C:/OverrideDBPropParam/wimdbproperties.xml"}
Params.txtschemaLocation=C:/WAS/etc/wim/setup
dbPropXML=C:/Program Files/IBM/WebSphere/AppServer/profiles/default
/config/cells/mycell/wim/config/wimdbproperties.xml
laPropXML=C:/Program Files/IBM/WebSphere/AppServer/profiles/default
/config/cells/mycell/wim/config/wimlaproperties.xml
databaseType=db2
dbURL=jdbc:db2:wim
dbDriver=com.ibm.db2.jcc.DB2Driver
reportSqlError=true
dn=o=db.com
dbAdminId=db2admin
dbAdminPassword=dbPassword
wasAdminId=wasadmin
wasAdminPassword=wasadmin1
To set up a database with the
-file option
using a file only, enter the following:
$AdminTask setupIdMgrDBTables {-file C:/params.txt}
Note: The use of a file only works if -file is
the only parameter specified on the command line. If other parameters
are specified then the file is completely ignored, and only the parameters
on the command line are used to execute the command.