Attribute definitions for the Sybase agent


Attribute definitions for the Sybase agent
Prev	Sybase resource type	Next

Review the description of the Sybase agent attributes. The agent attributes are classified as required, optional, and internal.

Table: Required attributes lists the required attributes.

Table: Required attributes

Required Attributes

Definition

Home

The $SYBASE path to Sybase binaries and configuration files.

Type and dimension: string-scalar

Default value: No default value

Owner

Sybase user as the defined owner of executables and database files in any of the sources (such as NIS+, /etc/hosts, and so on) specified in the /etc/nsswitch.conf file for passwd entry. The Sybase executables and database files are accessed in the context of this user.

Type and dimension: string-scalar

Quorum_dev

The quorum device manages the cluster membership, stores cluster configuration data, and contains information shared among server instances and nodes. The quorum device is a disk that is accessible to all the nodes in the cluster. Specify a fully qualified quorum device name.

Type and dimension: string-scalar

Default value: No default value

Note: This attribute should be specified only for the cluster edition.

Note:

If you do not set the Quorum_dev attribute for Sybase Cluster Edition, the Sybase agent does not perform the qrmutil-based checks. This error in configuration may lead to undesirable results. For example, if qrmutil returns failure pending, the agent does not panic the system.

Sybase database administrator. This attribute is required to connect to the ASE for shutdown.

Type and dimension: string-scalar

Default value: No default value

SApswd

Encrypted password for Sybase database administrator. This password is required to connect to the ASE for shutdown.

Type and dimension: string-scalar

Default value: No default value

Note:

You need not specify a value for this attribute if the SA user does not require a password.

Server

The $DSQUERY ASE name. Only one server should be configured in a Sybase service group. The advantage of configuring Sybase resources in a separate service group is, each Sybase data server can failover independently.

When multiple Sybase resources are configured in a single service group, even if one of the "n" data servers fail, the entire service group will be failed over.

Type and dimension: string-scalar

Default value: No default value

Table: Optional attributes lists the optional attributes.

Table: Optional attributes

Optional Attributes

Definition

DetailMonitor

Specifies whether the Sybase server is monitored in detail. A positive integer value indicates that the resource monitors the Sybase server in detail. Value 0 denotes it does not.

Note:

This attribute has been removed from the agent version 6.1.0 onwwards.

Default is 0.

Type and dimension: int-scalar

Note:

The DetailMonitor attribute is deprecated in VCS 7.3. Instead, LevelTwoMonitorFreq attribute at the Sybase resource type level may be used.

LevelTwoMonitorFreq

Specifies the frequency at which the agent for this resource type must perform second-level or detailed monitoring.

This is a resource type level attribute. You can override the value of this attribute at the resource level.

The default value of LevelTwoMonitorFreq attribute is 0 (zero).

If required, the value of LevelTwoMonitorFreq attribute can be overridden at resource level.

User

The database user, in the context of which, the transactions are performed on the database. You must specify a value for this attribute if LevelTwoMonitorFreq is set to a positive integer value.

Type and dimension: string-scalar

Default value: No default value

UPword

Encrypted password for the database user. You must specify a value for this attribute if LevelTwoMonitorFreq is set to a positive integer value. However, you need not specify a value for this attribute if the database user does not require a password.

intercType and dimension: string-scalar

Default value: No default value

Name of the database used for detailed monitoring. The table used by the detail monitor script resides in this database. You must specify a value for this attribute if LevelTwoMonitorFreq is set to a positive integer value.

Type and dimension: string-scalar

Default value: No default value

Table

Name of the table on which the detail monitoring script performs the transactions. You must specify a value for this attribute if LevelTwoMonitorFreq is set to a positive integer value.

Type and dimension: string-scalar

Default value: No default value

Monscript

The path to the detail monitor script; the default value for this attribute is the path for the script, SqlTest.pl, provided with the agent. You must specify a value for this attribute if LevelTwoMonitorFreq is set to a positive integer value.

Type and dimension: string-scalar

Default value: No default value

Note:

By default, SqlTest.pl script has the execute permission set. If you specify custom detail monitor script, ensure that custom detail monitor script also has the execute permissions set.

WaitForRecovery

The recovery procedures rebuild the server's databases from the transaction logs. This boolean attribute indicates if the agent should wait during Online agent function, till recovery has been completed and all databases that can be made online are brought online. This feature is not supported for pre-12.5.1 Sybase ASE server.

Type and dimension: boolean-scalar

Default value: 0

Run_ServerFile

Specifies the location of the RUN_SERVER file for the Sybase instance. The default location of this file is used if no value is specified for this attribute.

Type and dimension: string-scalar

Default value: No default value

IMF

This resource-type level attribute determines whether the Sybase agent must perform intelligent resource monitoring. You can also override the value of this attribute at resource-level.

This attribute includes the following keys:

Mode: Define this attribute to enable or disable intelligent resource monitoring.
Valid values are as follows:
- 0 - Does not perform intelligent resource monitoring
- 1 - Performs intelligent resource monitoring for offline resources and performs poll-based monitoring for online resources
- 2 - Performs intelligent resource monitoring for online resources and performs poll-based monitoring for offline resources
- 3 - Performs intelligent resource monitoring for both online and for offline resources
  
  Default: 3

IMF (cont.)

MonitorFreq: This key value specifies the frequency at which the agent invokes the monitor agent function. The value of this key is an integer.

Default: 5

You can set this key to a non-zero value for cases where the agent requires to perform both poll-based and intelligent resource monitoring. If the value is 0, the agent does not perform poll-based process check monitoring.

After the resource registers with the AMF kernel driver, the agent calls the monitor agent function as follows:
- After every (MonitorFreq x MonitorInterval) number of seconds for online resources
- After every (MonitorFreq x OfflineMonitorInterval) number of seconds for offline resources
RegisterRetryLimit: If you enable intelligent resource monitoring, the agent invokes the sybase_imf_register agent function to register the resource with the AMFkernel driver. The value of the RegisterRetryLimit key determines the number of times the agent must retry registration for a resource. If the agent cannot register the resource within the limit that is specified, then intelligent monitoring is disabled until the resource state changes or the value of the Mode key changes.

Default: 3

See Enabling and disabling intelligent resource monitoring (IMF) for agents.

Type and dimension: Integer-association.

interfaces_File

Specifies the location of interfaces file, including the directory name and the file name for the Sybase instance. If this attribute is configured, [-I interfaces file] option is used when connecting to the isql session. If this attribute is not configured, the agent does not use the -I option.

Type and dimension: string-scalar

Default value: No default value

For example: /sybase/my_interfaces_file

Note:

It is assumed that you have modified the RUN_ServerFile with the non-default interface file location if the interfaces_File attribute is configured.

DelayAfterOnline

Specifies the number of seconds that elapse after the Online entry point is complete and before the next monitor cycle is invoked.

Type and dimension: integer-scalar

Default value: 10

DelayAfterOffline

Specifies the number of seconds that elapse after the Offline entry point is complete and before the next monitor cycle is invoked.

Type and dimension: integer-scalar

Default value: 2

ShutdownWaitLimit

Maximum number of seconds for which the agent waits for the Sybase instance to stop after issuing the shutdown with wait command, and before attempting to issue the kill -15 <data server-pid> command, if required.

Type and dimension: integer-scalar

Default value: 60

Run_ServerFile

Specifies the location of the RUN_SERVER file of the Sybase instance. The default location of the file is used if no value is specified for this attribute.

Type and dimension: String-scalar

Default value: No default value

Prev	Up	Next
Type definition for the Sybase agent	Home	SybaseBk resource type