install_datasharekeys

Generates private keys for the Data Share Manager. The Data Share Manager is used to monitor asynchronous file uploads and downloads, and the keys are used to authenticate the file uploads and downloads with the Teamcenter database. This utility is initially called by the Teamcenter installation process to install the predefined private keys. After the initial installation, you can use this utility to perform functions such as exporting a public key to be used when installing the Data Share Manager. For general information about private and public keys, see http://en.wikipedia.org/wiki/Public-key_cryptography. Syntax install_datasharekeys -u=user-id {-p=password | -pf=password-file} -g=group-f={activate | delete | exp_pubkey | exp_pvtkey | gen_pvtkey | install | list | modify | seed} -file=input-file -reserve[-v] [-h] Arguments -u Specifies the user ID. This is 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: activate Sets an existing reserve key as the active private key and sets the previous active private key as the reserve key. There is only one active private key in the system that is used by Teamcenter. The general process to move to a new active private key is as follows: Create a new reserve private key using the -reserve argument with the install or seed argument. Export public keys for the reserve key and install the key on client machines. Switch to the new reserve private key using the -f=activate argument. Delete the old private key (now marked as reserve) at any later time. delete Deletes the Data Share Manager private key from the database. exp_pubkey Exports the Data Share Manager public key. This generates *.x509 key file and a *.pem file. The administrator packages the *.x509 file into a keys.zip file and distributes it to end users to be used when installing the Data Share Manager. (The *.pem file is not needed in the ZIP file.) The *.x509 file must be included in the ZIP file in a \keys directory so it can be properly read by installers. exp_pvtkey Exports the Data Share Manager private key. gen_pvtkey Generates a new private key that can be imported to the database using the modify argument. install Generates a new key and installs the Data Share Manager private key into the database. list Lists the name of the Data Share Manager private key in the database. modify Modifies the Data Share Manager private key in the database. seed Seeds or imports a new Data Share Manager private key into the database. -file=input-file Specifies a file name (with full path) that contains the private key to import using the -seed argument. If this optional parameter is specified with the -seed argument, the utility uses the specified filename argument as the private key to be imported. If this parameter is not specified when using the -seed argument, the utility prompts the user to specify the filename for the private key to be imported. -reserve Indicates that the current function should work on the reserve key. This argument can be used with the following functions: install, seed, modify, delete, exp_pubkey, exp_pvtkey, or gen_pvtkey. -v Displays verbose output. -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 export the public key from the database, enter the following command on a single line: Copy install_datasharekeys -u=username -p=password -g=dba -f=exp_pubkey Provide this key in a ZIP file to users installing the Data Share Manager. The key authenticates the users with the Teamcenter database when using the Data Share Manager to upload or download files. To generate a new private key and use it to modify the private key in the database, enter the following command on a single line: Copy install_datasharekeys -u=username -p=password -g=dba -f=gen_pvtkey -f=modify