https://github.com/xoap-io/xoap-powershell-dsc-module-template
This is the XOAP PowerShell DSC module template repository
https://github.com/xoap-io/xoap-powershell-dsc-module-template
dsc dsc-resources powershell-dsc
Last synced: 5 months ago
JSON representation
This is the XOAP PowerShell DSC module template repository
- Host: GitHub
- URL: https://github.com/xoap-io/xoap-powershell-dsc-module-template
- Owner: xoap-io
- License: mit
- Created: 2022-02-14T14:21:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-17T07:36:08.000Z (over 1 year ago)
- Last Synced: 2024-10-19T10:18:25.625Z (over 1 year ago)
- Topics: dsc, dsc-resources, powershell-dsc
- Language: PowerShell
- Homepage: https://xoap.io
- Size: 72.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# XOAPModuleTemplateDSC
This repository is a template that can be used as a starting point for creating new DSC modules and resources.
## Code of Conduct
This project has adopted this [Code of Conduct](CODE_OF_CONDUCT.md).
## Contributing
Please check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).
## Change log
A full list of changes in each version can be found in the [change log](CHANGELOG.md).
## Documentation
This script is used to easily create new DSC modules and resources.
## Prerequisites
Please install Plaster first and make sure it's present.
```powershell
Install-Module Plaster
Import-Module Plaster
```
## Create new DSC modules
Modules will be automatically created once you are creating a new DSC resource.
## Create new DSC resources
DSC resources can easily be deployed via the invocation of
```powershell
.\New-CompositeResource.ps1
```
with parameters
```powershell
.\New-CompositeResource.ps1 -Module XOAPModuleTemplateDSC -Version 0.0.1 -Resource ScheduledTasks
```
The parameter list is as followed:
| Parameter | Description | Note |
|-----------|----------------------------------------|------|
| Module | Name of the outer module part | - |
| Version | Target version of the module | - |
| Ressource | The name of the ressource /config part | - |
### Examples
You can review the [Examples](/Examples/Resources) directory in the **XOAPModuleTemplateDSC** module
for some general use scenarios for all the resources that are in the module.