System Administration Guide, Volume 3

Autofs Administration Task Overview

This section describes some of the most common tasks you might encounter in your own environment. Recommended procedures are included for each scenario to help you configure autofs to best meet your clients' needs.


Note -

Use the Solstice System Management Tools or see the Solaris Naming Administration Guide to perform the tasks discussed in this section.


Autofs Administration Task Map

The following table lists a description and a pointer to many of the tasks that are related to autofs.

Table 30-5 Autofs Administration Task Map

Task 

Description 

For Instructions, Go To ... 

Start autofs 

 Start the automount service without having the reboot the system"How to Start the Automounter"

Stop autofs 

 Stop the automount service without disabling other network services"How to Stop the Automounter"

Access file systems using autofs 

 Access file systems using the automount service"Mounting With the Automounter"

Modifying the autofs maps 

 Steps to modify the master map, which should be used to list other maps"How to Modify the Master Map"

 

 Steps to modify an indirect map, which should be used for most maps"How to Modify Indirect Maps"

 

 Steps to modify a direct map, which should be used when a direct association between a mount point on a client and a server is required"How to Modify Direct Maps"

Modifying the autofs maps to access non NFS file systems 

 Steps to set up an autofs map with an entry for a CD-ROM application"How to Access CD-ROM Applications With Autofs"

 

 Steps to set up an autofs map with an entry for a PC-DOS diskette "How to Access PC-DOS Data Diskettes With Autofs"

 

 Steps to use autofs to access a CacheFS file system "How to Access NFS File Systems Using CacheFS"

Using /home 

Example of how to set up a common /home map"Setting Up a Common View of /home"

 

Steps to set up a /home map that refers to multiple file systems"How to Set Up /home With Multiple Home Directory File Systems"

Using a new autofs mount point 

 Steps to set up a project-related autofs map"How to Consolidate Project-Related Files Under /ws"

 

 Steps to set up an autofs map that supports different client architectures"How to Set Up Different Architectures to Access a Shared Name Space"

 

 Steps to set up an autofs map that supports different operating systems"How to Support Incompatible Client Operating System Versions"

Replicating file systems with autofs 

 Provide access to file systems that failover"How to Replicate Shared Files Across Several Servers"

Using security restrictions with autofs 

Provide access to file systems while restricting remote root access to the files"How to Apply Security Restrictions"

Using a public file handle with autofs 

 Force use of the public file handle when mounting a file system"How to Use a Public File Handle With Autofs"

Using an NFS URL with autofs 

 Add an NFS URL so that the automounter can use it"How to Use NFS URLs With Autofs"

Disable autofs browsability 

 Steps to disable browability so that autofs mount points are not automatically populated on a single client"How to Completely Disable Autofs Browsability on a Single NFS Client"

 

 Steps to disable browability so that autofs mount points are not automatically populated on all clients"How to Disable Autofs Browsability for All Clients"

 

 Steps to disable browability so that a specific autofs mount point is not automatically populated on a client"How to Disable Autofs Browsability on an NFS Client"

Administrative Tasks Involving Maps

The following tables describe several of the factors you need to be aware of when administering autofs maps. Which type of map and which name service you choose changes the mechanism which you need to use to make changes to the autofs maps.

The following table describes the types of maps and their uses.

Table 30-6 Types of autofs Maps and Their Uses

Type of Map 

Use 

Master

Associates a directory with a map 

Direct

Directs autofs to specific file systems 

Indirect

Directs autofs to reference-oriented file systems 

The following table describes how to make changes to your autofs environment based on your name service.

Table 30-7 Map Maintenance

Name Service 

Method 

Local files 

Text editor 

NIS 

make files

NIS+ 

nistbladm

The next table tells you when to run the automount command, depending on the modification you have made to the type of map. For example, if you have made an addition or a deletion to a direct map, you need to run the automount command on the local system to allow the change take effect; however, if you've modified an existing entry, you do not need to run the automount command for the change to take effect.

Table 30-8 When to Run the automount Command

Type of Map 

Restart automount?

 

Addition or Deletion 

Modification 

