ReplicationServer.ChangeReplicationServerPasswords Method

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Replication
Assembly:
Microsoft.SqlServer.Rmo.dll

Changes all stored instances of the password for a login maintained on the replication server.

Overloads

ChangeReplicationServerPasswords(ReplicationSecurityMode, String, SecureString)

Changes all stored instances of the password for a login maintained on the replication server using a SecureString object.
ChangeReplicationServerPasswords(ReplicationSecurityMode, String, String)

Changes all stored instances of the password for a login maintained on the replication server.

ChangeReplicationServerPasswords(ReplicationSecurityMode, String, SecureString)

Changes all stored instances of the password for a login maintained on the replication server using a SecureString object.

public:
 void ChangeReplicationServerPasswords(Microsoft::SqlServer::Replication::ReplicationSecurityMode securityMode, System::String ^ login, System::Security::SecureString ^ password);
public void ChangeReplicationServerPasswords (Microsoft.SqlServer.Replication.ReplicationSecurityMode securityMode, string login, System.Security.SecureString password);
member this.ChangeReplicationServerPasswords : Microsoft.SqlServer.Replication.ReplicationSecurityMode * string * System.Security.SecureString -> unit
Public Sub ChangeReplicationServerPasswords (securityMode As ReplicationSecurityMode, login As String, password As SecureString)

Parameters

securityMode
ReplicationSecurityMode

Is the ReplicationSecurityMode value that specifies whether the login is used for Windows Authentication or SQL Server Authentication.

login
String

Is the login for the stored password being changed.

password
SecureString

Is the password being changed, supplied as a SecureString value.

Security Note When possible, prompt users to enter security credentials at run time. If you must store credentials, use the http://go.microsoft.com/fwlink/?LinkId=34733 cryptographic services provided by the Windows .NET Framework.

Remarks

The ChangeReplicationServerPasswords method is used to update the password for a login used by replication agents to connect to other servers in the replication topology after the password for this login has been changed. This method is used instead of individually changing the password for each stored instance of the login used for each agent connection.

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

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

Calling ChangeReplicationServerPasswords is equivalent to executing sp_changereplicationserverpasswords (Transact-SQL).

Applies to

ChangeReplicationServerPasswords(ReplicationSecurityMode, String, String)

Changes all stored instances of the password for a login maintained on the replication server.

public:
 void ChangeReplicationServerPasswords(Microsoft::SqlServer::Replication::ReplicationSecurityMode securityMode, System::String ^ login, System::String ^ password);
public void ChangeReplicationServerPasswords (Microsoft.SqlServer.Replication.ReplicationSecurityMode securityMode, string login, string password);
member this.ChangeReplicationServerPasswords : Microsoft.SqlServer.Replication.ReplicationSecurityMode * string * string -> unit
Public Sub ChangeReplicationServerPasswords (securityMode As ReplicationSecurityMode, login As String, password As String)

Parameters

securityMode
ReplicationSecurityMode

Is the ReplicationSecurityMode value that specifies whether the login is used for Windows Authentication or SQL Server Authentication. When possible, use Windows Authentication.

login
String

Is the login for the stored password being changed.

password
String

Is the password being changed.

Exceptions

ArgumentException

When the values of login or password are longer than 128 Unicode characters or contain null characters.

Remarks

The ChangeReplicationServerPasswords method is used to update the password for a login used by replication agents to connect to other servers in the replication topology after the password for this login has been changed. This method is used instead of individually changing the password for each stored instance of the login used for each agent connection.

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

Calling ChangeReplicationServerPasswords is equivalent to executing sp_changereplicationserverpasswords (Transact-SQL).

Applies to