Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
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_to |
		     migrate_from | 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.

       This resource agent may be configured for native	migration if available
       in the cluster manager. For Pacemaker, the allow-migrate="true" meta
       attribute enables native	migration.

SUPPORTED PARAMETERS
       config
	   Absolute path to the	libvirt	configuration file, for	this virtual
	   domain.

	   (unique, 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.
	   Determine the system's default uri by running 'virsh	--quiet	uri'.

	   (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)

       migration_downtime
	   Define max downtime during live migration in	milliseconds

	   (optional, integer, default 0)

       migration_speed
	   Define live migration speed per resource in MiB/s

	   (optional, integer, default 0)

       migration_network_suffix
	   Use a dedicated migration network. The migration URI	is composed by
	   adding this parameters value	to the end of the node name. If	the
	   node	name happens to	be an FQDN (as opposed to an unqualified host
	   name), insert the suffix immediately	prior to the first period (.)
	   in the FQDN.	At the moment Qemu/KVM and Xen migration via a
	   dedicated network is	supported.

	   Note: Be sure this composed host name is locally resolveable	and
	   the associated IP is	reachable through the favored network.

	   See also the	migrate_options	parameter below.

	   (optional, string, no default)

       migrate_options
	   Extra virsh options for the guest live migration. You can also
	   specify here	--migrateuri if	the calculated migrate URI is
	   unsuitable for your environment. If --migrateuri is set then
	   migration_network_suffix and	migrateport are	effectively ignored.
	   Use "%n" as the placeholder for the target node name.

	   Please refer	to the libvirt documentation for details on guest
	   migration.

	   (optional, string, no default)

       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)

       autoset_utilization_cpu
	   If set true,	the agent will detect the number of domainU's vCPUs
	   from	virsh, and put it into the CPU utilization of the resource
	   when	the monitor is executed.

	   (optional, boolean, default true)

       autoset_utilization_hv_memory
	   If set true,	the agent will detect the number of *Max memory* from
	   virsh, and put it into the hv_memory	utilization of the resource
	   when	the monitor is executed.

	   (optional, boolean, default true)

       migrateport
	   This	port will be used in the qemu migrateuri. If unset, the	port
	   will	be a random highport.

	   (optional, integer, no default)

       save_config_on_stop
	   Changes to a	running	VM's config are	normally lost on stop. This
	   parameter instructs the RA to save the configuration	back to	the
	   xml file provided in	the "config" parameter.

	   (optional, boolean, no default)

       sync_config_on_stop
	   Setting this	automatically enables save_config_on_stop. When
	   enabled this	parameter instructs the	RA to call csync2 -x to
	   synchronize the file	to all nodes. csync2 must be properly set up
	   for this to work.

	   (optional, boolean, no default)

       snapshot
	   Path	to the snapshot	directory where	the virtual machine image will
	   be stored. When this	parameter is set, the virtual machine's	RAM
	   state will be saved to a file in the	snapshot directory when
	   stopped. If on start	a state	file is	present	for the	domain,	the
	   domain will be restored to the same state it	was in right before it
	   stopped last. This option is	incompatible with the 'force_stop'
	   option.

	   (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	CRM SHELL
       The following is	an example configuration for a VirtualDomain resource
       using the crm(8)	shell:

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

EXAMPLE	PCS
       The following is	an example configuration for a VirtualDomain resource
       using pcs(8)

	   pcs resource	create p_VirtualDomain ocf:heartbeat:VirtualDomain \
	     config=string \
	     op	monitor	depth="0" timeout="30" interval="10"

SEE ALSO
       http://clusterlabs.org/

AUTHOR
       ClusterLabs contributors	(see the resource agent	source for information
       about individual	authors)

resource-agents	UNKNOWN		  07/02/2017	       OCF_HEARTBEAT_VIRTUA(7)

NAME | SYNOPSIS | DESCRIPTION | SUPPORTED PARAMETERS | SUPPORTED ACTIONS | EXAMPLE CRM SHELL | EXAMPLE PCS | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=ocf_heartbeat_VirtualDomain&sektion=7&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help