Index for Section 8

Alphabetical listing for C

Bottom of page

caa_stop(8)
NAME
  caa_stop - Stops a Cluster Application Availability (CAA) application
  resource

SYNOPSIS
  /usr/sbin/caa_stop resource_name [...] [-f] [-q]

  /usr/sbin/caa_stop -c cluster_member [...] [-q]

  /usr/sbin/caa_stop -all [-q]

  /usr/sbin/caa_stop [USR_attribute_name=value] [...] resource_name  [-q]

PARAMETER
  resource_name [...]
      Name(s) (as specified in a resource profile) of one or more resources
      to be stopped.

OPTIONS
  -c cluster_member [...]
      Specifies one or more active cluster members on which to stop all
      application resources.

  -all
      Stops all application resources on all active cluster members.

  -f  Forces termination of the indicated application resources and all
      application resources dependent on the specified resources.  This
      option is useful to stop all application resources when the caa_stop
      command fails because of application resources dependent on the
      specified resource or if the application is in the "UNKNOWN" state
      because of an unsuccessful stop entry point execution. This option
      makes caa_stop ignore any errors that are reported by the stop entry
      point of an action script.

  -q  Runs the caa_stop command in quiet mode; no messages are displayed on
      the console.

DESCRIPTION
  The caa_stop command sets the application resource target state to OFFLINE
  and attempts to stop specified registered application resources.  The
  caa_stop command causes the stop entry point in the resource's action
  script to be executed.  If the stop fails, CAA marks the resource as
  "UNKNOWN".  You must run caa_stop or caa_stop -f on a resource in this
  state to mark its state as "OFFLINE" before you can restart it. If a
  resource is marked as "UNKNOWN" investigate why the stop entry point of the
  action script is failing.

  If one or more user-defined attributes have been defined for application
  resources, you can specify values for these attributes when stopping an
  application with caa_stop.  The specified value is passed to the action
  script as an environment variable with the attribute name, see caa(4).

  The caa_stop command displays progress on the command line. If there are
  troubles stopping an application, feedback will be displayed.	 These
  messages also appear as events in the EVM event management system.

  You must have root privilege to use this command.

  After a registered resource is started, you must use the caa_stop command
  to end execution of the specified resource in the cluster environment.  You
  must not stop the resource independently of CAA.

  Standard error and standard output from a resource action script invoked by
  caa_stop are redirected to the standard error and standard output for
  caa_stop.  Note that if the CAA daemon starts an application, standard
  error and standard output of the action script is lost. Within an action
  script, you can check for user invocation of the action script using reason
  codes. For more information on reason codes see caa(4).

EXAMPLES
   1.  The following example stops an application resource:
	    /usr/sbin/caa_stop xclock
	    Trying to stop `xclock` on `provolone`
	    Successfully stopped `xclock` on `provolone`

   2.  The following example stops all resources on the specified cluster
       member:
	    /usr/sbin/caa_stop -c provolone
	    Trying to stop `xclock` on `provolone`
	    Successfully stopped `xclock` on `provolone`
	    Trying to stop `calc` on `provolone`
	    Successfully stopped `calc` on `provolone`

   3.  If a user-defined attribute USR_DEBUG has been defined, see caa(4),
       the following example runs the stop entry point of the action script
       with the USR_DEBUG environment variable set to true, overriding any
       value set in the resource profile.

       In the corresponding action script, if you add the following line to
       the appropriate section of the action script you can view the value:
	    echo $USR_DEBUG

       Then execute the command:
	    # caa_stop USR_DEBUG=true database
	    true
	    Attempting to stop `database` on `provolone`
	    Successfully stopped `database` on `provolone

EXIT VALUES
  The following exit values are returned:

  0   Successful completion

  non-zero
      A failure has occurred.

      A corresponding text message will be given for the following error
      conditions:

      No root privilege.

      CAA daemon is not running.

      Application is not running.

SEE ALSO
  Commands: caa_profile(8), caa_register(8), caa_relocate(8), caa_start(8),
  caa_stat(1), caa_unregister(8)

  Daemon:  caad(8)

  File:	 caa(4)

  TruCluster Server Cluster Administration

Index for Section 8

Alphabetical listing for C

Top of page