MSXEnlist Method

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The MSXEnlist method initiates SQL Server Agent participation as a target for multiserver administration.

Syntax

object
.MSXEnlist(
MasterServer
,
Location
)

Parts

  • object
    Expression that evaluates to an object in the Applies To list.

  • MasterServer
    String naming a registered instance of Microsoft SQL Server.The instance must be configured as a multiserver administration master server.

  • Location
    String documenting the enlisting server's location. Used for user assistance only.

Prototype (C/C++)

HRESULT MSXEnlist(
SQLDMO_LPCSTR szServer,
SQLDMO_LPCSTR szLocation);

Remarks

For SQL Server, multiserver administration participation is configured by performing two tasks. An instance of SQL Server declares itself a multiserver administration master server (MSX) by creating an administering operator. One or more instances of SQL Server then enlist with the configured master server, becoming administration target servers (TSX).

SQL Server multiserver administration is implemented using a hub and spoke topology. A master server cannot enlist as a target of any other master server in an organization.

An instance of SQL Server participating as a target server cannot become the target of any other master server by using the MSXEnlist method. Use the MSXDefect method to break an existing master-target relationship prior to enlisting the target server in a new multiserver administration group.

Applies To: