# Properties Tables

> Resource Type Properties Table
> Resource Properties Table
> Resource Group Properties Table
> Resource Property Attributes Table

## Resource Type Properties

Resource type 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 blank or empty string is not allowed.

> Conditional -- To exist, the property must be declared in the RTR file. Otherwise, the Resource Group Manager does not create the property. The property is also not available to administrative utilities. A blank or empty string is allowed. If the property is declared in the RTR file but no value is specified, the Resource Group Manager supplies a default value.

> Conditional/Explicit -- To exist, the property must be declared in the RTR file with an explicit value. Otherwise, the Resource Group Manager does not create the property. The property is also not available to administrative utilities. A blank or empty string is not allowed.

> Optional -- The property can be declared in the RTR file. If the property is not declared, the Resource Group Manager creates the property and supplies a default value. If the property is declared in the RTR file, but no value is specified, the Resource Group Manager supplies a default value. This default value is the same value that is used when the property is not declared in the RTR file.

> You cannot use administrative utilities to update resource type properties, excluding
> Installed_nodes
> , which cannot be declared in the RTR file. An administrator must set
> Installed_nodes
> .

## Resource Type Properties

Property Name | Description
--- | ---
Allow_hosts (string array) | Controls the set of clients that are allowed to register with the cl_apid daemon to receive cluster reconfiguration events. The general form of this property is ipaddress/masklength , which defines a subnet from which the clients are allowed to register. For example, the setting 129.99.77.0/24 allows clients on the subnet 129.99.77 to register for events. As another example, 192.9.84.231/32 allows only the client 192.9.84.231 to register for events. This property provides security to the CRNP. The cl_apid daemon is described in SUNW.Event (5) man page. In addition, the following special keywords are recognized. LOCAL refers to all clients that are located in directly connected subnets of the cluster. ALL allows all clients to register. Note that if a client matches an entry in both the Allow_hosts and the Deny_hosts property, that client is prevented from registering with the implementation. Category: Optional Default: LOCAL Tunable: Never
API_version (integer) | The version of the resource management API used by this resource type implementation. Category: Optional Default: 2 Tunable: Never
Boot (string) | An optional callback method: the path to the program that the Resource Group Manager invokes on a node. This node joins or rejoins the cluster when a resource of this type is already managed. This method is expected to initialize resources of this type that is similar to the Init method. Category: Conditional/Explicit Default: No default Tunable: Never
Client_retry_count (integer) | Controls the number of attempts made by the cl_apid daemon while communicating with external clients. If a client fails to respond within Client_retry_count attempts, the client times out. The client is subsequently removed from the list of registered clients that are eligible to receive cluster reconfiguration events. The client must re-register in order to start receiving events again. See the description of the Client_retry_interval property to learn more about how often these retries are made by the implementation. The cl_apid daemon is described in SUNW.Event (5). Category: Optional Default: 3 Tunable: Any time
Client_retry_interval (integer) | Defines the time period (in seconds) used by the cl_apid daemon while communicating with unresponsive external clients. Up to Client_retry_count attempts are made during this interval to contact the client. The cl_apid daemon is described in SUNW.Event (5). Category: Optional Default: 1800 Tunable: Any time
Client_timeout (integer) | The time-out value (in seconds) that is used by the cl_apid daemon while communicating with external clients. However, the cl_apid daemon continues to attempt to contact the client for a tunable number of times. See the descriptions of the Client_retry_count and Client_retry_interval properties to learn more about the means that you can use to tune this property. The cl_apid daemon is described in SUNW.Event (5). Category: Optional Default: 60 Tunable: Any time
Deny_hosts (string array) | Controls the set of clients that are prevented from registering to receive cluster reconfiguration events. To determine access, the settings of this property take precedence over those in the Allow_hosts list. The format of this property is the same as the format that is defined in the Allow_hosts property. This property provides security to the CRNP. Category: Optional Default: NULL Tunable: Any time
Failover (Boolean) | True indicates that resources of this type cannot be configured in any group that can be online on multiple nodes at once. Category: Optional Default: False Tunable: Never
Fini (string) | An optional callback method: the path to the program that the Resource Group Manager invokes when a resource of this type is removed from the Resource Group Manager's control. Category: Conditional/Explicit Default: No default Tunable: Never
Init (string) | An optional callback method: the path to the program that the Resource Group Manager invokes when a resource of this type becomes managed by the Resource Group Manager. Category: Conditional/Explicit Default: No default Tunable: Never
Init_nodes (enum) | Indicates the nodes on which the Resource Group Manager 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: Never
Installed_nodes (string array) | A list of the cluster node names on which the resource type is allowed to be run. The Resource Group Manager 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: Any time
Max_clients (integer) | Controls the maximum number of clients that can register with the cl_apid daemon to receive notification of cluster events. Attempts by additional clients to register for events are rejected by your application. Since each client registration uses resources on the cluster, tuning this property allows users to control resource usage on the cluster by external clients. The cl_apid daemon is described in SUNW.Event (5). Category: Optional Default: 1000 Tunable: Any time
Monitor_check (string) | An optional callback method: the path to the program that the Resource Group Manager invokes before doing a monitor-requested failover of a resource of this type. Category: Conditional/Explicit Default: No default Tunable: Never
Monitor_start (string) | An optional callback method: the path to the program that the Resource Group Manager invokes to start a fault monitor for a resource of this type. Category: Conditional/Explicit Default: No default Tunable: Never
Monitor_stop (string) | A callback method that is required if Monitor_start is set, or the path to the program that the Resource Group Manager invokes to stop a fault monitor for a resource of this type. Category: Conditional/Explicit Default: No default Tunable: Never
Num_resource_restarts on each cluster node (integer) | This property is set by the RGM to the number of scha_control RESTART calls that have been made for this resource on this node within the past [n] seconds, where [n] is the value of the Retry_interval property of the resource. If a resource type does not declare the Retry_interval property, then the Num_resource_restarts property is not available for resources of that type. Category: Query-only Default: No default Tunable: Never
Pkglist (string array) | An optional list of packages that are included in the resource type installation. Category: Conditional/Explicit Default: No default Tunable: Never
Postnet_stop (string) | An optional callback method: the path to the program that the Resource Group Manager invokes after calling the Stop method of any network-address resources ( Network_resources_used ) on which a resource of this type depends. This method is expected to perform Stop actions that must be completed after the network interfaces are configured to go down. Category: Conditional/Explicit Default: No default Tunable: Never
Prenet_start (string) | An optional callback method, or the path to the program that the Resource Group Manager invokes before calling the Start method of any network-address resources ( Network_resources_used ) on which a resource of this type depends. This method is expected to perform Start actions that must be completed before network interfaces are configured to go up. Category: Conditional/Explicit Default: No default Tunable: Never
Resource_type (string) | The name of the resource type. To view the names of the currently registered resource types, use this command: scrgadm -p Starting in Sun Cluster 3.1, the syntax of a resource type name is: [vendor_id].[resource_type]:[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 Vendor_id is unique, use the stock market symbol for the company that is creating the resource type. Note: The syntax of a resource type name that you created before the release of Sun Cluster 3.1 continues to be as follows: [vendor_id].[resource_type] Category: Required Default: Empty string Tunable: Never
RT_basedir (string) | The directory path that is used to complete relative paths for callback methods. Set this path to the directory where the resource type packages are located. This path must be a complete path that begins with a forward slash ( / ). Category: Required, unless all method path names are absolute Default: No default Tunable: Never
RT_description (string) | A brief description of the resource type. Category: Conditional Default: Empty string Tunable: Never
RT_system (Boolean) | Indicates, when set to True on a resource type, that the permitted scrgadm (1M) operations on that resource type are restricted. A resource type whose RT_System value is set to True is called a system resource type. Editing the RT_System property itself is never restricted, regardless of the current value of RT_System . Category: Optional Default: False Tunable: Any time
RT_version (string) | Starting in Sun Cluster 3.1, a required version string of this resource type implementation. RT_version is the suffix component of the full resource type name. Category: Conditional/Explicit Default: No default Tunable: Never
Single_instance (Boolean) | If True , indicates that only one resource of this type can exist in the cluster. Hence, the Resource Group Manager allows only one resource of this type to run cluster-wide at one time. Category: Optional Default: False Tunable: Never
Start (string) | A callback method: the path to the program that the Resource Group Manager invokes to start a resource of this type. Category: Required (unless the RTR file declares a Prenet_start method) Default: No default Tunable: Never
Stop (string) | A callback method: the path to the program that the Resource Group Manager invokes to stop a resource of this type. Category: Required (unless the RTR file declares a Postnet_stop method) Default: No default Tunable: Never
Update (string) | An optional callback method: the path to the program that the Resource Group Manager invokes when properties of a running resource of this type are changed. Category: Conditional/Explicit Default: No default Tunable: Never
Validate (string) | An optional callback method: the path to the program that is invoked to check values for properties of resources of this type. Category: Conditional/Explicit Default: No default Tunable: Never
Vendor_ID (string) | See the Resource_type property. Category: Conditional Default: No default Tunable: Never

Return to top

## Resource Properties

These descriptions have been developed for data service developers.

For more information about a particular data service, see that data service's man page. Resource property values are categorized as follows:

> Required -- The administrator must specify a value when creating a resource with an administrative utility.

> Optional -- If the administrator does not specify a value when creating a resource group, the system supplies a default value.

> Conditional -- The Resource Group Manager creates the property only if the property is declared in the RTR file. Otherwise, the property does not exist. The property is also not available to system administrators. A conditional property that is declared in the RTR file is optional or required. Whether a conditional property is optional or required depends on whether or not a default value is specified in the RTR file. The description of each conditional property contains details.

> Query-only -- Cannot be set directly by an administrative tool. Query-only values include

> None or False | Never
> True or Anytime | Any time
> At_creation | When the resource is added to a cluster
> When_disabled | When the resource is disabled

## Resource Properties

Property Name | Description
--- | ---
Affinity_timeout (integer) | Controls the number of seconds IP affinity lasts after a client closes all its connections to sticky scalable service. Before this timeout period expires, any new connection from the client is forwarded to the same cluster node. A 0 value means affinity lasts for as long as there is a connection between a client and the scalable service. The value -1 means that affinity lasts until the cluster node to which the client is bound crashes or reboots. So, no timeout period applies. This property only applies to resources with Load_balancing_policy = Lb_sticky or Lb_sticky_wild . Category: Optional Default: 0 Tunable: Any time
Cheap_probe_interval (integer) | The number of seconds between invocations of a quick fault probe of the resource. This property is only created by the Resource Group Manager. If this property is declared in the RTR file, this property is available to the administrator. This property is optional if a default value is specified in the RTR file. If the Tunable attribute is not specified in the resource type file, the Tunable value for the property is When_disabled . This property is required if the Default attribute is not specified in the property declaration in the RTR file. Category: Conditional Default: See the preceding description 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. For information on the individual attributes you can set for extension properties, see Resource Property Attributes. Category: Conditional Default: No default Tunable: Depends on the specific property
Failover_mode (enum) | Possible settings are None, Soft, and Hard. Controls whether the RGM relocates a resource group or aborts a node in response to a failure of a Start , Stop , or Monitor_stop method call on the resource. None indicates that the RGM should just set the resource state on method failure and wait for operator intervention. Soft indicates that failure of a Start method should cause the RGM to relocate the resource's group to a different node while failure of a Stop or Monitor_stop method should cause the RGM to set the resource to STOP_FAILED state and the resource group to ERROR_STOP_FAILED state and wait for operator intervention. For Stop or Monitor_stop failures, the None and Soft settings are equivalent. Hard indicates that failure of a Start method should cause the relocation of the group and failure of a Stop or Monitor_stop method should cause the forcible stop of the resource by aborting the cluster node. Category: Optional Default: None Tunable: Any time
Load_balancing_policy (string) | A string that defines the load-balancing policy in use. This property is used only for scalable services. The Resource Group Manager 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's IP address) of the scalable service is always sent to the same node of the cluster. Lb_sticky_wild . A given client (identified by the client's IP address), which 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 it is directed. Category: Conditional/Optional Default: Lb_weighted Tunable: At creation
Load_balancing_weights (string array) | For scalable resources only. The Resource Group Manager automatically creates this property if the Scalable property is declared in the RTR file. The format is [weight]@[node], [weight]@[node], where [weight] represents an integer that reflects the relative portion of load distributed to the specified [node]. The fraction of load 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 1/4 of the load and node 2 receives 3/4. 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 resource type file, the Tunable value for the property is Anytime . Changing this property revises the distribution for new connections only. Category: Conditional/Optional Default: Empty string Tunable: Any time
[method] _timeout for each callback method in Type (integer) | A time lapse, in seconds, after which the Resource Group Manager concludes that an invocation of the method has failed. Category: Conditional/Optional Default: 3,600 seconds, or one hour, if the method is declared in the RTR file Tunable: Any time
Monitored_switch (enum) | Set to Enabled or Disabled by the Resource Group Manager if the cluster administrator enables or disables the monitor with an administrative utility. If Disabled , the monitor does not have its Start method called until it is enabled again. If the resource does not have a monitor callback method, this property does not exist. Category:Query-only Default: Enabled Tunable: Never
Network_resources_used (string array) | A list of logical host name or shared address network resources 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 resource type file, the Tunable value for the property is At_creation . Category: Conditional/Required Default: No default Tunable: At creation
On_off_switch (enum) | Set to Enabled or Disabled by the Resource Group Manager if the cluster administrator enables or disables the resource with an administrative utility. If disabled, a resource has no callbacks invoked until it is enabled again. Category: Query-only Default: Disabled Tunable: Never
Port_list (string array) | A comma-separated list of port numbers on which the server is listening. Appended to each port number is the protocol being used by that port, for example, Port_list=80/tcp . If the Scalable property is declared in the RTR file, the Resource Group Manager automatically creates Port_list . Otherwise, this property is unavailable unless it is explicitly declared in the RTR file. For specifics on setting up this property for Apache, see the Apache chapter in the Sun Cluster 3.1 Data Services Installation and Configuration Guide. Category: Conditional/Required Default: No default Tunable: At creation
R_description (string) | A brief description of the resource. Category: Optional Default: Empty string Tunable: Any time
Resource_dependencies (string array) | A list of resources in the same or in different groups upon which this resource has a strong dependency. This resource cannot be started if the start of any resource in the list fails. If this resource and one of the resources in its list start at the same time, the RGM waits until the resource in the list starts before the RGM starts this resource. If the resource in this resource's Resource_dependencies list does not start (for example, if the resource group for the resource in the list remains offline or if the resource in the list is in a Start_failed state), this resource also remains offline. 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 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 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 to finish Stop and Postnet_stop before it runs Stop . Category: Optional Default: Empty list Tunable: Any time
Resource_dependencies_restart (string array) | A list of resources in the same or in different groups upon which this resource has a restart dependency. This resource cannot be started if the start of any resource in its list fails. If this resource and one of the resources in its list start at the same time, the RGM waits until the resource in the list starts before the RGM starts this resource. If the resource in this resource's Resource_dependencies_restart list does not start--for example, if the resource group for the resource in the list remains offline or if the resource in the list is in a Start_failed state--this resource remains offline. 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 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. This property works just as Resource_dependencies does, except that, if any resource in the restart dependency list is restarted, this resource is restarted. The restart of this resource occurs after the resource in the list comes back online. 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 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 to finish Stop and Postnet_stop before it runs Stop . Category: Optional Default: Empty list Tunable: Any time
Resource_dependencies_weak (string array) | A list of resources in the same or in different groups upon which this resource has a weak dependency. A weak dependency determines the order of method calls within the group. 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 until the resource in the list starts before the RGM starts this resource. 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 the 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 re-enters the Pending_online state. If this resource is brought offline when those in the list are, 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. 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 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 to finish Stop and Postnet_stop before it runs Stop . Category: Optional Default: Empty list Tunable: Any time
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: Never
Resource_project_name (string) | The Solaris project name 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 Resource Group Manager brings resources online, the Resource Group Manager launches 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 ( rg_properties (5) contains more information). If neither property is specified, the Resource Group Manager uses the predefined project name default. The specified project name must exist in the projects database and the user root must be configured as a member of the named project. Support for this property began in the Solaris 9 release. Note: Changes to this property take effect after the resource has been restarted. Category: Optional Default: Null Tunable: Any time
Resource_state on each cluster node (enum) | The state that is determined by the Resource Group Manager of the resource on each cluster node. Possible states are Online , Offline , Stop_failed , Start_failed , Monitor_failed , and Online_not_monitored . You cannot configure this property. Category: Query-only Default: No default Tunable: Never
Retry_count (integer) | The number of times a monitor attempts to restart a resource if the resource fails. This property is created by the Resource Group Manager only. If declared in the RTR file, this property is available to the administrator. This property is optional if a default value is specified in the RTR file. If the Tunable attribute is not specified in the resource type file, the Tunable value for the property is When_disabled . This property is required if the Default attribute is not specified in the property declaration in the RTR file. Category: Conditional Default: See description 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 Resource Group Manager only. If declared in the RTR file, this property is available to the administrator. This property is optional if a default value is specified in the RTR file. If the Tunable attribute is not specified in the resource type file, the Tunable value for the property is When_disabled . This property is required if the Default attribute is not specified in the property declaration in the RTR file. Category: Conditional Default: See the preceding description Tunable: When disabled
Scalable (Boolean) | Indicates whether the resource is scalable. If this property is declared in the RTR file, the Resource Group Manager automatically creates the following scalable service properties for resources of that type: Network_resources_used , Port_list , Load_balancing_policy , and Load_balancing_weights . 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 . When this property is declared in RTR file, the Tunable attribute must be set to At_creation or resource creation fails. If this property is not declared in the RTR file: The resource is not scalable The cluster administrator cannot tune this property No scalable service properties are set by the Resource Group Manager However, you can explicitly declare the Network_resources_used and Port_list properties in the RTR file, if desired, because these properties can be useful in a non-scalable service as well as in a scalable service. Category: Optional Default: See the preceding description Tunable: At creation
Status on each cluster node (enum) | Set by the resource monitor. Possible values are OK , degraded , faulted , unknown , and offline . The Resource Group Manager sets the value to unknown when the resource is brought online and to Offline when it is brought offline. Category: Query-only Default: No default Tunable: Never
Status_msg on each cluster node (string) | Set by the resource monitor at the same time as the Status property. This property is tunable per resource, per node. The Resource Group Manager sets this property to the empty string when the resource is brought offline. Category: Query-only Default: No default Tunable: Never
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 Resource Group Manager only. If declared in the RTR file, this property is available to the administrator. This property is optional if a default value is specified in the RTR file. If the Tunable attribute is not specified in the resource type file, the Tunable value for the property is When_disabled . This property is required if the Default attribute is not specified in the property declaration in the RTR file. Category: Conditional Default: No default Tunable: When disabled
Type (string) | An instance's resource type. Category: Required Default: No default Tunable: Never
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 may appear as a suffix of the resource type name. When a resource is edited, the Type_version may be changed to a new value. Its tunability is derived from: 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 True , UDP packets from a given client are forwarded to the same cluster server node the same way TCP connections are forwarded. If a client's TCP connections are "stuck" with a server node, its UDP packets are sent to that node as well. If False , this behavior is not maintained, and UDP packets from a given client could end up on a different node than TCP connections from that client. This property only applies to resources with Load_balancing_policy = Lb_sticky or Lb_sticky_wild . Category: Optional Default: False Tunable: When disabled
Weak_affinity (Boolean) | If true, enable the weak form of the client affinity. This allows connections from a given client to be sent to the same server node except: When a server listener starts up, for example, due to a fault monitor restarts, a resource failover or switchover, or a node rejoining a cluster after failing. When Load_balancing_weights for the scalable resource changes due to an administration 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

