mirror of
https://git.openafs.org/openafs.git
synced 2025-01-22 00:41:08 +00:00
244 lines
13 KiB
HTML
244 lines
13 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
|
|
<HTML><HEAD>
|
|
<TITLE>Administration Reference</TITLE>
|
|
<!-- Begin Header Records ========================================== -->
|
|
<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID -->
|
|
<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30 -->
|
|
<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
|
|
<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
|
|
<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
|
|
</HEAD><BODY>
|
|
<!-- (C) IBM Corporation 2000. All Rights Reserved -->
|
|
<BODY bgcolor="ffffff">
|
|
<!-- End Header Records ============================================ -->
|
|
<A NAME="Top_Of_Page"></A>
|
|
<H1>Administration Reference</H1>
|
|
<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf251.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf253.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
|
|
<P>
|
|
<H2><A NAME="HDRVOS_INTRO" HREF="auarf002.htm#ToC_266">vos</A></H2>
|
|
<A NAME="IDX5569"></A>
|
|
<A NAME="IDX5570"></A>
|
|
<A NAME="IDX5571"></A>
|
|
<A NAME="IDX5572"></A>
|
|
<A NAME="IDX5573"></A>
|
|
<A NAME="IDX5574"></A>
|
|
<A NAME="IDX5575"></A>
|
|
<A NAME="IDX5576"></A>
|
|
<A NAME="IDX5577"></A>
|
|
<A NAME="IDX5578"></A>
|
|
<A NAME="IDX5579"></A>
|
|
<A NAME="IDX5580"></A>
|
|
<A NAME="IDX5581"></A>
|
|
<A NAME="IDX5582"></A>
|
|
<A NAME="IDX5583"></A>
|
|
<A NAME="IDX5584"></A>
|
|
<A NAME="IDX5585"></A>
|
|
<A NAME="IDX5586"></A>
|
|
<P><STRONG>Purpose</STRONG>
|
|
<P>Introduction to the <B>vos</B> command suite
|
|
<P><STRONG>Description</STRONG>
|
|
<P>The commands in the <B>vos</B> command suite are the administrative
|
|
interface to the Volume Server and Volume Location (VL) Server. System
|
|
administrators use <B>vos</B> commands to create, move, delete, replicate,
|
|
back up and examine volumes, among other operations. The VL Server
|
|
automatically records in the Volume Location Database (VLDB) changes in volume
|
|
status and location that result from <B>vos</B> commands.
|
|
<P>The operations invoked by most <B>vos</B> commands are idempotent,
|
|
meaning that if an operation is interrupted by a network, server machine, or
|
|
process outage, then a subsequent attempt at the same operation continues from
|
|
the interruption point, rather than starting over at the beginning of the
|
|
operation. Before executing a command, the Volume and VL Servers check
|
|
the current state of the volumes and VLDB records to be altered by the
|
|
command. If they are already in the desired end state (or a consistent
|
|
intermediate state), there is no need to repeat the internal steps that
|
|
brought them there. Idempotency does not apply if the command issuer
|
|
explicitly interrupts the operation with the <<B>Ctrl-c</B>> command or
|
|
another interrupt signal. In that case, the volume is left locked and
|
|
the administrator must use the <B>vos unlock</B> command to unlock it
|
|
before proceeding.
|
|
<P>It is important that the VLDB accurately indicate the status of the volumes
|
|
on file server machines at all times. The reference pages for the files
|
|
<B>vldb.DB0</B> and
|
|
<B>V</B><VAR>vol_ID</VAR><B>.vol</B> describe the information
|
|
recorded in the VLDB and volume headers, respectively. If a
|
|
<B>vos</B> command changes volume status, it automatically records the
|
|
change in the corresponding VLDB entry. The most common cause of
|
|
discrepancies between the VLDB and volume status on file server machines is
|
|
interrupted operations; to restore consistency, use the <B>vos
|
|
syncserv</B> and <B>vos syncvldb</B> commands.
|
|
<P>There are several categories of commands in the <B>vos</B> command
|
|
suite:
|
|
<UL>
|
|
<P><LI>Commands to create, move, and rename volumes: <B>vos backup</B>,
|
|
<B>vos backupsys</B>, <B>vos create</B>, <B>vos move</B>, and
|
|
<B>vos rename</B>
|
|
<P><LI>Commands to remove VLDB volume records or volumes or both: <B>vos
|
|
delentry</B>, <B>vos remove</B>, and <B>vos zap</B>
|
|
<P><LI>Commands to edit or display VLDB server entries: <B>vos
|
|
changeaddr</B> and <B>vos listaddrs</B>
|
|
<P><LI>Commands to create and restore dump files: <B>vos dump</B> and
|
|
<B>vos restore</B>
|
|
<P><LI>Commands to administer replicated volumes: <B>vos addsite</B>,
|
|
<B>vos release</B>, and <B>vos remsite</B>
|
|
<P><LI>Commands to display VLDB records, volume headers, or both: <B>vos
|
|
examine</B>, <B>vos listvldb</B>, and <B>vos listvol</B>
|
|
<P><LI>Commands to display information about partitions that house volumes:
|
|
<B>vos listpart</B> and <B>vos partinfo</B>
|
|
<P><LI>Commands to restore consistency between the VLDB and volume headers:
|
|
<B>vos syncserv</B> and <B>vos syncvldb</B>
|
|
<P><LI>Commands to lock and unlock VLDB entries: <B>vos lock</B>,
|
|
<B>vos unlock</B>, and <B>vos unlockvldb</B>
|
|
<P><LI>A command to report Volume Server status: <B>vos status</B>
|
|
<P><LI>Commands to obtain help: <B>vos apropos</B> and <B>vos
|
|
help</B>
|
|
</UL>
|
|
<P><STRONG>Options</STRONG>
|
|
<P>The following arguments and flags are available on many commands in the
|
|
<B>bos</B> suite. The reference page for each command also lists
|
|
them, but they are described here in greater detail.
|
|
<DL>
|
|
<P><DT><B>-cell <<VAR>cell name</VAR>>
|
|
</B><DD>Names the cell in which to run the command. It is acceptable to
|
|
abbreviate the cell name to the shortest form that distinguishes it from the
|
|
other entries in the <B>/usr/vice/etc/CellServDB</B> file on the local
|
|
machine. If the <B>-cell</B> argument is omitted, the command
|
|
interpreter determines the name of the local cell by reading the following in
|
|
order:
|
|
<OL TYPE=1>
|
|
<P><LI>The value of the AFSCELL environment variable
|
|
<P><LI>The local <B>/usr/vice/etc/ThisCell</B> file
|
|
</OL>
|
|
<P>
|
|
<P>Do not combine the <B>-cell</B> and <B>-localauth</B>
|
|
options. A command on which the <B>-localauth</B> flag is included
|
|
always runs in the local cell (as defined in the server machine's local
|
|
<B>/usr/afs/etc/ThisCell</B> file), whereas a command on which the
|
|
<B>-cell</B> argument is included runs in the specified foreign
|
|
cell.
|
|
<P><DT><B>-help
|
|
</B><DD>Prints a command's online help message on the standard output
|
|
stream. Do not combine this flag with any of the command's other
|
|
options; when it is provided, the command interpreter ignores all other
|
|
options, and only prints the help message.
|
|
<P><DT><B>-localauth
|
|
</B><DD>Constructs a server ticket using the server encryption key with the
|
|
highest key version number in the local <B>/usr/afs/etc/KeyFile</B>
|
|
file. The <B>vos</B> command interpreter presents the ticket, which
|
|
never expires, to the Volume Server and VL Server during mutual
|
|
authentication.
|
|
<P>Use this flag only when issuing a command on a server machine; client
|
|
machines do not usually have a <B>/usr/afs/etc/KeyFile</B> file.
|
|
The issuer of a command that includes this flag must be logged on to the
|
|
server machine as the local superuser <B>root</B>. The flag is
|
|
useful for commands invoked by an unattended application program, such as a
|
|
process controlled by the UNIX <B>cron</B> utility or by a cron entry in
|
|
the machine's <B>/usr/afs/local/BosConfig</B> file. It is also
|
|
useful if an administrator is unable to authenticate to AFS but is logged in
|
|
as the local superuser <B>root</B>.
|
|
<P>Do not combine the <B>-cell</B> and <B>-localauth</B>
|
|
options. A command on which the <B>-localauth</B> flag is included
|
|
always runs in the local cell (as defined in the server machine's local
|
|
<B>/usr/afs/etc/ThisCell</B> file), whereas a command on which the
|
|
<B>-cell</B> argument is included runs in the specified foreign
|
|
cell. Also, do not combine the <B>-localauth</B> and
|
|
<B>-noauth</B> flags.
|
|
<P><DT><B>-noauth
|
|
</B><DD>Establishes an unauthenticated connection to the Volume Server and VL
|
|
Server, in which the servers treat the issuer as the unprivileged user
|
|
<B>anonymous</B>. It is useful only when authorization checking is
|
|
disabled on the server machine (during the installation of a file server
|
|
machine or when the <B>bos setauth</B> command has been used during other
|
|
unusual circumstances). In normal circumstances, the servers allow only
|
|
privileged users to issue commands that change the status of a volume or VLDB
|
|
record, and refuses to perform such an action even if the <B>-noauth</B>
|
|
flag is provided. Do not combine the <B>-noauth</B> and
|
|
<B>-localauth</B> flags.
|
|
<P><DT><B>-partition <<VAR>partition name</VAR>>
|
|
</B><DD>Identifies the AFS server partition on a file server machine that houses,
|
|
or is to house, the volumes of interest, or about which to list
|
|
information. The <B>vos</B> command interpreter accepts any of the
|
|
following four name formats:
|
|
<PRE> <B>/vicepa</B> = <B>vicepa</B> = <B>a</B> = <B>0</B>
|
|
<B>/vicepb</B> = <B>vicepb</B> = <B>b</B> = <B>1</B>
|
|
|
|
</PRE>
|
|
<P>
|
|
<P>After <B>/vicepz</B> (for which the index is 25) comes
|
|
<PRE> <B>/vicepaa</B> = <B>vicepaa</B> = <B>aa</B> = <B>26</B>
|
|
<B>/vicepab</B> = <B>vicepab</B> = <B>ab</B> = <B>27</B>
|
|
|
|
</PRE>
|
|
<P>and so on through
|
|
<PRE> <B>/vicepiv</B> = <B>vicepiv</B> = <B>iv</B> = <B>255</B>
|
|
|
|
</PRE>
|
|
<P>The <B>-frompartition</B> and <B>-topartition</B> arguments to the
|
|
<B>vos move</B> command also accept this notation.
|
|
<P><DT><B>-server <<VAR>machine name</VAR>>
|
|
</B><DD>Identifies the file server machine that houses, or is to house, the
|
|
volumes or AFS server partitions of interest. Provide the
|
|
machine's IP address in dotted decimal format, its fully qualified host
|
|
name (for example, <B>fs1.abc.com</B>), or the shortest
|
|
abbreviated form of its host name that distinguishes it from other
|
|
machines. Successful use of an abbreviated form depends on the
|
|
availability of a name resolution service (such as the Domain Name Service or
|
|
a local host table) at the time the command is issued.
|
|
<P>The <B>-fromserver</B> and <B>-toserver</B> arguments to the
|
|
<B>vos move</B> command also accept these name formats.
|
|
<P><DT><B>-verbose
|
|
</B><DD>Produces on the standard output stream a detailed trace of the
|
|
command's execution. If this argument is omitted, only warnings
|
|
and error messages appear.
|
|
</DL>
|
|
<P><STRONG>Privilege Required</STRONG>
|
|
<P>To issue most <B>vos</B> commands, the issuer must be listed in the
|
|
<B>/usr/afs/etc/UserList</B> file on each server machine that houses or is
|
|
to house an affected volume, and on each database server machine. The
|
|
most predictable performance results if all database server and file server
|
|
machines in the cell share a common <B>UserList</B> file.
|
|
Alternatively, if the <B>-localauth</B> flag is included, the issuer must
|
|
be logged on to a server machine as the local superuser
|
|
<B>root</B>.
|
|
<P>To issue a <B>vos</B> command that only displays information, no
|
|
privilege is required.
|
|
<P><STRONG>Related Information</STRONG>
|
|
<P><A HREF="auarf020.htm#HDRSV_CSDB">CellServDB (server version)</A>
|
|
<P><A HREF="auarf035.htm#HDRUSERLIST">UserList</A>
|
|
<P><A HREF="auarf253.htm#HDRVOS_ADDSITE">vos addsite</A>
|
|
<P><A HREF="auarf254.htm#HDRVOS_APROPOS">vos apropos</A>
|
|
<P><A HREF="auarf255.htm#HDRVOS_BACKUP">vos backup</A>
|
|
<P><A HREF="auarf256.htm#HDRVOS_BACKUPSYS">vos backupsys</A>
|
|
<P><A HREF="auarf257.htm#HDRVOS_CHANGEADDR">vos changeaddr</A>
|
|
<P><A HREF="auarf258.htm#HDRVOS_CREATE">vos create</A>
|
|
<P><A HREF="auarf259.htm#HDRVOS_DELENTRY">vos delentry</A>
|
|
<P><A HREF="auarf260.htm#HDRVOS_DUMP">vos dump</A>
|
|
<P><A HREF="auarf261.htm#HDRVOS_EXAMINE">vos examine</A>
|
|
<P><A HREF="auarf262.htm#HDRVOS_HELP">vos help</A>
|
|
<P><A HREF="auarf263.htm#HDRVOS_LISTADDRS">vos listaddrs</A>
|
|
<P><A HREF="auarf264.htm#HDRVOS_LISTPART">vos listpart</A>
|
|
<P><A HREF="auarf265.htm#HDRVOS_LISTVLDB">vos listvldb</A>
|
|
<P><A HREF="auarf266.htm#HDRVOS_LISTVOL">vos listvol</A>
|
|
<P><A HREF="auarf267.htm#HDRVOS_LOCK">vos lock</A>
|
|
<P><A HREF="auarf268.htm#HDRVOS_MOVE">vos move</A>
|
|
<P><A HREF="auarf269.htm#HDRVOS_PARTINFO">vos partinfo</A>
|
|
<P><A HREF="auarf270.htm#HDRVOS_RELEASE">vos release</A>
|
|
<P><A HREF="auarf271.htm#HDRVOS_REMOVE">vos remove</A>
|
|
<P><A HREF="auarf272.htm#HDRVOS_REMSITE">vos remsite</A>
|
|
<P><A HREF="auarf273.htm#HDRVOS_RENAME">vos rename</A>
|
|
<P><A HREF="auarf274.htm#HDRVOS_RESTORE">vos restore</A>
|
|
<P><A HREF="auarf275.htm#HDRVOS_STATUS">vos status</A>
|
|
<P><A HREF="auarf276.htm#HDRVOS_SYNCSERV">vos syncserv</A>
|
|
<P><A HREF="auarf277.htm#HDRVOS_SYNCVLDB">vos syncvldb</A>
|
|
<P><A HREF="auarf278.htm#HDRVOS_UNLOCK">vos unlock</A>
|
|
<P><A HREF="auarf279.htm#HDRVOS_UNLOCKVLDB">vos unlockvldb</A>
|
|
<P><A HREF="auarf280.htm#HDRVOS_ZAP">vos zap</A>
|
|
<P>
|
|
<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf251.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf253.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P>
|
|
<!-- Begin Footer Records ========================================== -->
|
|
<P><HR><B>
|
|
<br>© <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A> All Rights Reserved
|
|
</B>
|
|
<!-- End Footer Records ============================================ -->
|
|
<A NAME="Bot_Of_Page"></A>
|
|
</BODY></HTML>
|