Skip to main content
Pentaho Documentation

Command line arguments reference

Parent article

You can use the command line to manage the Pentaho Repository. The following tables list the command arguments, descriptions, values, and whether a specific argument is required.

Upload

The following arguments are for uploading to the Pentaho Repository:
CommandDescriptionValuesRequired
-i, --importUpload Commandn/aYes
-x, --source <arg>External system typelegacy-db or file-system (default)Yes
-o, --overwrite <arg>Overwrites file(s) on upload. Default value is: TrueBooleanNo
-m, --permission <arg>Applies ACL using manifest file. Default value is: TrueBooleanNo
-r, --retainOwnershipReplaces the file ownership upon upload with the ownership of the original download. Default value is: TrueBooleanNo
-t, --type <arg>The type of content being uploaded - files (default), metadata. File typeNo

Download

The following arguments are for downloading from the Pentaho Repository:
CommandDescriptionValuesRequired
-e, --exportDownload commandn/aYes
-fp, --filepath <arg>Location that the ZIP file is downloaded toFile pathYes
-w, --withManifest <arg>If true, includes Manifest.xml inside ZIP. If false, download excludes this file.BooleanNo

Backup and restore

The following arguments are for backing up or restoring the Pentaho Repository:
CommandDescriptionValuesRequired
--backup Backup commandn/aYes
--restoreRestore commandn/aYes
-a, --url <arg>URL ofPentaho Repository (for example: http://localhost:8080/pentaho)URLYes
-u, --username <arg>Pentaho Repository usernameAlphanumericYes
-p, --password <arg>Pentaho Repository passwordAlphanumericYes
-fp, --filepath <arg>Location that the ZIP file is downloaded toFile pathYes
-o, --overwrite <arg>Overwrites file(s) on upload. Default value is: TrueBooleanNo
--logfileSpecifies the location for writing the log file.File pathNo

Common arguments

The following arguments apply to uploading, downloading, backing up and restoring the Pentaho Repository:
CommandDescriptionValuesRequired
-a, --url <arg>URL ofPentaho Repository (for example: http://localhost:8080/pentaho)URLYes
-c, --charset <arg>Charset to use for the repository. Characters from external systems are converted to this charset.UTF-8 (default)No
-h, --helpPrints this message.n/aNo
-f, --path <arg>Pentaho Repository path to which the uploaded files are added (for example: /public)File pathYes
-p, --password <arg>Pentaho Repository passwordAlphanumericYes
-u, --username <arg>Pentaho Repository usernameAlphanumericYes
-l, --logfile <arg>Path to local file system with name of file to writeFile pathNo
-a_ds, --analysis-datasource <arg>Analysis datasource type.AlphanumericNo
-a_param, --analysis-parameters <arg>Analysis datasource parameters.AlphanumericNo
-a_xmla, --xmla-enabled <arg>Analysis XMLA enabled flag.BooleanNo
-cat, --catalog <arg>Catalog description.AlphanumericNo
-ds, --datasource-type <arg>Datasource type.AlphanumericNo
-m_id, --metadata-domain-id <arg>Metadata domain ID.AlphanumericNo
-params, --params <arg> Parameters to pass to REST service call.AlphanumericNo
-res, --resource-type <arg>Import/Export resource type.AlphanumericNo
-rest, --restUse the REST (default) version (not local to the Pentaho Server).AlphanumericNo
-s, --legacy <arg>If True - use the legacy Import/Export on the local Pentaho Server.BooleanNo
-v, --service <arg>This is the REST Service call, for example: ACL, children, propertiesURLNo