Return to top

## Resource Group Properties

Resource group property values are categorized as shown in the following table:

## Resource Group Properties

Property Name | Description
--- | ---
Auto_start_on_new_cluster (Boolean) | This property disallows automatic startup of the resource group when a new cluster is forming. If set to True , the Resource Group Manager attempts to start the resource group automatically to achieve Desired_primaries when the cluster is rebooted. If set to False , the resource group does not start automatically when the cluster reboots. Category: Optional Default: True Tunable: Any time
Desired_primaries (integer) | The number of nodes on which the group can run 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 , see description Tunable: Any time
Failback (Boolean) | A Boolean value that indicates whether to recalculate the set of nodes where the group is online when the cluster membership changes. A recalculation can cause the Resource Group Manager to bring the group offline on less preferred nodes and online on more preferred nodes. Category: Optional Default: False Tunable: Any time
Global_resources_used (string array) | Indicates whether cluster file systems are used by any resource in this resource group. Legal values that the 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: Any time
Implicit_network_dependencies (Boolean) | A Boolean value that indicates, when True , that the Resource Group Manager is to enforce implicit strong dependencies of non-network-address resources on network-address resources within the group. As a result, the Resource Group Manager 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 network-address resources. Category: Optional Default: True Tunable: When disabled
Maximum_primaries (integer) | The maximum number of nodes where the group might be online at once. 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 , see description Tunable: Any time
Nodelist (string array) | A comma-separated list of cluster nodes where the group can be brought online in order of preference. These nodes are known as the potential primaries or the masters of the resource group. Category: Optional Default: The list of all cluster nodes in arbitrary order Tunable: Any time
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: Empty string Tunable: Any time
Pingpong_interval (integer) | A non-negative integer value (in seconds) used by the RGM to determine where to bring the resource group online in the event of a reconfiguration or as the result of a scha_control -O GIVEOVER command or scha_control function with the SCHA_GIVEOVER argument being executed. In the event of a reconfiguration, if the resource group fails to come online more than once within the past Pingpong_interval seconds on a particular node (because the resource's Start or Prenet_start method exited non-zero or timed out), that node is considered ineligible to host the resource group and the RGM looks for another master. If a call to a resource's scha_control command or scha_control function causes the resource group to be brought offline on a particular node within the past Pingpong_interval seconds, that node is ineligible to host the resource group as the result of a subsequent call to scha_control originating from another node. Category: Optional Default: 3600 (one hour) Tunable: Any time
Resource_list (string array) | The list of resources that are contained in the group. The administrator does not set this property directly. Rather, the Resource Group Manager updates this property when the administrator adds or removes resources from the resource group. Category: Query-only Default: Empty list Tunable: Never
RG_Affinities (string) | The RGM is to try to locate this resource group on a node that is a current master of another given resource group (positive affinity), or to locate this resource group on a node that is not a current master of a given resource group (negative affinity). Settings include: ++, or strong positive +, or weak positive -, or weak negative - -, or strong negative Strong affinities are strictly enforced. This resource group is never brought online, nor allowed to remain online, on a node on which a resource group in the list is not online (strong positive affinity) or offline (strong negative affinity). In other words, this resource group automatically "follows" a group for which it has a strong positive affinity, and automatically "moves away from" a group for which it has a strong negative affinity. If there is no node on which its strong affinities can be satisfied (based on the current state of other resource groups), this group remains offline. If other resource groups' states change so that this group's strong affinities can again be satisfied, this group automatically comes back online. The graph of all strong RG_affinities (positive and negative) together with RG_dependencies is not allowed to contain cycles. Weak affinities are satisfied on a "best effort" basis and are not strictly enforced. When this resource group is brought online (for example, after a failover), the RGM attempts to choose a node that satisfies the greatest number of its weak affinities. Weak affinities take precedence over the Nodelist preference ordering. The weak affinities of this group do not cause it to change nodes in response to the movement of other groups. Cycles are permitted in the graph of weak RG_affinities . Note: Use caution when listing more than one strong affinity in RG_affinities of a given resource group. If all declared strong affinities cannot be satisfied, the group remains offline. Category: Optional Default: Empty string Tunable: Any time
RG_dependencies (string array) | Optional list of resource groups that indicate 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. In other words, suppose that 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 any 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 will fail 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: Empty list Tunable: Any time
RG_description (string) | A brief description of the resource group. Category: Optional Default: Empty string Tunable: Any time
RG_mode (enum) | Indicates whether the resource group is a failover or scalable group. If the value is Failover , the Resource Group Manager 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 Resource Group Manager allows the Maximum_primaries property to have a value greater than 1 . This value indicates that the group can be mastered by multiple nodes simultaneously. Note: The Resource Group Manager does not allow a resource whose Failover property is True to be added to a resource group whose RG_mode is Scalable . Category: Optional Default: Failover if Maximum_primaries is 1 ; Scalable if Maximum_primaries is greater than 1 Tunable: Never
RG_name (string) | The name of the resource group. This property is required. Also, this property must be unique within the cluster. Category: Required Default: No default Tunable: Never
RG_project_name (string) | The Solaris project name 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 launches the related processes under this project name for resources that do not have the Resource_project_name property set. The specified project name must exist in the projects database and the user root must be configured as a member of the named project. This property is only supported starting in Solaris 9. Note: Changes to this property take effect after the resource has been restarted. Category: Required Default: No default Tunable: Any time
RG_state on each cluster node (enum) | Set by the RGM to Online , Offline , Pending_online , Pending_offline , Pending_online_blocked , Error_stop_failed , or Online_faulted to describe the state of the group on each cluster node. This property is not user configurable. However, you can indirectly set this property by invoking scswitch (1M) (or by using the equivalent scsetup (1M) or SunPlex Manager commands). Category: Query-only Default: Offline Tunable: Never
RG_system (Boolean) | A Boolean value that indicates, when set to True on a resource group, that the permitted scrgadm (1M) and scswitch (1M) operations on that resource group are restricted. Also, some operations are restricted if the resources in that resource group have an RG_System value that is set to True . A resource group whose RG_System value is set to True is called a system resource group. Editing the RG_System property itself is never restricted, regardless of the current value of RG_System . The rg_properties (5) man page describes these restrictions in more detail. Category: Optional Default: False Tunable: Any time

Return to top

## Resource Property Attributes

Resource property attributes describe the attributes that can be used to change system-defined properties or create extension properties.

|  | You cannot specify NULL or the empty string ("") as the default value for boolean , enum , or int types.

## Resource Property Attributes

Property Name | Description
--- | ---
Property | The name of the resource property.
Extension | If used, indicates that the RTR file entry declares an extension property defined by the resource type implementation. Otherwise, the entry is a system-defined property.
Description | A string annotation intended to be a brief description of the property. The description attribute cannot be set in the RTR file for system-defined properties.
Type of the property | Allowable types are string , boolean , int , 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. The enum type is a set of string values.
Default | Indicates a default value for the property.
Tunable | Indicates when the cluster administrator can set the value of this property in a resource. Can be set to None or False to prevent the administrator from setting the property. Values that allow administrator tuning are True or Anytime (at any time), At_creation (only when the resource is created), or When_disabled (when the resource is offline). The default is True ( Anytime ).
Enumlist | For an enum type, a set of string values permitted for the property.
Min | For an int type, the minimal value permitted for the property.
Max | For an int type, the maximum value permitted for the property.
Minlength | For string and stringarray types, the minimum string length permitted.
Maxlength | For string and stringarray types, the maximum string length permitted.
Array_minsize | For stringarray type, the minimum number of array elements permitted.
Array_maxsize | For stringarray type, the maximum number of array elements permitted.

Return to top