Version information
This version is compatible with:
- Puppet Enterprise 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, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
- Puppet >= 6.0.0 < 8.0.0
- ,
Start using this module
Add this module to your Puppetfile:
mod 'n3snah-powershell7', '0.4.0'Learn more about managing modules with a PuppetfileDocumentation
powershell7
This module has been developed to manage the installation of PowerShell 7.
Table of Contents
- Description
- Setup - The basics of getting started with powershell7
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
PowerShell 7 is the latest major update which builds on PowerShell 6 core. This version of PowerShell brings many new features, cmdlets and includes a number of bugfixes.
Setup
Software Prerequisites
On Ubuntu, this module assumes that you have the following sofware is either already installed or in a manifest to install as this will attempt to download files from HTTPS:
- apt-transport-https
- software-properties-common
Please refer to the metadata.json file for a list of required modules and their
supported versions.
Beginning with powershell7
include powershell7 is enough to get started and have PowerShell 7 installed on
your Windows or Linux system.
Usage
All parameters for this module are contained in the powershell7 class. If you would like to alter installation settings such as context menu options please see below.
Install and Enable PowerShell 7
include powershell7
Disable Context Menu Options
class { 'powershell7':
'add_explorer_context_menu_openpowershell' => 0,
'add_file_context_menu_runpowershell' => 0,
}
Disable PS Remoting
class { 'powershell7':
'enable_psremoting' => 0,
}
Change Update Notification Settings
PowerShell 7 added a new feature to alert users when a newer version of the PowerShell
application is available. This can be configured to Off, Default or LTS.
The notification doesn't provide any capabilities to update PowerShell but just to notify only.
class { 'powershell7':
'powershell_updatecheck' => 'LTS',
}
This won't affect Linux installs at this time.
Configuring PowerShell Window Settings
Default PowerShell 7 window behaviour can now be customized which includes changing the size of the window along with also changing the buffer size and even the background/foreground color. With PowerShell, the buffer width must be equal to the same size as the window width so there is no option available to change this setting and will always be set to the same size.
class { 'powershell7':
'config_window_width' => 400,
'config_window_height' => 60,
'config_buffer_height' => 7000,
'config_background_color => 'Blue',
'config_foreground_color => 'White',
}
PowerShell Window Colors
PowerShell 7 only allows certain colors for the background and the foreground. This is the list of acceptable colors.
- Black
- DarkBlue
- DarkGreen
- DarkCyan
- DarkRed
- DarkMagenta
- DarkYellow
- Gray
- Blue
- Green
- Cyan
- Red
- Magenta
- Yellow
- White
PowerShell release types
There are 3 versions of powershell which can be installed onto any system.
- lts - Long Term Support which is aimed at consumers who which to have very stable and long supported releases
- preview - which is aimed at the more bleeding-edge type releases. Not usually ideal for enterprises.
- stable - releases where they bring in new features more often than LTS but deemed more stable than preview.
class { 'powershell7':
'release_type => 'lts'
}
Limitations
Currently if you have PowerShell installed on Ubuntu and you decide to change the release type. Puppet is unable to uninstall
the current package and install the new package. If you run a apt-remove <packagename> puppets next run should succeed. A
future task will be made available to handle this.
Due to using the Stdlib::Absolutepath and the way that the code is structured. You cannot have download_dir set to C:\.
This would cause the path to end up something like C:\\file.msi which wouldn't be a valid windows path.
Development
If you would like to contribute to this module. Fork me on github, make your
desired changes and create a Pull request back to n3snah/powershell7
Reference
Table of Contents
Classes
Public Classes
powershell7: This is the powershell7 module main class
Private Classes
powershell7::config: Configuration options for Powershell 7 once installedpowershell7::install: Install PowerShell 7powershell7::install::ubuntu: Install PowerShell 7 on Ubuntu systemspowershell7::install::windows: Install Powershell 7 on Windows systems
Data types
Powershell7::Windowcolor: Creates a new type alias which ensures that the PowerShell Background/Foreground colors are limited to those that are supported by the application.
Classes
powershell7
powershell7
This class declares all module parameters and calls the necessary classes to install PowerShell 7
Examples
Basic usage
include powershell7
Configuring window defaults
class { 'powershell7':
config_window_width => 400,
config_window_height => 60,
config_buffer_height => 6000,
config_background_color => 'Blue',
config_foreground_color => 'White',
}
Using a different download location and version of the installer
class {
lts_file_name => 'PowerShell-7.0.6-win-x64.msi',
lts_source_url => 'https://myserver.internal.com/PowerShell/PowerShell-7.0.6-win-x64.msi',
}
Parameters
The following parameters are available in the powershell7 class:
os_letterrelease_typeadd_explorer_context_menu_openpowershelladd_file_context_menu_runpowershellenable_psremotingregister_manifestpowershell_updatecheckconfig_window_widthconfig_window_heightconfig_buffer_heightconfig_background_colorconfig_foreground_colorapt_repositorydownload_dirlts_file_namelts_source_urlstable_file_namestable_source_urlpreview_file_namepreview_source_url
os_letter
Data type: Optional[Pattern[/^[A-Z]$/]]
The Letter of the disk which has the Windows folder. Defaults to C
Default value: undef
release_type
Data type: ENUM['lts','stable','preview']
Defines which PowerShell release type to be installed. Defaults to stable
add_explorer_context_menu_openpowershell
Data type: Integer[0,1]
Adds a context menu item for explorer and will open a PowerShell window at the current location. Defaults to 1
add_file_context_menu_runpowershell
Data type: Integer[0,1]
Adds a context menu item to run the selected file in PowerShell. Defaults to 1
enable_psremoting
Data type: Integer[0,1]
Enables PS Remoting during installation. Defaults to 1
register_manifest
Data type: Integer[0,1]
Enables the Windows Event Logging Manifest. Defaults to 1
powershell_updatecheck
Data type: ENUM['Off','Default','LTS']
Sets the update notification policy to alert users to the availability of updates. Defaults to 'Default'
config_window_width
Data type: Integer
Sets the width of the PowerShell window. This also needs to set the Buffer width also as they can't be different. Defaults to 120
config_window_height
Data type: Integer
Sets the height of the PowerShell window. Defaults to 30
config_buffer_height
Data type: Integer
Sets how far you can vertically scroll the window to see previous commands and output. Defaults to 9001
config_background_color
Data type: Powershell7::Windowcolor
Sets the color of the window behind the text. Defaults to 'Black'
config_foreground_color
Data type: Powershell7::Windowcolor
Sets the color of the foreground text color. Defaults to 'White'
apt_repository
Data type: Optional[Stdlib::HTTPUrl]
Sets the Apt Repository location for downloading PowerShell on Linux. Defaults to official Microsoft repository
Default value: undef
download_dir
Data type: Optional[Stdlib::Absolutepath]
The directory where the downloaded installer is placed.
Default value: undef
lts_file_name
Data type: Optional[String]
The name of the LTS PowerShell installer
Default value: undef
lts_source_url
Data type: Optional[Stdlib::HTTPUrl]
The internet URL for the LTS Powershell Download
Default value: undef
stable_file_name
Data type: Optional[String]
The name of the Stable PowerShell installer
Default value: undef
stable_source_url
Data type: Optional[Stdlib::HTTPUrl]
The internet URL for the Stable Powershell Download
Default value: undef
preview_file_name
Data type: Optional[String]
The name of the Preview PowerShell installer
Default value: undef
preview_source_url
Data type: Optional[Stdlib::HTTPUrl]
The internet URL for the Preview Powershell Download
Default value: undef
Data types
Powershell7::Windowcolor
Powershell7::Windowcolor
Alias of
Enum['Black', 'DarkBlue', 'DarkGreen', 'DarkCyan', 'DarkRed', 'DarkMagenta', 'DarkYellow', 'Gray', 'Blue', 'Green', 'Cyan', 'Red', 'Magenta', 'Yellow', 'White']
Changelog
All notable changes to this project will be documented in this file.
Release 0.4.0 (2021/10/19)
Features
- Added: Support for installing PowerShell 7 on Ubuntu 18.04 and Ubuntu 20.04 systems.
- Added: Added information to readme to document any requirements.
- Added: Added new parameter
apt_repositoryfor Ubuntu PowerShell package management. - Added: Many params in init.pp are now optional. Mainly because Linux would throw errors if they weren't defined.
- Added: Code coverage reports for RSPEC and Travis CI.
- Updated: Module has been updated to PDK v2.1.1.
- Updated: PowerShell Preview URL has been updated to 7.2.0 Preview 7
- Updated: REFERENCE.md has been regenerated via
puppet stringsto account for new changes for Ubuntu support.
Bugfixes
- Fix: Fixed case with
Windows Server 2012 R2as it wasn't testing correctly. - Fix: Added in missing Table of Contents link for
PowerShell Windows Colors. - Fix: Deploy stage has been set to
masterinstead ofmain.
Release 0.3.0 (2021/05/13)
Features
- Added: New file REFERENCE.md which is viewable on the forge.
- Added: New file LICENSE which displays the apache 2.0 module license agreement.
- Added: New files for Github issue templates.
- Added: Generated Puppet Strings Documentation
- Added: New configuration capability to manage PowerShell Profile settings (All Users, Current Host)
- Added: New Data Type Alias
Powershell7::Windowcolorto restrict Window Background/Foreground to specific colors
Bugfixes
- Fix: Removed hardcoded Windows paths from powershell7::install exec resource
Release 0.2.0 (2021/04/07)
Features
- Added: able to set the notification policy for Powershell 7 Update checks.
- Added: added metadata.json tags for better visibility of what this module references.
Bugfixes
- Fix: powershell7::install exec kept running due to the creates attribute sourcing the wrong file.
- Fix: installation source URLs now allow HTTP as well has HTTPS locations.
- Fix: supported version of puppet was lowered to
6.0.0as it works across all Puppet 6 versions.
Release 0.1.0 (2021/04/06)
Features
- Added: Able to install PowerShell 7 on Windows Server (2012 R2, 2016, 2019)
Bugfixes
Known Issues
Dependencies
- puppetlabs/apt (>= 7.5.0 < 9.0.0)
- puppetlabs/stdlib (>= 4.13.1 < 8.0.0)
- puppetlabs/registry (>= 3.0.0 < 5.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.