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
18 config
19 Absolute path to the libvirt configuration file, for this virtual
20 domain. (unique, required, string, no default)
21 hypervisor
23 Hypervisor URI to connect to. See the libvirt documentation for
24 details on supported URI formats. The default is system dependent.
25 (optional, string, no default)
26 force_stop
28 Always forcefully shut down ("destroy") the domain on stop. The
29 default behavior is to resort to a forceful shutdown only after a
30 graceful shutdown attempt has failed. You should only set this to
31 true if your virtual domain (or your virtualization backend) does
32 not support graceful shutdown. (optional, boolean, default 0)
33 migration_transport
35 Transport used to connect to the remote hypervisor while migrating.
36 Please refer to the libvirt documentation for details on transports
37 available. If this parameter is omitted, the resource will use
38 libvirt's default transport to connect to the remote hypervisor.
39 (optional, string, no default)
40 migration_network_suffix
42 Use a dedicated migration network. The migration URI is composed by
43 adding this parameters value to the end of the node name. If the
44 node name happens to be an FQDN (as opposed to an unqualified host
45 name), insert the suffix immediately prior to the first period (.)
46 in the FQDN. At the moment Qemu/KVM and Xen migration via a
47 dedicated network is supported. .sp Note: Be sure this composed
48 host name is locally resolveable and the associated IP is reachable
49 through the favored network. (optional, string, no default)
50 monitor_scripts
52 To additionally monitor services within the virtual domain, add
53 this parameter with a list of scripts to monitor. .sp Note: when
54 monitor scripts are used, the start and migrate_from operations
55 will complete only when all monitor scripts have completed
56 successfully. Be sure to set the timeout of these operations to
57 accommodate this delay. (optional, string, no default)
58
60 This resource agent supports the following actions (operations):
61 start
63 Starts the resource. Suggested minimum timeout: 90.
64 stop
66 Stops the resource. Suggested minimum timeout: 90.
67 status
69 Performs a status check. Suggested minimum timeout: 30. Suggested
70 interval: 10.
71 monitor
73 Performs a detailed status check. Suggested minimum timeout: 30.
74 Suggested interval: 10.
75 migrate_from
77 Executes steps necessary for migrating the resource away from the
78 node. Suggested minimum timeout: 60.
79 migrate_to
81 Executes steps necessary for migrating the resource to the node.
82 Suggested minimum timeout: 120.
83 meta-data
85 Retrieves resource agent metadata (internal use only). Suggested
86 minimum timeout: 5.
87 validate-all
89 Performs a validation of the resource configuration. Suggested
90 minimum timeout: 5.
91
93 The following is an example configuration for a VirtualDomain resource
94 using the crm(8) shell:
95 primitive p_VirtualDomain ocf:heartbeat:VirtualDomain \
97 params \
98 config=string \
99 meta allow-migrate="true" \
100 op monitor depth="0" timeout="30" interval="10"
101
103 http://www.linux-ha.org/wiki/VirtualDomain_(resource_agent)
104
106 Linux-HA contributors (see the resource agent source for information
107 about individual authors)
108resource-agents 3.9.2 07/08/2011 OCF_HEARTBEAT_VIRTUA(7)