IdMgrDBSetup command group for the AdminTask object

You can use the Jython or Jacl scripting language to manage the federated repository schema using the wsadmin tool. Use the deleteIdMgrPropertyExtensionEntityData command and its parameters in the IdMgrDBSetup group to manage the property extension repository. The command is available in both connected and local mode using the -conntype NONE option.

The IdMgrDBSetup command group for the AdminTask object includes the following commands:

deleteIdMgrDBTables

The deleteIdMgrDBTables command deletes the tables in the database. The following parameters are available for this command:

schemaLocation
The location of the <WAS>/etc/wim/setup directory. (String, required)
databaseType
The type of database. Supported databases are Db2, Oracle, Informix, Derby, Sqlserver, Db2zos, and Db2iseries. (String, required)
dbURL
The database URL for direct access mode. For example: jdbc:db2:wim. (String, required)
dbDriver
The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver. (String, optional)
dbAdminId
The database administrator ID for direct access mode. For example: db2admin. (String, optional)
Attention: For an Apache Derby v10.2 embedded database, the dbAdminId parameter is not required.
dbAdminPassword
The password associated with the dbAdminId. (String, optional)
Attention: For an Apache Derby v10.2 embedded database, the dbAdminPassword parameter is not required.
derbySystemHome
The home location of the Apache Derby v10.2 system if you are setting up an Apache Derby v10.2 database. (String, optional)
reportSqlError
Specifies whether to report SQL errors while setting up databases. (String, optional)
file
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. (String, optional)
dbSchema
The database schema from which you want to delete the federated repository tables. The schema should exist in the database. 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. (String, optional)
dbSchema
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. (String, optional)
tablespacePrefix
The tablespace prefix. The maximum length allowed for this string is 3 characters. The value of the 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. (String, optional)

deleteIdMgrEntryMappingRepositoryTables

The deleteIdMgrEntryMappingRepositoryTables command deletes the tables in the entry mapping repository. The following parameters are available for this command:

schemaLocation
The location of the <WAS>/etc/wim/setup directory. (String, required)
databaseType
The type of database. Supported databases are Db2, Oracle, Informix, Derby, Sqlserver, Db2zos, and Db2iseries. (String, required)
dbURL
The database URL for direct access mode. For example: jdbc:db2:wim. (String, required)
dbDriver
The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver. (String, optional)
dbAdminId
The database administrator ID for direct access mode. For example: db2admin. (String, optional)
Attention: For an Apache Derby v10.2 embedded database, the dbAdminId parameter is not required.
dbAdminPassword
The password associated with the dbAdminId parameter. (String, optional)
Attention: For an Apache Derby v10.2 embedded database, the dbAdminPassword parameter is not required.
derbySystemHome
The home location of the Apache Derby v10.2 system if you are setting up an Apache Derby v10.2 database. (String, optional)
reportSqlError
Specifies whether to report SQL errors while setting up databases. (String, optional)
file
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. (String, optional)
[IBM i]dbSchema
[IBM i]The database schema where you want to create the federated repository tables. The schema should exist in the database. 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. (String, optional)

deleteIdMgrPropertyExtensionEntityData

The deleteIdMgrPropertyExtensionEntityData command deletes property data from the property extension repository. The command also releases the space that is held by the property data in the property extension repository.

Target Object

None.

The following parameters are available for this command:

name
Use this parameter to specify the name of the property for which the data is to be deleted.

You can use a valid namespace prefix to refer to the property in a specific namespace. The default namespace prefix is wim. Use a colon (:) as the delimiter to specify the namespace prefix. For example, you can use your_ext:contact_number

  • your_ext is the namespace prefix.
  • contact_number is the property name.

(String, required)

Important: You must specify the same namespace prefix that you used to extend the property. You can use the listIdMgrPropertyExtensions command, which is part of the IdMgrDataModel command group, to retrieve this value.
entityTypeNames
Use this parameter to specify the name of one or more existing entity types for which the property data is to be deleted. Use the semicolon (;) as the delimiter to specify multiple entity types.

You can use a valid namespace prefix to refer to the entity type names in a specific namespace. The default namespace prefix used is wim. Use colon (:) to specify the namespace prefix. For example, you can use your_ext:person_account

  • your_ext is the namespace prefix.
  • person_account is the entity type name.

(String, optional)

Important: You must specify the same namespace prefix that you used to extend the property. You can use the listIdMgrPropertyExtensions command, which is part of the IdMgrDataModel command group, to retrieve this value.
dbAdminId
Use this parameter to specify the login identity of the database administrator when you run this command in the local mode. (String, optional)
dbAdminPassword
Use this parameter to specify the password of the database administrator when you run this command in the local mode. (String, optional)

Examples:

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteIdMgrPropertyExtensionEntityData {-name property_name_1}
  • Using Jython string:
    AdminTask.deleteIdMgrPropertyExtensionEntityData ('[-name property_name_1]')
  • Using Jython list:
    AdminTask.deleteIdMgrPropertyExtensionEntityData (['-name', 'property_name_1'])

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteIdMgrPropertyExtensionEntityData {-interactive}
  • Using Jython string:
    AdminTask.deleteIdMgrPropertyExtensionEntityData ('[-interactive]')
  • Using Jython list:
    AdminTask.deleteIdMgrPropertyExtensionEntityData (['-interactive'])

deleteIdMgrPropertyExtensionRepositoryTables

The deleteIdMgrPropertyExtensionRepositoryTables command deletes the tables in the property extension database.

This command is available in the connected or local mode. The following parameters are available for this command:

