About the Disaster Recovery Orchestrator agent for SQL Server Database Engine

The Disaster Recovery Orchestrator agent for SQL Server Database Engine agent monitors the Database Engine service. The agent brings the service online, monitors the status, and takes it offline. If the service is not running, the agent declares its state as offline.

If detail monitoring is configured, the agent checks the health of the configured SQL Server databases or executes a monitoring script. If detail monitoring is successful, the agent declares the application as available.

The SQLServer2008 resource type represents this agent.

Agent functions

Online

Brings the SQL Server service online.

Offline

Takes the SQL Server service offline.

Monitor

Monitors the status of SQL Server services.

If detail monitoring is configured, then depending on the configuration, the agent performs a database health check or executes a monitoring script.

Clean

Forcibly stops the SQL Server service.

Resource type definition
type SQLServer2008 (
  static int IMF{} = { Mode=3, MonitorFreq=5, RegisterRetryLimit=3 }
  static i18nstr IMFRegList[] = { Instance }
  static i18nstr ArgList[] = { Instance, "LanmanResName:VirtualName", 
    SQLOnlineTimeout,SQLOfflineTimeout, DetailMonitorInterval, 
    SQLDetailMonitorTimeout, Username, Domain, Password, DBList, SQLFile, 
    FaultOnDMFailure, LanmanResName:IPResName", SQLClusterAccount }
  str Instance
  str LanmanResName
  int SQLOnlineTimeout = 90
  int SQLOfflineTimeout = 90
  int DetailMonitorInterval
  int SQLDetailMonitorTimeout = 30
  i18nstr Username
  i18nstr Domain
  str Password
  i18nstr DBList[]
  i18nstr SQLFile
  boolean FaultOnDMFailure = 1
  str SQLClusterAccount
)
Agent attributes

Table: Disaster Recovery Orchestrator agent for SQL Server Database Engine - required attributes

Attribute

Description

Name: Instance

Type: String

Dimension: Scalar

Name of the SQL Server instance to monitor.

If the value of this attribute is empty, the agent monitors the default SQL Server instance (MSSQLSERVER).

Name: LanmanResName

Type:String

Dimension: Scalar

The Lanman resource name on which the SQLServer2008 resource depends.

Table: Disaster Recovery Orchestrator agent for SQL Server Database Engine - optional attributes

Attribute

Description

Name: SQLOnlineTimeout

Type: Integer

Dimension: Scalar

Number of seconds that may elapse before the Online function aborts.

Default value: 90

Name: SQLOfflineTimeout

Type: Integer

Dimension: Scalar

Number of seconds that may elapse before the Offline function aborts.

Default value: 90

Name: DetailMonitorInterval

Type: Integer

Dimension: Scalar

Defines the level of detail monitoring that the agent performs for SQL Server.

The value 0 (zero) indicates that the agent performs only the basic monitoring of the instance service. A non-zero value indicates the number of online monitor cycles that the agent must wait before performing detail monitoring. Symantec recommends that you set this value to an integer between 1 and 12.

The value 1 would make the agent perform detail monitoring at each monitor cycle. The value 2 would make the agent perform detail monitoring at every other monitor cycle. This interpretation may be extended to other values.

If this attribute is set to a non-zero value, then the following attributes must be assigned appropriate values:

  • For script-based monitoring: SQLFile, Username, Password, Domain, and SQLDetailMonitorTimeOut

  • For databases list-based monitoring: Username, Password, Domain, and DBList

Default value: 5

Name: FaultOnDMFailure

Type: Boolean

Dimension: Scalar

Defines whether the agent faults the SQL Server resource when the detail monitoring fails.

  • If the value is set to True, the agent faults the configured SQL Server resource when the detail monitoring fails.

    In this case, the SQL Server resource may go into OFFLINE state.

  • If the value is set to False, the agent does not fault the SQL Server resource when the detail monitoring fails.

    In this case, the SQL Server resource may go into the UNKOWN state.

Default value: True

Name: SQLDetailMonitorTimeout

Type: Integer

Dimension: Scalar

Number of seconds that may elapse before the detail monitoring routine aborts.

Default value: 30

Name: Username

Type: String

Dimension: Scalar

User account in whose context the detail monitoring is performed.

If the DetailMonitorInterval attribute is set to a non-zero value, the value of this attribute must not be empty.

Name: Domain

Type: String

Dimension: Scalar

Domain of the user account specified in the Username attribute.

Name: Password

Type: String

Dimension: Scalar

Password for the user account specified in the Username attribute.

If the DetailMonitorInterval attribute is set to a non-zero value, the value of this attribute must not be empty.

This password is encrypted.

Name: SQLFile

Type: String

Dimension: Scalar

Location of the SQL file executed during a monitor cycle

If the DetailMonitorInterval attribute is set to a non-zero value, then either the script-based detail monitoring or the database list-based detail monitoring must be configured.

Name: DBList

Type: String

Dimension: Vector

List of databases for which the agent must perform detail monitoring.

If the DetailMonitorInterval attribute is set to a non-zero value, then either the script-based detail monitoring or the database list-based detail monitoring must be configured.

If both the SQLFile attribute and the DBList attribute are configured, then the DBList attribute takes precedence.