Subscription.AgentOffload Property

Gets or sets whether the synchronization agent runs on a computer other than the one where the agent job was created. This property is no longer supported for Distributors running Microsoft SQL Server 2005 and later.

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

Syntax

'Declaration
Public Property AgentOffload As Boolean
    Get
    Set
'Usage
Dim instance As Subscription
Dim value As Boolean

value = instance.AgentOffload

instance.AgentOffload = value
public bool AgentOffload { get; set; }
public:
property bool AgentOffload {
    bool get ();
    void set (bool value);
}
member AgentOffload : bool with get, set
function get AgentOffload () : boolean
function set AgentOffload (value : boolean)

Property Value

Type: System.Boolean
A Boolean value. If true, the agent runs on another computer and is launched using a DCOM process. If false, the agent runs on the computer where the agent job was created.

Remarks

Microsoft SQL Server 2000 supported running the Distribution Agent or Merge Agent on another computer and then activating that agent remotely using Distributed Component Object Model (DCOM). Support has been discontinued for Distributors running SQL Server 2005 and later; it has been deprecated for Distributors running earlier versions of SQL Server. Setting the AgentOffload property on an instance of SQL Server 2005 will generate an exception on the server.

When AgentOffload is true, the agent will be launched remotely by way of a DCOM process if is not local.

The AgentOffload property can only be retrieved by members of the sysadmin fixed server role at the Publisher, by members of the db_owner fixed database role on the publication database, or by the user that created the subscription.

The AgentOffload property can only be set by members of the sysadmin fixed server role at the Publisher or by members of the db_owner fixed database role on the publication database.

The AgentOffload property is available with SQL Server 2000.

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