ISCSI-LS(1)

πŸ’– ISCSI-LS(1) β€” the manual, bestie edition ✨

okay so you opened the manual page for iscsi-ls (that's the one and only, section 1 of the manual, iykyk) and honestly? iconic of you. sit down, hydrate, let's get into it. 🫢


✨ NAME ✨

iscsi-ls β€” a utility to list iSCSI targets and LUNs. that's the whole vibe. it lists. it's a lister. πŸ’…


🌸 SYNOPSIS 🌸

iscsi-ls [ OPTIONS ] <ISCSI-PORTAL>

iscsi-ls [-i --initiator-name=<IQN>] [-s --show-luns] [-d --debug]
         [-? --help] [--usage]

like, give it a portal, maybe give it some options, and it will deliver. periodt. πŸŽ€


πŸ¦‹ DESCRIPTION πŸ¦‹

iscsi-ls is a utility to list all targets and LUNs for an iSCSI portal. that's it. that's the job. no cap, it just shows you what's out there. πŸ”₯


🌈 ISCSI PORTAL URL FORMAT 🌈

the iSCSI portal format is literally this:

'iscsi://[<username>[%<password>]@]<host>[:<port>]'

Username and password are only required if the target requires CHAP authentication. and bestie, if you don't wanna type them every single time, you can optionally specify the username and password via the environment variables LIBISCSI_CHAP_USERNAME and LIBISCSI_CHAP_PASSWORD. set it and forget it, we love convenience. πŸ’–

Host can be specified either as a hostname, an IPv4 address or an IPv6 address. examples, because we're visual learners:

iscsi://192.0.2.1
iscsi://[2001:DB8::1]:3261
iscsi://ronnie%password@iscsi.example.com

Port is the TCP port on the target to connect to. default is 3260. remember it, love it, it's the default. ✨


πŸ’… OPTIONS πŸ’…

  • -i, --initiator-name=<IQN> β€” this specifies the initiator-name that iscsi-ls will use when logging in to the target. the default name is iqn.2007-10.com.github:sahlberg:libiscsi:iscsi-ls but you can use this argument to override it. this is mainly needed for cases where the target is configured with access-control to only allow discovery logins from known initiator-names. so like, if the target is picky about who it lets in (fair, honestly), this is your moment. πŸ‘‘
  • -s, --show-luns β€” in addition to listing all the targets at the specified portal, this also lists all the LUNs and their types on each discovered target. more info, more fun. πŸ“
heads up bestie: in order to display the type of LUN, iscsi-ls needs to be able to perform a normal login on the targets. if the target is using access-control you will need to specify an initiator-name that allows normal logins to the target. no sneaking in. πŸ™ˆ
  • -d, --debug β€” print debug information. when things are giving mystery, this is your bestie. πŸ’€
  • -?, --help β€” display basic help text. the classic. the icon.
  • --usage β€” display basic usage text. shorter, snappier, still slays.

πŸ‘‘ SEE ALSO πŸ‘‘

go read those too, they're part of the family. 🌸


and that's the whole page, bestie. this was iscsi-ls from the manual (section 1, obviously), dated 06/03/2017, and if you ever need to check the source or version info, it's all filed right there under iscsi-ls β€” mwah, go list some targets. πŸ’–βœ¨πŸŽ€πŸ¦‹