augeas_core

Manage files using Augeas

Project URL RSS Feed Report issues

Module Stats

857,198 downloads

23,924 latest version

5.0 quality score

Version information

released Feb 28th 2024

Passed malware scan

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, 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 < 9.0.0
CentOS, OracleLinux, RedHat, Scientific, Debian, Ubuntu, Fedora, Rocky, AlmaLinux, AIX, Amazon

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'puppetlabs-augeas_core', '1.5.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-augeas_core

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-augeas_core --version 1.5.0

Documentation

puppetlabs/augeas_core — version 1.5.0 Feb 28th 2024

augeas_core

Description
Setup - The basics of getting started with augeas_core
- Setup requirements
- Beginning with augeas_core
Usage - Configuration options and additional functionality
Reference - An under-the-hood peek at what the module is doing and how
Limitations - OS compatibility, etc.
Development - Guide for contributing to the module

Description

The augeas_core module is used to manage configuration files using Augeas. This module is suitable for any host for which there are Augeas libraries and ruby bindings.

Setup

Setup Requirements

The augeas libraries and ruby bindings must be installed in order to use this module. If you are using puppet-agent packages, then those prerequisites are already satisfied for most platforms.

Beginning with augeas_core

To manage a configuration file using augeas, use the following code:

augeas { 'add_services_entry':
  context => '/files/etc/services',
  incl    => '/etc/services',
  lens    => 'Services.lns',
  changes => [
    'ins service-name after service-name[last()]',
    'set service-name[last()] "Doom"',
    'set service-name[. = "Doom"]/port "666"',
    'set service-name[. = "Doom"]/protocol "udp"'
  ]
}

Usage

Please see REFERENCE.md for the reference documentation and examples for details on usage.

Reference

Please see REFERENCE.md for the reference documentation.

This module is documented using Puppet Strings.

For a quick primer on how Strings works, please see this blog post or the README.md for Puppet Strings.

To generate documentation locally, run the following command:

bundle install
bundle exec puppet strings generate ./lib/**/*.rb

This command will create a browsable _index.html file in the doc directory. The references available here are all generated from YARD-style comments embedded in the code base. When any development happens on this module, the impacted documentation should also be updated.

Limitations

This module is only available on platforms that have augeas libraries and ruby bindings installed.

Development

Puppet Labs modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can't access the huge number of platforms and myriad of hardware, software, and deployment configurations that Puppet is intended to serve.

We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

For more information, see our module contribution guide.

Reference

Resource types

augeas: Apply a change or an array of changes to the filesystem using the augeas tool.

Resource types

`augeas`

Requires:

Augeas
The ruby-augeas bindings

Examples

Sample usage with a string:


augeas { "test1":
  context => "/files/etc/sysconfig/firstboot",
  changes => "set RUN_FIRSTBOOT YES",
  onlyif  => "match other_value size > 0",
}

Sample usage with an array and custom lenses:


augeas { "jboss_conf":
  context   => "/files",
  changes   => [
      "set etc/jbossas/jbossas.conf/JBOSS_IP $ipaddress",
      "set etc/jbossas/jbossas.conf/JAVA_HOME /usr",
    ],
  load_path => "$/usr/share/jbossas/lenses",
}

Properties

The following properties are available in the augeas type.

`returns`

The expected return code from the augeas command. Should not be set.

Default value: 0

Parameters

The following parameters are available in the augeas type.

changes
context
force
incl
lens
load_path
name
onlyif
provider
root
show_diff
type_check

`changes`

The changes which should be applied to the filesystem. This can be a command or an array of commands. The following commands are supported:

set <PATH> <VALUE> --- Sets the value VALUE at location PATH
setm <PATH> <SUB> <VALUE> --- Sets multiple nodes (matching SUB relative to PATH) to VALUE
rm <PATH> --- Removes the node at location PATH
remove <PATH> --- Synonym for rm
clear <PATH> --- Sets the node at PATH to NULL, creating it if needed
clearm <PATH> <SUB> --- Sets multiple nodes (matching SUB relative to PATH) to NULL
touch <PATH> --- Creates PATH with the value NULL if it does not exist
ins <LABEL> (before|after) <PATH> --- Inserts an empty node LABEL either before or after PATH.
insert <LABEL> <WHERE> <PATH> --- Synonym for ins
mv <PATH> <OTHER PATH> --- Moves a node at PATH to the new location OTHER PATH
move <PATH> <OTHER PATH> --- Synonym for mv
rename <PATH> <LABEL> --- Rename a node at PATH to a new LABEL
defvar <NAME> <PATH> --- Sets Augeas variable $NAME to PATH
defnode <NAME> <PATH> <VALUE> --- Sets Augeas variable $NAME to PATH, creating it with VALUE if needed

