Forge Home

puppet_conf

pdk
supported
tasks
Tasks that manipulates a puppet configuration file

129,568 downloads

2,873 latest version

5.0 quality score

Version information

  • 1.2.0 (latest)
  • 1.1.0
  • 1.0.0
  • 0.8.0
  • 0.7.0
  • 0.6.0
  • 0.5.0
  • 0.4.0
  • 0.3.1
  • 0.3.0
  • 0.2.1
  • 0.2.0
  • 0.1.5
  • 0.1.4
released Aug 25th 2021
This version is compatible with:
  • Puppet Enterprise 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
  • Debian
    ,
    CentOS
    ,
    OracleLinux
    ,
    RedHat
    ,
    Ubuntu
    ,
    windows
Tasks:
  • puppet_conf

Start using this module

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

Add this module to your Puppetfile:

mod 'puppetlabs-puppet_conf', '1.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-puppet_conf --version 1.2.0

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/puppet_conf — version 1.2.0 Aug 25th 2021

puppet_conf

Table of Contents

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

Overview

This module provides the puppet_conf task.

Module Description

The puppet_conf task allows you to inspect and change the configuration options in the puppet.conf file.

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 puppet_conf or see the puppet_conf module page on the Forge. For a complete list of puppet.conf options, see the puppet.conf documentation. To show help for the task CLI, run puppet task run --help or bolt task run --help

To run a puppet_conf task, use the task command, specifying the action, section, and setting of the puppet.conf setting.

  • With PE on the command line, run puppet task run puppet_conf action=<ACTION> section=<SECTION> setting=<SETTING>.
  • With Bolt on the command line, run bolt task run puppet_conf action=<ACTION> section=<SECTION> setting=<SETTING>.

For example, to check the status of the agent graph setting in puppet.conf, run:

  • With PE, run puppet task run puppet_conf action=get section=agent setting=graph --nodes neptune
  • With Bolt, run bolt task run puppet_conf action=get section=agent setting=graph --nodes neptune --modulepath ~/modules

To set the value of the agent graph setting in puppet.conf, specify a value with the set action:

  • With PE, run puppet task run puppet_conf action=set section=agent setting=graph value=true --nodes neptune
  • With Bolt, run bolt task run puppet_conf action=set section=agent setting=graph value=true --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

To run acceptance tests against Windows machines, ensure that the BEAKER_password environment variable has been set to the password of the Administrator user of the target machine.

For an extensive list of supported operating systems, see metadata.json

Development

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.