ReplicationMonitor.EnumMiscellaneousAgents Method
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 jobs for miscellaneous replication agents at the monitored Distributor.
public:
System::Data::DataSet ^ EnumMiscellaneousAgents();
public System.Data.DataSet EnumMiscellaneousAgents ();
member this.EnumMiscellaneousAgents : unit -> System.Data.DataSet
Public Function EnumMiscellaneousAgents () As DataSet
A DataSet object that contains the following columns.
Column | Data type | Description |
---|---|---|
name | String | Replication agent job name. |
agent_type | String | Type of miscellaneous replication agent. |
status | Int32 | The running status:
1 = Start 2 = Succeed 3 = In progress 4 = Idle 5 = Retry 6 = Fail |
message | String | Message text logged by the agent. |
start_time | String | Date and time of the last agent execution. |
run_duration | Int32 | Elapsed time of the session, in seconds. |
job_id | Byte **[16]** | Identifier of the SQL Server Agent job starting the replication agent. |
local_timestamp | Byte **[8]** | Timestamp of the most recent agent run. |
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 EnumMiscellaneousAgents method can only be called by members of the db_owner
or replmonitor
fixed database roles on the distribution database.