xref: /freebsd/usr.sbin/nfsrevoke/nfsrevoke.8 (revision 4f8f43b06ed07e96a250855488cc531799d5b78f)
1.\" Copyright (c) 2009 Rick Macklem, University of Guelph
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.Dd April 25, 2009
26.Dt NFSREVOKE 8
27.Os
28.Sh NAME
29.Nm nfsrevoke
30.Nd revoke
31.Tn NFS
32V4 client
33.Sh SYNOPSIS
34.Nm nfsrevoke
35.Ar ClientId
36.Sh DESCRIPTION
37.Nm
38This command is used by a system administrator to revoke a client's access
39to the NFS Version 4 server. All Open/Lock state held by the client will
40be released.
41After revocation, the client will no longer be able to use state on the server
42until it does a fresh SetClientID/SetClientIDConfirm operations sequence.
43THIS SHOULD BE DONE AS A LAST RESORT ONLY, when clients are holding state
44that must be released on the server.
45.Pp
46The
47.Ar ClientId
48argument is a hexadecimal string, which is the last field
49of the
50.Xr nfsdumpstate 8
51command's
52.Fl o
53and
54.Fl l
55options output.
56.Sh SEE ALSO
57.Xr nfsv4 4 ,
58.Xr nfsdumpstate 8
59.Sh HISTORY
60The
61.Nm
62command was introduced as a part of the experimental nfs server subsystem.
63