auto_master

Y

Y

direct

Y

N

indirect

N

N

Modifying the Maps

The following procedures require that you use NIS+ as your name service.

How to Modify the Master Map

  1. Using the nistbladm command, make the changes you want to the master map.

    See the Solaris Naming Administration Guide.

  2. For each client, become superuser.

  3. For each client, run the automount command to ensure the changes you made take effect.

  4. Notify your users of the changes.

    Notification is required so that the users can also run the automount command as superuser on their own computers.

The automount command gathers information from the master map whenever it is run.

How to Modify Indirect Maps

    Using the nistbladm command, make the changes you want to the indirect map.

    See the Solaris Naming Administration Guide.

The change takes effect the next time the map is used, which is the next time a mount is done.

How to Modify Direct Maps

  1. Using the nistbladm command, add or delete the changes you want to the direct map.

    See the Solaris Naming Administration Guide.

  2. If you added or deleted a mount-point entry in step 1, run the automount command.

  3. Notify your users of the changes.

    Notification is required so that the users can also run the automount command as superuser on their own computers.


    Note -

    If you only modify or change the contents of an existing direct map entry, you do not need to run the automount command.


    For example, suppose you modify the auto_direct map so that the /usr/src directory is now mounted from a different server. If /usr/src is not mounted at this time, the new entry takes effect immediately when you try to access /usr/src. If /usr/src is mounted now, you can wait until the auto-unmounting takes place, then access it.


    Note -

    Because of the additional steps, and because they do not take up as much space in the mount table as direct maps, use indirect maps whenever possible. They are easier to construct, and less demanding on the computers' file systems.


Avoiding Mount-Point Conflicts

If you have a local disk partition mounted on /src and you also want to use the autofs service to mount other source directories, you might encounter a problem. If you specify the mount point /src, the service hides the local partition whenever you try to reach it.

You need to mount the partition somewhere else; for example, on /export/src. You would then need an entry in /etc/vfstab like:


/dev/dsk/d0t3d0s5 /dev/rdsk/c0t3d0s5 /export/src ufs 3 yes - 

and this entry in auto_src:


terra		terra:/export/src 

where terra is the name of the computer.

Accessing Non NFS File Systems

Autofs can also mount files other than NFS files. Autofs mounts files on removable media, such as diskettes or CD-ROM. Normally, you would mount files on removable media using the Volume Manager. The following examples show how this mounting could be done through autofs. The Volume Manager and autofs do not work together, so these entries would not be used without first deactivating the Volume Manager.

Instead of mounting a file system from a server, you put the media in the drive and reference it from the map. If you want to access non NFS file systems and you are using autofs, see the following procedures.

How to Access CD-ROM Applications With Autofs


Note -

Use this procedure if you are not using Volume Manager.


  1. Become superuser.

  2. Update the autofs map.

    Add an entry for the CD-ROM file system, which should look like:


    hsfs     -fstype=hsfs,ro     :/dev/sr0

    The CD-ROM device you want to mount must appear as a name following a colon.

How to Access PC-DOS Data Diskettes With Autofs


Note -

Use this procedure if you are not using Volume Manager.


  1. Become superuser.

  2. Update the autofs map.

    Add an entry for the diskette file system such as:


     pcfs     -fstype=pcfs     :/dev/diskette

Accessing NFS File Systems Using CacheFS

The cache file system (CacheFS) is a generic nonvolatile caching mechanism that improves the performance of certain file systems by utilizing a small, fast, local disk.

You can improve the performance of the NFS environment by using CacheFS to cache data from an NFS file system on a local disk.

How to Access NFS File Systems Using CacheFS

  1. Become superuser.

  2. Run the cfsadmin command to create a cache directory on the local disk.


    # cfsadmin -c /var/cache
    
  3. Add the cachefs entry to the appropriate automounter map.

    For example, adding this entry to the master map caches all home directories:


    /home auto_home -fstype=cachefs,cachedir=/var/cache,backfstype=nfs

    Adding this entry to the auto_home map only caches the home directory for the user named rich:


    rich -fstype=cachefs,cachedir=/var/cache,backfstype=nfs dragon:/export/home1/rich

    Note -

    Options that are included in maps that are searched later override options set in maps that are searched earlier. The last options found are the ones that are used. In the previous example, a specific entry added to the auto_home map only needs to include the options listed in the master maps if some of the options needed to be changed.


