Forge Home


Type and Provider or Task based manipulation of the PE RBAC_API


7,745 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

  • 1.0.1 (latest)
  • 0.1.0
released Jan 21st 2020
This version is compatible with:
  • Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 6.0.0
  • , , , , ,
  • get_ds_data
  • set_ds_data
  • set_ds_json_data
  • test_ds_data
  • unset_ds

Start using this module

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

Add this module to your Puppetfile:

mod 'abuxton-puppet_ds', '1.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add abuxton-puppet_ds
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install abuxton-puppet_ds --version 1.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.



abuxton/puppet_ds — version 1.0.1 Jan 21st 2020


Puppet Directory Service

The Puppet_ds module encapsulates usage of the rbac_api/v1/ds end point configuring usage of a Directory Service (DS) for Role Based Access and Control(RBAC) of the Puppet Console.

The v 0.1.0, version of this is Puppet Task based only.

Table of Contents

  1. Description
  2. Setup - The basics of getting started with puppet_ds
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module


The module provides capabilities to use [] ( to get, set and test the directory services with a Puppet Task or by directly using the scripts provided as tasks during bootstrap and install of the Puppet Enterprise server.


What puppet_ds affects OPTIONAL

Setup Requirements OPTIONAL

You will need a active and reachable Directory Service, the documentation and test data uses a publicly WWW hosted DS service.

You will need to install Bolt as part of your bootstrap stage or provide matching environment variables and execute the shell scripts directly.

Beginning with puppet_ds

Review the data scheme of the DS json Puppet requires.

 {"schema" : {
       "help_link" : [ "maybe", "Str" ],
       "ssl" : "Bool",
       "(optional-key :ssl_hostname_validation)" : [ "maybe", "Bool" ],
       "group_name_attr" : "Str",
       "password" : [ "maybe", "Str" ],
       "group_rdn" : [ "maybe", "Str" ],
       "connect_timeout" : [ "maybe", "Int" ],
       "(optional-key :start_tls)" : [ "maybe", "Bool" ],
      "user_display_name_attr" : "Str",
       "hostname" : "Str",
       "base_dn" : "Str",
       "user_lookup_attr" : "Str",
       "port" : "Int",
       "login" : [ "maybe", "Str" ],
       "group_lookup_attr" : "Str",
       "(optional-key :disable_ldap_matching_rule_in_chain)" : [ "maybe", "Bool" ],
       "group_member_attr" : "Str",
       "(optional-key :id)" : [ "eq", 1 ],
       "(optional-key :ssl_wildcard_validation)" : [ "maybe", "Bool" ],
       "user_email_attr" : "Str",
       "(optional-key :search_nested_groups)" : [ "maybe", "Bool" ],
       "user_rdn" : [ "maybe", "Str" ],
       "group_object_class" : [ "maybe", "Str" ],
       "display_name" : "Str",
       "(optional-key :type)" : [ "maybe", [ "enum", "activedirectory", "openldap", "apacheds" ] ]


Currently the module only supports Puppet Tasks see for more information on running the provided tasks.


The tasks provided will only work on a server configured as the Puppet Enterprise server or MOM.


Pull requests welcome.


  • Create puppet_ds resources equivalent to all tasks.

Release Notes/Contributors/Etc. Optional

If you aren't using changelog, put your release notes here (though you should consider using changelog). You can also add any additional sections you feel are necessary or important to include here. Please use the ## header.