![]()
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.
- Parent Topic
- Child Topics
Upload
The following arguments are
for uploading to the Pentaho Repository:
| Command | Description | Values | Required |
| -i, --import | Upload Command | n/a | Yes |
| -x, --source
<arg> | External system type | legacy-db or file-system (default) | Yes |
| -o, --overwrite <arg> | Overwrites file(s) on upload. Default value is:
True | Boolean | No |
| -m, --permission <arg> | Applies ACL using manifest file. Default value is:
True | Boolean | No |
| -r, --retainOwnership | Replaces the file ownership upon upload with the ownership of the
original download. Default value is: True | Boolean | No |
| -t, --type
<arg> | The type of content being uploaded -
files (default), metadata. | File type | No |
- Parent Topic
Download
The following arguments are
for downloading from the Pentaho Repository:
| Command | Description | Values | Required |
| -e, --export | Download command | n/a | Yes |
| -fp, --filepath <arg> | Location that the ZIP file is downloaded to | File path | Yes |
| -w, --withManifest <arg> | If true, includes Manifest.xml inside ZIP. If
false, download excludes this file. | Boolean | No |
- Parent Topic
Backup and restore
The following arguments are for backing
up or restoring the Pentaho Repository:
| Command | Description | Values | Required |
| --backup
| Backup command | n/a | Yes |
| --restore | Restore command | n/a | Yes |
| -a, --url
<arg> | URL of Pentaho Repository (for example: http://localhost:8080/pentaho) | URL | Yes |
| -u, --username
<arg> | Pentaho Repository
username | Alphanumeric | Yes |
| -p, --password <arg> | Pentaho Repository
password | Alphanumeric | Yes |
| -fp, --filepath <arg> | Location that the ZIP file is downloaded to | File path | Yes |
| -o, --overwrite <arg> | Overwrites file(s) on upload. Default value is:
True | Boolean | No |
| --logfile | Specifies the location for writing the log file. | File path | No |
- Parent Topic
Common arguments
The following arguments apply to uploading, downloading, backing up and restoring the Pentaho Repository:
| Command | Description | Values | Required |
| -a, --url <arg> | URL of Pentaho Repository (for example: http://localhost:8080/pentaho) | URL | Yes |
| -c, --charset <arg> | Charset to use for the repository. Characters from external systems are converted to this charset. | UTF-8 (default) | No |
| -h, --help | Prints this message. | n/a | No |
| -f, --path <arg> | Pentaho Repository path to which the uploaded files are added (for example: /public) | File path | Yes |
| -p, --password <arg> | Pentaho Repository password | Alphanumeric | Yes |
| -u, --username <arg> | Pentaho Repository username | Alphanumeric | Yes |
| -l, --logfile <arg> | Path to local file system with name of file to write | File path | No |
| -a_ds, --analysis-datasource <arg> | Analysis datasource type. | Alphanumeric | No |
| -a_xmla, --xmla-enabled <arg> | Analysis XMLA enabled flag. | Boolean | No |
| -cat, --catalog <arg> | Catalog description. | Alphanumeric | No |
| -ds, --datasource-type <arg> | Datasource type. | Alphanumeric | No |
| -m_id, --metadata-domain-id <arg> | Metadata domain ID. | Alphanumeric | No |
| -params, --params <arg>
| Parameters to pass to REST service call. | Alphanumeric | No |
| -res, --resource-type <arg> | Import/Export resource type. | Alphanumeric | No |
| -rest, --rest | Use the REST (default) version (not local to the Pentaho Server). | Alphanumeric | No |
| -v, --service <arg> | This is the REST Service call, for example: ACL, children, properties | URL | No |
- Parent Topic
