NAME

       ocf_heartbeat_Stateful - Example stateful resource agent

SYNOPSIS

       Stateful [start | stop | monitor | promote | demote | meta-data | validate-all]

DESCRIPTION

       This is an example resource agent that impliments two states

SUPPORTED PARAMETERS

       state
           Location to store the resource state in

           (unique, optional, string, default
           "/var/run/resource-agents/Stateful-{OCF_RESOURCE_INSTANCE}.state")

SUPPORTED ACTIONS

       This resource agent supports the following actions (operations):

       start
           Starts the resource. Suggested minimum timeout: 20s.

       stop
           Stops the resource. Suggested minimum timeout: 20s.

       promote
           Promotes the resource to the Master role. Suggested minimum timeout: 20s.

       demote
           Demotes the resource to the Slave role. Suggested minimum timeout: 20s.

       monitor
           Performs a detailed status check. Suggested minimum timeout: 20. Suggested interval:
           10.

       meta-data
           Retrieves resource agent metadata (internal use only). Suggested minimum timeout: 5.

       validate-all
           Performs a validation of the resource configuration. Suggested minimum timeout: 20s.

EXAMPLE CRM SHELL

       The following is an example configuration for a Stateful resource using the crm(8) shell:

           primitive p_Stateful ocf:heartbeat:Stateful \
             op monitor depth="0" timeout="20" interval="10"

           ms ms_Stateful p_Stateful \
             meta notify="true" interleave="true"

EXAMPLE PCS

       The following is an example configuration for a Stateful resource using pcs(8)

           pcs resource create p_Stateful ocf:heartbeat:Stateful \
             op monitor depth="0" timeout="20" interval="10" --master

SEE ALSO

       http://www.linux-ha.org/wiki/Stateful_(resource_agent)

AUTHOR

       Linux-HA contributors (see the resource agent source for information about individual
       authors)