diff options
author | Gabriel Nagy <gabriel.nagy@puppet.com> | 2021-10-01 14:43:35 +0300 |
---|---|---|
committer | Gabriel Nagy <gabriel.nagy@puppet.com> | 2021-10-01 14:43:35 +0300 |
commit | 725d4693895c6ec060b16428a918d4cecb85ae2f (patch) | |
tree | c0766c8a4e904cdd9d9dbbac0e1c1eb7be334f55 | |
parent | dceffe1436b5ae834a192da323004e44048020b2 (diff) | |
download | puppet-hosts_core-725d4693895c6ec060b16428a918d4cecb85ae2f.tar.gz puppet-hosts_core-725d4693895c6ec060b16428a918d4cecb85ae2f.tar.bz2 |
(MODULES-8183) REFERENCE.md ToC fixes
-rw-r--r-- | REFERENCE.md | 38 | ||||
-rw-r--r-- | lib/puppet/type/host.rb | 7 |
2 files changed, 27 insertions, 18 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. + diff --git a/lib/puppet/type/host.rb b/lib/puppet/type/host.rb index 0510180..0e7a21c 100644 --- a/lib/puppet/type/host.rb +++ b/lib/puppet/type/host.rb @@ -1,9 +1,10 @@ require 'puppet/property/ordered_list' Puppet::Type.newtype(:host) do - @doc = "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." + @doc = "@summary 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." ensurable |