Copyrights updated
[mirror/scst/.git] / scstadmin / README
1 SCST Configuration/Administration scripts. Here you'll find scstadmin which reads
2 a configuration file /etc/scst.conf, or one if your choosing. With it you can manually
3 or automatically configure every aspect of SCST incuding enabling/disabling target mode
4 on your target SCSI controller. The old directory contains scst_db which uses a mysql
5 backend database to configure SCST but doesn't handle all the things scstadmin handles.
6 The perl module SCST::SCST is very generic and tries to handle error checking as well.
7
8 The init script was written for debian but should work on most distributions.
9
10         scst-0.7.4      This is the SCST Perl module required by scstadmin and scst_db.
11
12         scstadmin       Script which can accept operations on a command line or from
13                         a configuration file. See scst.conf. For command help,
14                                 #> scstadmin
15
16         old             Script which configures SCST using configurations
17                         found in a database. See the examples directory database
18                         schema and example data. You will need to edit the
19                         config file scst_db.conf to refect your environment.
20
21         scst.conf       Configuration file for scst script. Usually stored
22                         in /etc.
23
24         examples        Configuration examples.
25
26         init.d/scst     Init script to start SCST on boot which uses scstadmin.
27
28
29 Installation:
30 =============
31
32 Installation is simple.
33
34   #> make
35   #> make install
36
37 This installs scstadmin, the init.d script and the perl module. If you want SCST to
38 startup and configure automatically upon boot, enable SCST using your favorite
39 SysV init editor.
40
41 NOTE: The init.d startup & shutdown scripts now depend on lsb-core. Ensure you have
42 lsb-core installed or 'make install' will fail. Make sure /usr/lib/lsb/install_initd
43 exists.
44
45
46 Getting Started:
47 ================
48
49 The scstadmin script is much more functional than scst_db at this point but uses a
50 standard text-based config file. The original thought behind scst_db was to write
51 a daemon process which would except network connections and issue SCST commands. A
52 client app would then connect to that port. 
53
54 Copy scst.conf to /etc and edit it to your liking. if you have an existing configuration
55 then have scstadmin write it out to a config file for you:
56
57   #> scstadmin -WriteConfig /etc/scst.conf
58
59 When removing devices, users or groups from the config file keep in mind that
60 "scstadmin -config" will NOT remove those configurations from the running system unless
61 you use the -ForceConfig flag. Also, using the init script to reload the configuration
62
63   #> /etc/init.d/scst reload-config
64
65 will also not remove configurations from a running system.
66
67 NOTE! Section "[TARGETS enable]" in the config file is for qla2x00t driver only!
68
69 Mark.Buechler@gmail.com
70
71
72 To Do:
73 ======
74
75 - Compare device and assignment options between current and saved configurations and
76   reopen/reassign as required if -ForceConfig is used.
77
78 Completed:
79 ==========
80
81 - Create options section to scst.conf which will be carried forward in a -writeconfig.
82
83 - Add option to issue a LIP after any group assignment changes so initiators can see
84   the change immediately.