Active Directory Management Framework

Configuration driven Active Directory management.

Invoke-AdmfForest

SYNOPSIS

Applies the currently desired configuration to the targeted forest.

SYNTAX

Invoke-AdmfForest [[-Server] <ComputerParameter>] [[-Credential] <PSCredential>]
 [[-Options] <UpdateForestOptions[]>] [[-CredentialProvider] <String>] [-ContextPrompt] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Applies the currently desired configuration to the targeted forest. By default, this will only include sites, sitelinks and subnets.

To switch to a full application, use the “-Options All” parameter.

EXAMPLES

EXAMPLE 1

Invoke-AdmfForest -Server contoso.com -Options All

Applies the full forest configuration to the contoso.com domain.

PARAMETERS

-Server

The server / domain to work with.

Type: ComputerParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
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: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Options

Which aspects to actually update. Defaults to “default” (Sites, SiteLinks & Subnets) Also available:

Type: UpdateForestOptions[]
Parameter Sets: (All)
Aliases:
Accepted values: Sites, Subnets, SiteLinks, Topology, ServerRelocate, Schema, SchemaLdif, NTAuthStore, ForestLevel, ExchangeSchema, SchemaDefaultPermissions, AllSchema, Certificates, Default, All

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

-CredentialProvider

The credential provider to use to resolve the input credentials. See help on Register-AdmfCredentialProvider for details.

Type: String
Parameter Sets: (All)
Aliases:

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

-ContextPrompt

Force displaying the Context selection User Interface.

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

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