Go to main content

Reference for Oracle Solaris Cluster 4.4

Exit Print View

Updated: August 2018
 
 

ORCL.gds_proxy (7)

Name

ORCL.gds_proxy, gds_proxy - proxy resource type to reflect the state of a resource from another cluster framework or an application within the same or different cluster

Description

The Generic Data Service (GDS) Version 2 is a mechanism that enables you to proxy the state of an application or resource from another cluster framework (for example, Oracle Grid Infrastructure). You can also proxy the state of an application within the same cluster or a different cluster.

The GDSv2 contains a fully functional Oracle Solaris Cluster resource type, complete with callback methods (rt_callbacks(8HA)) and a Resource Type Registration (RTR) file (rt_reg(5)).

Standard Properties

Boot_timeout (integer)

Specifies the timeout value, in seconds, for the boot command.

Category

Optional

Minimum

60 seconds

Default

300 seconds

Tunable

Any time

Failover_mode (enum)

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

For more information on the failover_mode property, see the r_properties(7) man page.

Category

Optional

Default

SOFT

Tunable

Any time

Fini_timeout (integer)

Specifies the timeout value, in seconds, for the fini command.

Category

Optional

Minimum

60 seconds

Default

300 seconds

Tunable

Any time

Init_timeout (integer)

Specifies the timeout value, in seconds, for the init command.

Category

Optional

Minimum

60 seconds

Default

300 seconds

Tunable

Any time

Postnet_stop_timeout (integer)

Specifies the timeout value, in seconds, for the postnet_stop command.

Category

Optional

Minimum

60 seconds

Default

300 seconds

Tunable

Any time

Prenet_start_timeout (integer)

Specifies the timeout value, in seconds, for the prenet_start command.

Category

Optional

Minimum

60 seconds

Default

300 seconds

Tunable

Any time

Scalable (boolean)

Indicates whether the resource is scalable, which means that the resource uses the networking load balancing features of Oracle Solaris Cluster software.

If the scalable property is set to TRUE, then additional properties such as load_balancing_policy and load_balancing_weights are used to configure the load balancing behavior.

For more information on the scalable, load_balancing_policy, and load_balancing_weights properties, see the r_properties(7) man page.

Category

Optional

Default

FALSE

Tunable

At creation

Validate_timeout (integer)

Specifies the timeout value, in seconds, for the validate command.

Category

Optional

Minimum

60 seconds

Default

300 seconds

Tunable

Any time

Extension Properties

Boot_command (string)

Specifies the command that is run when the node has been booted or rebooted. This command must be a complete command line that can be passed directly to a shell. The command normally performs the same initialization as the init_command. You must ensure that the command is idempotent -- even if the command has initialized the resource during a previous execution, subsequent calls to the command must exit successfully.

Category

Optional

Default

Null

Tunable

When disabled

Child_mon_level (integer)

Provides control over the processes that are monitored through the Process Monitor Facility (PMF). This property denotes the level to which the forked children processes are monitored. Omitting this property or setting this property to the default value is the same as omitting the –C option for pmfadm(8): all children (and their descendents) are monitored.

Category

Optional

Default

-1

Tunable

At creation

Debug_gds (boolean)

Debug_gds is typically used by Oracle Solaris Cluster development and support. However, it can be useful to understand the various calls and sequences that occur within GDSv2.

If debug_gds=FALSE is set, no GDSv2 internal debug messages are sent to the system log.

If debug_gds=TRUE is set, all GDSv2 internal debug messages are sent to the system log.

Category

Optional

Default

TRUE

Tunable

When disabled

Debug_level (string)

Specifies the command that sets up trace and debug messages. Increasing the debug_level allows more messages to be written to the system-log. You can set debug_level as a per-node extension property by setting it for one node or different values for each node.

Category

Optional

Per Node

True

Data Type

Integer

Minimum

0

Maximum

3

Default

0

Tunable

Any time

Fini_command (string)

Specifies the command that is run when the resource is no longer managed by the RGM. This command must be a complete command line that can be passed directly to a shell. The command normally performs some cleanup or undoes any initializations that were performed by the init_command. The command is run on the node where the resource becomes unmanaged when the following situations occur:

  • The resource group that contains the resource is switched to an unmanaged state. In this case, the RGM executes the GDSv2 fini method which executes the fini_command on all nodes in the node list.

  • The resource is deleted from a managed resource group. In this case, the RGM executes the GDSv2 fini method which executes the fini_command on all nodes in the node list.

  • A node is deleted from the node list of the resource group that contains the resource. In this case, the RGM executes the GDSv2 fini method which executes the fini_command on all nodes in the node list.

