Skip to ContentSun and Oracle Channel Sun How to Buy Log In

Sun Cluster Data Services Developer's Guide for Solaris OS

View this book in:

Contained Within

Find More Documentation

Featured Support Resources

Download this book in PDF (1615 KB)

Appendix A Standard Properties

This appendix describes the standard resource type, resource, and resource group properties. This appendix also describes the resource property attributes that are available for changing system-defined properties and creating extension properties.

Note –

Property names for resource types, resources, and resource groups are not case sensitive. You can use any combination of uppercase and lowercase letters when you specify property names.

This appendix covers the following topics:

Resource Type Properties

The following information describes the resource type properties that are defined by the Sun Cluster software. The property values are categorized as follows:

Required. The property requires an explicit value in the Resource Type Registration (RTR) file. Otherwise, the object to which the property belongs cannot be created. A space or the empty string is not allowed as a value.
Conditional. To exist, the property must be declared in the RTR file. Otherwise, the RGM does not create the property and the property is not available to administrative utilities. A space or the empty string is allowed. If the property is declared in the RTR file but no value is specified, the RGM supplies a default value.
Conditional or Explicit. To exist, the property must be declared in the RTR file with an explicit value. Otherwise, the RGM does not create the property and the property is not available to administrative utilities. A space or the empty string is not allowed.
Optional. The property can be declared in the RTR file. If the property is not declared in the RTR file, the RGM creates it and supplies a default value. If the property is declared in the RTR file but no value is specified, the RGM supplies the same default value as if the property was not declared in the RTR file.
Query-only – Cannot be set directly by an administrative tool.

Resource type properties cannot be updated by administrative utilities with the exception of Installed_nodes and RT_system, which cannot be declared in the RTR file and must be set by the cluster administrator.

Property names are shown first, followed by a description.

Note –

Resource type property names, such as API_version and Boot, are not case sensitive. You can use any combination of uppercase and lowercase letters when you specify property names.

API_version (integer)

The minimum version of the resource management API that is required to support this resource type implementation.

The following information summarizes the maximum API_version that is supported by each release of Sun Cluster.

Before and up to 3.1: 2
3.1 10/03: 3
3.1 4/04: 4
3.1 9/04: 5
3.1 8/05: 6

Declaring a value for API_version that is greater than 2 in the RTR file prevents that resource type from being installed on a version of Sun Cluster that supports a lower maximum version. For example, if you declare API_version=5 for a resource type, that resource type cannot be installed on any version of Sun Cluster that was released before 3.1 9/04.

Note –

If you do not declare this property or set this property to the default value (2), the data service can be installed on any version of Sun Cluster starting with Sun Cluster 3.0.

Category:: Optional
Default:: 2
Tunable:: NONE

Boot (string)

An optional callback method: the path to the program that the RGM runs on a node, which joins or rejoins the cluster when a resource of this type is already managed. This method initializes resources of this type as the Init method does.

Category:: Conditional or Explicit
Default:: No default
Tunable:: NONE

Failover (boolean)

TRUE indicates that resources of this type cannot be configured in any group that can be online on multiple nodes at the same time.

The following table shows how to use this resource type property in combination with the Scalable resource property.

Value of the `Failover` Resource Type	Value of the `Scalable` Resource	Description
`TRUE`	`TRUE`	Do not specify this illogical combination.
`TRUE`	`FALSE`	Specify this combination for a failover service.
`FALSE`	`TRUE`	Specify this combination for a scalable service that uses a `SharedAddress` resource for network load balancing. The Sun Cluster Concepts Guide for Solaris OS describes `SharedAddress` in more detail.
`FALSE`	`FALSE`	Although it is an unusual combination, you can use this combination to select a multi-master service that does not use network load balancing.

The description of Scalable in the r_properties(5) man page and Chapter 3, Key Concepts for System Administrators and Application Developers, in Sun Cluster Concepts Guide for Solaris OS contain additional information.

Category:: Optional
Default:: FALSE
Tunable:: NONE

Fini (string)

An optional callback method: the path to the program that the RGM runs when a resource of this type is removed from RGM management.

Category:: Conditional or Explicit
Default:: No default
Tunable:: NONE

Init (string)

An optional callback method: the path to the program that the RGM runs when a resource of this type becomes managed by the RGM.

Category:: Conditional or Explicit
Default:: No default
Tunable:: NONE

Init_nodes (enum)

Indicates the nodes on which the RGM is to call the Init, Fini, Boot, and Validate methods. The values can be RG_PRIMARIES (just the nodes that can master the resource) or RT_INSTALLED_NODES (all nodes on which the resource type is installed).

Category:: Optional
Default:: RG_PRIMARIES
Tunable:: NONE

Installed_nodes (string_array)

A list of the cluster node names on which the resource type can be run. The RGM automatically creates this property. The cluster administrator can set the value. You cannot declare this property in the RTR file.

Category:: Can be configured by the cluster administrator
Default:: All cluster nodes
Tunable:: ANYTIME

