The initial commit of 0.9.5-pre1 version
[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            This is the SCST Perl module required by scstadmin and scst_db.
11                         Copy the SCST directory to your perl5 lib directory:
12                                 #> cp -r SCST /usr/lib/perl5/
13
14         scstadmin       Script which can accept operations on a command line or from
15                         a configuration file. See scst.conf. For command help,
16                                 #> scstadmin
17
18         old             Script which configures SCST using configurations
19                         found in a database. See the examples directory database
20                         schema and example data. You will need to edit the
21                         config file scst_db.conf to refect your environment.
22
23         scst.conf       Configuration file for scst script. Usually stored
24                         in /etc.
25
26         examples        Configuration examples.
27
28         init.d/scst     Init script to start SCST on boot which uses scstadmin.
29
30
31 Getting Started:
32
33 The scstadmin script is much more functional than scst_db at this point but uses a
34 standard text-based config file. The original thought behind scst_db was to write
35 a daemon process which would except network connections and issue SCST commands. A
36 client app would then connect to that port. 
37
38 Copy scst.conf to /etc and edit it to your liking. if you have an existing configuration
39 then have scstadmin write it out to a config file for you:
40
41 #> scstadmin -WriteConfig /etc/scst.conf
42
43 When removing devices, users or groups from the config file keep in mind that
44 "scstadmin -config" will NOT remove those configurations from the running system unless
45 you use the -ForceConfig flag. Also, using the init script to reload the configuration
46
47 #> /etc/init.d/scst -reload-config
48
49 will also not remove configurations from a running system.
50
51
52 Mark.Buechler@gmail.com
53