Remove-GPO
Remove-GPO
Deletes a GPO.
Syntax
Remove-GPO [-Name] <string> [-Domain <string>] [-KeepLinks] [-Server <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
Remove-GPO -Guid <Guid> [-Domain <string>] [-KeepLinks] [-Server <string>] [-Confirm] [-WhatIf] [<CommonParameters>]
Detailed Description
The Remove-GPO cmdlet removes the GPO container and data from the directory service and the system volume folder (SysVol).
Parameters
-Domain <string>
Specifies the domain in which you want to remove a GPO. You must specify the fully qualified domain name (FQDN) of the domain (for example: SalesDomain.Contoso.com).
If you do not specify the Domain parameter, the domain of the computer that you are logged on to is used.
If you specify a domain that differs from the domain of your user object, a trust must exist between the domain from which you want to remove the GPO and the domain of your user object.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByPropertyName) |
Position? |
named |
-Guid <Guid>
Specifies the GPO to delete by its globally unique identifier (GUID). The GUID uniquely identifies the GPO.
You can also refer to the Guid parameter by its built-in alias, "id". For more information, see about_Aliases.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByPropertyName) |
Position? |
named |
-KeepLinks <SwitchParameter>
Preserves the links to the GPO in the specified domain (including OUs) and all sites when the GPO is removed.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-Name <string>
Specifies the GPO to delete by its display name.
The display name is not guaranteed to be unique in the domain. If another GPO with the same display name exists in the domain an error occurs. You can use the Guid parameter to uniquely identify a GPO.
You can also refer to the Name parameter by its built-in alias, "displayname". For more information, see about_Aliases.
Attributes
| Name | Value |
|---|---|
Required? |
true |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
true (ByPropertyName) |
Position? |
1 |
-Server <string>
Specifies the name of the domain controller that this cmdlet contacts to complete the operation. You can specify either the fully qualified domain name (FQDN) or the host name. For example:
FQDN: DomainController1.sales.contoso.com
Host Name: DomainController1
If you do not specify the name by using the Server parameter, the PDC emulator is contacted.
You can also refer to the Server parameter by its built-in alias, "dc". For more information, see about_Aliases.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-Confirm <SwitchParameter>
Prompts you for confirmation before executing the command.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-WhatIf <SwitchParameter>
Describes what would happen if you executed the command without actually executing the command.
Attributes
| Name | Value |
|---|---|
Required? |
false |
Accept wildcard characters? |
false |
Accept Pipeline Input? |
false |
Position? |
named |
-CommonParameter
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see About Common Parameter
Input and Return Types
The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.
Input Type |
Microsoft.GroupPolicy.Gpo. A GPO to be deleted. Collections that contain GPOs from different domains are not supported. |
Return Type |
None. This cmdlet does not output any objects. |
Notes
- When you delete a GPO, by default, all links to that GPO in the domain of the GPO are deleted. To delete a link to a GPO, you must have permission to link Group Policy objects for the organizational unit or domain. If you do not have rights to delete a link, the GPO is deleted, but the link remains. Links from other domains and sites are not deleted. The link to a deleted GPO appears in the GPMC as Not Found. To delete Not Found links, you must either have permission on the site, domain, or organizational unit containing the link, or ask someone with sufficient rights to delete it.
Examples
EXAMPLE 1
C:\PS>
Remove-GPO -guid 50cc3e45-0b14-46dd-8b4d-afa012bc331c -Domain contoso.com -KeepLinks
Description
-----------
Removes the GPO that has the GUID 50cc3e45-0b14-46dd-8b4d-afa012bc331c from the contoso.com domain. Because the KeepLinks parameter is specified, links between the GPO and all sites, and links between the GPO and all containers in the domain are preserved.
EXAMPLE 2
C:\PS>
Remove-GPO -Name TestGPO
Description
-----------
Removes the "TestGPO" GPO from the domain of the user that is running the session (or, for startup and shutdown scripts, the domain of the computer). Because the KeepLinks parameter is not specified, links between the GPO and all sites, and links between the GPO and all containers in the domain are deleted.