TGT-ADMIN(8)

📦
version 1.0.98 · 13 versions
, in alpine 3.24, arch rolling

👑 TGT-ADMIN(8) — the tgt-admin glow-up 🎀

okay bestie, so this is the manual page for tgt-admin, section 8 of the manual (that's the sysadmin-commands girlies 💅). Everything you need is right here, no cap.

✨ NAME ✨

tgt-admin — Linux SCSI Target Configuration Tool

Like, literally the tool that lets you configure targets and luns persistently. She's giving main character energy in the SCSI target world. 🦋

🌸 SYNOPSIS 🌸

tgt-admin [-e --execute] [--delete <value>] [--offline <value>]
          [--ready <value>] [-s --show] [-C --control-port <NNNN>]
          [-c --conf <file>] [--ignore-errors] [-f --force]
          [-p --pretend] [--dump] [-v --verbose] [-h --help]

So many flags, so little time, iykyk. 🫶

💖 DESCRIPTION 💖

tgt-admin is a utility which allows a persistent configuration of targets and luns. That's the whole vibe. ✨ She uses tgtadm commands under the hood to create, delete and show targets — so yes, she's got a whole team behind her, but she's the one running the group chat.

🎀 OPTIONS 🎀

  • -e, --execute — Reads /etc/tgt/targets.conf and executes tgtadm commands. Lowkey important detail: if the target already exists, it won't be processed. Like, she's not gonna double-work a target that's already there. Check --update if that's what you wanted. 🙈
  • -d, --delete <value> — Deletes all or selected targets. But bestie, listen: the target will be deleted only if it's not used (aka no initiator is connected to it). It's giving "respect the boundaries." 🚫

If you want to delete targets which are in use, you have to add the "--force" flag. Yes, we're going there. 💀

Example usage:

--delete ALL            - delete all targets
--delete tid=4          - delete target 4
                          (target with tid 4)
--delete iqn.2008-08.com.example:some.target
                        - delete this target
  • --offline — Puts all or selected targets in offline state. She's taking a nap, don't @ her. 😴

Example usage:

--offline ALL           - offline all targets
--offline tid=4         - offline target 4
                          (target with tid 4)
--offline iqn.2008-08.com.example:some.target
                        - offline this target
  • --ready — Puts all or selected targets in ready state. She's back, refreshed, glowing. ✨

Example usage:

--ready ALL             - ready all targets
--ready tid=4           - ready target 4
                          (target with tid 4)
--ready iqn.2008-08.com.example:some.target
                        - ready this target
  • --update <value> — Updates all or selected targets. Same rule as delete, bestie: the target will be updated only if it's not used (no initiator is connected to it). 🤞

If you want to update targets which are in use, you have to add the "--force" flag. Yeah, that flag is doing a LOT of heavy lifting on this page. 💪

Example usage:

--update ALL             - ready all targets
--update tid=4           - ready target 4
                           (target with tid 4)
--update iqn.2008-08.com.example:some.target
                         - update this target
  • -s, --show — Shows all the targets. Just, like, a full tour of the situation. 👀
  • -C, --control-port <NNNN> — Okay so this is actually iconic: it is possible to run multiple concurrent instances of tgtd on a host. This argument is used to control which instance the tgt-admin command will operate on. Pick your fighter. 🥊
  • -c, --conf <configuration file> — Specifies an alternative configuration file instead of /etc/tgt/targets.conf, which is the default. She's flexible like that. 🧚
  • --ignore-errors — Continues even if tgtadm exits with non-zero code. She's choosing peace. 🕊️
  • -f, --force — Forces some operations even if the target is in use. The "I said what I said" flag. 🔥
  • -p, --pretend — Only prints tgtadm options which would be used; doesn't execute any actions. Assumes -v. It's a dress rehearsal, not the actual show. 🎭
  • --dump — Dumps current tgtd configuration. Note: it does not include detailed parameters, like write caching. So don't come for her when the details aren't there, she told you upfront. 💀
  • -v, --verbose — Increases verbosity (shows tgtadm commands used). She's telling you everything, bestie. 🗣️
  • -h, --help — Displays a list of available options and exits. The classic "wait what are my options again" move. 🙋‍♀️

🦋 FILES 🦋

  • /etc/tgt/targets.conf — Configuration file for tgt-admin.
  • /usr/share/doc/tgt/targets.conf.example — Example configuration file for tgt-admin. Study it, it's literally the blueprint. 📓

🌈 SEE ALSO 🌈

targets.conf(5), tgtd(8), tgtadm(8), tgtimg(8), tgt-setup-lun(8).

https://github.com/fujita/tgt

The whole friend group, plus the link. Go click it. 👑

💜 REPORTING BUGS 💜

Found something cursed? Report bugs to <stgt@vger.kernel.org>. Be nice about it, they're doing their best. 🫶

ngl that was a lot of flags, but you ate that. periodt. 💅

— with love, from the [FIXME: source] edition, dated 11/01/2026 🎀✨

📦 where this page comes from