Category

Optional

Default

Null

Tunable

When disabled

Init_command (string)

Specifies the command that is run when the resource becomes managed by the RGM as a result of one of the following conditions. This command must be a complete command line that can be passed directly to a shell.

  • The resource group in which the resource is located is switched from the unmanaged to a managed state.

  • The resource is created in a resource group that is already managed.

Category

Optional

Default

Null

Tunable

When disabled

Interpose_logical_hostname (string)

Specifies the logical host name to interpose whenever a system call to retrieve the hostname is made. The logical host is interposed as long as the following has been done:

  • The clreslogicalhostname(8CL) command has created a resource for the logical host name.

  • Your resource has a dependency on the logical host resource, if the logical host is in a different resource group from your resource.

  • /usr/lib/secure/libschost.so.1 must be symbolically linked to /usr/cluster/lib/libschost.so.1.

  • /usr/lib/secure/64/libschost.so.1 must be symbolically linked to /usr/cluster/lib/[amd64|sparcv9]/libschost.so.1.

Category

Optional

Per Node

TRUE

Default

Null

Tunable

When disabled

Postnet_stop_command (string)

Specifies the command that stops the prenet_start_command proxy daemon. This command must be a complete command line that can be passed directly to a shell to start the proxy daemon.

If postnet_stop_command is omitted, the stop_signal extension property value is sent to the proxy daemon processes running under the PMF flag.

Category

Optional

Default

Null

Tunable

When disabled

Prenet_start_command (string)

Specifies the command that starts the proxy daemon. This command must be a complete command line that can be passed directly to a shell to start the proxy daemon.

The prenet_start_command (or one of its forked children) is expected to be a long-running daemon. The prenet_start_command process tree is monitored by the PMF as described under the child_mon_level extension property.

Category

Required

Minimum

1

Default

No default

Tunable

When disabled

Proxy_interval (integer)

Specifies the number of seconds between invocations of the prenet_start_command proxy daemon of the resource. This extension property can be used by your prenet_start_command proxy daemon.

Category

Optional

Minimum

2 seconds

Default

30 seconds

Tunable

Any time

Stop_signal (integer)

Specifies the signal that stops the application if the application fails to stop with the postnet_stop_command. The values for this property are the same as those defined in the signal(3HEAD) man page.

Category

Optional

Minimum

1

Maximum

37

Default

15

Tunable

When disabled

Validate_command (string)

Specifies the absolute path to the command that validates the application. If you do not provide an absolute path, the application is not validated.

The exit status of the validate command is used to determine whether the creation or update of the GDSv2 resource should be permitted. Before creating or updating the resource, the specified validate command is executed on each node of the node list of the resource group that contains the resource. If the validate command exits nonzero, the requested resource creation or update is not permitted. Any output that is written to stdout or stderr by the validate command will be passed back to the user who issued the administrative command to create or update the resource. Such output can be used to explain why the resource validation failed.

The validate command is also executed before performing the GIVEOVER option of the scha_control command to relocate the resource group to a new node. If the command exits nonzero, the GIVEOVER is blocked and the resource group remains mastered on its current node.

Category

Optional

Default

Null

Tunable

When disabled

Examples

Configuring a Demo Application

The following example uses the supplied demo scripts that proxy the state of the Solaris Service Management Facility (SMF) system log. See Developing Agents With the Generic Data Service (GDS) for more information about GDSv2 demo applications.

# clresourcegroup create -p pathprefix=/opt/ORCLscgds/demo -S mysrg
# clresource create -g mysrg -t ORCL.gds_proxy \
# -p Prenet_start_command="%RG_PATHPREFIX/demo_proxy_prenet_start -R %RS_NAME -G %RG_NAME -T %RT_NAME" \
# -p Postnet_stop_command="%RG_PATHPREFIX/demo_proxy_postnet_stop -R %RS_NAME -G %RG_NAME -T %RT_NAME" \
# -p Validate_command="%RG_PATHPREFIX/demo_validate -R %RS_NAME -G %RG_NAME \
# -T %RT_NAME" -d mysrs
# clresourcegroup online -eM mysrg
# clresource status mysrs

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
ha-cluster/ha-service/gds2

See Also

clreslogicalhostname(8CL), signal(3HEAD), rt_reg(5), ORCL.gds(7), attributes(7), r_properties(7), scalable_service(7), clresource(8CL), clresourcegroup(8CL), clresourcetype(8CL), clressharedaddress(8CL), rt_callbacks(8HA), scdsbuilder(8HA), scha_control(8HA), scha_resource_get(8HA), hatimerun(8), pmfadm(8)