{"id":20156147,"url":"https://github.com/dsccommunity/gpregistrypolicydsc","last_synced_at":"2025-07-10T12:08:14.736Z","repository":{"id":49899600,"uuid":"203738796","full_name":"dsccommunity/GPRegistryPolicyDsc","owner":"dsccommunity","description":"DSC resources used to apply and manage local group policies by modifying the respective .pol file.","archived":false,"fork":false,"pushed_at":"2024-07-10T03:31:26.000Z","size":134,"stargazers_count":23,"open_issues_count":10,"forks_count":7,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-06-08T21:51:28.673Z","etag":null,"topics":["dsc","dsc-resources","group-policy","powershell-dsc","windows-server"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dsccommunity.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-08-22T07:28:55.000Z","updated_at":"2025-04-24T06:39:29.000Z","dependencies_parsed_at":"2025-01-03T22:02:45.245Z","dependency_job_id":null,"html_url":"https://github.com/dsccommunity/GPRegistryPolicyDsc","commit_stats":{"total_commits":22,"total_committers":5,"mean_commits":4.4,"dds":0.6363636363636364,"last_synced_commit":"db252f62809475aed2a21e34a44c73d118849cdc"},"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/dsccommunity/GPRegistryPolicyDsc","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FGPRegistryPolicyDsc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FGPRegistryPolicyDsc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FGPRegistryPolicyDsc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FGPRegistryPolicyDsc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dsccommunity","download_url":"https://codeload.github.com/dsccommunity/GPRegistryPolicyDsc/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FGPRegistryPolicyDsc/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264577977,"owners_count":23631465,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dsc","dsc-resources","group-policy","powershell-dsc","windows-server"],"created_at":"2024-11-13T23:37:47.742Z","updated_at":"2025-07-10T12:08:14.683Z","avatar_url":"https://github.com/dsccommunity.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GPRegistryPolicyDsc\r\n\r\n[![Build Status](https://dev.azure.com/dsccommunity/GPRegistryPolicyDsc/_apis/build/status/dsccommunity.GPRegistryPolicyDsc?branchName=master)](https://dev.azure.com/dsccommunity/GPRegistryPolicyDsc/_build/latest?definitionId=12\u0026branchName=master)\r\n![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/dsccommunity/GPRegistryPolicyDsc/12/master)\r\n[![codecov](https://codecov.io/gh/dsccommunity/GPRegistryPolicyDsc/branch/master/graph/badge.svg)](https://codecov.io/gh/dsccommunity/GPRegistryPolicyDsc)\r\n[![Azure DevOps tests](https://img.shields.io/azure-devops/tests/dsccommunity/GPRegistryPolicyDsc/12/master)](https://dsccommunity.visualstudio.com/GPRegistryPolicyDsc/_test/analytics?definitionId=12\u0026contextType=build)\r\n[![PowerShell Gallery (with prereleases)](https://img.shields.io/powershellgallery/vpre/GPRegistryPolicyDsc?label=GPRegistryPolicyDsc%20Preview)](https://www.powershellgallery.com/packages/GPRegistryPolicyDsc/)\r\n[![PowerShell Gallery](https://img.shields.io/powershellgallery/v/GPRegistryPolicyDsc?label=GPRegistryPolicyDsc)](https://www.powershellgallery.com/packages/GPRegistryPolicyDsc/)\r\n\r\nThis resource module contains resources used to apply and manage local group policies\r\nby modifying the respective .pol file.\r\n\r\nThis module is an adaptation from [GPRegistryPolicy](https://github.com/PowerShell/GPRegistryPolicy).\r\n\r\n## Code of Conduct\r\n\r\nThis project has adopted this [Code of Conduct](CODE_OF_CONDUCT.md).\r\n\r\n## Releases\r\n\r\nFor each merge to the branch `master` a preview release will be\r\ndeployed to [PowerShell Gallery](https://www.powershellgallery.com/).\r\nPeriodically a release version tag will be pushed which will deploy a\r\nfull release to [PowerShell Gallery](https://www.powershellgallery.com/).\r\n\r\n## Contributing\r\n\r\nPlease check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).\r\n\r\n## Installation\r\n\r\n### GitHub\r\n\r\nTo manually install the module,\r\ndownload the source code and unzip the contents to the directory\r\n'$env:ProgramFiles\\WindowsPowerShell\\Modules' folder.\r\n\r\n### PowerShell Gallery\r\n\r\nTo install from the PowerShell gallery using PowerShellGet (in PowerShell 5.0)\r\nrun the following command:\r\n\r\n```powershell\r\nFind-Module -Name GPRegistryPolicyDsc -Repository PSGallery | Install-Module\r\n```\r\n\r\nTo confirm installation, run the below command and ensure you see the\r\nDSC resources available:\r\n\r\n```powershell\r\nGet-DscResource -Module GPRegistryPolicyDsc\r\n```\r\n\r\n## Requirements\r\n\r\nThe minimum Windows Management Framework (PowerShell) version required is 5.0\r\nor higher.\r\n\r\n## Examples\r\n\r\nYou can review the [Examples](/source/Examples) directory for some general use\r\nscenarios for all of the resources that are in the module.\r\n\r\n## Change log\r\n\r\nA full list of changes in each version can be found in the [change log](CHANGELOG.md).\r\n\r\n## Resources\r\n\r\n* [**RefreshRegistryPolicy**](#RefreshRegistryPolicy) A resource to detect\r\n   and invoke a group policy refresh.\r\n* [**RegistryPolicyFile**](#RegistryPolicyFile) A resource to manage registry policy\r\n   entries in a policy (.pol) file.\r\n\r\n### RefreshRegistryPolicy\r\n\r\nA resource to detect and invoke a group policy refresh.\r\n\r\n#### Requirements\r\n\r\n* Target machine must be running Windows Server 2008 R2 or later.\r\n\r\n#### Parameters\r\n\r\n* **`[String]` IsSingleInstance** _(Key)_: Specifies the resource is a single\r\n      instance, the value must be 'Yes'\r\n\r\n#### Read-Only Properties from Get-TargetResource\r\n\r\n* **`[String]` RefreshRequiredKey** _(Read)_: Returns the value of the\r\n      GPRegistryPolicy key indicating a group policy refresh is needed.\r\n* **`[String]` Path** _(Read)_: Returns the path of the RefreshRequired\r\n       property indicating a group policy refresh is needed.\r\n\r\n## Known issues\r\n\r\nAll issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/GPRegistryPolicyDsc/issues?utf8=✓\u0026q=is%3Aissue+is%3Aopen+RefreshRegistryPolicy).\r\n\r\n### RegistryPolicyFile\r\n\r\nA resource to manage registry policy entries in a policy (.pol) file.\r\n\r\n#### Requirements\r\n\r\n* Target machine must be running Windows Server 2008 R2 or later.\r\n\r\n#### Parameters\r\n\r\n* **`[String]` Key** _(Key)_: Indicates the path of the registry key\r\n      for which you want to ensure a specific state.\r\n* **`[String]` ValueName** _(Key)_: Indicates the name of the registry value.\r\n* **`[String]` TargetType** _(Required)_: Indicates the target type.\r\n      This is needed to determine the .pol file path.\r\n      Supported values are ComputerConfiguration, UserConfiguration,\r\n      Administrators, NonAdministrators, and Account.\r\n* **`[String]` AccountName** _(Write)_: Specifies the name of the account\r\n      for an user specific pol file to be managed.\r\n* **`[String[]]` ValueData** _(Write)_: The data for the registry value.\r\n* **`[String]` ValueType** _(Write)_: Indicates the type of the value.\r\n      Possible values are:\"Binary\",\"Dword\",\"ExpandString\",\"MultiString\",\"Qword\",\"String\",\"None\"\r\n* **`[String]` Ensure** _(Write)_: Specifies the desired state of the registry policy.\r\n      When set to `'Present'`, the registry policy will be created. When set to `'Absent'`,\r\n      the registry policy will be removed. Default value is `'Present'`.\r\n\r\n#### Read-Only Properties from Get-TargetResource\r\n\r\n* **`[String]` Path** _(Read)_: Returns the path to the pol file being managed.\r\n\r\n#### Examples\r\n\r\n* [Disable SMB1](/source/Examples/Resources/RegistryPolicyFile/1-RegistryPolicyFile_DisableSmb1_Config.ps1)\r\n* [Disable SMB1 not configured](/source/Examples/Resources/RegistryPolicyFile/2-RegistryPolicy_SMB1NotConfigured_Config.ps1)\r\n* [Disable desktop changes, Target type is Account](/source/Examples/Resources/RegistryPolicyFile/3-RegistryPolicyFile_DisableDesktopChanges_Config.ps1)\r\n* [Configure lanman dependant services, MutiString datatype example](/source/Examples/Resources/RegistryPolicyFile/4-RegistryPolicyFile_LanmanDependantServices_Config.ps1)\r\n\r\n#### Known issues\r\n\r\nAll issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/GPRegistryPolicyDsc/issues?utf8=✓\u0026q=is%3Aissue+is%3Aopen+RegistryPolicyFile).\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsccommunity%2Fgpregistrypolicydsc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdsccommunity%2Fgpregistrypolicydsc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsccommunity%2Fgpregistrypolicydsc/lists"}