1OCF_HEARTBEAT_VIRTUA(7) OCF resource agents OCF_HEARTBEAT_VIRTUA(7)
2
6 ocf_heartbeat_VirtualDomain - Manages virtual domains through the
7 libvirt virtualization framework
8
10 VirtualDomain [start | stop | status | monitor | migrate_to |
11 migrate_from | meta-data | validate-all]
12
14 Resource agent for a virtual domain (a.k.a. domU, virtual machine,
15 virtual environment etc., depending on context) managed by libvirtd.
16 This resource agent may be configured for native migration if available
18 in the cluster manager. For Pacemaker, the allow-migrate="true" meta
19 attribute enables native migration.
20
22 config
23 Absolute path to the libvirt configuration file, for this virtual
24 domain.
25 (unique, required, string, no default)
27 hypervisor
29 Hypervisor URI to connect to. See the libvirt documentation for
30 details on supported URI formats. The default is system dependent.
31 (optional, string, no default)
33 force_stop
35 Always forcefully shut down ("destroy") the domain on stop. The
36 default behavior is to resort to a forceful shutdown only after a
37 graceful shutdown attempt has failed. You should only set this to
38 true if your virtual domain (or your virtualization backend) does
39 not support graceful shutdown.
40 (optional, boolean, default 0)
42 migration_transport
44 Transport used to connect to the remote hypervisor while migrating.
45 Please refer to the libvirt documentation for details on transports
46 available. If this parameter is omitted, the resource will use
47 libvirt´s default transport to connect to the remote hypervisor.
48 (optional, string, no default)
50 migration_network_suffix
52 Use a dedicated migration network. The migration URI is composed by
53 adding this parameters value to the end of the node name. If the
54 node name happens to be an FQDN (as opposed to an unqualified host
55 name), insert the suffix immediately prior to the first period (.)
56 in the FQDN. At the moment Qemu/KVM and Xen migration via a
57 dedicated network is supported.
58 Note: Be sure this composed host name is locally resolveable and
60 the associated IP is reachable through the favored network.
61 See also the migrate_options parameter below.
63 (optional, string, no default)
65 migrate_options
67 Extra virsh options for the guest live migration. You can also
68 specify here --migrateuri if the calculated migrate URI is
69 unsuitable for your environment. If --migrateuri is set then
70 migration_network_suffix and migrateport are effectively ignored.
71 Use "%n" as the placeholder for the target node name.
72 Please refer to the libvirt documentation for details on guest
74 migration.
75 (optional, string, no default)
77 monitor_scripts
79 To additionally monitor services within the virtual domain, add
80 this parameter with a list of scripts to monitor.
81 Note: when monitor scripts are used, the start and migrate_from
83 operations will complete only when all monitor scripts have
84 completed successfully. Be sure to set the timeout of these
85 operations to accommodate this delay.
86 (optional, string, no default)
88 autoset_utilization_cpu
90 If set true, the agent will detect the number of domainU´s vCPUs
91 from virsh, and put it into the CPU utilization of the resource
92 when the monitor is executed.
93 (optional, boolean, default true)
95 autoset_utilization_hv_memory
97 If set true, the agent will detect the number of *Max memory* from
98 virsh, and put it into the hv_memory utilization of the resource
99 when the monitor is executed.
100 (optional, boolean, default true)
102 migrateport
104 This port will be used in the qemu migrateuri. If unset, the port
105 will be a random highport.
106 (optional, integer, no default)
108 snapshot
110 Path to the snapshot directory where the virtual machine image will
111 be stored. When this parameter is set, the virtual machine´s RAM
112 state will be saved to a file in the snapshot directory when
113 stopped. If on start a state file is present for the domain, the
114 domain will be restored to the same state it was in right before it
115 stopped last. This option is incompatible with the ´force_stop´
116 option.
117 (optional, string, no default)
119
121 This resource agent supports the following actions (operations):
122 start
124 Starts the resource. Suggested minimum timeout: 90.
125 stop
127 Stops the resource. Suggested minimum timeout: 90.
128 status
130 Performs a status check. Suggested minimum timeout: 30. Suggested
131 interval: 10.
132 monitor
134 Performs a detailed status check. Suggested minimum timeout: 30.
135 Suggested interval: 10.
136 migrate_from
138 Executes steps necessary for migrating the resource away from the
139 node. Suggested minimum timeout: 60.
140 migrate_to
142 Executes steps necessary for migrating the resource to the node.
143 Suggested minimum timeout: 120.
144 meta-data
146 Retrieves resource agent metadata (internal use only). Suggested
147 minimum timeout: 5.
148 validate-all
150 Performs a validation of the resource configuration. Suggested
151 minimum timeout: 5.
152
154 The following is an example configuration for a VirtualDomain resource
155 using the crm(8) shell:
156 primitive p_VirtualDomain ocf:heartbeat:VirtualDomain \
158 params \
159 config=string \
160 meta allow-migrate="true" \
161 op monitor depth="0" timeout="30" interval="10"
162
164 http://www.linux-ha.org/wiki/VirtualDomain_(resource_agent)
165
167 Linux-HA contributors (see the resource agent source for information
168 about individual authors)
169resource-agents 3.9.2 03/24/2017 OCF_HEARTBEAT_VIRTUA(7)