Version information
released Apr 22nd 2024
This version is compatible with:
- Puppet Enterprise 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, 2019.8.x
- Puppet >= 6.21.0 < 99.0.0
Start using this module
Add this module to your Puppetfile:
mod 'rfbennett-ps1h', '0.1.8'Learn more about managing modules with a PuppetfileDocumentation
rfbennett/ps1h — version 0.1.8 Apr 22nd 2024
PS1 Helpers
PS1 Helper files used by assorted custom Puppet modules for use with Microsoft Windows.
Table of Contents
- Description
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
This module assists with centralizing certain PowerShell functions that are utilized by other Windows-based Puppet modules. It removes the need to maintain the exact same code within multiple locations/modules.
Usage
To use this module you simply need to 'Contain' or 'Include' it.
Review the included templates for examples on how to consume the PS1 files
An example of leveraging PowerShell .EPP templates:
$log_output = true
$some_other_param = 'C:\\Windows\\notepad.exe'
$account_password = Sensitive('MockupOfAnEYAMLClassParameter')
$epp_param_hash = {
'account_name' => '.\\name_that_gets_passed_in_directly',
}
if ($account_password.unwrap != '') {
exec { "Executing an example PS1 template for ${module_name}":
provider => powershell,
command => epp("${module_name}/_example_command.ps1.epp", $epp_param_hash),
onlyif => epp("${module_name}/_example_onlyif.ps1.epp", $epp_param_hash),
logoutput => $log_output,
}
}
Remember, you can wrap the entire command within Sensitive if you need to reduce potential leaks:
command => Sensitive(epp("${module_name}/_example_command.ps1.epp", $epp_param_hash)),
onlyif => Sensitive(epp("${module_name}/_example_onlyif.ps1.epp", $epp_param_hash)),
To force log output, create a SYSTEM environment variable named 'PUPPET_PS_HELPER_DEBUG' and set its value to 'True'.
Limitations
- This modules uses the following to generate the contents of the REFERENCE.md file:
puppet strings generate --format markdown --out REFERENCE.md
- This module has been evaluated against the following (as determined using $PSVersionTable):
- Microsoft Windows Server 2022 (running PowerShell 5.1.20348.2227)
- Microsoft Windows Server 2019 (running PowerShell 5.1.17763.5458)
- Microsoft Windows Server 2016 (running PowerShell 5.1.14393.6343)
- Microsoft Windows 11 (running PowerShell 5.1.22621.2506)
Development
Feedback and ideas are always welcome - please contact an Author (listed in metadata.json) to discuss your input, or feel free to simply open an Issue.
Command to apply this module locally (and try it out):
puppet apply --modulepath="<PathToModuleParentFolders>" --execute "include <ModuleName>" --environment "<EnvironmentName>" --no-splay --verbose --debug
For example: puppet apply --modulepath="C:\ProgramData\PuppetLabs\code\environments\production\modules;c:\projects\forge" --execute "include ps1h" --environment "production" --no-splay
Reference
Table of Contents
Classes
ps1h: PS1 Helpers
Classes
ps1h
PS1 Helper files used by assorted custom Puppet modules.
Examples
include ps1h
Parameters
The following parameters are available in the ps1h class:
ensure
Data type: Enum['present', 'absent']
Enumerated string denoting if the resource files should exist Example: 'absent'
Default value: 'present'
Change Log
All notable changes to this project will be documented here.
Release 0.1.8
- Add 'ensure' parameter to allow for easy mass cleanup
- Deprecating in favor of baking PS1 helper files into external modules (using a central repo to maintain authoritative source)
Release 0.1.7
- Add Invoke-HelperItemCopier function to assist with item copying with backups
Release 0.1.6
- Add LogFolder parameter to PS1 scripts to allow custom path for log file
- For example: . "$ps1Helper" -Identifier "example_module" -LogOutput $logOutput -LogFolder "C:\Test\Logs"
Release 0.1.5
- Add more logging to Invoke-HelperComparer PS1 function
Release 0.1.4
- Adjust Invoke-HelperHashToObjectConverter to a more flexible format
- Add note in ReadMe about PUPPET_PS_HELPER_DEBUG environment variable
Release 0.1.3
- Fix ReadMe formatting
Release 0.1.2
- Adjust helpers.ps1 Invoke-HelperExiter function to use Switch statement
- Adjust helpers-output.ps1 output to better leverage 'Error' Type
- Add more intel to Usage example within ReadMe
- Remove redundant parentheses in example templates
Release 0.1.1
- Initial release
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