Command line script guide
This page will provide you with information on how to use a Command line script function to upload and download data from the UNSW Data Archive. The Command line script is for users with a technical background and with large volumes of data. The Command line script allows automation, easier repeatability, and control.
This page contains the following elements:
- Preparing to use the Data Archive
- Should I use the Command line script?
- System/setup requirements
- Help and further information
Preparing to use the Data Archive
Before you start uploading your research data to the Data Archive, make sure it is organised and in alignment with UNSW recommendations and, that you know the level of access you have to the Collections inside the Data Archive. Read the Preparing data for upload and the RDMP and the Data Archive pages for more information. To access the data archive you will need:
An active UNSW zID and zPass. To verify your zID/zPass visit the UNSW Identity management page.
Access to the UNSW Network, either on a UNSW campus or by using the UNSW VPN Service
Research data identified and prepared for upload into the Data Archive.
Access levels appropriate to the tasks you wish to undertake within the Data Archive.
Note: a word of caution; it is recommended that you retain a local copy of the research data you have uploaded to the Data Archive for two weeks, before local deletion, to ensure that all three copies of your data have been created and one copy has been taken off-site. See the When should I delete / remove the local copy of my data? FAQ for more information.
Should I use the Command line script?
The UNSW Data Archive Web application provides access to an interface enabling you to upload, download, locate, and review your research data. The Data Archive Web application is suitable for researchers who wish to search the Data Archive and to either upload or download less than 50 gigabytes (GB) of data and/or less then 1000 files (during a single session).
Researchers who frequently upload or download data, and/or generate datasets, may wish to schedule a regular upload or download of data using the Command Line Script or use SFTP rather than manually uploading and downloading data via the Web application.
Note: The script can be used for automation of large, manual, uploads of data to the store.
- Researchers who upload or download more than 50 GB of data and/or more than 1000 files, at a time, please see the SFTP Client guide.
- Researchers who wish to schedule a regular upload or download of data, please follow the steps set out below.
To upload and download research data using the Command line script you will need:
- The latest version of Java.
- The source and destination paths of the data you wish to upload and/or download.
If you are running the script regularly you can contact the servicedesk to request a UNSW Data Archive Token be generated, which replaces your zPass in the script.
Help and further information:
- For help and support when using the Data Archive, see
- all Help Topics
- all Frequently Asked Questions (FAQs)
- browse through the carousel on the homepage to view all available videos
- For information on the types of data to add to the Data Archive, see Preparing data for upload
- For more information on the access levels in the Data archive, see Roles and access inside the Data Archive
- For information on using the Data Archive Web application, see the Web application guide
- For information on finding data in the Data Archive, see Search, filters, view and favourites
- For information on metadata (descriptive data) automatically and manually added to your research data, see the Metadata guide
- For information on the relationship between a Research Data Management Plan (RDMP) and the Data Archive, see RDMP and the Data Archive
- For information on submitting a RDMP, see
- To create, or update, a Research Data Management Plan (RDMP) go to the ResData service
- For information on data management at UNSW, see the Research Data Management Toolkit
- To access the Data Archive Web application, use this link, or, go to the Home page for other access options
- Note: the Data Archive service is also available over SFTP, see the SFTP client guide for more information