table of contents
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
(unique, required, string, no default)
hypervisor
(optional, string, no default)
force_stop
(optional, boolean, default 0)
migration_transport
(optional, string, no default)
migration_user
If remoteuri is set, migration_user will be ignored.
(optional, string, no default)
migration_downtime
(optional, integer, default 0)
migration_speed
(optional, integer, default 0)
migration_network_suffix
Note: Be sure this composed host name is locally resolveable and the associated IP is reachable through the favored network. This suffix will be added to the remoteuri and migrateuri parameters.
See also the migrate_options parameter below.
(optional, string, no default)
migrateuri
If migrateuri is set then migration_network_suffix, migrateport and
--migrateuri in migrate_options 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)
migrate_options
Please refer to the libvirt documentation for details on guest migration.
(optional, string, no default)
monitor_scripts
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
(optional, boolean, default true)
autoset_utilization_hv_memory
(optional, boolean, default true)
migrateport
(optional, integer, no default)
remoteuri
If remoteuri is set then migration_user and migration_network_suffix 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)
save_config_on_stop
(optional, boolean, no default)
sync_config_on_stop
(optional, boolean, no default)
snapshot
(optional, string, no default)
backingfile
(optional, string, no default)
stateless
(optional, boolean, default false)
copyindirs
(optional, string, no default)
shutdown_mode
(optional, string, no default)
SUPPORTED ACTIONS¶
This resource agent supports the following actions (operations):
start
stop
status
monitor
migrate_from
migrate_to
meta-data
validate-all
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="30s" interval="10s"
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="30s" interval="10s"
SEE ALSO¶
AUTHOR¶
ClusterLabs contributors (see the resource agent source for information about individual authors)
03/19/2024 | resource-agents UNKNOWN |