1
2FENCE_AGENT(8)              System Manager's Manual             FENCE_AGENT(8)
3
4
5

NAME

7       fence_rcd_serial - rcd_serial fence agent
8

DESCRIPTION

10       fence_rcd_serial operates a serial cable that toggles a reset of an op‐
11       posing server using the reset switch on its motherboard. The cable  it‐
12       self  is  simple  with no power, network or moving parts. An example of
13       the cable is available here: https://smcleod.net/rcd-stonith/  and  the
14       circuit design is available in the fence-agents src as SVG
15
16       fence_rcd_serial  accepts  options  on the command line as well as from
17       stdin. Fenced sends parameters through stdin when it execs  the  agent.
18       fence_rcd_serial  can be run by itself with command line options.  This
19       is useful for testing and for turning outlets on or off from scripts.
20
21       Vendor URL: https://github.com/sammcj/fence_rcd_serial
22

PARAMETERS

24
25
26       -o, --action=[action]
27              Fencing action (Default Value: reboot)
28
29       -m, --method=[method]
30              Method to fence (onoff|cycle) (Default Value: cycle)
31
32       --serial-port=[port]
33              Port of the serial device (Default Value: /dev/ttyS0)
34
35       -q, --quiet
36              Disable logging to stderr. Does not affect --verbose or --debug-
37              file or logging to syslog.
38
39       -v, --verbose
40              Verbose  mode.  Multiple  -v flags can be stacked on the command
41              line (e.g., -vvv) to increase verbosity.
42
43       --verbose-level
44              Level of debugging detail in output. Defaults to the  number  of
45              --verbose  flags  specified on the command line, or to 1 if ver‐
46              bose=1 in a  stonith  device  configuration  (i.e.,  on  stdin).
47
48
49       -D, --debug-file=[debugfile]
50              Write debug information to given file
51
52       -V, --version
53              Display version information and exit
54
55       -h, --help
56              Display help and exit
57
58       --delay=[seconds]
59              Wait  X  seconds  before  fencing  is started (Default Value: 0)
60
61
62       --disable-timeout=[true/false]
63              Disable timeout (true/false) (default: true when run from  Pace‐
64              maker 2.0+)
65
66       --login-timeout=[seconds]
67              Wait  X  seconds  for  cmd prompt after login (Default Value: 5)
68
69
70       --power-timeout=[seconds]
71              Test X seconds for status change after  ON/OFF  (Default  Value:
72              20)
73
74       --power-wait=[seconds]
75              Wait X seconds after issuing ON/OFF (Default Value: 2)
76
77       --shell-timeout=[seconds]
78              Wait  X  seconds  for  cmd prompt after issuing command (Default
79              Value: 3)
80
81       --stonith-status-sleep=[seconds]
82              Sleep X seconds between status calls  during  a  STONITH  action
83              (Default Value: 1)
84
85       --retry-on=[attempts]
86              Count of attempts to retry power on (Default Value: 1)
87
88

ACTIONS

90
91
92       reboot Reboot machine.
93
94       monitor
95              Check the health of fence device
96
97       metadata
98              Display the XML metadata describing this resource.
99
100       manpage
101               The operational behavior of this is not known.
102
103       validate-all
104              Validate if all required parameters are entered.
105
106

STDIN PARAMETERS

108
109
110       action Fencing action (Default Value: reboot)
111
112       method Method to fence (onoff|cycle) (Default Value: cycle)
113
114       serial_port
115              Port of the serial device (Default Value: /dev/ttyS0)
116
117       quiet  Disable logging to stderr. Does not affect --verbose or --debug-
118              file or logging to syslog.
119
120       verbose
121              Verbose mode. Multiple -v flags can be stacked  on  the  command
122              line (e.g., -vvv) to increase verbosity.
123
124       verbose_level
125              Level  of  debugging detail in output. Defaults to the number of
126              --verbose flags specified on the command line, or to 1  if  ver‐
127              bose=1  in  a  stonith  device  configuration  (i.e., on stdin).
128
129
130       debug_file
131              Write debug information to given file Obsoletes: debug
132
133       version
134              Display version information and exit
135
136       help   Display help and exit
137
138       delay  Wait X seconds before fencing  is  started  (Default  Value:  0)
139
140
141       disable_timeout
142              Disable  timeout (true/false) (default: true when run from Pace‐
143              maker 2.0+)
144
145       login_timeout
146              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
147
148
149       power_timeout
150              Test  X  seconds  for status change after ON/OFF (Default Value:
151              20)
152
153       power_wait
154              Wait X seconds after issuing ON/OFF (Default Value: 2)
155
156       shell_timeout
157              Wait X seconds for cmd prompt  after  issuing  command  (Default
158              Value: 3)
159
160       stonith_status_sleep
161              Sleep  X  seconds  between  status calls during a STONITH action
162              (Default Value: 1)
163
164       retry_on
165              Count of attempts to retry power on (Default Value: 1)
166
167
168
169fence_rcd_serial (Fence Agent)    2009-10-20                    FENCE_AGENT(8)