Installing and running NSD as a Microsoft Windows service

You can manually install Notes® System Diagnostics (NSD) as a Microsoft™ Windows™ (Win32) service. When NSD is registered as a service, you can enter commands to start or stop the service, trigger NSD processing, generate status and trace messages, and request status information that can be written to a log file. You can also uninstall the NSD service.

About this task

Enter all NSD commands from a Microsoft Windows console window. For example, to install the NSD service, open a Microsoft Windows console window, navigate to the location of the NOTES.INI file, and enter the following command:

nsd -svcinst
Note: If the location of NSD is not on the path, and the location of the NOTES.INI file is not the same as the location of NSD, an absolute or relative path to NSD is also required.

All of the options described in this topic are available only on Notes and Domino® running on Microsoft Windows platforms.

Installing the NSD service

About this task

Use this command to install the NSD service:

-svcinst

The -svcinst command Installs the NSD Win32 service. Once installed and started, Notes and Domino fault recovery uses the Win32 service for all attempts to invoke NSD. Note that -svcinst only installs the service; it must be started separately by doing one of the following:

  • Running NSD -svcstart
  • Using the Services control panel applet to start it
  • Rebooting the system which causes the service to restart

The -svcinst command is usually paired with -svcstart which starts the service. For example, enter the following:

nsd -svcinst -svcstart

Running the NSD service

About this task

Use the following commands to start and stop the NSD service:

-svcstart

The -svcstart command starts the NSD Win32 service. Once started, Notes and Domino fault recovery uses the Win32 service for all attempts to invoke NSD. This option is only useful when the NSD Win32 service is installed and not started. For example, enter:

nsd -svcstart

-svcstop

The -svcstop command stops the NSD Win32 service. Once stopped, Notes and Domino fault recovery runs NSD as a child process for all attempts to invoke NSD. This option is only useful when the NSD Win32 service is installed and started. For example, enter:

nsd -svcstop

Using the NSD service

About this task

Use the -svclog and -svcreport commands to manage the NSD service. For example, you can generate status and trace messages and request status information that can be written to a log file.

When specified with another service option, for example, svcinst, -svclog causes status and trace messages to be appended to a log file NSDSVC.LOG in the data\IBM_TECHNICAL_SUPPORT directory. This option is only useful when specified with another service option. For example, enter:

nsd -svcinst -svclog

The -svcreport command requests status information about the NSD Win32 service from Microsoft Windows, which is then written to the console (stdout), and appended to the file NSDSVC.LOG (if -svclog is also specified). This option is only available on Microsoft Windows versions of Notes and Domino. For example, enter:

nsd -svcreport

Uninstalling the NSD service

About this task

The uninstall command unregisters NSD as a Win32 system service. NSD -svcuninst does not remove any files from the system. Use the following command to uninstall the NSD service:

-svcuninst

The -svcuninst command uninstalls the NSD Win32 service. Once uninstalled, Notes and Domino fault recovery runs NSD as a child process for all attempts to invoke NSD. This option is only useful when the NSD Win32 service is installed.

The uninstall command is usually paired with the -svcstop command. For example, enter the following to stop the NSD service, and then uninstall it:

nsd -svcstop