Documentation

layman - Manage Gentoo overlays

New in version 1.6.

Synopsis

Uses Layman to manage an additional repositories for the Portage package manager on Gentoo Linux. Please note that Layman must be installed on a managed node prior using this module.

Requirements (on host that executes module)

  • python >= 2.6
  • layman python module

Options

parameter required default choices comments
list_url
no
    An URL of the alternative overlays list that defines the overlay to install. This list will be fetched and saved under ${overlay_defs}/${name}.xml), where overlay_defs is readed from the Layman's configuration.
    name
    yes
      The overlay id to install, synchronize, or uninstall. Use 'ALL' to sync all of the installed overlays (can be used only when state=updated).
      state
      no present
      • present
      • absent
      • updated
      Whether to install (present), sync (updated), or uninstall (absent) the overlay.
      validate_certs
      (added in 1.9.3)
      no yes
      • yes
      • no
      If no, SSL certificates will not be validated. This should only be set to no when no other option exists. Prior to 1.9.3 the code defaulted to no.

      Examples

      # Install the overlay 'mozilla' which is on the central overlays list.
      - layman: name=mozilla
      
      # Install the overlay 'cvut' from the specified alternative list.
      - layman: name=cvut list_url=http://raw.github.com/cvut/gentoo-overlay/master/overlay.xml
      
      # Update (sync) the overlay 'cvut', or install if not installed yet.
      - layman: name=cvut list_url=http://raw.github.com/cvut/gentoo-overlay/master/overlay.xml state=updated
      
      # Update (sync) all of the installed overlays.
      - layman: name=ALL state=updated
      
      # Uninstall the overlay 'cvut'.
      - layman: name=cvut state=absent
      

      This is an Extras Module

      For more information on what this means please read Extras Modules

      For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.