openafs/doc/man-pages/pod8/bos_getrestricted.pod
Stephan Wiesand eee0bf5871 doc: improve man pages related to bos restricted mode
Mention the restrictmode entry and the commands for setting and
querying it in the BosConfig man page, and add/fix cross references
between the BosConfig, bos, bos_getrestricted and bos_setrestricted
ones.

Change-Id: I938ef4c43c1a248335f09975c454b36f7570782c
Reviewed-on: http://gerrit.openafs.org/10874
Reviewed-by: Ken Dreyer <ktdreyer@ktdreyer.com>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
Reviewed-by: Jeffrey Altman <jaltman@your-file-system.com>
Tested-by: Jeffrey Altman <jaltman@your-file-system.com>
2014-03-11 06:26:42 -07:00

89 lines
2.1 KiB
Plaintext

=head1 NAME
bos_getrestricted - Displays whether a bos server is restricted or not
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<bos getrestricted> S<<< B<-server> <I<machine name>> >>> S<<< [B<-cell> <I<cell name>>] >>>
[B<-noauth>] [B<-localauth>] [B<-help>]
=for html
</div>
=head1 DESCRIPTION
The bos getrestricted command shows whether the server machine named by
the B<-server> argument is running in restricted mode.
Restricted mode limits access to certain bos commands. See
L<bos_setrestricted(8)> for details of which commands are disabled by
restricting a server.
Use the B<bos setrestricted> command to restrict, or un-restrict, a server.
=head1 OPTIONS
=over 4
=item B<-server> <I<machine name>>
Indicates the server machine for which to display the restart
times. Identify the machine by IP address or its host name (either
fully-qualified or abbreviated unambiguously). For details, see L<bos(8)>.
=item B<-cell> <I<cell name>>
Names the cell in which to run the command. Do not combine this argument
with the B<-localauth> flag. For more details, see L<bos(8)>.
=item B<-noauth>
Assigns the unprivileged identity C<anonymous> to the issuer. Do not
combine this flag with the B<-localauth> flag. For more details, see
L<bos(8)>.
=item B<-localauth>
Constructs a server ticket using a key from the local
F</usr/afs/etc/KeyFile> file. The B<bos> command interpreter presents the
ticket to the BOS Server during mutual authentication. Do not combine this
flag with the B<-cell> or B<-noauth> options. For more details, see
L<bos(8)>.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 OUTPUT
The output consists of a single line
Restricted mode is <val>
Where <val> is "on" or "off"
=head1 PRIVILEGE REQUIRED
None
=head1 SEE ALSO
L<BosConfig(5)>,
L<bos(8)>,
L<bos_setrestricted(8)>
=head1 COPYRIGHT
Copyright 2009 Simon Wilkinson <simon@sxw.org.uk>
This documentation is covered by the BSD License as written in the
doc/LICENSE file. This man page was written by Simon Wilkinson for
OpenAFS.