Lotus Domino Administration in a Nutshell By Greg Neilson
1st Edition August 2000 1-56592-717-6, Order Number: 7176 384 pages, $24.95
Chapter 13
Domino Server Tasks and Console Commands
In this chapter, I discuss how to specify which component tasks Domino loads at startup and how to configure Domino to run scheduled maintenance tasks. This type of configuration is usually done once as the server is commissioned, with occasional changes as needed.
There is also a set of commands that you can issue at the Domino server console to dynamically control the operation of the server. These commands are typically used to diagnose and resolve issues with Domino operations, make dynamic configuration changes to the Domino server, or to override scheduled operations and make things such as mail routing or database replication happen immediately.
Domino Server Tasks
A few lines in NOTES.INI define which server tasks are started when the server starts up, and also which scheduled tasks are to run at various times during the day.
The ServerTasks= line lists the tasks to start as the server starts up. The scheduled tasks are listed in the ServerTasksAt0= to ServerTasksAt23= lines. These specifications use the 24-hour clock, where 0 is midnight and 23 is 11:00 P.M.
Another option for scheduling tasks is the Program document in the Domino Directory. The Program document is described in Chapter 2, Domino Directories.
By default, the following tasks are configured to start, depending on how the server has been configured:
When the Quick and Easy Configuration setup option is selected, the tasks set to start at startup are Router, Replica, Update, AMgr, AdminP, CalConn, Event, Sched , Stats, and Maps. Then other tasks are added depending on which other client audience options are selected:
Web Browsers adds HTTP and DIIOP
Internet Mail Packages adds IMAP and POP3
News Readers adds NNTP
Enterprise Connection Services adds DECs
When the Advanced Configuration setup option is selected, the tasks set to start at startup are AdminP, AMgr, Update, Replica, Router, and Maps. Other tasks, such as CalConn, Event, Sched, and Stat, are optionally added if selected. Other tasks are added if they are selected by name. These are:
HTTP, DIIOP
IMAP, POP3
LDAP
NNTP
DECS
When the server has been upgraded from 4.x, you are not required to run the setup application after the code has been installed. This means that the original list of startup tasks is retained. Because the Reports task no longer exists in R5 and has been replaced by the Collect task, you must remove it. You also must remove the SMTPMTA statement, since this function has been added to the Router process.
Then, for the scheduled tasks in NOTES.INI, these entries are added as part of the original installation:
ServerTasksAt1=Catalog,Design
ServerTasksAt2=UpdAll,Object Collect mailobj.nsf
ServerTasksAt3=Object Info -Full
ServerTasksAt5=Statlog
You should also be aware that after you reinstall or upgrade your Domino server code, these entries are usually added again to NOTES.INI, if they had been removed.
Here is a list of all of the Domino server tasks, their functions, and the specific console commands they accept:
AdminP
The Administration Process automates many administration tasks. This task has the following commands available to modify its behavior while it is running:
tell adminp process all
Instructs the admin process to process all new and modified immediate/interval/daily/delayed requests.
tell adminp process daily
Instructs the admin process to process all new and modified daily requests.
tell adminp process delayed
Instructs the admin process to process all new and modified delayed requests.
tell adminp process interval
Instructs the admin process to process all immediate and interval requests.
tell adminp process new
Instructs the admin process to process all new requests.
tell adminp process people
Instructs the admin process to process all new and modified requests to update Person records within the Domino Directory.
tell adminp process time
Instructs the admin process to process all new and modified requests to delete mail files that become unlinked.
tell adminp show databases
Lists the databases that an administration server manages, and also lists databases that do not have an administration server configured.
AMgr
The Agent Manager runs scheduled and triggered agents in Domino databases. This task has the following commands available to modify its behavior while it is running:
tell amgr pause
Pauses the agent manager service, so no new agents can be scheduled for execution on the server.
tell amgr resume
Resumes the agent manager service, so new agents can be scheduled for execution on the server.
tell amgr schedule
Displays the scheduled agents that are to run today, and also the database in which they reside.
tell amgr status
Displays the status of the agent manager, and also configuration information of the agent manager from the server document in the Domino Directory.
Billing
Collects the configured usage information for billing.
Calconn (Calendar Connector)
Used to request free/busy time information for users whose mail databases reside on other servers.
Catalog
Maintains the Domain Catalog, which helps users to find and locate Domino databases and files of interest to them within the Domino domain.
Chronos
Performs updates of database full text indexes for databases that are configured to be updated hourly or daily. This task is autostarted by Domino and does not need to be added to NOTES.INI in order to run. You can cause this task to run immediately by issuing the commands load chronos daily or load chronos hourly.
Cladmin (Cluster Administration Process)
Ensures correct operation of the Domino application-level cluster.
Cldbdir (Cluster Database Directory Manager)
Maintains the cluster database directory.
Clrepl (Cluster Replicator)
Replicates between servers in a cluster in real time. Cluster replication is event-driven, whereas standard replication is schedule-driven. This task has the following commands available to modify its behavior while it is running:
tell clrepl log
Instructs the cluster replication tasks to immediately log information into the server log database, rather than wait for the defined log interval. Use this command when cluster replication is encountering problems--you can view the log entries for the errors and ensure that the problem is resolved before the next cluster replication attempt.
Collect
Collects server activity statistics from one or more servers. This task has the following command available to modify its behavior while it is running:
tell collector collect
Runs the Domino server statistic collection on every server specified and creates statistic reports.
Compact (Database Compaction)
Reorganizes the disk usage by each database in order to free up unused space. The Compact task can be invoked with the following commands (the various options can be combined as needed):
load compact [database]
Compacts the database or specified subdirectory.
load compact [database] -S X
Compacts databases with greater than X % free space.
load compact [database] -D
Compacts databases and deletes any built view indexes.
load compact [database] -R
Compacts databases and changes the ODS version to R4 from R5. Used when backing out of an upgrade from R4 to R5.
load compact [database] -M
For R4 databases, sets a maximum size of 4GB and compacts the database.
load compact [database] -b
Compacts databases in place. Can be used only if the database internal format is not being changed due to a change in one if the advanced database properties. It recovers unused space within the database, but does not reduce the file size of the database.
load compact [database] -B
Compacts databases in place. It recovers unused space within the database, and does reduce the file size of the database.
load compact [database] -c
Uses copy-style compaction of the database, rather than in-place compaction.
load compact [database] -L
When using copy-style compaction, allows access to the database while the compaction is in process. Compaction ends for the database if a user accesses the database.
load compact [database] -i
When using copy-style compaction, ignores any errors that occur during compaction.
load compact [database] -f
Compacts the database and changes the format of the database to disable support for document table bitmap optimization.
load compact [database] -F
Compacts the database and changes the format of the database to enable support for document table bitmap optimization.
load compact [database] -H
Compacts the database and changes the format of the database to enable support for maintenance of the specialized response hierarchy used by the @AllChildren and @AllDesendants view selection formulae.
load compact [database] -h
Compacts the database and changes the format of the database to disable support for maintenance of the specialized response hierarchy used by the @AllChildren and @AllDesendants view selection formulae.
load compact [database] -T
Compacts the database and changes the format of the database to enable transactional logging.
load compact [database] -t
Compacts the database and changes the format of the database to disable transactional logging.
load compact [database] -U
Compacts the database and changes the format of the database to maintain unread marks.
load compact [database] -u
Compacts the database and changes the format of the database to disable maintaining unread marks.
load compact [database] -A
Doesn't compact the database; archives documents to another database, and then deletes those documents from this database if archiving is set up for the database.
load compact [database] -a
If archiving is set up for the database, archives documents to another database and then deletes these documents from this database and compacts the database.
Convert
Used to update the mail databases to a new mail template design, typically used when upgrading the server to from R4 to R5. The Convert task can be invoked with the following commands:
load convert [-r] mailfilepath currenttemplatename newtemplatename
Converts the mail databases in the given mailfilepath from the currenttemplatename (* can be used to match all existing templates) to the newtemplatename. The new mail template for R5 is called MAIL50.NTF. The -r option is used to recursively process subdirectories below the given mailfilepath.
load convert -l mailfilelist
Produces a list of primary mail databases (but not replicas) on the server and writes the list to the file specified in mailfilelist. This option is used to produce a list of mail database files, which would be used with the -f option as shown in the next entry.
load convert -f mailfilelist currenttemplatename newtemplatename
Updates the mail databases listed in the mailfilelist from the currenttemplatename (* can be used to match all previous templates) to the newtemplatename. The new template in R5 is called MAIL50.NTF.
load convert -m mailfilepath
Changes the mail databases specified within the mailfilepath to able be used for IMAP mail access.
DECS (Domino Enterprise Connection Services)
Enables hot linking between documents within a Domino database and backend data sources such as DB2 or Oracle.
Design
Updates database designs from their template.
DIIOP
An object request broker; allows browser clients running Java applets to access backend Notes database objects via the IIOP protocol. This task has the following commands available to modify its behavior while it is running:
tell diiop show users
Shows all active users connected to the server by DIIOP.
tell diiop drop all
Drops all user connections using DIIOP immediately.
Dircat
Maintains small copies of the Domino Directory called the Directory Catalog, which can be used for user lookup for mobile/laptop users. This task is usually not started via an entry in NOTES.INI; when you enable a schedule on the Directory Cataloger tab in the Server Document this task is launched automatically.
Event (Event Monitor)
Tracks of specific events that have occurred on the Domino server
Fixup
Fixes suspected corrupt Domino databases. These options can be combined as needed:
load fixup [database] -F
When fixup runs against multiple databases, by default it checks only documents with the last modified date since its last run. This parameter then forces the fixup task to check all documents in all databases being checked.
load fixup [database] -i
Checks only new documents in the database since the last run of fixup.
load fixup [database] -J
Runs fixup against databases that have transaction logging enabled. If this parameter isn't used, fixup doesn't check these databases.
load fixup -L
When used without specifying the database to check, logs every database suspected of being corrupted. The default is to log only when a database problem is found and needs to be corrected.
load fixup [database] -N
Changes the way that fixup operates when a corrupted document within a database is encountered. When this parameter is specified, any corrupted documents found are not deleted. A typical use of this is to allow documents to be copied to another database before fixup deletes them in an effort to retrieve documents from a corrupted database.
load fixup [database] -Q
Instructs fixup to be less thorough in its checking for corrupted documents in the database.
load fixup [database] -U
Changes unread document lists to the older R4 format. (Lotus recommends that you do this only when requested by Lotus Support.)
load fixup [database] -V
Specifies to not check views for corruption.
HTTP (Domino web server)
Serves regular HTML/CGI and converts Domino elements into HTML/Java applets as required. This task has the following commands available to modify its behavior while it is running:
tell http restart
Refreshes the configuration for the HTTP task without having to unload and reload the task into the server memory.
tell http show file access
Shows filesystem access on the server for HTTP clients.
tell http show security
Displays SSL configuration information for the web server.
tell http show users
Shows the current list of session-based users that are connected and authenticated to Domino.
tell http show virtual servers
Displays the configured virtual web servers defined on the Domino server.
ICM (Internet Cluster Manager)
Manages access to clustered servers for HTTP (web) clients.
IMAP
Facilitates access to Domino mail databases by IMAP clients.
LDAP
Facilitates access to the Domino Directory by LDAP clients. This task has the following commands available to modify its behavior while it is running:
tell ldap reloadschema
Updates the schema for LDAP to reflect customizations made to the Domino Directory.
tell ldap exportschema
Creates or updates the schema database (SCHEMA50.NSF) to reflect schema changes in the Domino Directory.
Maps
Extracts information from Connection documents to produce the graphical replication and routing information in Domino Administrator.
MTC (Message Tracking Collector)
Monitors the work of the Router process (which delivers mail in Domino) and keeps records as required as to what mail was sent to whom. This allows users and administrators to query mail status. This task does not need to be explicitly started; if mail tracking is enabled on the server by a Configuration document, then Domino will start this task automatically as the Router task is started.
tell mtc process
Collects information now for message tracking, rather than waiting for the message tracking interval.
tell mtc interval value
Changes the collection interval used for message tracking information by the MTC task.
tell mtc compact
Compacts the message tracking store database now.
tell mtc reindex
Reindexes the message tracking store database now.
tell mtc purge value
Purges collected message tracking information older than value days from the message tracking database now.
NNTP
Enables the Domino server to be used as a newsgroup server. This task has the following commands available to modify its behavior while it is running:
tell nntp newgroup newsgroupname
Creates a new newsgroup called newsgroupname.
tell nntp newgroup delete groupname1, groupname2
Deletes the specified newsgroups.
tell nntp newgroup newsgroupname pathname
Tells the NNTP task to add a new newsgroup to its cache using the specified database.
tell nntp print cache list
Displays the current newsgroups and their corresponding databases.
tell nntp print config
Shows the configuration information for the NNTP server.
tell nntp reset servername
Resets the newsfeed from the specified server, so the next newsfeed will be considered an initial newsfeed.
tell nntp show config
Shows the configuration information for the NNTP server.
tell nttp show groups
Shows the currently configured newsgroups on the server, and the path of each relative to the data directory on the server.
Object (Object Store Manager)
Works with single-object store mail databases, if enabled. The Object task can be invoked as follows:
load object create sharedmaildb.nsf
Creates a new shared mail database with the name sharedmaildb.nsf.
load object link usermaildb.nsf sharedmaildb.nsf
Links messages already present within sharedmaildb.nsf into the shared mail database.
load object link -nocompact usermaildb.nsf sharedmaildb.nsf
Links messages already present within sharedmaildb.nsf into the shared mail database. The -nocompact option means that usermaildb.nsf is not compacted (which reclaims unused space in databases) even if there are more than five messages linked into sharedmaildb.nsf.
load object link -relink usermaildb.nsf sharedmaildb.nsf
Links a user's mail database to a different sharedmaildb.nsf.
load object unlink usermaildb.nsf
Unlinks messages for the given usermaildb.nsf.
load object unlink sharedmaildb.nsf
Unlinks messages for the given sharedmaildb.nsf.
load object set -never usermaildb.nsf
Sets usermaildb.nsf to never use shared mail.
load object reset -never usermaildb.nsf
Removes the setting to never use shared mail for usernmildb.nsf.
load object set -always usermaildb.nsf sharedmaildb.nsf
Ensures all replicas of the usermaildb.nsf use the shared mail database sharedmaildb.nsf.
load object reset -always usermaildb.nsf
Removes the setting that makes sure all replicas of usermaildb.nsf use the shared mail database.
load object collect -nodelete
Checks which old messages are ready to be deleted, but does not actually delete them.
load object collect usermaildb.nsf
Deletes obsolete messages from the usermaildb.nsf.
load object collect sharedmaildb.nsf
Deletes obsolete messages from the sharedmaildb.nsf.
load object collect -force sharedmaildb.nsf
The -force option is used after a user mail database has been deleted, and you wish to reclaim the space used for linked messages in sharedmaildb.nsf that were referred to only from that user mail database.
load object info usermaildb.nsf
Checks whether the usermaildb.nsf contains any messages that use a shared mail database.
POP3
Facilitates access to Domino mail databases by POP3 clients.
Replica
Allows Domino servers to replicate database updates with each other.
Router
Delivers mail to databases on this server and forwards it to other servers as required. This task has the following commands available to modify its behavior while it is running:
tell router delivery stats
Shows the current mail routing delivery statistics.
tell router compact
Shuts down the mail routing process on the server, and compacts the MAIL.BOX database. If more than one MAIL.BOX is on the server (for example, MAIL1.BOX and MAIL2.BOX if the server is configured to have two), each of these databases is compacted in turn. When the compaction activity is complete, the router process is resumed.
tell router show queues
Shows the current number of waiting mail items in the queues for each destination mail server.
tell router use databasename
Enables the use of shared mail on this server. It also changes the value of SHARED_MAIL to 2 in NOTES.INI. databasename is the name of the database used for the shared mail database, and a new database link called MAILOBJ.NSF is created in the server data directory, which points to databasename.
RunJava ISpy
Allows us to configure probes between servers to periodically check that servers can be accessed to send mail or that they can communicate via a TCP port. Note that this task name is case-sensitive--it must be specified in this way (with an uppercase IS and lowercase py)--otherwise, the Java VM within Domino will not be able to find the appropriate Java classes to load.
Sched (Schedule Manager)
Tracks free/busy time for all who have their mail database on that server. This task has the following commands available to modify its behavior while it is running:
tell sched stats
Displays the number of user appointments and resources reservations in the free time database.
tell sched show username
Displays when username is busy according to the schedule in that given user's mail database.
tell sched validate
For every mail user on the server, checks whether free/busy time is recorded in the free time database.
tell sched validate username
For username, checks whether free/busy time is recorded in the free time database.
SMTP
Listens for incoming SMTP mail. Usually you need not configure this task to start; it is started automatically once the SMTP Listener task is enabled on the Server document within the Domino Directory.
Statlog
Records database usage information into the Domino Log file, LOG.NSF.
Stats
Produces statistics for a Domino server.
Updall (Indexer)
Maintains changed views and full text indices as the data changes within the Domino database.
load updall [database] -A
Performs an incremental update of an R4 site search database.
load updall [database] -B
Performs a full update of an R4 site search database.
load updall database -C
Rebuilds the full text indexes and any unused views in the database.
load updall [database] -F
Updates full text indexes but not views.
load updall [database] -H
Updates full text indexes that are configured to be updated immediately.
load updall [database] -L
Updates full text indexes that are configured to be updated immediately, hourly, or daily.
load updall [database] -M
Updates full text indexes that are configured to be updated immediately or hourly.
load updall [database] -R
Rebuilds all full text indexes and all views in the database.
load updall database -T view
Rebuilds the out-of-date view in the database.
load updall database -T view -R
Rebuilds the view in the database whether or not it is out of date.
load updall [database] -V
Updates view but not full text indexes.
load updall [database] -X
Displays the number of user appointments and resource reservations in the free time database.
Web
Converts HTML web pages into Notes documents for retrieval by Notes clients. This task has the following commands available to modify its behavior while it is running:
tell web help
Lists the available options for the web task: tell web quit, load web, tell web help, and tell web refresh.
tell web refresh
Refreshes the web navigator task settings while the task is running.
Domino Server Console
The Domino server console is a DOS-like window on NT and OS/2 servers in which you can view server messages and enter commands. For those platforms, switch to this open window to access it at the server. On the AS/400 platform, issue the command WRKDOMCSL servername (work with Domino Console) to access the Domino console. On the OS/390 platform, you have the option to use telnet or the OS/390 operator console with the as-is DOMCON package, which is downloadable from
http://www.s390.ibm.com/products/domino/domcon/dmcnmain.html. On the Unix platforms (AIX, HP/UX, Linux, and Solaris), there is a new character console in R5 that can be used to access the server console. This function works only on the Domino server itself, so to do this remotely requires telnet access to the server. Also, you have to be listed as an Administrator for that server within the Domino Directory. The steps to use this function in Unix are:
Change to the data directory for the server (cd ~/notes/data).
Execute the cconsole program (/opt/bin/cconsole).
Enter the location of your ID file, then enter your password.
There are three special commands available on the Unix platforms to work with this character console:
done
Exits the console program.
live on
Turns on live update of server messages on the console.
live off
Turns off live update of server messages on the console. You might do this so that commands you enter and any responses made by Domino are not lost in a sea of updated messages issued by the running server.
These console commands on all platforms are also logged in the LOG.NSF database on the server. So if the output messages from the commands you enter get scrolled off the screen because of other messages from the server, you can open the Miscellaneous Events view of this database to review the output messages. The documents in this view are listed in chronological order, with the most recent log messages therefore at the bottom of the view (see Figure 13-1).
Figure 13-1. Viewing old console messages in the server's log database (LOG.NSF)
As discussed in Chapter 6, Domino Administration Tools, Domino Administrator has an option on the Server tab to access the console of the current server being administered. You are more likely to use this in day-to-day operations than you are to use the server itself. Another advantage of using this mode of operation is that the Domino Administrator client has a built-in list of server commands, which means that you don't need to always work from memory on the command names and their correct syntax (see Figure 13-2).
Figure 13-2. Accessing the server console via the Domino Administrator client
The Domino server console supports redirection for both input and output with the > and < operators. You can create a text file of server commands, then issue the name of the file on the server console to run the command listed in this batch file of server commands. The default location of this file is \LOTUS\DOMINO, so if another location is specified, then the fully qualified filename of this file must be entered at the server console. A use for this could be when you wish to push changes now from a hub server to all the spoke servers in the company, rather than wait until the replication schedule. You could have a text file on the hub server that contains a series of PUSH commands to each server, and run this just by typing the name of this command file.
You can also redirect the console output into a file. If you use Domino Administrator, you can see that under the hood, this is how it gets some of the server information about task and user status. Figure 13-3 shows examples of both types of command redirection (the meaning of the actual commands listed will be explained later in this chapter).
Figure 13-3. Redirection of input and output with the Domino server console
The basic commands are listed here, and then each is described in further detail:
broadcast
Sends a broadcast message to specified users or to all users.
dbcache
Displays, disables, or flushes the Domino database cache.
drop
Drops the server sessions for specified users or all users.
exit
Stops the Domino server.
help
Lists all Domino servers available.
load
Starts a task on the server.
platform
Works with the collection of operating system statistics by Domino.
pull
Starts replication now from the specified server.
push
Starts replication now to the specified server.
quit
Stops the Domino server.
replicate
Starts replication now from/to the specified server.
restart
Stops and restarts the Domino server or the specified communication port.
route
Starts mail routing with the specified server.
set
Makes changes to the Domino server configuration.
show
Displays information about the Domino server.
start port
Enables the given Domino port for network connections.
stop port
Disables the given Domino port for network connections.
tell
Issues a command to a Domino server task.
trace
Tests the connection to another server.
broadcast (b)
This is a broadcast message from the server console to either nominated users or to all connected users to the server. This message is displayed in the status bar of the Notes client with no warning sound, so it can be very easy to for users to miss the message.
Syntax
broadcast message
broadcast message users
Command options
message
The message you wish to send. For messages containing spaces, enclose the entire message in quotation marks to ensure that it is processed as the message content.
users
Defines which users receive the message. If this parameter is not specified, the command applies to all connected users. If a name is a specified, it should be enclosed in quotes.
Examples
> b "Please close all open Domino databases for scheduled maintenance"
07/11/99 09:16:06 PM BROADCAST from shoreline/Alameda: Please close all open Domino databases forscheduled maintenance
> b "Please call the help desk on xtn5555" "Greg Neilson/Alameda"
07/11/99 09:16:41 PM BROADCAST from shoreline/Alameda: Please call the help desk on xtn5555 [GregNeilson/Alameda]
dbcache
Domino uses the database cache to keep open the most recently used databases for performance reasons. However, sometimes you may need to work with one of the databases within the cache (perhaps to restore from backup). You can use these commands to view the contents of the database cache, disable the use of the cache, and flush out the contents of the database cache.
Syntax
dbcache show
dbcache disable
dbcache flush
Command options
show
Displays the current opened databases in the database cache.
disable
Disables the server from using the database cache.
flush
Flushes out the open databases that were in the database cache.
Examples
This is the output from a dbcache show command to display which databases are currently open in the cache:
> dbcache show
Database Cache is limited to 121 entries
Database
C:\Lotus\Domino\Data\mtdata\mtstore.nsf
C:\Lotus\Domino\Data\admin4.nsf
C:\Lotus\Domino\Data\mail\sneilson.nsf
drop (dr)
This command can be used to close user sessions either for all users or for the nominated users. Typically you would use this command only in preparation for an unscheduled shutdown of the Domino server.
Syntax
drop all
drop username
Command options
all
Drops all user sessions from the server.
username
Drops the nominated user sessions from the server. More than one username can be entered at once, each of which should be enclosed in double quotes.
Examples
This is output from a command to drop all user sessions from the server:
> dr all
07/11/99 09:06:24 PM Closed session for Greg Neilson/Alameda
Databases accessed: 2 Documents read: 2 Documents written: 1
07/11/99 09:06:24 PM Closed session for Greg Neilson/Alameda
Databases accessed: 1 Documents read: 0 Documents written: 0
exit (e)
Closes down the Domino server.
Syntax
exit [password]
Command options
password
If the SET SECURE command has been run to provide a password for operation of the Domino server, then this password needs to be provided in order to shut down the server.
See Also
quit, restart server
help (he)
Displays the list of server commands and their main parameters. Unfortunately, this list is too long for a single screen and quickly scrolls to the end. To use this list, you can either view the console output in the server log database (LOG.NSF) or redirect the server output into a file.
Syntax
help
load (l)
Starts a Domino server task. Three particular tasks, convert, compact, and object, have a number of optional command-line parameters. For the compact task, if a database or subdirectory is not specified, this command applies to all databases on the server. The object task works with the optional shared mail feature, and is further described in Chapter 4, Mail. The convert task is used when upgrading to a new release of the server code--say from R4 to R5--and updates the specified mail databases to use the new design template.
Syntax
load program [options]
Command options
program
See the list of server tasks at the start of this chapter.
platform (pl)
Works with operating system statistic collection on the Windows NT (Intel) and Solaris (Sparc) platforms. You must have the collection of platform statistics enabled (by having the NOTES.INI parameter PLATFORM_STATISTICS_ENABLED=1) to be able to use these commands.
Syntax
platform time [secs]
platform reset
platform run
platform wait
Command options
time [minutes]
When this command is run without a time parameter, it displays the current statistic collection sampling rate. The default is one minute. Otherwise, this sets the statistic collection sampling rate to the value (in minutes) entered.
reset
Issued at the start of a monitoring session, this command resets the statistic counters for the operating system platform.
run
Resumes the collection of platform statistics.
wait
Temporarily pauses the collection of platform statistics.
pull (pul)
Starts database replication from the specified server to the local server. Typically, a Connection document defines the scheduled replication between servers, and this command is used to manually override it.
Syntax
pull server [database]
Command options
server
The name of the remote server you wish to pull database changes from to the local server. The remote server name should be the full hierarchical name, and enclosed in quotes if there any spaces in it.
database
Optionally, the name of the database on the local server into which you wish to pull changes from the server. The database on the other server must be a replica copy (that is, have the same replica ID) in order for replication to occur.
If the database parameter is not listed, then the server prepares a list of databases with identical replica IDs on both servers, and then pulls the changes in each from the other server.
Examples
pul Westline/Alameda pulls changes from the remote server named Westline/Alameda to the local server for all databases having the same replica ID.
pul Shoreline/Alameda names.nsf pulls changes from the remote server named Shoreline/Alameda to the local server for the NAMES.NSF database.
See Also
push, replicate, route
push (pus)
Starts database replication from the local server to the specified server. Typically, a Connection document defines the scheduled replication between servers, and this command is used to manually override it.
Syntax
push server [database]
Command options
server
The name of the remote server you wish to push database changes to from the local server. The server name should be the full hierarchical name, and enclosed in quotes if there any spaces in it.
database
Optionally, the name of the database on the local server out of which you wish to push changes to the remote server. The database on the remote server must be a replica copy (that is, have the same replica ID) in order for replication to occur.
If the database parameter is not listed, the server prepares a list of databases with identical replica IDs on both servers, and then pushes the changes in each to the other server.
Examples
pus Westline/Alameda pushes changes from this local server to the remote server Westline/Alameda for all databases having the same replica ID.
pus Shoreline/Alameda names.nsf pushes changes from the local server to the remote server Shoreline/Alameda for the NAMES.NSF database.
See Also
pull, replicate, route
quit (q)
Closes down the Domino server.
Syntax
quit [password]
Command options
password
If the SET SECURE command has been run to provide a password for operation of the Domino server, this password needs to be provided in order to shut down the server.
See Also
exit, restart server
replicate (rep)
Starts database replication from this server to/from the specified remote server. Typically, a Connection document defines the scheduled replication between servers, and this command is used to manually override it. The process works in two stages: the local server pulls any changes from the remote server, and then the remote server has the option to pull any changes from the local server. The remote server refers to the replication schedule, and performs a pull now only if this manual replication doesn't fall within the timeframe the server replicates to this server.
Syntax
replicate server [database]
Command options
server
The name of the remote server you wish to push/pull database changes to or from. The server name should be the full hierarchical name, and enclosed in quotes if there any spaces in it.
database
An optional parameter specifying which database to replicate. If this parameter is not present, the server attempts to replicate every database that has a common replica ID between the two servers.
Examples
This example replicates the Domino Directory between the two servers with the command rep Westline/Alameda names.nsf:
> rep westline/alameda names.nsf
07/18/99 12:10:43 AM Database Replicator started
07/18/99 12:10:43 AM Starting replication with server westline/alameda
07/18/99 12:10:43 AM Pulling names.nsf from westline/alameda names.nsf
07/18/99 12:10:44 AM Replicator added 1 document(s) to names.nsf from
westline/alameda names.nsf
07/18/99 12:10:44 AM Pushing names.nsf to westline/alameda names.nsf
07/18/99 12:10:44 AM Replicator added 1 document(s) to westline/alameda
names.nsf from names.nsf
07/18/99 12:10:44 AM Replicator updated 6 document(s) in westline/alameda
names.nsf from names.nsf
07/18/99 12:10:44 AM Finished replication with server westline/alameda
07/18/99 12:10:44 AM Database Replicator shutdown
See Also
pull, push, route
restart
Stops or starts the Domino server or one of its network ports.
Syntax
restart server [password]
restart port portname
Command options
server
Performs an orderly shutdown of the server and then restarts it.
Note that this does not work when Domino is configured as a Windows NT/2000 service. In this case, you must stop and start the service to restart the Domino server.
port portname
Specifies which port is to be restarted. The currently enabled ports for Domino are defined in the Ports= line in NOTES.INI. The default ports available to be configured (others can be defined if needed) are TCPIP, LAN0ip, VINES, SPX, Appletalk, LAN1-LAN8 (NetBIOS), and COM1-COM5.
password
If the SET SECURE command has been run to provide a password for operation of the Domino server, this password must be provided in order to shut down the server.
Examples
restart server shuts down and restarts the Domino server.
restart port tcpip stops and restarts the TCP/IP port for Domino network communications.
See Also
exit, quit, start port, stop port, show allports
route (ro)
Starts mail routing with a given server. Typically, a Connection document will define the scheduled mail routing a server, and this command is used to manually override the scheduled mail routing. If there is no mail to route at this server (that is, MAIL.BOX is empty) this command is ignored.
Syntax
route servername
Command options
servername
The name of the server we wish to send mail to, using the hierarchical name format.
Examples
route Westline/Alameda sends any outstanding mail that was destined for that server.
See Also
replicate, push, pull
set (se)
Makes dynamic changes to the Domino server configuration.
Syntax
set configuration variable = value [password]
set secure password
set secure password newpassword
set stat statisticname
Command options
configuration variable = value
This command specifies the variable from NOTES.INI to be changed and its new value to use. As well as making the dynamic change in the Domino, the NOTES.INI file is also updated with this new value. It can also be used to add configuration variables to NOTES.INI.
Note that if the server console has been secured via a SET SECURE command, this password needs to be supplied in order to change this variable.
secure password
Sets a password for the Domino server that must be entered to shut down the server or dynamically change any of the parameters. However, this usage is not entirely foolproof--it adds an entry to NOTES.INI called SERVER_CONSOLE_PASSWORD and stores the password there in a hashed format. This line can be deleted from NOTES.INI to remove the use of the password. So physical security of the server, ensured by placing it in a secured room with limited access, is probably a better idea.
If the same command is run again with the current password, the password is deleted from use.
newpassword
Used to change the password from the previous password to this new value.
stat statisticname
Resets the value of the counter statistic to 0. The statisticname parameter must be provided. You can obtain a complete set of statistics from the output of the show stat console command. However, the vast majority of the server statistics cannot be reset; if you attempt to reset them, the console will return the message "statistic cannot be reset." The only statistics that can be reset are those for the server. These are:
SERVER.BUSYTIMEQUERY.RECEIVEDCOUNT
SERVER.OPENREQUEST.MAXUSERS
SERVER.OPENREQUEST.PREV4CLIENT
SERVER.OPENREQUEST.RESTRICTED
SERVER.OPENREQUEST.V4CLIENT
SERVER.TRANS.TOTAL
Examples
This example resets the SERVER.TRANS.TOTAL statistic:
> set stat Server.Trans.Total
07/17/99 08:29:00 PM SERVER.TRANS.TOTAL was set to zero.
The following example checks the value of the LOG_REPLICATION configuration value, then sets it to 5 (which displays the most information when replicating ), then checks the value again:
> show configuration log_replication
LOG_REPLICATION=1
> set configuration log_replication=5
> show configuration log_replication
LOG_REPLICATION=5
See Also
show configuration
show (sh)
This command has many options available and is used to display information about the Domino server. Note that much of this information is available graphically from the Server tab in Domino Administrator.
Syntax
show allports
show cluster
show configuration setting
show directory [*log | *nolog]
show diskspace [location]
show memory
show performance
show port portname
show schedule
show server
show stat [statisticname]
show tasks
show transactions
show users
Command options
allports
Lists all ports defined on the server as enabled or disabled ports.
cluster
If the server is part of a Domino cluster, displays current information such as the name of the cluster, which servers are defined in the cluster, and their availability state and index (out of 100). This command can be abbreviated as:
SH CL
configuration setting
Displays the current value of a given setting from NOTES.INI. This command can be abbreviated as:
SH CO setting
directory [*log | *nolog]
Lists all files in the server's DATA directory, what database version they are (R4 or R5), whether the database uses transactional logging, and the date and time of the last update. This command can be abbreviated as:
SH DIR
The *log option displays only files that use transactional logging, while the *nolog option displays only files that do not use transactional logging.
diskspace [location]
Shows how much free space is available on the given drive (NT and OS/2) and filesystem (Unix variants). If the drive is unspecified, the default is to use the drive/file system that has the Domino program directory. The disk space is displayed in bytes. This command can be abbreviated as:
SH DIS
memory
The command displays the amount of available memory, which includes the virtual memory allowed. In OS/2, this is the remaining free space on the drive that houses the swap file; in NT, this is the sum of the maximum specified sizes for paging files (assuming there is sufficient free space available on the disk(s)). This command can be abbreviated as:
SH ME
performance
Toggles on or off the display of performance data to the Domino each minute. This display shows the number of transactions per minute and the number of users on the server. This command can be abbreviated as:
SH PE
port portname
Shows communication statistics for that configured port. This command can be abbreviated as:
SH PO portname
schedule [taskname | servername]
Displays the list of currently scheduled tasks and when they are scheduled to run next. If a task name is given, the next time that task is scheduled to run is displayed. For mail routing and replication, if a destination servername is given, then the next time this is scheduled to run is listed.
This uses information from Connection (for mail routing and database replication) and Program documents to determine the scheduled tasks. It does not include those from the ServerTasksAtx = lines in NOTES.INI. This command can be abbreviated as:
SH SC
server
Shows information about the server, including the name, whether transaction logging is enabled, whether shared mail is enabled, whether there is any mail still to be sent somewhere, and some measures of the peak server load since starting. This command can be abbreviated as:
SH SE
stat [statisticname]
If a statistic name is entered, then the current value of that statistic is displayed. Also, a group of statistics can be entered with * as the wildcard character; for example, show stat database.*. If no statistic name is entered, all of the currently defined statistics and their values are listed. In this case, since there are likely to be over 200, values displayed--and perhaps more depending on how many tasks are running on the server at that time--this information will scroll through the console window too quickly to read. In this case, you can either review the output in the server log, or redirect the output to a file setting from NOTES.INI. This command can be abbreviated as:
SH ST [statisticname]
tasks
Lists the currently executing Domino server tasks and their status. This command can be abbreviated as:
SH TA
transactions
Lists statistics of Domino NRPC transaction types performed on the server. For each command, lists the transaction count and the minimum, maximum, total time, and average time to complete the command in milliseconds. This command can be abbreviated as:
SH TR
users
Lists the current user sessions on the server, the databases they have open, and how long since the database was last used. This command can be abbreviated as:
SH US
Examples
Output example from the SHOW SCHEDULE command:
> show schedule
westline/Alameda Replication 07/24/99 08:00:00 AM
westline/Alameda Mail Routing 07/24/99 08:00:00 AM
compact Run Program 07/24/99 11:30:00 PM
Output example from the SHOW TRANSACTION command:
Function Count Min Max Total Average
ILLEGAL 3 0 0 0 0
OPEN_DB 25 0 541 1373 54
GET_SPECIAL_NOTE_ID 2 0 10 10 5
OPEN_NOTE 3 10 30 60 20
CLOSE_DB 20 0 20 20 1
POLL_DEL_SEQNUM 7 0 20 20 2
SERVER_AVAILABLE_LITE 53 0 0 0 0
START_SERVER 65 0 902 2635 40
REGISTER_MONITOR_RQST 3 0 20 20 6
MONITOR_GETEVENTS_RQST 12 0 70 80 6
FINDDESIGN_NOTES 3 0 20 20 6
This is an example of the SHOW CLUSTER command:
> sh cl
Cluster Information
Cluster name: Cluster1, Server name: shoreline/Alameda
Server cluster probe timeout: 1 minute(s)
Server cluster probe count: 72
Server availability threshold: 0
Server availability index: 100 (state: AVAILABLE)
Cluster members (2)...
server: shoreline/Alameda, availability index: 100
server: westline/Alameda, availability index: 100
See Also
set configuration, set statisics
start port
This command enables the network port for communications in Domino.
Syntax
start port portname
Command options
portname
The currently enabled ports for Domino are defined in the Ports= line in NOTES.INI. The default ports that are available to be configured (others can be defined if needed) are TCPIP, LAN0ip, VINES, SPX, Appletalk, LAN1-LAN8 (NetBIOS), and COM1-COM5.
Examples
start port tcpip enables the TCP/IP port to be used for Domino network communications.
See Also
show allports, stop port, restart port
stop port
This command disables the network port for communications in Domino.
Syntax
stop port portname
Command options
portname
The currently enabled ports for Domino are defined in the Ports= line in NOTES.INI. The default ports that are available to be configured (others can be defined if needed) are TCPIP, LAN0ip, VINES, SPX, Appletalk, LAN1-LAN8 (NetBIOS), and COM1-COM5.
Examples
stop port tcpip disables this port from being used for Domino communications.
See Also
show allports, start port, restart port
tell (t)
Used to issue a command to a running Domino server task. Every task responds to the quit command, but some tasks have special options available to control their operation.
Syntax
tell task quit
tell task [options]
Command options
task quit Stops the task.
trace (tr)
Used to test whether a server can successfully connect to another. There is also an option to specify which port to use to test the connection.
Syntax
trace servername
trace portname!!!servername
Command options
servername
The name of the server you wish to test the connection to.
portname
The name of the server communication port you optionally wish to use to connect to the other server.
Examples
Output from a successful invocation of trace servername :
> trace westline/alameda
Determining path to server WESTLINE/ALAMEDA
Enabled Ports: TCPIP
Checking normal priority connection documents only...
Local network connection document found for westline/Alameda
Verifying address 'westline.alameda.com' for WESTLINE/ALAMEDA on TCPIP
Requesting IP Address for westline.alameda.com from DNS
DNS returned address 10.0.0.11 for westline.alameda.com
Connected to server WESTLINE/ALAMEDA
See Also
show allports, start port, stop port, restart port