diff options
Diffstat (limited to 'REFERENCE.md')
| -rw-r--r-- | REFERENCE.md | 38 |
1 files changed, 23 insertions, 15 deletions
diff --git a/REFERENCE.md b/REFERENCE.md index 613a4df..4f5a401 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -1,44 +1,44 @@ # Reference + <!-- DO NOT EDIT: This document was generated by Puppet Strings --> ## Table of Contents -**Resource types** +### 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 +* [`host`](#host): Installs and manages host entries. ## Resource types -### host +### <a name="host"></a>`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. +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` +##### `comment` -Valid values: present, absent +A comment that will be attached to the line with a # character. -The basic property that the resource should be in. +##### `ensure` -Default value: present +Valid values: `present`, `absent` -##### `ip` +The basic property that the resource should be in. -The host's IP address, IPv4 or IPv6. +Default value: `present` ##### `host_aliases` Any aliases the host might have. Multiple values must be specified as an array. -##### `comment` +##### `ip` -A comment that will be attached to the line with a # character. +The host's IP address, IPv4 or IPv6. ##### `target` @@ -49,9 +49,17 @@ those providers that write to disk. On most systems this defaults to `/etc/hosts The following parameters are available in the `host` type. -##### `name` +* [`name`](#name) +* [`provider`](#provider) + +##### <a name="name"></a>`name` namevar The host name. +##### <a name="provider"></a>`provider` + +The specific backend to use for this `host` resource. You will seldom need to specify this --- Puppet will usually +discover the appropriate provider for your platform. + |