Forge Home

package

Tasks that manipulate a package

152,599 downloads

6,489 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
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.

Version information

  • 3.0.1 (latest)
  • 3.0.0
  • 2.4.0
  • 2.3.0
  • 2.2.0
  • 2.1.0
  • 2.0.0
  • 1.4.0
  • 1.3.0
  • 1.2.0
  • 1.1.0
  • 1.0.0
  • 0.7.0
  • 0.6.0
  • 0.5.0
  • 0.4.1
  • 0.3.0
  • 0.2.0
  • 0.1.5
  • 0.1.4 (deleted)
released Feb 29th 2024
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

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppetlabs-package', '3.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-package
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-package --version 3.0.1

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

puppetlabs/package — version 3.0.1 Feb 29th 2024

package

Table of Contents

  1. Overview
  2. Module Description
  3. Setup
  4. Usage
  5. Reference
  6. Limitations
  7. License
  8. Development

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.