Skip to content

REFERENCE.md

Latest commit

 

History

History
369 lines (206 loc) · 10.3 KB

REFERENCE.md

File metadata and controls

369 lines (206 loc) · 10.3 KB
Raw

Reference

Table of Contents

Classes

  • realmd: realmd
  • realmd::config: == Class realmd::config This class is called from realmd for service config.
  • realmd::install: == Class realmd::install This class is called from realmd for install.
  • realmd::join: == Class realmd::join This class is called from realmd for joining AD.
  • realmd::join::keytab: == Class realmd::join::keytab This class is called from realmd for performing a passwordless AD join with a Kerberos keytab
  • realmd::join::one_time_password: == Class realmd::join::password This class is called from realmd for joining AD using a username and password. The default password for Wind
  • realmd::join::password: == Class realmd::join::password This class is called from realmd for joining AD using a username and password.
  • realmd::sssd::config: == Class realmd::sssd::config This class is called from realmd for SSSD service configuration.
  • realmd::sssd::service: == Class realmd::sssd::service This class is meant to be called from realmd. It ensure the service is running.

Classes

realmd

Installs, configures, and joins a domain using realmd. Optionally control the Kerberos client and SSSD configuration files and the SSSD service.

Default values for all parameters are in hiera.

Parameters

The following parameters are available in the realmd class:

realmd_package_name

Data type: String

The name of the main Realmd package

realmd_package_ensure

Data type: String

realmd_config_file

Data type: Stdlib::Absolutepath

The absolute path of the Realmd configuration file

realmd_config

Data type: Hash

A hash of configuration options structured in an ini-style format

homedir_umask

Data type: String

A string of the umask for the default directory permissions created by mkhomedir with Debian

adcli_package_name

Data type: String

The name of the adcli package

adcli_package_ensure

Data type: String

krb_client_package_name

Data type: String

The name of the Kerberos client package

krb_client_package_ensure

Data type: String

sssd_package_name

Data type: String

The name of the main SSSD package

sssd_package_ensure

Data type: String

sssd_service_name

Data type: String

The name of the SSSD service

sssd_service_ensure

Data type: String

sssd_config_file

Data type: Stdlib::Absolutepath

The absolute path of the SSSD configuration file

sssd_config_file_mode

Data type: Stdlib::Filemode

A file mode to set on the SSSD configuration file

sssd_config_cache_file

Data type: Stdlib::Absolutepath

sssd_config

Data type: Hash

A hash of configuration options structured in an ini-style format

manage_sssd_config

Data type: Boolean

Enable or disable management of the SSSD configuration file

manage_sssd_service

Data type: Boolean

Enable or disable management of the SSSD service

manage_sssd_package

Data type: Boolean

domain

Data type: String

The name of the domain to join

netbiosname

Data type: String

The computer name used with one-time-password (computer account) join

domain_join_user

Data type: Variant[String, Undef]

The account to be used in joining the domain

domain_join_password

Data type: Variant[String, Undef]

The password of the account to be used in joining the domain

one_time_password

Data type: Variant[String, Undef]

The password of the prepared computer account

krb_ticket_join

Data type: Boolean

Enable of disable joining the domain via a Kerberos keytab

krb_keytab

Data type: Variant[Stdlib::Absolutepath, Undef]

The absolute path to the Kerberos keytab file to be used in joining the domain

krb_config_file

Data type: Stdlib::Absolutepath

The absolute path to the Kerberos client configuration file

krb_config

Data type: Hash

A hash of configuration options structured in an ini-style format

manage_krb_config

Data type: Boolean

Enable or disable management of the Kerberos client configuration file

ou

Data type: Variant[String, Undef]

The computer organizational unit

required_packages

Data type: Hash

A hash of package resources to manage for any auxilliary functionality

extra_join_options

Data type: Variant[Array, Undef]

Extra arguments passed to realm join command

computer_name

Data type: Optional[String[1, 20]]

The computer name used with password and keytab join

Default value: undef

manage_krb_keytab

Data type: Boolean

Whether to manage keytab file

Default value: true

krb_keytab_source

Data type: Optional[String[1]]

Keytab file source

Default value: undef

krb_keytab_content

Data type:

Optional[Variant[
      Binary, Sensitive[Binary],
      String[1], Sensitive[String[1]],
  ]]

Keytab file content. If defined, must be either a strict-base64-encoded String or a Binary stream.

Default value: undef

automatic_id_mapping

Data type: Boolean

Set this to false to not perform UID/GID mapping for users and groups, but expect these identifiers to be present in the domain already.

Default value: true

realmd::config

== Class realmd::config

This class is called from realmd for service config.

realmd::install

== Class realmd::install

This class is called from realmd for install.

realmd::join

== Class realmd::join

This class is called from realmd for joining AD.

realmd::join::keytab

== Class realmd::join::keytab

This class is called from realmd for performing a passwordless AD join with a Kerberos keytab

realmd::join::one_time_password

== Class realmd::join::password

This class is called from realmd for joining AD using a username and password. The default password for Windows ADS is "the first 15 chars of the hostname in lowercase"

realmd::join::password

== Class realmd::join::password

This class is called from realmd for joining AD using a username and password.

realmd::sssd::config

== Class realmd::sssd::config

This class is called from realmd for SSSD service configuration.

realmd::sssd::service

== Class realmd::sssd::service

This class is meant to be called from realmd. It ensure the service is running.