site_util

Performs site-related maintenance, such as creating and deleting remote sites, setting ownership, and changing the ID of remote sites. Syntax site_util [-u=user-id {-p=password | -pf=password-file} -g=group] -f=function [-site_name=site-name] [-site_id=site-id] [-license_server=license-server] [-node_name=node-name] [-soa_url=soa-url] [-gms_url=gms-url] [-geography=geography_code] [-ods= y | n] [-hub=y | n] [-http=y | n] [-tcxml=y | n] [-offline=y | n] [-replicaDel=y | n] [-unmanaged=y | n] [-archive=y | n] [-display_only] [-h] Arguments -u Specifies the user ID. This must be a user with Teamcenter administration privileges. Note 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. -f Specifies one of the following functions: create Defines a remote site in the local database. set_id Changes the current ID of a remote site. This function corrects errors made while defining sites and must be used with extreme caution. Caution Modifying a site ID can result in serious data sharing problems. This function is not allowed to be run on the local site, because it will corrupt the database. The -site_name argument is required when using the set_id function. modify Changes attributes of a site other than the site ID and may be used for local or remote sites. The -site_id argument is required to identify the site being modified. Only the given attributes are modified. delete Deletes a remote site from the local database. Only those sites not referenced by any object in the local database can be deleted. This function cannot be used for the local site. The -site_id argument is required when using the delete function. list Lists all defined sites in the database and their attributes. No attribute switch is required. fix_site_ownership Sets the ownership of all defined sites in the database as being owned by the local site. Use this when you encounter an error stating that you cannot export a POM_imc object because it is owned by another site. This can be run while users are logged on to the database. No attribute switch is required. -site_name Specifies the name of the site when creating or modifying sites. -site_id Specifies the ID of the site to which the specified function applies. -license_server Specifies a default license server for the site. If, when creating a user, if you do not assign the user to a specific license server, the default license server is used. -node_name Specifies the node name when creating a new site. This argument can also be used when modifying site properties. If the value of the -http argument is set to y, the value of -site_name can be a URL of an SOA. -soa_url Specifies the service oriented architecture (SOA) URL, for example, http://Tc_host:7001/tc. -gms_url Specifies the URL for Global Services. -geography Specifies the geography code, a two-character code from ISO 3166. -ods Specifies whether the site being created or modified is an Object Directory Services (ODS) site. For more information about Object Directory Services, see Multi-Site Collaboration. -hub Specifies whether the site being created or modified is a hub. For more information about hub configurations, see Multi-Site Collaboration. -http Specifies whether to use the HTTP protocol or remote procedure call (RPC) protocol. -tcxml Specifies the utility uses TC XML payload instead of an object manager. -offline Specifies that the site has no network connection to the local site. This argument is intended to avoid sending unnecessary messages to a site when a replica is deleted. -replicaDel Switch that indicates objects replicated to a given site can be deleted as long as the object is not replicated to other sites that do not have this property. -unmanaged Switch that indicates an unmanaged site. -archive Specifies whether the site being created or modified is a Multi-Site Collaboration archive site. Only a single site in a federation of connected sites can be specified as an archive site. -display_only Determines whether it is necessary to fix site ownership. This argument must be used in conjunction with the fix_site_ownership function. A returned count greater than zero indicates that site ownership must be fixed by running the utility using the fix_site_ownership function. -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. Files As specified in Log files produced by Teamcenter. Restrictions None. Examples To define a new remote site in the local database, enter the following command on a single line: Copy site_util -f=create -site_id=123456789 -site_name=Site1 -node_name=node1 -ods=y To change the node name of a site, enter the following command on a single line: Copy site_util -f=modify -site_id=123456789 -node_name=node2 To indicate that a site is a multisite hub, enter the following command on a single line: Copy site_util -f=modify -site_id=123456789 -hub=y A returned count greater than zero indicates that site ownership must be fixed by running the utility using the fix_site_ownership function. To determine if it is necessary to run the fix_site_ownership function, enter the following command on a single line: Copy site_util -f=fix_site_ownership -display_only To define a GMS site, enter the following command on a single line: Copy site_util -f=create -http=y -tcxml=y -node_name=http://url_of_the_gs_instance