![]() |
Page History
To view usage information for any DME CLU command, type the command with the help (-h) parameter. For detailed information on each of the available DME CLU commandsuse DME CLU, refer to the following pagesprerequisites:
- For all CLU users: Getting Started
Generating a DME API Authentication Token via the CLU — dm_generate_token
Finding Data
- Searching for Data via the CLU — dm_query_dataobject
Using Bookmarks
Adding a Bookmark via the CLU — dm_add_bookmark
Retrieving Metadata
Retrieving the Metadata of a Collection via the CLU — dm_get_collection
Retrieving the Metadata of a Data File via the CLU — dm_get_dataobject
- with DME CLU
- When using Globus: Preparing to Use Globus
Registering Data
Creating an Empty Collection via the CLU — dm_register_collectionThe character limit for each metadata value is 2700.
The following table provides examples for some of the most commonly-used DME CLU commands:
Detailed Instructions | Example | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creating an Empty Collection via the CLU | The following command creates a Project_New collection within the PI_Lab1 collection and applies to that new collection the metadata in the collection-metadata.json file:
Replace the DME path (/Test_Archive/PI_Lab1/Project_New) with a DME path to which you have write access. The JSON file must contain metadata for the new collection, Project_New. If the parent collection, PI_Lab1, does not already exist, then the JSON file must also contain metadata for that collection. | ||||||||||||
Registering a Data File via the CLU |
...
The following command registers the test.txt file from a test folder to the Project_New collection in DME:
|
...
|
...
|
...
Registering Directory Contents from Your File System via the CLU — dm_register_directory
...
Updating Collection Metadata via the CLU — dm_register_collection
...
Replace the DME path (/Test_Archive/PI_Lab1/Project_New/test.txt) with a DME path to which you have write access. |
...
...
The following command downloads a sample.txt file from the Project_Orig collection in DME to a test folder:
Replace the DME path (/Test_Archive/PI_Lab1/Project_Orig/sample.txt) with a DME path to which you have read access. | |||||||||||||
Downloading One or More Collections via the CLU | The following command downloads the Project_Orig collection in DME to a test folder:
Replace the DME path (/Test_Archive/PI_Lab1/Project_Orig) with a DME path to which you have read access. The command creates a Project_Orig folder. |
...
Using DME as an Administrator
Registering a User via the CLU — dm_register_user
Adding a Bookmark and Permissions via the CLU — dm_add_bookmark
- Moving or Renaming a Collection or File via the CLU — dm_rename
- Deleting Data via the CLU — dm_delete_datafile, dm_delete_collection
...
group | GP-CFW-DMEDOC-DEV, GP-CFW_ADMINS |
---|
...