DscResource.Template

March 2, 2019 ยท View on GitHub

The DscResource.Template module contains a template with example code and best practices for DSC resource modules in DSC Resource Kit.

NOTE! This is not meant to be a fully functioning resource module. The resource in this repository is just to make sure common code works, and used as a practical example.

This project has adopted this code of conduct.

Branches

master

Build status codecov

This is the branch containing the latest release - no contributions should be made directly to this branch.

dev

Build status codecov

This is the development branch to which contributions should be proposed by contributors as pull requests. This development branch will periodically be merged to the master branch, and be released to PowerShell Gallery.

Contributing

Please see our contributing guidelines.

Installation

GitHub

To manually install the module, download the source code and unzip the contents to the directory '$env:ProgramFiles\WindowsPowerShell\Modules' folder.

To install from the PowerShell gallery using PowerShellGet (in PowerShell 5.0) run the following command:

Find-Module -Name DscResource.Template -Repository PSGallery | Install-Module

To confirm installation, run the below command and ensure you see the DSC resources available:

Get-DscResource -Module DscResource.Template

Requirements

The minimum Windows Management Framework (PowerShell) version required is 4.0 or higher.

Examples

You can review the Examples directory for some general use scenarios for all of the resources that are in the module.

Change log

A full list of changes in each version can be found in the change log.

Resources

  • Folder example resource to manage a folder on Windows.
  • {Resource2 One line description of resource 1}

Folder

Example resource to manage a folder on Windows.

Requirements

  • Target machine must be running Windows Server 2008 R2 or later.

Parameters

  • [String] Path (Key): The path to the folder to create.
  • [Boolean] ReadOnly (Required): If the files in the folder should be read only.
  • [Boolean] Hidden (Write): If the folder should be hidden. Default value is $false.
  • [String] Ensure (Write): Specifies the desired state of the folder. When set to 'Present', the folder will be created. When set to 'Absent', the folder will be removed. Default value is 'Present'.

Read-Only Properties from Get-TargetResource

  • [Boolean] Shared (Write): If sharing is be enabled or disabled.
  • [String] ShareName (Read): The name of the shared resource.

Examples

Known issues

All issues are not listed here, see here for all open issues.

{ResourceName}

{ Detailed description of ResourceName. }

Requirements

{ Please include any requirements for running this resource (e.g. Must run on Windows Server OS, must have Exchange already installed). }

  • Target machine must be running Windows Server 2008 R2 or later.

Parameters

  • {[String] Property1 (Key): Description of ResourceName property 1}
  • {[Boolean] Property2 (Required): Description of ResourceName property 2}

Read-Only Properties from Get-TargetResource

  • {[Boolean] Property3 (Write): Description of ResourceName property 2}

Examples

  • { Add links to the examples for the resource ResourceName }

Known issues

All issues are not listed here, see here for all open issues.