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
- , , , , , , ,
Tasks:
- package
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-package', '3.1.0'
Learn more about managing modules with a PuppetfileDocumentation
package
Table of Contents
Overview
This module provides the package task.
Description
This task allows you to install, uninstall, update, and check the status of packages.
Setup
Requirements
This module is compatible with Puppet Enterprise and Puppet Bolt.
-
To run tasks with Puppet Enterprise, PE 2018.1 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must be Puppet agents.
-
To run tasks with Puppet Bolt, Bolt 1.0 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must have SSH or WinRM services enabled.
Usage
To view the available actions and parameters, on the command line, run puppet task show package
or see the package module page on the Forge.
For a complete list of optional package providers that are supported, see the Puppet Types documentation.
To run a package task, use the task command, specifying the action and the name of the package.
To show help for the task CLI, run puppet task run --help
or bolt task run --help
- With PE on the command line, run
puppet task run package action=<ACTION> name=<PACKAGE_NAME>
. - With Bolt on the command line, run
bolt task run package action=<ACTION> name=<PACKAGE_NAME>
.
For example, to check whether the vim package is present or absent, run:
- With PE, run
puppet task run package action=status name=vim --nodes neptune
. - With Bolt, run
bolt task run package action=status name=vim --nodes neptune --modulepath ~/modules
.
You can also run tasks in the PE console. See PE task documentation for complete information.
Reference
For information on the classes and types, see the REFERENCE.md.
Limitations
For an extensive list of supported operating systems, see metadata.json
License
This codebase is licensed under the Apache2.0 licensing, however due to the nature of the codebase the open source dependencies may also use a combination of AGPL, BSD-2, BSD-3, GPL2.0, LGPL, MIT and MPL Licensing.
Development
Tests are ran using puppet_litmus. To run the acceptance tests follow the instructions from this point here.
Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. To contribute to Puppet projects, see our module contribution guide.
Reference
Table of Contents
Tasks
init
: Manage and inspect the state of packageslinux
: Manage and inspect the state of packages (without a puppet agent)windows
: Manage the state of packages (without a puppet agent)
Tasks
init
Manage and inspect the state of packages
Supports noop? false
Parameters
action
Data type: Enum[install, status, uninstall, upgrade]
The operation (install, status, uninstall and upgrade) to perform on the package.
name
Data type: String[1]
The name of the package to be manipulated.
version
Data type: Optional[String[1]]
Version numbers must match the full version to install, including release if the provider uses a release moniker. Ranges or semver patterns are not accepted except for the gem package provider. For example, to install the bash package from the rpm bash-4.1.2-29.el6.x86_64.rpm, use the string '4.1.2-29.el6'.
manager_options
Data type: Optional[String[1]]
options to be sent to the package manager
provider
Data type: Optional[String[1]]
The provider to use to manage or inspect the package, defaults to the system package manager. Only used when the 'puppet-agent' feature is available on the target so we can leverage Puppet.
linux
Manage and inspect the state of packages (without a puppet agent)
Supports noop? false
Parameters
action
Data type: Enum[install, status, uninstall, upgrade]
The operation (install, status, uninstall and upgrade) to perform on the package.
name
Data type: String[1]
The name of the package to be manipulated.
manager_options
Data type: Optional[String[1]]
options to be sent to the package manager
version
Data type: Optional[String[1]]
Version numbers must match the full version to install, including release if the provider uses a release moniker. Ranges or semver patterns are not accepted except for the gem package provider. For example, to install the bash package from the rpm bash-4.1.2-29.el6.x86_64.rpm, use the string '4.1.2-29.el6'.
provider
Data type: Optional[String[1]]
The provider to use to manage or inspect the package, defaults to the system package manager. Only used when the 'puppet-agent' feature is available on the target so we can leverage Puppet.
windows
Manage the state of packages (without a puppet agent)
Supports noop? false
Parameters
action
Data type: Enum[install, uninstall, upgrade, status]
The action to be applied to the package: install, uninstall, upgrade, and status.
name
Data type: String[1]
The name of the package to manage.
version
Data type: Optional[String[1]]
The version, and if applicable, the release value of the package. A version number range or a semver pattern are not permitted. For example, to install the bash-4.1.2-29.el6.x86_64.rpm package, enter 4.1.2-29.el6.
What are tasks?
Modules can contain tasks that take action outside of a desired state managed by Puppet. It’s perfect for troubleshooting or deploying one-off changes, distributing scripts to run across your infrastructure, or automating changes that need to happen in a particular order as part of an application deployment.
Tasks in this module release
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.
v3.1.0 - 2024-12-17
Added
- (CAT-2125) Add Ubuntu 24.04 support #341 (shubhamshinde360)
- (CAT-2100) Add Debian 12 support #340 (shubhamshinde360)
Fixed
- (CAT-2158) Upgrade rexml to address CVE-2024-49761 #342 (amitkarsale)
v3.0.1 - 2024-03-01
Fixed
v3.0.0 - 2023-04-19
Changed
- (CONT-791) - Add Puppet 8/Drop Puppet 6 #307 (jordanbreen28)
v2.4.0 - 2023-04-19
Added
- Add Compatibility with FreeBSD #306 (smortex)
- Improve package status consistency on Debian #303 (smortex)
Fixed
- Fix shebangs #305 (smortex)
- Unset user-defined locale variables #304 (smortex)
- pdksync - (CONT-189) Remove support for RedHat6 / OracleLinux6 #292 (david22swan)
- pdksync - (CONT-130) - Dropping Support for Debian 9 #289 (jordanbreen28)
v2.3.0 - 2022-10-03
Added
- pdksync - (GH-cat-11) Certify Support for Ubuntu 22.04 #286 (david22swan)
- pdksync - (GH-cat-12) Add Support for Redhat 9 #285 (david22swan)
Fixed
- (MAINT) Drop support for windows server 2008 R2. #287 (jordanbreen28)
v2.2.0 - 2022-05-30
Added
- pdksync - (FM-8922) - Add Support for Windows 2022 #275 (david22swan)
- pdksync - (IAC-1753) - Add Support for AlmaLinux 8 #270 (david22swan)
- pdksync - (IAC-1751) - Add Support for Rocky 8 #269 (david22swan)
- Expose package manager options to task #265 (MartyEwings)
Fixed
- pdksync - (GH-iac-334) Remove Support for Ubuntu 14.04/16.04 #277 (david22swan)
- pdksync - (IAC-1787) Remove Support for CentOS 6 #273 (david22swan)
- pdksync - (IAC-1598) - Remove Support for Debian 8 #268 (david22swan)
v2.1.0 - 2021-08-16
Added
- pdksync - (IAC-1720) - Add Support for Ubuntu 20.04 #263 (david22swan)
- pdksync - (IAC-1709) - Add Support for Debian 11 #261 (david22swan)
- pdksync - (IAC-1719) - Add Support for Debian 10 #260 (david22swan)
v2.0.0 - 2021-03-02
Changed
- pdksync - Remove RHEL 5 family support #240 (sanfrancrisko)
- pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 #235 (carabasdaniel)
Fixed
v1.4.0 - 2020-12-09
Added
- pdksync - (feat) - Add support for Puppet 7 #224 (daianamezdrea)
- (MODULES-10842) - Allow version to be set when installing via init task #217 (david22swan)
Fixed
v1.3.0 - 2020-10-01
Added
- pdksync - (IAC-973) - Update travis/appveyor to run on new default branch
main
#208 (david22swan)
Fixed
v1.2.0 - 2020-06-26
Added
v1.1.0 - 2019-12-11
Added
- pdksync - "MODULES-10242 Add ubuntu14 support back to the modules" #167 (sheenaajay)
v1.0.0 - 2019-12-02
Changed
Added
- (FM-8692) - Addition of Support for CentOS 8 #161 (david22swan)
v0.7.0 - 2019-10-28
Added
- (BOLT-1525) Zypper implementation #143 (m0dular)
- (FM-8225) Convert to litmus testing #134 (sheenaajay)
v0.6.0 - 2019-06-13
Changed
- pdksync - (MODULES-8444) - Raise lower Puppet bound #123 (david22swan)
Added
- (FM-8156) Add Windows Server 2019 support #129 (eimlav)
- (FM-8044) Add Redhat8 support #128 (sheenaajay)
- (Bolt-1104) - Add linux package task uninstall #126 (m0dular)
Fixed
v0.5.0 - 2019-04-10
Added
- (SEN-795) Move extension metadata to init.json #119 (conormurray95)
- (SEN-795) Add discovery extension metadata #118 (conormurray95)
- (BOLT-1104) Unify task implementation output #117 (donoghuc)
Fixed
- (MODULES-8717) Fix for boltspec run dependancy issue #113 (HelenCampbell)
0.4.1 - 2019-01-09
Fixed
0.4.0 - 2019-01-08
Added
- (MODULES-8390) Enable implementations on the init task and hide others #96 (MikaelSmith)
Fixed
- pdksync - (FM-7655) Fix rubygems-update for ruby < 2.3 #97 (tphoney)
- (MODULES-8045) Fix apt-get upgrading everything when no version passed and apt is package manager. #92 (eoinmcq)
0.3.0 - 2018-09-28
Added
- pdksync - (FM-7392) - Puppet 6 Testing Changes #88 (pmcmaw)
- (DI-3260) Adding agentless windows task (for choco) #81 (HairyMike)
- (DI-2373) Adding agentless linux task #77 (tphoney)
- (FM-7263) - Addition of support for ubuntu 18.04 #70 (david22swan)
- [FM-7058] Addition of support for Debian 9 to package #69 (david22swan)
0.2.0 - 2018-03-05
0.1.5 - 2017-10-11
0.1.4 - 2017-10-10
0.1.3 - 2017-10-04
0.1.2 - 2017-09-21
0.1.1 - 2017-09-20
Fixed
0.1.0 - 2017-09-11
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-package
- Module version:
- 3.1.0
- Scan initiated:
- December 16th 2024, 21:25:13
- Detections:
- 0 / 51
- Scan stats:
- 50 undetected
- 0 harmless
- 1 failures
- 0 timeouts
- 0 malicious
- 0 suspicious
- 14 unsupported
- Scan report:
- View the detailed scan report