Commands and common parameters for istool

You can use the istool commands to manage assets that are stored in the metadata repository of InfoSphere® Information Server.

The istool commands have the following basic syntax:
command authentication_parameters [generic_parameters] [command_parameters]
This topic has the following sections: Parameters and syntax for commands are explained in the separate command topics.

istool commands

The following tables lists all istool commands.
Table 1. istool commands
Command Description
build package Build a package of InfoSphere DataStage and QualityStage assets to be deployed.
delete Delete InfoSphere DataStage and QualityStage assets.
deletecm Delete common metadata assets.
deploy package Deploy a package of InfoSphere DataStage and QualityStage assets.
export Export the following types of assets to a file for transfer to a newer version or different instance of InfoSphere Information Server:
event deleteEvents Delete exception events and governance events.
event listCallbacks List the applications that are registered for event types.
event listEvents List processed events.
event registerCallback Register an application so that it can receive and process notifications of events of a specific type.
event unregisterCallback Unregister an application so that it no longer processes events.
event updateEventType Change the email notifications or description of an event type.
glossary export Export business glossary assets (terms, categories, information governance rules, information governance policies) to a file.
glossary import Import business glossary assets from a file of previously archived assets, or import a glossary model (.ndm) file from IBM InfoSphere Data Architect.
glossary bi2bg Generate categories and terms from business intelligence (BI) models.
glossary ldm2bg Generate categories and terms from logical data models.
import Import the following types assets from a file into a newer version or different instance of InfoSphere Information Server:
import custom attribute values Import custom attribute values into the metadata repository by using a file in a comma-separated value (CSV) format.
query Query common metadata assets (implemented data resources, logical and physical data models, and business intelligence assets) and write the results to a file.
send package Send a package of InfoSphere DataStage and QualityStage assets to the local client computer.
workbench extension mapping delete Delete extension mapping documents from the metadata repository.
workbench extension mapping export Export extension mapping documents from the metadata repository to a file in a comma-separated value (CSV) format.
workbench extension mapping import Import extension mapping documents into the metadata repository.
workbench extension source delete Delete extended data source assets from the metadata repository.
workbench extension source export Export extended data source assets from the metadata repository to a file in a comma-separated value (CSV) format.
workbench extension source import Import extended data source assets from a file in a comma-separated value (CSV) format into the metadata repository.
workbench purgeOMD Delete operational metadata from transformation projects, jobs, and stages of InfoSphere DataStage or InfoSphere QualityStage.
workbench query Run published and user queries of InfoSphere Information Governance Catalog from the command line, and view the results in a file.

Authentication parameters

Use the authentication parameters to specify the InfoSphere Information Server services tier computer to connect to. The authentication parameters in the following table are used by all istool commands.
Table 2. Authentication parameters
Name Argument Description
-domain | -dom domain[:port] Optional. If you do not specify this parameter, the primary domain server is used for the connection.
The argument depends on the configuration of IBM WebSphere® Application Server:
  • If clustering is set up, the name or IP address and the port of the front-end dispatcher (either the web server or the load balancer). Do not use the host name and port of a particular cluster member.
  • If clustering is not set up, the host name or IP address of the computer where WebSphere Application Server is installed and the port number that is assigned to the IBM InfoSphere Information Server Web console, by default 9443.
If you use an IPV6 address, you must enclose it in square brackets ([ ]). For example, 
istool export -domain [2002:920:c000:217:9:32:217:32]:9443 
-username user1 -password pass1 -archive "c:\arc.isx" 
-datastage '"serv2/Proj/Jobs/Mine/ajob.pjb"'
-authfile | -af name_and_path_of_credentials_file The path to a file that contains encrypted credentials for logging on to InfoSphere Information Server. If you use -authfile, you do not need to specify -username or -password on the command line. If you specify both the -authfile option and the explicit user name and password options, the explicit options take precedence. For more information, see the topic Encrypt command.
-username | -u user_name Name of the user account on the services tier
-password | -p password Password for the account that is specified in the -username parameter. (Optional after the first login).

Generic parameters

The generic parameters in the following table are optional parameters that can be used with all istool commands.
Table 3. Generic parameters
Option long name Argument Description
-help | -h N/A Prints the list of command options. To view help for a specific command, enter istool command -help.
-script name_and_path_of_script_file Run commands that are read directly from a text file. The file is read and run as a series of command lines.
-silent | -s N/A Silences non-error command output.
-verbose | -v N/A Prints detailed information throughout the operation.

Common parameters

The following table lists parameters that are common to the istool import or istool export commands for most tools and asset types.

Table 4. Common parameters for the istool import and istool export commands
Name Argument Description Exceptions
-all N/A Optional. Used with the istool export and istool import commands. Exports all assets in the metadata repository to one or more archive files. Imports archive files that were exported by using the -all parameter. See Moving all assets from one metadata repository to another. Not supported for InfoSphere DataStage and QualityStage assets or InfoSphere Information Governance Catalog assets.
-abortAfter | -abort number_of_errors Optional. Used with istool import command. Stops the import after the specified number of errors.
-abortIfError | -abort number_of_errors Optional. Used with istool export command. Stops the export after the specified number of errors.  
-archive | -ar archive_name_and_path Required. Used with istool import and istool export commands. Specifies the archive file to be exported or imported.  
-maxArchiveSize | -mas number_of_megabytes Optional. Used with istool export command. Specifies the maximum size in megabytes of the export archive file and creates additional archive files when that size is exceeded.

Each additional archive file is named with the name that you specify as a value for the -archive parameter, followed by an underscore and a sequential number. For example, if you specify the file name myArchive.isx and two more archives are created, the additional archives are named myArchive_1.isx and myArchive_2.isx.

When you import the exported archive files, if you specify the first archive file in the import command, for example myArchive.isx, all additional files are automatically imported. However, if you specify a subsequent file, for example, myArchive_1.isx, only that file is imported. If you specify the first archive file for import and one of the additional files is missing, the import fails.

 Not supported for glossary assets.
-preview | -pre N/A Optional. Used with istool import and istool export commands. Previews the import and export tasks without running the command.  
-replace N/A Required only for security and reporting imports, otherwise optional. Used with istool import command. Specifies how to resolve an identity conflict.

If you specify -replace, and an asset with the same identity exists in the target metadata repository, the existing asset is replaced by or merged with the imported asset, depending on the type of asset.

If you do not specify -replace, the new asset is not imported if there is an existing asset in the target metadata repository that has the same identity.

 Use -mergemethod instead of -replace for glossary imports. Some tools have more options for replacing assets. The -replace option for the istool send package command has different functionality.
-responseFile file_name_and_path Optional. Used with istool import and istool export commands. Specifies the name and path of a response file that contains assets that failed to export or import during a run of a previous istool export or import command. You can fix the problem and export or import the failed assets. For more information see Using a response file with istool export and istool import commands. Not supported for InfoSphere Information Governance Catalog assets.
-updatearchive | -up N/A Optional. Used with istool export command. Updates the specified archive file by adding new assets or overwriting changed assets. No assets in the archive file are deleted.  
Parent topic: Using the istool command line