.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "BOS_GETRESTRICTED 8"
.TH BOS_GETRESTRICTED 8 2024-03-20 OpenAFS "AFS Command Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
bos_getrestricted \- Displays whether a bos server is restricted or not
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBbos getrestricted\fR \fB\-server\fR\ <\fImachine\ name\fR> [\fB\-cell\fR\ <\fIcell\ name\fR>]
    [\fB\-noauth\fR] [\fB\-localauth\fR] [\fB\-help\fR]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The bos getrestricted command shows whether the server machine named by
the \fB\-server\fR argument is running in restricted mode.
.PP
Restricted mode limits access to certain bos commands. See
\&\fBbos_setrestricted\fR\|(8) for details of which commands are disabled by
restricting a server.
.PP
Use the \fBbos setrestricted\fR command to restrict, or un-restrict, a server.
.SH OPTIONS
.IX Header "OPTIONS"
.IP "\fB\-server\fR <\fImachine name\fR>" 4
.IX Item "-server <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 \fBbos\fR\|(8).
.IP "\fB\-cell\fR <\fIcell name\fR>" 4
.IX Item "-cell <cell name>"
Names the cell in which to run the command. Do not combine this argument
with the \fB\-localauth\fR flag. For more details, see \fBbos\fR\|(8).
.IP \fB\-noauth\fR 4
.IX Item "-noauth"
Assigns the unprivileged identity \f(CW\*(C`anonymous\*(C'\fR to the issuer. Do not
combine this flag with the \fB\-localauth\fR flag. For more details, see
\&\fBbos\fR\|(8).
.IP \fB\-localauth\fR 4
.IX Item "-localauth"
Constructs a server ticket using a key from the local
\&\fI/etc/openafs/server/KeyFile\fR file. The \fBbos\fR command interpreter presents the
ticket to the BOS Server during mutual authentication. Do not combine this
flag with the \fB\-cell\fR or \fB\-noauth\fR options. For more details, see
\&\fBbos\fR\|(8).
.IP \fB\-help\fR 4
.IX Item "-help"
Prints the online help for this command. All other valid options are
ignored.
.SH OUTPUT
.IX Header "OUTPUT"
The output consists of a single line
.PP
.Vb 1
\&   Restricted mode is <val>
.Ve
.PP
Where <val> is "on" or "off"
.SH "PRIVILEGE REQUIRED"
.IX Header "PRIVILEGE REQUIRED"
None
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBBosConfig\fR\|(5),
\&\fBbos\fR\|(8),
\&\fBbos_setrestricted\fR\|(8)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2009 Simon Wilkinson <simon@sxw.org.uk>
.PP
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.