nscontrol displayargumentkey Command

Displays the value of the SQL Server Notification Services key used to encrypt delivery channel and event provider arguments, if the instance uses argument encryption.

Syntax

nscontrol displayargumentkey 
    [-nologo]
    [-help]
        –name instanceName

Arguments

• -nologo
  Suppresses the product and version statement that appears when you run an nscontrol command.

• -help
  Displays the command syntax.

• -nameinstanceName
  Is the name of an instance of Notification Services that uses argument encryption.

Remarks

Configure argument encryption using the EncryptArguments element in the instance configuration file (ICF). When the EncryptArguments value is true, Notification Services encrypts the values of delivery channel and event provider arguments before storing these values in the instance and application databases.

You initially provide the key value when you register or create the instance. You need to use the same key value when creating, updating, and registering the instance. The nscontrol displayargumentkey command enables you to view the key.

The nscontrol displayargumentkey command returns the key value from the registry.

Permissions

The account used to run nscontrol displayargumentkey must be a member of the Administrators or Power Users groups in Windows, or must be the same account as used to run the instance. The account must also have permission to execute the Notification Services binary files; this permission is granted to members of the Administrators and SQLServerNotificationServicesUser Windows groups.

Examples

The following example shows how to view the argument key for the StockInstance instance.

nscontrol displayargumentkey -name StockInstance

See Also

Reference

nscontrol Utility

Other Resources

EncryptArguments Element (ICF)

Help and Information

Getting SQL Server 2005 Assistance

Change History