ReplicationMonitor.EnumSnapshotAgents Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns information on Snapshot Agent jobs at the monitored Distributor.
public:
System::Data::DataSet ^ EnumSnapshotAgents();public System.Data.DataSet EnumSnapshotAgents ();member this.EnumSnapshotAgents : unit -> System.Data.DataSetPublic Function EnumSnapshotAgents () As DataSetReturns
A DataSet object that contains the following columns.
| Column | Data type | Description |
|---|---|---|
| db_name | String | Name of the distribution database. |
| 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 publication database. |
| publication | String | Name of the publication. |
| start_time | String | Date and time of the 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 defines 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 defines a partition. |
Remarks
You should commit any property changes to the ReplicationMonitor object before calling this method because properties of this object may need to be loaded if they have not been loaded already.
The EnumSnapshotAgents method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.