motd
Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x
- Puppet >= 7.0.0 < 9.0.0
- , , , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-motd', '7.1.0'
Learn more about managing modules with a PuppetfileDocumentation
motd
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with the motd module
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Module Description
The motd module configures a system message of the day. The module includes a default message template. Alternatively, you can specify a different template or a static string.
Setup
Beginning with the motd module
To configure motd on your system, include the motd
class: include motd
.
Usage
The motd module configures the message of the day on a wide variety of systems. The module populates either /etc/motd
, /etc/issue
and /etc/issue.net
(on POSIX systems) or a registry key (on Windows systems) with the contents of a basic template file.
By default, the module populates motd using the included template. Alternatively, you can specify a different template or a static string. For example, to use a custom template you would set the template parameter:
class { 'motd':
template => 'mymodule/mytemplate.epp',
}
To specify a string as the message of the day:
class { 'motd':
content => "Hello world!\n",
}
Reference
See REFERENCE.md
Limitations
For an extensive list of supported operating systems, see metadata.json
Disabling dynamic motd is supported only on Debian.
A note on Windows
On Windows systems, the motd module populates the contents of HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\policies\system\legalnoticetext
and HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\policies\system\legalnoticecaption
. The legalnoticetext
registry key is shown before login on a Windows system.
Development
We are experimenting with a new tool for running acceptance tests. It's name is puppet_litmus this replaces beaker as the test runner. To run the acceptance tests follow the instructions here.
Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our module contribution guide.
Contributors
The list of contributors can be found at: https://github.com/puppetlabs/puppetlabs-motd/graphs/contributors.
Reference
Table of Contents
Classes
motd
: This module configures a system message of the day on a wide variety of systems.
Classes
motd
This module configures a system message of the day on a wide variety of systems.
Examples
Basic usage
include motd
Parameters
The following parameters are available in the motd
class:
dynamic_motd
template
content
issue_template
issue_content
issue_net_template
issue_net_content
windows_motd_title
dynamic_motd
Data type: Boolean
Enables or disables dynamic motd on Debian systems.
Default value: true
template
Data type: Optional[String]
Specifies a custom template. A template takes precedence over content
. Valid options: '/mymodule/mytemplate.erb'.
Default value: undef
content
Data type: Optional[String]
Specifies a static string as the motd content.
Default value: undef
issue_template
Data type: Optional[String]
Specifies a custom template to process and save to /etc/issue
. A template takes precedence over issue_content
.
Default value: undef
issue_content
Data type: Optional[String]
Specifies a static string as the /etc/issue
content.
Default value: undef
issue_net_template
Data type: Optional[String]
Specifies a custom template to process and save to /etc/issue.net
. A template takes precedence over issue_net_content
.
Default value: undef
issue_net_content
Data type: Optional[String]
Specifies a static string as the /etc/issue.net
content.
Default value: undef
windows_motd_title
Data type: String
Specifies a static string to be used for: 'HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\policies\system\legalnoticetext' and 'HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\CurrentVersion\policies\system\legalnoticecaption' The 'legalnoticetext' registry key is shown before login on a Windows system.
Default value: 'Message of the day'
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v7.1.0 - 2023-06-20
Added
Fixed
v7.0.0 - 2023-04-05
Changed
- (Cont 787) Add Support for Puppet 8 / Drop Support for Puppet 6 #472 (david22swan)
Fixed
- pdksync - (CONT-189) Remove support for RedHat6 / OracleLinux6 / Scientific6 #456 (david22swan)
- pdksync - (CONT-130) - Dropping Support for Debian 9 #450 (jordanbreen28)
v6.3.0 - 2022-10-03
Added
- pdksync - (GH-cat-11) Certify Support for Ubuntu 22.04 #447 (david22swan)
- pdksync - (GH-cat-12) Add Support for Redhat 9 #446 (david22swan)
Fixed
- (MAINT) Dropped support for Windows Server 2008 R2 and FreeBSD #448 (jordanbreen28)
v6.2.0 - 2022-05-30
Added
- Update motd location for FreeBSD 13 and above #431 (Scnaeg)
- pdksync - (IAC-1753) - Add Support for AlmaLinux 8 #428 (david22swan)
- pdksync - (IAC-1751) - Add Support for Rocky 8 #427 (david22swan)
Fixed
- pdksync - (GH-iac-334) Remove Support for Ubuntu 16.04 #433 (david22swan)
- pdksync - (IAC-1787) Remove Support for CentOS 6 #430 (david22swan)
- pdksync - (IAC-1598) - Remove Support for Debian 8 #426 (david22swan)
v6.1.0 - 2021-08-26
Added
- pdksync - (IAC-1709) - Add Support for Debian 11 #420 (david22swan)
Fixed
- (IAC-1741) Allow stdlib v8.0.0 #421 (david22swan)
v6.0.0 - 2021-05-10
Fixed
- (IAC-1497) - Removal of unsupported
translate
dependency #404 (david22swan)
v5.0.0 - 2021-03-01
Changed
- Update metadata.json - remove ubuntu 14.04 #401 (daianamezdrea)
- pdksync - Remove SLES 11 support #399 (sanfrancrisko)
- pdksync - Remove RHEL 5 family support #398 (sanfrancrisko)
- pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 #394 (carabasdaniel)
v4.3.0 - 2020-12-14
Added
- pdksync - (feat) - Add support for Puppet 7 #369 (daianamezdrea)
v4.2.0 - 2020-08-20
Added
- (IAC-974) - Removal of inappropriate terminology #326 (david22swan)
- pdksync - (IAC-973) - Update travis/appveyor to run on new default branch main #320 (david22swan)
- (IAC-746) - Add ubuntu 20.04 support #309 (david22swan)
v4.1.1 - 2020-05-19
Fixed
- (MAINT) Ensure FreeBSD compatibility #271 (dandrzejewski)
v4.1.0 - 2020-01-21
Added
- (MODULES-10242) Add back support for Ubuntu 14.04 #267 (sheenaajay)
- (FM-8691) - Addition of Support for CentOS 8 #264 (david22swan)
Fixed
- (MODULES-10387) Raise lower bound for puppetlabs-registry dependency to 4.0.0 #276 (daianamezdrea)
v4.0.0 - 2019-11-11
Added
Changed
v3.1.0 - 2019-08-01
Added
- (MODULES-9653) Add Windows Server 2019 support #235 (eimlav)
- FM-8043 - redhat8 support #222 (lionce)
Fixed
v3.0.0 - 2019-05-20
Added
- simplistic support for vscode integration to litmus added #212 (abuxton)
- (MODULES-8767) Add support for SLES 15 #205 (eimlav)
- (FM-7647) use puppet_litmus for acceptance testing #200 (tphoney)
Changed
- pdksync - (MODULES-8444) - Raise lower Puppet bound #208 (david22swan)
Fixed
- (bugfix) remove scientific 5 testing #217 (tphoney)
- (FM-8073) litmus block support #216 (tphoney)
- (bugfix) changes needed for litmus 0.1.0 release #214 (tphoney)
- (MODULES-8758) Change memoryfree to memorysize in template #204 (eimlav)
2.1.2 - 2019-01-24
Fixed
2.1.1 - 2018-09-28
Fixed
- (fix) - Changelog Fix #171 (david22swan)
2.1.0 - 2018-09-28
Added
2.0.0 - 2018-09-19
Added
- (FM-7310)- Updating Windows version support #156 (lionce)
- (FM-7306) - Added Puppet 4 data types and changed templates to .epp #152 (eimlav)
- (FM-7307) - added translation functionality #150 (Lavinia-Dan)
- (maint) removing registry pin, update stdlib bound #145 (tphoney)
- (FM-7237) - Addition of support for Ubuntu 18.04 on motd #140 (david22swan)
Changed
- [FM-6965] Removal of unsupported OS from motd #131 (david22swan)
1.9.0 - 2018-05-04
Added
Other
- (maint) - docs update #124 (pmcmaw)
- (MODULES-7124) - Release prep for 1.9.0 #123 (pmcmaw)
- pdksync - Update using 1.5.0 #122 (pmcmaw)
- (MODULES-7069) Add compatibility for AIX #115 (jarretlavallee)
- (MODULES-6881) - Removing duplicaton in .sync.yml #114 (pmcmaw)
1.8.0 - 2018-02-20
Added
1.7.0 - 2018-01-22
Other
- Release prep 1.7.0 #101 (HelenCampbell)
- Conversion using 1.3.2 PDK #100 (HelenCampbell)
- Release mergeback 1.6.0 #98 (pmcmaw)
1.6.0 - 2018-01-04
Other
- Addition of blacksmith Rake tasks #97 (HelenCampbell)
- Add blacksmith for module releases #96 (HelenCampbell)
- 1.6.0 Release Prep #95 (HelenCampbell)
- (maint) Convert module for PDK Compatibility #93 (bmjen)
- (maint) - modulesync 384f4c1 #92 (tphoney)
- RubocopFix #90 (david22swan)
- Convert module to PDK standards using pdk convert #89 (davinhanlon)
- (maint) - modulesync 1d81b6a #88 (pmcmaw)
- 1.5.1 Release mergeback #87 (pmcmaw)
1.5.1 - 2017-10-31
Other
- Release Prep for MOTD 1.5.1 #86 (willmeek)
- Cleanup ruby code via rubocop #85 (willmeek)
- Release mergeback 1.5.0 #83 (pmcmaw)
1.5.0 - 2017-10-24
Other
- Release Prep for MOTD 1.5.0 #82 (willmeek)
- Add set mode for File #81 (willmeek)
- (maint) modulesync 892c4cf #80 (HAIL9000)
- (MODULES-5501) - Remove unsupported Ubuntu #79 (pmcmaw)
- (MODULES-5468) msync, added windows as supported platform #78 (8675309)
- (MODULES-5468) removed 'delete appveyor' code from .sync.yml #77 (8675309)
- (MODULES-3593) Changes default MOTD to something more useful #76 (8675309)
- (maint) modulesync 915cde70e20 #75 (glennsarti)
- Added Solaris support to motd #74 (wfsaxton)
- (MODULES-5187) mysnc puppet 5 and ruby 2.4 #73 (eputnam)
- (MODULES-5144) Prep for puppet 5 #72 (hunner)
- MODULES-4832 updated metadata version #71 (daniel5119)
- [msync] 786266 Implement puppet-module-gems, a45803 Remove metadata.json from locales config #69 (wilson208)
- [MODULES-4528] Replace Puppet.version.to_f version comparison from spec_helper.rb #68 (wilson208)
- Corrected SLES version #67 (cetanu)
- [MODULES-4556] Remove PE requirement from metadata.json #66 (wilson208)
- Implement beaker-module_install_helper #65 (wilson208)
- (MODULES-4098) Sync the rest of the files #64 (hunner)
- (MODULES-4097) Sync travis.yml #63 (hunner)
- add xenial to metadata #62 (eputnam)
- (FM-5972) gettext and spec.opts #61 (eputnam)
- (#5955) Support for /etc/issue and /etc/issue.net #60 (GeoffWilliams)
- (MODULES-3631) msync Gemfile for 1.9 frozen strings #57 (hunner)
- Remove useless test file to pass release_checks #56 (DavidS)
- (MODULES-3704) Update gemfile template to be identical #55 (hunner)
- mocha version update #54 (eputnam)
- (MODULES-3983) Update parallel_tests for ruby 2.0.0 #53 (pmcmaw)
- Update modulesync_config [51f469d][#51](https://github.com/puppetlabs/puppetlabs-motd/pull/51) (DavidS)
- Update modulesync_config [a3fe424][#50](https://github.com/puppetlabs/puppetlabs-motd/pull/50) (DavidS)
- (maint) Fixes dynamic_motd setting on Debian #49 (bmjen)
- (maint) Removes unnecessary test #48 (bmjen)
- (MAINT) Update for modulesync_config 72d19f184 #47 (DavidS)
- (MODULES-3581) modulesync [067d08a][#46](https://github.com/puppetlabs/puppetlabs-motd/pull/46) (DavidS)
- {maint} modulesync 0794b2c #45 (tphoney)
- Update to newest modulesync_configs [9ca280f][#44](https://github.com/puppetlabs/puppetlabs-motd/pull/44) (DavidS)
- (maint) fix test to run under strict variables #43 (tphoney)
- 1.4.x Mergeback #42 (HelenCampbell)
- MODULES-3096 - Update Beaker SUT definitions #41 (borcean)
- Update metadata to note Debian 8 support #40 (DavidS)
- (FM-4046) Update to current msync configs [006831f][#39](https://github.com/puppetlabs/puppetlabs-motd/pull/39) (DavidS)
1.4.0 - 2016-01-25
Other
- (FM-4049) update to modulesync_configs #38 (DavidS)
- FM-4620: edit motd README #37 (jbondpdx)
- Changelog and metadata update for 1.4.0 release #36 (HelenCampbell)
- Fixes acceptance testing for windows #35 (bmjen)
- Fixes tests for debian8 #34 (bmjen)
- Fixes acceptance tests. #33 (bmjen)
- tweak the tests for debian #32 (tphoney)
- (FM-3924) Create Master/Agent automation test for Puppetlabs-motd #29 (phongdly)
1.3.0 - 2015-12-10
Other
- (maint) Update formatting of metadata.json. #30 (bmjen)
- Update Travis config #28 (borcean)
- Cut 1.3.0 release - MODULES-2845 #27 (borcean)
- Use strings for parameter documentation MODULES-2664 #26 (borcean)
- Removed trailing whitespace, proper spacing. MODULES-2663 #25 (borcean)
- Beaker tests modules 2665 #23 (iankronquist)
- Fix for MODULES-2590 #22 (HelenCampbell)
- Add missing stdlib fixture #21 (arioch)
- Added option to disable dynamic motd on Debian based systems #20 (dlactin)
- Added logic for Windows Logon Message #19 (ncorrare)
- fixed static string example that would not display MOTD on CentOS #17 (bsnape)
1.2.0 - 2014-11-04
Other
1.1.1 - 2014-07-15
Other
1.1.0 - 2014-05-28
Other
- Prepare for 1.1.0 release. #14 (underscorgan)
- add test and ERB conditional logic for when ::domain not present #13 (nrvale0)
- Little fix on documentation #12 (leopoiroux)
- Added class parameter for external templates and tests #7 (solarkennedy)
- Add Apache 2.0 license file. #6 (apenney)
- fix a deprecation warning introduced by puppet issue 19058 #5 (nagas)
- Init.pp doesn't meet puppet style guidelines #2 (brianvans)
- Created README content, updated extension and deleted extraneous READMEs #1 (lrnrthr)
1.0.1 - 2012-03-26
1.0.0 - 2012-03-26
Dependencies
- puppetlabs/registry (>= 1.0.0 < 6.0.0)
- puppetlabs/stdlib (>= 2.1.0 < 10.0.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Quality checks
We run a couple of automated scans to help you assess a module’s quality. Each module is given a score based on how well the author has formatted their code and documentation and select modules are also checked for malware using VirusTotal.
Please note, the information below is for guidance only and neither of these methods should be considered an endorsement by Puppet.
Malware scan results
The malware detection service on Puppet Forge is an automated process that identifies known malware in module releases before they’re published. It is not intended to replace your own virus scanning solution.
Learn more about malware scans- Module name:
- puppetlabs-motd
- Module version:
- 7.1.0
- Scan initiated:
- June 21st 2023, 15:48:26
- Detections:
- 0 / 59
- Scan stats:
- 58 undetected
- 0 harmless
- 1 failures
- 0 timeouts
- 0 malicious
- 0 suspicious
- 16 unsupported
- Scan report:
- View the detailed scan report