Customizing the Automounter

You can set up the automounter maps in several ways. The following tasks give detailed instructions on how to customize the automounter maps to provide an easy-to-use directory structure.

Setting Up a Common View of /home

The ideal is for all network users to be able to locate their own, or anyone else's home directory under /home. This view should be common across all computers, whether client or server.

Every Solaris installation comes with a master map: /etc/auto_master.


# Master map for autofs
#
+auto_master
/net     -hosts     -nosuid,nobrowse
/home    auto_home  -nobrowse
/xfn     -xfn

A map for auto_home is also installed under /etc.


# Home directory map for autofs
#
+auto_home

Except for a reference to an external auto_home map, this map is empty. If the directories under /home are to be common to all computers, do not modify this /etc/auto_home map. All home directory entries should appear in the name service files, either NIS or NIS+.


Note -

Users should not be permitted to run setuid executables from their home directories; without this restriction, any user could have superuser privileges on any computer.


How to Set Up /home With Multiple Home Directory File Systems

  1. Become superuser.

  2. Install home directory partitions under /export/home.

    If there are several partitions, install them under separate directories, for example, /export/home1, /export/home2, and so on.

  3. Use the Solstice System Management Tools to create and maintain the auto_home map.

    Whenever you create a new user account, type the location of the user's home directory in the auto_home map. Map entries can be simple, for example:


    rusty        dragon:/export/home1/&
    gwenda       dragon:/export/home1/&
    charles      sundog:/export/home2/&
    rich         dragon:/export/home3/&

    Notice the use of the & (ampersand) to substitute the map key. This is an abbreviation for the second occurrence of rusty in the following example.


    rusty     	dragon:/export/home1/rusty

    With the auto_home map in place, users can refer to any home directory (including their own) with the path /home/user, where user is their login name and the key in the map. This common view of all home directories is valuable when logging in to another user's computer. Autofs mounts your home directory for you. Similarly, if you run a remote windowing system client on another computer, the client program has the same view of the /home directory as you do on the computer providing the windowing system display.

    This common view also extends to the server. Using the previous example, if rusty logs in to the server dragon, autofs there provides direct access to the local disk by loopback-mounting /export/home1/rusty onto /home/rusty.

    Users do not need to be aware of the real location of their home directories. If rusty needs more disk space and needs to have his home directory relocated to another server, you need only change rusty's entry in the auto_home map to reflect the new location. Everyone else can continue to use the /home/rusty path.

How to Consolidate Project-Related Files Under /ws

