REFERENCE.md 8.77 KB
Newer Older
1 2 3 4 5 6 7
# Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->

## Table of Contents

**Classes**

Fabien Combernous's avatar
Fabien Combernous committed
8 9
_Public Classes_

10
* [`freeipa`](#freeipa): Manages IPA masters, replicas and clients.
11
* [`freeipa::config::humanadmins`](#freeipaconfighumanadmins): This class manages admin accounts. It will create/give rights to any admin accounts set to be present. It will delete accounts set to be absent.
Fabien Combernous's avatar
Fabien Combernous committed
12
* [`freeipa::helpers::flushcache`](#freeipahelpersflushcache): Flushcache sss for Debian and RedHat only
13
* [`freeipa::install::autofs`](#freeipainstallautofs): Installs and start autofs
Fabien Combernous's avatar
Fabien Combernous committed
14 15 16

_Private Classes_

Fabien Combernous's avatar
Fabien Combernous committed
17
* `freeipa::config::keytab`: Configures keytab for admin user on FreeIPA master.
Fabien Combernous's avatar
Fabien Combernous committed
18 19 20 21 22 23
* `freeipa::install`: Installs the packages needed for servers and clients
* `freeipa::install::client`: Install freeipa client
* `freeipa::install::server`: This class mainly defines options for the ipa install command, then install master or replica regarding the role set.
* `freeipa::install::server::master`: Installs freeipa server as master
* `freeipa::install::server::replica`: Installs freeipa server as replica
* `freeipa::install::sssd`: Install sssd package
24 25 26

**Defined types**

27
* [`freeipa::config::humanadmin`](#freeipaconfighumanadmin): From FreeIPA master, creates or deletes admin account in FreeIPA.
28 29 30 31 32 33 34

## Classes

### freeipa

Parameters
----------
35 36 37
Also, triggers the install of the required dns server packages.
and passed to the IPA installer.
and passed to the IPA installer.
38 39 40 41 42 43

#### Examples

##### 

```puppet
44 45 46 47
class {'freeipa':
    ipa_role                    => 'master',
    domain                      => 'example.lan',
    ipa_server_fqdn             => 'ipa-server-1.example.lan',
48
    puppet_admin_password       => 'vagrant123',
49 50 51 52 53 54 55
    directory_services_password => 'vagrant123',
    install_ipa_server          => true,
    ip_address                  => '10.10.10.35',
    enable_ip_address           => true,
    enable_hostname             => true,
    manage_host_entry           => true,
    install_epel                => true,
56
    humanadmins => { foo => { password => 'secret123', ensure => 'present'}, bar => { password => 'secret123', ensure => 'present'} },
57
}
58 59 60 61 62 63 64 65
```

#### Parameters

The following parameters are available in the `freeipa` class.

##### `domain`

66
Data type: `Stdlib::Fqdn`
67 68 69 70 71

The name of the IPA domain to create or join.

##### `ipa_role`

Scott Barthelemy's avatar
Scott Barthelemy committed
72
Data type: `Enum['master','replica','client']`
73 74 75

What role the node will be. Options are 'master', 'replica', and 'client'.

76
##### `puppet_admin_password`
77

Scott Barthelemy's avatar
Scott Barthelemy committed
78
Data type: `String[8]`
79 80 81 82 83

Password which will be assigned to the IPA account named 'admin'.

##### `directory_services_password`

Scott Barthelemy's avatar
Scott Barthelemy committed
84
Data type: `String[8]`
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107

Password which will be passed into the ipa setup's parameter named "--ds-password".

##### `autofs_package_name`

Data type: `String`

Name of the autofs package to install if enabled.

Default value: 'autofs'

##### `client_install_ldaputils`

Data type: `Boolean`

If true, then the ldaputils packages are installed if ipa_role is set to client.

Default value: `false`

##### `configure_dns_server`

Data type: `Boolean`

108
If true, then the parameter '--setup-dns' is passed to the IPA server installer.
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127

Default value: `true`

##### `configure_ntp`

Data type: `Boolean`

If false, then the parameter '--no-ntp' is passed to the IPA server installer.

Default value: `true`

##### `custom_dns_forwarders`

Data type: `Array[String]`

Each element in this array is prefixed with '--forwarder' and passed to the IPA server installer.

Default value: []

Scott Barthelemy's avatar
Scott Barthelemy committed
128
##### `principal_usedto_joindomain`
129 130 131 132 133

Data type: `String`

The principal (usually username) used to join a client or replica to the IPA domain.

Scott Barthelemy's avatar
Scott Barthelemy committed
134
Default value: 'admin'
135

Scott Barthelemy's avatar
Scott Barthelemy committed
136
##### `password_usedto_joindomain`
137 138 139 140 141

Data type: `String`

The password for the domain_join_principal.

142
Default value: $puppet_admin_password
143 144 145 146 147

##### `enable_hostname`

Data type: `Boolean`

148
If true, then the parameter '--hostname' is populated with the parameter 'ipa_server_fqdn'
149 150 151 152 153 154 155

Default value: `true`

##### `enable_ip_address`

Data type: `Boolean`

156
If true, then the parameter '--ip-address' is populated with the parameter 'ip_address'
157 158 159 160 161 162 163 164 165 166 167 168 169

Default value: `false`

##### `fixed_primary`

Data type: `Boolean`

If true, then the parameter '--fixed-primary' is passed to the IPA installer.

Default value: `false`

##### `idstart`

Scott Barthelemy's avatar
Scott Barthelemy committed
170
Data type: `Integer[10000]`
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205

From the IPA man pages: "The starting user and group id number".

Default value: 10000

##### `install_autofs`

Data type: `Boolean`

If true, then the autofs packages are installed.

Default value: `false`

##### `install_epel`

Data type: `Boolean`

If true, then the epel repo is installed. The epel repo is usually required for sssd packages.

Default value: `true`

##### `install_sssdtools`

Data type: `Boolean`

If true, then the sssdtools packages are installed.

Default value: `true`

##### `ipa_client_package_name`

Data type: `String`

Name of the IPA client package.

Scott Barthelemy's avatar
Scott Barthelemy committed
206
Default value: $facts['os']['family']
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241

##### `ipa_server_package_name`

Data type: `String`

Name of the IPA server package.

Default value: 'ipa-server'

##### `install_ipa_client`

Data type: `Boolean`

If true, then the IPA client packages are installed if the parameter 'ipa_role' is set to 'client'.

Default value: `true`

##### `install_ipa_server`

Data type: `Boolean`

If true, then the IPA server packages are installed if the parameter 'ipa_role' is not set to 'client'.

Default value: `true`

##### `install_sssd`

Data type: `Boolean`

If true, then the sssd packages are installed.

Default value: `true`

##### `ip_address`

242
Data type: `Stdlib::IP::Address`
243 244 245 246 247

IP address to pass to the IPA installer.

##### `ipa_server_fqdn`

248
Data type: `Stdlib::Fqdn`
249 250 251

Actual fqdn of the IPA server or client.

252
Default value: $facts['networking']['fqdn']
253 254 255 256 257 258 259

##### `ldaputils_package_name`

Data type: `String`

Name of the ldaputils package.

Scott Barthelemy's avatar
Scott Barthelemy committed
260
Default value: $facts['os']['family']
261 262 263

##### `ipa_master_fqdn`

264
Data type: `Stdlib::Fqdn`
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283

FQDN of the server to use for a client or replica domain join.

##### `manage_host_entry`

Data type: `Boolean`

If true, then a host entry is created using the parameters 'ipa_server_fqdn' and 'ip_address'.

Default value: `false`

##### `mkhomedir`

Data type: `Boolean`

If true, then the parameter '--mkhomedir' is passed to the IPA client installer.

Default value: `true`

284
##### `webui_redirect`
285 286 287

Data type: `Boolean`

288
If true, then web requests to URL root / will be redirected to webui https://example.com/ipa/ui.
289

290
Default value: `true`
291 292 293

##### `realm`

294
Data type: `Stdlib::Fqdn`
295 296 297

The name of the IPA realm to create or join.

298
Default value: upcase($domain)
299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323

##### `server_install_ldaputils`

Data type: `Boolean`

If true, then the ldaputils packages are installed if ipa_role is not set to client.

Default value: `true`

##### `sssd_package_name`

Data type: `String`

Name of the sssd package.

Default value: 'sssd-common'

##### `sssdtools_package_name`

Data type: `String`

Name of the sssdtools package.

Default value: 'sssd-tools'

324 325 326 327
##### `humanadmins`

Data type: `Freeipa::Humanadmins`

328
Hash of admin accounts in freeipa. Uses the following schema : Hash[ String[1], Struct[{ password => String[1], Optional[ensure] => Enum['present','absent']}]]
329 330 331

Default value: {}

332 333 334 335 336 337 338 339
##### `install_ca`

Data type: `Boolean`

If true, then the parameter '--setup-ca' is passed to the IPA server installer (for replicas)

Default value: `true`

340 341 342 343 344 345 346 347 348 349
##### `enable_manage_admins`

Data type: `Boolean`



Default value: `true`

### freeipa::config::humanadmins

350
This class manages admin accounts. It will create/give rights to any admin accounts set to be present. It will delete accounts set to be absent.
351 352 353 354 355 356

#### Examples

##### 

```puppet
357 358 359 360 361 362
class { 'freeipa::config::humanadmins' :
  humanadmins => {
    admin1 => {ensure=>'present', password=>'secreat123'},
    admin2 => {ensure=>'absent'},
  }
}
363 364
```

365 366 367 368 369 370 371 372 373 374
#### Parameters

The following parameters are available in the `freeipa::config::humanadmins` class.

##### `humanadmins`

Data type: `Freeipa::Humanadmins`

Hash defines desired admins of FreeIPA

Fabien Combernous's avatar
Fabien Combernous committed
375
### freeipa::helpers::flushcache
376

Fabien Combernous's avatar
Fabien Combernous committed
377
Flushcache sss for Debian and RedHat only
378 379 380 381 382 383

#### Examples

##### 

```puppet
Fabien Combernous's avatar
Fabien Combernous committed
384
include freeipa::helpers::flushcache
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
```

### freeipa::install::autofs

Installs and start autofs

#### Examples

##### 

```puppet
include freeipa::install::autofs
```

## Defined types

401 402
### freeipa::config::humanadmin

403
From FreeIPA master, creates or deletes admin account in FreeIPA.
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432

#### Examples

##### 

```puppet
freeipa::config::humanadmin { 'myadmin' :
  adminsettings => {
    password => 'secret123',
    ensure   =>  'present',
  }
}
```

#### Parameters

The following parameters are available in the `freeipa::config::humanadmin` defined type.

##### `adminsettings`

Data type: `Freeipa::Humanadmin`

Hash of settings for one admin account

Options:

* **:ensure** `Enum['present','absent']`: Desired state
* **:password** `String[1]`: Password of this account