Home
Administering
This documentation provides information about the administration tools for managing and monitoring servers and databases.
Administration tools
Topics in this section describe the tools you can use to administer a Domino® server.
Domino® server commands
This section describes the Domino® server commands that are available, as well as methods of issuing those commands.
List of server commands and syntax
This list briefly describes the Domino® server commands that are available.
Trace
Tests a connection to a server.

Administering
This documentation provides information about the administration tools for managing and monitoring servers and databases.
- Administration tools
  Topics in this section describe the tools you can use to administer a Domino® server.
  - The Domino® Administrator
    The Domino® Administrator is the administration client for Notes® and Domino. You can use the Domino Administrator to perform most administration tasks.
  - The Server Controller and the Domino® Console
    The Server Controller is a Java-based program that controls a Domino® server. Starting the Server Controller starts the Domino server it controls. When a server runs under a Server Controller, you can send operating system commands, Controller commands, and Domino server commands to the Server Controller.
  - The Administration Process
    The Administration Process is a program that automates many routine administrative tasks.
  - Domino® server commands
    This section describes the Domino® server commands that are available, as well as methods of issuing those commands.
    - List of server commands and syntax
      This list briefly describes the Domino® server commands that are available.
      - Broadcast
        Sends a message to specified users, to users of a specified database, or to all users of a specified server.
      - Dbcache Disable
        Disables the database cache when you need exclusive access to a file in it.
      - Dbcache Flush
        Closes all databases that are currently open in the database cache.
      - Dbcache Show
        Displays the names of the databases currently in the cache.
      - Drop
        Closes one or more Domino® server sessions.
      - Exit
        Use this command to stop the server. This command is identical to Quit.
      - Help
        Displays a list of server commands with a brief description, arguments (if any), and the proper syntax for each.
      - Keymgmt Create
        Creates a named encryption key in the server ID file; creates a credential store assigned a named encryption key that is used to encrypt documents; creates a shared key in a credential store to use to encrypt DAOS objects on multiple servers; or creates a Domain Keys Identified Mail (DKIM) key
      - Keymgmt Delete
        Deletes a named encryption key from the server ID file.
      - Keymgmt Export
        Exports the content of a credential store, shared keys from a credential store, named encryption key from a server ID file, all Domain Keys Identified Mail (DKIM) documents, or a DKIM key.
      - Keymgmt Import
        Imports the content of a credential store into another credential store, imports a named encryption key into a server ID file, or imports a shared encryption key used for DAOS object encryption previously exported from one credential store into another credential store. Performed after keymgmt export.
      - Keymgmt Show
        Shows a specific named encryption key or all named encryption keys in the server ID file, shows a shared encryption key or all shared encryption keys in a credential store, or shows one DKIM key or all DKIM keys in a credential store.
      - Load
        The Load command loads and starts a specified server task or program on the Domino® server.
      - Platform
        Controls the platform statistics data at the console.
      - Pull
        The Pull command forces a one-way replication from the specified server to your server. You can also replicate a single database from the specified server to your server by including the database name on the command line.
      - Push
        The Push command forces a one-way replication from your server to the specified server. You can also replicate a single database from your server to the specified server by including the database name on the command line.
      - Quit
        The Quit command stops the Domino® server.
      - Replicate
        Forces replication between two servers (the server where you enter this command and the server you specify).
      - Restart Port
        Disables transactions (or messages) on the specified port and then re-enables the port after a brief delay.
      - Restart Server
        The Restart Server command stops the Domino® server and then restarts it after a brief delay.
      - Restart Task
        Shuts down and then restarts a specified server task.
      - Route
        Initiates mail routing with a specific Domino® server.
      - Save
        Exports a specified document (noteid) from the Domino® Directory (NAMES.NSF) to dxl format and saves the dxl file to the Domino data directory.
      - Set Configuration
        Adds or changes a setting in the NOTES.INI file.
      - Set Rules
        Reloads the Domino® server's mail rules, enabling new rules to take effect immediately.
      - Set SCOS
        The Set SCOS command activates or deactivates a shared mail database.
      - Set Secure
        Password-protects the Domino® server console.
      - Set Statistics
        Resets a statistic that is cumulative.
      - Set SystemTime
        Forces the internal Domino® time to be set to the operating system time.
      - Show Agents
        Displays the names of agents in the database you specify.
      - Show AI
        Displays the history of the expansion factor and the availability index (AI). Use this command after running a server under load.
      - Show Allports
        Displays the configuration for all enabled and disabled ports on the server.
      - Show Cluster
        Displays the local server's cluster name cache.
      - Show Configuration
        Displays the current value for a NOTES.INI setting.
      - Show Database
        Shows information about a specific database.
      - Show Directory
        Lists all database files (NSF and NTF) in the data directory on a Domino® server, and specifies whether the server contains multiple replicas of a database.
      - Show Diskspace
        Displays the amount of space, in bytes, available on the disk drive (Microsoft™ Windows™), or file system (UNIX™).
      - Show Heartbeat
        Indicates whether the server is responding.
      - Show IDvaults
        Displays configuration information about the ID vaults on a server. The command also deletes a vault replica that is marked for deletion.
      - Show JVM
        Displays the long Java™ Virtual Machine (JVM) version string.
      - Show Memory
        Displays the amount of RAM and swap memory available on a server.
      - Show Monitors
        Reports the amount of memory being used by monitors.
      - Show Opendatabases
        Displays a list of open databases on the server and detail information for the databases.
      - Show Performance
        Displays the per minute user/transaction values when the Domino® Server is running.
      - Show Port
        Displays traffic and error statistics, and resources used on the network adapter card or communications port.
      - Show Schedule
        Shows the next time that a server task will run.
      - Show SCOS
        Shows single copy object store (shared mail) information and reloads the shared mail configuration.
      - Show Server
        Shows server status information.
      - Show Stat
        Displays Domino® server statistics for one or more of the following: disk space, memory, mail, replication, and network activity.
      - Show Stat DAOS
        Shows statistics on the Domino® Attachment and Object Service (DAOS).
      - Show Stat Mail
        Shows messaging statistics regarding dispatch requests and other messaging statistics.
      - Show Stat Platform
        Displays individual and cumulative platform statistics for all servers including one or more of the following: logical disk, paging file, memory, individual network, process, and system.
      - Show Stat vm
        Monitors the performance of physical and virtual memory. The Show Stat vm command displays a list of virtual memory usage statistics for all enabled Domino® server processes.
      - Show Tasks
        Displays the server name, the Domino® program directory path, and the status of the active server tasks.
      - Show Transactions
        For each type of transaction, displays the total number of NRPC transactions, the minimum and maximum duration of the transaction, the total time to perform all transactions, and the average time to perform the transaction.
      - Show Users
        Displays a list of all users who have established sessions with the server, whether or not the users are actively working in databases.
      - Show Xdir
        Provides information about each directory a server uses for name resolution.
      - Start Consolelog
        Enables output to the console log file.
      - Start Port
        Enables transactions (or messages) on the specified port.
      - Stop Consolelog
        Disables output to the console log file.
      - Stop Port
        Disables transactions (or messages) on the specified port.
      - Sucache refresh
        Forces a dynamic reloading of the Smart Upgrade configuration information, displays the state of the Domino® server's Smart Upgrade cache information, and displays Smart Upgrade statistics gathered when the Domino server was restarted.
      - Sucache show
        Displays the current state of the Domino® server's Smart Upgrade cache as well as some statistics gathered since the Domino server was restarted.
      - Tell
        Issues a command to a server program or task.
      - Trace
        Tests a connection to a server.
    - Using a console to send commands to a server
      Use a server console to see server events as they happen and to send commands to a server. Server events are also logged to a server's log file (LOG.NSF). You can view the log file from the Server > Analysis tab in the Domino® Administrator.
    - Entering commands at the console at the server
      You can enter commands in the server console.
    - Sending Controller and shell commands from a remote console
      A server can run under a Java-based Controller; this starts the server when you start the Controller.
    - Sending commands from the Domino® Administrator console
      A Domino® server command can contain up to 255 characters. If an argument for a command contains a space, enclose it in quotation marks. For example: PULL "Renovations Server".
    - Using the Domino® Character Console to access the server console
      The Domino® Character Console (cconsole program) provides a way to access the server console from the command line. This feature is available only for UNIX™ platforms.
  - Domino® server tasks
    The information in this topic describes Domino® server tasks and their defaults in the NOTES.INI file.
  - IBM® i server commands
    You can use IBM® i server commands to manage Domino® with IBM i.
- Managing users
  The Administration Process helps you manage users by automating many of the associated administrative tasks. For example, if you rename a user, the Administration Process automates changing the name throughout databases in the Notes® domain by generating and carrying out a series of requests, which are posted in the Administration Requests database.
- Monitoring servers
  This section describes how to use the tools and features that help you monitor a Domino® system.
- Managing servers
  Manage Domino® servers by performing any of these tasks.
- Managing databases
  Topics in this section describe how to set up and manage Domino® databases.

Trace

Tests a connection to a server.

Details

This command shows detailed information about each server hop and is useful in troubleshooting network connection problems. This command works the same way as "Trace connections," when you choose File > Preferences > Notes Preferences in the Notes® client.

When you attempt to connect to a server, network trace information automatically appears on the status bar of a Notes® workstation or on the server console, depending on where you initiated the connection attempt. You can use the NOTES.INI setting Console_LogLevel to control the level of detail that messages on the status bar contain. Trace information is recorded in the log file (LOG.NSF).

Syntax

 Trace servername

Examples

To trace a path to a server, enter:

Trace servername

To trace a specific port, enter:

Trace portname!!!servername