NAME

Automount.list - automount map information file


SYNOPSIS

item=data . .

AUTOMOUNT


DESCRIPTION

This file describes automount maps in a Unix network. It contains <key>=<value> pairs describing each automount base map and its keys.

This file is used by the Unix::Sysadmin:: object framework to produce amd.map and auto_* maps for amd and autofs respectively. The file may be edited manually, but be sure you know what you are doing.

The file defines three types of entries. The most common is a fully specified map entry, containing both a base map name and a subkey. These specify remote or local filesystems under automounter control. Base map entries are distinguished by having no subkey. A basemap specifies the mount point under which automount entries (keys) will be mounted. Basemap entries define defaults for all the entries that have the base map entry named in their map= field. They therefore must appear before any of their child entries are defined in the file. Finally there is one special entry, /default, that defines defaults for the entire file. It must be the first entry in the file. These types are seperate so that defaults may be specified at the basemap level (overriding /default) for all keys under that basemap. The individual key entries may override these defaults a third time if needed.


FILE STRUCTURE

The file is separated into stanzas, each consisting of one or more fields, one per line. Each field begins with ``item='', where item is a tag naming the field. For example, the following example stanza shows entry for a automount entry for key called '/home/elmer'

 mapname=home
 subkey=elmer
 scope=wabbit-hole:+hunting-lodges
 expt_allow=porky-pen
 expt_deny=+servers:bugs-place
 comment=# Bunny chaser. Watch out for this guy.
 AUTOMOUNT

Each stanza is separated from the next by a separator token on a line by itself. The token for this file is AUTOMOUNT.


FIELDS

The following sections document each defined field's structure and purpose.

mapname

The name of the basemap to which the key belongs. This corresponds to the maps referred to in /etc/auto_master on Solaris (e.g. 'home' for 'auto_home') or the basemap entry in an amd.map file.

 Example:
 mapname=home

subkey

The subkey of the key. All key entries have this field except for the /defaults key (see below) and base map entries.

 Example:
 mapname=home
 subkey=elmer

This example defines the key 'home/elmer'

 Example:
 mapname=home
 (no subkey)

This example defines the base map entry 'home'

opts

Options to the mount command used with this entry. Entries will inherit this value from base maps and base maps will inherit from the /default entry. So there is no need to specify this field for every entry in the file, though that is permitted.

 Example:
 opts=intr,nosuid,noquota,soft,grpid,rw,timeo=10,retrans=10

hosts

The hosts entry specifies where a particular file system is located and how to get to it. There can be multiple hosts fields per automount key. The hosts entry is a colon separated list with the following values:

        hostname:match:type:fs:rfs:rhost

These have the following meanings:

hostname
The hostname of the machine where the map will be used

match
Either == or != according to whether the hostusing the map equals or does not equal hostname.

type
Either link or nfs depending on whether the filesystem is remote or local to hostname

fs
The path to the filesystem if it is local to hostname.

rfs
The remote path to the filesystem if it is not local to hostname.

rhost
The the host serving the filesystem if it is not local to hostname.

Here's an example

 host=wabbit-hole:==:link:/export/home/elmer::
 host=wabbit-hole:!=:nfs:/export/home/elmer:wabbit-hole

This means:

If the host is 'wabbit-hole' then the filesystem is linked to locally from '/export/home/elmer'. If any other host than wabbit-hole, mount the filesystem from wabbit-hole.

scope

Defines what hosts the map entry will be placed on. One of ``ALL'', ``NONE'' or a colon seperated list of hosts and/or netgroups. Scope that permits access is inherited from the /defaults and base map entries. If a permissive scope has been inherited in this way, a local scope that denies access will override the inherited scope. Scope that denies access at the base map level overrides permissive scope at the subkey level. For instance, it would be an error to allow ``/home/elmer'' but not ``/home''. Modified by the expt_allow and expt_deny paramaters.

 Example:
 scope=wabbit-hole:+hunting-lodges

expt_allow

Allow exceptions. Colon separated list of host names and/or netgroups. If scope is 'NONE' or if a host does not appear in scope allow access anyway if listed here. Inherited in the same way as scope. Ignored if scope is 'ALL'.

 Example:
 expt_allow=porky-pen

expt_deny

Allow exceptions. Colon separated list of host names and/or netgroups. If scope is 'ALL' or if a host appears in scope deny access anyway if listed here. Inherited in the same way as scope. Ignored if scope is 'NONE'.

 Example:
 expt_deny=+servers:bugs-place

comment

Comment line that will appear before the current entry in generated files. Note that this must include the comment character itself.

Example:

 comment=# Bunny chaser. Watch out for this guy.


EXAMPLE

Here's a complete example of an Automount file:

 mapname=/defaults
 opts=intr,nosuid,noquota,soft,grpid,rw,timeo=10,retrans=10
 type=nfs
 AUTOMOUNT
 comment=#
 comment=# Home areas.
 comment=#
 mapname=home
 scope=ALL
 type=auto
 fs=${map}
 pref=${key}/
 AUTOMOUNT
 mapname=home
 subkey=elmer
 scope=wabbit-hole:+hunting-lodges
 expt_allow=porky-pen
 expt_deny=+servers:bugs-place
 comment=# Bunny chaser. Watch out for this guy.
 AUTOMOUNT

This file would produce the following amd.map on systems running amd and within the scope for home/elmer:

 /defaults      type:=nfs;opts:=intr,nosuid,noquota,soft,grpid,rw,timeo=10,retrans=10
 #
 # Home areas.
 #
 home           type:=auto;fs:=${map};pref:=${key}/
 # Bunny chaser. Watch out for this guy.
 home/elmer     host==wabbit-hole;type:=link;fs:=/export/${key} \
                host!=wabbit-hole;type:=nfs;rfs:=/export/${key};rhost:=wabbit-hole

The following entry will be added to /etc/auto_master on hosts running automounter and within the scope for home/elmer:

 /home  auto_home       -nobrowse

And the following /etc/auto_home will be produced:

 # home map for automounter
 #
 #
 # Home areas.
 #
 # Bunny chaser. Watch out for this guy.
 elmer -intr,nosuid,noquota,soft,grpid,rw,timeo=10,retrans=10 wabbit-hole:/export/home/elmer


SEE ALSO

Man(3) pages (programmer's docs):

the Unix::Sysadmin::Host manpage, the Unix::Sysadmin::User manpage, the Unix::Sysadmin::Automount manpage, the Unix::Sysadmin::Group manpage, the Unix::Sysadmin::Netgroup manpage, the Unix::Sysadmin::List manpage, the Unix::Sysadmin::Cmds manpage, the Unix::Sysadmin::Files manpage the Unix::Sysadmin::Utility manpage the Unix::Sysadmin::Config manpage, the Unix::Sysadmin::Scoped manpage

Man(4) pages (file formats):

the Unix::Sysadmin::Host.list manpage, the Unix::Sysadmin::User.list manpage, the Unix::Sysadmin::Automount.list manpage, the Unix::Sysadmin::Group.list manpage, the Unix::Sysadmin::Netgroup.list manpage

Man(1m) pages (manager's docs):

the Unix::Sysadmin manpage, the Unix::Sysadmin::Setup manpage the usasetup manpage

the usatest manpage

the usabackup manpage

the usaupdate manpage

the usapush manpage


AUTHOR

Howard Owen <hbo@egbok.com> =cut