Version information
This version is compatible with:
- Puppet Enterprise 2025.3.x, 2025.2.x, 2025.1.x, 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
- Puppet >= 7.10.0 < 99.0.0
- windows
Start using this module
Add this module to your Puppetfile:
mod 'rfbennett-windows_drives', '0.2.1'Learn more about managing modules with a PuppetfileDocumentation
Windows Drives
Manage Microsoft Windows drives.
Table of Contents
- Description
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
This module allows you to manage drives within Microsoft Windows.
Usage
Simply supply the desired array information:
windows_drives::drives: [
{
letter: 'E',
label: 'Example01',
indexing: 'false',
shadow_copy: {
store_on: 'E',
auto_retry_minutes: 25,
triggers: [
{
at: '11:45pm',
days_of_week: ['Friday'],
weeks_interval: 1,
},
],
},
},
]
Limitations
- This modules uses puppet-strings to generate the contents of the REFERENCE.md file:
puppet strings generate --format markdown --out REFERENCE.md
- This module has been evaluated against the following (determined via $PSVersionTable):
- Microsoft Windows Server 2022 (running PowerShell 5.1.20348.2849)
- Microsoft Windows Server 2019 (running PowerShell 5.1.17763.6530)
- Microsoft Windows 11 (running PowerShell 5.1.26100.2161)
Development
Feedback and ideas are always welcome - please contact an Author (listed in metadata.json) to discuss your input, or feel free to simply open an Issue.
Command to apply this module locally (and try it out):
puppet apply --modulepath="<PathToModuleParentFolders>" --execute "include <ModuleName>" --environment "<EnvironmentName>" --no-splay --verbose --debug
For example: puppet apply --modulepath="C:\ProgramData\PuppetLabs\code\environments\production\modules;c:\projects\forge" --execute "include windows_drives" --environment "production" --no-splay
Reference
Table of Contents
Classes
Public Classes
windows_drives: Windows Drives
Private Classes
windows_drives::config: Configuration
Defined types
windows_drives::defines::drive: Drivewindows_drives::defines::shadow_copy: Shadow Copywindows_drives::defines::trigger: Trigger
Classes
windows_drives
Manages Microsoft Windows drives
Examples
include windows_drives
Parameters
The following parameters are available in the windows_drives class:
drives
Data type: Array[Hash]
Array of hashes containing drive configurations Example: [ { letter: 'E', label: 'Example01', indexing: 'false', shadow_copy: { store_on: 'E', auto_retry_minutes: 25, ensure: 'present', max_size: 4224, triggers: [ { at: '11:45pm', days_of_week: ['Friday'], weeks_interval: 3, }, { at: '8:15am', days_of_week: ['Monday', 'Wednesday'], weeks_interval: 1, }, ], }, }, ]
Default value: []
log_output
Data type: Boolean
Boolean used to enable additional logging output Example: true
Default value: false
Defined types
windows_drives::defines::drive
Defines a Windows drive
Parameters
The following parameters are available in the windows_drives::defines::drive defined type:
indexing
Data type: Enum['true', 'false', 'unmanaged']
Enumerated string denoting if Indexing should be enabled on the drive Allow time for indexing service changes to fully process if there is data on the drive Example: 'true'
Default value: 'unmanaged'
label
Data type: Optional[String]
String containing the text to use as the label on the drive Example: 'DataDisk'
Default value: undef
letter
Data type:
Enum['A', 'B', 'C', 'D', 'E', 'F',
'G', 'H', 'I', 'J', 'K', 'L', 'M', 'N',
'O', 'P', 'Q', 'R', 'S', 'T', 'U', 'V',
'W', 'X', 'Y', 'Z']
Enumerated string containing the letter of the drive to configure Example: 'E'
shadow_copy
Data type: Optional[Hash]
Hash containing the shadow copy information for the drive Example: { auto_retry_minutes: 25, ensure: 'present', store_on: 'E', max_size: 4224, triggers: [ { at: '11:45pm', days_of_week: ['Friday'], weeks_interval: 3, }, { at: '8:15am', days_of_week: ['Monday', 'Wednesday'], weeks_interval: 1, }, ], },
Default value: undef
windows_drives::defines::shadow_copy
Defines a Windows drive shadow copy configuration
Parameters
The following parameters are available in the windows_drives::defines::shadow_copy defined type:
auto_retry_minutesensuremax_sizemax_size_typestore_ontask_compatibilitytask_execution_time_limittask_prioritytriggers
auto_retry_minutes
Data type: Integer
The maximum amount of time (in minutes) to attempt to create the shadow copy Example: 25
Default value: 15
ensure
Data type: Enum['absent', 'present']
Denotes the desired state of shadow copy for the supplied drive letter Example: 'present'
Default value: 'present'
max_size
Data type: Integer
Denotes the maximum amount of storage space to consume If limited, must be 300 MB or greater Do not set if wanting Unlimited Example: 450
Default value: undef
max_size_type
Data type: Enum['bytes', 'KB', 'MB', 'GB', 'TB', 'PB', 'EB']
Denotes the type of max_size value supplied Example: 'GB'
Default value: 'MB'
store_on
Data type:
Enum['A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'I', 'J',
'K', 'L', 'M', 'N', 'O', 'P', 'Q', 'R', 'S', 'T', 'U',
'V', 'W', 'X', 'Y', 'Z']
The letter of the drive where the shadow copy should be stored Example: 'K'
task_compatibility
Data type: Enum['At', 'V1', 'Vista', 'Win7', 'Win8']
String containing the compatibiltiy type for the associated scheduled task Example: 'Win8'
Default value: 'V1'
task_execution_time_limit
Data type: Enum['1H', '2H', '4H', '8H', '12H', '1D', '3D']
String of the amount of time that the associated scheduled task is allowed for completion D=Days, H=Hours Example: '4H'
Default value: '8H'
task_priority
Data type: Integer[0,10]
The priority level given to the asssociated scheduled task Example: 5
Default value: 7
triggers
Data type: Array[Hash]
Array of hashes containing the scheduled task trigger configurations Example: [ { at: '11:45pm', days_of_week: ['Friday'], weeks_interval: 3, }, { at: '8:15am', days_of_week: ['Monday', 'Wednesday'], weeks_interval: 1, }, ],
Default value: []
windows_drives::defines::trigger
Defines a Windows drive shadow copy scheduled task trigger
Parameters
The following parameters are available in the windows_drives::defines::trigger defined type:
at
Data type: String
String containing the time to trigger the task Example: '10:15am'
days_of_week
Data type: Array[String]
Array of strings denoting the days of the week on which to run the task Example: ['Monday', 'Wednesday', 'Friday']
Default value: []
weeks_interval
Data type: Integer[1,25]
Integer denoting the interval between the weeks in the schedule for the task Example: 3
Default value: 1
Change Log
All notable changes to this project will be documented in this file.
Release 0.2.1
- Refreshed project files
- Reverted data structure changes back to 0.1.9 format
- Rebranded $on param in shadow_copy defined type to $store_on to avoid conflicts
- Removed 'unamanaged' value from $ensure param in shadow_copy
Release 0.2.0
- Refactored to support flatter heira data structure
- Split shadow_copy data into separate param in init.pp
Release 0.1.9
- Initial release
Dependencies
- puppetlabs/pwshlib (>= 0.4.0 < 99.0.0)
- puppetlabs/powershell (>= 1.0.1 < 99.0.0)
- puppet/stdlib (>= 6.4.0 < 99.0.0)
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