If the context parameter is set, that value is prepended to any relative PATHs.

`context`

Optional context path. This value is prepended to the paths of all changes if the path is relative. If the incl parameter is set, defaults to /files + incl; otherwise, defaults to the empty string.

Default value: ''

`force`

Optional command to force the augeas type to execute even if it thinks changes will not be made. This does not override the onlyif parameter.

Default value: false

`incl`

Load only a specific file, such as /etc/hosts. This can greatly speed up the execution the resource. When this parameter is set, you must also set the lens parameter to indicate which lens to use.

`lens`

Use a specific lens, such as Hosts.lns. When this parameter is set, you must also set the incl parameter to indicate which file to load. The Augeas documentation includes a list of available lenses.

`load_path`

Optional colon-separated list or array of directories; these directories are searched for schema definitions. The agent's $libdir/augeas/lenses path will always be added to support pluginsync.

Default value: ''

`name`

namevar

The name of this task. Used for uniqueness.

`onlyif`

Optional augeas command and comparisons to control the execution of this type.

Note: values is not an actual augeas API command. It calls match to retrieve an array of paths in <MATCH_PATH> and then get to retrieve the values from each of the returned paths.

Supported onlyif syntax:

get <AUGEAS_PATH> <COMPARATOR> <STRING>
values <MATCH_PATH> include <STRING>
values <MATCH_PATH> not_include <STRING>
values <MATCH_PATH> == <AN_ARRAY>
values <MATCH_PATH> != <AN_ARRAY>
match <MATCH_PATH> size <COMPARATOR> <INT>
match <MATCH_PATH> include <STRING>
match <MATCH_PATH> not_include <STRING>
match <MATCH_PATH> == <AN_ARRAY>
match <MATCH_PATH> != <AN_ARRAY>

where:

AUGEAS_PATH is a valid path scoped by the context
MATCH_PATH is a valid match syntax scoped by the context
COMPARATOR is one of >, >=, !=, ==, <=, or <
STRING is a string
INT is a number
AN_ARRAY is in the form ['a string', 'another']

Default value: ''

`provider`

The specific backend to use for this augeas resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

`root`

A file system path; all files loaded by Augeas are loaded underneath root.

Default value: /

`show_diff`

Valid values: true, false, yes, no

Whether to display differences when the file changes, defaulting to true. This parameter is useful for files that may contain passwords or other secret data, which might otherwise be included in Puppet reports or other insecure outputs. If the global show_diff setting is false, then no diffs will be shown even if this parameter is true.

Default value: true

`type_check`

Valid values: true, false

Whether augeas should perform typechecking. Defaults to false.

Default value: false

                                 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.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

augeas_core

Version information

This version is compatible with:

Start using this module

Documentation

augeas_core

Table of Contents

Description

Setup

Setup Requirements

Beginning with augeas_core

Usage

Reference

Limitations

Development

Reference

Table of Contents

Resource types

Resource types

augeas

Examples

Sample usage with a string:

Sample usage with an array and custom lenses:

Properties

returns

Parameters

changes

context

force

incl

lens

load_path

name

onlyif

provider

root

show_diff

type_check

Changelog

v1.5.0 - 2024-02-27

Added

v1.4.1 - 2023-09-21

v1.4.0 - 2023-09-18

Added

v1.3.0 - 2023-02-14

Added

v1.2.0 - 2021-10-01

Added

Fixed

1.1.2 - 2021-03-08

Fixed

1.1.1 - 2020-09-29

Fixed

1.1.0 - 2020-09-29

Added

1.0.5 - 2019-11-01

Added

1.0.4 - 2019-01-10

Added

1.0.3 - 2018-10-02

Added

1.0.2 - 2018-09-26

Fixed

1.0.1 - 2018-08-17

Added

1.0.0 - 2018-07-02

Quality checks

Malware scan results

`augeas`

`returns`

`changes`

`context`

`force`

`incl`

`lens`

`load_path`

`name`

`onlyif`

`provider`

`root`

`show_diff`

`type_check`