NAME

mount_smbfs, umount_smbfsmount and unmount a shared resource from an SMB file server

SYNOPSIS

mount [-F smbfs] [generic-options] [-o name[=value]] [-O] resource

mount [-F smbfs] [generic-options] [-o name[=value]] [-O] mount-point

mount [-F smbfs] [generic-options] [-o name[=value]] [-O] resource mount-point

umount [-F smbfs] [generic-options] mount-point

DESCRIPTION

The mount utility attaches a named resource, resource, to the file system hierarchy at the path name location, mount-point, which must already exist.
 
The mount utility attaches a named resource, resource, to the file system hierarchy at the path name location, mount-point, which must already exist.
If mount-point has any contents prior to the mount operation, those contents remain hidden until the resource is unmounted. An authorized user with the SYS_MOUNT privilege can perform a mount operation. Also, a user can perform SMBFS mount operations on a directory the user owns.
If the resource is listed in the /etc/vfstab file, you can specify either resource or mount-point as the mount command will consult the /etc/vfstab file for more information. If the -F option is omitted, mount takes the file system type from the entry in the /etc/vfstab file.
If the resource is not listed in the /etc/vfstab file, the command line must specify both resource and mount-point.
The umount utility detaches a mounted file system from the file system hierarchy. An authorized user with the SYS_MOUNT privilege can perform a umount operation. Also, a user can perform SMBFS unmount operations on a directory the user owns.
The network/smb/client service must be enabled to successfully mount an SMB share. This service is enabled, by default.
To enable the service, enter the following svcadm(1M) command:
# svcadm enable network/smb/client

Operands

The mount command supports the following operands:
resource //[workgroup;][user[:password]@]server/share
The name of the resource to be mounted. In addition to its name, you can specify the following information about the resource:
  • password is the password associated with user. If password is not specified, the mount first attempts to use the password stored by the smbutil login command (if any). If that password fails to authenticate, the mount_smbfs prompts you for a password.
  • server is the DNS or NetBIOS name of the remote computer.
  • share is the resource name on the remote server.
  • user is the remote user name. If user is omitted, the logged in user ID is used.
  • workgroup is the name of the workgroup or the Windows domain in which the user name is defined.
    If the resource includes a workgroup, you must escape the semicolon that appears after the workgroup name to prevent it from being interpreted by the command shell. For instance, surround the entire resource name with double quotes:
    mount -F smbfs "//SALES;george@RSERVER" /mnt
mount-point
The path to the location where the file system is to be mounted or unmounted. The mount command maintains a table of mounted file systems in the /etc/mnttab file. See the mnttab(4) man page.

OPTIONS

See the mount(1M) man page for the list of supported generic-options.
-o name[=value]
Sets the file system-specific properties. You can specify more than one name-value pair as a list of comma-separated pairs. No spaces are permitted in the list. The properties are as follows:
acl|noacl
Enable (or disable) presentation of Access Control Lists (ACLs) on files and directories under this smbfs(7FS) mount. The default behavior is noacl, which presents files and directories as owned by the owner of the mount point and having permissions based on fileperms or dirperms. With the acl mount option, files are presented with ACLs obtained from the SMB server. Setting the acl mount option is not advised unless the system is joined to an Active Directory domain and using ldap(1) so it can correctly present ACL identities from the SMB server.
dirperms=octaltriplet
Specifies the permissions to be assigned to directories. The value must be specified as an octal triplet, such as ‘755’. The default value for the directory mode is taken from the fileperms setting, with execute permission added where fileperms has read permission.
Note that these permissions have no relation to the rights granted by the SMB server.
fileperms=octaltriplet
Specifies the permissions to be assigned to files. The value must be specified as an octal triplet, such as ‘644’. The default value is ‘700’.
Note that these permissions have no relation to the rights granted by the SMB server.
gid=groupid
Assigns the specified group ID to files. The default value is the group ID of the directory where the volume is mounted.
intr|nointr
Enable (or disable) cancellation of smbfs(7FS) I/O operations when the user interrupts the calling thread (for example, by hitting Ctrl-C while an operation is underway). The default is intr (interruption enabled), so cancellation is normally allowed.
noprompt
Suppresses the prompting for a password when mounting a share. This property enables you to permit anonymous access to a share. Anonymous access does not require a password.
The mount operation fails if a password is required, the noprompt property is set, and no password is stored by the smbutil login command.
retry_count=number
Specifies the number of SMBFS retries to attempt before the connection is marked as broken. By default, 4 attempts are made.
The retry_count property value set by the mount command overrides the global value set in SMF or the value set in your .nsmbrc file.
timeout=seconds
Specifies the SMB request timeout. By default, the timeout is 15 seconds.
The timeout property value set by the mount command overrides the global value set in SMF or the value set in your .nsmbrc file.
uid=userid
Assigns the specified user ID files. The default value is the owner ID of the directory where the volume is mounted.
xattr|noxattr
Enable (or disable) Extended Attributes in this mount point. This option defaults to xattr (enabled Extended Attributes), but note: if the SMB server does not support SMB "named streams", smbfs(7FS) forces this option to noxattr. When a mount has the noxattr option, attempts to use Extended attributes fail with EINVAL.
-O
Overlays mount. Allow the file system to be mounted over an existing mount point, making the underlying file system inaccessible. If a mount is attempted on a pre-existing mount point without setting this flag, the mount fails, producing the error "device busy."

