Using btadmin

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

This section describes the following:

Using btadmin on UNIX

The btadmin utility on UNIX is a shell script invoked from the <CC_install_directory>/ directory. If you are running 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 describes each of these options.

[start | stop | restart <daemon>]

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

Daemon

Description

ccmgr
Application manager daemon.

dfp
Cisco LocalDirector's Dynamic Feedback Protocol daemon.

failover
The failover daemon.

ipaliasd
The ClusterCATS failover daemon.

ns-httpd
The HTTP daemon.

wsprobe
Web server probe daemon.

Daemon	Description
ccmgr	Application manager daemon.
dfp	Cisco LocalDirector's Dynamic Feedback Protocol daemon.
failover	The failover daemon.
ipaliasd	The ClusterCATS failover daemon.
ns-httpd	The HTTP daemon.
wsprobe	Web server probe daemon.

Note

Stopping and starting some daemons may 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 the 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 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 your cluster configuration settings on the current server. For more information on the effects of resetting a cluster member, refer to "Resetting Cluster Members".

[help]

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

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 all virtual directories.

btadmin +f
Adds the ClusterCATS filter to your Web server.

btadmin -b
Stops all ClusterCATS services.

btadmin +b
Starts all ClusterCATS services.

btadmin +m
Reconfigures all ClusterCATS services to Manual start mode.

btadmin -m
Reconfigures all ClusterCATS services to Automatic start mode.

btadmin -r
Removes all 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 all ClusterCATS services. For more information on using Maintenance mode, refer to "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 all virtual directories.
btadmin +f	Adds the ClusterCATS filter to your Web server.
btadmin -b	Stops all ClusterCATS services.
btadmin +b	Starts all ClusterCATS services.
btadmin +m	Reconfigures all ClusterCATS services to Manual start mode.
btadmin -m	Reconfigures all ClusterCATS services to Automatic start mode.
btadmin -r	Removes all 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 all ClusterCATS services. For more information on using Maintenance mode, refer to "Using Maintenance Mode (Windows only)".

btadmin can be invoked with more than one options. For example to stop and restart ClusterCATS services enter btadmin -b +b.

Advanced ColdFusion Administration
ClusterCATS Utilities