GroupPolicyDsc

GroupPolicyDsc is a module written to provide PowerShell DSC configuration resources to manipulate Group Policy within a domain.

Resources

• GroupPolicy: Provides a mechanism to create Group Policy objects.
• GPLink: Provides a mechanism to link Group Policy objects to Organisational Units.
• GPPermission: Provides a mechanism to set the permission scope of a Group Policy object.
• GPRegistryValue: Provides a mechanism to set a registry item within a Grouop Policy object.

GroupPolicy

Provides a mechanism to create Group Policy objects.

Requirements

• This must be run on an Active Directory Domain Controller

Parameters

• [String] Name (Key): The name of the Group Policy object you want to configure.
• [String] Status (Write): The status of the Group Policy object. { AllSettingsEnabled | UserSettingsDisabled | ComputerSettingsDisabled | AllSettingsDisabled }
• [String] Ensure (Write): Specifies whether the Group Policy object should be present or absent. { Present | Absent }

Read-Only Properties from Get-TargetResource

None

Examples

• Create new Group Policy object

GPLink

Provides a mechanism to link Group Policy objects to Organisational Units.

Requirements

• This must be run on an Active Directory Domain Controller

Parameters

• [String] Path (Key): The X.500 path of the Organisational Unit you want to link to.
• [String] GPOName (Key): The name of the Group Policy object you want to configure.
• [String] Enabled (Write): The status of the Group Policy link. { Yes | No }
• [String] Enforced (Write): Whether or not the Group Policy link will be enforced, that is, will override GP inheritance blocks. { No | Yes }
• [Int32] Order (Write): The order of the link compared to other Group Policy links on the same Organisational Unit. { 1 | 2,3,4,5... }
• [String] Ensure (Write): Specifies whether the Group Policy link should be present or absent. { Present | Absent }

Read-Only Properties from Get-TargetResource

None

Examples

• Create new Group Policy link

GPPermission

Provides a mechanism to set the permission scope of a Group Policy object.

Requirements

• This must be run on an Active Directory Domain Controller

Parameters

• [String] GPOName (Key): The name of the Group Policy object you want to configure.
• [String] TargetName (Key): The account name of the object you want to configure.
• [String] TargetType (Write): The type of the account. { Group | User | Computer }
• [String] PermissionLevel (Write): The type of the account. { GpoApply | GpoRead | GpoApply | GpoEditDeleteModifySecurity | None }
• [String] Force (Write): Whether to force the permission to be set as specified or only added to. { No | Yes }
• [String] Ensure (Write): Specifies whether the permission should be present or absent. { Present | Absent }

Read-Only Properties from Get-TargetResource

None

Examples

• Create new Group Policy permission

GPRegistryValue

Provides a mechanism to set Registry Values within Group Policy objects.

Requirements

• This must be run on an Active Directory Domain Controller

Parameters

• [String] Name (Key): The name of the Group Policy object you want to configure.
• [String] Key (Key): The registry key you want to configure.
• [String] Name (Key): The registry key value name you want to configure.
• [String] ValueType (Write): The type of the registry value you want to configure. { DWord | Other }
• [String] Value (Write): The value of the registry you want to configure.
• [String] Ensure (Write): Specifies whether the Group Policy object should be present or absent. { Present | Absent }

Read-Only Properties from Get-TargetResource

None

Examples

• Create new GP Registry Value

Versions

1.0.0

• Initial release of GroupPolicyDsc.