8 TimesTen Configuration Attributes for Oracle Clusterware

Required attributes

These attributes must be present for each DSN in the cluster.oracle.ini file. They have no default values.

The required attributes are listed in Table 8-1, "Required attributes" and described in detail in this section.

MasterHosts

This attribute lists the host names that can contain master databases in the active standby pair. The first host listed has the active database when the cluster is started initially and after restarts. There are exceptions to the designated order:

• If there are already active and standby databases on specific nodes when the cluster is stopped, then the active and standby databases remain on those hosts when the cluster is restarted.

• If the cluster is started and the only existing database is on a host that is not listed first in MasterHosts, then that host will be configured with the active database. The first host listed for MasterHosts will be the standby database.

If the scheme contains no virtual IP addresses, only two master hosts are allowed.

Setting

Set MasterHosts as follows:

Conditionally required attributes

These attributes may be required depending on the desired Oracle Clusterware configuration. They have no default values. The conditionally required attributes are listed in Table 8-2, "Conditionally required attributes" and described in detail in this section.

AppCheckCmd

This attribute specifies the full command line for executing a user-supplied script or program that checks the status of the TimesTen application specified by AppName. It must include the full path name of the executable. If there are spaces in the path name, enclose the path name in double quotes.

The command should be written to return 0 when the application is running and a nonzero number when the application is not running. When Oracle Clusterware detects a nonzero value, it takes action to recover the failed application.

Setting

Set AppCheckCmd as follows:

Examples

On UNIX:

AppCheckCmd=/mycluster/reader/app_check.sh check

On Windows:

AppCheckCmd="C:\Program Files\UserApps\UpdateApp.exe" -dsn myDSN -check

AppFailureInterval

This attribute sets the interval in seconds before which Oracle Clusterware stops a TimesTen application if the application has exceeded the number of failures specified by the Oracle Clusterware FAILURE_THRESHOLD resource attribute. If the value is zero, then failure tracking is disabled.

For more information about the Oracle Clusterware FAILURE_THRESHOLD resource attribute, see Oracle Clusterware Administration and Deployment Guide.

Setting

Set AppFailureInterval as follows:

AppName

This attribute specifies the name of a TimesTen application managed by Oracle Clusterware. Oracle Clusterware uses the application name to name the corresponding resource. Any description of an application in the cluster.oracle.ini file must begin with this attribute.

Setting

Set AppName as follows:

AppRestartAttempts

This attribute specifies the number of times that Oracle Clusterware attempts to restart the TimesTen application on the current host before moving the application to another host.

Setting

Set AppRestartAttempts as follows:

AppRestartAttempts=30

AppStartCmd

This attribute specifies the command line that starts the TimesTen application specified by AppName. It must include the full path name of the executable. If there are spaces in the path name, enclose the path name in double quotes.

Setting

Set AppStartCmd as follows:

Examples

On UNIX:

AppCheckCmd=/mycluster/reader/app_start.sh start

On Windows:

AppCheckCmd="C:\Program Files\UserApps\UpdateApp.exe" -dsn myDSN -start

AppStopCmd

This attribute specifies the command line that stops the TimesTen application specified by AppName. It must include the full path name of the executable. If there are spaces in the path name, enclose the path name in double quotes.

Setting

Set AppStopCmd as follows:

Examples

On UNIX:

AppCheckCmd=/mycluster/reader/app_stop.sh stop

On Windows:

AppCheckCmd="C:\Program Files\UserApps\UpdateApp.exe" -dsn myDSN -stop

AppType

This attribute determines the hosts on which the TimesTen application should start.

Setting

Set AppType as follows:

AppUptimeThreshold

This attribute specifies the value for the Oracle Clusterware UPTIME_THRESHOLD resource attribute.The value represents the number of seconds that a TimesTen application must be up before Oracle Clusterware considers the application to be stable.

For more information about UPTIME_THRESHOLD, see Oracle Clusterware Administration and Deployment Guide.

AppUptimeThreshold=60

CacheConnect

If the active standby pair replicates cache groups, set this attribute to Y. If you specify Y, Oracle Clusterware assumes that TimesTen is connected to an Oracle database and prompts for the Oracle password.

