ReplicationServer.InstallDistributor Method (SecureString, DistributionDatabase)

Installs a Distributor on the currently connected instance of Microsoft SQL Server, where the password is specified using a SecureString object.

Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)

Syntax

'Declaration
Public Sub InstallDistributor ( _
    password As SecureString, _
    distributionDB As DistributionDatabase _
)

public void InstallDistributor (
    SecureString password,
    DistributionDatabase distributionDB
)

public:
void InstallDistributor (
    SecureString^ password, 
    DistributionDatabase^ distributionDB
)

public void InstallDistributor (
    SecureString password, 
    DistributionDatabase distributionDB
)

public function InstallDistributor (
    password : SecureString, 
    distributionDB : DistributionDatabase
)

Parameters

• password
  Is a SecureString value representing the password of the distributor_admin login used to access the Distributor.

  Security Note:
  When possible, prompt users to enter security credentials at run time. If you must store credentials, use the cryptographic services provided by the Windows .NET Framework.

• distributionDB
  A DistributionDatabase object representing the distribution database used by the Distributor.

Remarks

You must specify a strong password for password when the Distributor has remote Publishers. If password is set to null, a random password is generated, and you must call ChangeDistributorPassword to reset the password when the first remote Publisher is registered at the Distributor.

This method overload must be called at the Distributor before calling InstallDistributor(String,String) from a remote server.

The InstallDistributor(SecureString,DistributionDatabase) method provides additional security for the password while it is stored in memory and should be used instead of InstallDistributor(String,DistributionDatabase).

The InstallDistributor method can only be called by a member of the sysadmin fixed server role.

The InstallDistributor method is equivalent to the sp_adddistributor (Transact-SQL) stored procedure.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

ReplicationServer Class
ReplicationServer Members
Microsoft.SqlServer.Replication Namespace