Repository tools command to export user information
Use the exportUsers command to export user information.
Purpose
The exportUsers command can be used to export the user information into a CSV file.Important: The server must be running when
you run the command.
Parameters
Attribute | Description | Required | Default |
---|---|---|---|
toFile | Path to the users comma delimited file. | No | users.csv |
overwrite | Whether to overwrite an existing CSV file. | No | no |
repositoryURL | The connection URL for the server. | No | https://localhost:9443/application where application is jts, ccm, rm, qm, gc, dcc, or relm. |
adminUserId | Administrator user ID to login to the repository. | No | ADMIN |
adminPassword | Administrator password to login to the repository. | No | ADMIN |
credentialsFile | The file containing the administrator user's login credentials. | No | credentials.properties |
certificateFile | The file containing the administrator user's login certificate. | No | none |
smartCard | The alias to login using a smart card, or ? to list available aliases. | No | none |
logFile | Path to the log file. | No | repotools-application_exportUsers.log where application is jts, ccm, rm, qm, gc, dcc, or relm. |
kerberos | Authenticate with Windows user credentials using Kerberos/SPNEGO by setting to true. Or authenticate with Windows Integrated Authentication by setting to windows. | No | None |
onlyValidLicenses | Export only valid (installed) assigned licenses. | No | no |
Example
The following example is for Jazz®
Team Server. To use
this command for other applications, run these options from the server directory:
- IBM® Engineering Workflow Management (Change and Configuration Management application): repotools-ccm
- IBM Engineering Requirements Management DOORS® Next (Requirements Management application): repotools-rm
- IBM Engineering Test Management (Quality Management application): repotools-qm
- Global Configuration Management: repotools-gc
- Data Collection Component: repotools-dcc
- IBM Engineering Lifecycle Optimization - Engineering Insights: repotools-relm
Open a command prompt and enter this command:
cd C:\Program Files\IBM\JazzTeamServer\server\
repotools-jts.bat -exportUsers toFile=C:\users.csv repositoryURL=https://hostname.example.com:9443/jts kerberos=true
Open a command line and enter this command:
cd opt/IBM/JazzTeamServer/server ./repotools-jts.sh -exportUsers toFile=opt/users.csv repositoryURL=https://hostname.example.com:9443/jts
Sample
The output is a comma separated value that lists:
userid,name,email@example.org,[com.ibm.team.foundation.user],[JazzUser],0
userid
is the user ID of the user.name
is the name of the user.email@example.org
is the email address of the user.[com.ibm.team.foundation.user]
is the list of licenses.[JazzUser]
is the list of groups.0
means that the user is not archived. If the user is archived, this value is 1.