NAME 

cluadmin

SYNOPSIS

cluadmin [options]

cluadmin [options] command

DESCRIPTION

Administer the cluster through a command line interface (CLI).  The
CLI supports commands to make adjustments to the cluster
configuration, and to setup, modify, and control cluster services.

USAGE

$ cluadmin --help
Usage: cluadmin [OPTIONS] [COMMAND]
cluadmin - Administer cluster.

  -h,-?, --help              Give short usage message.
  -n,    --nointeractive]    Don't interact.
  -d,    --debug             Spew copious diagnostic info.
  -t,    --tcl               Allow an escape to tcl.
  -V,    --version           Print version information.

If arguments are left over on the command line, interpret the arguments 
as a command, then exit.
If no arguments are left after OPTIONS, start an interactive interpreter.
$ 

-n, --nointeractive causes the cluadmin script not to go into its
interactive command loop.  For debugging.

-d, --debug prints diagnostic messages while running.

-t, --tcl provides access to tcl commands.  For debug.

-V, --version Print version number and exit.

COMMANDS

help

The help command gives help on commands accessible throught the CLI.  The general form of a help command is: help topic subtopic ... 

cluster

The cluster command provides access to the command set that is
specifically applicable to cluster level operations.  Its sub-commands are:

        monitor

                Puts the cluster into a monitoring loop, in which the
                current state of the cluster is printed periodically.
                Accepts optional arguments -clear, and -interval.

        loglevel 

                Allows setting the loglevel of cluster daemons.

        reload  

                Causes cluster daemons to re-read the cluster
                configuration database.

        name  

                Allows the cluster name to be set and queried.

        backup  

                Saves the cluster configuration database to a safe
                place.

        restore  

                Restores a saved copy of the cluster configuration
                database.

        saveas  

                Saves the cluster configuration database to a
                specified file.

        restorefrom  

                Loads the cluster configuration database from the
                specified file.

        edit  

                Edits the cluster configuration database using the
                editor specified in the users EDITOR environment
                variable.

        status 

                Prints a single snapshot of the cluster's current
                status.


service 

        The service command provides acces to service management
        functions.

        configure

                Steps the user through a sequence of questions and
                answers to set various parameters for a service.
                Takes as an argument the name of the service to
                configure.
 
        disable 
                
                Disables the named service.

        enable 

                Enables the named service.

        show 

                state

                Display the state of the running services.

                configuration

                Display the configuration of the named service.

        create 

                Create a new service.

        modify 

                Modify an existing service.

        delete 

                Delete the named service.

clear

        Clears the screen.

exit, quit

        Exits cluadmin.


EXAMPLES

$ cluadmin
This is cluadmin.
Fri Mar 17 09:12:49 EST 2034
You can get help by typing help.
Commands: 
cluster     service        clear       
help        quit           exit
cluadmin> 
cluadmin> help cluster
Cluster directed commands: 
monitor  loglevel reload  name  backup  restore  saveas  
restorefrom  edit  status 
cluadmin> help service
Service directed commands
configure disable enable show add modify delete 
cluadmin> 

See Cluster documentation for other examples.

DEPENDANCIES

Requires SWIG1.1p5 for build, www.swig.org.  Note that swig must be
built and installed from a directory that is visible on the builders
machine later when it is used.  In other words, it is not possible to
install swig and then delete the sources from which it was built
afterwards, nor is it possible to build swig from a directory that
resides on a local partition, and install to a nfs partition.
Instead, place the sources on the nfs partition, and build and install
swig from there.

Requires tcl version >8.0, www.scriptics.com.  Tclsh is typically
installed as part of the usual installation of many linux
distribution.

INSTALLATION

Building from sources requires swig in the builder's path.  

To build:

$ ./configure --prefix="cluster source root directory"
$ make

Cluadmin is installed as part of the cluster software binary
distribution.

If tcl is installed someplace other than the usual place, the
configure script needs to know the directory in which the tclConfig.sh
file resides.  Set the environment variable TCL_CONFIG_DIR to point to
the directory, or run configure something like this:

$ TCL_CONFIG_DIR="tclConfig.sh directory" ./configure \
        --prefix="cluster source root directory"
$ make

Note that configure can be given the enviromnent variable in the
top-level cluster directory.

FILES

  cluster.so  A shared library of cluster code accessed by the CLI.

ENVIRONMENT VARIABLES

Cluadmin looks for the following variables in the user's environment.

  CLU_PATH, if set, points to the path where the cluster binaries are
  installed.  If not set, defaults to /cluster.

  CLU_LIB_PATH, if set, points to the path where cluster shared
  libraries can be found.  If not set, defaults to /cluster.

BUGS
