Edit

Share via

Remove-ControlledGpo

  • Reference
Module:
AGPM

Removes controlled GPOs from the AGPM archive.

Syntax

Remove-ControlledGpo
      [[-ControlledGpos] <ControlledGpo[]>]
      [-Comment <String>]
      [-Domain <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-ControlledGpo cmdlet removes controlled Group Policy Objects (GPOs) from the Advanced Group Policy Management (AGPM) archive. A removed GPO is no longer controlled. This cmdlet does not delete the GPO. To remove the GPO from the production environment, use the Remove-Gpo cmdlet. For more information, type Get-Help Remove-Gpo.

Examples

Example 1: Remove a GPO

PS C:\>Get-ControlledGpo -Domain "TSQA.Contoso.com" | Where {$_.Name -eq "test"} | Remove-ControlledGpo

This command uses the Get-ControlledGpo cmdlet to get all controlled GPOs in the specified domain. The command passes those GPOs to the Where-Object cmdlet. That cmdlet passes any GPOs named test to the current cmdlet. This cmdlet removes that test GPO from the AGPM archive.

Parameters

-Comment

Specifies a comment for the change that this cmdlet makes.

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ControlledGpos

Specifies an array of GPOs to remove. To obtain controlled GPOs, use the Get-ControlledGpo cmdlet.

Type:ControlledGpo[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Domain

Specifies the fully qualified domain name (FQDN) of a domain. This cmdlet operates on GPOs in the domain that this parameter specifies. If the AGPM service runs as part of a different domain, and if this cmdlet specifies that domain, a trust relationship must exist between that domain and the domain of the current user or computer.

If you do not specify a domain, this cmdlet uses the domain of the current user.

If you use this cmdlet as part of a computer startup or shutdown script, and if the command does not specify this parameter, the cmdlet uses the domain of the computer.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.Agpm.ControlledGpo

This cmdlet accepts controlled GPOs.