DFdisable.rpc — Disable a study database server or incoming fax daemon to make them unavailable to clients and incoming faxes
DFdisable.rpc
{
[-s #]
| [-i #]
}
[-f]
[-w #]
[-r string]
{key}
The study database server must be disabled when a user requires "off-line" access to the database and wishes to ensure that no client connections to the server are permitted.
Equivalent functionality can be obtained using the dialog in DFadmin.
A disable request will fail if there are other users with client tools connected to the study server at the time of the request.
When -i is used to disable an incoming daemon, the daemon is
allowed
to complete any fax processing that it might be engaged in, but as soon as this
is completed and the daemon exits, it will not be allowed to process another
incoming fax.
Following execution of DFdisable.rpc, a study server or incoming fax daemon can be re-enabled using DFenable.rpc. The command must be executed by the user who executed DFdisable.rpc, and the same key must be provided.
When a study server is disabled, the default requirement is that the server
shutdown as quickly as possible. In the interest of efficiency, it removes
only those index entries that are for obsolete records and sorts only those
index files that are unsorted.
This is sufficient for correct operation of the
server. However, the server does not remove those indices or records that are
marked for deletion nor does it perform garbage collection on data records that
are obsolete. The result is that it is subsequently possible to export a record
that is still scheduled for deletion. This may be undesirable for archival
purposes.
Use of -f will force the server to remove all records
marked for deletion and perform garbage collection of obsolete data records.
This option is primarily useful when shutting down a database in preparation
for archiving.
-s | the study number or the incoming daemon number of the server to be disabled |
-f | force clean-up of database. This results in a complete garbage clean-up by the server of the database. Usage of this flag will slow down the execution time of DFdisable.rpc and is not required for proper server operation. |
-w | an optional number of seconds for the command to delay while waiting for the server to shutdown. The default is 60 and the legal range is 10 to 1000. Very large databases may not shutdown in 60 seconds and so should delay longer. |
-r string | an optional reason string indicating why the study server is being disabled. This reason will appear in the error log file whenever a user attempts to connect to the server while it is disabled. |
key | a required string, which must be subsequently provided by the same user from the same machine when executing to enable the server again. The key must be the last argument on the command line. |
DFdisable.rpc exits with one of the following statuses:
0 | The command was successful. |
1 | The command failed because the required command-line arguments were not present or were incorrectly specified. |
> 1 | The command failed because the database server could not be contacted, communication with the database server failed, or the database server has already been disabled. |