Go to main content

Reference for Oracle Solaris Cluster 4.4

Exit Print View

Updated: August 2018
 
 

scdsconfig (8HA)

Name

scdsconfig - configure resource type template

Synopsis

scdsconfig -s start-command [-u start-method-timeout] [-e 
     validate-command] [-y validate-method-timeout] [-t stop-command] 
     [-v stop-method-timeout] [-m probe-command] [-n probe-timeout] 
     [-d working-directory]

Description

The scdsconfig command configures the resource type template that you created with the scdscreate(8HA) command. The scdsconfig command enables you to configure C, Generic Data Service (GDS), or Korn shell-based templates for both network aware (client-server model) and non-network aware (clientless) applications.

The scdsconfig command configures application-specific commands to start, stop, validate, and probe the application. You can also use the scdsconfig command to set timeout values for the start, stop, validate, and probe commands. The scdsconfig command supports both network aware (client-server model) and non-network aware (clientless) applications. You can run the scdsconfig command from the same directory where the scdscreate command was run. You can also specify that same directory by using the –d option. The scdsconfig command configures the resource type template by placing the user-specified parameters at correct locations in the generated code. If C was the type of generated source code, this command also compiles the code. The scdsconfig command puts the output into a Solaris package that you can then install. This command creates the package in the pkg subdirectory under the $vendor-id$ resource-type-name directory created by the scdscreate command.

Options

The following options are supported:

–d working-directory

Specifies the directory where the scdscreate command was run.

You must specify this option if you run the scdsconfig command from a directory other than the directory where the scdscreate command was run.

–e validate-command

Specifies the absolute path to a command to invoke to validate the application. If you do not specify an absolute path, the application is not validated. The validate-command returns with an exit status of 0 if the application is running successfully. An exit status other than 0 indicates that the application is failing to perform correctly. In this case, one of two results occur, depending on the failure history of the application in the past:

  • The resources of this resource type are either restarted on the same node.

  • The resource group that contains the resource has failed over to another healthy node.

–m probe-command

Specifies a command to periodically check the health of the network aware or non-network aware application. It must be a complete command line that can be passed directly to a shell to probe the application. The probe-command returns with an exit status of 0 if the application is running successfully. An exit status other than 0 indicates that the application is failing to perform correctly. In this case, one of two results occur, depending on the failure history of the application in the past:

  • The resources of this resource type are either restarted on the same node.

  • The resource group that contains the resource is failed over to another healthy node.

–n probe-timeout

Specifies the timeout, in seconds, for the probe command. The timeout must take into account system overloads to prevent false failures. The default value is 30 seconds.

–s start-command

Specifies the command that starts the application. The start command must be a complete command line that can be passed directly to a shell to start the application. You can include command-line arguments to specify host names, port numbers, or other configuration data that is necessary to start the application. To create a resource type with multiple independent process trees, you specify a text file that contains the list of commands, one per line, to start the different process trees.

–t stop-command

Specifies the stop command for the application. The stop command must be a complete command line that can be passed directly to a shell to stop the application. If you omit this option, the generated code stops the application by issuing signals. The stop command is allotted 80 percent of the timeout value to stop the application. If the stop command fails to stop the application within this period, a SIGKILL is allotted 15 percent of the timeout value to stop the application. If SIGKILL also fails to stop the application, the stop method returns with an error.

–u start-method-timeout

Specifies the timeout, in seconds, for the start command. The timeout must take into account system overloads to prevent false failures. The default value is 300 seconds.

–v stop-method-timeout

Specifies the timeout, in seconds, for the stop command. The timeout must take into account system overloads to prevent false failures. The default value is 300 seconds.

–y validate-method-timeout

Specifies the timeout, in seconds, for the validate command. The timeout must take into account system overloads to prevent false failures. The default value is 300 seconds.

Exit Status

The following exit status codes are returned:

0

The command completed successfully.

nonzero

An error occurred.

Files

working-directory/rtconfig

Contains information from the previous session. Facilitates the tool's quit and restart feature.

Attributes

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

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
ha-cluster/developer/api
Interface Stability
Evolving

See Also

ksh(1), attributes(7), scdsbuilder(8HA), scdscreate(8HA)