Related API Commands

In addition to the Replication Manager plug-in, you can also use the Replicaiton Monitoring Services (RMS) API to monitor your replication environment.

Task Related API
Adding a server addserver – adds a server to monitor.
Dropping a server dropserver – drops a a monitored server.
Viewing monitored objects N/A
Setting configuration parameters
  • configure server – returns configuration parameter information for a Replication Server or Replication Agent, or sets the value of a specified configuration parameter. configure server also retrieves and sets RMS-specific parameters.

  • configure component – returns configuration parameters for a component or sets the value of the configuration parameter specified.

  • configure RMS – returns the configuration parameter information for the RMS, or sets the value of a specified RMS configuration parameter

Managing a logical group of servers
  • create group – defines a logical group of servers.

  • delete group – deletes a logical group that was added using the create group command.

  • get group – returns a result set that contains either a list of the groups and a rollup status for each group or for each server.

Suspending or resuming components
  • suspendcomponent – suspends a component in a specified server.

  • suspend replication – suspends replication in a Replication Agent.

  • resume component – resumes a component in a specified server.

  • resume replication – resumes replication in a Replication Agent.

Shutting down monitored servers shutdown server – shuts down one or more, or group of monitored Replication Servers or RMS.
Viewing rollup status information and various server states
  • get servers – returns a list of servers that are monitored by the RMS, and the status of the RMS environment.

  • get status description – retrieves the list of status descriptions for a server or component.

Monitoring heartbeat
  • get heartbeat – retrieves a list of the heartbeat processes that have been defined in the RMS.

  • get heartbeat ticket – retrieves a set of tickets from the rms_ticket_history table, for the heartbeat process and date and time range specified.

  • start heartbeat – sets up and starts a heartbeat process from a specified primary connection to a specified replicate connection.

  • stop heartbeat – stops the heartbeat process between the primary and replicate databases. Optionally truncates the rms_ticket_history table.

Managing event triggers
  • add event trigger – sets up a trigger, such as a process or a script, that is executed by the RMS when a specific event occurs.

  • drop event trigger – removes a trigger that the RMS is monitoring.

  • get triggers – displays information about the triggers that are monitored by the RMS.

For detailed information about these APIs, see Chapter 9, “Replication Monitoring Services API,” in the Replication Server Reference Manual.