Annotation of 43BSDReno/usr.sbin/amd/doc/amq.tex, revision 1.1

1.1     ! root        1: % $Id: amq.tex,v 5.2 90/06/23 22:21:56 jsp Rel $
        !             2: %
        !             3: % Copyright (c) 1989 Jan-Simon Pendry
        !             4: % Copyright (c) 1989 Imperial College of Science, Technology & Medicine
        !             5: % Copyright (c) 1989 The Regents of the University of California.
        !             6: % All rights reserved.
        !             7: %
        !             8: % This code is derived from software contributed to Berkeley by
        !             9: % Jan-Simon Pendry at Imperial College, London.
        !            10: %
        !            11: % Redistribution and use in source and binary forms are permitted provided
        !            12: % that: (1) source distributions retain this entire copyright notice and
        !            13: % comment, and (2) distributions including binaries display the following
        !            14: % acknowledgement:  ``This product includes software developed by the
        !            15: % University of California, Berkeley and its contributors'' in the
        !            16: % documentation or other materials provided with the distribution and in
        !            17: % all advertising materials mentioning features or use of this software.
        !            18: % Neither the name of the University nor the names of its contributors may
        !            19: % be used to endorse or promote products derived from this software without
        !            20: % specific prior written permission.
        !            21: % THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
        !            22: % WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
        !            23: % MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
        !            24: %
        !            25: %      @(#)amq.tex     5.1 (Berkeley) 7/19/90
        !            26: 
        !            27: 
        !            28: \Chapter{Run-time Administration}\label{chapter:amq}
        !            29: 
        !            30: It is sometimes desirable or necessary to exercise external control
        !            31: over some of \amd's internal state.  To support this requirement,
        !            32: \amd\ implements an RPC interface which is used by the \amq\ program.
        !            33: 
        !            34: \Amq\ provides a variety of operations.  With no arguments, \amq\ obtains
        !            35: a brief list of all existing mounts created by \amd.  This is different from
        !            36: the list displayed by {\bf df}(1) since the latter only includes system
        !            37: mount points.
        !            38: The output from this option includes the following information:
        !            39: \begin{itemize}
        !            40: \item the automount point,
        !            41: \item the filesystem type,
        !            42: \item the mount map or mount information,
        !            43: \item the internal, or system mount point.
        !            44: \end{itemize}
        !            45: For example:
        !            46: \begin{verbatim}
        !            47: /            auto  "root"                      sky:(pid75)
        !            48: /homes       auto  /usr/local/etc/amd.homes    /homes
        !            49: /home        auto  /usr/local/etc/amd.home     /home
        !            50: /homes/jsp   nfs   charm:/home/charm           /a/charm/home/charm/jsp
        !            51: /homes/phjk  nfs   toytown:/home/toytown       /a/toytown/home/toytown/ai/phjk
        !            52: \end{verbatim}
        !            53: 
        !            54: The ``-m'' option displays similar information about mounted filesystems,
        !            55: rather than automount points.  The output includes the following
        !            56: information:
        !            57: \begin{itemize}
        !            58: \item the mount information,
        !            59: \item the mount point,
        !            60: \item the filesystem type,
        !            61: \item the number of references to this filesystem,
        !            62: \item the server hostname,
        !            63: \item the state of the file server,
        !            64: \item any error which has occured.
        !            65: \end{itemize}
        !            66: For example:
        !            67: \begin{verbatim}
        !            68: "root"             truth:(pid602)       auto 1 localhost is up
        !            69: hesiod.home        /home                auto 1 localhost is up
        !            70: hesiod.vol         /vol                 auto 1 localhost is up
        !            71: hesiod.homes       /homes               auto 1 localhost is up
        !            72: amy:/home/amy      /a/amy/home/amy      nfs  5 amy is up
        !            73: gould:/home/gould  /a/gould/home/gould  nfs  0 gould is up (Permission denied)
        !            74: noddy:/home/noddy  /a/noddy/home/noddy  nfs  0 noddy is down
        !            75: \end{verbatim}
        !            76: When the reference count is zero the filesystem is not mounted but
        !            77: the mount point and server information is still being maintained
        !            78: by \amd.
        !            79: 
        !            80: \Amq\ generally applies an operation, specified by a single letter option,
        !            81: to a list of mount points.  The default operation is to obtain statistics
        !            82: about each mount point.  This is similar to the output shown above
        !            83: but includes information about the number and type of accesses to each
        !            84: mount point.
        !            85: 
        !            86: By default the local host is used.  In an HP-UX cluster the root server
        !            87: is used since that is the only place in the cluster where \amd\ will be running.
        !            88: To query \amd\ on another host the ``-h'' option should be used.
        !            89: 
        !            90: The ``-u'' option causes the time-to-live interval of the named mount points
        !            91: to be expired, thus causing an unmount attempt.  This is the only safe way
        !            92: to unmount an automounted filesystem.
        !            93: It is not possible to unmount a filesystem which has been mounted with
        !            94: the {\tt notimeout} flag.
        !            95: 
        !            96: %The ``-H'' option informs \amd\ that the specified mount point has hung -
        !            97: %as if its keepalive timer had expired.
        !            98: 
        !            99: The ``-s'' option displays global statistics.  If any other options are specified
        !           100: or any filesystems named then this option is ignored.
        !           101: 
        !           102: The ``-f'' option causes \amd\ to flush the internal mount map cache.  This is
        !           103: useful for YP and Hesiod maps since \amd\ will not notice when they
        !           104: have been updated.
        !           105: 
        !           106: Three other operations are implemented.  These modify the state of
        !           107: \amd\ as a whole, rather than any particular filesystem.
        !           108: The ``-l'', ``-x'' and ``-D'' options have exactly the same effect
        !           109: as \amd's corresponding command line options.  However, the ``-l''
        !           110: option is rejected by \amd\ in version ``\VERSION''
        !           111: for obvious security reasons.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.