1TGT-ADMIN(8) [FIXME: manual] TGT-ADMIN(8)
2
3
4
6 tgt-admin - Linux SCSI Target Configuration Tool
7
9 tgt-admin [-e --execute] [--delete <value>] [--offline <value>]
10 [--ready <value>] [-s --show] [-C --control-port <NNNN>]
11 [-c --conf <file>] [--ignore-errors] [-f --force]
12 [-p --pretend] [--dump] [-v --verbose] [-h --help]
13
15 tgt-admin is a utility which allows a persistent configuration of
16 targets and luns. It uses tgtadm commands to create, delete and show
17 targets.
18
20 -e, --execute
21 Read /etc/tgt/targets.conf and execute tgtadm commands. If the
22 target already exists, it won´t be processed. See --update.
23
24 -d, --delete <value>
25 Delete all or selected targets. The target will be deleted only if
26 it´s not used (no initiator is connected to it).
27
28 If you want to delete targets which are in use, you have to add the
29 "--force" flag.
30
31 Example usage:
32 --delete ALL - delete all targets
33 --delete tid=4 - delete target 4
34 (target with tid 4)
35 --delete iqn.2008-08.com.example:some.target
36 - delete this target
37
38
39
40 --offline
41 Put all or selected targets in offline state.
42
43 Example usage:
44 --offline ALL - offline all targets
45 --offline tid=4 - offline target 4
46 (target with tid 4)
47 --offline iqn.2008-08.com.example:some.target
48 - offline this target
49
50
51
52 --ready
53 Put all or selected targets in ready state.
54
55 Example usage:
56 --ready ALL - ready all targets
57 --ready tid=4 - ready target 4
58 (target with tid 4)
59 --ready iqn.2008-08.com.example:some.target
60 - ready this target
61
62
63
64 --update <value>
65 Update all or selected targets. The target will be updated only if
66 it´s not used (no initiator is connected to it).
67
68 If you want to update targets which are in use, you have to add
69 "--force" flag.
70
71 Example usage:
72 --update ALL - ready all targets
73 --update tid=4 - ready target 4
74 (target with tid 4)
75 --update iqn.2008-08.com.example:some.target
76 - update this target
77
78
79
80 -s, --show
81 Show all the targets.
82
83 -C, --control-port <NNNN>
84 It is possible to run multiple concurrent instances of tgtd on a
85 host. This argument is used to control which instance the tgt-admin
86 command will operate on.
87
88 -c, --conf <configuration file>
89 Specify an alternative configuration file instead of
90 /etc/tgt/target.conf, which is the default.
91
92 --ignore-errors
93 Continue even if tgtadm exits with non-zero code.
94
95 -f, --force
96 Force some operations even if the target is in use.
97
98 -p, --pretend
99 Only print tgtadm options which would be used; don´t execute any
100 actions. Assumes -v.
101
102 --dump
103 Dump current tgtd configuration. Note: does not include detailed
104 parameters, like write caching.
105
106 -v, --verbose
107 Increase verbosity (show tgtadm commands used).
108
109 -h, --help
110 Display a list of available options and exit.
111
113 /etc/tgt/targets.conf
114 Configuration file for tgt-admin.
115
116 /usr/share/doc/tgt/targets.conf.example
117 Example configuration file for tgt-admin.
118
120 targets.conf(5), tgtd(8), tgtadm(8), tgtimg(8), tgt-setup-lun(8).
121 http://stgt.sourceforge.net/
122
124 Report bugs to <stgt@vger.kernel.org>
125
126
127
128[FIXME: source] 05/11/2016 TGT-ADMIN(8)