Share via


PublicationMonitor.EnumSnapshotAgent Method

Definition

Returns information for the Snapshot Agent job used by the monitored publication.

public:
 System::Data::DataSet ^ EnumSnapshotAgent();
public System.Data.DataSet EnumSnapshotAgent ();
member this.EnumSnapshotAgent : unit -> System.Data.DataSet
Public Function EnumSnapshotAgent () As DataSet

Returns

A DataSet object that contains the following columns.

Column Data type Description
name String Replication Agent job name.
status Int32 The running status:

1 = Start

2 = Succeed

3 = In progress

4 = Idle

5 = Retry

6 = Fail

publisher String Publisher name.
publisher_db String Name of the database published.
publication String Publication name.
start_time String Date and time of last agent execution.
time String Date and time that the session was logged.
duration Int32 Elapsed time of the session, in seconds.
comments String Message text logged by the agent.
delivered_transactions Int32 Total number of transactions delivered in the session.
delivered_commands Int32 Total number of commands delivered in the session.
delivery_rate Single Average number of commands delivered per second.
error_id Int32 The ID of the error in the [MSrepl_errors (Transact-SQL)](http://msdn.microsoft.com/library/c6e023c1-2c32-4269-8d76-e442ea309e4b) system table. Use the EnumErrorRecords(Int32) method to return detailed information about an error.
job_id Byte **[16]** Identifier of the SQL Server Agent job starting the Replication Agent.
local_job Boolean When true, the agent job is available at the Distributor.
profile_id Int32 Profile identifier.
agent_id Int32 Agent job identifier.
local_timestamp Byte **[8]** Timestamp of the most recent agent run.
dynamic_filter_login String The value used for evaluating the [SUSER_SNAME (Transact-SQL)](http://msdn.microsoft.com/library/11ec7d86-d429-4004-a436-da25df9f8761) function in parameterized filters that define a partition.
dynamic_filter_hostname String The value used for evaluating the [HOST_NAME (Transact-SQL)](http://msdn.microsoft.com/library/4b8b0705-c083-4b07-b954-c83ee73b2ebb) function in parameterized filters that define a partition.

Remarks

The EnumSnapshotAgent method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.

Applies to

See also