'\" t
.\"     Title: ocf_heartbeat_Xen
.\"    Author: Linux-HA contributors (see the resource agent source for information about individual authors)
.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 03/09/2014
.\"    Manual: OCF resource agents
.\"    Source: resource-agents UNKNOWN
.\"  Language: English
.\"
.TH "OCF_HEARTBEAT_XEN" "7" "03/09/2014" "resource-agents UNKNOWN" "OCF resource agents"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ocf_heartbeat_Xen \- Manages Xen unprivileged domains (DomUs)
.SH "SYNOPSIS"
.HP \w'\fBXen\fR\ 'u
\fBXen\fR [start | stop | monitor | migrate_to | migrate_from | meta\-data | validate\-all]
.SH "DESCRIPTION"
.PP
Resource Agent for the Xen Hypervisor\&. Manages Xen virtual machine instances by mapping cluster resource start and stop, to Xen create and shutdown, respectively\&.
.PP
A note on names
.PP
We will try to extract the name from the config file (the xmfile attribute)\&. If you use a simple assignment statement, then you should be fine\&. Otherwise, if there\*(Aqs some python acrobacy involved such as dynamically assigning names depending on other variables, and we will try to detect this, then please set the name attribute\&. You should also do that if there is any chance of a pathological situation where a config file might be missing, for example if it resides on a shared storage\&. If all fails, we finally fall back to the instance id to preserve backward compatibility\&.
.PP
Para\-virtualized guests can also be migrated by enabling the meta_attribute allow\-migrate\&.
.PP
.SH "SUPPORTED PARAMETERS"
.PP
\fBxmfile\fR
.RS 4
Absolute path to the Xen control file, for this virtual machine\&.
(required, string, no default)
.RE
.PP
\fBname\fR
.RS 4
Name of the virtual machine\&.
(optional, string, no default)
.RE
.PP
\fBshutdown_timeout\fR
.RS 4
The Xen agent will first try an orderly shutdown using xm shutdown\&. Should this not succeed within this timeout, the agent will escalate to xm destroy, forcibly killing the node\&. .sp
If this is not set, it will default to two\-third of the stop action timeout\&. .sp
Setting this value to 0 forces an immediate destroy\&. .sp

(optional, string, no default)
.RE
.PP
\fBallow_mem_management\fR
.RS 4
This parameter enables dynamic adjustment of memory for start and stop actions used for Dom0 and the DomUs\&. The default is to not adjust memory dynamically\&.
(optional, boolean, default
0)
.RE
.PP
\fBnode_ip_attribute\fR
.RS 4
In case of a live migration, the system will default to using the IP address associated with the hostname via DNS or /etc/hosts\&. .sp
This parameter allows you to specify a node attribute that will be queried instead for the target node, overriding the IP address\&. This allows you to use a dedicated network for live migration traffic to a specific node\&. .sp
Warning: make very sure the IP address does point to the right node\&. Or else the live migration will end up somewhere else, greatly confusing the cluster and causing havoc\&.
(optional, string, no default)
.RE
.PP
\fBreserved_Dom0_memory\fR
.RS 4
In case memory management is used, this parameter defines the minimum amount of memory to be reserved for the dom0\&. The default minimum memory is 512MB\&.
(optional, string, default
512)
.RE
.PP
\fBmonitor_scripts\fR
.RS 4
To additionally monitor services within the unprivileged domain, add this parameter with a list of scripts to monitor\&.
(optional, string, no default)
.RE
.SH "SUPPORTED ACTIONS"
.PP
This resource agent supports the following actions (operations):
.PP
\fBstart\fR
.RS 4
Starts the resource\&. Suggested minimum timeout: 60\&.
.RE
.PP
\fBstop\fR
.RS 4
Stops the resource\&. Suggested minimum timeout: 40\&.
.RE
.PP
\fBmigrate_from\fR
.RS 4
Executes steps necessary for migrating the resource
\fIaway from\fR
the node\&. Suggested minimum timeout: 120\&.
.RE
.PP
\fBmigrate_to\fR
.RS 4
Executes steps necessary for migrating the resource
\fIto\fR
the node\&. Suggested minimum timeout: 120\&.
.RE
.PP
\fBmonitor\fR
.RS 4
Performs a detailed status check\&. Suggested minimum timeout: 30\&. Suggested interval: 10\&.
.RE
.PP
\fBmeta\-data\fR
.RS 4
Retrieves resource agent metadata (internal use only)\&. Suggested minimum timeout: 5\&.
.RE
.PP
\fBvalidate\-all\fR
.RS 4
Performs a validation of the resource configuration\&. Suggested minimum timeout: 5\&.
.RE
.SH "EXAMPLE"
.PP
The following is an example configuration for a Xen resource using the
\fBcrm\fR(8)
shell:
.sp
.if n \{\
.RS 4
.\}
.nf
primitive p_Xen ocf:heartbeat:Xen \e
  params \e
    xmfile=\fIstring\fR \e
  meta allow\-migrate="true" \e
  op monitor depth="0" timeout="30" interval="10" 
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP

\m[blue]\fB\%http://www.linux-ha.org/wiki/Xen_(resource_agent)\fR\m[]
.SH "AUTHOR"
.PP
\fBLinux\-HA contributors (see the resource agent source for information about individual authors)\fR