dsa_util

Distributes system administration data, such as users and groups, from one site to another. When adding a new site, this allows you to enter the site information of all sites in the network so the new site can exchange data with them. Caution Do not use this utility to share organization objects between sites if the same organization objects are shared through a global organization. Note This utility should be used only for the initial migration of system objects. Siemens Digital Industries Software recommends that you do not use this utility to maintain system objects. Propagates Teamcenter administration data among multiple sites and allows administrators to: Manage system data from a central site. Support non-networked sites. Create reports of the results of a distribution operation. Syntax dsa_util [-u=user-id {-p=password | -pf=password-file} -g=group] -f={list_sites | check_sites | set_logging_level -level={FATAL | ERROR | WARNING | INFO | DEBUG | TRACE | OFF}} [-site=remote-site1-name -site=remote-site2-name...] [-h={topics | topic-name} | -h [-f=function-name | -class=class-name]] Arguments Entries in parentheses are accepted abbreviations for arguments. -u Specifies the user ID. This must be a user with Teamcenter administration privileges. If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are authenticated externally through SSO rather than being authenticated against the Teamcenter database. If you do not supply these arguments, the utility attempts to join an existing SSO session. If no session is found, you are prompted to enter a user ID and password. -p Specifies the password. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. For more information about managing password files, see Manage password files. This argument is mutually exclusive with the -p argument. -g Specifies the group associated with the user. If used without a value, the user's default group is assumed. Caution For HTTP enabled sites, remote site operations log on using the default group for the user supplied with the -u argument. Any value supplied with the -g argument is ignored. -f Identifies the function to perform. Must be one of the following functions: list_sites (ls) Lists all the sites that are defined in the local database. check_sites (cs) Checks the availability of all sites defined in the local database. A site is considered available for Distributed System Administration purposes if its IDSM server is ready. set_logging_level (sll) Sets the logging level at the remote site indicated by the -site argument to the level indicated by the -level argument. See restrictions 5 and 6. -level Specifies the logging level for a given remote site in a remote procedure call (RPC)-based Multi-Site environment. Valid values are: FATAL Logs only severe errors that cause premature program termination. ERROR Logs other run-time errors or unexpected conditions. WARNING Logs run-time situations that are undesirable or unexpected, such as use of deprecated APIs. INFO Logs informational messages that highlight the progress of the application at a coarse-grained level, such as startup and shutdown events. DEBUG Logs detailed information on the flow through the system. This information is useful for debugging an application. TRACE Logs the most detailed information on system events and operation. OFF Turns off logging. See restrictions 5 and 6. Set the logging level at the local site in the logger.properties file in the TC_DATA directory. -site Identifies the remote sites to which system objects are distributed. May be given multiple times in the same command line to distribute to multiple sites. -h Displays help information on basic usage. Return Values Return value upon success 0 Return value upon failure >1 Restrictions To use this utility, you must be a user with system administration privileges or be granted authorization by a user with system administration privileges. Do not use this utility to share organization objects between sites if the same organization objects are shared through a global organization. When exporting the user object, this utility does not export the license level of the user. The license level of the user is set to the lowest available license level at the importing site. System administrators at the importing site must manually set the license level and/or the license bundle of each user. The dsa_util utility does not recognize externally managed users, groups, roles, persons, and group members with a datasource attribute value greater than 0 and convert them to remotely managed (for example, managed by an LDAP external directory at a remote site). Because the dsa_util utility is the only way user constructs can be converted to remotely managed, no user construct objects in the Organization user interface appear as remotely managed. The set_logging_level function and -level argument are only for RPC-based Multi-Site environments. Use the JMX console to set the logging levels for the loggers in an HTTP (four-tier) Multi-Site environment. To use this argument, you must add the source site (site where the utility is run) to the IDSM_dsa_sites_permitted_to_push_admin_data preference value at the remote site. Examples To set the Multi-Site logging level to DEBUG at a remote site 203456177, enter the following command on a single line: Copy dsa_util -u=Tc_admin-user -p=password -f= set_logging_level -site=203456177 level=DEBUG Related Topics TC XML and PLM XML Configuration for Data Import and Export Multi-Site Collaboration