FreeIPA
Draft version. Content is hallucinated. Do not use!
directory

Automount Maps

Manage automount maps and keys for automatic filesystem mounting in NFS environments. Automount configuration enables centralized management of mount points, indirect and direct maps, and supports standard automounter syntax. Features include map and key lifecycle management, location-based map organization, and import/export capabilities for migration and backup.

16 commands
directory
nfs automount filesystem

Stores automount(8) configuration for autofs(8) in IPA.

The base of an automount configuration is the configuration file auto.master. This is also the base location in IPA. Multiple auto.master configurations can be stored in separate locations. A location is implementation-specific with the default being a location named ‘default’. For example, you can have locations by geographic region, by floor, by type, etc.

Automount has three basic object types: locations, maps and keys.

A location defines a set of maps anchored in auto.master. This allows you to store multiple automount configurations. A location in itself isn’t very interesting, it is just a point to start a new automount map.

A map is roughly equivalent to a discrete automount file and provides storage for keys.

A key is a mount point associated with a map.

When a new location is created, two maps are automatically created for it: auto.master and auto.direct. auto.master is the root map for all automount maps for the location. auto.direct is the default map for direct mounts and is mounted on /-.

An automount map may contain a submount key. This key defines a mount location within the map that references another map. This can be done either using automountmap-add-indirect —parentmap or manually with automountkey-add and setting info to “-type=autofs :”.

EXAMPLES

Locations

Create a named location, “Baltimore”:

ipa automountlocation-add baltimore

Display the new location:

ipa automountlocation-show baltimore

Find available locations:

ipa automountlocation-find

Remove a named automount location:

ipa automountlocation-del baltimore

Show what the automount maps would look like if they were in the filesystem:

ipa automountlocation-tofiles baltimore

Import an existing configuration into a location:

ipa automountlocation-import baltimore /etc/auto.master

The import will fail if any duplicate entries are found. For
continuous operation where errors are ignored, use the --continue
option.

Maps

Create a new map, “auto.share”:

ipa automountmap-add baltimore auto.share

Display the new map:

ipa automountmap-show baltimore auto.share

Find maps in the location baltimore:

ipa automountmap-find baltimore

Create an indirect map with auto.share as a submount:

ipa automountmap-add-indirect baltimore --parentmap=auto.share --mount=sub auto.man

This is equivalent to:

ipa automountmap-add-indirect baltimore --mount=/man auto.man
ipa automountkey-add baltimore auto.man --key=sub --info="-fstype=autofs ldap:auto.share"

Remove the auto.share map:

ipa automountmap-del baltimore auto.share

Keys

Create a new key for the auto.share map in location baltimore. This ties

the map we previously created to auto.master:

ipa automountkey-add baltimore auto.master --key=/share --info=auto.share

Create a new key for our auto.share map, an NFS mount for man pages:

ipa automountkey-add baltimore auto.share --key=man --info="-ro,soft,rsize=8192,wsize=8192 ipa.example.com:/shared/man"

Find all keys for the auto.share map:

ipa automountkey-find baltimore auto.share

Find all direct automount keys:

ipa automountkey-find baltimore --key=/-

Remove the man key from the auto.share map:

ipa automountkey-del baltimore auto.share --key=man

Commands

Command Description

automountkey-add Create a new automount key.

automountkey-del Delete an automount key.

automountkey-find Search for an automount key.

automountkey-mod Modify an automount key.

automountkey-show Display an automount key.

automountlocation-add Create a new automount location.

automountlocation-del Delete an automount location.

automountlocation-find Search for an automount location.

automountlocation-show Display an automount location.

automountlocation-tofiles Generate automount files for a specific location.

automountmap-add Create a new automount map.

automountmap-add-indirect Create a new indirect mount point.

automountmap-del Delete an automount map.

automountmap-find Search for an automount map.

automountmap-mod Modify an automount map.

automountmap-show Display an automount map.

automountkey-add

Usage: ipa [global-options] automountkey-add AUTOMOUNTLOCATION AUTOMOUNTMAP [options]

Create a new automount key.

Arguments

Argument Required Description

AUTOMOUNTLOCATION yes Automount location name.

AUTOMOUNTMAP yes Automount map name.

Options

Option Description

--key KEY Automount key name.

--info INFO Mount information

--setattr SETATTR Set an attribute to a name/value pair. Format is attr=value.

--addattr ADDATTR Add an attribute/value pair. Format is attr=value. The attribute

--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

automountkey-del

Usage: ipa [global-options] automountkey-del AUTOMOUNTLOCATION AUTOMOUNTMAP [options]

Delete an automount key.

Arguments

Argument Required Description

AUTOMOUNTLOCATION yes Automount location name.

AUTOMOUNTMAP yes Automount map name.

Options

Option Description

--key KEY Automount key name.

--info INFO Mount information

automountkey-find

Usage: ipa [global-options] automountkey-find AUTOMOUNTLOCATION AUTOMOUNTMAP [CRITERIA] [options]

Search for an automount key.

Arguments

Argument Required Description

AUTOMOUNTLOCATION yes Automount location name.

AUTOMOUNTMAP yes Automount map name.

CRITERIA no A string searched in all relevant object attributes

Options

Option Description

--key KEY Automount key name.

--info INFO Mount information

--timelimit TIMELIMIT Time limit of search in seconds (0 is unlimited)

--sizelimit SIZELIMIT Maximum number of entries returned (0 is unlimited)

--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

automountkey-mod

Usage: ipa [global-options] automountkey-mod AUTOMOUNTLOCATION AUTOMOUNTMAP [options]

Modify an automount key.

Arguments

Argument Required Description

AUTOMOUNTLOCATION yes Automount location name.

