Oracle® Solaris Cluster Data Services Developer's Guide

Exit Print View

Updated: July 2014, E39646-01
 
 

Using the Configure Screen

The Configure screen appears after Agent Builder finishes creating the resource type and you click Next on the Create screen. You cannot access the Configure screen before the resource type has been created.

    The Configure screen contains the following fields:

  • Start Command. The complete command line that can be passed to any UNIX shell to start the base application. You must specify a start command. You can type the command in the field provided, or use Browse to locate a file that contains the command to start the application.

    The complete command line must include everything necessary to start the application, such as host names, port numbers, a path to configuration files. You can also specify property variables, which are described in Using Property Variables. If your Korn shell-based application requires a host name to be specified on the command line, you can use the $hostnames variable that Agent Builder defines. See Using the Agent Builder Korn Shell-Based $hostnames Variable.

    Do not enclose the command in double quotation marks (””).


    Note - If the base application has multiple independent process trees, each of which is started with its own tag under Process Monitor Facility (PMF) control, you cannot specify a single command. Rather, you must create a text file that contains individual commands to start each process tree, and specify the path to this file in the Start Command text field. See Before You Use Agent Builder. This section lists some special characteristics that this file requires to work correctly.
  • Stop Command. The complete command line that can be passed to any UNIX shell to stop the base application. You can type the command in the field provided, or use Browse to locate a file that contains the command to stop the application. You can also specify property variables, which are described in Using Property Variables. If your Korn shell-based application requires a host name to be specified on the command line, you can use the $hostnames variable that Agent Builder defines. See Using the Agent Builder Korn Shell-Based $hostnames Variable.

    This command is optional.

      If you do not specify a stop command, the generated code uses signals (in the Stop method) to stop the application, as follows:

    • The Stop method sends SIGTERM to stop the application and waits for 80 percent of the timeout value for the application to exit.

    • If the SIGTERM signal is unsuccessful, the Stop method sends SIGKILL to stop the application and waits for 15 percent of the timeout value for the application to exit.

    • If SIGKILL is unsuccessful, the Stop method exits unsuccessfully. The remaining 5 percent of the timeout value is considered overhead.


    Caution

    Caution  - Be certain the stop command does not return before the application has stopped completely.


  • Probe Command. A command that can be run periodically to check the health of the application and return an exit status between 0 (success) and 100 (complete failure). This command is optional. You can type the complete path to the command, or use Browse to locate a file that contains the commands to probe the application.

    Typically, you specify a simple client of the base application. If you do not specify a probe command, the generated code simply connects to and disconnects from the port that is used by the resource. If the connect and disconnect succeed, the generated code declares the application healthy. You can also specify property variables, which are described in Using Property Variables. If your Korn shell-based application requires that you specify a host name on the probe command line, you can use the $hostnames variable that Agent Builder defines. See Using the Agent Builder Korn Shell-Based $hostnames Variable.

    Do not enclose the command in double quotation marks (””).

  • Timeout. A timeout value, in seconds, for each command. You can specify a new value, or accept the default value that Agent Builder provides. The default value is 300 seconds for start and stop and 30 seconds for probe.