Setting

Set CacheConnect as follows:

GridPort

This attribute lists the port numbers used by the cache grid agents for the active database and the standby database in an active standby pair that is a cache grid member. The port numbers are separated by a comma. This is a mandatory parameter when global cache groups are present.

Setting

Set GridPort as follows

MasterVIP

This attribute is a list of the two virtual IP (VIP) addresses associated with two master databases. This is used for advanced availability. This attribute is required if you intend to use virtual IP addresses.

Setting

Set MasterVIP as follows:

RemoteSubscriberHosts

This attribute contains a list of subscriber hosts that are part of the active standby pair replication scheme but are not managed by Oracle Clusterware.

Setting

Set RemoteSubscriberHosts as follows:

RepBackupDir

This attribute indicates the directory where the backup of the active database is stored. This must be a directory in a shared file system that every node in the cluster can access. This attribute is required only if RepBackupPeriod is set to a value other than 0.

On UNIX, the directory must be a shared partition that is shared by all hosts in the cluster. On UNIX platforms, the partition must be NFS or OCFS (Oracle Cluster File System). On Windows, it must be an OCFS partition.

If you want to enable backup, install OCFS on the shared storage during the Oracle Clusterware installation process. You can use this shared storage for backup for an active standby pair.

See "Recovering from permanent failure of both master nodes" and "Failure and recovery for active standby pair grid members" for restrictions on backups.

Setting

Set RepBackupDir as follows:

SubscriberHosts

Lists the host names that can contain subscriber databases. If virtual IP addresses are used, this list can overlap with the master host list provided by the MasterHosts attribute.

If the active standby pair is configured with subscribers, this attribute is required. It has no default value.

Setting

Set SubscriberHosts as follows:

SubscriberVIP

This attribute is a list of the virtual IP addresses associated with the subscriber databases. This is used for advanced availability. This attribute is required if you intend to use virtual IP addresses.

Setting

Set SubscriberVIP as follows:

VIPInterface

This attribute is the name of the public network adapter used for virtual IP addresses on each host. This attribute is required if you intend to use virtual IP addresses.

Setting

Set VIPInterface as follows:

VIPNetMask

This attribute is the netmask of the virtual IP addresses. This attribute is required if you intend to use virtual IP addresses.

Setting

Set VIPNetMask as follows:

Optional attributes

These attributes are optional and have no default values. The optional attributes are listed in Table 8-3, "Optional attributes" and described in detail in this section.

AppFailoverDelay

This attribute specifies the number of seconds that the process that is monitoring the application waits after a failure is detected before performing a failover. The default is 0.

Setting

Set AppFailoverDelay as follows:

AppFailureThreshold

This attribute specifies the number of consecutive failures that Oracle Clusterware tolerates for the action script for an application within an interval equal to 10 * AppScriptTimeout. The default is 2.

Setting

Set AppFailureThreshold as follows:

AppScriptTimeout

This attribute indicates the number of seconds that the TimesTen application monitor process waits for the start action script and the stop action script to complete for a specific application. The check action script has a nonconfigurable timeout of five seconds and is not affected by this attribute.

Setting

Set AppScriptTimeout as follows:

AutoRecover

Specifies whether Oracle Clusterware automatically recovers the active database from the backup in the case of a failure of both masters.

If recovery is not automated (AutoRecover=N), the database can be recovered using the ttCWAdmin -restore command.

You cannot use AutoRecover if you are using cache groups in your configuration or if a cache grid is configured.

Setting

Set AutoRecover as follows:

DatabaseFailoverDelay

This attributes specifies the number of seconds that Oracle Clusterware waits before migrating a database to a new host after a failure. Oracle Clusterware does not relocate a database if the database comes up during the delay period. This is applicable when advanced availability is configured. The default is 60 seconds.

Setting

Set DatabaseFailoverDelay as follows:

FailureThreshold

This attribute specifies the number of consecutive failures of resources managed by Oracle Clusterware that are tolerated within 10 seconds before the active standby pair is considered failed and a new active standby pair is created on spare hosts using the automated backup. A spare node is only an option when using virtual IP addresses.

