NAME

tkadmin stop server - stops a Toolkit server

SYNOPSIS

tkadmin stop server -server servername [-delay seconds] [-exitcode exitcode] [-force]

ARGUMENTS

-server servername Specifies the server affected by the command. The server name is the name that is registered with the DCE Directory Service. If the server name is not specified in the command line, it is retrieved from an environment variable, ENCINA_TK_SERVER. 

[-delay seconds] Specifies the time delay (in seconds) before the specified server is stopped. The default is 5 seconds. 

[-exitcode exitcode] Specifies the exit code or status with which the server should exit. The default is 0. 

[-force] Forces the termination of a server regardless of its state of operation. Using this option, an actively operating server (one that is processing active transactions) can be terminated without executing an exit method (application-specific termination logic) if one is defined. 

DESCRIPTION

The tkadmin stop server command terminates the operation of a Toolkit server. The -force option causes the forced termination of an actively operating server, without executing an exit method (application-specific termination logic) if one is defined. 

The -delay option can be used to offset the shutdown of servers. Note that the default delay is minimal (5 seconds), just enough time to allow the server to respond (report result) to the client administration program. To force an immediate termination, the -delay option can be used to specify a 0 second delay. In this case, however, the server does not have time to reply to the client administration program. Consequently, you may see an RPC communication failure as a result. Typically, this is not an error in stopping the server as intended. The -exitcode option can be used to specify a particular exit code to indicate the status of the shutdown. 

EXAMPLES

In the following example, the server /.:/branch1/server/sfs1 is forced to stop immediately:

% tkadmin stop server -server /.:/branch1/server/sfs1 -force

PRIVILEGE REQUIRED

Encina Monitor administer (a) permission to the server

Encina RQS administer (a) permission to the RQS server

Encina SFS administer (A) permission to the SFS server
 

  —  March 1997