RemoteServers Collection

SQL-DMO

SQL-DMO

RemoteServers Collection

The RemoteServers collection contains RemoteServer objects that expose the attributes of an instance of Microsoft® SQL Server™ visible as a remote server.

Properties
Count Property
Methods
Add Method Refresh Method
Item Method Remove Method (Collections)
ItemByID Method  

Remarks

SQL Server provides several mechanisms to help manage connections between instances of SQL Server in an organization. One mechanism is remote-server naming.

An instance of SQL Server can maintain authentication information for connections originating from other instances of SQL Server. Each instance of SQL Server in an organization can control access by listing instances of SQL Server from which it accepts connections.

Additionally, when a remote server is named at an instance of SQL Server, the server maintaining the name list can, in turn, originate a connection to a named remote server.

Note  Remote server naming is one method for configuring server-initiated access for instances of SQL Server in an organization. SQL Server version 7.0 implements distributed queries using persisted OLE DB data source definitions called linked servers. For more information, see LinkedServer Object.

With the RemoteServers collection, you can:

  • Identify an instance of SQL Server as a remote server.

  • Remove remote server naming.

  • Rename an instance of SQL Server.

To identify an instance of SQL Server as a remote server

  1. Create a RemoteServer object.

  2. Configure the RemoteServer object by setting the Name, NetName, and Options properties.

  3. Add the RemoteServer object to the RemoteServers collection of a connected SQLServer object.

To remove a named remote server, disabling access to or from the instance

  • Use the Remove method of the RemoteServers collection, as in:
    oSQLServer.RemoteServers.Remove("LONDON1")

To rename an instance of SQL Server

  1. Use the Remove method of the RemoteServers collection, providing the existing SQL Server instance name in the method call.

  2. Create a RemoteServer object.

  3. Configure the RemoteServer object by setting the Name property to the desired new name.

  4. Configure the RemoteServer object by setting the NetName property to the network name of the instance of SQL Server.

  5. Add the RemoteServer object to the RemoteServers collection of the SQLServer object.

  6. Use the Shutdown and Start methods of the SQLServer object to restart the instance of SQL Server.

When using the Item or Remove method, the RemoteServers collection supports member identification using either name or ordinal reference syntax. For example:

Set oRemoteServer = oSQLServer.RemoteServers("SEATTLE2")

Or:

Set oRemoteServer = oSQLServer.RemoteServers(2)

Note  Creating or removing remote server entries by using the RemoteServers collection requires appropriate privilege. The SQL Server login used for SQLServer object connection must be a member of the fixed role setupadmin or a role with greater privilege.