https://github.com/puppetlabs/puppetlabs-puppet_conf
https://github.com/puppetlabs/puppetlabs-puppet_conf
hacktoberfest module supported
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/puppetlabs/puppetlabs-puppet_conf
- Owner: puppetlabs
- License: apache-2.0
- Created: 2017-09-11T19:48:57.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2025-02-04T02:36:41.000Z (over 1 year ago)
- Last Synced: 2025-03-31T06:02:33.490Z (about 1 year ago)
- Topics: hacktoberfest, module, supported
- Language: Ruby
- Homepage:
- Size: 318 KB
- Stars: 2
- Watchers: 98
- Forks: 20
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# puppet_conf
#### Table of Contents
1. [Overview](#overview)
2. [Module Description](#module-description)
3. [Setup](#setup)
* [Requirements](#requirements)
4. [Usage](#usage)
5. [Reference](#reference)
6. [Limitations](#limitations)
7. [License](#license)
8. [Development](#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](https://forge.puppet.com/puppetlabs/puppet_conf/tasks).
For a complete list of `puppet.conf` options, see the [`puppet.conf`](https://docs.puppet.com/puppet/latest/config_file_main.html) 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= section= setting=`.
* With Bolt on the command line, run `bolt task run puppet_conf action= section= 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](https://github.com/puppetlabs/puppetlabs-puppet_conf/blob/main/REFERENCE.md).
## Limitations
For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-puppet_conf/blob/main/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](https://opensource.org/license/agpl-v3/), [BSD-2](https://opensource.org/license/bsd-2-clause/), [BSD-3](https://opensource.org/license/bsd-3-clause/), [GPL2.0](https://opensource.org/license/gpl-2-0/), [LGPL](https://opensource.org/license/lgpl-3-0/), [MIT](https://opensource.org/license/mit/) and [MPL](https://opensource.org/license/mpl-2-0/) Licensing.
## 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.](https://github.com/puppetlabs/puppetlabs-puppet_conf/blob/main/CONTRIBUTING.md)