istgtcontrol(1)

💖 istgtcontrol(1) — General Commands Manual 💖

okay bestie, sit down, grab a boba, because we're talking about istgtcontrol — the little command-and-control bestie for istgt(1) that lets you poke at a local or remote istgt instance and ask it how it's doing (or tell it what to do, no cap). ✨

🎀 NAME 🎀

istgtcontrol — the istgt iSCSI target command utility. it's giving "remote control for your storage, but make it cute". 💅

✨ SYNOPSIS ✨

istgtcontrol [options] <command> [<file>]

🌸 DESCRIPTION 🌸

istgtcontrol is a command and control utility for istgt(1). It can be used to query and change the status of a local or remote istgt instance. literally its whole personality. 🦋

istgtcontrol supports all the commands listed below to interact with the istgt instance. By default it connects and authenticates to the iSCSI target portal specified in the istgtcontrol.conf configuration file, and uses the CHAP credentials written down in there, if there are any. Both of those things can be overridden by using the respective command line arguments — so yeah, you have main character energy and full control. 👑

💫 COMMANDS 💫

istgtcontrol understands the following commands, which can be forwarded to istgt:

• noop — does not actually do anything 🙈, but it tests the responsiveness of the portal and tests the CHAP credentials only. it's the vibe check of commands.
• version — retrieves the istgt version number providing the iSCSI portal that istgtcontrol connected to. ✨
• list — lists all the targets shared by the portal, or just the specified targets only. 🎀
• load — loads a new media to the specified unit. This command issues the same command as if a drive tray had been closed on a SCSI device.
• unload — unloads a media from the specified unit. This command issues the same command as if the drive tray had been opened from a SCSI device.
• change file — changes the loaded media by the specified unit. This command is equivalent to as if a new media (for example a DVD-ROM or tape cartridge) had been inserted in the SCSI drive. The "file" argument is interpreted as filename to be loaded. iconic behavior tbh. 💿
• reset — resets the specified LUN of the portal.
• info — displays all connections of the portal. 👀

💅 OPTIONS 💅

• -c config — use the specified file as the configuration file instead of the default file.
• -h host — override the target portal by the specified host name or IP address. This defaults to "localhost" if no other host was specified in the configuration file.
• -p port — override the target portal port by the specified port number. This defaults to "3261" if no other port was specified in the configuration file.
• -t target — specifies the target IQN which should be affected by the command given. There may be a default given in the configuration file. The keyword "all" is accepted by some commands and matches all exported volumes.
• -l lun — specifies the target LUN which should be affected by the command given. This defaults to "0" unless another default was provided in the configuration file.
• -f flags — specifies flags passed to the portal when loading a new media. This defaults to "ro". Supported flags are: "ro", "rw", "extend" and "dynamic".
• -s size — specifies the size of the media to be loaded. The default is to auto-detect the media size.
• -q — quiet mode, suppresses non-critical outputs. 🤫
• -v — verbose mode, gives more output during operations. 🗣️
• -A method — sets the preferred authentication method for logging in to the portal. This overrides any method specified in the configuration file. Supported methods are either CHAP/Mutual or CHAP/Auto.
• -U user — sets the user to authenticate on the portal. This overrides any username specified in the configuration file.
• -S secret — sets the secret used to authenticate on the portal. This overrides any secret specified in the configuration file.
• -M muser — sets the mutual authentication user. This overrides any user specified in the configuration file.
• -R msecret — sets the mutual authentication secret. This overrides any secret specified in the configuration file.
• -H — displays a brief usage summary and exits. short and sweet fr fr.
• -V — displays the istgtcontrol version number and exits. ⭐

📁 FILES 📁

• /etc/istgt/istgtcontrol.conf — the configuration file. 🫶

🌈 SEE ALSO 🌈

istgt(1)

👑 AUTHORS 👑

Daisuke Aoyama <aoyama@peach.ne.jp>

This manual page was written by Arno Töll (<debian@toell.net>) for the Debian GNU/kFreeBSD system (but may be used by others). 🧚

aaaand that's the whole page bestie, no notes. 💖 this was istgtcontrol, from the General Commands Manual, dated Oct 07, 2011 — go forth and control your targets, you absolute legend. ✨💅🌸