schemaLocation
The location of the <WAS>/etc/wim/setup directory. (String, required)
databaseType
The type of database. Supported databases are Db2, Oracle, Informix, Derby, Sqlserver, Db2zos, and Db2iseries. (String, required)
dbURL
The database URL for direct access mode. For example: jdbc:db2:wim. (String, required)
dbDriver
The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver. (String, optional)
dbAdminId
The database administrator ID for direct access mode. For example: db2admin. (String, optional)
Attention: For an Apache Derby v10.2 embedded database, the dbAdminId parameter is not required.
dbAdminPassword
The password associated with the dbAdminId. (String, optional)
Attention: For an Apache Derby v10.2 embedded database, the dbAdminPassword parameter is not required.
derbySystemHome
The home location of the Apache Derby v10.2 system if you are setting up an Apache Derby v10.2 database. (String, optional)
reportSqlError
Specifies whether to report SQL errors while setting up databases. (String, optional)
file
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. (String, optional)
[IBM i]dbSchema
[IBM i]The database schema where you want to create the federated repository tables. The schema should exist in the database. 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. (String, optional)

setupIdMgrDBTables

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. The following parameters are available for this command:

schemaLocation
The location of the <WAS>/etc/wim/setup directory. (String, required)
dbPropXML
The location of database repository property definition .xml file. (String, required)
databaseType
The type of database. Supported databases are Db2, Oracle, Informix, Derby, Sqlserver, Db2zos, and Db2iseries. (String, required)
dbURL
The database URL for direct access mode. For example: jdbc:db2:wim. (String, required)
Attention: For DB2 High Availability Disaster Recovery (HADR) database configurations, use a Virtual IP (VIP) in the dbURL to ensure failover for administrative users located in the database repository.
dbDriver
The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver. (String, required)
dbAdminId
The database administrator ID for direct access mode. For example: db2admin.
Attention: For an Apache Derby v10.2 embedded database, the dbAdminId parameter is not required. (String, required)
dbAdminPassword
The password associated with the dbAdminId.
Attention: For an Apache Derby v10.2 embedded database, the dbAdminPassword parameter is not required. (String, required)
dn
The default organization unique Name to replace. For example: o=yourco. If it is not set, o=Default Organization is used. (String, required)
wasAdminId
The WebSphere® Application Server admin user ID. The ID should be a short name, not a uniqueNameparameter. For example: wasadmin. After creation, the uniqueName value is uid=wasadmin, <defaultOrg>. (String, required)
password
The WebSphere Application Server admin user password. If wasAdminId is set, then this parameter is mandatory. (String, required)
saltLength
The salt length of the randomly generated salt for password hashing. (Integer, required)
encryptionKey
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. (String, required)
derbySystemHome
The home location of the Apache Derby v10.2 system if you are setting up an Apache Derby v10.2 database. (String, required)
reportSqlError
Specifies whether to report SQL errors while setting up databases. (String, required)
file
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. (String, required)
[IBM i]dbSchema
[IBM i]The database schema where you want to create the federated repository tables. The schema should exist in the database. 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. (String, required)
Attention: If you specify the wasAdminId and wasAdminPassword parameters, a new user is created in the repository. Ensure that the value specified does not duplicate an existing user in another repository.

setupIdMgrEntryMappingRepositoryTables

The setupIdMgrEntryMappingRepositoryTables command sets up the entry mapping repository, which includes creating and populating the tables of the repository. The following parameters are available for this command:

schemaLocation
The location of the <WAS>/etc/wim/setup directory. (String, required)
databaseType
The type of database. Supported databases are Db2, Oracle, Informix, Derby, Sqlserver, Db2zos, and Db2iseries. (String, required)
dbURL
The database URL for direct access mode. For example: jdbc:db2:wim. (String, required)
dbDriver
The name of the database driver. For example: com.ibm.db2.jcc.DB2Driver. (String, optional)
dbAdminId
The database administrator ID for direct access mode. For example: db2admin. (String, optional)
Attention: For an Apache Derby v10.2 embedded database, the dbAdminId parameter is not required.
dbAdminPassword
The password associated with the dbAdminId parameter. (String, optional)
Attention: For an Apache Derby v10.2 embedded database, the dbAdminPassword parameter is not required.
derbySystemHome
The home location of the Apache Derby v10.2 system if you are setting up an Apache Derby v10.2 database. (String, optional)
reportSqlError
Specifies whether to report SQL errors while setting up databases. (String, optional)
file
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. (String, optional)
[IBM i]dbSchema
[IBM i]The database schema where you want to create the federated repository tables. The schema should exist in the database. 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. (String, optional)

setupIdMgrPropertyExtensionRepositoryTables

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. The following parameters are available for this command:

schemaLocation
The location of the app_server_root/etc/wim/setup directory. (String, required)
laPropXML
The location of the property extension repository definition .xml file. (String, optional)
databaseType
The type of database. Supported databases are Db2, Oracle, Informix, Derby, Sqlserver, Db2zos, and Db2iseries. (String, required)
dbURL
The database URL for direct access mode. For example: jdbc:db2:wim. (String, required)
dbAdminId
The database administrator ID for direct access mode. For example: db2admin. (String, optional)
Attention: For an Apache Derby v10.2 embedded database, the dbAdminId parameter is not required.
dbAdminPassword
The password associated with the dbAdminId parameter. (String, optional)
Attention: For an Apache Derby v10.2 embedded database, the dbAdminPassword parameter is not required.
derbySystemHome
The home location of the Apache Derby v10.2 system if you are setting up an Apache Derby v10.2 database. (String, optional)
reportSqlError
Specifies whether to report SQL errors while setting up databases. (String, optional)
skipDBCreation
Specifies whether to create the tables in the property extension repository. (Boolean, optional)

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
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. (String, optional)
[IBM i]dbSchema
[IBM i]The database schema where you want to create the federated repository tables. The schema should exist in the database. 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. (String, optional)