Is_logical_hostname (boolean

TRUE indicates that this resource type is some version of the LogicalHostname resource type that manages failover Internet Protocol (IP) addresses.

Category:: Query-only
Default:: No default
Tunable:: NONE

Is_shared_address (boolean)

TRUE indicates that this resource type is some version of the SharedAddress resource type that manages failover Internet Protocol (IP) addresses.

Category:: Query-only
Default:: No default
Tunable:: NONE

Monitor_check (string)

An optional callback method: the path to the program that the RGM runs before performing a monitor-requested failover of a resource of this type.

Category:: Conditional or Explicit
Default:: No default
Tunable:: NONE

Monitor_start (string)

An optional callback method: the path to the program that the RGM runs to start a fault monitor for a resource of this type.

Category:: Conditional or Explicit
Default:: No default
Tunable:: NONE

Monitor_stop (string)

A callback method that is required if Monitor_start is set: the path to the program that the RGM runs to stop a fault monitor for a resource of this type.

Category:: Conditional or Explicit
Default:: No default
Tunable:: NONE

Pkglist (string_array)

An optional list of packages that are included in the resource type installation.

Category:: Conditional or Explicit
Default:: No default
Tunable:: NONE

Postnet_stop (string)

An optional callback method: the path to the program that the RGM runs after calling the Stop method of any network-address resources on which a resource of this type depends. After the network interfaces are configured down, this method must perform Stop actions.

Category:: Conditional or Explicit
Default:: No default
Tunable:: NONE

Prenet_start (string)

An optional callback method: the path to the program that the RGM runs before the RGM calls the Start method of any network-address resources on which a resource of this type depends. This method performs Start actions that must be performed before network interfaces are configured.

Category:: Conditional or Explicit
Default:: No default
Tunable:: NONE

Resource_list (string_array)

The list of all resources of the resource type. The cluster administrator does not set this property directly. Rather, the RGM updates this property when the cluster administrator adds or removes a resource of this type to or from any resource group.

Category:: Query-only
Default:: Empty list
Tunable:: NONE

Resource_type (string)

The name of the resource type. To view the names of the currently registered resource types, use:

scrgadm -p

In Sun Cluster 3.1 and later releases, a resource type name includes the version, which is mandatory:

vendor-id.resource-type:rt-version

The three components of the resource type name are properties that are specified in the RTR file as vendor-id, resource-type, and rt-version. The scrgadm command inserts the period (.) and colon (:) delimiters. The rt-version suffix of the resource type name is the same value as the RT_version property. To ensure that the vendor-id is unique, use the stock symbol of the company that is creating the resource type. Resource type names that were created before Sun Cluster 3.1 continue to use the syntax:

vendor-id.resource-type

Category:: Required
Default:: Empty string
Tunable:: NONE

RT_basedir (string)

The directory path that is used to complete relative paths for callback methods. This path must be set to the directory in which the resource type packages are installed. The path must be a complete path, that is, it must start with a forward slash (/).

Category:: Required unless all method path names are absolute
Default:: No default
Tunable:: NONE

RT_description (string)

A brief description of the resource type.

Category:: Conditional
Default:: Empty string
Tunable:: NONE

RT_system (boolean)

If the RT_system property is TRUE for a resource type, you cannot delete the resource type (scrgadm -r -t resource-type-name). This property prevents the accidental deletion of resource types, such as LogicalHostname, that are used to support the cluster infrastructure. However, you can apply the RT_system property to any resource type.

To delete a resource type whose RT_system property is set to TRUE, you must first set the property to FALSE. Use care when you delete a resource type whose resources support cluster services.

Category:: Optional
Default:: FALSE
Tunable:: ANYTIME

RT_version (string)

Starting in Sun Cluster 3.1, a required version string of this resource type implementation. The RT_version is the suffix component of the full resource type name. The RT_version property, which was optional in Sun Cluster 3.0, is mandatory in Sun Cluster 3.1 and later releases.

Category:: Conditional/Explicit or Required
Default:: No default
Tunable:: NONE

Single_instance (boolean)

If TRUE, indicates that only one resource of this type can exist in the cluster. The RGM allows only one resource of this type to run cluster-wide at one time.

Category:: Optional
Default:: FALSE
Tunable:: NONE

Start (string)

A callback method: the path to the program that the RGM runs to start a resource of this type.

Category:: Required unless the RTR file declares a Prenet_start method
Default:: No default
Tunable:: NONE

Stop (string)

A callback method: the path to the program that the RGM runs to stop a resource of this type.

Category:: Required unless the RTR file declares a Postnet_stop method
Default:: No default
Tunable:: NONE

Update (string)

An optional callback method: the path to the program that the RGM runs when properties of a running resource of this type are changed.

Category:: Conditional or Explicit
Default:: No default
Tunable:: NONE

Validate (string)

An optional callback method: the path to the program that the RGM runs to check values for properties of resources of this type.

Category:: Conditional or Explicit
Default:: No default
Tunable:: NONE

Vendor_ID (string)

See the Resource_type property.

Category:: Conditional
Default:: No default
Tunable:: NONE

Resource Properties

This section describes the resource properties that are defined by the Sun Cluster software. The property values are categorized as follows:

Required. The cluster administrator must specify a value when he or she creates a resource with an administrative utility.
Optional. If the cluster administrator does not specify a value when he or she creates a resource group, the system supplies a default value.
Conditional. The RGM creates the property only if the property is declared in the RTR file. Otherwise, the property does not exist and is not available to cluster administrators. A conditional property that is declared in the RTR file is optional or required, depending on whether a default value is specified in the RTR file. For details, see the description of each conditional property.
Query-only. Cannot be set directly by an administrative tool.

The Tunable attribute, which is described in Resource Property Attributes, lists whether and when you can update resource properties, as follows:

FALSE or NONE: Never
TRUE or ANYTIME: Any time
AT_CREATION: When the resource is added to a cluster
WHEN_DISABLED: When the resource is disabled

Property names are shown first, followed by a description.

Affinity_timeout (integer)

Length of time in seconds during which connections from a given client IP address for any service in the resource are sent to the same server node.

This property is relevant only when Load_balancing_policy is either Lb_sticky or Lb_sticky_wild. In addition, Weak_affinity must be set to FALSE.

This property is only used for scalable services.

Category:: Optional
Default:: No default
Tunable:: ANYTIME

Boot_timeout for each callback method in the Type (integer)

A time lapse, in seconds, after which the RGM concludes that an invocation of this method has failed. For a given resource type, timeout properties are defined only for those methods that are declared in the RTR file.

Category:: Conditional or Optional
Default:: 3600 (one hour), if the method itself is declared in the RTR file
Tunable:: ANYTIME

Cheap_probe_interval (integer)

The number of seconds between invocations of a quick fault probe of the resource. This property is created by the RGM and is available to the cluster administrator only if it is declared in the RTR file. This property is optional if a default value is specified in the RTR file.

If the Tunable attribute is not specified in the RTR file, the Tunable value for the property is WHEN_DISABLED.

Category:: Conditional
Default:: No default
Tunable:: WHEN_DISABLED

Extension properties

Extension properties as declared in the RTR file of the resource's type. The implementation of the resource type defines these properties. Resource Property Attributes contains information about the individual attributes that you can set for extension properties.

Category:: Conditional
Default:: No default
Tunable:: Depends on the specific property

Failover_mode (enum)

Modifies the recovery actions that the RGM takes when a resource fails to start or to stop successfully, or when a resource monitor finds a resource to be unhealthy and consequently requests a restart or failover.

NONE, SOFT, or HARD (method failures)

These settings affect only failover behavior when a start or stop method (Prenet_start, Start, Monitor_stop, Stop, Postnet_stop) fails. Once the resource has started successfully, NONE, SOFT, and HARD have no effect on subsequent resource restart or giveover behavior that the resource monitor initiates with the scha_control command or the scha_control() function. See the scha_control(1HA) and the scha_control(3HA) man pages. NONE indicates that the RGM is not to take any recovery action when one of the previously listed start or stop methods fails. SOFT or HARD indicates that if a Start or Prenet_start method fails, the RGM is to relocate the resource's group to a different node. For Start or Prenet_start failures, SOFT and HARD are the same.

For failure of a stop method (Monitor_stop, Stop, or Postnet_stop), SOFT is the same as NONE. If Failover_mode is set to HARD when one of these stop methods fails, the RGM reboots the node to force the resource group offline. The RGM might then attempt to start the group on another node.

RESTART_ONLY or LOG_ONLY

Unlike NONE, SOFT, and HARD, which affect failover behavior when a start or stop method fails, RESTART_ONLY and LOG_ONLY affect all failover behavior. Failover behavior includes monitor-initiated (scha_control) restarts of resources and resource groups, and giveovers that are initiated by the resource monitor (scha_control). RESTART_ONLY indicates that the monitor can run scha_control to restart a resource or a resource group. The RGM allows Retry_count restarts within Retry_interval. If Retry_count is exceeded, no further restarts are permitted. If Failover_mode is set to LOG_ONLY, no resource restarts or giveovers are permitted. Setting Failover_mode to LOG_ONLY is the same as setting Failover_mode to RESTART_ONLY with Retry_count set to zero.

RESTART_ONLY or LOG_ONLY (method failures)

If a Prenet_start, Start, Monitor_stop, Stop, or Postnet_stop method fails, RESTART_ONLY and LOG_ONLY are the same as NONE. That is, the node is neither failed over nor rebooted.

Effect of Failover_mode settings on a data service

The effect that each setting for Failover_mode has on a data service depends on whether the data service is monitored or unmonitored and whether it is based on the Data Services Development Library (DSDL).

A data service is monitored if it implements a Monitor_start method and monitoring of the resource is enabled. The RGM starts a resource monitor by executing the Monitor_start method after starting the resource itself. The resource monitor probes the health of the resource. If the probes fail, the resource monitor might request a restart or a failover by calling the scha_control() function. For DSDL-based resources, probes might reveal partial failure (degradation) or a complete failure of the data service. Repeated partial failures accumulate to a complete failure.
A data service is unmonitored if it does not provide a Monitor_start method or monitoring of the resource has been disabled.
DSDL-based data services include those that are developed with Agent Builder, through the GDS, or by using the DSDL directly. Some data services, HA Oracle for example, were developed without using the DSDL.

NONE, SOFT, or HARD (probe failures)

If you set Failover_mode to NONE, SOFT, or HARD and the data service is a monitored DSDL-based service, and if the probe fails completely, the monitor calls the scha_control() function to request a restart of the resource. If probes continue to fail, the resource is restarted up to a maximum of Retry_count number of times within Retry_interval. If the probes fail again after the Retry_count number of restarts is reached, the monitor requests a failover of the resource's group to another node.

If you set Failover_mode to NONE, SOFT, or HARD and the data service is an unmonitored DSDL-based service, the only failure that is detected is the death of the resource's process tree. If the resource's process tree dies, the resource is restarted.

If the data service is a not a DSDL-based service, the restart or failover behavior depends on how the resource monitor is coded. For example, the Oracle resource monitor recovers by restarting the resource or the resource group, or by failing over the resource group.

RESTART_ONLY (probe failures)

If you set Failover_mode to RESTART_ONLY and the data service is a monitored DSDL-based service, and if the probe fails completely, the resource is restarted Retry_count times within Retry_interval. However, if Retry_count is exceeded, the resource monitor exits, sets the resource status to FAULTED, and generates the status message “Application faulted, but not restarted. Probe quitting.” At this point, although monitoring is still enabled, the resource is effectively unmonitored until it is repaired and restarted by the cluster administrator.

If you set Failover_mode to RESTART_ONLY and the data service is an unmonitored DSDL-based service, and if the process tree dies, the resource is not restarted.

If a monitored data service is not DSDL-based, the recovery behavior depends on how the resource monitor is coded. If you set Failover_mode to RESTART_ONLY, the resource or resource group can be restarted by a call to the scha_control() function Retry_count times within Retry_interval. If the resource monitor exceeds Retry_count, the attempt to restart fails. If the monitor calls the scha_control() function to request a failover, that request fails as well.

LOG_ONLY (probe failures)

If you set Failover_mode to LOG_ONLY for any data service, all scha_control() requests either to restart the resource or resource group or to fail over the group are precluded. If the data service is DSDL-based, a message is logged when a probe completely fails, but the resource is not restarted. If a probe fails completely more than Retry_count times within Retry_interval, the resource monitor exits, sets the resource status to FAULTED, and generates the status message “Application faulted, but not restarted. Probe quitting.” At this point, although monitoring is still enabled, the resource is effectively unmonitored until it is repaired and restarted by the cluster administrator.

If you set Failover_mode to LOG_ONLY and the data service is an unmonitored DSDL-based service, and if the process tree dies, a message is logged but the resource is not restarted.

If a monitored data service is not DSDL-based, the recovery behavior depends on how the resource monitor is coded. If you set Failover_mode to LOG_ONLY, all scha_control() requests either to restart the resource or resource group or to fail over the group fail.

Category:: Optional
Default:: NONE
Tunable:: ANYTIME

Fini_timeout for each callback method in the Type (integer)

Category:: Conditional or Optional
Default:: 3600 (one hour), if the method itself is declared in the RTR file
Tunable:: ANYTIME

Init_timeout for each callback method in the Type (integer)

Category:: Conditional or Optional
Default:: 3600 (one hour), if the method itself is declared in the RTR file
Tunable:: ANYTIME

Load_balancing_policy (string)

A string that defines the load-balancing policy in use. This property is used only for scalable services. The RGM automatically creates this property if the Scalable property is declared in the RTR file. Load_balancing_policy can take the following values:

Lb_weighted (the default). The load is distributed among various nodes according to the weights set in the Load_balancing_weights property.

Lb_sticky. A given client (identified by the client IP address) of the scalable service is always sent to the same node of the cluster.

Lb_sticky_wild. A given client's IP address that connects to an IP address of a wildcard sticky service is always sent to the same cluster node, regardless of the port number to which the IP address is coming.

Category:: Conditional or Optional
Default:: Lb_weighted
Tunable:: AT_CREATION

Load_balancing_weights (string_array)

For scalable resources only. The RGM automatically creates this property if the Scalable property is declared in the RTR file. The format is weight@node,weight@node, where weight is an integer that reflects the relative portion of load that is distributed to the specified node. The fraction of load that is distributed to a node is the weight for this node, divided by the sum of all weights. For example, 1@1,3@2 specifies that node 1 receives one-fourth of the load and node 2 receives three-fourths of the load. The empty string (“”), the default, sets a uniform distribution. Any node that is not assigned an explicit weight receives a default weight of 1.

If the Tunable attribute is not specified in the RTR file, the Tunable value for the property is ANYTIME. Changing this property revises the distribution for new connections only.

Category:: Conditional or Optional
Default:: The empty string (“”)
Tunable:: ANYTIME

Monitor_check_timeout for each callback method in the Type (integer)

Category:: Conditional or Optional
Default:: 3600 (one hour), if the method itself is declared in the RTR file
Tunable:: ANYTIME

Monitor_start_timeout for each callback method in the Type (integer)

Category:: Conditional or Optional
Default:: 3600 (one hour), if the method itself is declared in the RTR file
Tunable:: ANYTIME

Monitor_stop_timeout for each callback method in the Type (integer)

Category:: Conditional or Optional
Default:: 3600 (one hour), if the method itself is declared in the RTR file
Tunable:: ANYTIME

Monitored_switch (enum)

Set to Enabled or Disabled by the RGM if the cluster administrator enables or disables the monitor with an administrative utility. If Disabled, monitoring on the resource is stopped, although the resource itself remains online. The Monitor_start method is not called until monitoring is re-enabled. If the resource does not have a monitor callback method, this property does not exist.

Category:: Query-only
Default:: No default
Tunable:: NONE

Network_resources_used (string_array)

A list of logical host name or shared address network resources that are used by the resource. For scalable services, this property must refer to shared address resources that exist in a separate resource group. For failover services, this property refers to logical host name or shared address resources that exist in the same resource group. The RGM automatically creates this property if the Scalable property is declared in the RTR file. If Scalable is not declared in the RTR file, Network_resources_used is unavailable unless it is explicitly declared in the RTR file.

If the Tunable attribute is not specified in the RTR file, the Tunable value for the property is AT_CREATION.

Note –

The SUNW.Event(5) man page describes how to set up this property for the CRNP.

Category:: Conditional or Required
Default:: No default
Tunable:: AT_CREATION

Num_resource_restarts on each cluster node (integer)

You cannot directly set this property. This property is set by the RGM to the number of scha_control, Resource_restart, or Resource_is_restarted calls that have been made for this resource on this node within the past n seconds. n is the value of the Retry_interval property of the resource. The resource restart counter is reset to zero (0) by the RGM whenever a scha_control giveover is executed by this resource, whether the giveover attempt succeeds or fails.

If a resource type does not declare the Retry_interval property, the Num_resource_restarts property is not available for resources of that type.

Category:: Query-only
Default:: No default
Tunable:: NONE

Num_rg_restarts on each cluster node (integer)

You cannot directly set this property. This property is set by the RGM to the number of scha_control Restart calls that the resource has made for its containing resource group on this node within the past n seconds. n is the value of the Retry_interval property of the resource. If a resource type does not declare the Retry_interval property, the Num_rg_restarts property is not available for resources of that type.

Category:: See description
Default:: No default
Tunable:: NONE

On_off_switch (enum)

Set to Enabled or Disabled by the RGM if the cluster administrator enables or disables the resource with an administrative utility. If disabled, a resource is brought offline and has no callbacks run until it is re-enabled.

Category:: Query-only
Default:: No default
Tunable:: NONE

Port_list (string_array)

A list of port numbers on which the server is listening. Appended to each port number is a slash (/) followed by the protocol that is being used by that port, for example, Port_list=80/tcp or Port_list=80/tcp6,40/udp6. You can specify the following protocol values:

tcp, for TCP IPv4
tcp6, for TCP IPv6
udp, for UDP IPv4
udp6, for UDP IPv6

If the Scalable property is declared in the RTR file, the RGM automatically creates Port_list. Otherwise, this property is unavailable unless it is explicitly declared in the RTR file.

Setting up this property for Apache is described in the Sun Cluster Data Service for Apache Guide for Solaris OS.

Category:: Conditional or Required
Default:: No default
Tunable:: ANYTIME

Postnet_stop_timeout for each callback method in the Type (integer)

Category:: Conditional or Optional
Default:: 3600 (one hour), if the method itself is declared in the RTR file
Tunable:: ANYTIME

Prenet_start_timeout for each callback method in the Type (integer)

Category:: Conditional or Optional
Default:: 3600 (one hour), if the method itself is declared in the RTR file
Tunable:: ANYTIME

R_description (string)

A brief description of the resource.

Category:: Optional
Default:: The empty string
Tunable:: ANYTIME

Resource_dependencies (string_array)

A list of resources in the same or in different groups on which the Resource_dependencies resource has a strong dependency. This resource cannot be started if any resource in the list is not online. If this resource and one of the resources in the list start at the same time, the RGM waits to start this resource until the resource in the list starts. If the resource in this resource's Resource_dependencies list does not start, this resource remains offline. The resource in this resource's list might not start because the resource group for the resource in the list remains offline or is in a START_FAILED state. If this resource remains offline because of a dependency on a resource in a different resource group that fails to start, this resource's group enters a PENDING_ONLINE_BLOCKED state.

If this resource is brought offline at the same time as those resources in the list, this resource stops before those in the list. However, if this resource remains online or fails to stop, a resource in the list that is in a different resource group stops anyway. Resources in the list cannot be disabled unless this resource is disabled first.

By default in a resource group, application resources have an implicit strong resource dependency on network address resources. Implicit_network_dependencies in Resource Group Properties contains more information.

Within a resource group, Prenet_start methods are run in dependency order before Start methods. Postnet_stop methods are run in dependency order after Stop methods. In different resource groups, the dependent resource waits for the depended-on resource to finish Prenet_start and Start before it runs Prenet_start. The depended-on resource waits for the dependent resource to finish Stop and Postnet_stop before it runs Stop.

Category:: Optional
Default:: The empty list
Tunable:: ANYTIME

Resource_dependencies_restart (string_array)

A list of resources in the same or in different groups on which the Resource_dependencies_restart resource has a restart dependency.

This property works as Resource_dependencies does, with one exception. If any resource in the restart dependency list is restarted, this resource is restarted. The RGM restarts this resource after the resource in the list comes back online.

Category:: Optional
Default:: The empty list
Tunable:: ANYTIME

Resource_dependencies_weak (string_array)

A list of resources in the same or in different groups on which the Resource_dependencies_weak resource has a weak dependency. A weak dependency determines the order of method calls. The RGM calls the Start methods of the resources in this list before the Start method of this resource. The RGM calls the Stop methods of this resource before the Stop methods of those in the list. The resource can still start if those in the list fail to start or remain offline.

If this resource and a resource in its Resource_dependencies_weak list start concurrently, the RGM waits to start this resource until the resource in the list starts. If the resource in the list does not start, for example, if the resource group for the resource in the list remains offline or the resource in the list is in a START_FAILED state, this resource starts. This resource's resource group might enter a PENDING_ONLINE_BLOCKED state temporarily as resources in this resource's Resource_dependencies_weak list start. When all resources in the list have started or failed to start, this resource starts and its group reenters the PENDING_ONLINE state.

If this resource is brought offline at the same time as those in the list, this resource stops before those in the list. If this resource remains online or fails to stop, a resource in the list stops anyway. You cannot disable resources in the list unless this resource is disabled first.

Category:: Optional
Default:: The empty list
Tunable:: ANYTIME

Resource_name (string)

The name of the resource instance. This name must be unique within the cluster configuration and cannot be changed after a resource has been created.

Category:: Required
Default:: No default
Tunable:: NONE

Resource_project_name (string)

The Solaris project name that is associated with the resource. Use this property to apply Solaris resource management features, such as CPU shares and resource pools, to cluster data services. When the RGM brings resources online, it starts the related processes under this project name. If this property is not specified, the project name is taken from the RG_project_name property of the resource group that contains the resource (see the rg_properties(5) man page). If neither property is specified, the RGM uses the predefined project name default. The specified project name must exist in the projects database(see the projects(1) man page and System Administration Guide: Solaris Containers-Resource Management and Solaris Zones).

This property is only supported starting in Solaris 9.

Note –

Changes to this property take effect the next time that the resource is started.

Category:: Optional
Default:: Null
Tunable:: ANYTIME

Resource_state on each cluster node (enum)

The RGM-determined state of the resource on each cluster node. Possible states are ONLINE, OFFLINE, START_FAILED, STOP_FAILED, MONITOR_FAILED, ONLINE_NOT_MONITORED, STARTING, and STOPPING.

You cannot configure this property.

Category:: Query-only
Default:: No default
Tunable:: NONE

Retry_count (integer)

The number of times that a monitor attempts to restart a resource if it fails. If the Retry_count is exceeded, depending on the particular data service and the setting of the Failover_mode property, the monitor might perform one of the following actions:

Allow the resource group to remain on the current primary node, even though the resource is in a faulted state
Request a failover of the resource group onto a different node

This property is created by the RGM and is made available to the cluster administrator only if this property is declared in the RTR file. This property is optional if a default value is specified in the RTR file.

If the Tunable attribute is not specified in the RTR file, the Tunable value for the property is WHEN_DISABLED.

Note –

If you specify a negative value for this property, the monitor attempts to restart the resource an unlimited number of times.

Category:: Conditional
Default:: See above
Tunable:: WHEN_DISABLED

Retry_interval (integer)

The number of seconds over which to count attempts to restart a failed resource. The resource monitor uses this property in conjunction with Retry_count. This property is created by the RGM and is available to the cluster administrator only if it is declared in the RTR file. This property is optional if a default value is specified in the RTR file.

If the Tunable attribute is not specified in the RTR file, the Tunable value for the property is WHEN_DISABLED.

Category:: Conditional
Default:: No default (see above)
Tunable:: WHEN_DISABLED

Scalable (boolean)

Indicates whether the resource is scalable, that is, whether the resource uses the networking load-balancing features of the Sun Cluster software.

If this property is declared in the RTR file, the RGM automatically creates the following scalable service properties for resources of that type: Affinity_timeout, Load_balancing_policy, Load_balancing_weights, Network_resources_used, Port_list, UDP_affinity, and Weak_affinity. These properties have their default values unless they are explicitly declared in the RTR file. The default for Scalable, when it is declared in the RTR file, is TRUE.

If this property is declared in the RTR file, it cannot be assigned a Tunable attribute other than AT_CREATION.

If this property is not declared in the RTR file, the resource is not scalable, you cannot tune this property, and no scalable service properties are set by the RGM. However, you can explicitly declare the Network_resources_used and Port_list properties in the RTR file. These properties can be useful in a nonscalable service as well as in a scalable service.

Using this resource property in combination with the Failover resource type property is described in more detail in the r_properties(5) man page.

Category:: Optional
Default:: No default
Tunable:: AT_CREATION

Start_timeout for each callback method in the Type (integer)

Category:: Conditional or Optional
Default:: 3600 (one hour), if the method itself is declared in the RTR file
Tunable:: ANYTIME

Status on each cluster node (enum)

Set by the resource monitor with the scha_resource_setstatus command or the scha_resource_setstatus() function. Possible values are OK, degraded, faulted, unknown, and offline. When a resource is brought online or offline, the RGM automatically sets the Status value if the Status value is not set by the resource's monitor or methods.

Category:: Query-only
Default:: No default
Tunable:: NONE

Status_msg on each cluster node (string)

Set by the resource monitor at the same time as the Status property. When a resource is brought online or offline, the RGM automatically resets this property to the empty string if this property is not set by the resource's methods.

Category:: Query-only
Default:: No default
Tunable:: NONE

Stop_timeout for each callback method in the Type (integer)

Category:: Conditional or Optional
Default:: 3600 (one hour), if the method itself is declared in the RTR file
Tunable:: ANYTIME

Thorough_probe_interval (integer)

The number of seconds between invocations of a high-overhead fault probe of the resource. This property is created by the RGM and is available to the cluster administrator only if it is declared in the RTR file. This property is optional if a default value is specified in the RTR file.

If the Tunable attribute is not specified in the RTR file, the Tunable value for the property is WHEN_DISABLED.

Category:: Conditional
Default:: No default
Tunable:: WHEN_DISABLED

Type (string)

The resource type of which this resource is an instance.

Category:: Required
Default:: No default
Tunable:: NONE

Type_version (string)

Specifies which version of the resource type is currently associated with this resource. The RGM automatically creates this property, which cannot be declared in the RTR file. The value of this property is equal to the RT_version property of the resource's type. When a resource is created, the Type_version property is not specified explicitly, though it might appear as a suffix of the resource type name. When a resource is edited, the Type_version property can be changed to a new value.

The tunability of this property is derived from the following sources:

The current version of the resource type
The #$upgrade_from directive in the RTR file

Category:: See description
Default:: No default
Tunable:: See description

UDP_affinity (boolean)

If this property is set to TRUE, sends all UDP traffic from a given client to the same server node that currently handles all TCP traffic for the client.

This property is relevant only when Load_balancing_policy is either Lb_sticky or Lb_sticky_wild. In addition, Weak_affinity must be set to FALSE.

This property is only used for scalable services.

Category:: Optional
Default:: No default
Tunable:: WHEN_DISABLED

Update_timeout for each callback method in the Type (integer)

Category:: Conditional or Optional
Default:: 3600 (one hour), if the method itself is declared in the RTR file
Tunable:: ANYTIME

Validate_timeout for each callback method in the Type (integer)

Category:: Conditional or Optional
Default:: 3600 (one hour), if the method itself is declared in the RTR file
Tunable:: ANYTIME

Weak_affinity (boolean)

If this property is set to TRUE, this property enables the weak form of the client affinity. The weak form of the client affinity allows connections from a given client to be sent to the same server node except when the following conditions occur:

A server listener starts in response to, for example, a fault monitor's restarting, a resource's failing over or switching over, or a node's rejoining a cluster after failing
Load_balancing_weights for the scalable resource changes because the cluster administrator performed an administrative action

Weak affinity provides a low-overhead alternative to the default form, both in terms of memory consumption and processor cycles.

This property is relevant only when Load_balancing_policy is either Lb_sticky or Lb_sticky_wild.

This property is only used for scalable services.

Category:: Optional
Default:: No default
Tunable:: WHEN_DISABLED

Resource Group Properties

The following information describes the resource group properties that are defined by the Sun Cluster software. The property values are categorized as follows:

Required. The cluster administrator must specify a value when creating a resource group with an administrative utility.
Optional. If the cluster administrator does not specify a value when creating a resource group, the system supplies a default value.
Query-only. Cannot be set directly by an administrative tool.

Property names are shown first, followed by a description.

Auto_start_on_new_cluster (boolean)

This property controls whether the Resource Group Manager (RGM) starts the resource group automatically when a new cluster is forming. The default is TRUE.

If set to TRUE, the RGM attempts to start the resource group automatically to achieve Desired_primaries when all the nodes of the cluster are simultaneously rebooted.

If set to FALSE, the resource group does not start automatically when the cluster is rebooted. The resource group remains offline until the first time that the resource group is manually switched online by using the scswitch command or the equivalent GUI instruction. After that, the resource group resumes normal failover behavior.

Category:: Optional
Default:: TRUE
Tunable:: ANYTIME

Desired_primaries (integer)

The preferred number of nodes that the group can run on simultaneously.

The default is 1. If the RG_mode property is Failover, the value of this property must be no greater than 1. If the RG_mode property is Scalable, a value greater than 1 is allowed.

Category:: Optional
Default:: 1
Tunable:: ANYTIME

Failback (boolean)

A Boolean value that indicates whether to recalculate the set of nodes on which the group is online when the cluster membership changes. A recalculation can cause the RGM to bring the group offline on less preferred nodes and online on more preferred nodes.

Category:: Optional
Default:: FALSE
Tunable:: ANYTIME

Global_resources_used (string_array)

Indicates whether cluster file systems are used by any resource in this resource group. Legal values that the cluster administrator can specify are an asterisk (*) to indicate all global resources, and the empty string (“”) to indicate no global resources.

Category:: Optional
Default:: All global resources
Tunable:: ANYTIME

Implicit_network_dependencies (boolean)

A Boolean value that indicates, when TRUE, that the RGM should enforce implicit strong dependencies of nonnetwork address resources on network address resources within the group. This means that the RGM starts all network address resources before all other resources and stops network address resources after all other resources within the group. Network address resources include the logical host name and shared address resource types.

In a scalable resource group, this property has no effect because a scalable resource group does not contain any network address resources.

Category:: Optional
Default:: TRUE
Tunable:: ANYTIME

Maximum_primaries (integer)

The maximum number of nodes on which the group might be online at the same time.

If the RG_mode property is Failover, the value of this property must be no greater than 1. If the RG_mode property is Scalable, a value greater than 1 is allowed.

Category:: Optional
Default:: 1
Tunable:: ANYTIME

Nodelist (string_array)

A list of cluster nodes on which the group can be brought online in order of preference. These nodes are known as the potential primaries or masters of the resource group.

Category:: Optional
Default:: The list of all cluster nodes in arbitrary order
Tunable:: ANYTIME

Pathprefix (string)

A directory in the cluster file system in which resources in the group can write essential administrative files. Some resources might require this property. Make Pathprefix unique for each resource group.

Category:: Optional
Default:: The empty string
Tunable:: ANYTIME

Pingpong_interval (integer)

A nonnegative integer value (in seconds) that is used by the RGM to determine where to bring the resource group online in these instances:

In the event of a reconfiguration
As the result of the execution of a scha_control GIVEOVER command or function

In the event of a reconfiguration, the resource group might fail more than once to come online within the past Pingpong_interval seconds on a particular node. This failure occurs because the resource's Start or Prenet_start method exited with a nonzero status or timed out. As a result, that node is considered ineligible to host the resource group, and the RGM looks for another master.

If a scha_control command or scha_control GIVEOVER command is executed on a given node by a resource, thereby causing its resource group to fail over to another node, the first node (on which scha_control was run) cannot be the destination of another scha_control GIVEOVER by the same resource until Pingpong_interval seconds have elapsed.

Category:: Optional
Default:: 3600 (one hour)
Tunable:: ANYTIME

Resource_list (string_array)

The list of resources that are contained in the group. The cluster administrator does not set this property directly. Rather, the RGM updates this property as the cluster administrator adds or removes resources from the resource group.

Category:: Query-only
Default:: No default
Tunable:: NONE

RG_affinities (string)

The RGM is to try to locate a resource group on a node that is a current master of another given resource group (positive affinity) or that is not a current master of a given resource group (negative affinity).

You can set RG_affinities to the following strings:

++, or strong positive affinity
+, or weak positive affinity
-, or weak negative affinity
--, or strong negative affinity
+++, or strong positive affinity with failover delegation

For example, RG_affinities=+RG2,--RG3 indicates that this resource group has a weak positive affinity for RG2 and a strong negative affinity for RG3.

Using RG_affinities is described in Chapter 2, Administering Data Service Resources.

Category:: Optional
Default:: The empty string
Tunable:: ANYTIME

RG_dependencies (string_array)

Optional list of resource groups that indicates a preferred ordering for bringing other groups online or offline on the same node. The graph of all strong RG_affinities (positive and negative) together with RG_dependencies is not allowed to contain cycles.

For example, suppose that resource group RG2 is listed in the RG_dependencies list of resource group RG1, that is, RG1 has a resource group dependency on RG2. The following list summarizes the effects of this resource group dependency:

When a node joins the cluster, Boot methods on that node are not run on resources in RG1 until all Boot methods on that node have completed on resources in RG2.
If RG1 and RG2 are both in the PENDING_ONLINE state on the same node at the same time, the starting methods (Prenet_start or Start) are not run on any resources in RG1 until all the resources in RG2 have completed their starting methods.
If RG1 and RG2 are both in the PENDING_OFFLINE state on the same node at the same time, the stopping methods (Stop or Postnet_stop) are not run on any resources in RG2 until all the resources in RG1 have completed their stopping methods.
An attempt to switch the primaries of RG1 or RG2 fails if switching the primaries would leave RG1 online on any node and RG2 offline on all nodes. The scswitch(1M) and scsetup(1M) man pages contain more information.
Setting the Desired_primaries property to a value that is greater than zero on RG1 is not permitted if Desired_primaries is set to zero on RG2.
Setting the Auto_start_on_new_cluster property to TRUE on RG1 is not permitted if Auto_start_on_new_cluster is set to FALSE on RG2.

Category:: Optional
Default:: The empty list
Tunable:: ANYTIME

RG_description (string)

A brief description of the resource group.

Category:: Optional
Default:: The empty string
Tunable:: ANYTIME

RG_is_frozen (boolean)

A Boolean value that indicates whether a global device on which a resource group depends is being switched over. If this property is set to TRUE, the global device is being switched over. If this property is set to FALSE, no global device is being switched over. A resource group depends on global devices as indicated by its Global_resources_used property.

You do not set the RG_is_frozen property directly. The RGM updates the RG_is_frozen property when the status of the global devices changes.

Category:: Optional
Default:: No default
Tunable:: NONE

RG_mode (enum)

Indicates whether the resource group is a failover or a scalable group. If the value is Failover, the RGM sets the Maximum_primaries property of the group to 1 and restricts the resource group to being mastered by a single node.

If the value of this property is Scalable, the RGM allows the Maximum_primaries property to be set to a value that is greater than 1. As a result, the group can be mastered by multiple nodes simultaneously. The RGM does not allow a resource whose Failover property is TRUE to be added to a resource group whose RG_mode is Scalable.

If Maximum_primaries is 1, the default is Failover. If Maximum_primaries is greater than 1, the default is Scalable.

Category:: Optional
Default:: Depends on the value of Maximum_primaries
Tunable:: NONE

RG_name (string)

The name of the resource group. This property is required and must be unique within the cluster.

Category:: Required
Default:: No default
Tunable:: NONE

RG_project_name (string)

The Solaris project name (see the projects(1) man page) that is associated with the resource group. Use this property to apply Solaris resource management features, such as CPU shares and resource pools, to cluster data services. When the RGM brings resource groups online, it starts the related processes under this project name for resources that do not have the Resource_project_name property set (see the r_properties(5) man page). The specified project name must exist in the projects database (see the projects(1) man page and System Administration Guide: Solaris Containers-Resource Management and Solaris Zones).

This property is only supported starting in Solaris 9.

Note –

Changes to this property take affect the next time that the resource is started.

Category:: Optional
Default:: The text string “default”
Tunable:: ANYTIME

RG_state on each cluster node (enum)

Set by the RGM to UNMANAGED, ONLINE, OFFLINE, PENDING_ONLINE, PENDING_OFFLINE, ERROR_STOP_FAILED, ONLINE_FAULTED, or PENDING_ONLINE_BLOCKED to describe the state of the group on each cluster node.

You cannot configure this property. However, you can indirectly set this property by running the scswitch command or by using the equivalent scsetup or SunPlex Manager commands. A group can exist in an UNMANAGED state when that group is not under the control of the RGM.

The following descriptions summarize each state.

Note –

States apply to individual nodes only, except the UNMANAGED state, which applies across all nodes. For example, a resource group might be OFFLINE on node A, but PENDING_ONLINE on node B.

UNMANAGED

The initial state of a newly created resource group, or the state of a previously managed resource group. Either Init methods have not yet been run on resources in the group, or Fini methods have been run on resources in the group.

The group is not managed by the RGM.

ONLINE

The resource group has been started on the node. In other words, the starting methods Prenet_start, Start, and Monitor_start, as applicable to each resource, have executed successfully on all enabled resources in the group.

OFFLINE

The resource group has been stopped on the node. In other words, the stopping methods Monitor_stop, Stop, and Postnet_stop, as applicable to each resource, have executed successfully on all enabled resources in the group. This state also applies before a resource group has started for the first time on the node.

PENDING_ONLINE

The resource group is starting on the node. The starting methods Prenet_start, Start, and Monitor_start, as applicable to each resource, are being executed on enabled resources in the group.

PENDING_OFFLINE

The resource group is stopping on the node. The stopping methods Monitor_stop, Stop, and Postnet_stop, as applicable to each resource, are being executed on enabled resources in the group.

ERROR_STOP_FAILED

One or more resources within the resource group failed to stop successfully and are in the Stop_failed state. Other resources in the group might remain online or offline. This resource group is not permitted to start on any node until the ERROR_STOP_FAILED state is cleared.

You must use an administrative command, such as scswitch -c, to manually kill the Stop_failed resource and reset its state to OFFLINE.

ONLINE_FAULTED

The resource group was PENDING_ONLINE and has finished starting on this node. However, one or more resources ended up in the Start_failed state or with Faulted status.

PENDING_ONLINE_BLOCKED

The resource group failed to start fully because one or more resources within that resource group have an unsatisfied strong resource dependency on a resource in a different resource group. Such resources remain OFFLINE. When the resource dependencies are satisfied, the resource group automatically moves back to the PENDING_ONLINE state.

Category:: Query-only
Default:: No default
Tunable:: NONE

RG_system (boolean)

If the RG_system property is TRUE for a resource group, particular operations are restricted for the resource group and for the resources that the resource group contains. This restriction is intended to help prevent accidental modification or deletion of critical resource groups and resources. Only the scrgadm and scswitch commands are affected by this property. Operations for scha_control(1HA) and scha_control(3HA) are not affected.

Before performing a restricted operation on a resource group (or a resource group's resources), you must first set the RG_system property of the resource group to FALSE. Use care when you modify or delete a resource group that supports cluster services, or when you modify or delete the resources that such a resource group contains.

Operation	Example
Delete a resource group	`scrgadm -r -g RG1`
Edit a resource group property (except for `RG_system`)	`scrgadm -c -t RG1 -y nodelist=...`
Add a resource to a resource group	`scrgadm -a -j R1 -g RG1`
Delete a resource from a resource group	`scrgadm -r -j R1 -g RG1`
Edit a property of a resource that belongs to a resource group	`scrgadm -c -j R1`
Switch a resource group offline	`scswitch -F -g RG1`
Manage a resource group	`scswitch -o -g RG1`
Unmanage a resource group	`scswitch -u -g RG1`
Enable a resource	`scswitch -e -j R1`
Enable monitoring for a resource	`scswitch -e -M -j R1`
Disable a resource	`scswitch -n -j R1`
Disable monitoring for a resource	`scswitch -n -M -j R1`

If the RG_system property is TRUE for a resource group, the only property of the resource group that you can edit is the RG_system property itself. In other words, editing the RG_system property is never restricted.

Category:: Optional
Default:: FALSE
Tunable:: ANYTIME

Resource Property Attributes

This section describes the resource property attributes that you can use to change system-defined properties or to create extension properties.

Caution –

You cannot specify Null or the empty string (“”) as the default value for boolean, enum, or int types.

Property names are shown first, followed by a description.

Array_maxsize

For stringarray type, the maximum number of array elements that are permitted.

Array_minsize

For stringarray type, the minimum number of array elements that are permitted.

Default

Indicates a default value for the property.

Description

A string annotation that is intended to be a brief description of the property. The Description attribute cannot be set in the RTR file for system-defined properties.

Enumlist

For an enum type, a set of string values that are permitted for the property.

Extension

If used, indicates that the RTR file entry declares an extension property that is defined by the resource type implementation. Otherwise, the entry is a system-defined property.

Max

For an int type, the maximum value that is permitted for the property.

Maxlength

For string and stringarray types, the maximum string length that is permitted.

Min

For an int type, the minimal value that is permitted for the property.

Minlength

For string and stringarray types, the minimum string length that is permitted.

Property

The name of the resource property.

Tunable

Indicates when the cluster administrator can set the value of this property in a resource. Set to NONE or FALSE to prevent the cluster administrator from setting the property. Values that enable a cluster administrator to tune a property are TRUE or ANYTIME (at any time), AT_CREATION (only when the resource is created), or WHEN_DISABLED (when the resource is disabled). To establish other conditions, such as “when monitoring is disabled” or “when offline”, set this attribute to ANYTIME and validate the state of the resource in the Validate method.

The default differs for each standard resource property, as shown in the following entry. The default setting for tuning an extension property, if not otherwise specified in the RTR file, is TRUE (ANYTIME).

Type of the property

Allowable types are string, boolean, integer, enum, and stringarray. You cannot set the type attribute in an RTR file entry for system-defined properties. The type determines acceptable property values and the type-specific attributes that are allowed in the RTR file entry. An enum type is a set of string values.