Provided by: cluster-agents_1.0.4-0ubuntu2_i386 bug


       ocf_heartbeat_Xen - Manages Xen unprivileged domains (DomUs)


       Xen [start | stop | monitor | migrate_to | migrate_from | meta-data |


       Resource Agent for the Xen Hypervisor. Manages Xen virtual machine
       instances by mapping cluster resource start and stop, to Xen create and
       shutdown, respectively.

       A note on names

       We will try to extract the name from the config file (the xmfile
       attribute). If you use a simple assignment statement, then you should
       be fine. Otherwise, if there's some python acrobacy involved such as
       dynamically assigning names depending on other variables, and we will
       try to detect this, then please set the name attribute. You should also
       do that if there is any chance of a pathological situation where a
       config file might be missing, for example if it resides on a shared
       storage. If all fails, we finally fall back to the instance id to
       preserve backward compatibility.

       Para-virtualized guests can also be migrated by enabling the
       meta_attribute allow-migrate.


           Absolute path to the Xen control file, for this virtual machine.
           (required, string, no default)

           Name of the virtual machine. (optional, string, no default)

           The Xen agent will first try an orderly shutdown using xm shutdown.
           Should this not succeed within this timeout, the agent will
           escalate to xm destroy, forcibly killing the node. If this is not
           set, it will default to two-third of the stop action timeout.
           Setting this value to 0 forces an immediate destroy. (optional,
           string, no default)

           This parameter enables dynamic adjustment of memory for start and
           stop actions used for Dom0 and the DomUs. The default is to not
           adjust memory dynamically. (optional, boolean, default 0)

           In case of a live migration, the system will default to using the
           IP address associated with the hostname via DNS or /etc/hosts. This
           parameter allows you to specify a node attribute that will be
           queried instead for the target node, overriding the IP address.
           This allows you to use a dedicated network for live migration
           traffic to a specific node. Warning: make very sure the IP address
           does point to the right node. Or else the live migration will end
           up somewhere else, greatly confusing the cluster and causing havoc.
           (optional, string, no default)

           In case memory management is used, this parameter defines the
           minimum amount of memory to be reserved for the dom0. The default
           minimum memory is 512MB. (optional, string, default 512)

           To additionally monitor services within the unprivileged domain,
           add this parameter with a list of scripts to monitor. (optional,
           string, no default)


       This resource agent supports the following actions (operations):

           Starts the resource. Suggested minimum timeout: 60.

           Stops the resource. Suggested minimum timeout: 40.

           Executes steps necessary for migrating the resource away from the
           node. Suggested minimum timeout: 120.

           Executes steps necessary for migrating the resource to the node.
           Suggested minimum timeout: 120.

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

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

           Performs a validation of the resource configuration. Suggested
           minimum timeout: 5.


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

           primitive example_Xen ocf:heartbeat:Xen \
             params \
               xmfile=string \
             meta allow-migrate="true" \
             op monitor depth="0" timeout="30" interval="10"



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