Active Directory Management Framework

Configuration driven Active Directory management.

Invoke-DMGroupMembership

SYNOPSIS

Applies the desired group memberships to the target domain.

SYNTAX

Invoke-DMGroupMembership [[-InputObject] <Object>] [-RemoveUnidentified] [[-Server] <ComputerParameter>]
 [[-Credential] <PSCredential>] [-EnableException] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Applies the desired group memberships to the target domain. Use Register-DMGroupMembership to configure just what is considered desired. Use Set-DMDomainCredential to prepare authentication as needed for remote domains, when principals from that domain must be resolved.

EXAMPLES

EXAMPLE 1

Invoke-DMGroupMembership -Server contoso.com

Applies the desired group membership configuration to the contoso.com domain

PARAMETERS

-InputObject

Test results provided by the associated test command. Only the provided changes will be executed, unless none were specified, in which ALL pending changes will be executed.

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-RemoveUnidentified

By default, existing permissions for foreign security principals that cannot be resolved will only be deleted, if every single configured membership was resolveable. In cases where that is not possible, these memberships are flagged as “Unidentified” Using this parameter you can enforce deleting them anyway.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Server

The server / domain to work with.

Type: ComputerParameter
Parameter Sets: (All)
Aliases:

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

-Credential

The credentials to use for this operation.

Type: PSCredential
Parameter Sets: (All)
Aliases:

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

-EnableException

This parameters disables user-friendly warnings and enables the throwing of exceptions. This is less user friendly, but allows catching exceptions in calling scripts.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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