aboutsummaryrefslogtreecommitdiff
path: root/REFERENCE.md
blob: 613a4df559101f32dc7da35d824807505db6e8a3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->

## Table of Contents

**Resource types**

* [`host`](#host): Installs and manages host entries.  For most systems, these entries will just be in `/etc/hosts`, but some systems (notably OS X) will have d

## Resource types

### host

Installs and manages host entries.  For most systems, these
entries will just be in `/etc/hosts`, but some systems (notably OS X)
will have different solutions.

#### Properties

The following properties are available in the `host` type.

##### `ensure`

Valid values: present, absent

The basic property that the resource should be in.

Default value: present

##### `ip`

The host's IP address, IPv4 or IPv6.

##### `host_aliases`

Any aliases the host might have.  Multiple values must be
specified as an array.

##### `comment`

A comment that will be attached to the line with a # character.

##### `target`

The file in which to store service information.  Only used by
those providers that write to disk. On most systems this defaults to `/etc/hosts`.

#### Parameters

The following parameters are available in the `host` type.

##### `name`

namevar

The host name.