Using btadmin

btadmin is a scriptable utility installed on each server in a cluster. It provides most of the functionality of the Windows-based ClusterCATS Server Administrator so UNIX and Windows administrators can include calls in automated scripts.

This section describes the following:

Using btadmin on Windows

btadmin is a Windows executable invoked from the command line in the <CC_install_directory>/program directory.

The table below describes each of the options and their syntax for btadmin.

Option

Description

btadmin

Displays btadmin online help.

btadmin -v

Displays the current version of Microsoft's IIS if it is bound to the ClusterCATS Server.

btadmin -f

Removes the ClusterCATS Web server filter and virtual directories.

btadmin +f

Adds the ClusterCATS filter to your web server.

btadmin -b

Stops ClusterCATS services.

btadmin +b

Starts ClusterCATS services.

btadmin +m

Reconfigures ClusterCATS services to manual start mode.

btadmin -m

Reconfigures ClusterCATS services to automatic start mode.

btadmin -r

Removes servers, delete database files and registry keys related to servers

btadmin -s <seconds>

Puts server into maintenance mode after a set delay (in seconds). This shuts down ClusterCATS services. For more information, see "Using maintenance mode (Windows only)".

Option	Description
btadmin	Displays `btadmin` online help.
btadmin -v	Displays the current version of Microsoft's IIS if it is bound to the ClusterCATS Server.
btadmin -f	Removes the ClusterCATS Web server filter and virtual directories.
btadmin +f	Adds the ClusterCATS filter to your web server.
btadmin -b	Stops ClusterCATS services.
btadmin +b	Starts ClusterCATS services.
btadmin +m	Reconfigures ClusterCATS services to manual start mode.
btadmin -m	Reconfigures ClusterCATS services to automatic start mode.
btadmin -r	Removes servers, delete database files and registry keys related to servers
btadmin -s <seconds>	Puts server into maintenance mode after a set delay (in seconds). This shuts down ClusterCATS services. For more information, see "Using maintenance mode (Windows only)".

You can invoke btadmin with more than one option. For example, to stop and restart ClusterCATS services, enter btadmin -b +b.

Using btadmin on UNIX

The btadmin utility on UNIX is a shell script invoked from the <CC_install_directory>/ directory. If you run btadmin on Red Hat Linux, the ksh shell must be installed.

The syntax for btadmin is:

btadmin [start | stop | restart <daemon>]

btadmin [enable | disable | add | delete | config <option><instance>] 
btadmin [show | reset | help]

The following sections describe each of these options.

[start | stop | restart <daemon>]

You can start, stop and restart the following daemons with btadmin:

Daemon

Description

appmgr

Application manager daemon.

dfp

Cisco LocalDirector's Dynamic Feedback Protocol daemon.

failover

Failover daemon.

ipaliasd

ClusterCATS failover daemon.

ns-httpd

HTTP daemon.

reqmgr

Solaris-only authentication daemon.

teserver

ClusterCATS Server process on Apache. This option is an alias for teserver_apache.

On NES, the ClusterCATS Server is run in the context of the web server.

wsprobe

Web server probe daemon.

Daemon	Description
appmgr	Application manager daemon.
dfp	Cisco LocalDirector's Dynamic Feedback Protocol daemon.
failover	Failover daemon.
ipaliasd	ClusterCATS failover daemon.
ns-httpd	HTTP daemon.
reqmgr	Solaris-only authentication daemon.
teserver	ClusterCATS Server process on Apache. This option is an alias for `teserver_apache`. On NES, the ClusterCATS Server is run in the context of the web server.
wsprobe	Web server probe daemon.

Note: Stopping and starting some daemons can result in multiple daemons being stopped or started.

Following are examples of how you start and stop daemons with the btadmin utility:

btadmin start appmgr
btadmin stop failover
btadmin restart ns-httpd

[enable | disable | add | delete | config <option> _ <Web_server_instance>]

The following table describes the btadmin options for changing ClusterCATS settings:

Option

Description

enable

Enable the specified option for a web server instance.

disable

Disable the specified option for a web server instance.

add

Add a new web server instance.

delete

Delete an existing web server instance.

config

Configure a specified option for an instance. btadmin prompts you for additional information when using the config option.

Option	Description
enable	Enable the specified option for a web server instance.
disable	Disable the specified option for a web server instance.
add	Add a new web server instance.
delete	Delete an existing web server instance.
config	Configure a specified option for an instance. `btadmin` prompts you for additional information when using the `config` option.

For Netscape web servers, enter the web server instance as https-<server>. For Apache web servers, enter https-<hostname>.

You can enable, disable, and configure the following ClusterCATS options using the btadmin utility:

Option

Description

btcats

Configures the ClusterCATS Server.

dfp

Configures Cisco LocalDirector's Dynamic Feedback Protocol.

failover

Configures the ClusterCATS failover (ipaliasd) support.

load

Configures the load-balancing preferences.

wsroot

Configures a web server root directory in case you upgrade your installation or move the root directory.

wsprobe

Configures the web server probes.

Option	Description
btcats	Configures the ClusterCATS Server.
dfp	Configures Cisco LocalDirector's Dynamic Feedback Protocol.
failover	Configures the ClusterCATS failover (ipaliasd) support.
load	Configures the load-balancing preferences.
wsroot	Configures a web server root directory in case you upgrade your installation or move the root directory.
wsprobe	Configures the web server probes.

The following examples show how to use the btadmin utility:

btadmin add https-myserver

btadmin enable btcats https-myserver
btadmin disable failover https-myserver
btadmin config load https-myserver

[show]

Use the show option to display the currently enabled ClusterCATS configuration settings.

[reset]

Use the reset option to reinitialize cluster configuration settings on the current server. For more information, see "Resetting cluster members".

[help]

Use the help option to get a list of the btadmin utility's features and syntax.

Using ClusterCATS
ClusterCATS Utilities