IPUT(1)

💅 IPUT(1) — iput, an iRODS iCommand 🦋

okay so bestie, welcome to the manual page for iput — manual name IPUT(1), from the User Commands girlies — and yes, it's an iRODS iCommand. The whole serve is storing files into iRODS, and I'm gonna walk you through every flag so nothing catches you off guard. no cap. ✨

📛 NAME

iput - an iRODS iCommand

🌸 SYNOPSIS

iput [-abfIkKPrtTUvV] [-D dataType] [-N numThreads] [-n replNum]
[-R resource] [-X restartFile] [--ignore-symlinks] [--lfrestart
lfRestartFile] [--retries count] [--purgec]
[--kv_pass=key-value-string] [--metadata=avu-string]
[--acl=acl-string]  localSrcFile|localSrcDir ...
destDataObj|destColl

and the usage line, same energy:

Usage: iput [-abfIkKPtTUvV] [-D dataType] [-N numThreads] [-n replNum]
[-R resource] [-X restartFile] [--ignore-symlinks] [--lfrestart
lfRestartFile] [--retries count] [--purgec]
[--kv_pass=key-value-string] [--metadata=avu-string]
[--acl=acl-string]  localSrcFile

💖 DESCRIPTION

okay so here's the tea: iput stores a file into iRODS. If the destination data-object or collection are not provided, the current iRODS directory and the input file name are used. easy peasy, bestie. 🌸

restart era (-X): 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 information. If the restartFile does not exist, it will be created and used for recording subsequent restart information. If it exists and is not empty, the restart information contained in this file will be used to restart the operation. Important: the operation is not restarted automatically when it failed. Another iput -X run must be made to continue from where it left off using the restart information. 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 uploading directories and the path input must be identical to the one that generated the restart file. 🫶

⚠️ real talk: restart only works for uploading directories, and the path input has to be identical to the one that generated the restart file.

large file restart (--lfrestart): the --lfrestart option specifies that the large file restart option is on and the lfRestartFile input specifies a local file that contains the restart information. Currently, only files larger than 32 Mbytes will be restarted. The --lfrestart option can be used together with the -X option to do large file transfer restart as part of the overall directory upload restart. 🧚

overwrite behavior (-f): if the -f option is used to overwrite an existing data-object, the copy in the resource specified by the -R option will be picked if it exists. Otherwise, one of the copies in the other resources will be picked for the overwrite. Note that a copy will not be made in the specified resource if a copy in the specified resource does not already exist. The irepl command should be used to make a replica of an existing copy. 💅

redirect connection (-I): the -I option specifies the redirection of the connection so that it can be connected directly to the resource server. This option can improve the performance of uploading a large number of small (<32 Mbytes) files. This option is only effective if the source is a directory and the -f option is not used. 🚀

socket renewal (-T): 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 server firewall as reported by some users. ⏰

bulk upload (-b): the -b option specifies the bulk upload operation which can do up to 50 uploads at a time to reduce overhead. The -b and -f options are incompatible parameters. To overwrite a collection using bulk upload, the existing collection should be removed or renamed beforehand. 📦

🚨 -b and -f are incompatible parameters, bestie. don't try to make them happen.

🎀 Options are: 🎀

• -a — all: update all existing copies. every single copy gets the update ✨
• -b — bulk upload to reduce overhead. up to 50 uploads at a time, remember?
• -D dataType — the data type string. data type string era
• -f — force: write data-object even it exists already; overwrite it. yes, it overwrites — be sure, bestie.
• -I — redirect connection: redirect the connection to connect directly to the resource server. direct-to-resource-server vibe
• -k — checksum: calculate a checksum on the data server-side, and store it in the catalog. server-side checksum slay
• -K — verify checksum: calculate and verify the checksum on the data, both client-side and server-side, and store it in the catalog. verify on both sides, periodt
• --ignore-symlinks — ignore symlinks. symlinks? not today.
• -n replNum — the replica to be replaced, typically not needed. usually not needed, so don't stress
• -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. threading vibe check: 0 = no threading.
• --purgec — Purge the staged cache copy after uploading an object to a COMPOUND resource. bye, staged cache copy 🫶
• -P — output the progress of the upload. progress meter moment
• -R resource — specifies the resource to store to. This can also be specified in your environment or via a rule set up by the administrator. resource selection, but make it admin-approved
• -r — recursive: store the whole subdirectory. whole subdirectory energy
• -t ticket — ticket (string) to use for ticket-based access. ticket-based access, iykyk
• -T — renew socket connection after 10 minutes. socket refresh at the 10-minute mark
• -v — verbose. chatty mode: on
• -V — Very verbose. capital V = extra chatty
• -X restartFile — specifies that the restart option is on and the restartFile input specifies a local file that contains the restart information. restart info lives in a local file
• --retries count — Retry the iput in case of error. The 'count' input specifies the number of times to retry. It must be used with the -X option. must be used with -X, fr fr
• --lfrestart lfRestartFile — specifies that the large file restart option is on and the lfRestartFile input specifies a local file that contains the restart information. large file restart, but only files larger than 32 Mbytes
• --kv_pass — pass quoted key-value strings through to the resource hierarchy, of the form key1=value1;key2=value2. key-value strings, but make it fashion
• --metadata — atomically assign metadata after a data object is registered in the catalog. Metadata is encoded into a quoted string of the form attr1;val1;unit1;attr2;val2;unit2;. metadata, atomically, no cap
• --acl — atomically apply ACLs of the form 'perm user_or_group;perm user_or_group;' where 'perm' is defined as null|read|write|own. ACL glow-up: null|read|write|own
• -h — this help. the help era

---

okay bye bestie 🫶 — iRODS Version 5.0.2 and iput are signing off. Source/version footer vibe: iput iRODS-5.0.2, dated January 1980, manual page IPUT(1). Periodt. 💅