fence_rcd_serial(8)

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       --plug-separator=[char]
59              Separator  for  plug  parameter when specifying more than 1 plug
60              (Default Value: ,)
61
62       --delay=[seconds]
63              Wait X seconds before fencing  is  started  (Default  Value:  0)
64
65
66       --disable-timeout=[true/false]
67              Disable  timeout (true/false) (default: true when run from Pace‐
68              maker 2.0+)
69
70       --login-timeout=[seconds]
71              Wait X seconds for cmd prompt after  login  (Default  Value:  5)
72
73
74       --power-timeout=[seconds]
75              Test  X  seconds  for status change after ON/OFF (Default Value:
76              20)
77
78       --power-wait=[seconds]
79              Wait X seconds after issuing ON/OFF (Default Value: 2)
80
81       --shell-timeout=[seconds]
82              Wait X seconds for cmd prompt  after  issuing  command  (Default
83              Value: 3)
84
85       --stonith-status-sleep=[seconds]
86              Sleep  X  seconds  between  status calls during a STONITH action
87              (Default Value: 1)
88
89       --retry-on=[attempts]
90              Count of attempts to retry power on (Default Value: 1)
91
92

ACTIONS

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

STDIN PARAMETERS

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