Assume you are the administrator of a large software development project. You want to make all project-related files available under a directory called /ws. This directory is to be common across all workstations at the site.

  1. Add an entry for the /ws directory to the site auto_master map, either NIS or NIS+.


    /ws     auto_ws     -nosuid 

    The auto_ws map determines the contents of the /ws directory.

  2. Add the -nosuid option as a precaution.

    This option prevents users from running setuid programs that might exist in any workspaces.

  3. Add entries to the auto_ws map.

    The auto_ws map is organized so that each entry describes a subproject. Your first attempt yields a map that looks like the following:


    compiler   alpha:/export/ws/&
    windows    alpha:/export/ws/&
    files      bravo:/export/ws/&
    drivers    alpha:/export/ws/&
    man        bravo:/export/ws/&
    tools      delta:/export/ws/&

    The ampersand (&) at the end of each entry is an abbreviation for the entry key. For instance, the first entry is equivalent to:


    compiler		alpha:/export/ws/compiler 

    This first attempt provides a map that looks simple, but it turns out to be inadequate. The project organizer decides that the documentation in the man entry should be provided as a subdirectory under each subproject. Also, each subproject requires subdirectories to describe several versions of the software. You must assign each of these subdirectories to an entire disk partition on the server.

    Modify the entries in the map as follows:


    compiler \
        /vers1.0    alpha:/export/ws/&/vers1.0 \
        /vers2.0    bravo:/export/ws/&/vers2.0 \
        /man        bravo:/export/ws/&/man
    windows \
        /vers1.0    alpha:/export/ws/&/vers1.0 \
        /man        bravo:/export/ws/&/man
    files \
        /vers1.0    alpha:/export/ws/&/vers1.0 \
        /vers2.0    bravo:/export/ws/&/vers2.0 \
        /vers3.0    bravo:/export/ws/&/vers3.0 \
        /man        bravo:/export/ws/&/man
    drivers \
        /vers1.0    alpha:/export/ws/&/vers1.0 \
        /man        bravo:/export/ws/&/man
    tools \
        /           delta:/export/ws/&

    Although the map now appears to be much larger, it still contains only the five entries. Each entry is larger because it contains multiple mounts. For instance, a reference to /ws/compiler requires three mounts for the vers1.0, vers2.0, and man directories. The backslash at the end of each line tells autofs that the entry is continued onto the next line. In effect, the entry is one long line, though line breaks and some indenting have been used to make it more readable. The tools directory contains software development tools for all subprojects, so it is not subject to the same subdirectory structure. The tools directory continues to be a single mount.

    This arrangement provides the administrator with much flexibility. Software projects are notorious for consuming substantial amounts of disk space. Through the life of the project you might be required to relocate and expand various disk partitions. As long as these changes are reflected in the auto_ws map, the users do not need to be notified, as the directory hierarchy under /ws is not changed.

    Because the servers alpha and bravo view the same autofs map, any users who log in to these computers can find the /ws name space as expected. These users are provided with direct access to local files through loopback mounts instead of NFS mounts.

How to Set Up Different Architectures to Access a Shared Name Space

You need to assemble a shared name space for local executables, and applications, such as spreadsheet tools and word-processing packages. The clients of this name space use several different workstation architectures that require different executable formats. Also, some workstations are running different releases of the operating system.

  1. Create the auto_local map with the nistbladm command.

    See the Solaris Naming Administration Guide.

  2. Choose a single, site-specific name for the shared name space so that files and directories that belong to this space are easily identifiable.

    For example, if you choose /usr/local as the name, the path /usr/local/bin is obviously a part of this name space.

  3. For ease of user community recognition, create an autofs indirect map and mount it at /usr/local. Set up the following entry in the NIS+ (or NIS) auto_master map:


    /usr/local     auto_local     -ro

    Notice that the -ro mount option implies that clients will not be able to write to any files or directories.

  4. Export the appropriate directory on the server.

  5. Include a bin entry in the auto_local map.

    Your directory structure looks like this:


     bin     aa:/export/local/bin 

    To satisfy the need to serve clients of different architectures, references to the bin directory need to be directed to different directories on the server, depending on the clients' architecture type.

  6. To serve clients of different architectures, change the entry by adding the autofs CPU variable.


    bin     aa:/export/local/bin/$CPU 
    • For SPARC clients - Place executables in /export/local/bin/sparc

    • For IA clients - Place executables in /export/local/bin/i386

How to Support Incompatible Client Operating System Versions

  1. Combine the architecture type with a variable that determines the operating system type of the client.

    The autofs OSREL variable can be combined with the CPU variable to form a name that determines both CPU type and OS release.

  2. Create the following map entry.


    bin     aa:/export/local/bin/$CPU$OSREL

    For clients running version 5.6 of the operating system, export the following file systems:

    • For SPARC clients - Export /export/local/bin/sparc5.6

    • For IA clients - Place executables in /export/local/bin/i3865.6

How to Replicate Shared Files Across Several Servers

The best way to share replicated file systems that are read-only is to use failover. See "Client-Side Failover" for a discussion of failover.

  1. Become superuser.

  2. Modify the entry in the autofs maps.

    Create the list of all replica servers as a comma-separated list, such as:


    bin     aa,bb,cc,dd:/export/local/bin/$CPU
    

    Autofs chooses the nearest server. If a server has several network interfaces, list each interface. Autofs chooses the nearest interface to the client, avoiding unnecessary routing of NFS traffic.

