Active Directory Management Framework

Configuration driven Active Directory management.

Register-DMGPLink

SYNOPSIS

Registers a group policy link as a desired state.

SYNTAX

Path

Register-DMGPLink -PolicyName <String> -OrganizationalUnit <String> -Precedence <Int32> [-Tier <Int32>]
 [-State <String>] [-ProcessingMode <String>] [-Present <Boolean>] [-ContextName <String>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

Filter

Register-DMGPLink -PolicyName <String> -OUFilter <String> -Precedence <Int32> [-Tier <Int32>] [-State <String>]
 [-ProcessingMode <String>] [-Present <Boolean>] [-ContextName <String>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

Registers a group policy link as a desired state.

EXAMPLES

EXAMPLE 1

Get-Content $configPath | ConvertFrom-Json | Write-Output | Register-DMGPLink

Import all GPLinks stored in the json file located at $configPath.

PARAMETERS

-PolicyName

The name of the group policy being linked. Supports string expansion.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OrganizationalUnit

The organizational unit (or domain root) being linked to. Supports string expansion.

Type: String
Parameter Sets: Path
Aliases: OU

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-OUFilter

A filter string for an organizational unit. The filter must be a wildcard-pattern supporting distinguishedname.

Type: String
Parameter Sets: Filter
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Precedence

Numeric value representing the order it is linked in. The lower the number, the higher on the list, the more relevant the setting.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Tier

The tier of a link is a priority ordering on top of Precedence. While precedence determines order within a given tier, each tier is processed separately. The higher the tier number, the higher the priority. In additive mode, already existing linked policies have a Tier 0 priority. If you want your own policies to be prepended, use Tier 1 or higher. If you want your own policies to have the least priority however, user Tier -1 or lower. Default: 1

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 1
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-State

The state the link should be in. Supported states:

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Enabled
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ProcessingMode

In which way GPO links are being processed:

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: Constrained
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Present

Whether the link should be present at all. Relevant in additive mode, to retain the capability to delete undesired links.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ContextName

The name of the context defining the setting. This allows determining the configuration set that provided this setting. Used by the ADMF, available to any other configuration management solution.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: <Undefined>
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES