Oracle Solaris Cluster Generic Data Service (GDS) Guide

Exit Print View

Updated: July 2014, E48652-01
 
 

Optional GDS Properties

Optional GDS properties include both system-defined properties and extension properties. System-defined properties are a standard set of properties that are provided by Oracle Solaris Cluster. Properties that are defined in the RTR file are called extension properties.

    Optional GDS properties include:

  • Child_mon_level extension property (used only with administration commands)

  • Failover_enabled extension property

  • Log_level extension property

  • Monitor_retry_count extension property

  • Monitor_retry_interval extension property

  • Network_aware extension property

  • Network_resources_used property

  • Probe_command extension property

  • Probe_timeout extension property

  • Start_timeout property

  • Stop_command extension property

  • Stop_signal extension property

  • Stop_timeout property

  • Validate_command extension property

  • Validate_timeout property

Child_mon_level Property


Note -  If you use Oracle Solaris Cluster administration commands, you can use the Child_mon_level property. If you use Agent Builder, you cannot use this property.

This property provides control over the processes that are monitored through the Process Monitor Facility (PMF). This property denotes the level up to which the forked children processes are monitored. This property works like the –C argument to the pmfadm command. See the pmfadm (1M) man page.

Omitting this property, or setting it to the default value of -1, has the same effect as omitting the –C option on the pmfadm command. That is, all children and their descendants are monitored.

Failover_enabled Property

This property controls the failover behavior of the resource. If this extension property is set to TRUE, the application fails over when the number of restarts exceeds the Retry_count within the Retry_interval number of seconds.

If this property is set to FALSE, the application does not restart or fail over to another node when the number of restarts exceeds the Retry_count within the Retry_interval number of seconds.

You can use this property to prevent the application resource from initiating a failover of the resource group. The default value for this property is TRUE.


Note -  In future, use the Failover_mode property in place of the Failover_enabled extension property as Failover_mode better controls failover behavior. For more information, see the descriptions of the LOG_ONLY and RESTART_ONLY values for Failover_mode in the r_properties (5) man page.

Log_level Property

This property specifies the level, or type, of diagnostic messages that are logged by the GDS. You can specify NONE, INFO, or ERR for this property. When you specify NONE, diagnostic messages are not logged by the GDS. When you specify INFO, only informational messages are logged. When you specify ERR, only error messages are logged. By default, the GDS does not log diagnostic messages (NONE).

Monitor_retry_count Property

This property specifies the number of times that the process monitor facility (PMF) restarts the fault monitor during the time window that the Monitor_retry_interval property specifies. This property refers to restarts of the fault monitor itself rather than to the resource. The system-defined properties Retry_interval and Retry_count control restarting of the resource.

Monitor_retry_interval Property

This property specifies the time (in minutes) over which failures of the fault monitor are counted. If the number of times that the fault monitor fails exceeds the value that is specified in the extension property Monitor_retry_count within this period, the PMF does not restart the fault monitor.

Network_aware Property

This property specifies whether your application uses the network. By default, the GDS assumes that your application is network aware, that is, uses the network (Network_aware is set to TRUE).

If your application is network aware, you must provide both the Start_command extension property and the Port_list property. If your application is non-network aware, you must provide only the Start_command extension property.

Network_resources_used Property

This property specifies a list of logical host name or shared address network resources that are used by a resource. The default value for this property is the empty list. You must specify this property if the application needs to bind to one or more specific addresses. If you omit this property or you specify Null, the application listens on all addresses.

Before you create the GDS resource, a LogicalHostname or SharedAddress resource must already be configured. See the Oracle Solaris Cluster Data Services Planning and Administration Guide for information about how to configure a LogicalHostname or SharedAddress resource.

To specify a value, specify one or more resource names. Each resource name can contain one or more LogicalHostname resources or one or more SharedAddress resources. See the r_properties (5) man page for details.

Probe_command Property

This property specifies the probe command that periodically checks the health of a given application. This command must be a UNIX command with arguments that can be passed directly to a shell to probe the application. The probe command returns with an exit status of 0 if the application is running correctly.

The exit status of the probe command is used to determine the severity of the application's failure. This exit status, called the probe status, must be an integer between 0 (for success) and 100 (for complete failure). The probe status can also be a special value of 201, which causes the application to immediately fail over unless Failover_enabled is set to FALSE. The GDS probing algorithm uses the probe status to determine whether to restart the application locally or fail it over. See the scds_fm_action (3HA) man page for more information. If the exit status is 201, the application is immediately failed over.

If the probe command is omitted, the GDS provides its own simple probe. This probe connects to the application on the set of IP addresses that is derived from the Network_resources_used property or from the output of the scds_get_netaddr_list() function. See the scds_get_netaddr_list (3HA) man page for more information. If the connect succeeds, the connect disconnects immediately. If both the connect and disconnect succeed, the application is deemed to be running well.


Note -  The probe that is provided with the GDS is only intended to be a simple substitute for the fully functioning application-specific probe.

Probe_timeout Property

This property specifies the timeout value for the probe command. See Probe_command Property for additional information. The default for Probe_timeout is 30 seconds.

Start_timeout Property

This property specifies the start timeout for the start command. See Start_command Property for additional information. The default for Start_timeout is 300 seconds.

Stop_command Property

This property specifies the command that must stop an application and only return after the application has been completely stopped. This command must be a complete UNIX command that can be passed directly to a shell to stop the application.

If the Stop_command extension property is provided, the GDS stop method starts the stop command with 80 percent of the stop timeout. Regardless of the outcome of starting the stop command, the GDS stop method sends SIGKILL with 15 percent of the stop timeout. The remaining 5 percent of the time is reserved for housekeeping overhead.

If the stop command is omitted, the GDS tries to stop the application by using the signal specified in Stop_signal.

Stop_signal Property

This property specifies a value that identifies the signal to stop an application through the PMF. See the signal (3HEAD) man page for a list of the integer values that you can specify. The default value is 15 (SIGTERM).

Stop_timeout Property

This property specifies the timeout for the stop command. See Stop_command Property for additional information. The default for Stop_timeout is 300 seconds.

Validate_command Property

This property specifies the absolute path to a command to invoke to validate the application. If you do not provide an absolute path, the application is not validated.

Validate_timeout Property

This property specifies the timeout for the validate command. See Validate_command Property for additional information. The default for Validate_timeout is 300 seconds.