diff options
author | Gabriel Nagy <gabriel.nagy@puppet.com> | 2021-10-04 11:00:55 +0300 |
---|---|---|
committer | Gabriel Nagy <gabriel.nagy@puppet.com> | 2021-10-04 11:20:54 +0300 |
commit | 15049eff83d9fc6231daa4dc85cd34b9d5b2d65b (patch) | |
tree | be9d5fd8bd1be4909f91b306b7221ada9331bba3 /REFERENCE.md | |
parent | ec3ca459f0f3d774119b8fba37390bf212c06923 (diff) | |
download | puppet-mailalias_core-15049eff83d9fc6231daa4dc85cd34b9d5b2d65b.tar.gz puppet-mailalias_core-15049eff83d9fc6231daa4dc85cd34b9d5b2d65b.tar.bz2 |
(MODULES-11197) Update to pdk-templates 2.2.0
Includes REFERENCE.md ToC fixes for MODULES-8183.
Diffstat (limited to 'REFERENCE.md')
-rw-r--r-- | REFERENCE.md | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/REFERENCE.md b/REFERENCE.md new file mode 100644 index 0000000..25a335f --- /dev/null +++ b/REFERENCE.md @@ -0,0 +1,74 @@ +# Reference + +<!-- DO NOT EDIT: This document was generated by Puppet Strings --> + +## Table of Contents + +### Resource types + +* [`mailalias`](#mailalias): Creates an email alias in the local alias database. + +## Resource types + +### <a name="mailalias"></a>`mailalias` + +Creates an email alias in the local alias database. + +#### Examples + +##### using mailalias to redirect mail for the ftp account to root's mailbox + +```puppet + +mailalias { 'ftp': + ensure => present, + recipient => 'root', +} +``` + +#### Properties + +The following properties are available in the `mailalias` type. + +##### `ensure` + +Valid values: `present`, `absent` + +The basic property that the resource should be in. + +Default value: `present` + +##### `file` + +A file containing the alias's contents. The file and the +recipient entries are mutually exclusive. + +##### `recipient` + +Where email should be sent. Multiple values +should be specified as an array. The file and the +recipient entries are mutually exclusive. + +##### `target` + +The file in which to store the aliases. Only used by +those providers that write to disk. + +#### Parameters + +The following parameters are available in the `mailalias` type. + +* [`name`](#name) +* [`provider`](#provider) + +##### <a name="name"></a>`name` + +namevar + +The alias name. + +##### <a name="provider"></a>`provider` + +The specific backend to use for this `mailalias` resource. You will seldom need to specify this --- Puppet will usually +discover the appropriate provider for your platform. + |