Repository tools command to back up Jazz Foundation Service indexes

Use the backupJFSIndexes command to back up resource description framework (RDF), text indices, and work item indices to a .zip file.

Purpose

In addition to resource description framework (RDF) and text indices, work item indices can be backed up when you use the online backupJFSIndexes command. For example, you can start a change and configuration management (CCM) server, and then run repotools-ccm -backupJFSIndexes toFile=indices_backup.zip. The resulting indices_backup.zip file includes the work item indices directory.
Important: The server must be running when you run the command.

Parameters

Attribute Description Required Default
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 (This parameter is required if the default ADMIN user was disabled during the setup.) ADMIN
adminPassword Administrator password to login to the repository. No (This parameter is required if the default ADMIN user was disabled during the setup.) 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_backupJFSIndexes.log

where application is jts, ccm, rm, qm, gc, dcc, or relm.

toFile Path to the .zip file No N/A
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

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

For Windows
operating system Open a command prompt and enter this command:

cd C:\Program Files\IBM\JazzTeamServer\server\
repotools-jts.bat -backupJFSIndexes repositoryURL=https://hostname.example.com:9443/jts toFile=C:\Temp\JFSIndexesBackup.zip kerberos=true

For Unix
operating systems Open a command line and enter this command:

cd opt/IBM/JazzTeamServer/server
./repotools-jts.sh -backupJFSIndexes repositoryURL=https://hostname.example.com:9443/jts toFile=opt/temp/JFSIndexesBackup.zip