FILES

/etc/mnttab
Table of mounted file systems.
/etc/dfs/fstypes
Default distributed file system type.
/etc/vfstab
Table of automatically mounted resources.
$HOME/.nsmbrc
User-settable mount point configuration file to store the description for each connection.

EXAMPLES

Example 1 Mounting an SMBFS Share
The following example shows how to mount the /tmp share from the nano server in the SALES workgroup on the local /mnt mount point. You must supply the password for the root user to successfully perform the mount operation.
# mount -F smbfs "//SALES;root@nano.sfbay/tmp" /mnt 
Password:
Example 2 Verifying That an SMBFS File System Is Mounted
The following example shows how to mount the /tmp share from the nano server on the local /mnt mount point. You must supply the password for the root user to successfully perform the mount operation.
# mount -F smbfs //root@nano.sfbay/tmp /mnt 
Password:
You can verify that the share is mounted in the following ways:
  • View the file system entry in the /etc/mnttab file.
    # grep root /etc/mnttab 
    //root@nano.sfbay/tmp   /mnt    smbfs   dev=4900000     1177097833
  • View the output of the ‘mount’ command.
    # mount | grep root 
    /mnt on //root@nano.sfbay/tmp read/write/setuid/devices/dev=4900000 on 
    Fri Apr 20 13:37:13 2007
  • View the output of the ‘df /mnt’ command.
    # df /mnt 
    /mnt               (//root@nano.sfbay/tmp): 3635872 blocks       -1 files
Obtain information about the mounted share by viewing the output of the ‘df -k /mnt’ command.
# df -k /mnt 
Filesystem            kbytes    used   avail capacity  Mounted on 
//root@nano.sfbay/tmp 
                      1882384   64448 1817936     4%    /mnt
Example 3 Unmounting an SMB Share
This example assumes that an SMB share has been mounted on the /mnt mount point. The following command line unmounts the share from the mount point.
# umount /mnt

INTERFACE STABILITY

Committed

SEE ALSO

ldap(1), smbutil(1), mount(1M), mountall(1M), svcadm(1M), acl(2), fcntl(2), link(2), mknod(2), mount(2), symlink(2), umount(2), mnttab(4), nsmbrc(4), vfstab(4), attributes(5), pcfs(7FS), smbfs(7FS)

AUTHORS

This manual page contains material originally authored by Boris Popov <bp@butya.kz>, <bp@FreeBSD.org>.

NOTES

The SMB client always attempts to use gethostbyname(3NSL) to resolve host names. If the host name cannot be resolved, the SMB client uses NetBIOS name resolution (NBNS). By default, the SMB client permits the use of NBNS to enable SMB clients in Windows environments to work without additional configuration.
Since NBNS has been exploited in the past, you might want to disable it. To disable NBNS, set the nbns-enabled service management facility property to false. By default, nbns-enabled is set to true.
If the directory on which a file system is to be mounted is a symbolic link, the file system is mounted on the directory to which the symbolic link refers, rather than being mounted on top of the symbolic link itself.