nscontrol Utility

The nscontrol utility is a command prompt utility for administering Microsoft SQL Server 2005 Notification Services. It provides commands for deploying, configuring, monitoring, and controlling Notification Services instances and applications.

Note

You can develop your own applications for performing many functions of the nscontrol commands. For more information, see the reference for the Instance class in the Server Management Objects for Notification Services.

Syntax Conventions

The following rules apply to all commands of the nscontrol utility:

  • Commands and arguments are not case-sensitive.
  • Precede command arguments with either a hyphen (-) or a forward slash (/). These symbols are equivalent to one another.
  • Include a space between the argument and its value.
  • Enclose in quotation marks (") any value that contains a space.

nscontrol Commands

The following commands are available in nscontrol.

Topic Description

nscontrol create Command

Creates the instance and application databases for a new instance of Notification Services.

nscontrol delete Command

Deletes the instance and application databases for an existing instance of Notification Services.

nscontrol disable Command

Disables the specified Notification Services components.

nscontrol displayargumentkey Command

Displays the key used to encrypt delivery channel and event provider arguments.

nscontrol enable Command

Enables the specified Notification Services components.

nscontrol export Command

Exports metadata from the instance and application databases and creates one XML instance configuration file (ICF) and one XML application definition files (ADFs) per application.

nscontrol listversions Command

Displays information about the installed versions and registered instances of Notification Services.

nscontrol repair Command

Updates the information in the msdb database for the specified instance of Notification Services.

nscontrol register Command

Creates or updates registry entries for an instance of Notification Services optionally create a Windows service and performance counters for the instance.

nscontrol status Command

Displays the current enabled or disabled status of instances and applications.

nscontrol unregister Command

Removes the registry information for the instance as well as the Windows service and performance counters, if they exist.

nscontrol update Command

Compares the metadata in the ICF and the ADFs to the metadata in the instance and application databases, and then optionally update the databases for any differences that it finds.

nscontrol upgrade Command

Upgrades an instance of Notification Services that was created using an older version of the product to the current version or from an earlier edition to the current edition.

See Also

Reference

Microsoft.SqlServer.Management.Nmo

Other Resources

Administering Notification Services
Deploying Notification Services

Help and Information

Getting SQL Server 2005 Assistance