NIH | National Cancer Institute | NCI Wiki  

Error rendering macro 'rw-search'

null

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: For HPCDATAMGM-1141: Updated command name to match recent change in Jira comment.

...

  1. Prepare a Globus endpoint, as described in Preparing to Use Globus with DME.

  2. Consider how you want to specify the Globus endpoint:

    • If you want to use the default Globus endpoint in your hpcdme.properties file, as described in Getting Started with DME CLU, plan to omit the endpoint from the command. 
    • If you want to specify a different Globus endpoint, plan to include the endpoint in the command.
  3. Run the following command:

    Code Block
    dm_download_collection_asyncglobus [optional parameters] [collection-logical-path] <globus-destination-path> [globus-endpoint]

    The following table describes each parameter:

    ParameterDescription
    [-D <REST-response>]

    An optional parameter, specifying a path and filename in your file system. The system always creates a response file:

    • If you specify this parameter, the system saves the response from the server to the specified file in the specified location.
    • If you omit this parameter, the system saves the file as download-collection-response-header.tmp in your home directory.
    [-o <output-json-file>]

    An optional parameter, specifying a path and filename in your file system. The system always creates an output file:

    • If you specify this parameter, the system saves the output to the specified file in the specified location.
    • If you omit this parameter, the system saves the output as download-collection-response-message.json.tmp in your home directory.

    If the command is successful, the output file is empty.

    [-f <paths-file>]

    or

    [collection-logical-path]

    One or more paths within DME. Select one of the following methods to specify the collection or collections that you want to download:

    • To specify multiple collections, use the -f parameter to specify a path and filename in your file system, of a file that lists the paths for all of the DME collections you want to download, delimited by newline.
    • To specify a single collection, specify the path for the DME collection you want to download.
    <globus-destination-path>
    A path from the Globus endpoint. Specify where you want the system to create the downloaded file or files.
    [globus-endpoint]
    The UUID of the Globus endpoint that you want to use, if not the one specified in your hpcdme.properties file, as described in Getting Started with DME CLU. (The following instructions may be helpful: Copying the Globus Shared Endpoint UUID.)

...

Code Block
titleSingle Collection Example
dm_download_collection_asyncglobus /Example_Archive/PI_Lab1/Project_1 /

...

Code Block
titleMultiple Collections Example
dm_download_collection_asyncglobus -f collection-list.txt /

With the following code in the specified collection-list.txt file, the above command downloads multiple collections from various locations in DME.

...