ocf_heartbeat_Xen(7)

1OCF_HEARTBEAT_XEN(7)          OCF resource agents         OCF_HEARTBEAT_XEN(7)
2
3
4

NAME

6       ocf_heartbeat_Xen - Manages Xen unprivileged domains (DomUs)
7

SYNOPSIS

9       Xen [start | stop | monitor | migrate_to | migrate_from | meta-data |
10           validate-all]
11

DESCRIPTION

13       Resource Agent for the Xen Hypervisor. Manages Xen virtual machine
14       instances by mapping cluster resource start and stop, to Xen create and
15       shutdown, respectively.
16
17       A note on names
18
19       We will try to extract the name from the config file (the xmfile
20       attribute). If you use a simple assignment statement, then you should
21       be fine. Otherwise, if there's some python acrobacy involved such as
22       dynamically assigning names depending on other variables, and we will
23       try to detect this, then please set the name attribute. You should also
24       do that if there is any chance of a pathological situation where a
25       config file might be missing, for example if it resides on a shared
26       storage. If all fails, we finally fall back to the instance id to
27       preserve backward compatibility.
28
29       Para-virtualized guests can also be migrated by enabling the
30       meta_attribute allow-migrate.
31

SUPPORTED PARAMETERS

33       xmfile
34           Absolute path to the Xen control file, for this virtual machine.
35           (required, string, no default)
36
37       name
38           Name of the virtual machine.  (optional, string, no default)
39
40       shutdown_timeout
41           The Xen agent will first try an orderly shutdown using xm shutdown.
42           Should this not succeed within this timeout, the agent will
43           escalate to xm destroy, forcibly killing the node. .sp If this is
44           not set, it will default to two-third of the stop action timeout.
45           .sp Setting this value to 0 forces an immediate destroy. .sp
46
47           (optional, string, no default)
48
49       allow_mem_management
50           This parameter enables dynamic adjustment of memory for start and
51           stop actions used for Dom0 and the DomUs. The default is to not
52           adjust memory dynamically.  (optional, boolean, default 0)
53
54       node_ip_attribute
55           In case of a live migration, the system will default to using the
56           IP address associated with the hostname via DNS or /etc/hosts. .sp
57           This parameter allows you to specify a node attribute that will be
58           queried instead for the target node, overriding the IP address.
59           This allows you to use a dedicated network for live migration
60           traffic to a specific node. .sp Warning: make very sure the IP
61           address does point to the right node. Or else the live migration
62           will end up somewhere else, greatly confusing the cluster and
63           causing havoc.  (optional, string, no default)
64
65       reserved_Dom0_memory
66           In case memory management is used, this parameter defines the
67           minimum amount of memory to be reserved for the dom0. The default
68           minimum memory is 512MB.  (optional, string, default 512)
69
70       monitor_scripts
71           To additionally monitor services within the unprivileged domain,
72           add this parameter with a list of scripts to monitor.  (optional,
73           string, no default)
74

SUPPORTED ACTIONS

76       This resource agent supports the following actions (operations):
77
78       start
79           Starts the resource. Suggested minimum timeout: 60.
80
81       stop
82           Stops the resource. Suggested minimum timeout: 40.
83
84       migrate_from
85           Executes steps necessary for migrating the resource away from the
86           node. Suggested minimum timeout: 120.
87
88       migrate_to
89           Executes steps necessary for migrating the resource to the node.
90           Suggested minimum timeout: 120.
91
92       monitor
93           Performs a detailed status check. Suggested minimum timeout: 30.
94           Suggested interval: 10.
95
96       meta-data
97           Retrieves resource agent metadata (internal use only). Suggested
98           minimum timeout: 5.
99
100       validate-all
101           Performs a validation of the resource configuration. Suggested
102           minimum timeout: 5.
103

EXAMPLE

105       The following is an example configuration for a Xen resource using the
106       crm(8) shell:
107
108           primitive p_Xen ocf:heartbeat:Xen \
109             params \
110               xmfile=string \
111             meta allow-migrate="true" \
112             op monitor depth="0" timeout="30" interval="10"
113

AUTHOR

118       Linux-HA contributors (see the resource agent source for information
119       about individual authors)
120
121
122
123resource-agents 3.9.2             07/08/2011              OCF_HEARTBEAT_XEN(7)