Oracle Clusterware tries to perform a duplicate for the active standby pair when a single failure occurs; it tries to perform a restoration if more than a single failure occurs.

This value is ignored for basic availability, since a spare node is only configured when at least one virtual IP address is configured, or is ignored when RepBackupPeriod is set to 0 when using advanced availability, which does include the configuration of at least one virtual IP address.

Setting

Set FailureThreshold as follows:

MasterStoreAttribute

This attribute indicates the desired replication scheme STORE attributes for the master databases. The STORE attributes apply to both the active and standby databases. The STORE clause for replication schemes is defined in Oracle TimesTen In-Memory Database SQL Reference.

This attribute is not required when RepDDL is configured.

If this attribute is not set, the STORE attributes take their default values. See "Setting STORE attributes".

Setting

Set MasterStoreAttribute as follows:

RepBackupPeriod

This attribute indicates the number of seconds between each backup of the active database. If this attribute is set to a value greater than 0, you must also specify a backup directory by setting RepBackupDir.

See "Recovering from permanent failure of both master nodes" and "Failure and recovery for active standby pair grid members" for restrictions on backups.

Setting

Set RepBackupPeriod as follows:

RepDDL

This attribute represents the SQL statement that creates the active standby pair. Use this attribute only in special circumstances. For example, you must specify RepDDL if you need to exclude tables and sequences from the active standby pair.

If RepDDL is set, do not set these attributes:

• ReturnServiceAttribute

• MasterStoreAttribute

• SubscriberStoreAttribute

Replace the database file name prefix in the SQL statement with the <DSN> macro. Use the <MASTERHOST[1]>, <MASTERHOST[2]> and <SUBSCRIBERHOST[n]> macros instead of the host names.

There is no default value for RepDDL.

This example sets RepDDL for two master databases:

RepDDL=CREATE ACTIVE STANDBY PAIR <DSN> ON <MASTERHOST[1]>, <DSN> ON <MASTERHOST[2]>

See "Using the RepDDL attribute" for additional examples.

You do not usually need to set the ROUTE clause in RepDDL because the transmitter of the replication agent automatically obtains the private and public network interfaces that Oracle Clusterware uses. However, if hosts have network connectivity for replication schemes that are not managed by Oracle Clusterware, then RepDDL needs to include the ROUTE clause.

If this attribute is used, each STORE clause must be followed by the pseudo host names such as:

• ActiveHost

• ActiveVIP

• StandbyHost

• StandbyVIP

• SubscriberHost

• SubscriberVIP

Setting

Set RepDDL as follows:

RepFullBackupCycle

This attribute specifies the number of incremental backups between full backups. The number of incremental backups depends on the capacity of the shared storage.

Setting this attribute can impact performance. There is a trade-off between the storage capacity and the time consumption for backup. An incremental backup can be performed much faster than a full backup. However, storage consumption increases until a full backup is performed.

See "Recovering from permanent failure of both master nodes" and "Failure and recovery for active standby pair grid members" for restrictions on backups.

Setting

Set RepFullBackupCycle as follows:

ReturnServiceAttribute

This attribute specifies the return service for the active standby replication scheme. See "Using a return service".

If no value is specified for this attribute, the active standby pair is configured with no return service.

Setting

Set ReturnServiceAttribute as follows:

SubscriberStoreAttribute

This attribute indicates the replication scheme STORE attributes of subscriber databases. The STORE attributes apply to all subscribers. The STORE clause for replication schemes is defined in Oracle TimesTen In-Memory Database SQL Reference.

This attribute is not required when RepDDL is present.

If this attribute is not set, the STORE attributes take their default values. See "Setting STORE attributes".

Setting

Set SubscriberStoreAttribute as follows:

TimesTenScriptTimeout

This attribute specifies the number of seconds that Oracle Clusterware waits for the monitor process to start before assuming a failure.

Oracle TimesTen recommends setting a value of several hours because the action script may take a long time to duplicate the active database. The default is 1209600 seconds (14 days).

Setting

Set TimesTenScriptTimeout as follows: