README.md

mount_windows_smb

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

Description

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

Usage

Mapping a drive

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

Notes

• 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,
}

Reference

generated documentation.

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

bundle exec puppet strings

Limitations

• Not supported by Puppet, Inc.

Development

PRs accepted :)

Testing

This module supports testing using PDQTest.

Test can be executed with:

bundle install
make

See .travis.yml for a working CI example

Acknowledgement

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