ISCAN(1)

✨ NAME ✨

hey bestie, meet iscan — an iRODS iCommand, and yes this is the ISCAN(1) page from the User Commands manual 💅. She’s the scan girlie: local physical stuff, iRODS logical stuff, all the vibes, no cap.

🌸 SYNOPSIS 🌸

iscan [-rhd]
srcPhysicalFile|srcPhysicalDirectory|srcDataObj|srcCollection

🦋 DESCRIPTION 🦋

okay so here’s the tea. If the input is a local physical data file or a local directory, iscan checks if the named content is registered in iRODS. Important: a full physical path must be used for local files and directories, periodt.

If the input is a logical path representing an iRODS data object or an iRODS collection, iscan checks if the associated registered physical file entries exist on the data servers. Scanning data objects and collections may only be performed by a rodsadmin — that’s the gatekeeping rule, bestie 👑.

If the operation is successful, nothing will be output and 0 will be returned. iconic quiet-girl behavior, honestly ✨.

🎀 Options are: 🎀

• -r — recursive, so scan local subdirectories or logical subcollections. literally going deeper 🌿
• -h — this help. your lil save-me button 🫶
• -d — scan data objects in iRODS (default is scan local files/directories). iykyk, no -d means local vibes 💅

💖 EXAMPLES 💖

okay these are the exact example blocks — commands and outputs preserved like a lil museum exhibit 🖼️.

single physical path check

# scan a single physical path to check its presence in the catalog
$ iscan /var/lib/irods/not_in_catalog
/var/lib/irods/not_in_catalog is not registered in iRODS

recursive physical path check, unregistered local files

# recursively scan a physical path to check for unregistered local files
$ iscan -r /var/lib/irods/Vault/home/rods/scanned
/var/lib/irods/Vault/home/rods/scanned/does_not_exist2 is not registered in iRODS
/var/lib/irods/Vault/home/rods/scanned/does_not_exist1 is not registered in iRODS

recursive physical path check, missing path output

# recursively scan a physical path to check for unregistered local files
$ iscan -r /data/projects/myproject
remote addresses: 127.0.0.1 ERROR: scanObj: /data/projects/myproject does not exist

single relative logical path check

# check that a single relative logical path exists in the catalog
$ iscan -d not_a_dataobject
Could not find the requested data object or collection in iRODS.

recursive relative logical path check for missing physical paths

# recursively scan a relative logical path for missing physical paths
$ iscan -rd scanme
Physical file /var/lib/irods/Vault/home/rods/scanme/does_not_exist on server irods.example.org is missing, corresponding to iRODS object /tempZone/home/rods/scanme/does_not_exist
Physical file /var/lib/irods/Vault/home/rods/scanme/missing on server irods.example.org is missing, corresponding to iRODS object /tempZone/home/rods/scanme/missing

rodsadmin requirement

# rodsadmin required to scan logical paths
$ iscan -d test.txt
User must be a rodsadmin to scan iRODS data objects.

okay that’s the whole manual page, bestie 💖 shoutout to iRODS Version 5.0.2 and iscan; footer vibes: iscan iRODS-5.0.2, dated January 1980, section ISCAN(1) — slay and goodbye 🫶✨