...
- To run the Retrieval Tool, open a terminal or command prompt and navigate to the directory where the Retrieval Tool jar file is located
To display the help for the Retrieval Tool, run
Code Block java -jar retrievaltool-{version}-driver.jar
When running the Retrieval Tool, you will need to use these options:
Short Option
Long Option
Argument Expected
Required
Description
Default Value (if optional)
-h
--host
Yes
Yes
The host address of the DuraCloud DuraStore application
-r
--port
Yes
No
The port of the DuraCloud DuraStore application
443
-u
--username
Yes
Yes
The username necessary to perform writes to DuraStore
-p
--password
Yes
No
The password necessary to perform writes to DuraStore. If not specified the retrieval tool will first check to see if an environment variable named "DURACLOUD_PASSWORD" exists, if it does exist the retrieval tool will use its value as the password, otherwise you will be prompted to enter the password.
Not set
-i
--store-id
Yes
No
The Store ID for the DuraCloud storage provider
The default store is used
-s
--spaces
Yes
No
The space or spaces from which content will be retrieved. Either this option or -a must be included
-a
--all-spaces
No
No
Indicates that all spaces should be retrieved; if this option is included the -s option is ignored
Not set
-c
--content-dir
Yes
Yes
Retrieved content is stored in this local directory
-w
--work-dir
Yes
Yes
Logs and output files will be stored in the work directory
-o
--overwrite
No
No
Indicates that existing local files which differ from files in DuraCloud under the same path and name sould be overwritten rather than copied
Not set
-t
--threads
Yes
No
The number of threads in the pool used to manage file transfers
3
-d --disable-timestamps No No Indicates that timestamp information found as content item properties in DuraCloud should not be applied to local files as they are retrieved.
Not set -l --list-only
Highlight color green New in 2.4 No No Indicates that the retrieval tool should create a file listing the contents of the specified space rather than downloading the actual content files. The list file will be placed in the specified content directory. One list file will be created for each specified space.
Not set -f --list-file
Highlight color green New in 2.4 Yes No Retrieve specific contents using content IDs in the specified file. The specified file should contain one content ID per line. This option can only operate on one space at a time.
Not set
...