Commit f69c5df5 authored by Scott Barthelemy's avatar Scott Barthelemy

Update REFERENCE.md

parent 985b34b8
......@@ -17,7 +17,6 @@
* [`freeipa::install::server::master`](#freeipainstallservermaster): Installs freeipa server as master
* [`freeipa::install::server::replica`](#freeipainstallserverreplica): Installs freeipa server as replica
* [`freeipa::install::sssd`](#freeipainstallsssd): A short summary of the purpose of this class
* [`freeipa::validate_params`](#freeipavalidate_params): Validates input configs from init.pp.
**Defined types**
......@@ -58,32 +57,24 @@ Data type: `Stdlib::Fqdn`
The name of the IPA domain to create or join.
Default value: 'default'
##### `ipa_role`
Data type: `String`
Data type: `Enum['master','replica','client']`
What role the node will be. Options are 'master', 'replica', and 'client'.
Default value: 'default'
##### `admin_password`
Data type: `String`
Data type: `String[8]`
Password which will be assigned to the IPA account named 'admin'.
Default value: ''
##### `directory_services_password`
Data type: `String`
Data type: `String[8]`
Password which will be passed into the ipa setup's parameter named "--ds-password".
Default value: ''
##### `autofs_package_name`
Data type: `String`
......@@ -124,21 +115,21 @@ Each element in this array is prefixed with '--forwarder' and passed to the IPA
Default value: []
##### `domain_join_principal`
##### `principal_usedto_joindomain`
Data type: `String`
The principal (usually username) used to join a client or replica to the IPA domain.
Default value: ''
Default value: 'admin'
##### `domain_join_password`
##### `password_usedto_joindomain`
Data type: `String`
The password for the domain_join_principal.
Default value: ''
Default value: $directory_services_password
##### `enable_hostname`
......@@ -166,7 +157,7 @@ Default value: `false`
##### `idstart`
Data type: `Integer`
Data type: `Integer[10000]`
From the IPA man pages: "The starting user and group id number".
......@@ -210,7 +201,7 @@ Data type: `String`
Name of the IPA client package.
Default value: $::osfamily
Default value: $facts['os']['family']
##### `ipa_server_package_name`
......@@ -250,15 +241,13 @@ Data type: `Stdlib::IP::Address::V4`
IP address to pass to the IPA installer.
Default value: '0.0.0.0'
##### `ipa_server_fqdn`
Data type: `Stdlib::Fqdn`
Actual fqdn of the IPA server or client.
Default value: $::fqdn
Default value: $facts['fqdn']
##### `kstart_package_name`
......@@ -274,7 +263,7 @@ Data type: `String`
Name of the ldaputils package.
Default value: $::osfamily
Default value: $facts['os']['family']
##### `ipa_master_fqdn`
......@@ -282,8 +271,6 @@ Data type: `Stdlib::Fqdn`
FQDN of the server to use for a client or replica domain join.
Default value: 'default'
##### `manage_host_entry`
Data type: `Boolean`
......@@ -314,7 +301,7 @@ Data type: `Stdlib::Fqdn`
The name of the IPA realm to create or join.
Default value: 'default'
Default value: $domain
##### `server_install_ldaputils`
......@@ -521,19 +508,6 @@ Install sssd package
include freeipa::install::sssd
```
### freeipa::validate_params
A description of what this class does
Validates input configs from init.pp.
#### Examples
#####
```puppet
include freeipa::validate_params
```
## Defined types
### freeipa::helpers::flushcache
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment