Exporting and Importing Module Data Using the CLI

Exporting Modules Using CLI

Prerequisites

You have the proper module name or the module group type name (Plug-in name) to be exported.

Call up

Interactive mode

startcli [-u <user account>] [-p <password>]
...
export --exportModule [<module name>] --exportModuleUser <user name or user group name> --exportModuleGroup[<module group type>] --exportFile <file path to ZIP archive> [--exportTag <tag>]

Script mode

startcli --execCommand "export --exportModule [<module name>] --exportModuleUser <username or user group namer> --exportModuleGroup[<module group type>] --exportFile <file path to ZIP archive> [--exportTag <tag>]

Command options

Option Description

Option	Description
`-h,--help`	Displays the usage
`--exportModule <arg>`	Name(s) of module to be exported. When exporting multiple modules, the module names must be comma-separated and put in single quotation marks. To export all modules, use the `--exportModule` option.
`--exportModuleUser <arg>`	User, user group or higher-level user group owning the module(s) to be exported.
`--exportModuleGroup <arg>`	Name(s) of module group type(s) (Plug-in name) to be exported. Export of multiple module group types must be comma-separated and put in single quotation marks. To export all module group types, use the `--exportModuleGroup` option.
`--exportFile <arg>`	Absolute path to the export file (ZIP archive)
`--exportTag <arg>`	Optional: Tag to be exported. If no tag is set, HEAD is exported.

-h,--help

Displays the usage

--exportModule <arg>

Name(s) of module to be exported. When exporting multiple modules, the module names must be comma-separated and put in single quotation marks. To export all modules, use the --exportModule option.

--exportModuleUser <arg>

User, user group or higher-level user group owning the module(s) to be exported.

--exportModuleGroup <arg>

Name(s) of module group type(s) (Plug-in name) to be exported. Export of multiple module group types must be comma-separated and put in single quotation marks. To export all module group types, use the --exportModuleGroup option.

--exportFile <arg>

Absolute path to the export file (ZIP archive)

--exportTag <arg>

Optional: Tag to be exported. If no tag is set, HEAD is exported.

Example

Interactive mode

export --exportModule 'fileConn' --exportModuleUser root --exportModuleGroup '' --exportFile c:\temp\export.zip
export --exportModule '' --exportModuleUser root --exportModuleGroup 'File Connector' --exportFile c:\temp\export.zip

Script mode

startcli -u root -p inubit --execCommand "export --exportModule 'fileConn' --exportModuleUser jh --exportModuleGroup '' --exportFile c:\temp\export.zip"

Importing Modules Using CLI

Call up

startcli -u<User> [-p<Password>]
...
import --importModule --importFile <file path of ZIP archive> --importUser <user name or user group name>

Command options

Option Description

Option	Description
`-h,--help`	Displays the usage
`--importFile <arg>`	File path to the archive to be imported
`--importUser <arg>`	User, user group or higher-level user group to be imported

-h,--help

Displays the usage

--importFile <arg>

File path to the archive to be imported

--importUser <arg>

User, user group or higher-level user group to be imported

Example

import --importModule --importFile c:\temp\export.zip --importUser root