xref: /freebsd/usr.sbin/pnfsdskill/pnfsdskill.8 (revision 4b9d6057)
1.\" Copyright (c) 2018 Rick Macklem
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
13.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
14.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
15.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
16.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
17.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
18.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
19.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
20.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
21.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
22.\" SUCH DAMAGE.
23.\"
24.Dd July 9, 2018
25.Dt PNFSDSKILL 8
26.Os
27.Sh NAME
28.Nm pnfsdskill
29.Nd
30disables a pNFS data storage server (DS)
31.Sh SYNOPSIS
32.Nm
33.Op Fl f
34.Ar mounted-on-DS-dir
35.Sh DESCRIPTION
36The
37.Nm
38command disables one DS when mirroring is enabled.
39If one mirrored DS is malfunctioning, a system administrator
40may use this command on the metadata server (MDS) to disable use of this mirror.
41This command must be used on the MDS and the
42.Ar mounted-on-DS-dir
43must be the exact pathname used when mounting the DS on the MDS.
44Normally this command will fail if there is no valid mirror for the DS
45available.
46.Pp
47The following option is available:
48.Bl -tag -width Ds
49.It Fl f
50This option forces the DS to be disabled even if there is no valid mirror
51for the DS available.
52It should only be used to allow the
53.Xr nfsd 8
54threads to be terminated.
55.El
56.Pp
57If this command fails with
58.Dq Device not configured
59(ENXIO), it probably
60means that the DS has already been disabled due to an error either detected
61by the MDS or reported to the MDS by a client.
62.Pp
63The pNFS service should continue to run normally so long as the number of
64operational DSs is at least as many as the level of mirroring.
65.El
66.Sh SEE ALSO
67.Xr nfsv4 4 ,
68.Xr pnfs 4 ,
69.Xr nfsd 8 ,
70.Xr pnfsdscopymr 8 ,
71.Xr pnfsdsfile 8
72.Sh HISTORY
73The
74.Nm
75command first appeared in
76.Fx 12.0 .
77