Forge Home


Add a `mount` provider `windows_smb` to enable mapping windows shares to drive letters using Puppet


4,498 latest version

3.5 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

  • 0.1.1 (latest)
  • 0.1.0
released Sep 17th 2019

Start using this module

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

Add this module to your Puppetfile:

mod 'geoffwilliams-mount_windows_smb', '0.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add geoffwilliams-mount_windows_smb
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install geoffwilliams-mount_windows_smb --version 0.1.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.



geoffwilliams/mount_windows_smb — version 0.1.1 Sep 17th 2019

Build Status


Table of Contents

  1. Description
  2. Usage - Configuration options and additional functionality
  3. Reference - An under-the-hood peek at what the module is doing and how
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module


Add a mount provider windows_smb to enable mapping windows shares to drive letters using Puppet


Mapping a drive

mount { "D:":
  ensure   => mounted,
  provider => windows_smb,
  device   => "//VAGRANT-2012-R2/shared",
  options  => '{"user":"VAGRANT-2012-R2/test","password":"Password123!"}',


  • You must specify the drive letter as the resource name, in capitals, with a colon
  • To avoid a sea of backslashes, use a forward slash in any share names and user names. The provider will convert them for you
  • options semi-officially has to be a string acording to the type documentation... but no one said I couldn't load the string with JSON ;-)
  • Omit password if there isn't one
  • Other options such as dump, pass etc are ignored
  • We claim the default mount provider on windows
  • Havent tested what happens if the UNC path is changed

Un-mapping a drive

mount { "D:":
  ensure   => absent,
  provider => windows_smb,


generated documentation.

Reference documentation is generated directly from source code using puppet-strings. You may regenerate the documentation by running:

bundle exec puppet strings


  • Not supported by Puppet, Inc.


PRs accepted :)


This module supports testing using PDQTest.

Test can be executed with:

bundle install

See .travis.yml for a working CI example


  • Thanks to Paul Tötterman and Rob Reynolds - I was able to construct a working provider from the notes left on MODULES-4927