IGET(1)

🦋 IGET(1) — iget, the iRODS iCommand (User Commands) 🦋

✨ NAME ✨

iget — an iRODS iCommand. That's the name, that's the vibe, she's iconic 💅

🌸 SYNOPSIS 🌸

iget [-fIKPrUvVT] [-n replNumber] [-N numThreads] [-X restartFile]

💖 DESCRIPTION 💖

Okay bestie, the original page literally opens DESCRIPTION with the rest of that synopsis line, so here it is exactly, no edits:

[-R resource] [--lfrestart lfRestartFile] [--retries count] [--purgec]
srcDataObj|srcCollection ... destLocalFile|destLocalDir

Then it hits you with these usage blocks:

Usage: iget [-fIKPUvVT] [-n replNumber] [-N numThreads] [-X restartFile]
[-R resource] [--lfrestart lfRestartFile] [--retries count] [--purgec]
srcDataObj|srcCollection

Usage: iget [-fIKPUvVT] [-n replNumber] [-N numThreads] [-X restartFile]
[-R resource] [--lfrestart lfRestartFile] [--retries count] [--purgec]
srcDataObj ... -

So the whole point is: get data-objects or collections from iRODS space, either to the specified local area or to the current working directory. Slay. 💖

Data Objects with multiple replicas in iRODS may have one or more 'stale' replicas (they will not display the & before the filename in ils -l or ils -L). iRODS will not serve a stale or 'dirty' replica unless asked specifically (by using the -R option). Without the -R option, a clean replica will be selected and served to the client.

If the destLocalFile is -, the files read from the server will be written to the standard output (stdout). Similar to the UNIX cat command, multiple source files can be specified. iykyk 🫶

The -X option specifies that the restart option is on and the operation is restartable. The restartFile input specifies a local file that contains the restart info. If the restartFile does not exist, it will be created and used for recording subsequent restart info. If it exists and is not empty, the restart info contained in this file will be used to restart the operation. Note that the operation is not restarted automatically when it failed. Another iget -X run must be made to continue from where it left off using the restart info. But the -X option can be used in conjunction with the --retries option to automatically restart the operation in case of failure. Also note that the restart operation only works for downloading directories and the path input must be identical to the one that generated the restart file. Important little caveat, bestie! ⚠️

The --lfrestart option specifies that the large file restart option is on and the lfRestartFile input specifies a local file that contains the restart info.

The --lfrestart option can be used together with the -X option to do large file transfer restart as part of the overall collection download restart.

Large files are defined by the 'maximum_size_for_single_buffer_in_megabytes' advanced configuration setting.

The -T option will renew the socket connection between the client and server after 10 minutes of connection. This gets around the problem of sockets getting timed out by the firewall as reported by some users. Firewall said timeout? Not today. 🔥

🎀 Options are: 🎀

• -f — force: write local files even if they already exist (overwrite them).
• -I — redirect connection: redirect the connection to connect directly to the best (determined by the first 10 data objects in the input collection) resource server.
• -K — verify the checksum.
• -n replNumber — retrieve the copy with the specified replica number.
• -N numThreads — the number of threads to use for the transfer. A value of 0 means no threading. By default (-N option not used) the server decides the number of threads to use.
• --purgec — purge the staged cache copy after downloading a COMPOUND object.
• -P — output the progress of the download.
• -r — recursive: retrieve subcollections.
• -R resource — specify a resource from which to get the data. If no such resource exists or a replica does not exist on the specified resource, an error will be returned.
• -T — renew socket connection after 10 minutes.
• -v — verbose.
• -V — Very verbose.
• -X restartFile — specifies that the restart option is on and the restartFile input specifies a local file that contains the restart info.
• --retries count — retry the iget in case of error. The count input specifies the number of times to retry. It must be used with the -X option.
• --lfrestart lfRestartFile — specifies that the large file restart option is on and the lfRestartFile input specifies a local file that contains the restart info.
• -t ticket — ticket (string) to use for ticket-based access.
• --kv_pass — pass quoted key-value strings through to the resource hierarchy, of the form key1=value1;key2=value2.
• -h — this help.

And right after -h, the page has this little version echo: iRODS Version 5.0.2 iget.

---

✨ Final footer energy, bestie: this whole manual is signed off as iget iRODS-5.0.2, dated January 1980, with IGET(1) stamped on the footer. Source/version and date, cute and accounted for. Bye! 💖🎀🦋