AUTOMOUNTMAP yes Automount map name.

Options

Option Description

--key KEY Automount key name.

--info INFO Mount information

--setattr SETATTR Set an attribute to a name/value pair. Format is attr=value.

--addattr ADDATTR Add an attribute/value pair. Format is attr=value. The attribute

--delattr DELATTR Delete an attribute/value pair. The option will be evaluated

--rights Display the access rights of this entry (requires —all). See ipa man page for details.

--newinfo NEWINFO New mount information

--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

--rename RENAME Rename the automount key object

automountkey-show

Usage: ipa [global-options] automountkey-show AUTOMOUNTLOCATION AUTOMOUNTMAP [options]

Display an automount key.

Arguments

Argument Required Description

AUTOMOUNTLOCATION yes Automount location name.

AUTOMOUNTMAP yes Automount map name.

Options

Option Description

--rights Display the access rights of this entry (requires —all). See ipa man page for details.

--key KEY Automount key name.

--info INFO Mount information

--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

automountlocation-add

Usage: ipa [global-options] automountlocation-add LOCATION [options]

Create a new automount location.

Arguments

Argument Required Description

LOCATION yes Automount location name.

Options

Option Description

--setattr SETATTR Set an attribute to a name/value pair. Format is attr=value.

--addattr ADDATTR Add an attribute/value pair. Format is attr=value. The attribute

--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

automountlocation-del

Usage: ipa [global-options] automountlocation-del LOCATION [options]

Delete an automount location.

Arguments

Argument Required Description

LOCATION yes Automount location name.

Options

Option Description

--continue Continuous mode: Don’t stop on errors.

automountlocation-find

Usage: ipa [global-options] automountlocation-find [CRITERIA] [options]

Search for an automount location.

Arguments

Argument Required Description

CRITERIA no A string searched in all relevant object attributes

Options

Option Description

--location LOCATION Automount location name.

--timelimit TIMELIMIT Time limit of search in seconds (0 is unlimited)

--sizelimit SIZELIMIT Maximum number of entries returned (0 is unlimited)

--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

--pkey-only Results should contain primary key attribute only (“location”)

automountlocation-show

Usage: ipa [global-options] automountlocation-show LOCATION [options]

Display an automount location.

Arguments

Argument Required Description

LOCATION yes Automount location name.

Options

Option Description

--rights Display the access rights of this entry (requires —all). See ipa man page for details.

--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

automountlocation-tofiles

Usage: ipa [global-options] automountlocation-tofiles LOCATION [options]

Generate automount files for a specific location.

Arguments

Argument Required Description

LOCATION yes Automount location name.

automountmap-add

Usage: ipa [global-options] automountmap-add AUTOMOUNTLOCATION MAP [options]

Create a new automount map.

Arguments

Argument Required Description

AUTOMOUNTLOCATION yes Automount location name.

MAP yes Automount map name.

Options

Option Description

--desc DESC Description

--setattr SETATTR Set an attribute to a name/value pair. Format is attr=value.

--addattr ADDATTR Add an attribute/value pair. Format is attr=value. The attribute

--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

automountmap-add-indirect

Usage: ipa [global-options] automountmap-add-indirect AUTOMOUNTLOCATION MAP [options]

Create a new indirect mount point.

Arguments

Argument Required Description

AUTOMOUNTLOCATION yes Automount location name.

MAP yes Automount map name.

Options

Option Description

--desc DESC Description

--setattr SETATTR Set an attribute to a name/value pair. Format is attr=value.

--addattr ADDATTR Add an attribute/value pair. Format is attr=value. The attribute

--mount MOUNT Mount point

--parentmap PARENTMAP Name of parent automount map (default: auto.master).

--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

automountmap-del

Usage: ipa [global-options] automountmap-del AUTOMOUNTLOCATION MAP [options]

Delete an automount map.

Arguments

Argument Required Description

AUTOMOUNTLOCATION yes Automount location name.

MAP yes Automount map name.

Options

Option Description

--continue Continuous mode: Don’t stop on errors.

automountmap-find

Usage: ipa [global-options] automountmap-find AUTOMOUNTLOCATION [CRITERIA] [options]

Search for an automount map.

Arguments

Argument Required Description

AUTOMOUNTLOCATION yes Automount location name.

CRITERIA no A string searched in all relevant object attributes

Options

Option Description

--map MAP Automount map name.

--desc DESC Description

--timelimit TIMELIMIT Time limit of search in seconds (0 is unlimited)

--sizelimit SIZELIMIT Maximum number of entries returned (0 is unlimited)

--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

--pkey-only Results should contain primary key attribute only (“map”)

automountmap-mod

Usage: ipa [global-options] automountmap-mod AUTOMOUNTLOCATION MAP [options]

Modify an automount map.

Arguments

Argument Required Description

AUTOMOUNTLOCATION yes Automount location name.

MAP yes Automount map name.

Options

Option Description

--desc DESC Description

--setattr SETATTR Set an attribute to a name/value pair. Format is attr=value.

--addattr ADDATTR Add an attribute/value pair. Format is attr=value. The attribute

--delattr DELATTR Delete an attribute/value pair. The option will be evaluated

--rights Display the access rights of this entry (requires —all). See ipa man page for details.

--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

automountmap-show

Usage: ipa [global-options] automountmap-show AUTOMOUNTLOCATION MAP [options]

Display an automount map.

Arguments

Argument Required Description

AUTOMOUNTLOCATION yes Automount location name.

MAP yes Automount map name.

Options

Option Description

--rights Display the access rights of this entry (requires —all). See ipa man page for details.

--all Retrieve and print all attributes from the server. Affects command output.

--raw Print entries as stored on the server. Only affects output format.

Related Topics

host location