usr.sbin/pnfsdskill/pnfsdskill.8

   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 .\" $FreeBSD$
  25 .\"
  26 .Dd July 9, 2018
  27 .Dt PNFSDSKILL 8
  28 .Os
  29 .Sh NAME
  30 .Nm pnfsdskill
  31 .Nd
  32 disables a pNFS data storage server (DS)
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl f
  36 .Ar mounted-on-DS-dir
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 command disables one DS when mirroring is enabled.
  41 If one mirrored DS is malfunctioning, a system administrator
  42 may use this command on the metadata server (MDS) to disable use of this mirror.
  43 This command must be used on the MDS and the
  44 .Ar mounted-on-DS-dir
  45 must be the exact pathname used when mounting the DS on the MDS.
  46 Normally this command will fail if there is no valid mirror for the DS
  47 available.
  48 .Pp
  49 The following option is available:
  50 .Bl -tag -width Ds
  51 .It Fl f
  52 This option forces the DS to be disabled even if there is no valid mirror
  53 for the DS available.
  54 It should only be used to allow the
  55 .Xr nfsd 8
  56 threads to be terminated.
  57 .El
  58 .Pp
  59 If this command fails with
  60 .Dq Device not configured
  61 (ENXIO), it probably
  62 means that the DS has already been disabled due to an error either detected
  63 by the MDS or reported to the MDS by a client.
  64 .Pp
  65 The pNFS service should continue to run normally so long as the number of
  66 operational DSs is at least as many as the level of mirroring.
  67 .El
  68 .Sh SEE ALSO
  69 .Xr nfsv4 4 ,
  70 .Xr pnfs 4 ,
  71 .Xr nfsd 8 ,
  72 .Xr pnfsdscopymr 8 ,
  73 .Xr pnfsdsfile 8
  74 .Sh HISTORY
  75 The
  76 .Nm
  77 command first appeared in
  78 .Fx 12.0 .