suse man page for ocf_heartbeat_virtualdomain

OCF_HEARTBEAT_VIRTUA(7) 					OCF resource agents					   OCF_HEARTBEAT_VIRTUA(7)

NAME
       ocf_heartbeat_VirtualDomain - Manages virtual domains through the libvirt virtualization framework

SYNOPSIS
       VirtualDomain [start | stop | status | monitor | migrate_from | migrate_to | meta-data | validate-all]

DESCRIPTION
       Resource agent for a virtual domain (a.k.a. domU, virtual machine, virtual environment etc., depending on context) managed by libvirtd.

SUPPORTED PARAMETERS
       config
	   Absolute path to the libvirt configuration file, for this virtual domain. (required, string, no default)

       hypervisor
	   Hypervisor URI to connect to. See the libvirt documentation for details on supported URI formats. The default is system dependent.
	   (optional, string, no default)

       force_stop
	   Always forcefully shut down ("destroy") the domain on stop. The default behavior is to resort to a forceful shutdown only after a
	   graceful shutdown attempt has failed. You should only set this to true if your virtual domain (or your virtualization backend) does not
	   support graceful shutdown. (optional, boolean, default 0)

       migration_transport
	   Transport used to connect to the remote hypervisor while migrating. Please refer to the libvirt documentation for details on transports
	   available. If this parameter is omitted, the resource will use libvirt's default transport to connect to the remote hypervisor.
	   (optional, string, no default)

       migrate_use_fqdn
	   Use resolver to acquire a fully qualified domain name for the destination node. Should be used if migration_transport is set to use
	   TLS/SSL, and certificates are made out to the FQDN of the node. (optional, boolean, default 0)

       monitor_scripts
	   To additionally monitor services within the virtual domain, add this parameter with a list of scripts to monitor. Note: when monitor
	   scripts are used, the start and migrate_from operations will complete only when all monitor scripts have completed successfully. Be
	   sure to set the timeout of these operations to accommodate this delay. (optional, string, no default)

SUPPORTED ACTIONS
       This resource agent supports the following actions (operations):

       start
	   Starts the resource. Suggested minimum timeout: 90.

       stop
	   Stops the resource. Suggested minimum timeout: 90.

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

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

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

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

       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: 5.

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

	   primitive example_VirtualDomain ocf:heartbeat:VirtualDomain 
	     params 
	       config=string 
	     meta allow-migrate="true" 
	     op monitor depth="0" timeout="30" interval="10"

SEE ALSO
       http://www.linux-ha.org/wiki/VirtualDomain_(resource_agent)

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

resource-agents 1.0.3						    07/05/2010						   OCF_HEARTBEAT_VIRTUA(7)