Skip to content

Latest commit

 

History

History
303 lines (182 loc) · 7.38 KB

REFERENCE.md

File metadata and controls

303 lines (182 loc) · 7.38 KB

Reference

Table of Contents

Classes

Defined types

Classes

authselect

This will select the requested authselect profile

group: files systemd {exclude if "with-custom-group"} netgroup: files {exclude if "with-custom-netgroup"} automount: files {exclude if "with-custom-automount"} services: files {exclude if "with-custom-services"} sudoers: files {include if "with-sudo"}' ensure: 'file' owner: 'root' group: 'root' mode: '0664'

Examples

Specifying a custom profile
authselect::profile: 'custom/custom_profile_name'
Specifying a vendor profile
authselect::profile: 'sssd'
Creating several profiles with different parameters
authselect::custom_profiles:
  'local_user_minimal':
    base_profile: 'minimal'
  'local_user_linked_nsswitch':
    symlink_nsswitch: true
  'local_user_custom_nsswitch':
    contents:
      'nsswitch.conf':
        content: 'passwd:     files systemd   {exclude if "with-custom-passwd"}

Parameters

The following parameters are available in the authselect class:

package_manage

Data type: Boolean

Should this class manage the authselect package(s)

package_ensure

Data type: String

Passed to package ensure for the authselect package(s)

package_names

Data type: Array[String[1], 1]

Packages to manage in this class

profile_manage

Data type: Boolean

Should this class set the active profile

profile

Data type: String[1]

Which authselect profile should be used. Note: If using a custom (non-vendor) profile you must prefix the name with 'custom/'

profile_options

Data type: Array[String, 0]

What options should we pass to authselect ie, what features should be enabled/disabled?

custom_profiles

Data type: Hash

Custom profiles to manage

authselect::config

Configure authselect

Examples

include authselect::config

authselect::package

Manage the authselect package(s)

Examples

include authselect::package

Defined types

authselect::custom_profile

Manage a custom authselect profile

Examples

authselect::custom_profile { 'namevar': }

Parameters

The following parameters are available in the authselect::custom_profile defined type:

contents

Data type: Hash

Custom profile contents use this only if you fully understand how authselect works!

Default value: {}

base_profile

Data type: Enum['sssd','winbind', 'nis', 'minimal']

the profile to base your custom profile off of, defaults to sssd

Default value: 'sssd'

vendor

Data type: Boolean

Specify whether this profile goes into the custom folder or the vendor profile in authselect keep in mind that if you wish to select a custom profile you must prefix the name of the profile with 'custom/' when setting authselect::profile

Default value: false

symlink_meta

Data type: Boolean

Symlink meta files from the base profile instead of copying them

Default value: false

symlink_nsswitch

Data type: Boolean

Symlink nsswitch files from the base profile instead of copying them

Default value: false

symlink_pam

Data type: Boolean

Symlink pam files from the base profile instead of copying them

Default value: false

symlink_dconf

Data type: Boolean

Symlink dconf files from the base profile instead of copying them

Default value: false

authselect::custom_profile_content

Manage file contents in a custom authselect profile

Examples

authselect::custom_profile_content { 'myprofile/filename':
  content => "File contents\n",
}

Parameters

The following parameters are available in the authselect::custom_profile_content defined type:

content

Data type: String

The file resource content attribute

path

Data type:

Pattern[
    /^\/etc\/authselect\/custom\/[^\/]+\/[^\/]+$/,
    /^\/usr\/share\/authselect\/vendor\/[^\/]+\/[^\/]+$/
  ]

The full path to the managed file

Default value: "/etc/authselect/custom/${name}"

ensure

Data type: Stdlib::Ensure::File

The file resource ensure attribute

Default value: 'file'

owner

Data type: String[1]

The file resource owner attribute

Default value: 'root'

group

Data type: String[1]

The file resource group attribute

Default value: 'root'

mode

Data type: Stdlib::Filemode

The file resource mode attribute

Default value: '0644'