3caa64111b2ec0e25044a9d91b56be163fb11983
[openafs.git] / doc / man-pages / pod8 / bos_getrestricted.pod
1 =head1 NAME
2
3 bos_getrestricted - Displays whether a bos server is restricted or not
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<bos getrestricted> S<<< B<-server> <I<machine name>> >>> S<<< [B<-cell> <I<cell name>>] >>>
11     [B<-noauth>] [B<-localauth>] [B<-help>]
12
13 =for html
14 </div>
15
16 =head1 DESCRIPTION
17
18 The bos getrestricted command shows whether the server machine named by
19 the B<-server> argument is running in restricted mode.
20
21 Restricted mode limits access to certain bos commands. See
22 L<bos_setrestricted(8)> for details of which commands are disabled by
23 restricting a server.
24
25 Use the B<bos setrestricted> command to restrict, or un-restrict, a server.
26
27 =head1 OPTIONS
28
29 =over 4
30
31 =item B<-server> <I<machine name>>
32
33 Indicates the server machine for which to display the restart
34 times. Identify the machine by IP address or its host name (either
35 fully-qualified or abbreviated unambiguously). For details, see L<bos(8)>.
36
37 =item B<-cell> <I<cell name>>
38
39 Names the cell in which to run the command. Do not combine this argument
40 with the B<-localauth> flag. For more details, see L<bos(8)>.
41
42 =item B<-noauth>
43
44 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
45 combine this flag with the B<-localauth> flag. For more details, see
46 L<bos(8)>.
47
48 =item B<-localauth>
49
50 Constructs a server ticket using a key from the local
51 F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
52 ticket to the BOS Server during mutual authentication. Do not combine this
53 flag with the B<-cell> or B<-noauth> options. For more details, see
54 L<bos(8)>.
55
56 =item B<-help>
57
58 Prints the online help for this command. All other valid options are
59 ignored.
60
61 =back
62
63 =head1 OUTPUT
64
65 The output consists of a single line
66
67    Restricted mode is <val>
68
69 Where <val> is "on" or "off"
70
71 =head1 PRIVILEGE REQUIRED
72
73 None
74
75 =head1 SEE ALSO
76
77 L<BosConfig(5)>,
78 L<bos(8)>,
79 L<bos_setrestricted(8)>
80
81 =head1 COPYRIGHT
82
83 Copyright 2009 Simon Wilkinson <simon@sxw.org.uk>
84
85 This documentation is covered by the BSD License as written in the
86 doc/LICENSE file. This man page was written by Simon Wilkinson for
87 OpenAFS.
88