How to Apply Security Restrictions

  1. Become superuser.

  2. Create the following entry in the name service auto_master file, either NIS or NIS+:


    /home     auto_home     -nosuid
    

    The nosuid option prevents users from creating files with the setuid or setgid bit set.

    This entry overrides the entry for /home in a generic local /etc/auto_master file (see the previous example) because the +auto_master reference to the external name service map occurs before the /home entry in the file. If the entries in the auto_home map include mount options, the nosuid option is overwritten, so either no options should be used in the auto_home map or the nosuid option must be included with each entry.


    Note -

    Do not mount the home directory disk partitions on or under /home on the server.


How to Use a Public File Handle With Autofs

  1. Become superuser.

  2. Create an entry in the autofs map like:


    /usr/local     -ro,public    bee:/export/share/local

    The public option forces the public handle to be used. If the NFS server does not support a public file handle, the mount will fail.

How to Use NFS URLs With Autofs

  1. Become superuser.

  2. Create an autofs entry like:


    /usr/local     -ro    nfs://bee/export/share/local

    The service tries to use the public file handle on the NFS server, but if the server does not support a public file handle, the MOUNT protocol is used.

Disabling Autofs Browsability

Starting with the Solaris 2.6 release, the default version of /etc/auto_master that is installed has the -nobrowse option added to the entries for /home and /net. In addition, the upgrade procedure adds the -nobrowse option to the /home and /net entries in /etc/auto_master if these entries have not been modified. However, it might be necessary to make these changes manually or to turn off browsability for site-specific autofs mount points after the installation.

You can turn off the browsability feature in several ways. Disable it using a command-line option to the automountd daemon, which completely disables autofs browsability for the client. Or disable it for each map entry on all clients using the autofs maps in either a NIS or NIS+ name space, or for each map entry on each client, using local autofs maps if no network-wide name space is being used.

How to Completely Disable Autofs Browsability on a Single NFS Client

  1. Become superuser.

  2. Add the -n option to the startup script.

    As root, edit the /etc/init.d/autofs script and add the -n option to the line that starts the automountd daemon:


    	/usr/lib/autofs/automountd -n \
    		< /dev/null > /dev/console 2>&1	# start daemon
  3. Restart the autofs service.


    # /etc/init.d/autofs stop
    # /etc/init.d/autofs start
    

How to Disable Autofs Browsability for All Clients

To disable browsability for all clients, you must employ a name service such as NIS or NIS+. Otherwise, you need to manually edit the automounter maps on each client. In this example, the browsability of the /home directory is disabled. You must follow this procedure for each indirect autofs node that needs to be disabled.

  1. Add the -nobrowse option to the /home entry in the name service auto_master file.


    /home     auto_home     -nobrowse 
    
  2. On all clients: run the automount command.

    The new behavior takes effect after running the automount command on the client systems or after a reboot.


    # /usr/sbin/automount
    

How to Disable Autofs Browsability on an NFS Client

In this example, browsability of the /net directory is disabled. The same procedure can be used for /home or any other autofs mount points.

  1. Check the automount entry in /etc/nsswitch.conf.

    For local file entries to take precedence, the entry in the name service switch file should list files before the name service. For example:


    automount:  files nisplus

    This is the default configuration in a standard Solaris installation.

  2. Check the position of the +auto_master entry in /etc/auto_master.

    For additions to the local files to take precedence over the entries in the name space, the +auto_master entry must be moved below /net:


    # Master map for automounter
    #
    /net    -hosts     -nosuid
    /home   auto_home
    /xfn    -xfn
    +auto_master
    

    A standard configuration places the +auto_master entry at the top of the file. This prevents any local changes from being used.

  3. Add the -nobrowse option to the /net entry in the /etc/auto_master file.


    /net     -hosts     -nosuid,nobrowse 
    
  4. On all clients: run the automount command.

    The new behavior takes effect after running the automount command on the client systems or after a reboot.


    # /usr/sbin/automount