targetclid.8


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

.TH targetclid 8
.SH NAME
.B targetclid
\- daemon component for targetcli
.SH DESCRIPTION
.B targetclid
is the daemon component of targetcli, which will help retain state of various
configfs object in memory, hence any new request/command can directly use the
in memory objects instead of reconstructing them by parsing through the entire
configfs files again and again for each and every single command. This will
greatly improve the overall execution time taken by targetcli commands at scale.

.SH USAGE
.B targetclid [cmd]
.br
.B "--help"
for additional usage information.
.br
.B "--version"
for version information.
.SH QUICKSTART & EXAMPLES
.TP
To start using the daemon, one need to enable targetclid socket,
.br
$ systemctl enable targetclid.socket
.TP
If you would like to use the daemonized approach as default method then,
.br
$ targetcli set global auto_use_daemon=true
.br
$ targetcli ls
.TP
You can use interactive mode,
.br
$ targetcli <hit-enter>
.br
targetcli shell version 2.1.51
.br
Entering targetcli interactive mode for daemonized approach.
.br
Type 'exit' to quit.
.br
/> pwd
.br
/
.br
/> cd /iscsi
.br
/> pwd
.br
/iscsi
.br
/> exit
.br
.TP
You can also use batch mode for sending multiple commands in one go,
.br
$ targetcli set global daemon_use_batch_mode=true
.br
Parameter daemon_use_batch_mode is now 'true'.
.br
$ targetcli <hit-enter>
.br
targetcli shell version 2.1.51
.br
Entering targetcli batch mode for daemonized approach.
.br
Enter multiple commands separated by newline and type 'exit' to run them all in one go.
.br
/> ls
.br
/> pwd
.br
/> get global loglevel_file
.br
/> exit
.br
.TP
You can set preference to stop using daemonized mode even when the daemon is not running,
.br
$ targetcli --disable-daemon
.SH FILES
.B /etc/target/saveconfig.json
.br
.B /etc/target/backup/*
.br
.B /var/run/targetclid.sock
.br
.B /var/run/targetclid.pid
.SH ENVIRONMENT
.SS TARGETCLI_HOME
If set, this variable points to a directory that should be used instead of ~/.targetcli
.SH SEE ALSO
.BR targetcli (8),
.BR targetctl (8),
.BR tcmu-runner (8)
.SH AUTHOR
Written by Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
.br
Man page written by Prasanna Kumar Kalever <prasanna.kalever@redhat.com>
.SH REPORTING BUGS
Report bugs via <targetcli-fb-devel@lists.fedorahosted.org>
.br
or <https://github.com/open-iscsi/targetcli-fb/issues>