tipcli - Export plugins

Edit online

Use the Export command to export customization data for an instance of the Jazz® for Service Management application server. Use the ListExportPlugins command to list plugins that are available for export.

Restriction: When running consolecli.sh|bat commands in Tivoli® Integrated Portal environments, you must use tipcli.sh/bat instead. That is, the consolecli.sh|bat commands replaced the tipcli.sh/bat commands with the release of Dashboard Application Services Hub.
Attention: These instructions assume that you are exporting data from a Tivoli Integrated Portal environment and not a Dashboard Application Services Hub one. Therefore, the file paths and commands are documented in relation to a Tivoli Integrated Portal instance. For example, commands are documented using tipcli instead of consolecli. For Dashboard Application Services Hub environments, substitute the tipcli element of the command with consolecli.

Syntax

ListExportPlugins
Use the ListExportPlugins command to list all plugins that can be exported. Use the list of returned plugins to assist you when you are specifying plugins to be exported.
Export [--includePlugins|--excludePlugins plugin1,plugin2] [--settingFile setting_file] --username tip_username --password tip_user_password

Parameters

If you provide no parameters to the Export command, all custom data is exported by default.

Note: If you specify additional parameters for the tipcli.bat|.sh Export and make a typing error, that is, if you type a parameter incorrectly, or use the incorrect case, then the commands runs as if no parameters were specified and no warning message is displayed.

Export parameters and arguments:

  • [--includePlugins|--excludePlugins plugin1,plugin2]

    Optional parameter. You can choose to include or exclude a list of plugins when you run the Export command.

  • [--settingFile setting_file]

    Optional parameter. You can specify your export requirements in properties file instead of specifying your requirements using separate parameters at the command line. Provide a path to the settings file as the argument to the settingFile parameter. On systems running Windows you must use double backslashes characters (\\) when specifying the path to your settings file, for example, C:\\tmp\\export.properties. Command line parameters take precedence over entries in the settings file.

  • --username tip_username

    Mandatory parameter. The user name for a user with the iscadmin role.

  • --password tip_user_password

    Mandatory parameter. The password for the specified user name.

Example 1 - Return a list of plugins available for exporting

The following example returns a list of plugins that can be exported:Windows operating systems
C:\IBM\tivoli\tipv22\profiles\TIPProfile\bin>tipcli.bat ListExportPlugins

Example 2 - Export a subset of available plugins

The following example exports the CMS plugin only:Windows operating systems
C:\IBM\tivoli\tipv22\profiles\TIPProfile\bin>tipcli.bat Export 
--includePlugins com.ibm.tivoli.tip.cli.cms.CmsExportPlugin 
--username admin_user --password admin_user_password