install-and-document-klog-krb5-20080627
[openafs.git] / doc / xml / AdminReference / sect1 / fs_getcellstatus.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="fs_getcellstatus1">
3   <refmeta>
4     <refentrytitle>fs getcellstatus</refentrytitle>
5     <manvolnum>1</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>fs getcellstatus</refname>
9     <refpurpose>Reports whether setuid programs are honored in a cell</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Synopsis</title>
13     <para><emphasis role="bold">fs getcellstatus</emphasis> <emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;+ [<emphasis role="bold">-help</emphasis>]</para>
14
15     <para><emphasis role="bold">fs getce</emphasis> <emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;+ [<emphasis role="bold">-h</emphasis>]</para>
16
17   </refsect1>
18   <refsect1>
19     <title>Description</title>
20     <para>The <emphasis role="bold">fs getcellstatus</emphasis> command reports whether the Cache Manager allows
21     programs fetched from each specified cell to run with setuid
22     permission. To set a cell's setuid status, use the <emphasis role="bold">fs setcell</emphasis> command;
23     <link linkend="fs_setcell1">fs_setcell(1)</link> fully describes how AFS treats setuid programs.</para>
24
25   </refsect1>
26   <refsect1>
27     <title>Options</title>
28     <variablelist>
29       <varlistentry>
30         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;+</term>
31         <listitem>
32           <para>Names each cell for which to report setuid status. Provide the fully
33           qualified domain name, or a shortened form that disambiguates it from the
34           other cells listed in the local <replaceable>/usr/vice/etc/CellServDB</replaceable> file.</para>
35
36         </listitem>
37       </varlistentry>
38       <varlistentry>
39         <term><emphasis role="bold">-help</emphasis></term>
40         <listitem>
41           <para>Prints the online help for this command. All other valid options are
42           ignored.</para>
43
44         </listitem>
45       </varlistentry>
46     </variablelist>
47   </refsect1>
48   <refsect1>
49     <title>Output</title>
50     <para>The output reports one of the following two values as appropriate:</para>
51
52 <programlisting>
53    Cell &amp;lt;cell&amp;gt; status: setuid allowed
54    Cell &amp;lt;cell&amp;gt; status: no setuid allowed
55
56 </programlisting>
57     </refsect1>
58     <refsect1>
59       <title>Examples</title>
60       <para>The following example indicates that programs from the cell <computeroutput>abc.com</computeroutput> are
61       not allowed to run with setuid permission.</para>
62
63 <programlisting>
64    % fs getcellstatus abc.com
65    Cell abc.com status: no setuid allowed
66
67 </programlisting>
68       </refsect1>
69       <refsect1>
70         <title>Privilege Required</title>
71         <para>None</para>
72
73       </refsect1>
74       <refsect1>
75         <title>See Also</title>
76         <para><link linkend="CellServDB5">CellServDB(5)</link>,
77         <link linkend="fs_setcell1">fs_setcell(1)</link></para>
78
79       </refsect1>
80       <refsect1>
81         <title>Copyright</title>
82         <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
83
84         <para>This documentation is covered by the IBM Public License Version 1.0.  It was
85         converted from HTML to POD by software written by Chas Williams and Russ
86         Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
87
88       </refsect1>
89     </refentry>