The Tivoli Access Manager migrateEAR utility

The migrateEAR utility for Tivoli Access Manager

Purpose

Migrates changes made to console users and groups in the admin-authz.xml file into the Tivoli Access Manager object space.

Syntax

migrateEAR -profileName default -j profile_root/config/cells/cellName/admin-authz.xml -a sec_master -p password -w wsadmin -d o=ibm,c=us -c file:profile_root/etc/pd/PdPerm.properties

Note the following on iSeries (OS/400):

-j defaults to profile_root/config/cells/cellName/admin-authz.xml
-c defaults to file:profile_root/etc/pd/PdPerm.properties, and the output of the utility is logged to the file, pdwas_migrate.log, created in profile_root/logs.
-profileName is optional and defaults to the default profile name.

Parameters

-a Tivoli_Access_Manager_administrator_ID

The administrative user identifier. The administrative user must have the privileges required to create users, objects, and access control lists (ACLs). For example, -a sec_master.

This parameter is optional. When the parameter is not specified, you are prompted to supply it at run time.

-c PdPerm.properties_file_location

The Uniform Resource Indicator (URI) location of the PdPerm.properties file that is configured by the pdwascfg utility. When WebSphere Application Server is installed in the default location, the URI is:

[iSeries]
file:profile_root/etc/pd/PdPerm.properties

[Solaris] [Linux] [HP-UX]
file:/opt/IBM/WebSphere/AppServer/java/jre/PdPerm.properties
[AIX]
file:/usr/IBM/WebSphere/AppServer/java/jre/PdPerm.properties

[Windows]
file:/"C:\Program Files\IBM\WebSphere\AppServer\java\jre\PdPerm.properties"

-d user_registry_domain_suffix

The domain suffix for the user registry to use. For example, for Lightweight Directory Access Protocol (LDAP) user registries, this value is the domain suffix, such as: "o=ibm,c=us"

[Windows]
Windows platforms require that the domain suffix is enclosed within quotes.

You can use the pdadmin user show command to display the distinguished name (DN) for a user.

-j admin-authz.html_path_name

The fully qualified path and file name of the Java 2 Platform,
Enterprise Edition application archive file. Optionally, this path can also be a directory of an expanded enterprise application. When WebSphere Application Server is installed in the default location, the paths to the data files to migrate include:

[iSeries]
profile_root/config/cells/cellName/admin-authz.xml

[Solaris] [Linux] [HP-UX]
file:/opt/IBM/WebSphere/AppServer/profiles/profile_name/config/cells/cell_name/admin-authz.xml

[AIX]
file:/usr/IBM/WebSphere/AppServer/profiles/profile_name/config/cells/cellName/admin-authz.xml

[Windows]
"c:\Program Files\IBM\WebSphere\AppServer\profiles\profile_name\config\cells\cell_name\admin-authz.xml"

-p Tivoli_Access_Manager_administrator_password

The password for the Tivoli Access Manager administrative user. The administrative user must have the privileges that are required to create users, objects, and access control lists (ACLs). For example, you can specify the password for the -a sec_master administrative user as -p myPassword.

When this parameter is not specified, the user is prompted to supply the password for the administrative user name.

-r root_objectspace_name

The space name of the root object. The value is the name of the root of the protected object namespace hierarchy that is created for WebSphere Application Server policy data.

The default value for the root object space is WebAppServer.

Set the Tivoli Access Manager root object space name by modifying the amwas.amjacc.template.properties file prior to configuring the Java Authorization Contract for Control (JACC) provider for Tivoli Access Manager for the first time. Use this option if the default object space value is not used in the configuration of the Tivoli Access Manager JACC provider for Tivoli Access Manager.

Do not change the Tivoli Access Manager object space name after the Tivoli Access Manager JACC provider has been configured.

-t ssl_timeout

The number of minutes for the Secure Sockets Layer (SSL) timeout. This parameter is used to disconnect and reconnect the SSL context between the Tivoli Access Manager authorization server and the policy server before the default connection times out.

The default is 60 minutes. The minimum is 10 minutes. The maximum value cannot exceed the Tivoli Access Manager ssl-v3-timeout value. The default value for ssl-v3-timeout is 120 minutes.

If you are not familiar with the administration of this value, you can safely use the default value.

-w WebSphere_Application_Server_administrator_user_name

The user name that is configured in the WebSphere Application Server security user registry field as the administrator. This value matches the account that you created or imported in Creating the security administrative user. Access permission for this user is needed to create or update the Tivoli Access Manager protected object space.

When the WebSphere Application Server administrative user does not already exist in the protected object space, it is created or imported. In this case, a random password is generated for the user and the account is set to not valid. Change this password to a known value and set the account to valid. A protected object and access control list (ACL) are created. The administrative user is added to the pdwas-admin group with the following ACL attributes:

T: Traverse permission
i: Invoke permission
WebAppServer: You can overwrite the action group name. The default name is WebAppServer. This action group name and the matching root object space can be overwritten when the migration utility is run with the -r option.

Comments

This utility migrates security policy information from deployment descriptors enterprise archive files to Tivoli Access Manager for WebSphere Application Server. The script calls the com.tivoli.pdwas.migrate.Migrate Java class.

Before invoking the script run the setupCmdLine script from the Qshell command line. This file can be found in the install_root/bin directory, where install_root is your installation path. In the default installation, install_root is /QIBM/ProdData/WebSphere/AppServer/V6/edition. This can be found in the %WAS_HOME%/bin directory. The script is dependent on finding the correct environment variables for the location of prerequisite software. The script calls Java code with the following options:

-Dpdwas.lang.home: The directory that contains the native language support libraries that are provided with the JACC provider for Tivoli Access Manager. These libraries are located in a subdirectory under the JACC provider for Tivoli Access Manager installation directory. For example: -Dpdwas.lang.home=%PDWAS_HOME%\java\nls
-cp %CLASSPATH% com.tivoli.pdwas.migrate.Migrate: The CLASSPATH variable must be set correctly for your Java installation.

[Windows]
Both the -j option and the -c option can reference the %WAS_HOME% variable to determine where WebSphere Application Server is installed. This information is used to:

Build the full path name of the enterprise archive file.
Build the full URI path name to the location of the PdPerm.properties file.

Return codes

The utility can return the following exit status codes:

0: The command completed successfully.
1: The command failed.

Searchable topic ID: rsec_TAM_JACC_migrateear