diff options
author | Josh Cooper <josh@puppet.com> | 2018-07-10 00:31:31 -0700 |
---|---|---|
committer | Josh Cooper <josh@puppet.com> | 2018-07-10 11:03:14 -0700 |
commit | 7963657d39e640b733e87dbbd9cdafe9ce9b1866 (patch) | |
tree | 72900087b02c8c3d27222b090d4ae0cb8c88bda9 /REFERENCE.md | |
parent | bb927c4bdd93e085ed2f8838b4d6a1fd1a842305 (diff) | |
download | puppet-hosts_core-7963657d39e640b733e87dbbd9cdafe9ce9b1866.tar.gz puppet-hosts_core-7963657d39e640b733e87dbbd9cdafe9ce9b1866.tar.bz2 |
Add strings reference and updated readme
Diffstat (limited to 'REFERENCE.md')
-rw-r--r-- | REFERENCE.md | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/REFERENCE.md b/REFERENCE.md new file mode 100644 index 0000000..613a4df --- /dev/null +++ b/REFERENCE.md @@ -0,0 +1,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. + |