summaryrefslogtreecommitdiffstats
path: root/tests/data/metadata/fence_kdump.xml
blob: aa08538d5264f47338908f5ca32a1b3390cd463d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<?xml version="1.0" ?>
<resource-agent name="fence_kdump" shortdesc="fencing agent for use with kdump crash recovery service">
<longdesc>fence_kdump is an I/O fencing agent to be used with the kdump
crash recovery service. When the fence_kdump agent is invoked,
it will listen for a message from the failed node that acknowledges
that the failed node it executing the kdump crash kernel.
Note that fence_kdump is not a replacement for traditional
fencing methods. The fence_kdump agent can only detect that a
node has entered the kdump crash recovery service. This allows the
kdump crash recovery service complete without being preempted by
traditional power fencing methods.

Note: the "off" action listen for message from failed node that
acknowledges node has entered kdump crash recovery service. If a valid
message is received from the failed node, the node is considered to be
fenced and the agent returns success. Failure to receive a valid
message from the failed node in the given timeout period results in
fencing failure. When multiple node names/IP addresses are specified
a single valid message is sufficient for success. This is useful when
single node can send message via several different IP addresses.
</longdesc>
<vendor-url>http://www.kernel.org/pub/linux/utils/kernel/kexec/</vendor-url>
<parameters>
	<parameter name="nodename" unique="0" required="0">
		<getopt mixed="-n, --nodename=NODE[,NODE...]" />
		<content type="string" />
		<shortdesc lang="en">List of names or IP addresses of node to be fenced. This option is
required for the "off" action. Multiple values separated by commas
can be specified. All values must be of same IP network family.</shortdesc>
	</parameter>
	<parameter name="ipport" unique="0" required="0">
		<getopt mixed="-p, --ipport=PORT" />
		<content type="string" default="7410" />
		<shortdesc lang="en">IP port number that the fence_kdump agent will use to listen for
messages.</shortdesc>
	</parameter>
	<parameter name="family" unique="0" required="0">
		<getopt mixed="-f, --family=FAMILY" />
		<content type="string" default="auto" />
		<shortdesc lang="en">IP network family. Force the fence_kdump agent to use a specific
family. The value for FAMILY can be "auto", "ipv4", or
"ipv6".</shortdesc>
	</parameter>
	<parameter name="action" unique="0" required="0">
		<getopt mixed="-o, --action=ACTION" />
		<content type="string" default="off" />
		<shortdesc lang="en">Fencing action to perform. The value for ACTION can be either
"off" or "metadata".</shortdesc>
	</parameter>
	<parameter name="timeout" unique="0" required="0">
		<getopt mixed="-t, --timeout=TIMEOUT" />
		<content type="string" default="60" />
		<shortdesc lang="en">Number of seconds to wait for message from failed node. If no message
is received within TIMEOUT seconds, the fence_kdump agent
returns failure.</shortdesc>
	</parameter>
	<parameter name="verbose" unique="0" required="0">
		<getopt mixed="-v, --verbose" />
		<content type="boolean" />
		<shortdesc lang="en">Print verbose output</shortdesc>
	</parameter>
	<parameter name="version" unique="0" required="0">
		<getopt mixed="-V, --version" />
		<content type="boolean" />
		<shortdesc lang="en">Print version</shortdesc>
	</parameter>
	<parameter name="usage" unique="0" required="0">
		<getopt mixed="-h, --help" />
		<content type="boolean" />
		<shortdesc lang="en">Print usage</shortdesc>
	</parameter>
</parameters>
<actions>
	<action name="off" />
	<action name="monitor" />
	<action name="metadata" />
	<action name="validate-all" />
</actions>
</resource-agent>