Command Reference

jdma command [command] [arg] [options]

Options:

[-h|--help]
[-e|--email=EMAIL]
[-w|--workspace=WORKSPACE]
[-f]--filter=workspace|user]
[-l|--label=LABEL]
[-r|--target=TARGET]
[-s|--storage=STORAGE]
[-n|--limit=LIMIT]
[-d|--digest]
[-j|--json]
[-t|--simple]
[-F|--force]

Help command

jdma_client.jdma.do_help(args)

help <command> : get help for a command.

User and system commands

jdma_client.jdma.do_init(args)

init <email address> : Initialise the Joint-Storage Data Migration App for your JASMIN login. Creates a configuration file at ~/.jdma.json.

jdma_client.jdma.do_email(args)

email <email address> : Set / update your email address for notifications.

jdma_client.jdma.do_info(args)

info : get information about you, including email address and notification setting.

jdma_client.jdma.do_notify(args)

notify : Switch on / off email notifications of the completion of GET | PUT | MIGRATE requests. Default is on.

jdma_client.jdma.do_storage(args)

storage : list the storage targets that batches can be written to.

Data transfer commands

jdma_client.jdma.do_put(args)

put <path>|<filelist>: Create a batch upload of the current directory, or directory in <path> or a list of files. Use –label= to give the batch a label. Use –storage to specify which external storage to target for the migration. Use command storage to list all the available storage targets.

jdma_client.jdma.do_migrate(args)

migrate <path>|<filelist>: Create a batch upload of the current directory, or directory in <path> or a list of files. Use –label= to give the batch a label. Use –storage to specify which external storage to target for the migration. Use command storage to list all the available storage targets. The data in the directory or filelist will be deleted after the upload is completed.

jdma_client.jdma.do_get(args)

get <batch_id> : Retrieve a batch upload of a directory or filelist with the id <request_id>. A different target directory to the original directory can be specified with –target=.

get <batch_id> <filelist> : Retrieve a (subset) list of files from a batch with <batch_id>. <filelist> is the name of a file containing a list of filenames to retrieve. The filenames in the filelist must be the relative path, as obtained by jdma --simple files <batch_id>.

jdma_client.jdma.do_delete(args)

delete <batch_id> : Delete the batch with <batch_id> from the storage

Data transfer properties and status commands

jdma_client.jdma.do_label(args)

label <batch_id> : Change the label of the batch with <batch_id>.

jdma_client.jdma.do_request(args)

request <request_id> : List all requests, or the details of a particular request with <request_id>.

jdma_client.jdma.do_batch(args)

batch <batch_id> : List all batches, or all the details of a particular batch with <batch_id>.

jdma_client.jdma.do_files(args)

files <batch_id> : List the original paths of files in a batch. Use the –simple option to produce a simply formatted list which can be used in conjunction with the get command to get a subset of the batch.

jdma_client.jdma.do_archives(args)

archives <batch_id> : List the archives in a batch.

Options

jdma_client.jdma.main()
-e|--email=EMAIL : Email address for user in the init and email commands.
-w|--workspace=WORKSPACE : Group workspace to use in the request. Use all to list all workspaces for a user.
-f|--filter=user|workspace : List either the requests or batches for just a user or for all users in a workspace.
-l|--label=LABEL : Label to name or update the request.”
-r | --target : Optional target directory for GET.”
-s | --storage : Specify external storage to use for migration. Use command storage to list the available storage targets. Default is given in the config file ~/.jdma.json.
-n | --limit : Limit the number of files output when using the files or archives command.
-d | --digest : Show the SHA256 digest when using the files or archives command.
-j | --json : Output JSON, rather than formatted output, for all commands.
-t | --simple : Output simple listings for files and archives commands.
-F | --force : Force deletion of batch, rather than prompting for user confirmation.