Set-GPInheritance

Set-GPInheritance

Blocks or unblocks inheritance for a specified domain or organizational unit (OU).

Syntax

Set-GPInheritance [-Target] <string> -IsBlocked {<No> | <Yes>} [-Domain <string>] [-Server <string>] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-GPInheritance cmdlet blocks or unblocks inheritance for a specified domain or organizational unit (OU).

GPOs are applied according to the Group Policy hierarchy in the following order: local GPO, GPOs linked to the site, GPOs linked to the domain, GPOs linked to OUs. By default, an Active Directory container inherits settings from GPOs that are applied at the next higher level in the hierarchy. Blocking inheritance prevents the settings in GPOs that are linked to higher-level sites, domains, or organizational units from being automatically inherited by the specified domain or OU, unless the link (at the higher-level container) for a GPO is enforced.

You use the Target parameter to specify the LDAP distinguished name of the domain or OU, and use the IsBlocked parameter to specify whether to block or unblock inheritance.

Parameters

-Domain <string>

Specifies the domain for this cmdlet. You must specify the fully qualified domain name (FQDN) of the domain (for example: sales.contoso.com).

For the Set-GPInheritance cmdlet, this is typically the domain of the Active Directory container (domain or OU) for which you want to block or unblock inheritance. If the domain for the cmdlet is different than the domain of the container, a trust must exist between the two domains.

If you do not specify the Domain parameter, the domain of the user that is running the current session is used. (If the cmdlet is being executed from a computer startup or shutdown script, the domain of the computer is used.) For more information, see the Notes section in the full Help.

If you specify a domain that is different from the domain of the user that is running the current session (or, for a startup or shutdown script, the computer), a trust must exist between that domain and the domain of the user (or the computer).

You can also refer to the Domain parameter by its built-in alias, "domainname". For more information, see about_Aliases.

Attributes

Name Value

Required?

false

Accept wildcard characters?

false

Accept Pipeline Input?

true (ByPropertyName)

Position?

named

-IsBlocked <BlockInheritance>

Specifies whether to block inheritance for the domain or OU. You must specify Yes or No.

The following values are permitted for this object type.

  • No **

  • Yes **

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

false

Position?

named

-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

-Target <string>

Specifies the domain or the OU for which to block or unblock inheritance by its LDAP distinguished name. For example, the "MyOU" organizational unit in the contoso.com domain is specified as "ou=MyOU,dc=contoso,dc=com".

You can also refer to the Target parameter by its built-in alias, "path". For more information, see about_Aliases.

Attributes

Name Value

Required?

true

Accept wildcard characters?

false

Accept Pipeline Input?

true (ByPropertyName)

Position?

1

-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.Som. This cmdlet takes an object that represents a domain or an OU as input.

Return Type

Microsoft.GroupPolicy.Som. Set-GPInheritance returns an object that represents the domain or OU after the operation is applied. The properties of this object that are displayed by default describe the Group Policy inheritance information for the domain or OU. The GpoInheritanceBlocked property indicates whether inheritance is blocked.

Notes

  • GPO links that are enforced cannot be blocked. This cmdlet should be used sparingly. Casual use of this cmdlet can complicate troubleshooting.

    You can use the Domain parameter to explicitly specify the domain for this cmdlet.

    If you do not explicitly specify the domain, the cmdlet uses a default domain. The default domain is the domain that is used to access network resources by the security context under which the current session is running. This domain is typically the domain of the user that is running the session. For example, the domain of the user who started the session by opening Windows PowerShell from the Program Files menu, or the domain of a user that is specified in a runas command. However, computer startup and shutdown scripts execute under the context of the LocalSystem account. The LocalSystem account is a built-in local account, and it accesses network resources under the context of the computer account. Therefore, when this cmdlet is executed from a startup or shutdown script, the default domain is the domain to which the computer is joined.

Examples

EXAMPLE 1

C:\PS>

Set-GPinheritance -Target "ou=MyOU,dc=contoso,dc=com" -IsBlocked Yes



Name                  : myou

ContainerType         : OU

Path                  : ou=myou,dc=contoso,dc=com

GpoInheritanceBlocked : Yes

GpoLinks              : {TestGPO-1, TestGPO-2}

InheritedGpoLinks     : {TestGPO-1, TestGPO-2}                        

Description

-----------

This command blocks inheritance for the "MyOU" OU in the contoso.com domain. GPOs that are linked to higher-level sites or domains, or to OUs that are parent OUs of the "MyOU" OU are not applied (unless their links are enforced) when Group Policy is processed for the OU on the client.

Because inheritance is blocked, only GPOs that are linked directly to the "MyOU" OU (and those that are enforced at higher-level containers) appear in the InheritedGpoLinks list.

EXAMPLE 2

C:\PS>

Set-GPinheritance -Target "dc=northwest, dc=contoso, dc=com" -IsBlocked No                        

Description

-----------

This command unblocks inheritance for the northwest.contoso.com domain. GPOs linked to higher-level sites or domains are applied to this domain when Group Policy is processed on the client.

EXAMPLE 3

C:\PS>

Set-GPinheritance -Target "ou=MyOU,dc=contoso,dc=com" -IsBlocked No



Name                  : myou

ContainerType         : OU

Path                  : ou=myou,dc=contoso,dc=com

GpoInheritanceBlocked : No

GpoLinks              : {TestGPO-1, TestGPO-2}

InheritedGpoLinks     : {TestGPO-1, TestGPO-2, Default Domain Policy}                        

Description

-----------

This command blocks inheritance for the "MyOU" OU in the contoso.com domain. GPOs that are linked to higher-level sites or domains, or to OUs that are parent OUs of the "MyOU" OU, are applied when Group Policy is processed for the OU on the client.

Because inheritance is not blocked, GPOs that are inherited from higher-level containers appear in the InheritedGpoLinks list (together with GPOs that are linked directly to the OU). For example, the "Default Domain Policy" GPO is linked at the domain level.

See Also

Reference

Get-GPInheritance