xref: /freebsd/usr.sbin/nfsrevoke/nfsrevoke.8 (revision 57718be8fa0bd5edc11ab9a72e68cc71982939a6)
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.\" $FreeBSD$
26.\"
27.Dd April 25, 2009
28.Dt NFSREVOKE 8
29.Os
30.Sh NAME
31.Nm nfsrevoke
32.Nd revoke
33.Tn NFS
34V4 client
35.Sh SYNOPSIS
36.Nm nfsrevoke
37.Ar ClientId
38.Sh DESCRIPTION
39.Nm
40This command is used by a system administrator to revoke a client's access
41to the NFS Version 4 server. All Open/Lock state held by the client will
42be released.
43After revocation, the client will no longer be able to use state on the server
44until it does a fresh SetClientID/SetClientIDConfirm operations sequence.
45THIS SHOULD BE DONE AS A LAST RESORT ONLY, when clients are holding state
46that must be released on the server.
47.Pp
48The
49.Ar ClientId
50argument is a hexadecimal string, which is the last field
51of the
52.Xr nfsdumpstate 8
53command's
54.Fl o
55and
56.Fl l
57options output.
58.Sh SEE ALSO
59.Xr nfsv4 4 ,
60.Xr nfsdumpstate 8
61.Sh HISTORY
62The
63.Nm
64command was introduced as a part of the experimental nfs server subsystem.
65